Get inbound SMS messages

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

If for some reason you are unable to receive incoming SMS to the endpoint of your choice in real time, you can use this API call to fetch messages. Each request will return a batch of received messages - only once. The API request will only return new messages that arrived since the last API request.

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
limit	integer (int32)	limit=2	Maximum number of messages to return in a response. If not set, the latest 50 records are returned. The maximum allowed value is 1000. Data is available only for the last 48 hours.	No
applicationId	string	applicationId=marketing-automation-application	Filters messages linked to a specific application.	No
entityId	string	entityId=promotional-traffic-entity	Filters messages linked to a specific entity.	No
campaignReferenceId	string	campaignReferenceId=summersale	Filters messages that were part of a specific campaign.	No

Example Request

Retrieve the Last 2 Messages

bash

GET /sms/1/inbox/reports?limit=2

Filter by Application ID

bash

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

Filter by Entity ID

bash

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

Filter by Campaign Reference ID

bash

GET /sms/1/inbox/reports?campaignReferenceId=summersale

Combined Filters

bash

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