Get outbound SMS message delivery reports

POST https://{baseUrl}/sms/1/reports

This API method to learn if and when the message has been delivered to the recipient. Each request will return a batch of delivery reports - only once. The following API request will return only new reports that arrived since the last API request in the last 48 hours.

Request Headers

Header	Type	Description	Required
Authorization	string	API key for authentication (Bearer <your_api_key>).	Yes
Accept	string	Expected response format (e.g., "application/json").	Yes

Query Parameters

Parameter	Type	Example	Description	Required
bulkId	string	bulkId=BULK-ID-123-xyz	Unique identifier for a bulk messaging request.	No
messageId	string	messageId=MESSAGE-ID-123-xyz	Unique identifier for an individual message.	No
limit	integer (int32)	limit=2	Maximum number of delivery reports to return. Defaults to 50 if not set. Maximum allowed value is 1000. Only reports from the last 48 hours are available.	No
applicationId	string	applicationId=marketing-automation-application	Filters reports by the application used to send the message.	No
entityId	string	entityId=promotional-traffic-entity	Filters reports by the entity used to send the message.	No
campaignReferenceId	string	campaignReferenceId=summersale	Filters reports by the campaign linked to the message.	No

Example Requests

Retrieve Delivery Reports for the Last 2 Messages

bash

GET /sms/1/reports?limit=2

Filter by Bulk ID

bash

GET /sms/1/reports?bulkId=BULK-ID-123-xyz

Filter by Message ID

bash

GET /sms/1/reports?messageId=MESSAGE-ID-123-xyz

Filter by Application ID

bash

GET /sms/1/reports?applicationId=marketing-automation-application

Filter by Entity ID

bash

GET /sms/1/reports?entityId=promotional-traffic-entity

Filter by Campaign Reference ID

bash

GET /sms/1/reports?campaignReferenceId=summersale

Combined Filters

bash

GET /sms/1/reports?limit=5&applicationId=marketing-automation-application&entityId=promotional-traffic-entity&campaignReferenceId=summersale