telnyx-voice-python

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Telnyx Voice - Python

Installation

安装

bash

pip install telnyx

bash

pip install telnyx

Setup

设置

python

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.

python

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # 这是默认配置，可省略
)

以下所有示例均假设

client

已按上述方式初始化完成。

Answer call

接听呼叫

Answer an incoming call.

POST /calls/{call_control_id}/actions/answer

python

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

接听呼入的呼叫。

POST /calls/{call_control_id}/actions/answer

python

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

Bridge calls

桥接呼叫

Bridge two call control calls.

POST /calls/{call_control_id}/actions/bridge

— Required:

call_control_id

python

response = client.calls.actions.bridge(
    call_control_id_to_bridge="call_control_id",
    call_control_id_to_bridge_with="v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
)
print(response.data)

将两个呼叫控制呼叫进行桥接。

POST /calls/{call_control_id}/actions/bridge

— 必填参数:

call_control_id

python

response = client.calls.actions.bridge(
    call_control_id_to_bridge="call_control_id",
    call_control_id_to_bridge_with="v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
)
print(response.data)

Dial

发起呼叫

Dial a number or SIP URI from a given connection.

POST /calls

— Required:

connection_id

to

from

python

response = client.calls.dial(
    connection_id="7267xxxxxxxxxxxxxx",
    from_="+18005550101",
    to="+18005550100",
)
print(response.data)

从指定的连接拨打号码或SIP URI。

POST /calls

— 必填参数:

connection_id

to

from

python

response = client.calls.dial(
    connection_id="7267xxxxxxxxxxxxxx",
    from_="+18005550101",
    to="+18005550100",
)
print(response.data)

Hangup call

挂断呼叫

Hang up the call.

POST /calls/{call_control_id}/actions/hangup

python

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

挂断当前呼叫。

POST /calls/{call_control_id}/actions/hangup

python

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

Transfer call

转接呼叫

Transfer a call to a new destination.

POST /calls/{call_control_id}/actions/transfer

— Required:

to

python

response = client.calls.actions.transfer(
    call_control_id="call_control_id",
    to="+18005550100",
)
print(response.data)

将呼叫转接至新的目的地。

POST /calls/{call_control_id}/actions/transfer

— 必填参数:

to

python

response = client.calls.actions.transfer(
    call_control_id="call_control_id",
    to="+18005550100",
)
print(response.data)

List all active calls for given connection

列出指定连接的所有活跃呼叫

Lists all active calls for given connection.

GET /connections/{connection_id}/active_calls

python

page = client.connections.list_active_calls(
    connection_id="1293384261075731461",
)
page = page.data[0]
print(page.call_control_id)

列出指定连接下的所有活跃呼叫。

GET /connections/{connection_id}/active_calls

python

page = client.connections.list_active_calls(
    connection_id="1293384261075731461",
)
page = page.data[0]
print(page.call_control_id)

List call control applications

列出呼叫控制应用

Return a list of call control applications.

GET /call_control_applications

python

page = client.call_control_applications.list()
page = page.data[0]
print(page.id)

返回呼叫控制应用的列表。

GET /call_control_applications

python

page = client.call_control_applications.list()
page = page.data[0]
print(page.id)

Create a call control application

创建呼叫控制应用

Create a call control application.

POST /call_control_applications

— Required:

application_name

webhook_event_url

python

call_control_application = client.call_control_applications.create(
    application_name="call-router",
    webhook_event_url="https://example.com",
)
print(call_control_application.data)

创建一个呼叫控制应用。

POST /call_control_applications

— 必填参数:

application_name

webhook_event_url

python

call_control_application = client.call_control_applications.create(
    application_name="call-router",
    webhook_event_url="https://example.com",
)
print(call_control_application.data)

Retrieve a call control application

获取呼叫控制应用详情

Retrieves the details of an existing call control application.

GET /call_control_applications/{id}

python

call_control_application = client.call_control_applications.retrieve(
    "id",
)
print(call_control_application.data)

获取现有呼叫控制应用的详细信息。

GET /call_control_applications/{id}

python

call_control_application = client.call_control_applications.retrieve(
    "id",
)
print(call_control_application.data)

Update a call control application

更新呼叫控制应用

Updates settings of an existing call control application.

PATCH /call_control_applications/{id}

— Required:

application_name

webhook_event_url

python

call_control_application = client.call_control_applications.update(
    id="id",
    application_name="call-router",
    webhook_event_url="https://example.com",
)
print(call_control_application.data)

更新现有呼叫控制应用的设置。

PATCH /call_control_applications/{id}

— 必填参数:

application_name

webhook_event_url

python

call_control_application = client.call_control_applications.update(
    id="id",
    application_name="call-router",
    webhook_event_url="https://example.com",
)
print(call_control_application.data)

Delete a call control application

删除呼叫控制应用

Deletes a call control application.

DELETE /call_control_applications/{id}

python

call_control_application = client.call_control_applications.delete(
    "id",
)
print(call_control_application.data)

删除一个呼叫控制应用。

DELETE /call_control_applications/{id}

python

call_control_application = client.call_control_applications.delete(
    "id",
)
print(call_control_application.data)

List call events

列出呼叫事件

Filters call events by given filter parameters.

GET /call_events

python

page = client.call_events.list()
page = page.data[0]
print(page.call_leg_id)

根据指定的过滤参数筛选呼叫事件。

GET /call_events

python

page = client.call_events.list()
page = page.data[0]
print(page.call_leg_id)

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
`callAnswered`	Call Answered
`callStreamingStarted`	Call Streaming Started
`callStreamingStopped`	Call Streaming Stopped
`callStreamingFailed`	Call Streaming Failed
`callBridged`	Call Bridged
`callInitiated`	Call Initiated
`callHangup`	Call Hangup
`callRecordingSaved`	Call Recording Saved
`callMachineDetectionEnded`	Call Machine Detection Ended
`callMachineGreetingEnded`	Call Machine Greeting Ended
`callMachinePremiumDetectionEnded`	Call Machine Premium Detection Ended
`callMachinePremiumGreetingEnded`	Call Machine Premium Greeting Ended

以下Webhook事件将发送到您配置的Webhook URL。所有Webhook均包含

telnyx-timestamp

和

telnyx-signature-ed25519

头部用于验证（兼容标准Webhooks）。

事件	描述
`callAnswered`	呼叫已接听
`callStreamingStarted`	呼叫流已启动
`callStreamingStopped`	呼叫流已停止
`callStreamingFailed`	呼叫流启动失败
`callBridged`	呼叫已桥接
`callInitiated`	呼叫已发起
`callHangup`	呼叫已挂断
`callRecordingSaved`	呼叫录音已保存
`callMachineDetectionEnded`	机器检测已结束
`callMachineGreetingEnded`	机器问候语已结束
`callMachinePremiumDetectionEnded`	高级机器检测已结束
`callMachinePremiumGreetingEnded`	高级机器问候语已结束