Back to Details

telnyx-numbers-config-python

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

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

Telnyx Numbers Config - Python

Telnyx 号码配置 - 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
已按照上述方式完成初始化。

Lists the phone number blocks jobs

列出电话号码批量处理任务

GET /phone_number_blocks/jobs
python
page = client.phone_number_blocks.jobs.list()
page = page.data[0]
print(page.id)
GET /phone_number_blocks/jobs
python
page = client.phone_number_blocks.jobs.list()
page = page.data[0]
print(page.id)

Retrieves a phone number blocks job

获取单个电话号码批量处理任务

GET /phone_number_blocks/jobs/{id}
python
job = client.phone_number_blocks.jobs.retrieve(
    "id",
)
print(job.data)
GET /phone_number_blocks/jobs/{id}
python
job = client.phone_number_blocks.jobs.retrieve(
    "id",
)
print(job.data)

Deletes all numbers associated with a phone number block

删除与电话号码批量块关联的所有号码

Creates a new background job to delete all the phone numbers associated with the given block.
POST /phone_number_blocks/jobs/delete_phone_number_block
— Required: 
phone_number_block_id
python
response = client.phone_number_blocks.jobs.delete_phone_number_block(
    phone_number_block_id="f3946371-7199-4261-9c3d-81a0d7935146",
)
print(response.data)
创建一个新的后台任务，删除与指定批量块关联的所有电话号码。
POST /phone_number_blocks/jobs/delete_phone_number_block
— 必填参数：
phone_number_block_id
python
response = client.phone_number_blocks.jobs.delete_phone_number_block(
    phone_number_block_id="f3946371-7199-4261-9c3d-81a0d7935146",
)
print(response.data)

List phone numbers

列出电话号码

GET /phone_numbers
python
page = client.phone_numbers.list()
page = page.data[0]
print(page.id)
GET /phone_numbers
python
page = client.phone_numbers.list()
page = page.data[0]
print(page.id)

Retrieve a phone number

获取单个电话号码

GET /phone_numbers/{id}
python
phone_number = client.phone_numbers.retrieve(
    "1293384261075731499",
)
print(phone_number.data)
GET /phone_numbers/{id}
python
phone_number = client.phone_numbers.retrieve(
    "1293384261075731499",
)
print(phone_number.data)

Update a phone number

更新电话号码

PATCH /phone_numbers/{id}
Optional: 
address_id
(string), 
billing_group_id
(string), 
connection_id
(string), 
customer_reference
(string), 
external_pin
(string), 
hd_voice_enabled
(boolean), 
id
(string), 
tags
(array[string])
python
phone_number = client.phone_numbers.update(
    phone_number_id="1293384261075731499",
)
print(phone_number.data)
PATCH /phone_numbers/{id}
可选参数：
address_id
（字符串）, 
billing_group_id
（字符串）, 
connection_id
（字符串）, 
customer_reference
（字符串）, 
external_pin
（字符串）, 
hd_voice_enabled
（布尔值）, 
id
（字符串）, 
tags
（字符串数组）
python
phone_number = client.phone_numbers.update(
    phone_number_id="1293384261075731499",
)
print(phone_number.data)

Delete a phone number

删除电话号码

DELETE /phone_numbers/{id}
python
phone_number = client.phone_numbers.delete(
    "1293384261075731499",
)
print(phone_number.data)
DELETE /phone_numbers/{id}
python
phone_number = client.phone_numbers.delete(
    "1293384261075731499",
)
print(phone_number.data)

Change the bundle status for a phone number (set to being in a bundle or remove from a bundle)

修改电话号码的捆绑状态（加入捆绑或从捆绑中移除）

PATCH /phone_numbers/{id}/actions/bundle_status_change
— Required: 
bundle_id
python
response = client.phone_numbers.actions.change_bundle_status(
    id="1293384261075731499",
    bundle_id="5194d8fc-87e6-4188-baa9-1c434bbe861b",
)
print(response.data)
PATCH /phone_numbers/{id}/actions/bundle_status_change
— 必填参数：
bundle_id
python
response = client.phone_numbers.actions.change_bundle_status(
    id="1293384261075731499",
    bundle_id="5194d8fc-87e6-4188-baa9-1c434bbe861b",
)
print(response.data)

Enable emergency for a phone number

为电话号码启用紧急呼叫功能

POST /phone_numbers/{id}/actions/enable_emergency
— Required: 
emergency_enabled
, 
emergency_address_id
python
response = client.phone_numbers.actions.enable_emergency(
    id="1293384261075731499",
    emergency_address_id="53829456729313",
    emergency_enabled=True,
)
print(response.data)
POST /phone_numbers/{id}/actions/enable_emergency
— 必填参数：
emergency_enabled
, 
emergency_address_id
python
response = client.phone_numbers.actions.enable_emergency(
    id="1293384261075731499",
    emergency_address_id="53829456729313",
    emergency_enabled=True,
)
print(response.data)

