SMS

AVAILABLE IN

Download

Download Postman collection Download Swagger

Available endpoints

POST v1/messages/sms

Description

Send an SMS Message to a single or multiple mobile number/s.

Header parameters

Content-Type application/json

Auth parameters

oauth2 Authorization

FormData parameters

to array required

Mobile number to send SMS to

body string required

text body of the SMS message

from string

Sender identity/address/code

notificationURL string

callback URL to send status of the SMS send request

clientId string required

Client/Organizaton name

201Created

messages

to string

The number the sms is sent to.

deliveryStatus string

Indicates whether or not the sms has been accepted for delivery

messageId string

A unique id to check the messages status. Id generated during delivery

smsStatusURL 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

Description

Retrieve SMS messages one by one

Header parameters

Content-Type application/json

Auth parameters

oauth2 Authorization

Query parameters

batchSize integer

200OK

batchSize integer

Number of SMSes returned

messages

status string

message status

to 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 sent

messageId string

Message Id

sentTimestamp 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

Description

Get delivery status

Header parameters

Content-Type application/json

Auth parameters

oauth2 Authorization

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

Description

Callback endpoint to enable the consuming app to receive smses sent to short code assigned to the app

Header parameters

Content-Type application/json

Auth parameters

oauth2 Authorization

FormData parameters

callbackURL string required

The callback being registered.

accessCode string

Developer assigned short code

clientId string

App ID

201Created

accessCode string

Id of the registered callback

callbackUrl 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}

Description

Remove endpoint used to send SMS notifications

Header parameters

Content-Type application/json

Auth parameters

oauth2 Authorization

{
    "code": 1,
    "reason": 1,
    "message": "string"
}