COcommpeak
Streams

Get stream token

Changed on

Retrieve the stream token for a stream. This token authenticates the messaging endpoints (simple_send, template_send, …) for that stream — see the token types in the API Overview.

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

get/streams/{id}/token

Request

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

Path parameters

idinteger required

Unique identifier of the resource.

Response

Successful Response

tokenstring nullable

The stream token, sent as the raw Authorization header value on the messaging endpoints.

Example response

{
  "token": "d2b14ae204e9002338f97b9e45b387cd907f9aa8"
}

Changes

  • 5012671cf95dRevision changes
    • breaking

      added the new path request parameter id

    • breaking

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

    • info

      api operation id getStreamToken removed and replaced with get_stream_token

    • 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