Sign in

v1

latestOpenAPI 3.0.32026-07-24156161.2 MB
Streams Service

single_simple_send

Send a single SMS message in one request. The body is a flat object — ideal for transactional, one-off messages. For high volume, use simple_send to batch up to 250 messages per call.

Set a unique internal_id to correlate the message with delivery webhooks. The response returns a task_id and the assigned message_uuid/conversation_uuid.

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

post/streams/simple_send_single

Request body

internal_idstring

Your identifier for the message. Echoed back in responses and delivery webhooks.

senderstring

Sender ID or phone number. Falls back to the stream default when omitted.

recipient_phonestring

Recipient phone number in international format, digits only.

message_contentstring required

The text body of the SMS message.

Example request

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

Response

The message 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"
    }
  ]
}