Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

An API key to authenticate requests

Body

application/json

SMS message object

recipients
string
required

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

Example:

"2348023456789, 2348098765432"

sender_id
string
required

Sender ID of the SMS message

Maximum string length: 11
Example:

"Simpu"

channel
enum<string>

Channel to send the SMS message

Available options:
sms,
whatsapp
Example:

"sms"

content
string

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

Example:

"Hello! World. This is a test message."

template_id
string

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

Example:

"674535b2b39158b9aae90188fcec23eb"

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

Example:

"674535b2b39158b9aae90188fcec23eb"

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

Example:

false

callback
string

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

Example:

"https://example.com/sms/delivery_report"

Response

SMS response

id
string
required

Unique ID of the SMS message

Example:

"674535b2b39158b9aae90188fcec23eb"

recipients
array
required

Recipients of the SMS message

Example:
sender_id
string
required

Sender ID of the SMS message

Maximum string length: 11
Example:

"Simpu"

is_trackable
boolean
required

This determines if links in the message should be tracked

Example:

false

content
string

Content of the SMS message

Example:

"Hello! World. This is a test message."

external_ref
string

This is a reference to the message in your system

Example:

"674535b2b39158b9aae90188fcec23eb"

callback
string

This is the URL to receive delivery reports for the message

Example:

"https://example.com/sms/delivery_report"

template_id
string

Template ID of the SMS message

Example:

"674535b2b39158b9aae90188fcec23eb"

personalisation
object[]

Personalisation of the SMS message

created_datetime
string

Date and time the SMS was created

Example:

"2024-06-28T23:56:38.128604+00:00"

updated_datetime
string

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

Example:

"2024-06-28T23:56:38.128604+00:00"

meta
object