Get conversation token

Get a WebRTC session token for real-time communication.

En-têtes

xi-api-keystringOptionnel

Paramètres de requête

agent_idstringRequis

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

participant_namestringOptionnel
Optional custom participant name. If not provided, user ID will be used
branch_idstringOptionnel
The ID of the branch to use
version_idstringOptionnel
The ID of the version to use
environmentstringOptionnel

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

debug_events_requestbooleanOptionnelPar défaut false
Whether to enable debug events. Only available for users with editor access to the agent.

Réponse

Successful Response
tokenstring
conversation_idstring

Erreurs

422
Conversations Get Webrtc Token Request Unprocessable Entity Error