COcommpeak
Streams

Get stream

Changed on

Retrieve a single stream by its ID.

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

get/streams/{id}

Request

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

Path parameters

idinteger required

Unique identifier of the resource.

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

      added the new path request parameter id

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • 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 getStream removed and replaced with get_stream

    • 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

      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