Description
Summary: Sends one or more SMS messages to specified recipients via the TextPeak Streams API. Details: The request accepts a batch of messages in a single call. Each message in the array requires a unique internal identifier, a sender name/ID, the recipient's phone number, and the message content. Authentication is performed via a stream token passed in the Authorization header.
Authentication & Scopes
Authentication is handled via a stream token provided in the Authorization header. No OAuth scopes are defined; access is granted or denied based on the validity of the token.
| Method | Details |
|---|---|
| Stream Token | Pass your token directly in the Authorization header value (not as a Bearer token). |
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | The stream token that verifies your access to the API. |
Content-Type | Yes | Must be set to application/json. The API only accepts JSON-formatted request bodies. |
Parameters
This endpoint does not use path or query parameters.
Request Body
The request body is a JSON object containing a single top-level key messages, which holds an array of message objects.
Top Level:
| Field | Type | Required | Description |
|---|---|---|---|
messages | array[object] | Yes | An array of message objects to be sent. |
Message Object:
| Field | Type | Required | Description |
|---|---|---|---|
internal_id | string | Yes | A unique identifier for the message. Must be unique within the request. |
sender | string | Yes | The sender's identifier. Can be a name, phone number, or any other identifier (e.g., "GLOBAL"). |
recipient_phone | string | Yes | The phone number of the message recipient, in international format (e.g., "972524265292"). |
message_content | string | Yes | The text content of the SMS message to be delivered. |
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||