Skip to main content
POST

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Body

messages
SMSBinaryMessage · object[]
required

An array of message objects of a single message or multiple messages sent under one bulk ID.

Minimum array length: 1
bulkId
string

Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response. Typically, used to fetch delivery reports and message logs. Anything above 100 characters passed in the request will be clipped during processing and returned in response, reports and logs.

sendingSpeedLimit
SendingSpeedLimit · object

Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.

Response

successful response

bulkId
string
read-only

Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. Typically, used to fetch delivery reports and message logs.

messages
SMSResponseDetails · object[]
read-only

An array of message objects of a single message or multiple messages sent under one bulk ID.