SMS: Send SMS

post

https://partner-api-url.com/send-sms

Sends an SMS message. Returns 200 OK on success. Status codes above 500 and 429 are retried automatically. Other non-200 status codes trigger the enqueue_failed event.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
Channel API access and fees
The Channel API is available to partners and clients who want to build connectors to Communications Platform as a Service (CPaaS) vendors or Mail Transfer Agents (MTAs, also known as ESPs) such as Mailgun, Sinch, Infobip, and Omnivery.
Channel API access isn't enabled by default and is subject to additional fees. To get access, contact your Account Manager.

Body Params

sender

string

required

Sender number or name

recipient

string

required

Recipient number, format 00\d{7,15} (MSISDN)

message

string

required

Message content

request_id

string

required

Unique request ID used for deduplication. In send endpoint timeout scenarios, this may be the only way to guarantee exactly-once delivery. Note: Not populated when sending a test message from the Sandbox.

custom_data

string

required

Custom obscure BR data metadata which need to be stored on provider's side, passed to webhook callbacks. Will be URL safe and usually a few hundred characters long.

callback_url

string

required

Webhook URL where to send delivery reports along with custom_data.

metadata

object

required

BR metadata that can be used by provider if needed

Headers

Chan-Example-Token

string

required

Defaults to 123

An example header (one of multiple) containing account identity or authorization data. The actual headers to be sent can be customized to provider's needs, by default BR will send each setting field as a separate header with the prefix Chan- added to the name.

An API key is a token that you provide when making API calls. Include the token in a header parameter called Chan-Example-Token.

Example: Chan-Example-Token: 123

Responses

Language

Loading…

Response

Choose an example:

application/json

Channel API access and fees

200200

4XX4XX

5XX5XX