Sign in

v1

latestOpenAPI 3.0.32026-07-24156161.2 MB
Senders

Add sender

Create a new sender identity. Both name and value are required. New senders may require approval before use.

Authentication: TextPeak API key in the Authorization header (see Authentication in the API Overview).

post/senders

Request body

namestring required

Sender display name.

valuestring required

The sender ID or phone number (dashes, spaces, and + are stripped).

Example request

{
  "name": "CommPeak",
  "value": "CommPeak"
}

Response

The created sender.

idinteger

Unique sender identifier.

namestring

Sender display name.

valuestring

The sender ID or phone number used on outbound messages.

dailyLimitinteger

Maximum messages this sender may send per day.

streamstring

IRI of the stream this sender belongs to, if any.

senderType'PHONE' | 'ALPHANUMERIC' | 'INBOUND_ONLY' | 'BOT' | 'WHATSAPP' | 'TELEGRAM_PRIVATE' | 'WHATSAPP_PRIVATE' | 'WIDGET' | 'VOICE'

Sender type (read-only, derived from the value).

status'WAITING_APPROVE' | 'APPROVED' | 'UNAPPROVED'

Approval status (read-only).

Example response

{
  "id": 7,
  "name": "CommPeak",
  "value": "CommPeak",
  "dailyLimit": 5000,
  "stream": "/api/streams/5",
  "senderType": "ALPHANUMERIC",
  "status": "APPROVED"
}