Sign in

v1

latestOpenAPI 3.0.32026-07-24156161.2 MB
Senders

Get all senders

List all sender identities in your account.

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

get/senders

Query parameters

_pageinteger

Page number (1-based).

itemsPerPageinteger

Items per page.

Response

The list of senders.

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