v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Call Commands

Join AI Assistant Conversation

Add a participant to an existing AI assistant conversation. Use this command to bring an additional call leg into a running AI conversation.

post/calls/{call_control_id}/actions/ai_assistant_join

Path parameters

call_control_idstring required

Unique identifier and token for controlling the call

Request body

client_statestring

Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.

command_idstring

Use this field to avoid duplicate commands. Telnyx will ignore any command with the same command_id for the same call_control_id.

conversation_idstring required

The ID of the AI assistant conversation to join.

Example request

{
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
  "conversation_id": "v3:abc123",
  "participant": {
    "id": "v3:abc123def456",
    "name": "John Doe",
    "on_hangup": "continue_conversation",
    "role": "user"
  }
}

Response

Successful response upon making a call control command that includes conversation_id.

Example response

{
  "data": {
    "conversation_id": "d7e9c1d4-8b2a-4b8f-b3a7-9a671c9e9b0a",
    "result": "ok"
  }
}