v1

latestOpenAPI 3.0.32026-07-24156161.2 MB

Streams Service

simple_send

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.

Sender modes — pick one:

Batch: set one top-level sender for the whole request and omit sender on each message.
Mixed: omit the top-level sender and set a sender on every message.
Batch size: up to 250 messages per request.
Correlation: set a unique internal_id per message; it is echoed back in the response and in delivery webhooks, and it keys any per-message error.
Response: a batch task_id plus, per message, a message_uuid and conversation_uuid. Final delivery status is sent asynchronously to your configured webhook.
Partial failures are reported inline on the offending message (error code + details).

Authentication: stream token in the Authorization header (see Authentication in the API Overview).

post/streams/simple_send

Request body

senderstring

Top-level sender applied to every message (batch mode). An alphanumeric sender ID or a phone number. Omit when each message carries its own sender.

Example request

{
  "sender": "CommPeak",
  "messages": [
    {
      "internal_id": "1001",
      "sender": "CommPeak",
      "recipient_phone": "447700900123",
      "message_content": "Hi Lando, your CommPeak code is 4821."
    }
  ]
}

Response

The batch was accepted for delivery.

statusboolean

true when the batch was accepted. Individual messages may still carry an error.

task_idstring

Identifier for the accepted batch (processed asynchronously).

Example response

{
  "status": true,
  "task_id": "ca550f7e-9eb5-45b3-9830-e82b407ede02",
  "messages": [
    {
      "internal_id": "1001",
      "message_uuid": "a61e5bfe-c82b-448a-815b-32de8bf22089",
      "conversation_uuid": "e2a489db-bb8a-4f51-9692-726153599c57",
      "error": "0x31",
      "details": "reached daily limit"
    }
  ]
}