Gather using AI

POST

/calls/{call_control_id}/actions/gather_using_ai

Gather parameters defined in the request payload using a voice assistant.

You can pass parameters described as a JSON Schema object and the voice assistant will attempt to gather these informations.

Expected Webhooks (see callback schema below):

call.ai_gather.ended

call.conversation.ended

call.ai_gather.partial_results (if send_partial_results is set to true)

call.ai_gather.message_history_updated (if send_message_history_updates is set to true)

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/calls//actions/gather_using_ai' \
--header 'Content-Type: application/json' \
--data-raw '{
    "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
    "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
    "greeting": "Hello, can you tell me your age and where you live?",
    "message_history": [
        {
            "content": "Hello, what'\''s your name?",
            "role": "assistant"
        },
        {
            "content": "Hello, I'\''m John.",
            "role": "user"
        }
    ],
    "parameters": {
        "properties": {
            "age": {
                "description": "The age of the customer.",
                "type": "integer"
            },
            "location": {
                "description": "The location of the customer.",
                "type": "string"
            }
        },
        "required": [
            "age",
            "location"
        ],
        "type": "object"
    },
    "send_message_history_updates": true,
    "send_partial_results": true,
    "user_response_timeout_ms": 5000,
    "voice": "Telnyx.KokoroTTS.af"
}'

Response Example

200 - Example 1

{
    "data": {
        "result": "ok"
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Successful response upon making a call control command.

Body

🔴500Server Error

Modified at 2025-06-16 19:14:41

Gather stop

Gather using audio