API REFERENCEConversations

Get conversation token

Get a WebRTC session token for real-time communication.

Headers

xi-api-keystringRequired

Query parameters

agent_idstringRequired
The id of the agent you're taking the action on.
participant_namestring or nullOptional
Optional custom participant name. If not provided, user ID will be used
sourceenum or nullOptional
The source of the conversation initiation.
versionstring or nullOptionalformat: "^[0-9]+\.[0-9]+\.[0-9]+(-[a-zA-Z0-9.-]+)?$"<=50 characters
The SDK version number

Response

Successful Response
tokenstring

Errors