Telnyx Porting In - JavaScript 是一个用于将电话号码携入 Telnyx 平台的 JavaScript SDK 技能。它基于 telnyx npm 包(版本 6.74.2),提供了一系列 API 方法,帮助开发者自动化携号转网流程。
用途
该技能主要用于管理电话号码从其他运营商携入 Telnyx 的完整流程,包括检查号码可携性、创建携转订单、上传 LOA 文档、跟踪携转状态以及生成相关报告。
主要能力
- 可携性检查:运行可携性检查,立即返回结果,包括号码是否可携、不可携原因等。
- 携转事件管理:列出所有携转事件、查看特定事件、重新发布事件。
- LOA 配置管理:列出、创建、预览、检索、更新和删除 LOA 配置。LOA 配置包含地址、公司名称、联系人、Logo 等信息。
- 携转报告:列出和创建携转相关报告,支持导出携转订单 CSV。
- 英国运营商列表:列出英国可用的运营商。
- 携转订单管理:列出、创建、检索、编辑和删除携转订单。订单包含电话号码、客户参考、激活设置、文档、终端用户等信息。
- 电话号码配置:列出和创建电话号码配置。
- 异常类型:列出所有可能的携转订单异常类型。
- 订单操作:异步激活携转订单中的每个号码(仅限美国 FastPort 订单)、取消携转订单。
使用方式
首先安装 SDK:
npm install telnyx@6.74.2
然后初始化客户端:
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'],
});
之后即可调用各 API 方法。例如,运行可携性检查:
const response = await client.portabilityChecks.run({
phone_numbers: ["+18005550101"],
});
console.log(response.data);
创建携转订单:
const portingOrder = await client.portingOrders.create({
phone_numbers: ['+13035550000', '+13035550001', '+13035550002'],
});
console.log(portingOrder.data);
适用场景
适用于需要自动化电话号码携入流程的开发者,例如电信运营商、VoIP 服务提供商或企业通信系统集成商。
限制
- 电话号码必须使用 E.164 格式(如 +13125550001),包含 + 前缀和国家代码,不能有空格、破折号或括号。
- 所有 API 调用可能失败,需处理网络错误、速率限制(429)、验证错误(422)和认证错误(401)。
- 删除携转订单仅限草稿状态。
- 异步激活操作仅限美国 FastPort 订单。
- 列表方法返回自动分页迭代器,需使用 for await...of 遍历。
- 其他具体限制暂未提供。