Get outbound SMS message delivery reports

If you are for any reason unable to receive real-time delivery reports on your endpoint, you can use 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.

Learn more about SMS channel and use cases

Please log in to see full path URL. Learn why.

get

/sms/1/reports

Authorizations:

Scopes:

message:send

sms:manage

sms:message:send

query Parameters

bulkId	string Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
messageId	string Unique message ID for which a report is requested.
limit	integer <int32> <= 1000 Default: 50 Example: limit=2 Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is `1000` and you can only access reports for the last 48h.
applicationId	string Example: applicationId=marketing-automation-application Application id used to send the message. For more details, see our documentation.
entityId	string Example: entityId=promotional-traffic-entity Entity id used to send the message. For more details, see our documentation.
campaignReferenceId	string Example: campaignReferenceId=summersale ID of a campaign that was sent in the message.

Responses

200

successful response

400

Error responses

401

Unauthorized

403

Forbidden

500

Internal Server Error

Request samples

Example

cURL

Copy

curl -L -g 'https://{baseUrl}/sms/1/reports?limit=2&applicationId=marketing-automation-application&entityId=promotional-traffic-entity&campaignReferenceId=summersale' \
-H 'Authorization: {authorization}' \
-H 'Accept: application/json'

Response samples

Content type

Copy

Collapse all


{"results": 
[
{"bulkId": "BULK-ID-123-xyz",
"messageId": "MESSAGE-ID-123-xyz",
"to": "41793026727",
"sentAt": "2019-11-09T16:00:00.000+0000",
"doneAt": "2019-11-09T16:00:00.000+0000",
"smsCount": 1,
"callbackData": "callbackData",
"price": 
{"pricePerMessage": 0.01,
"currency": "EUR"
},
"status": 
{"groupId": 3,
"groupName": "DELIVERED",
"id": 5,
"name": "DELIVERED_TO_HANDSET",
"description": "Message delivered to handset"
},
"error": 
{"groupId": 0,
"groupName": "Ok",
"id": 0,
"name": "NO_ERROR",
"description": "No Error",
"permanent": false
},
"entityId": "promotional-traffic-entity",
"applicationId": "marketing-automation-application"
},
{"bulkId": "BULK-ID-123-xyz",
"messageId": "12db39c3-7822-4e72-a3ec-c87442c0ffc5",
"to": "41793026834",
"sentAt": "2019-11-09T17:00:00.000+0000",
"doneAt": "2019-11-09T17:00:00.000+0000",
"smsCount": 1,
"price": 
{"pricePerMessage": 0.01,
"currency": "EUR"
},
"status": 
{"groupId": 3,
"groupName": "DELIVERED",
"id": 5,
"name": "DELIVERED_TO_HANDSET",
"description": "Message delivered to handset"
},
"error": 
{"groupId": 0,
"groupName": "Ok",
"id": 0,
"name": "NO_ERROR",
"description": "No Error",
"permanent": false
},
"applicationId": "default"
}
]
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products

Learn more

Service status

Privacy documents Terms of use