Skip to main content
POST
Send an SMS

Authorizations

Authorization
string
header
required

Pass your API key as Authorization: Bearer rb_live_...

Headers

Idempotency-Key
string

Body

application/json
to
string
required

E.164 phone number.

Example:

"+2348012345678"

from
string
required

Registered sender ID, ≤ 11 chars.

Example:

"SHUTTLERS"

body
string

Message body (required unless template is set).

template
string

Slug or UUID of an SMS template.

variables
object

Template variables (required when template is set).

country
string

ISO-3166 alpha-2 override.

Example:

"NG"

send_at
string<date-time>

Schedule for a future time.

Response

Accepted — queued for delivery.

id
string<uuid>
status
enum<string>
Available options:
queued,
scheduled,
sent,
delivered,
failed,
rejected,
cancelled
to
string
Example:

"+2348012345678"

from
string
Example:

"SHUTTLERS"

body
string
segments
integer
encoding
enum<string>
Available options:
GSM7,
UCS2
country
string
Example:

"NG"

carrier
string
Example:

"mtn_ng"

provider
string
Example:

"beem"

provider_message_id
string
provider_attempts
object[]
cost
object
test_mode
boolean
created_at
string<date-time>
sent_at
string<date-time>
delivered_at
string<date-time>