Skip to main content
POST
/
sms
Send an SMS
curl --request POST \
  --url https://api.robase.dev/v1/sms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "+2348012345678",
  "from": "SHUTTLERS",
  "body": "<string>",
  "template": "<string>",
  "variables": {},
  "country": "NG",
  "send_at": "2023-11-07T05:31:56Z"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "queued",
  "to": "+2348012345678",
  "from": "SHUTTLERS",
  "body": "<string>",
  "segments": 123,
  "encoding": "GSM7",
  "country": "NG",
  "carrier": "mtn_ng",
  "provider": "beem",
  "provider_message_id": "<string>",
  "provider_attempts": [
    {
      "provider": "<string>",
      "attempted_at": "2023-11-07T05:31:56Z",
      "ok": true,
      "provider_message_id": "<string>",
      "error_code": "<string>",
      "error_message": "<string>"
    }
  ],
  "cost": {
    "amount_kobo": 123,
    "currency": "NGN"
  },
  "test_mode": true,
  "created_at": "2023-11-07T05:31:56Z",
  "sent_at": "2023-11-07T05:31:56Z",
  "delivered_at": "2023-11-07T05:31:56Z"
}

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>