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

  • tostringrequired

    Recipient in international format, e.g. +254712345678.

  • messagestringrequired

    The text to send.

  • fromstringoptional

    Your approved sender ID, up to 11 characters.

  • scheduled_atstringoptional

    ISO 8601 time to send later.

  • typestringoptional

    promotional or transactional. Defaults to promotional.

Response fields

  • id

    Message ID

  • status

    queued, sent, delivered or failed

  • segments

    SMS segments used

  • credits_used

    Credits charged

  • created_at · scheduled_at

    Timestamps

Errors

Tap one to see its response above.

Was this page helpful?
Powered by StdioX Labs