team-telnyx/telnyx-voice-gather-python

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Voice Gather - Python

Installation

pip install telnyx

Setup

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)

All examples below assume client is already initialized as shown above.

Add messages to AI Assistant

Add messages to the conversation started by an AI assistant on the call.

POST /calls/{call_control_id}/actions/ai_assistant_add_messages

response = client.calls.actions.add_ai_assistant_messages(
    call_control_id="call_control_id",
)
print(response.data)

Start AI Assistant

Start an AI assistant on the call.

POST /calls/{call_control_id}/actions/ai_assistant_start

response = client.calls.actions.start_ai_assistant(
    call_control_id="call_control_id",
)
print(response.data)

Stop AI Assistant

Stop an AI assistant on the call.

POST /calls/{call_control_id}/actions/ai_assistant_stop

response = client.calls.actions.stop_ai_assistant(
    call_control_id="call_control_id",
)
print(response.data)

Gather stop

Stop current gather.

POST /calls/{call_control_id}/actions/gather_stop

response = client.calls.actions.stop_gather(
    call_control_id="call_control_id",
)
print(response.data)

Gather using AI

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

POST /calls/{call_control_id}/actions/gather_using_ai — Required: parameters

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

Gather using audio

Play an audio file on the call until the required DTMF signals are gathered to build interactive menus.

POST /calls/{call_control_id}/actions/gather_using_audio

response = client.calls.actions.gather_using_audio(
    call_control_id="call_control_id",
)
print(response.data)

Gather using speak

Convert text to speech and play it on the call until the required DTMF signals are gathered to build interactive menus.

POST /calls/{call_control_id}/actions/gather_using_speak — Required: voice, payload

response = client.calls.actions.gather_using_speak(
    call_control_id="call_control_id",
    payload="say this on call",
    voice="male",
)
print(response.data)

Gather

Gather DTMF signals to build interactive menus.

POST /calls/{call_control_id}/actions/gather

response = client.calls.actions.gather(
    call_control_id="call_control_id",
)
print(response.data)

---

Webhooks

The following webhook events are sent to your configured webhook URL. All webhooks include telnyx-timestamp and telnyx-signature-ed25519 headers for verification (Standard Webhooks compatible).

| Event | Description | |-------|-------------| | callGatherEnded | Call Gather Ended | | CallAIGatherEnded | Call AI Gather Ended | | CallAIGatherMessageHistoryUpdated | Call AI Gather Message History Updated | | CallAIGatherPartialResults | Call AI Gather Partial Results | | CallConversationEnded | Call Conversation Ended | | callPlaybackStarted | Call Playback Started | | callPlaybackEnded | Call Playback Ended | | callDtmfReceived | Call Dtmf Received |