Skip to main content
POST
/
sms
/
batch
Send an SMS batch
curl --request POST \
  --url https://api.robase.dev/v1/sms/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "<string>",
  "messages": [
    {
      "to": "<string>",
      "body": "<string>",
      "template": "<string>",
      "variables": {},
      "idempotency_key": "<string>"
    }
  ],
  "template": "<string>",
  "country": "<string>",
  "send_at": "2023-11-07T05:31:56Z"
}
'
{
  "accepted": 123,
  "failed": 123,
  "success": true,
  "data": [
    {
      "index": 123,
      "replayed": true,
      "sms": {
        "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"
      },
      "error": {
        "error": {
          "type": "validation_error",
          "message": "<string>",
          "field": "<string>"
        }
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Body

application/json
from
string
required
messages
object[]
required
Maximum array length: 1000
template
string
country
string
send_at
string<date-time>

Response

200 - application/json

Partial success — check per-row error.

accepted
integer
failed
integer
success
boolean
data
object[]