POST
/
sms
/
send

Authorizations

Authorization
string
headerrequired

An API key to authenticate requests

Body

application/json
recipients
string
required

Recipients of the SMS message, comma separated list of phone numbers

sender_id
string
required

Sender ID of the SMS message

Maximum length: 11
content
string

Content of the SMS message, this is required if a template ID is not specified

template_id
string

Template ID of the SMS message, this is required if content is not specified

personalisation
object[]

Personalisation of the SMS message, this is applicable if a template ID is specified

external_ref
string

This is a reference to the message in your system

is_trackable
boolean
default: false

This determines if links in the message should be tracked, links in the message will be replaced with trackable links

callback
string

This is the URL to receive delivery reports for the message test

Response

200 - application/json
id
string
required

Unique ID of the SMS message

recipients
any[]
required

Recipients of the SMS message

sender_id
string
required

Sender ID of the SMS message

Maximum length: 11
is_trackable
boolean
required

This determines if links in the message should be tracked

content
string

Content of the SMS message

external_ref
string

This is a reference to the message in your system

callback
string

This is the URL to receive delivery reports for the message

template_id
string

Template ID of the SMS message

personalisation
object[]

Personalisation of the SMS message

created_datetime
string

Date and time the SMS was created

updated_datetime
string

Date and time the SMS token was last updated, if any

meta
object