Send one or more SMS messages in a single request. Each message is queued and delivered independently, so a batch can partially succeed — always inspect every item in the response.
Senders. Set a top-level sender for the whole request, a sender on individual messages, or both: a message's own sender overrides the top-level one. With neither, the stream's default sender is used.
- Batch size: up to 250 messages per request.
- Correlation: set an
internal_idper message; it is echoed back in the response and in delivery webhooks. - Media: on WhatsApp Business and Telegram streams a message can carry
media(from Upload file) instead of, or with,message_content.
Response. HTTP 200 with a task_id and one entry per message. status is false when any message failed: failed entries come first and carry error (hex code) and details; accepted entries carry message_uuid (and conversation_uuid on two-way channels). Match entries by internal_id. Final delivery status is sent asynchronously to your configured webhook.
Whole-request errors. Invalid JSON field types return HTTP 200 with status: false, error_code 0x1 and no task_id. 402 (0x41) means the balance is depleted.
Authentication: stream token in the Authorization header (see Authentication in the API Overview).
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||