SuperAPI AI 工具集

telnyx-fax-python

办公与效率

查看项目

更新于 10-16 05:41

技能介绍

用途:该技能面向需要以编程方式使用 Telnyx 传真能力的 Python 项目,覆盖发送与接收传真、管理传真应用和媒体资源,并提供 Python SDK 示例。

安装与初始化:使用 pip install telnyx 安装。初始化客户端时传入 api_key=os.environ.get("TELNYX_API_KEY")。所有示例默认 client 已按此方式初始化。

主要能力:

  • 传真应用:支持列出、创建、查询、更新、删除传真应用。创建时必填 application_name 与 webhook_event_url;更新同样必填这两项。应用用于配置如何通过可编程传真 API 收发传真。
  • 传真:支持查看传真列表、发送传真、查看单个传真、删除传真、取消处于 queued、media.processed、originated 或 sending 状态的外发传真、刷新已过期的入站传真 media_url。
  • 发送传真:必填 connection_id、from、to,可选 media_url、media_name、quality、monochrome、store_media、webhook_url 等。文件超过 50MB 或超过 350 页会分别以 file_size_limit_exceeded、page_count_limit_exceeded 失败。
  • Webhook:Telnyx 使用 Ed25519 签名,请求包含 telnyx-signature-ed25519 与 telnyx-timestamp 头。生产环境需验证签名,可使用 client.webhooks.unwrap(payload, headers=headers),并需使用原始请求体。事件包含 fax.delivered、fax.failed、fax.media.processed、fax.queued、fax.sending.started。

使用注意:电话号码需使用 E.164 格式(如 +13125550001),包含加号和国家代码,不能有空格、连字符或括号。列表方法返回自动分页迭代器,可用 for item in page_result 遍历所有页。所有 API 调用都可能失败,应处理网络错误、429 限流、422 校验错误、401 认证错误等;常见错误码包括 401、403、404、422、429,限流建议指数退避重试。

限制:资料未提供收费、价格或计费方式信息。具体可用地区、配额、账号权限等未在该资料中说明,需另行确认。