Retrieve SMS details
GET/api/v1/subaccounts/:subAccountId/messages/:umid
This resource can be used to query message details like delivery status using the unique message identifier (UMID) of the message.
URL
You need to specify the sub-account id and the umid of the message in place of {subAccountId} and {umid} respectively.
umid is the unique identifier you received when you submitted the message to the API.
API Rate Limiting
To protect the platform from being overloaded and maintain a high quality of service to all customers, we enforce API rate limits for this API endpoint.
The limit is set to 1 request/second per subaccount.
To safeguard your privacy, sensitive data such as message content and phone numbers are masked by default. Access to this information can be requested by contacting our support team.
Request
Responses
- 200
- 400
- 401
- 404
- 429
Response returned with the message details if a message with the UMID is found for the specified sub account.
This error response is returned if the request is invalid (e.g. umid is not a valid uuid).
Request was not authenticated response
This error response is returned if there is a message by the specified sub account and umid does not exist.
Rate limiting quota exceeded error