v1

latestOpenAPI 3.0.0The MIT License (MIT)2026-07-14614962.2 KB

Get status of report

Retrieve status and metadata about a requested report.

get/v2/reports/{report_id}

Path parameters

report_idstring required
Example:aaaaaaaa-bbbb-cccc-dddd-0123456789ab

UUID of the report request (request_id in response).

Response

OK

OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "_links": {
    "download_report": {
      "href": "https://api.nexmo.com/v3/media/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
    },
    "self": {
      "href": "https://api.nexmo.com/v2/reports/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
    }
  },
  "account_id": "abcdef01",
  "callback_url": "https://requestb.in/12345",
  "date_end": "2018-01-01T00:00:00+00:00",
  "date_start": "2017-12-01T00:00:00+00:00",
  "product": "SMS",
  "receive_time": "2019-06-28T15:30:00+0000",
  "request_id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
  "request_status": "SUCCESS",
  "start_time": "2019-06-28T15:30:00+0000",
  "direction": "outbound",
  "from": "441234567890",
  "network": "23415",
  "status": "delivered",
  "to": "441234567890"
}