single_simple_send

Send a single 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.

Extras. On WhatsApp, actions turns the message into reply buttons, a link button or a list. check_duplication_time_window skips the send when the same sender already messaged the recipient within that many hours (up to 72).

Set an internal_id to correlate the message with delivery webhooks; it defaults to the recipient phone number.

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).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Your identifier for the message. Echoed back in the response and in delivery webhooks (internal_id). Up to 36 characters are kept; longer values are cut. Not checked for uniqueness. Defaults to the recipient phone number.

An alphanumeric sender ID or a phone number registered on the stream. Omit it to use the stream's default sender.

Recipient phone number in international format, as a string. +, spaces, - and parentheses are removed before validation. Not needed when conversation_uuid or contact.phone identifies the recipient.

string
required

The text body. With actions, the body of the interactive message.

Contact | null

Contact details stored with the conversation.

Continue an existing conversation: the sender and recipient are taken from it. Two-way channels only (WhatsApp, Telegram, two-way SMS); ignored on one-way SMS.

array | null

WhatsApp interactive buttons. One cta_url item: a link button. One to three items: reply buttons. More than three: a list.

Skip the send when this sender already messaged this recipient within the last N hours (content is not compared). At most 72. The skipped message is reported with error 0x19.

array | null

Candidate senders, used only when no sender is set on the message, the request or the stream: a sender allowed for the destination is picked at random. When none is allowed, the whole request fails with 0x61.

Send at this time instead of now (ISO 8601 date-time).

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json