COcommpeak
Senders

Get sender

Changed on

Retrieve a single sender by its ID.

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

get/senders/{id}

Request

  • Base URL
    https://api.commpeak.com/textpeak
  • URL
    https://api.commpeak.com/textpeak/senders/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Unique identifier of the resource.

Response

Successful Response

idinteger required

Unique sender identifier.

namestring required

Sender display name.

valuestring required

The sender ID or phone number used on outbound messages (-, spaces and + removed).

dailyLimitinteger required

Maximum messages this sender may send per day. 0 for senders created through the API.

streamstring nullable

IRI of the stream this sender is bound to (/api/streams/{id}), or null.

senderType'PHONE' | 'ALPHANUMERIC' | 'INBOUND_ONLY' | 'BOT' | 'WHATSAPP' | 'TELEGRAM_PRIVATE' | 'WHATSAPP_PRIVATE' | 'WIDGET' | 'VOICE' | 'EMAIL' | 'UNKNOWN' required
status'WAITING_APPROVE' | 'APPROVED' | 'UNAPPROVED' | 'UNKNOWN' required

Example response

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

Changes

  • 5012671cf95dRevision changes
    • breaking

      added the new path request parameter id

    • breaking

      response property stream list-of-types was widened by adding types null to media type application/json of response 200

    • warning

      added the new EMAIL enum value to the response property for the response status

    • warning

      added the new UNKNOWN enum value to the response property for the response status

    • warning

      added the new UNKNOWN enum value to the response property for the response status

    • info

      api operation id getSender removed and replaced with get_sender

    • info

      the endpoint scheme security APIKeyHeader was added to the API

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status