Skip to Content
Transactional SMS

Send single or multi-recipient SMS

View Markdown (.md)
POST
/api/v1/public/sms/send

Dispatches high-priority transactional SMS to 1-10 recipients. Supports test keys (sk_test_...) and magic numbers (+233200000001 through +233200000004) for deterministic sandbox simulation without deducting wallet credits.

Authorization

headerX-Api-Key<token>

SMS Pro API Key (sk_live_... or sk_test_...)

Header Parameters

Idempotency-Key?string

Unique UUID or string for idempotent dispatch protection. Guarantees that a message is only sent once within a 24-hour window.

Lengthlength <= 128

Request Body

application/json
  1. body
to?string

Single recipient phone number in E.164 format

recipients?array<string>

Multi-recipient list (1-10 phone numbers in E.164 format)

Itemsitems <= 10
message*string

Text content of the message

senderId?string

Registered alphanumeric Sender ID (max 11 chars)

Lengthlength <= 11
scheduleAt?string

Optional future timestamp to schedule delivery

Formatdate-time
deliveryCallbackUrl?string

Webhook URL to receive signed delivery receipts

Formaturi

Response Body

Message accepted and queued for carrier delivery or simulated in sandbox

application/json
  1. response
status?string
message?string
data?
Example Request
curl -X POST 'https://api.smspro.com/api/v1/public/sms/send' \  -H 'Content-Type: application/json' \  -d '{  "message": "string"}'
Example Response
{  "status": "string",  "message": "string",  "data": {    "jobId": "string",    "messageIds": [      "string"    ],    "messageId": "string",    "status": "string",    "segmentCount": 0,    "totalUnits": 0  }}