Back to Details

telnyx-sip-integrations-python

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->
<!-- 由Telnyx OpenAPI规范自动生成，请勿编辑。 -->

Telnyx Sip Integrations - Python

Telnyx SIP集成 - 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
已按照上述方式完成初始化。

List all call recordings

列出所有通话录音

Returns a list of your call recordings.
GET /recordings
python
page = client.recordings.list()
page = page.data[0]
print(page.id)
返回您的所有通话录音列表。
GET /recordings
python
page = client.recordings.list()
page = page.data[0]
print(page.id)

Retrieve a call recording

获取单个通话录音

Retrieves the details of an existing call recording.
GET /recordings/{recording_id}
python
recording = client.recordings.retrieve(
    "recording_id",
)
print(recording.data)
获取现有通话录音的详细信息。
GET /recordings/{recording_id}
python
recording = client.recordings.retrieve(
    "recording_id",
)
print(recording.data)

Delete a call recording

删除单个通话录音

Permanently deletes a call recording.
DELETE /recordings/{recording_id}
python
recording = client.recordings.delete(
    "recording_id",
)
print(recording.data)
永久删除指定通话录音。
DELETE /recordings/{recording_id}
python
recording = client.recordings.delete(
    "recording_id",
)
print(recording.data)

Delete a list of call recordings

删除多个通话录音

