用途:在 JavaScript/Node.js 项目中调用 Telnyx 消息托管相关 API,覆盖托管短信号码订单、号码迁移与资格校验、RCS 富消息以及免费电话验证。
安装与初始化:npm install telnyx;import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: process.env['TELNYX_API_KEY'] });
主要能力:
- 托管号码订单:列出、创建、查询、删除订单,检查号码资格,上传文档,创建与校验验证码,删除托管号码。
- RCS:发送 RCS 消息(POST /messages/rcs,需 agent_id、to、messaging_profile_id、agent_message),生成 RCS 深链,列出/查询/修改 RCS 智能体,批量与单个查询 RCS 能力,添加测试号码。
- 免费电话验证:列出、提交、查询、更新验证请求(POST /messaging_tollfree/verification/requests 需 businessName、corporateWebsite、地址、联系人、messageVolume、phoneNumbers、useCase、useCaseSummary、productionMessageContent、optInWorkflow、optInWorkflowImageURLs、additionalInformation 等)。
使用要点:号码须为 E.164 格式(如 +13125550001),含 + 与国家代码,无空格、连字符或括号;列表方法返回自动分页迭代器,可用 for await (const item of result) 遍历。
错误处理:需处理网络错误、429 限流(按 retry-after 指数退避重试)、422 校验错误、401 认证错误等;常见状态码 401 密钥无效、403 权限不足、404 资源不存在。
限制:资料未提供收费、价格、平台支持范围与具体效果信息;部分接口参数与返回字段细节以官方文档为准。