Download
Download Postman collection Download SwaggerAvailable endpoints
POST v1/messages/sms
201Created
messages
to string
The number the sms is sent to.deliveryStatus string
Indicates whether or not the sms has been accepted for deliverymessageId string
A unique id to check the messages status. Id generated during deliverysmsStatusURL string
Currently this url will map to the callback url provided. Please use the messageIds and delivery status endpoint to query delivery status.{
"messages": {
"to": "string",
"deliveryStatus": "string",
"messageId": "string",
"smsStatusURL": "string"
}
}
400Bad Request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
415Unsupported Media Type
500Internal Server Error
501Not Implemented
503Service Unavailable
GET v1/messages/sms
200OK
batchSize integer
Number of SMSes returnedmessages
status string
message statusto string
The mobile number (recipient) that the message was sent to (in E.164 format).from string
The phone number (sender) that the message was sent from (in E.164 forma).message string
Text of the message that was sentmessageId string
Message IdsentTimestamp string
The date and time when the message was sent by recipient.{
"batchSize": 1,
"messages": {
"status": "string",
"to": "string",
"from": "string",
"message": "string",
"messageId": "string",
"sentTimestamp": "string"
}
}
400Bad Request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
415Unsupported Media Type
500Internal Server Error
501Not Implemented
503Service Unavailable
GET v1/messages/sms/{messageId}/status
200OK
to string
The phone number (recipient) the message was sent to (in E.164 format).sentTimestamp object
receivedTimestamp object
deliveryStatus string
PENDING,SENT,DELIVERED,EXPIRED,DELETED,UNDELIVERABLE,REJECTED,READ{
"to": "string",
"sentTimestamp": [],
"receivedTimestamp": [],
"deliveryStatus": "string"
}
400Bad Request
401Unauthorized
403Forbidden
404Not Found
405Method Not Allowed
415Unsupported Media Type
500Internal Server Error
501Not Implemented
503Service Unavailable
defaultAn internal error occurred when processing the request
POST v1/messages/sms-listeners
201Created
accessCode string
Id of the registered callbackcallbackUrl string
The callback being registered.status string
message string
{
"accessCode": "string",
"callbackUrl": "string",
"status": "string",
"message": "string"
}
400Bad Request
code integer
Application related code.reason integer
Text that explains the reason for error.message string
(optional) Text that provide more details and corrective actions related to the error.{
"code": 1,
"reason": 1,
"message": "string"
}
401Unauthorized
code integer
Application related code.reason integer
Text that explains the reason for error.message string
(optional) Text that provide more details and corrective actions related to the error.{
"code": 1,
"reason": 1,
"message": "string"
}
403Forbidden
code integer
Application related code.reason integer
Text that explains the reason for error.message string
(optional) Text that provide more details and corrective actions related to the error.{
"code": 1,
"reason": 1,
"message": "string"
}
404Not Found
code integer
Application related code.reason integer
Text that explains the reason for error.message string
(optional) Text that provide more details and corrective actions related to the error.{
"code": 1,
"reason": 1,
"message": "string"
}
405Method Not Allowed
code integer
Application related code.reason integer
Text that explains the reason for error.message string
(optional) Text that provide more details and corrective actions related to the error.{
"code": 1,
"reason": 1,
"message": "string"
}
409Conflict
code integer
Application related code.reason integer
Text that explains the reason for error.message string
(optional) Text that provide more details and corrective actions related to the error.{
"code": 1,
"reason": 1,
"message": "string"
}
500Internal Server Error
code integer
Application related code.reason integer
Text that explains the reason for error.message string
(optional) Text that provide more details and corrective actions related to the error.{
"code": 1,
"reason": 1,
"message": "string"
}
DELETE v1/messages/sms-listeners/{accessCode}
204No Content
400Bad Request
code integer
Application related code.reason integer
Text that explains the reason for error.message string
(optional) Text that provide more details and corrective actions related to the error.{
"code": 1,
"reason": 1,
"message": "string"
}
401Unauthorized
code integer
Application related code.reason integer
Text that explains the reason for error.message string
(optional) Text that provide more details and corrective actions related to the error.{
"code": 1,
"reason": 1,
"message": "string"
}
403Forbidden
code integer
Application related code.reason integer
Text that explains the reason for error.message string
(optional) Text that provide more details and corrective actions related to the error.{
"code": 1,
"reason": 1,
"message": "string"
}
404Not Found
code integer
Application related code.reason integer
Text that explains the reason for error.message string
(optional) Text that provide more details and corrective actions related to the error.{
"code": 1,
"reason": 1,
"message": "string"
}
405Method Not Allowed
code integer
Application related code.reason integer
Text that explains the reason for error.message string
(optional) Text that provide more details and corrective actions related to the error.{
"code": 1,
"reason": 1,
"message": "string"
}
409Conflict
code integer
Application related code.reason integer
Text that explains the reason for error.message string
(optional) Text that provide more details and corrective actions related to the error.{
"code": 1,
"reason": 1,
"message": "string"
}
500Internal Server Error
code integer
Application related code.reason integer
Text that explains the reason for error.message string
(optional) Text that provide more details and corrective actions related to the error.{
"code": 1,
"reason": 1,
"message": "string"
}