跳到正文
cccskills
免费在 GitHub 公开

telnyx-numbers-services-python

Configure voicemail, voice channels, and emergency (E911) services for your phone numbers. This skill provides Python SDK examples.

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(1)

  • SKILL.md12.7 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

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

Telnyx Numbers Services - 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
    public_key=os.environ.get("TELNYX_PUBLIC_KEY"),  # Required for client.webhooks.unwrap() (webhook verification)
)

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

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

import telnyx

try:
    result = client.messages.send(to="+13125550001", from_="+13125550002", text="Hello")
except telnyx.APIConnectionError:
    print("Network error — check connectivity and retry")
    raise
except telnyx.RateLimitError:
    # 429: rate limited — wait, then retry the request (bounded exponential backoff)
    import time
    time.sleep(1)  # Check Retry-After header for actual delay
    # ...retry the call here (give up after a few attempts); otherwise re-raise:
    raise
except telnyx.APIStatusError as e:
    print(f"API error {e.status_code}: {e.message}")
    if e.status_code == 422:
        print("Validation error — check required fields and formats")
    raise  # A failed request must never look like success to the caller

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

Important Notes

  • Pagination: List methods return an auto-paginating iterator. Use for item in page_result: to iterate through all pages automatically.

List your voice channels for non-US zones

Returns the non-US voice channels for your account. voice channels allow you to use Channel Billing for calls to your Telnyx phone numbers. Please check the Telnyx Support Articles section for full information and examples of how to utilize Channel Billing.

GET /channel_zones

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

Returns: channels (int64), countries (array[string]), created_at (string), id (string), name (string), record_type (enum: channel_zone), updated_at (string)

Update voice channels for non-US Zones

Update the number of Voice Channels for the Non-US Zones. This allows your account to handle multiple simultaneous inbound calls to Non-US numbers. Use this endpoint to increase or decrease your capacity based on expected call volume.

PUT /channel_zones/{channel_zone_id} — Required: channels

channel_zone = client.channel_zones.update(
    channel_zone_id="550e8400-e29b-41d4-a716-446655440000",
    channels=0,
)
print(channel_zone.id)

Returns: channels (int64), countries (array[string]), created_at (string), id (string), name (string), record_type (enum: channel_zone), updated_at (string)

List dynamic emergency addresses

Returns the dynamic emergency addresses according to filters

GET /dynamic_emergency_addresses

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

Returns: administrative_area (string), country_code (enum: US, CA, PR), created_at (string), extended_address (string), house_number (string), house_suffix (string), id (string), locality (string), postal_code (string), record_type (string), sip_geolocation_id (string), status (enum: pending, activated, rejected), street_name (string), street_post_directional (string), street_pre_directional (string), street_suffix (string), updated_at (string)

Create a dynamic emergency address.

Creates a dynamic emergency address, the validated physical location used when provisioning dynamic emergency endpoints.

POST /dynamic_emergency_addresses — Required: house_number, street_name, locality, administrative_area, postal_code, country_code

Optional: created_at (string), extended_address (string), house_suffix (string), id (string), record_type (string), sip_geolocation_id (string), status (enum: pending, activated, rejected), street_post_directional (string), street_pre_directional (string), street_suffix (string), updated_at (string)

dynamic_emergency_address = client.dynamic_emergency_addresses.create(
    administrative_area="TX",
    country_code="US",
    house_number="600",
    locality="Austin",
    postal_code="78701",
    street_name="Congress",
)
print(dynamic_emergency_address.data)

Returns: administrative_area (string), country_code (enum: US, CA, PR), created_at (string), extended_address (string), house_number (string), house_suffix (string), id (string), locality (string), postal_code (string), record_type (string), sip_geolocation_id (string), status (enum: pending, activated, rejected), street_name (string), street_post_directional (string), street_pre_directional (string), street_suffix (string), updated_at (string)

Get a dynamic emergency address

Returns the dynamic emergency address based on the ID provided

GET /dynamic_emergency_addresses/{id}

