用途:在号码从 Telnyx 携出时管理携出(port-out)请求,包括列出、查看、评论、上传支持文档、生成报表以及授权或拒绝携出。
主要能力:
- 列出携出请求(GET /portouts,自动分页迭代器)。
- 获取单个携出请求(GET /portouts/{id})。
- 列出、查看、重新发布携出事件(/portouts/events)。
- 列出特定订单可用的拒绝代码(GET /portouts/rejections/{portout_id})。
- 列出与创建携出报表(/portouts/reports)。
- 列出与创建携出请求评论(/portouts/{id}/comments)。
- 列出与创建支持文档(/portouts/{id}/supporting_documents)。
- 更新状态,授权或拒绝携出(PATCH /portouts/{id}/{status},必填 reason)。
使用方式:先安装依赖 npm install telnyx@6.74.2,再用 import Telnyx from 'telnyx'; 初始化客户端,传入 process.env['TELNYX_API_KEY'],随后调用各 client.portouts 方法。列表方法返回自动分页迭代器,可用 for await (const item of result) {...} 遍历所有页。
错误处理:调用可能因网络、限流(429)、校验(422)或认证(401)失败,应使用 try/catch 并针对 APIConnectionError、RateLimitError、APIError 分别处理;429 可按 retry-after 退避重试。
适用场景:电信号码携出流程的自动化与监控。限制:具体功能、收费、价格与效果资料暂未提供。