Get conversation token

Get a WebRTC session token for real-time communication.

Cabeçalhos

xi-api-keystringOpcional

Parâmetros de consulta

agent_idstringObrigatório

Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource.

participant_namestringOpcional
Optional custom participant name. If not provided, user ID will be used
branch_idstringOpcional
The ID of the branch to use
version_idstringOpcional
The ID of the version to use
environmentstringOpcional

The environment to use for resolving environment variables (e.g. ‘production’, ‘staging’). Defaults to ‘production’.

debug_events_requestbooleanOpcionalPadrão é false
Whether to enable debug events. Only available for users with editor access to the agent.

Resposta

Successful Response
tokenstring
conversation_idstring

Erros

422
Conversations Get Webrtc Token Request Unprocessable Entity Error