COcommpeak
Streams

Get all streams

Changed on

List all streams in your account. Your account's default stream is not listed.

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/streams

Request

  • Base URL
    https://api.commpeak.com/textpeak
  • URL
    https://api.commpeak.com/textpeak/streams
  • 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.

idinteger nullable

Exact stream ID.

namestring nullable

Stream name contains this text.

type'MARKETING' | 'TRANSACTIONAL' | 'OTP' | 'TWO_WAY' | 'WHATSAPP_BUSINESS' | 'WHATSAPP_PRIVATE' | 'TELEGRAM_BOT' | 'TELEGRAM_PRIVATE' | 'WEBSOCKET' | 'VOICE' | 'EMAIL' | 'WHATSAPP_BUSINESS_AUTH' | 'WHATSAPP_EMBEDDED' nullable

Stream type (case-insensitive).

type[]string[] nullable

Any of these stream types.

state'READY' | 'SENDING' | 'DRAFT' | 'DISABLED' | 'RESTRICTED' nullable

Stream state (case-insensitive).

state[]string[] nullable

Any of these stream states.

ipAclstring nullable

IP allow-list contains this text.

streamTagsinteger nullable

Only streams with this tag ID.

Response

Successful Response

idinteger required

Unique stream identifier.

streamUidstring nullable

Opaque stream UID, generated at creation.

namestring nullable

Stream name.

descriptionstring nullable

Free-text description.

type'MARKETING' | 'TRANSACTIONAL' | 'OTP' | 'TWO_WAY' | 'WHATSAPP_BUSINESS' | 'WHATSAPP_PRIVATE' | 'TELEGRAM_BOT' | 'TELEGRAM_PRIVATE' | 'WEBSOCKET' | 'VOICE' | 'EMAIL' | 'WHATSAPP_BUSINESS_AUTH' | 'WHATSAPP_EMBEDDED' | 'UNKNOWN' required
callerIdstring nullable

Caller ID. Set only on VOICE streams.

ipAclstring nullable

Comma-separated, sorted IP / CIDR allow-list. Empty when not restricted.

state'READY' | 'SENDING' | 'DRAFT' | 'DISABLED' | 'RESTRICTED' | 'UNKNOWN' required
selectedSenderIdstring nullable

WhatsApp phone number ID selected during WhatsApp onboarding; null otherwise.

Example response

[
  {
    "description": "Outbound marketing to US contacts",
    "id": 5,
    "ipAcl": "192.0.2.10",
    "name": "Marketing US",
    "state": "READY",
    "streamTags": [
      {
        "id": 12,
        "value": "vip"
      }
    ],
    "streamUid": "9f1c2d3e4b5a6789c0d1e2f3a4b5c6d7",
    "type": "MARKETING"
  }
]

Changes

  • 5012671cf95dRevision changes
    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

      response property items/streamUid 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

    • warning

      added the new WHATSAPP_BUSINESS_AUTH enum value to the / response property for the response status

    • warning

      added the new WHATSAPP_EMBEDDED enum value to the / response property for the response status

    • info

      api operation id getAllStreams removed and replaced with list_streams

    • info

      the endpoint scheme security APIKeyHeader was added to the API

    • info

      added the new optional query request parameter id

    • info

      added the new optional query request parameter ipAcl

    • info

      added the new optional query request parameter name

    • 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 state

    • info

      added the new optional query request parameter state[]

    • info

      added the new optional query request parameter streamTags

    • info

      added the new optional query request parameter type

    • info

      added the new optional query request parameter type[]

    • 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

      added the optional property / to the response with the status

    • info

      added the optional property / to the 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