SuperAPI AI 工具集

telnyx-sip-curl

部署与运维

查看项目

更新于 10-16 04:22

技能介绍

用途

Telnyx SIP(curl 版)是一份基于 curl 的 API 操作技能,用于配置 SIP 中继连接(SIP trunking connections)与出站语音配置文件(outbound voice profiles)。当需要连接 PBX 系统或管理 SIP 基础设施时,可参考本技能提供的 REST API 调用方式。

安装与认证

curl 在 macOS、Linux 和 Windows 10+ 上已预装,无需额外安装。使用前需设置 API 密钥环境变量:

export TELNYX_API_KEY="YOUR_API_KEY_HERE"

文档中所有示例均使用 $TELNYX_API_KEY 进行认证,请求头为 Authorization: Bearer $TELNYX_API_KEY。

主要能力

技能覆盖以下 Telnyx API 操作:

  • 访问 IP 范围(Access IP Ranges):列出全部、创建新的访问 IP 范围(必填 cidr_block,可选 description)、删除指定访问 IP 范围。
  • 连接(Connections):列出所有类型的连接(支持 sort 参数,如 sort=connection_name)、检索指定连接的概要信息。
  • 凭证连接(Credential Connections):列出、创建(必填 user_name、password、connection_name)、检索、更新(PATCH)、删除,以及检查凭证连接的注册状态(registration_status 与 registration_status_updated_at)。
  • FQDN 连接(FQDN Connections):列出 FQDN 连接、创建 FQDN 连接(必填 connection_name)。

各接口文档列出了返回字段,例如连接返回 active、connection_name、id、outbound_voice_profile_id、record_type、tags、webhook_api_version、webhook_event_url 等;凭证连接还包含 dtmf_type、encrypted_media、noise_suppression、sip_uri_calling_preference、user_name、password 等字段;FQDN 连接包含 transport_protocol、txt_name、txt_ttl、txt_value、microsoft_teams_sbc 等字段。

使用方式

以 curl 直接调用 Telnyx API 端点,例如列出访问 IP 范围:

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/access_ip_ranges"

创建凭证连接示例:

curl -X POST -H "Authorization: Bearer $TELNYX_API_KEY" -H "Content-Type: application/json" -d '{"user_name": "myusername123", "password": "my123secure456password789", "connection_name": "office-connection"}' "https://api.telnyx.com/v2/credential_connections"

检查凭证连接注册状态:

curl -X POST -H "Authorization: Bearer $TELNYX_API_KEY" -H "Content-Type: application/json" "https://api.telnyx.com/v2/credential_connections/550e8400-e29b-41d4-a716-446655440000/actions/check_registration_status"

错误处理

文档建议在生产代码中始终处理错误。API 调用可能因网络错误、速率限制(429)、校验错误(422)或认证错误(401)而失败。示例通过 -w "\n%{http_code}" 获取 HTTP 状态码并分支处理:2* 为成功,422 为校验错误(检查必填字段与格式),429 为速率限制(延迟后重试),401 为认证失败(检查 TELNYX_API_KEY)。常见错误码还包括 403 权限不足、404 资源未找到。

分页

列表端点返回分页结果,可使用 page[number] 和 page[size] 查询参数翻页,并检查响应中的 meta.total_pages。

适用场景与限制

适用于通过命令行或脚本管理 Telnyx SIP 中继、凭证连接、FQDN 连接与访问 IP 范围,以及连接 PBX 系统等场景。文档未提供收费、价格、平台支持范围或具体效果等信息,暂未提供。