dynamic_emergency_address = client.dynamic_emergency_addresses.retrieve(
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(dynamic_emergency_address.data)

Returns: administrative_area (string), country_code (enum: US, CA, PR), created_at (string), extended_address (string), house_number (string), house_suffix (string), id (string), locality (string), postal_code (string), record_type (string), sip_geolocation_id (string), status (enum: pending, activated, rejected), street_name (string), street_post_directional (string), street_pre_directional (string), street_suffix (string), updated_at (string)

Delete a dynamic emergency address

Deletes the dynamic emergency address based on the ID provided

DELETE /dynamic_emergency_addresses/{id}

dynamic_emergency_address = client.dynamic_emergency_addresses.delete(
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(dynamic_emergency_address.data)

Returns: administrative_area (string), country_code (enum: US, CA, PR), created_at (string), extended_address (string), house_number (string), house_suffix (string), id (string), locality (string), postal_code (string), record_type (string), sip_geolocation_id (string), status (enum: pending, activated, rejected), street_name (string), street_post_directional (string), street_pre_directional (string), street_suffix (string), updated_at (string)

List dynamic emergency endpoints

Returns the dynamic emergency endpoints according to filters

GET /dynamic_emergency_endpoints

page = client.dynamic_emergency_endpoints.list()
page = page.data[0]
print(page.dynamic_emergency_address_id)

Returns: callback_number (string), caller_name (string), created_at (string), dynamic_emergency_address_id (string), id (string), record_type (string), sip_from_id (string), status (enum: pending, activated, rejected), updated_at (string)

Create a dynamic emergency endpoint.

Creates a dynamic emergency endpoint, associating a callback number and location with a device for emergency calling.

POST /dynamic_emergency_endpoints — Required: dynamic_emergency_address_id, callback_number, caller_name

Optional: created_at (string), id (string), record_type (string), sip_from_id (string), status (enum: pending, activated, rejected), updated_at (string)

dynamic_emergency_endpoint = client.dynamic_emergency_endpoints.create(
    callback_number="+13125550000",
    caller_name="Jane Doe Desk Phone",
    dynamic_emergency_address_id="0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
)
print(dynamic_emergency_endpoint.data)

Returns: callback_number (string), caller_name (string), created_at (string), dynamic_emergency_address_id (string), id (string), record_type (string), sip_from_id (string), status (enum: pending, activated, rejected), updated_at (string)

Get a dynamic emergency endpoint

Returns the dynamic emergency endpoint based on the ID provided

GET /dynamic_emergency_endpoints/{id}

dynamic_emergency_endpoint = client.dynamic_emergency_endpoints.retrieve(
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(dynamic_emergency_endpoint.data)

Returns: callback_number (string), caller_name (string), created_at (string), dynamic_emergency_address_id (string), id (string), record_type (string), sip_from_id (string), status (enum: pending, activated, rejected), updated_at (string)

Delete a dynamic emergency endpoint

Deletes the dynamic emergency endpoint based on the ID provided

DELETE /dynamic_emergency_endpoints/{id}

dynamic_emergency_endpoint = client.dynamic_emergency_endpoints.delete(
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(dynamic_emergency_endpoint.data)

Returns: callback_number (string), caller_name (string), created_at (string), dynamic_emergency_address_id (string), id (string), record_type (string), sip_from_id (string), status (enum: pending, activated, rejected), updated_at (string)

List your voice channels for US Zone

Returns the US Zone voice channels for your account. voice channels allows you to use Channel Billing for calls to your Telnyx phone numbers. Please check the Telnyx Support Articles section for full information and examples of how to utilize Channel Billing.

GET /inbound_channels

inbound_channels = client.inbound_channels.list()
print(inbound_channels.data)

Returns: channels (integer), record_type (string)

Update voice channels for US Zone

Update the number of Voice Channels for the US Zone. This allows your account to handle multiple simultaneous inbound calls to US numbers. Use this endpoint to increase or decrease your capacity based on expected call volume.

PATCH /inbound_channels — Required: channels

inbound_channel = client.inbound_channels.update(
    channels=7,
)
print(inbound_channel.data)

Returns: channels (integer), record_type (string)

List All Numbers using Channel Billing

Retrieve a list of all phone numbers using Channel Billing, grouped by Zone.

GET /list

response = client.list.retrieve_all()
print(response.data)

Returns: number_of_channels (integer), numbers (array[object]), zone_id (string), zone_name (string)

List Numbers using Channel Billing for a specific Zone

Retrieve a list of phone numbers using Channel Billing for a specific Zone.

GET /list/{channel_zone_id}

response = client.list.retrieve_by_zone(
    "channel_zone_id",
)
print(response.data)

Returns: number_of_channels (integer), numbers (array[object]), zone_id (string), zone_name (string)

Get voicemail

Returns the voicemail settings for a phone number

GET /phone_numbers/{phone_number_id}/voicemail

voicemail = client.phone_numbers.voicemail.retrieve(
    "123455678900",
)
print(voicemail.data)

Returns: enabled (boolean), greeting (object), pin (string)

Create voicemail

Create voicemail settings for a phone number. You can also configure a custom greeting by setting the greeting object: use mode custom_greeting together with a media_name that points to an audio file uploaded through the Media Storage API, or mode default to use the standard system greeting.

POST /phone_numbers/{phone_number_id}/voicemail

Optional: enabled (boolean), greeting (object), pin (string)

voicemail = client.phone_numbers.voicemail.create(
    phone_number_id="123455678900",
)
print(voicemail.data)

Returns: enabled (boolean), greeting (object), pin (string)

Update voicemail

Update voicemail settings for a phone number. You can also configure a custom greeting by setting the greeting object: use mode custom_greeting together with a media_name that points to an audio file uploaded through the Media Storage API, or mode default to use the standard system greeting.

PATCH /phone_numbers/{phone_number_id}/voicemail

Optional: enabled (boolean), greeting (object), pin (string)

voicemail = client.phone_numbers.voicemail.update(
    phone_number_id="123455678900",
)
print(voicemail.data)

Returns: enabled (boolean), greeting (object), pin (string)

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Test VoIP push notifications for Telnyx WebRTC iOS (APNs) and Android (FCM) apps. Use when debugging push notification delivery, validating certificate/credential setup, or testing that a device receives VoIP pushes correctly.

中文简介正在准备中。当前显示原文说明。

team-telnyx/ai2222026年10月22日 更新

10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.

中文简介正在准备中。当前显示原文说明。

team-telnyx/ai2222026年10月22日 更新

10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.

中文简介正在准备中。当前显示原文说明。

team-telnyx/ai2222026年10月22日 更新

10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.

中文简介正在准备中。当前显示原文说明。

team-telnyx/ai2222026年10月22日 更新

10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.

中文简介正在准备中。当前显示原文说明。

team-telnyx/ai2222026年10月22日 更新

10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.

中文简介正在准备中。当前显示原文说明。

team-telnyx/ai2222026年10月22日 更新

查看 team-telnyx 的全部技能

报告此技能的问题