Sign in
Senders

Get sender

Retrieve a single sender by its ID.

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

get/senders/{id}

Response

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.