COcommpeak
Senders

Get all senders

Changed on

List all sender identities in your account.

Pagination. page (1-based, default 1) and itemsPerPage (default 30, at most 1000). The response is a plain JSON array.

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

get/senders

Request

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

Query parameters

pageinteger nullable

Page number (1-based).

itemsPerPageinteger nullable

Items per page, at most 1000.

order[id]'asc' | 'desc'

Sort by ID.

valuestring nullable

Sender value contains this text.

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

Sender type (case-insensitive).

senderType[]string[] nullable

Any of these sender types.

status'WAITING_APPROVE' | 'APPROVED' | 'UNAPPROVED' | 'UNKNOWN' nullable

Approval status (case-insensitive).

status[]string[] nullable

Any of these approval statuses.

streaminteger nullable

Only senders bound to this stream ID.

createdAt[before]string nullable

Created on or before this time (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).

createdAt[after]string nullable

Created on or after this time (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).

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

      for the query request parameter itemsPerPage, default value 30 was added

    • breaking

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

    • warning

      deleted the query request parameter _page

    • 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 getAllSenders removed and replaced with list_senders

    • info

      the endpoint scheme security APIKeyHeader was added to the API

    • info

      added the new optional query request parameter createdAt[after]

    • info

      added the new optional query request parameter createdAt[before]

    • info

      added the new optional query request parameter order[id]

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter senderType

    • info

      added the new optional query request parameter senderType[]

    • info

      added the new optional query request parameter status

    • info

      added the new optional query request parameter status[]

    • info

      added the new optional query request parameter stream

    • info

      added the new optional query request parameter value

    • info

      query request parameter itemsPerPage list-of-types was widened by adding types null

    • info

      for the query request parameter itemsPerPage, the type was generalized from integer to no type

    • 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