Calls

Create Call Stream Token

Mint a short-lived WebSocket token for a call. Use the returned stream_url to connect to Pinnacle's bidirectional voice stream.

post/calls/{id}/stream-token

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/calls/{id}/stream-token
  • Auth: API key in header PINNACLE-API-KEY

Path parameters

idstring required

Pinnacle call ID.

Request body

commands_enabledboolean

Whether this WebSocket may send call commands. Defaults to true.

stream_idstring

Customer-chosen stream ID for reconnects and multiple subscribers.

recordboolean

Enable recording for this WebSocket stream.

Response

Stream token.

tokenstring required

Short-lived stream token.

expires_atstring date-time required
stream_urlstring uri required

Pre-built WebSocket URL containing the token.

Changes

No recorded changes to this operation across all 1 revision of this API.