The Reports API enables you to request a report of activity for your Vonage account.
Depending on your query pattern, you can choose from one of the two versions of the Reports API: asynchronous and synchronous. The asynchronous version is optimized for infrequent and large data queries (from several records to tens of millions). The synchronous version is optimized for frequent and periodic retrievals of small batches of data records (from one record to tens of thousand per query).
Only synchronous version supports retrival of data records by message/record ID.
Vonage recommends that you limit asynchronous queries to a maximum of 20 million records, by setting the start and end dates accordingly. On average, the asynchronous Reports API takes 5 - 10 minutes to generate 1 million records.
Fetch usage data synchronously
GET
https://api.nexmo.com/v2/reports/records
Host
https://api.nexmo.com
GET
/v2/reports/records
This API supports both JWT and Basic authentication. Basic authentication is easier to get started with, but does not support advanced features such as ACLs.
You can use either JWT or Basic authentication, but not both at the same time.
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
The account for which the list of reports will be queried.
The product to return records for
Must be one of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
The UUID of the message or call to be searched for.
If you specify id, you must not specify status, date_start or date_end.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin.
It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If you provide this, you must provide date_end and must not provide id.
Must be no more than 24 hours later than date_start
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end.
It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If you provide this, you must provide date_start and must not provide id.
Include the message contents in the records. Only applicable for use with products SMS and MESSAGES, where it is optional.
true or false
The event type to search for. Only used, and is required, when product is CONVERSATIONS.
ip-voice or cs-custom-event
The SMS status to search for. Optional where product is SMS.
delivered, expired, failed, rejected, accepted, buffered, unknown or deleted
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Time at which the report request was received by the service.
Price of the request.
Currency of the price of the request.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Include the text of messages in the report.
The number of returned records
Records in JSON format
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Time at which the report request was received by the service.
Price of the request.
Currency of the price of the request.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Include the text of messages in the report.
The number of returned records
Records in JSON format
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Time at which the report request was received by the service.
Price of the request.
Currency of the price of the request.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Include the text of messages in the report.
The number of returned records
Records in JSON format
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
UUID of the request.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Request from this number.
Request to this number.
Network used to send the request.
Name of the network used to send the request.
Country where the request was sent.
Country name where the request was sent.
Date of the start of the call.
Date of the end of the call.
Duration of the call in seconds.
Search only for voice call with the corresponding status.
One of:started, ringing, answered, machine, completed, timeout, failed, rejected, cancelled or busy
Description of the status of the call.
Currency of the price of the request.
Price of the request.
Total price of the request.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Time at which the report request was received by the service.
Price of the request.
Currency of the price of the request.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Include the text of messages in the report.
The number of returned records
Records in JSON format
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
UUID of the request.
Request from this number.
Request to this number.
Locale used for the TTS.
Type of phone number to which requests are sent.
Network used to send the request.
Name of the network used to send the request.
Country where the request was sent.
Country name where the request was sent.
Date of the request.
Date when the request was finalized.
Date of the first verify event.
Date of the last verify event.
Status of the verify request.
Number of sms sent for this verify request.
Number of tts sent for this verify request.
Currency of the price of the request.
Pricing model used for this request.
Price of the request.
Estimated price of the verify request.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Time at which the report request was received by the service.
Price of the request.
Currency of the price of the request.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Include the text of messages in the report.
The number of returned records
Records in JSON format
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
UUID of the request.
Type of Number Insight request.
Number looked up for this request.
Date of the request.
Status of the Number Insight request.
Response code of the Number Insight request.
Network of the looked up number.
Network name of the looked up number.
Network type of the looked up number.
Country of the looked up number.
Country name of the looked up number.
Is the looked up number valid.
Is the looked up number ported.
Is the looked up number reachable.
First name of the owner of the looked up number.
Last name of the owner of the looked up number.
Currency of the price of the request.
Total price of the request.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Time at which the report request was received by the service.
Price of the request.
Currency of the price of the request.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Include the text of messages in the report.
The number of returned records
Records in JSON format
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
Id of the request.
Search for messages with this client_ref.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Request from this number.
Request to this number.
Body of the message sent. Only present if include_message parameter is set to true.
Country where the request was sent.
Country name where the request was sent.
Provider of the message.
Date of the request.
Date when the request was finalized.
Latency of the request in ms.
Status of the message.
Error code of the message.
Currency of the price of the request.
Total price of the request.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Time at which the report request was received by the service.
Price of the request.
Currency of the price of the request.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Include the text of messages in the report.
The number of returned records
Records in JSON format
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
Id of the request.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Request from this number.
Request to this number.
Body of the message sent. Only present if include_message parameter is set to true.
Provider of the message.
Date of the request.
Currency of the price of the request.
Total price of the request.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Time at which the report request was received by the service.
Price of the request.
Currency of the price of the request.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Include the text of messages in the report.
The number of returned records
Records in JSON format
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
UUID of the request.
Search only for requests attached to a particular Application ID.
Search only for Voice calls attached to this particular Conversation. This should include the "CON-" prefix.
User ID of the caller.
Id of the leg.
Date of the start of the call.
Date of the end of the call.
Duration of the call in seconds.
Status of the conversation evnet.
Currency of the price of the request.
Price of the request.
Total price of the request.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Time at which the report request was received by the service.
Price of the request.
Currency of the price of the request.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Include the text of messages in the report.
The number of returned records
Records in JSON format
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
UUID of the request.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Request from this number.
Request to this number.
Date of the start of the call.
Date of the start of the call.
Date of the end of the call.
Duration of the call in seconds.
Search only for ASR with corresponding status.
One of:ok or error
ASR error message.
Currency of the price of the request.
Price of the request.
Total price of the request.
{
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/records?product=SMS&direction=outbound&date_start=2020-03-05T13%3A00%3A00Z&date_end=2020-03-05T14%0A00%3A00Z&account_id=abcdef01"
}
},
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"received_at": "2019-06-28T15:30:00+0000",
"price": "0.042",
"currency": "EUR",
"direction": "outbound",
"product": "SMS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_message": "true",
"items_count": 2,
"records": [
{
"account_id": "abcdef01",
"message_id": "0000000A",
"client_ref": "abc123",
"direction": "outbound",
"from": "441234567890",
"to": "441234567890",
"network": "23415",
"network_name": "Vodafone Limited",
"country": "FR",
"country_name": "France",
"date_received": "2019-06-28T15:30:00+0000",
"date_finalized": "2019-06-28T15:30:00+0000",
"latency": "42",
"status": "delivered",
"error_code": "0",
"error_code_description": "Delivered",
"currency": "EUR",
"total_price": "0.042",
"message_body": "This is a text message"
}
]
}{
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/records?product=SMS&direction=outbound&date_start=2020-03-05T13%3A00%3A00Z&date_end=2020-03-05T14%0A00%3A00Z&account_id=abcdef01"
}
},
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"received_at": "2019-06-28T15:30:00+0000",
"price": "0.042",
"currency": "EUR",
"direction": "outbound",
"product": "SMS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_message": "true",
"items_count": 2,
"records": [
{
"account_id": "abcdef01",
"message_id": "0000000A",
"direction": "inbound",
"from": "441234567890",
"to": "441234567890",
"network": "23415",
"network_name": "Vodafone Limited",
"country": "FR",
"country_name": "France",
"date_received": "2019-06-28T15:30:00+0000",
"currency": "EUR",
"total_price": "0.042",
"message_body": "This is a text message"
}
]
}{
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/records?product=SMS&direction=outbound&date_start=2020-03-05T13%3A00%3A00Z&date_end=2020-03-05T14%0A00%3A00Z&account_id=abcdef01"
}
},
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"received_at": "2019-06-28T15:30:00+0000",
"price": "0.042",
"currency": "EUR",
"direction": "outbound",
"product": "SMS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_message": "false",
"items_count": 2,
"records": [
{
"account_id": "abcdef01",
"call_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"direction": "outbound",
"from": "441234567890",
"to": "441234567890",
"network": "23415",
"network_name": "Vodafone Limited",
"country": "FR",
"country_name": "France",
"date_start": "2019-06-28T15:30:00+0000",
"date_end": "2019-06-28T15:30:00+0000",
"duration": "42",
"status": "started",
"status_description": "The call was successful.",
"currency": "EUR",
"price": "0.042",
"total_price": "0.042"
}
]
}{
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/records?product=SMS&direction=outbound&date_start=2020-03-05T13%3A00%3A00Z&date_end=2020-03-05T14%0A00%3A00Z&account_id=abcdef01"
}
},
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"received_at": "2019-06-28T15:30:00+0000",
"price": "0.042",
"currency": "EUR",
"direction": "outbound",
"product": "SMS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_message": "false",
"items_count": 2,
"records": [
{
"account_id": "abcdef01",
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"from": "441234567890",
"to": "441234567890",
"locale": "en-gb",
"number_type": "MOBILE",
"network": "23415",
"network_name": "Vodafone Limited",
"country": "FR",
"country_name": "France",
"date_received": "2019-06-28T15:30:00+0000",
"date_finalized": "2019-06-28T15:30:00+0000",
"first_event_date": "2019-06-28T15:30:00+0000",
"last_event_date": "2019-06-28T15:30:00+0000",
"verify_status": "SUCCESS",
"sms_event_count": "1",
"tts_event_count": "1",
"currency": "EUR",
"pricing_model": "0",
"price": "0.042",
"estimated_price": "0.042"
}
]
}{
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/records?product=SMS&direction=outbound&date_start=2020-03-05T13%3A00%3A00Z&date_end=2020-03-05T14%0A00%3A00Z&account_id=abcdef01"
}
},
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"received_at": "2019-06-28T15:30:00+0000",
"price": "0.042",
"currency": "EUR",
"direction": "outbound",
"product": "SMS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_message": "false",
"items_count": 2,
"records": [
{
"account_id": "abcdef01",
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"product_type": "HLR-LOOKUP",
"number": "HLR-LOOKUP",
"date_received": "2019-06-28T15:30:00+0000",
"status": "Success",
"response_code": "0",
"network": "23415",
"network_name": "Vodafone Limited",
"network_type": "mobile",
"country": "mobile",
"country_name": "mobile",
"valid": "valid",
"ported": "ported",
"reachable": "reachable",
"first_name": "valid",
"last_name": "valid",
"currency": "EUR",
"total_price": "0.042"
}
]
}{
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/records?product=SMS&direction=outbound&date_start=2020-03-05T13%3A00%3A00Z&date_end=2020-03-05T14%0A00%3A00Z&account_id=abcdef01"
}
},
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"received_at": "2019-06-28T15:30:00+0000",
"price": "0.042",
"currency": "EUR",
"direction": "outbound",
"product": "SMS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_message": "true",
"items_count": 2,
"records": [
{
"account_id": "abcdef01",
"message_id": "0000000A",
"client_ref": "abc123",
"direction": "outbound",
"from": "441234567890",
"to": "441234567890",
"message_body": "This is a text message",
"country": "FR",
"country_name": "France",
"provider": "whatsapp",
"date_received": "2019-06-28T15:30:00+0000",
"date_finalized": "2019-06-28T15:30:00+0000",
"latency": "42",
"status": "submitted",
"error_code": "1300",
"currency": "EUR",
"total_price": "0.042"
}
]
}{
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/records?product=SMS&direction=outbound&date_start=2020-03-05T13%3A00%3A00Z&date_end=2020-03-05T14%0A00%3A00Z&account_id=abcdef01"
}
},
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"received_at": "2019-06-28T15:30:00+0000",
"price": "0.042",
"currency": "EUR",
"direction": "outbound",
"product": "SMS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_message": "false",
"items_count": 2,
"records": [
{
"account_id": "abcdef01",
"message_id": "0000000A",
"direction": "outbound",
"from": "441234567890",
"to": "441234567890",
"message_body": "This is a text message",
"provider": "whatsapp",
"date_received": "2019-06-28T15:30:00+0000",
"currency": "EUR",
"total_price": "0.042"
}
]
}{
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/records?product=SMS&direction=outbound&date_start=2020-03-05T13%3A00%3A00Z&date_end=2020-03-05T14%0A00%3A00Z&account_id=abcdef01"
}
},
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"received_at": "2019-06-28T15:30:00+0000",
"price": "0.042",
"currency": "EUR",
"direction": "outbound",
"product": "SMS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_message": "false",
"items_count": 2,
"records": [
{
"account_id": "abcdef01",
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"application_id": "abc123",
"conversation_id": "CON-abc123",
"user_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"leg_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"date_start": "2019-06-28T15:30:00+0000",
"date_end": "2019-06-28T15:30:00+0000",
"duration": "42",
"status": "0",
"currency": "EUR",
"price": "0.042",
"total_price": "0.042"
}
]
}{
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/records?product=SMS&direction=outbound&date_start=2020-03-05T13%3A00%3A00Z&date_end=2020-03-05T14%0A00%3A00Z&account_id=abcdef01"
}
},
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"received_at": "2019-06-28T15:30:00+0000",
"price": "0.042",
"currency": "EUR",
"direction": "outbound",
"product": "SMS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_message": "false",
"items_count": 2,
"records": [
{
"account_id": "abcdef01",
"call_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"direction": "outbound",
"from": "441234567890",
"to": "441234567890",
"call_date_start": "2019-06-28T15:30:00+0000",
"date_start": "2019-06-28T15:30:00+0000",
"date_end": "2019-06-28T15:30:00+0000",
"duration": "42",
"status": "ok",
"status_description": "",
"currency": "EUR",
"price": "0.042",
"total_price": "0.042"
}
]
}{
"title": "Forbidden",
"detail": "User not authorized to query the requested data",
"instance": "f94b4e56604e07e5e5ad5a7228618f81"
}{
"title": "Unprocessable entity",
"invalid_parameters": [
{
"reason": "Missing required parameter",
"name": "date_end"
}
],
"instance": "f94b4e56604e07e5e5ad5a7228618f81"
}{
"title": "Unprocessable entity",
"invalid_parameters": [
{
"reason": "Could not resolve product name. Please use one of the following values [CONVERSATIONS, MESSAGES, NUMBER-INSIGHT, SMS, VERIFY-API, VERIFY-SDK, VOICE-CALL]",
"name": "product"
}
],
"instance": "f94b4e56604e07e5e5ad5a7228618f81"
}{
"type": "https://developer.nexmo.com/api-errors/reports#invalid-filter",
"title": "Invalid filter",
"detail": "When using message_id, the following parameters are not supported: [date_start, date_end]",
"instance": "f94b4e56604e07e5e5ad5a7228618f81"
}List reports created by the specified account based on filtered provided.
GET
https://api.nexmo.com/v2/reports
Host
https://api.nexmo.com
GET
/v2/reports
This API supports both JWT and Basic authentication. Basic authentication is easier to get started with, but does not support advanced features such as ACLs.
You can use either JWT or Basic authentication, but not both at the same time.
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
The account for which the list of reports will be queried.
A comma-separated list of report status values. Reports with any of the statuses specified are returned. The values in the comma-seperated list specified for status can be any of PENDING, PROCESSING, SUCCESS, ABORTED, FAILED, TRUNCATED.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date from which the list of reports will be queried. Format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date until which the list of reports will be queried. Format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z.
The number of reports in the list.
URI of this search.
The list of reports.
{
"items_count": 1,
"self_link": "https://api.nexmo.com/v2/reports/",
"reports": [
{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "SMS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"direction": "outbound",
"status": "delivered",
"client_ref": "abc123",
"account_ref": "abc123",
"include_message": "true",
"network": "23415",
"from": "441234567890",
"to": "441234567890"
},
{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "VOICE-CALL",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"direction": "outbound",
"network": "23415",
"from": "441234567890",
"to": "441234567890",
"status": "started"
},
{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "VERIFY-API",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"to": "441234567890",
"network": "23415"
},
{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "NUMBER-INSIGHT",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"number": "441234567890",
"network": "23415"
},
{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "MESSAGES",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"direction": "outbound",
"from": "441234567890",
"to": "441234567890",
"id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"include_message": "true"
},
{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "CONVERSATIONS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"type": "ip-voice",
"conversation_id": "CON-abc123",
"status": "0"
},
{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "ASR",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"direction": "outbound",
"from": "441234567890",
"to": "441234567890",
"status": "ok"
}
]
}{
"type": "https://developer.nexmo.com/api-errors/reports#invalid-request-parameters",
"title": "Invalid request parameter",
"detail": "Invalid request parameter.",
"instance": "f94b4e56604e07e5e5ad5a7228618f81"
}{
"type": "https://developer.nexmo.com/api-errors#unauthorized",
"title": "Unauthorized",
"detail": "You did not provide correct credentials.",
"instance": "f94b4e56604e07e5e5ad5a7228618f81"
}Request a report on your account activity
POST
https://api.nexmo.com/v2/reports
Host
https://api.nexmo.com
POST
/v2/reports
This API supports both JWT and Basic authentication. Basic authentication is easier to get started with, but does not support advanced features such as ACLs.
You can use either JWT or Basic authentication, but not both at the same time.
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
The parameters of the JSON body will be used to create and filter the report.
The value of the product field will define which product the report will be created for and which parameters are accepted.
Which product you wish to generate a report for.
Must be one of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
Must be one of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Search only for sms with the corresponding status.
Must be one of:delivered, expired, failed, rejected, accepted, buffered or unknown
Search for messages with this client_ref.
Search for messages with this account_ref.
Include the text of messages in the report.
Network used to send the request.
Request from this number.
Request to this number.
Which product you wish to generate a report for.
Must be one of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
Must be one of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Network used to send the request.
Request from this number.
Request to this number.
Search only for voice call with the corresponding status.
Must be one of:started, ringing, answered, machine, completed, timeout, failed, rejected, cancelled or busy
Which product you wish to generate a report for.
Must be one of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
Must be one of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Request to this number.
Network used to send the request.
Which product you wish to generate a report for.
Must be one of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
Must be one of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Search only request for the target number.
Network used to send the request.
Which product you wish to generate a report for.
Must be one of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
Must be one of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Request from this number.
Request to this number.
Search only messages with the specified uuid.
Include the text of messages in the report.
Which product you wish to generate a report for.
Must be one of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
Must be one of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Type of conversation request. Only used, and is required, when product is CONVERSATIONS.
ip-voice or cs-custom-event
Search only for Voice calls attached to this particular Conversation. This should include the "CON-" prefix.
Search only for conversation events with the specified event status.
Which product you wish to generate a report for.
Must be one of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
Must be one of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Request from this number.
Request to this number.
Search only for ASR with corresponding status.
Must be one of:ok or error
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Search only for sms with the corresponding status.
One of:delivered, expired, failed, rejected, accepted, buffered or unknown
Search for messages with this client_ref.
Search for messages with this account_ref.
Include the text of messages in the report.
Network used to send the request.
Request from this number.
Request to this number.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Network used to send the request.
Request from this number.
Request to this number.
Search only for voice call with the corresponding status.
One of:started, ringing, answered, machine, completed, timeout, failed, rejected, cancelled or busy
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
Request to this number.
Network used to send the request.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
Search only request for the target number.
Network used to send the request.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Request from this number.
Request to this number.
Search only messages with the specified uuid.
Include the text of messages in the report.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
Type of conversation request. Only used, and is required, when product is CONVERSATIONS.
ip-voice or cs-custom-event
Search only for Voice calls attached to this particular Conversation. This should include the "CON-" prefix.
Search only for conversation events with the specified event status.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Request from this number.
Request to this number.
Search only for ASR with corresponding status.
One of:ok or error
{
"product": "SMS",
"account_id": "abcdef01",
"direction": "outbound"
}{
"product": "SMS",
"account_id": "abcdef01",
"direction": "outbound",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"status": "delivered",
"include_message": "true",
"network": "23415",
"from": "441234567890",
"to": "441234567890"
}{
"product": "VOICE-CALL",
"account_id": "abcdef01"
}{
"product": "VOICE-CALL",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"direction": "outbound",
"network": "23415",
"from": "441234567890",
"to": "441234567890",
"status": "started"
}{
"product": "VERIFY-API",
"account_id": "abcdef01"
}{
"product": "VERIFY-API",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"to": "441234567890",
"network": "23415"
}{
"product": "NUMBER-INSIGHT",
"account_id": "abcdef01"
}{
"product": "NUMBER-INSIGHT",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"number": "441234567890",
"network": "23415"
}{
"product": "MESSAGES",
"account_id": "abcdef01",
"direction": "outbound"
}{
"product": "MESSAGES",
"account_id": "abcdef01",
"direction": "outbound",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"from": "441234567890",
"to": "441234567890",
"id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"include_message": "true"
}{
"product": "CONVERSATIONS",
"account_id": "abcdef01"
}{
"product": "CONVERSATIONS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"type": "ip-voice",
"conversation_id": "CON-abc123",
"status": "0"
}{
"product": "ASR",
"account_id": "abcdef01"
}{
"product": "ASR",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"direction": "outbound",
"from": "441234567890",
"to": "441234567890",
"status": "ok"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "PENDING",
"product": "SMS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"direction": "outbound",
"status": "delivered",
"client_ref": "abc123",
"account_ref": "abc123",
"include_message": "true",
"network": "23415",
"from": "441234567890",
"to": "441234567890"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "PENDING",
"product": "VOICE-CALL",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"direction": "outbound",
"network": "23415",
"from": "441234567890",
"to": "441234567890",
"status": "started"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "PENDING",
"product": "VERIFY-API",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"to": "441234567890",
"network": "23415"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "PENDING",
"product": "NUMBER-INSIGHT",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"number": "441234567890",
"network": "23415"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "PENDING",
"product": "MESSAGES",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"direction": "outbound",
"from": "441234567890",
"to": "441234567890",
"id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"include_message": "true"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "PENDING",
"product": "CONVERSATIONS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"type": "ip-voice",
"conversation_id": "CON-abc123",
"status": "0"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "PENDING",
"product": "ASR",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"direction": "outbound",
"from": "441234567890",
"to": "441234567890",
"status": "ok"
}{
"type": "https://developer.nexmo.com/api-errors#invalid-json",
"title": "Malformed JSON",
"detail": "Malformed JSON payload.",
"instance": "f94b4e56604e07e5e5ad5a7228618f81"
}{
"type": "https://developer.nexmo.com/api-errors#unauthorized",
"title": "Unauthorized",
"detail": "You did not provide correct credentials.",
"instance": "f94b4e56604e07e5e5ad5a7228618f81"
}{
"type": "https://developer.nexmo.com/api-errors#forbidden",
"title": "Forbidden",
"detail": "User not authorized to query the requested data.",
"instance": "f94b4e56604e07e5e5ad5a7228618f81"
}{
"type": "https://developer.nexmo.com/api-errors#not-found",
"title": "Unprocessable entity",
"detail": "Unprocessable entity.",
"instance": "f94b4e56604e07e5e5ad5a7228618f81"
}Retrieve status and metadata about a requested report.
GET
https://api.nexmo.com/v2/reports/:report_id
Host
https://api.nexmo.com
GET
/v2/reports/:report_id
This API supports both JWT and Basic authentication. Basic authentication is easier to get started with, but does not support advanced features such as ACLs.
You can use either JWT or Basic authentication, but not both at the same time.
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
UUID of the report request (request_id in response).
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
The number of rows in the resulting file (when report has been completed).
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Search only for sms with the corresponding status.
One of:delivered, expired, failed, rejected, accepted, buffered or unknown
Search for messages with this client_ref.
Search for messages with this account_ref.
Include the text of messages in the report.
Network used to send the request.
Request from this number.
Request to this number.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
The number of rows in the resulting file (when report has been completed).
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Network used to send the request.
Request from this number.
Request to this number.
Search only for voice call with the corresponding status.
One of:started, ringing, answered, machine, completed, timeout, failed, rejected, cancelled or busy
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
The number of rows in the resulting file (when report has been completed).
Request to this number.
Network used to send the request.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
The number of rows in the resulting file (when report has been completed).
Search only request for the target number.
Network used to send the request.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
The number of rows in the resulting file (when report has been completed).
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Request from this number.
Request to this number.
Search only messages with the specified uuid.
Include the text of messages in the report.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
The number of rows in the resulting file (when report has been completed).
Type of conversation request. Only used, and is required, when product is CONVERSATIONS.
ip-voice or cs-custom-event
Search only for Voice calls attached to this particular Conversation. This should include the "CON-" prefix.
Search only for conversation events with the specified event status.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
The number of rows in the resulting file (when report has been completed).
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Request from this number.
Request to this number.
Search only for ASR with corresponding status.
One of:ok or error
{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "SMS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"direction": "outbound",
"status": "delivered",
"client_ref": "abc123",
"account_ref": "abc123",
"include_message": "true",
"network": "23415",
"from": "441234567890",
"to": "441234567890"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "VOICE-CALL",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"direction": "outbound",
"network": "23415",
"from": "441234567890",
"to": "441234567890",
"status": "started"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "VERIFY-API",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"to": "441234567890",
"network": "23415"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "NUMBER-INSIGHT",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"number": "441234567890",
"network": "23415"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "MESSAGES",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"direction": "outbound",
"from": "441234567890",
"to": "441234567890",
"id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"include_message": "true"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "CONVERSATIONS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"type": "ip-voice",
"conversation_id": "CON-abc123",
"status": "0"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "ASR",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"direction": "outbound",
"from": "441234567890",
"to": "441234567890",
"status": "ok"
}{
"type": "https://developer.nexmo.com/api-errors#unauthorized",
"title": "Unauthorized",
"detail": "You did not provide correct credentials.",
"instance": "f94b4e56604e07e5e5ad5a7228618f81"
}{
"type": "https://developer.nexmo.com/api-errors#not-found",
"title": "Invalid report ID",
"detail": "Report aaaaaaaa-bbbb-cccc-dddd-0123456789ab does not exist, or you do not have access.",
"instance": "f94b4e56604e07e5e5ad5a7228618f81"
}Cancel the execution of a pending or processing report.
DELETE
https://api.nexmo.com/v2/reports/:report_id
Host
https://api.nexmo.com
DELETE
/v2/reports/:report_id
This API supports both JWT and Basic authentication. Basic authentication is easier to get started with, but does not support advanced features such as ACLs.
You can use either JWT or Basic authentication, but not both at the same time.
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
UUID of the report
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
The number of rows in the resulting file (when report has been completed).
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Search only for sms with the corresponding status.
One of:delivered, expired, failed, rejected, accepted, buffered or unknown
Search for messages with this client_ref.
Search for messages with this account_ref.
Include the text of messages in the report.
Network used to send the request.
Request from this number.
Request to this number.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
The number of rows in the resulting file (when report has been completed).
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Network used to send the request.
Request from this number.
Request to this number.
Search only for voice call with the corresponding status.
One of:started, ringing, answered, machine, completed, timeout, failed, rejected, cancelled or busy
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
The number of rows in the resulting file (when report has been completed).
Request to this number.
Network used to send the request.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
The number of rows in the resulting file (when report has been completed).
Search only request for the target number.
Network used to send the request.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
The number of rows in the resulting file (when report has been completed).
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Request from this number.
Request to this number.
Search only messages with the specified uuid.
Include the text of messages in the report.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
The number of rows in the resulting file (when report has been completed).
Type of conversation request. Only used, and is required, when product is CONVERSATIONS.
ip-voice or cs-custom-event
Search only for Voice calls attached to this particular Conversation. This should include the "CON-" prefix.
Search only for conversation events with the specified event status.
UUID of the request.
Status of the request.
One of:PENDING, PROCESSING, SUCCESS, ABORTED, FAILED or TRUNCATED
Which product you wish to generate a report for.
One of:SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES, CONVERSATIONS or ASR
The account ID (API key) you wish to search for. This can differ from the API key in the authorization header because some accounts can request reports for other accounts, e.g. a primary account owner wants to create a report for one of its subaccounts.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when reports should begin. It filters on the time the API call was received by Vonage and corresponds to the field date_received (date_start for Voice) in the report file. It is inclusive, i.e. the provided value is less than or equal to the value in the field date_received (date_start for Voice) in the CDR.
If unspecified, defaults to seven days ago.
ISO-8601 extended time zone offset or ISO-8601 UTC zone offset formatted date (format yyyy-mm-ddThh:mm:ss[.sss]±hh:mm or yyyy-mm-ddThh:mm:ss[.sss]Z) for when report should end. It is exclusive, i.e. the provided value is strictly greater than the value in the field date_received in the CDR.
If unspecified, defaults to the current time.
Whether to include subaccounts or not.
One of:true or false
URL to send a callback upon completion of the report. This POST callback contains the same information as the response to Get status of report.
Time at which the report request was received by the service.
Time at which the report processing of the report has started.
The number of rows in the resulting file (when report has been completed).
Direction of the communication, either inbound (received by our services), or outbound (originated from our services). Required for products SMS and MESSAGES. Optional for VOICE-CALL. Invalid for CONVERSATIONS, NUMBER-INSIGHT, VERIFY-API.
inbound or outbound
Request from this number.
Request to this number.
Search only for ASR with corresponding status.
One of:ok or error
{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "SMS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"direction": "outbound",
"status": "delivered",
"client_ref": "abc123",
"account_ref": "abc123",
"include_message": "true",
"network": "23415",
"from": "441234567890",
"to": "441234567890"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "VOICE-CALL",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"direction": "outbound",
"network": "23415",
"from": "441234567890",
"to": "441234567890",
"status": "started"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "VERIFY-API",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"to": "441234567890",
"network": "23415"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "NUMBER-INSIGHT",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"number": "441234567890",
"network": "23415"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "MESSAGES",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"direction": "outbound",
"from": "441234567890",
"to": "441234567890",
"id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"include_message": "true"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "CONVERSATIONS",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"type": "ip-voice",
"conversation_id": "CON-abc123",
"status": "0"
}{
"request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"request_status": "SUCCESS",
"product": "ASR",
"account_id": "abcdef01",
"date_start": "2017-12-01T00:00:00+00:00",
"date_end": "2018-01-01T00:00:00+00:00",
"include_subaccounts": "false",
"callback_url": "https://requestb.in/12345",
"receive_time": "2019-06-28T15:30:00+0000",
"start_time": "2019-06-28T15:30:00+0000",
"_links": {
"self": {
"href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
},
"download_report": {
"href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
},
"items_count": 1,
"direction": "outbound",
"from": "441234567890",
"to": "441234567890",
"status": "ok"
}{
"type": "https://developer.nexmo.com/api-errors#unauthorized",
"title": "Unauthorized",
"detail": "You did not provide correct credentials.",
"instance": "f94b4e56604e07e5e5ad5a7228618f81"
}{
"type": "https://developer.nexmo.com/api-errors#not-found",
"title": "Invalid report ID",
"detail": "Report aaaaaaaa-bbbb-cccc-dddd-0123456789ab does not exist, or you do not have access.",
"instance": "f94b4e56604e07e5e5ad5a7228618f81"
}Download a zipped archive of the rendered report. The file is available for download for 72 hours.
The zip file will be named <PRODUCT>_<REPORT_ID>.zip
The csv file in the zip archive will be named as report_<PRODUCT>_<ACCOUNT_ID>_<DATE>.csv the date will be formatted as yyyyMMdd.
GET
https://api.nexmo.com/v3/media/:file_id
Host
https://api.nexmo.com
GET
/v3/media/:file_id
This API supports both JWT and Basic authentication. Basic authentication is easier to get started with, but does not support advanced features such as ACLs.
You can use either JWT or Basic authentication, but not both at the same time.
| Key | Description | Example | Default |
|---|---|---|---|
| Authorization |
Your JSON web token. Read more about JWTs |
Bearer <JWT> |
None |
| Authorization |
Base64 encoded API key and secret joined by a colon. Read more |
Basic <base64> |
None |
UUID of the file.
The report in CSV format inside the zip archive.
This endpoint does not support application/json
Zip file containing CSV filesThis endpoint does not support application/json
{
"type": "https://developer.nexmo.com/api-errors#unauthorized",
"title": "Unauthorized",
"detail": "You did not provide correct credentials.",
"instance": "f94b4e56604e07e5e5ad5a7228618f81"
}{
"type": "https://developer.nexmo.com/api-errors#not-found",
"title": "Invalid report ID",
"detail": "Report aaaaaaaa-bbbb-cccc-dddd-0123456789ab does not exist, or you do not have access.",
"instance": "f94b4e56604e07e5e5ad5a7228618f81"
}