Delivery reports
Retrieve a list of delivery reports
Get a list of finished delivery reports.
This operation supports pagination.
get/xms/v1/{service_plan_id}/delivery_reports
Query parameters
pageinteger
The page number starting from 0.
page_sizeinteger
Determines the size of a page.
start_datestring date-time
Only list messages received at or after this date/time. Default: 24h ago
end_datestring date-time
Only list messages received before this date/time.
statusDeliveryStatus[]
Comma separated list of delivery report statuses to include.
[ "Delivered" ]
codeDeliveryReceiptStatusCode[]
Comma separated list of delivery receipt error codes to include.
client_referencestring
Client reference to include
Example response
{
"count": 2,
"page_size": 2,
"delivery_reports": [
{
"batch_id": "01FC66621XXXXX119Z8PMV1QPQ",
"encoding": "GSM",
"number_of_message_parts": 1,
"operator": "35000",
"recipient": "15551231234",
"status": "Delivered"
}
]
}