Permanently deletes a list of call recordings.
POST /recordings/actions/delete
python
client.recordings.actions.delete(
    ids=["428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "428c31b6-7af4-4bcb-b7f5-5013ef9657c2"],
)
永久删除一批通话录音。
POST /recordings/actions/delete
python
client.recordings.actions.delete(
    ids=["428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "428c31b6-7af4-4bcb-b7f5-5013ef9657c2"],
)

List all recording transcriptions

列出所有录音转写结果

Returns a list of your recording transcriptions.
GET /recording_transcriptions
python
recording_transcriptions = client.recording_transcriptions.list()
print(recording_transcriptions.data)
返回您的所有录音转写结果列表。
GET /recording_transcriptions
python
recording_transcriptions = client.recording_transcriptions.list()
print(recording_transcriptions.data)

Retrieve a recording transcription

获取单个录音转写结果

Retrieves the details of an existing recording transcription.
GET /recording_transcriptions/{recording_transcription_id}
python
recording_transcription = client.recording_transcriptions.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(recording_transcription.data)
获取现有录音转写结果的详细信息。
GET /recording_transcriptions/{recording_transcription_id}
python
recording_transcription = client.recording_transcriptions.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(recording_transcription.data)

Delete a recording transcription

删除单个录音转写结果

Permanently deletes a recording transcription.
DELETE /recording_transcriptions/{recording_transcription_id}
python
recording_transcription = client.recording_transcriptions.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(recording_transcription.data)
永久删除指定录音转写结果。
DELETE /recording_transcriptions/{recording_transcription_id}
python
recording_transcription = client.recording_transcriptions.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(recording_transcription.data)

Retrieve a stored credential

获取存储的凭证

Returns the information about custom storage credentials.
GET /custom_storage_credentials/{connection_id}
python
custom_storage_credential = client.custom_storage_credentials.retrieve(
    "connection_id",
)
print(custom_storage_credential.connection_id)
返回自定义存储凭证的相关信息。
GET /custom_storage_credentials/{connection_id}
python
custom_storage_credential = client.custom_storage_credentials.retrieve(
    "connection_id",
)
print(custom_storage_credential.connection_id)

Create a custom storage credential

创建自定义存储凭证

Creates a custom storage credentials configuration.
POST /custom_storage_credentials/{connection_id}
python
custom_storage_credential = client.custom_storage_credentials.create(
    connection_id="connection_id",
    backend="gcs",
    configuration={
        "backend": "gcs"
    },
)
print(custom_storage_credential.connection_id)
创建自定义存储凭证配置。
POST /custom_storage_credentials/{connection_id}
python
custom_storage_credential = client.custom_storage_credentials.create(
    connection_id="connection_id",
    backend="gcs",
    configuration={
        "backend": "gcs"
    },
)
print(custom_storage_credential.connection_id)

Update a stored credential

更新存储的凭证

Updates a stored custom credentials configuration.
PUT /custom_storage_credentials/{connection_id}
python
custom_storage_credential = client.custom_storage_credentials.update(
    connection_id="connection_id",
    backend="gcs",
    configuration={
        "backend": "gcs"
    },
)
print(custom_storage_credential.connection_id)
更新已存储的自定义凭证配置。
PUT /custom_storage_credentials/{connection_id}
python
custom_storage_credential = client.custom_storage_credentials.update(
    connection_id="connection_id",
    backend="gcs",
    configuration={
        "backend": "gcs"
    },
)
print(custom_storage_credential.connection_id)

Delete a stored credential

删除存储的凭证

Deletes a stored custom credentials configuration.
DELETE /custom_storage_credentials/{connection_id}
python
client.custom_storage_credentials.delete(
    "connection_id",
)
删除已存储的自定义凭证配置。
DELETE /custom_storage_credentials/{connection_id}
python
client.custom_storage_credentials.delete(
    "connection_id",
)

Retrieve stored Dialogflow Connection

获取存储的Dialogflow连接

Return details of the Dialogflow connection associated with the given CallControl connection.
GET /dialogflow_connections/{connection_id}
python
dialogflow_connection = client.dialogflow_connections.retrieve(
    "connection_id",
)
print(dialogflow_connection.data)
返回与指定CallControl连接关联的Dialogflow连接详情。
GET /dialogflow_connections/{connection_id}
python
dialogflow_connection = client.dialogflow_connections.retrieve(
    "connection_id",
)
print(dialogflow_connection.data)

Create a Dialogflow Connection

创建Dialogflow连接

Save Dialogflow Credentiails to Telnyx, so it can be used with other Telnyx services.
POST /dialogflow_connections/{connection_id}
python
dialogflow_connection = client.dialogflow_connections.create(
    connection_id="connection_id",
    service_account={
        "type": "bar",
        "project_id": "bar",
        "private_key_id": "bar",
        "private_key": "bar",
        "client_email": "bar",
        "client_id": "bar",
        "auth_uri": "bar",
        "token_uri": "bar",
        "auth_provider_x509_cert_url": "bar",
        "client_x509_cert_url": "bar",
    },
)
print(dialogflow_connection.data)
将Dialogflow凭证保存到Telnyx，以便与其他Telnyx服务配合使用。
POST /dialogflow_connections/{connection_id}
python
dialogflow_connection = client.dialogflow_connections.create(
    connection_id="connection_id",
    service_account={
        "type": "bar",
        "project_id": "bar",
        "private_key_id": "bar",
        "private_key": "bar",
        "client_email": "bar",
        "client_id": "bar",
        "auth_uri": "bar",
        "token_uri": "bar",
        "auth_provider_x509_cert_url": "bar",
        "client_x509_cert_url": "bar",
    },
)
print(dialogflow_connection.data)

Update stored Dialogflow Connection

更新存储的Dialogflow连接

Updates a stored Dialogflow Connection.
PUT /dialogflow_connections/{connection_id}
python
dialogflow_connection = client.dialogflow_connections.update(
    connection_id="connection_id",
    service_account={
        "type": "bar",
        "project_id": "bar",
        "private_key_id": "bar",
        "private_key": "bar",
        "client_email": "bar",
        "client_id": "bar",
        "auth_uri": "bar",
        "token_uri": "bar",
        "auth_provider_x509_cert_url": "bar",
        "client_x509_cert_url": "bar",
    },
)
print(dialogflow_connection.data)
更新已存储的Dialogflow连接配置。
PUT /dialogflow_connections/{connection_id}
python
dialogflow_connection = client.dialogflow_connections.update(
    connection_id="connection_id",
    service_account={
        "type": "bar",
        "project_id": "bar",
        "private_key_id": "bar",
        "private_key": "bar",
        "client_email": "bar",
        "client_id": "bar",
        "auth_uri": "bar",
        "token_uri": "bar",
        "auth_provider_x509_cert_url": "bar",
        "client_x509_cert_url": "bar",
    },
)
print(dialogflow_connection.data)

Delete stored Dialogflow Connection

删除存储的Dialogflow连接

Deletes a stored Dialogflow Connection.
DELETE /dialogflow_connections/{connection_id}
python
client.dialogflow_connections.delete(
    "connection_id",
)
删除已存储的Dialogflow连接。
DELETE /dialogflow_connections/{connection_id}
python
client.dialogflow_connections.delete(
    "connection_id",
)

List all External Connections

列出所有外部连接

This endpoint returns a list of your External Connections inside the 'data' attribute of the response.
GET /external_connections
python
page = client.external_connections.list()
page = page.data[0]
print(page.id)
该端点返回您的所有外部连接列表，结果在响应的'data'属性中。
GET /external_connections
python
page = client.external_connections.list()
page = page.data[0]
print(page.id)

Creates an External Connection

创建外部连接

Creates a new External Connection based on the parameters sent in the request.
POST /external_connections
— Required: 
external_sip_connection
, 
outbound
python
external_connection = client.external_connections.create(
    external_sip_connection="zoom",
    outbound={},
)
print(external_connection.data)
根据请求中发送的参数创建新的外部连接。
POST /external_connections
— 必填参数：
external_sip_connection
, 
outbound
python
external_connection = client.external_connections.create(
    external_sip_connection="zoom",
    outbound={},
)
print(external_connection.data)

Retrieve an External Connection

获取单个外部连接

Return the details of an existing External Connection inside the 'data' attribute of the response.
GET /external_connections/{id}
python
external_connection = client.external_connections.retrieve(
    "id",
)
print(external_connection.data)
返回现有外部连接的详情，结果在响应的'data'属性中。
GET /external_connections/{id}
python
external_connection = client.external_connections.retrieve(
    "id",
)
print(external_connection.data)

Update an External Connection

更新外部连接

Updates settings of an existing External Connection based on the parameters of the request.
PATCH /external_connections/{id}
— Required: 
outbound
python
external_connection = client.external_connections.update(
    id="id",
    outbound={
        "outbound_voice_profile_id": "outbound_voice_profile_id"
    },
)
print(external_connection.data)
根据请求参数更新现有外部连接的设置。
PATCH /external_connections/{id}
— 必填参数：
outbound
python
external_connection = client.external_connections.update(
    id="id",
    outbound={
        "outbound_voice_profile_id": "outbound_voice_profile_id"
    },
)
print(external_connection.data)

Deletes an External Connection

删除外部连接

Permanently deletes an External Connection.
DELETE /external_connections/{id}
python
external_connection = client.external_connections.delete(
    "id",
)
print(external_connection.data)
永久删除指定外部连接。
DELETE /external_connections/{id}
python
external_connection = client.external_connections.delete(
    "id",
)
print(external_connection.data)

List all civic addresses and locations

列出所有民用地址和位置

Returns the civic addresses and locations from Microsoft Teams.
GET /external_connections/{id}/civic_addresses
python
civic_addresses = client.external_connections.civic_addresses.list(
    id="id",
)
print(civic_addresses.data)
返回来自Microsoft Teams的民用地址和位置信息。
GET /external_connections/{id}/civic_addresses
python
civic_addresses = client.external_connections.civic_addresses.list(
    id="id",
)
print(civic_addresses.data)

Retrieve a Civic Address

获取单个民用地址

Return the details of an existing Civic Address with its Locations inside the 'data' attribute of the response.
GET /external_connections/{id}/civic_addresses/{address_id}
python
civic_address = client.external_connections.civic_addresses.retrieve(
    address_id="318fb664-d341-44d2-8405-e6bfb9ced6d9",
    id="id",
)
print(civic_address.data)
返回现有民用地址及其位置的详情，结果在响应的'data'属性中。
GET /external_connections/{id}/civic_addresses/{address_id}
python
civic_address = client.external_connections.civic_addresses.retrieve(
    address_id="318fb664-d341-44d2-8405-e6bfb9ced6d9",
    id="id",
)
print(civic_address.data)

Update a location's static emergency address

更新位置的静态紧急地址

PATCH /external_connections/{id}/locations/{location_id}
— Required: 
static_emergency_address_id
python
response = client.external_connections.update_location(
    location_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    static_emergency_address_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(response.data)
PATCH /external_connections/{id}/locations/{location_id}
— 必填参数：
static_emergency_address_id
python
response = client.external_connections.update_location(
    location_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    static_emergency_address_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(response.data)

List all phone numbers

列出所有电话号码

Returns a list of all active phone numbers associated with the given external connection.
GET /external_connections/{id}/phone_numbers
python
page = client.external_connections.phone_numbers.list(
    id="id",
)
page = page.data[0]
print(page.civic_address_id)
返回与指定外部连接关联的所有活跃电话号码列表。
GET /external_connections/{id}/phone_numbers
python
page = client.external_connections.phone_numbers.list(
    id="id",
)
page = page.data[0]
print(page.civic_address_id)

Retrieve a phone number

获取单个电话号码

Return the details of a phone number associated with the given external connection.
GET /external_connections/{id}/phone_numbers/{phone_number_id}
python
phone_number = client.external_connections.phone_numbers.retrieve(
    phone_number_id="1234567889",
    id="id",
)
print(phone_number.data)
返回与指定外部连接关联的电话号码详情。
GET /external_connections/{id}/phone_numbers/{phone_number_id}
python
phone_number = client.external_connections.phone_numbers.retrieve(
    phone_number_id="1234567889",
    id="id",
)
print(phone_number.data)

Update a phone number

更新电话号码

Asynchronously update settings of the phone number associated with the given external connection.
PATCH /external_connections/{id}/phone_numbers/{phone_number_id}
python
phone_number = client.external_connections.phone_numbers.update(
    phone_number_id="1234567889",
    id="id",
)
print(phone_number.data)
异步更新与指定外部连接关联的电话号码设置。
PATCH /external_connections/{id}/phone_numbers/{phone_number_id}
python
phone_number = client.external_connections.phone_numbers.update(
    phone_number_id="1234567889",
    id="id",
)
print(phone_number.data)

List all Releases

列出所有发布请求

Returns a list of your Releases for the given external connection.
GET /external_connections/{id}/releases
python
page = client.external_connections.releases.list(
    id="id",
)
page = page.data[0]
print(page.tenant_id)
返回指定外部连接的所有发布请求列表。
GET /external_connections/{id}/releases
python
page = client.external_connections.releases.list(
    id="id",
)
page = page.data[0]
print(page.tenant_id)

Retrieve a Release request

获取单个发布请求

Return the details of a Release request and its phone numbers.
GET /external_connections/{id}/releases/{release_id}
python
release = client.external_connections.releases.retrieve(
    release_id="7b6a6449-b055-45a6-81f6-f6f0dffa4cc6",
    id="id",
)
print(release.data)
返回发布请求及其关联电话号码的详情。
GET /external_connections/{id}/releases/{release_id}
python
release = client.external_connections.releases.retrieve(
    release_id="7b6a6449-b055-45a6-81f6-f6f0dffa4cc6",
    id="id",
)
print(release.data)

List all Upload requests

列出所有上传请求

Returns a list of your Upload requests for the given external connection.
GET /external_connections/{id}/uploads
python
page = client.external_connections.uploads.list(
    id="id",
)
page = page.data[0]
print(page.location_id)
返回指定外部连接的所有上传请求列表。
GET /external_connections/{id}/uploads
python
page = client.external_connections.uploads.list(
    id="id",
)
page = page.data[0]
print(page.location_id)

Creates an Upload request

创建上传请求

Creates a new Upload request to Microsoft teams with the included phone numbers.
POST /external_connections/{id}/uploads
— Required: 
number_ids
python
upload = client.external_connections.uploads.create(
    id="id",
    number_ids=["3920457616934164700", "3920457616934164701", "3920457616934164702", "3920457616934164703"],
)
print(upload.ticket_id)
创建新的上传请求，将指定电话号码上传至Microsoft Teams。
POST /external_connections/{id}/uploads
— 必填参数：
number_ids
python
upload = client.external_connections.uploads.create(
    id="id",
    number_ids=["3920457616934164700", "3920457616934164701", "3920457616934164702", "3920457616934164703"],
)
print(upload.ticket_id)

Refresh the status of all Upload requests

刷新所有上传请求的状态

Forces a recheck of the status of all pending Upload requests for the given external connection in the background.
POST /external_connections/{id}/uploads/refresh
python
response = client.external_connections.uploads.refresh_status(
    "id",
)
print(response.success)
后台强制重新检查指定外部连接的所有待处理上传请求状态。
POST /external_connections/{id}/uploads/refresh
python
response = client.external_connections.uploads.refresh_status(
    "id",
)
print(response.success)

Get the count of pending upload requests

获取待处理上传请求的数量

Returns the count of all pending upload requests for the given external connection.
GET /external_connections/{id}/uploads/status
python
response = client.external_connections.uploads.pending_count(
    "id",
)
print(response.data)
返回指定外部连接的所有待处理上传请求数量。
GET /external_connections/{id}/uploads/status
python
response = client.external_connections.uploads.pending_count(
    "id",
)
print(response.data)

Retrieve an Upload request

获取单个上传请求

Return the details of an Upload request and its phone numbers.
GET /external_connections/{id}/uploads/{ticket_id}
python
upload = client.external_connections.uploads.retrieve(
    ticket_id="7b6a6449-b055-45a6-81f6-f6f0dffa4cc6",
    id="id",
)
print(upload.data)
返回上传请求及其关联电话号码的详情。
GET /external_connections/{id}/uploads/{ticket_id}
python
upload = client.external_connections.uploads.retrieve(
    ticket_id="7b6a6449-b055-45a6-81f6-f6f0dffa4cc6",
    id="id",
)
print(upload.data)

Retry an Upload request

重试上传请求

If there were any errors during the upload process, this endpoint will retry the upload request.
POST /external_connections/{id}/uploads/{ticket_id}/retry
python
response = client.external_connections.uploads.retry(
    ticket_id="7b6a6449-b055-45a6-81f6-f6f0dffa4cc6",
    id="id",
)
print(response.data)
如果上传过程中出现错误，该端点将重试上传请求。
POST /external_connections/{id}/uploads/{ticket_id}/retry
python
response = client.external_connections.uploads.retry(
    ticket_id="7b6a6449-b055-45a6-81f6-f6f0dffa4cc6",
    id="id",
)
print(response.data)

List all log messages

列出所有日志消息

Retrieve a list of log messages for all external connections associated with your account.
GET /external_connections/log_messages
python
page = client.external_connections.log_messages.list()
page = page.log_messages[0]
print(page.code)
获取与您账户关联的所有外部连接的日志消息列表。
GET /external_connections/log_messages
python
page = client.external_connections.log_messages.list()
page = page.log_messages[0]
print(page.code)

Retrieve a log message

获取单个日志消息

Retrieve a log message for an external connection associated with your account.
GET /external_connections/log_messages/{id}
python
log_message = client.external_connections.log_messages.retrieve(
    "id",
)
print(log_message.log_messages)
获取与您账户关联的某个外部连接的日志消息。
GET /external_connections/log_messages/{id}
python
log_message = client.external_connections.log_messages.retrieve(
    "id",
)
print(log_message.log_messages)

Dismiss a log message

忽略日志消息

Dismiss a log message for an external connection associated with your account.
DELETE /external_connections/log_messages/{id}
python
response = client.external_connections.log_messages.dismiss(
    "id",
)
print(response.success)
忽略与您账户关联的某个外部连接的日志消息。
DELETE /external_connections/log_messages/{id}
python
response = client.external_connections.log_messages.dismiss(
    "id",
)
print(response.success)

Refresh Operator Connect integration

刷新Operator Connect集成

This endpoint will make an asynchronous request to refresh the Operator Connect integration with Microsoft Teams for the current user.
POST /operator_connect/actions/refresh
python
response = client.operator_connect.actions.refresh()
print(response.message)
该端点将发送异步请求，刷新当前用户与Microsoft Teams的Operator Connect集成。
POST /operator_connect/actions/refresh
python
response = client.operator_connect.actions.refresh()
print(response.message)

List uploaded media

列出已上传的媒体

Returns a list of stored media files.
GET /media
python
media = client.media.list()
print(media.data)
返回已存储的媒体文件列表。
GET /media
python
media = client.media.list()
print(media.data)

Upload media

上传媒体

Upload media file to Telnyx so it can be used with other Telnyx services
POST /media
— Required: 
media_url
python
response = client.media.upload(
    media_url="http://www.example.com/audio.mp3",
)
print(response.data)
将媒体文件上传至Telnyx，以便与其他Telnyx服务配合使用
POST /media
— 必填参数：
media_url
python
response = client.media.upload(
    media_url="http://www.example.com/audio.mp3",
)
print(response.data)

Retrieve stored media

获取已存储的媒体

Returns the information about a stored media file.
GET /media/{media_name}
python
media = client.media.retrieve(
    "media_name",
)
print(media.data)
返回已存储媒体文件的相关信息。
GET /media/{media_name}
python
media = client.media.retrieve(
    "media_name",
)
print(media.data)

Update stored media

更新已存储的媒体

Updates a stored media file.
PUT /media/{media_name}
python
media = client.media.update(
    media_name="media_name",
)
print(media.data)
更新已存储的媒体文件。
PUT /media/{media_name}
python
media = client.media.update(
    media_name="media_name",
)
print(media.data)

Deletes stored media

删除已存储的媒体

Deletes a stored media file.
DELETE /media/{media_name}
python
client.media.delete(
    "media_name",
)
删除已存储的媒体文件。
DELETE /media/{media_name}
python
client.media.delete(
    "media_name",
)

Download stored media

下载已存储的媒体

Downloads a stored media file.
GET /media/{media_name}/download
python
response = client.media.download(
    "media_name",
)
print(response)
content = response.read()
print(content)
下载已存储的媒体文件。
GET /media/{media_name}/download
python
response = client.media.download(
    "media_name",
)
print(response)
content = response.read()
print(content)