SuperAPI AI 工具集

telnyx-numbers-config-javascript

编程与开发

查看项目

更新于 10-16 05:23

技能介绍

Telnyx Numbers Config(JavaScript)是面向使用 Telnyx 平台的开发者的配置类技能,重点在于通过 JavaScript SDK 对电话号码进行设置与管理,包括主叫号码显示、呼叫转移、短信启用和连接分配等。

用途 该技能用于在代码中配置和查询 Telnyx 电话号码的各类属性。涵盖单个号码的读取、更新与删除,以及针对批量号码的后台作业操作(批量删除、批量更新紧急设置、批量更新号码属性),并支持批量更新短信配置文件和校验号码归属。

主要能力

  • 批量更新号码短信配置:POST /messaging_numbers_bulk_updates,需提供 messaging_profile_id 与 numbers,可选 assign_only;返回 failed、order_id、pending、record_type、success。
  • 查询批量更新状态:GET /messaging_numbers_bulk_updates/{order_id}。
  • 列出移动电话号码及其短信设置:GET /mobile_phone_numbers/messaging,返回 country_code、features、messaging_profile_id 等字段,通过自动分页迭代器遍历。
  • 检索单个移动电话号码短信设置:GET /mobile_phone_numbers/{id}/messaging。
  • 列出电话号码:GET /phone_numbers,返回 billing_group_id、call_forwarding_enabled、call_recording_enabled、caller_id_name_enabled、connection_id、emergency_status、phone_number_type、status、tags 等大量字段。
  • 校验号码归属:POST /phone_numbers/actions/verify_ownership,需提供 phone_numbers,返回 found、not_found。
  • 号码作业列表与检索:GET /phone_numbers/jobs 与 GET /phone_numbers/jobs/{id},返回作业状态(pending、in_progress、completed、failed、expired)及成功/失败/待处理操作。
  • 批量删除号码:POST /phone_numbers/jobs/delete_phone_numbers,每次最多一千个号码。
  • 批量更新紧急设置:POST /phone_numbers/jobs/update_emergency_settings,需 emergency_enabled 与 phone_numbers,可选 emergency_address_id。
  • 批量更新号码属性:POST /phone_numbers/jobs/update_phone_numbers,可选字段包括 billing_group_id、connection_id、customer_reference、deletion_lock_enabled、external_pin、hd_voice_enabled、tags、voice。
  • 带短信设置与带语音设置的号码列表:GET /phone_numbers/messaging 与 GET /phone_numbers/voice。
  • 精简列表:GET /phone_numbers/slim,官方说明其性能与限流表现优于 /phone_numbers。
  • 单个号码检索、更新与删除:GET/PATCH/DELETE /phone_numbers/{id},更新可选字段含 address_id、billing_group_id、connection_id、customer_reference、external_pin、hd_voice_enabled、tags 等。

使用方式 安装:npm install telnyx。初始化:import Telnyx from 'telnyx',用 apiKey: process.env['TELNYX_API_KEY'] 创建 client(该参数为默认值,可省略)。文档建议在生产代码中统一处理错误,区分 Telnyx.APIConnectionError、Telnyx.RateLimitError(429,可按 retry-after 指数退避重试)和 Telnyx.APIError(如 422 校验错误)。列表方法返回自动分页迭代器,可用 for await (const item of result) 自动遍历所有分页。

适用场景 适用于需要以编程方式管理 Telnyx 电话号码配置的开发者,例如批量调整号码所属连接或短信配置文件、批量更新紧急呼叫设置、校验一批号码是否归属于当前账户、查询号码的语音或短信能力,以及删除不再使用的号码。

限制与注意事项

  • 号码必须为 E.164 格式(如 +13125550001),需包含 + 前缀与国家代码,不能含空格、连字符或括号。
  • 批量作业每次最多更新一千个号码;批量更新号码时至少需提交一个可更新字段。
  • 常见错误码:401 无效 API 密钥、403 权限不足、404 资源不存在、422 校验错误、429 触发限流(建议指数退避重试)。
  • 具体价格、计费方式、配额上限及服务等级等信息,资料中暂未提供。