API reference · SMS
Send an SMS
Send one SMS. Long messages are split into segments, and each segment uses credits.
POST/v1/sms/send
- Rate limit 120 / min
- Returns 201 Created
- Needs the SMS permission · 1 credit per 160 characters
Body parameters
tostringrequiredRecipient in international format, e.g. +254712345678.
messagestringrequiredThe text to send.
fromstringoptionalYour approved sender ID, up to 11 characters.
scheduled_atstringoptionalISO 8601 time to send later.
typestringoptionalpromotional or transactional. Defaults to promotional.
Response fieldsResponse
idMessage ID
statusqueued, sent, delivered or failed
segmentsSMS segments used
credits_usedCredits charged
created_at · scheduled_atTimestamps
Errors
Tap one to see its response above.
Was this page helpful?
Powered by StdioX Labs