Retrieve a phone number with voice settings

获取带语音设置的电话号码

GET /phone_numbers/{id}/voice
python
voice = client.phone_numbers.voice.retrieve(
    "1293384261075731499",
)
print(voice.data)
GET /phone_numbers/{id}/voice
python
voice = client.phone_numbers.voice.retrieve(
    "1293384261075731499",
)
print(voice.data)

Update a phone number with voice settings

更新电话号码的语音设置

PATCH /phone_numbers/{id}/voice
Optional: 
call_forwarding
(object), 
call_recording
(object), 
caller_id_name_enabled
(boolean), 
cnam_listing
(object), 
inbound_call_screening
(enum), 
media_features
(object), 
tech_prefix_enabled
(boolean), 
translated_number
(string), 
usage_payment_method
(enum)
python
voice = client.phone_numbers.voice.update(
    id="1293384261075731499",
)
print(voice.data)
PATCH /phone_numbers/{id}/voice
可选参数：
call_forwarding
（对象）, 
call_recording
（对象）, 
caller_id_name_enabled
（布尔值）, 
cnam_listing
（对象）, 
inbound_call_screening
（枚举）, 
media_features
（对象）, 
tech_prefix_enabled
（布尔值）, 
translated_number
（字符串）, 
usage_payment_method
（枚举）
python
voice = client.phone_numbers.voice.update(
    id="1293384261075731499",
)
print(voice.data)

Verify ownership of phone numbers

验证电话号码所有权

Verifies ownership of the provided phone numbers and returns a mapping of numbers to their IDs, plus a list of numbers not found in the account.
POST /phone_numbers/actions/verify_ownership
— Required: 
phone_numbers
python
response = client.phone_numbers.actions.verify_ownership(
    phone_numbers=["+15551234567"],
)
print(response.data)
验证提供的电话号码的所有权，返回号码与对应ID的映射关系，以及账户中未找到的号码列表。
POST /phone_numbers/actions/verify_ownership
— 必填参数：
phone_numbers
python
response = client.phone_numbers.actions.verify_ownership(
    phone_numbers=["+15551234567"],
)
print(response.data)

List CSV downloads

列出CSV下载任务

GET /phone_numbers/csv_downloads
python
page = client.phone_numbers.csv_downloads.list()
page = page.data[0]
print(page.id)
GET /phone_numbers/csv_downloads
python
page = client.phone_numbers.csv_downloads.list()
page = page.data[0]
print(page.id)

Create a CSV download

创建CSV下载任务

POST /phone_numbers/csv_downloads
python
csv_download = client.phone_numbers.csv_downloads.create()
print(csv_download.data)
POST /phone_numbers/csv_downloads
python
csv_download = client.phone_numbers.csv_downloads.create()
print(csv_download.data)

Retrieve a CSV download

获取CSV下载任务

GET /phone_numbers/csv_downloads/{id}
python
csv_download = client.phone_numbers.csv_downloads.retrieve(
    "id",
)
print(csv_download.data)
GET /phone_numbers/csv_downloads/{id}
python
csv_download = client.phone_numbers.csv_downloads.retrieve(
    "id",
)
print(csv_download.data)

Lists the phone numbers jobs

列出电话号码任务

GET /phone_numbers/jobs
python
page = client.phone_numbers.jobs.list()
page = page.data[0]
print(page.id)
GET /phone_numbers/jobs
python
page = client.phone_numbers.jobs.list()
page = page.data[0]
print(page.id)

Retrieve a phone numbers job

获取单个电话号码任务

GET /phone_numbers/jobs/{id}
python
job = client.phone_numbers.jobs.retrieve(
    "id",
)
print(job.data)
GET /phone_numbers/jobs/{id}
python
job = client.phone_numbers.jobs.retrieve(
    "id",
)
print(job.data)

Delete a batch of numbers

批量删除号码

Creates a new background job to delete a batch of numbers.
POST /phone_numbers/jobs/delete_phone_numbers
— Required: 
phone_numbers
python
response = client.phone_numbers.jobs.delete_batch(
    phone_numbers=["+19705555098", "+19715555098", "32873127836"],
)
print(response.data)
创建一个新的后台任务，批量删除多个号码。
POST /phone_numbers/jobs/delete_phone_numbers
— 必填参数：
phone_numbers
python
response = client.phone_numbers.jobs.delete_batch(
    phone_numbers=["+19705555098", "+19715555098", "32873127836"],
)
print(response.data)

Update the emergency settings from a batch of numbers

批量更新号码的紧急呼叫设置

