Gather using AI

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.calls.actions.gatherUsingAI('call_control_id', {
  parameters: {
    properties: 'bar',
    required: 'bar',
    type: 'bar',
  },
});

console.log(response.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
response = client.calls.actions.gather_using_ai(
    call_control_id="call_control_id",
    parameters={
        "properties": "bar",
        "required": "bar",
        "type": "bar",
    },
)
print(response.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	response, err := client.Calls.Actions.GatherUsingAI(
		context.TODO(),
		"call_control_id",
		telnyx.CallActionGatherUsingAIParams{
			Parameters: map[string]any{
				"properties": "bar",
				"required":   "bar",
				"type":       "bar",
			},
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", response.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.core.JsonValue;
import com.telnyx.sdk.models.calls.actions.ActionGatherUsingAiParams;
import com.telnyx.sdk.models.calls.actions.ActionGatherUsingAiResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        ActionGatherUsingAiParams params = ActionGatherUsingAiParams.builder()
            .callControlId("call_control_id")
            .parameters(ActionGatherUsingAiParams.Parameters.builder()
                .putAdditionalProperty("properties", JsonValue.from("bar"))
                .putAdditionalProperty("required", JsonValue.from("bar"))
                .putAdditionalProperty("type", JsonValue.from("bar"))
                .build())
            .build();
        ActionGatherUsingAiResponse response = client.calls().actions().gatherUsingAi(params);
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

response = telnyx.calls.actions.gather_using_ai(
  "call_control_id",
  parameters: {properties: "bar", required: "bar", type: "bar"}
)

puts(response)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Calls\Actions\GoogleTranscriptionLanguage;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $response = $client->calls->actions->gatherUsingAI(
    'call_control_id',
    parameters: ['properties' => 'bar', 'required' => 'bar', 'type' => 'bar'],
    assistant: [
      'instructions' => 'You are a friendly voice assistant.',
      'model' => 'Qwen/Qwen3-235B-A22B',
      'openaiAPIKeyRef' => 'my_openai_api_key',
      'tools' => [
        [
          'bookAppointment' => [
            'apiKeyRef' => 'my_calcom_api_key',
            'eventTypeID' => 0,
            'attendeeName' => 'attendee_name',
            'attendeeTimezone' => 'attendee_timezone',
          ],
          'type' => 'book_appointment',
        ],
      ],
    ],
    clientState: 'aGF2ZSBhIG5pY2UgZGF5ID1d',
    commandID: '891510ac-f3e4-11e8-af5b-de00688a4901',
    gatherEndedSpeech: 'Thank you for providing the information.',
    greeting: 'Hello, can you tell me your age and where you live?',
    interruptionSettings: ['enable' => true],
    language: GoogleTranscriptionLanguage::EN,
    messageHistory: [
      ['content' => 'Hello, what\'s your name?', 'role' => 'assistant'],
      ['content' => 'Hello, I\'m John.', 'role' => 'user'],
    ],
    sendMessageHistoryUpdates: true,
    sendPartialResults: true,
    transcription: [
      'language' => 'auto', 'model' => 'distil-whisper/distil-large-v2'
    ],
    userResponseTimeoutMs: 5000,
    voice: 'Telnyx.KokoroTTS.af',
    voiceSettings: [
      'type' => 'elevenlabs', 'apiKeyRef' => 'my_elevenlabs_api_key'
    ],
  );

  var_dump($response);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx calls:actions gather-using-ai \
  --api-key 'My API Key' \
  --call-control-id call_control_id \
  --parameters '{properties: bar, required: bar, type: bar}'

curl --request POST \
  --url https://api.telnyx.com/v2/calls/{call_control_id}/actions/gather_using_ai \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "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"
  },
  "voice": "Telnyx.KokoroTTS.af",
  "greeting": "Hello, can you tell me your age and where you live?",
  "send_partial_results": true,
  "send_message_history_updates": true,
  "message_history": [
    {
      "content": "Hello, what's your name?",
      "role": "assistant"
    },
    {
      "content": "Hello, I'm John.",
      "role": "user"
    }
  ],
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
  "command_id": "891510ac-f3e4-11e8-af5b-de00688a4901",
  "user_response_timeout_ms": 5000
}
EOF