SuperAPI AI 工具集

telnyx-fax-javascript

通用与其它

查看项目

更新于 10-16 04:53

技能介绍

用途:该技能面向使用 Telnyx Programmable Fax API 的 JavaScript 开发者,提供发送与接收传真、管理传真应用(Fax Applications)和媒体文件的 SDK 示例代码。

安装与初始化:使用 npm install telnyx 安装,然后通过 import Telnyx from 'telnyx' 引入,并用 API Key(如 process.env['TELNYX_API_KEY'])初始化客户端。

主要能力:

  1. 传真应用管理:列出、创建、检索、更新、删除传真应用(GET/POST /fax_applications,GET/PATCH/DELETE /fax_applications/{id}),创建时 application_name 与 webhook_event_url 为必填。
  2. 传真操作:列出传真(GET /faxes)、发送传真(POST /faxes,必填 connection_id、from、to)、查看传真(GET /faxes/{id})、删除传真(DELETE /faxes/{id})、取消处于 queued、media.processed、originated 或 sending 状态的出站传真(POST /faxes/{id}/actions/cancel)、刷新已过期的入站传真 media_url(POST /faxes/{id}/actions/refresh)。
  3. Webhook:支持 fax.delivered、fax.failed、fax.media.processed、fax.queued、fax.sending.started 等事件,使用 Ed25519 签名,请求头包含 telnyx-signature-ed25519 与 telnyx-timestamp,可用 client.webhooks.unwrap() 验证。

使用要点:电话号码须为 E.164 格式(如 +13125550001),含 + 与国家代码,不含空格、短横线或括号;列表方法返回自动分页迭代器,可用 for await 遍历;生产代码应处理网络错误、429 限流(指数退避重试)、422 校验错误、401 认证错误等。

限制:发送传真时文件超过 50MB 或超过 350 页会分别以 file_size_limit_exceeded 和 page_count_limit_exceeded 失败;删除传真应用时若仍被电话号码使用可能被阻止。具体收费、价格与平台支持情况暂未提供。