Creates a background job to update the emergency settings of a collection of phone numbers.
POST /phone_numbers/jobs/update_emergency_settings
— Required: 
emergency_enabled
, 
phone_numbers
Optional: 
emergency_address_id
(['string', 'null'])
python
response = client.phone_numbers.jobs.update_emergency_settings_batch(
    emergency_enabled=True,
    phone_numbers=["+19705555098", "+19715555098", "32873127836"],
)
print(response.data)
创建后台任务，更新一组电话号码的紧急呼叫设置。
POST /phone_numbers/jobs/update_emergency_settings
— 必填参数：
emergency_enabled
, 
phone_numbers
可选参数：
emergency_address_id
（['字符串', '空值']）
python
response = client.phone_numbers.jobs.update_emergency_settings_batch(
    emergency_enabled=True,
    phone_numbers=["+19705555098", "+19715555098", "32873127836"],
)
print(response.data)

Update a batch of numbers

批量更新号码

Creates a new background job to update a batch of numbers.
POST /phone_numbers/jobs/update_phone_numbers
— Required: 
phone_numbers
Optional: 
billing_group_id
(string), 
connection_id
(string), 
customer_reference
(string), 
deletion_lock_enabled
(boolean), 
external_pin
(string), 
hd_voice_enabled
(boolean), 
tags
(array[string]), 
voice
(object)
python
response = client.phone_numbers.jobs.update_batch(
    phone_numbers=["1583466971586889004", "+13127367254"],
)
print(response.data)
创建一个新的后台任务，批量更新多个号码。
POST /phone_numbers/jobs/update_phone_numbers
— 必填参数：
phone_numbers
可选参数：
billing_group_id
（字符串）, 
connection_id
（字符串）, 
customer_reference
（字符串）, 
deletion_lock_enabled
（布尔值）, 
external_pin
（字符串）, 
hd_voice_enabled
（布尔值）, 
tags
（字符串数组）, 
voice
（对象）
python
response = client.phone_numbers.jobs.update_batch(
    phone_numbers=["1583466971586889004", "+13127367254"],
)
print(response.data)

Retrieve regulatory requirements for a list of phone numbers

获取电话号码的合规要求

GET /phone_numbers/regulatory_requirements
python
phone_numbers_regulatory_requirement = client.phone_numbers_regulatory_requirements.retrieve()
print(phone_numbers_regulatory_requirement.data)
GET /phone_numbers/regulatory_requirements
python
phone_numbers_regulatory_requirement = client.phone_numbers_regulatory_requirements.retrieve()
print(phone_numbers_regulatory_requirement.data)

Slim List phone numbers

精简版电话号码列表

List phone numbers, This endpoint is a lighter version of the /phone_numbers endpoint having higher performance and rate limit.
GET /phone_numbers/slim
python
page = client.phone_numbers.slim_list()
page = page.data[0]
print(page.id)
列出电话号码，该接口是/phone_numbers接口的轻量版本，具有更高的性能和调用频率限制。
GET /phone_numbers/slim
python
page = client.phone_numbers.slim_list()
page = page.data[0]
print(page.id)

List phone numbers with voice settings

列出带语音设置的电话号码

GET /phone_numbers/voice
python
page = client.phone_numbers.voice.list()
page = page.data[0]
print(page.id)
GET /phone_numbers/voice
python
page = client.phone_numbers.voice.list()
page = page.data[0]
print(page.id)

List Mobile Phone Numbers

列出移动电话号码

GET /v2/mobile_phone_numbers
python
page = client.mobile_phone_numbers.list()
page = page.data[0]
print(page.id)
GET /v2/mobile_phone_numbers
python
page = client.mobile_phone_numbers.list()
page = page.data[0]
print(page.id)

Retrieve a Mobile Phone Number

获取单个移动电话号码

GET /v2/mobile_phone_numbers/{id}
python
mobile_phone_number = client.mobile_phone_numbers.retrieve(
    "id",
)
print(mobile_phone_number.data)
GET /v2/mobile_phone_numbers/{id}
python
mobile_phone_number = client.mobile_phone_numbers.retrieve(
    "id",
)
print(mobile_phone_number.data)

Update a Mobile Phone Number

更新移动电话号码

PATCH /v2/mobile_phone_numbers/{id}
Optional: 
call_forwarding
(object), 
call_recording
(object), 
caller_id_name_enabled
(boolean), 
cnam_listing
(object), 
connection_id
(['string', 'null']), 
customer_reference
(['string', 'null']), 
inbound
(object), 
inbound_call_screening
(enum), 
noise_suppression
(boolean), 
outbound
(object), 
tags
(array[string])
python
mobile_phone_number = client.mobile_phone_numbers.update(
    id="id",
)
print(mobile_phone_number.data)
PATCH /v2/mobile_phone_numbers/{id}
可选参数：
call_forwarding
（对象）, 
call_recording
（对象）, 
caller_id_name_enabled
（布尔值）, 
cnam_listing
（对象）, 
connection_id
（['字符串', '空值']）, 
customer_reference
（['字符串', '空值']）, 
inbound
（对象）, 
inbound_call_screening
（枚举）, 
noise_suppression
（布尔值）, 
outbound
（对象）, 
tags
（字符串数组）
python
mobile_phone_number = client.mobile_phone_numbers.update(
    id="id",
)
print(mobile_phone_number.data)