Create report asynchronously

This code snippet shows you how to generate a report asynchronously, using a date range.

This is an asynchronous call and so will return immediately. You can check the current status of report generation with Get Report Status. Once completed, you can obtain the report with Get Report. Alternatively, you can set a callback URL and receive a notification when report generation is complete.

Date range is limited to 13 months for this call.

Example

Variable Required Description
NEXMO_API_KEY Yes Your API key which you can obtain from your Dashboard.
NEXMO_API_SECRET Yes Your API secret which you can obtain from your Dashboard.
ACCOUNT_ID Yes The API key for the target account. Reports generated, or records retrieved, are for this account.
REPORT_DIRECTION Yes Either inbound or outbound
REPORT_PRODUCT Yes Specifies the product for which reports and records are obtained. Can be one of SMS, VOICE-CALL, VERIFY-API, NUMBER-INSIGHT, MESSAGES or CONVERSATIONS.
DATE_START Yes Date of time window from when you want to start gathering records in ISO-8601 format. For example, 2020-06-09T18:05:00Z.
DATE_END Yes Date of time window from when you want to stop gathering records in ISO-8601 format. For example, 2020-06-09T20:05:00Z.
STATUS Optional Status of message or call. Examples include delivered, answered.
  • cURL

    • Write the code

    Add the following to create-async-report.sh:

    Copy to Clipboard 
    curl -X POST "https://api.nexmo.com/v2/reports" \
  -H 'Content-Type: application/json; charset=utf-8' \
  -u "$NEXMO_API_KEY:$NEXMO_API_SECRET" \
  -d $'{
  "product": "'$REPORT_PRODUCT'",
  "account_id": "'$ACCOUNT_ID'",
  "direction": "'$REPORT_DIRECTION'",
  "status": "'$STATUS'",
  "date_start": "'$DATE_START'",
  "date_end": "'$DATE_END'"
}'

    View full source

    Run your code

    Save this file to your machine and run it: 

    bash create-async-report.sh

    Try it out

    1. Set the replaceable variables for your account.

    2. For this example, set REPORT_PRODUCT to one of SMS, VOICE or MESSAGES.

    3. Using the table as a guide set values for the remaining variables.

    4. Run the script and you receive a response similar to the following:

    {
  "request_id": "ri3p58f-42d57cfd-1234-5678-9abc-67580d95f54a",
  "request_status": "PENDING",
  "direction": "outbound",
  "product": "SMS",
  "account_id": "abcd1234",
  "date_start": "2020-05-21T13:27:00+0000",
  "date_end": "2020-05-21T13:57:00+0000",
  "include_subaccounts": false,
  "include_message": false,
  "receive_time": "2020-06-04T10:53:32+0000",
  "_links": {
    "self": {
      "href": "https://api.nexmo.com/v2/reports/ri3p58f-42d57cfd-1234-5678-9abc-67580d95f54a"
    }
  }
}

    If you set a callback URL, you will receive a callback on that URL with the same content as shown in the previous step.

    See also