SuperAPI AI 工具集

telnyx-sip-ruby

通用与其它

查看项目

更新于 10-16 05:42

技能介绍

用途:该技能面向使用 Ruby 的开发者,提供通过官方 telnyx gem 调用 Telnyx API 来配置 SIP 中继连接、出站语音配置以及管理 SIP 基础设施的能力,适用于连接 PBX 系统等场景。

安装与初始化:执行 gem install telnyx 安装 SDK,然后通过 require "telnyx" 引入并创建客户端:client = Telnyx::Client.new(api_key: ENV["TELNYX_API_KEY"]),api_key 为默认参数可省略。后续示例均假定客户端已初始化。

主要能力:

  1. 访问 IP 范围:列出、创建(必填 cidr_block,可选 description)、删除访问 IP 范围。
  2. 连接管理:列出所有类型的连接、检索单个连接详情;支持凭证连接(credential_connections)与 FQDN 连接的列出、创建、检索、更新、删除,并可检查凭证连接的 SIP 注册状态。
  3. 凭证连接创建必填 user_name、password、connection_name,可选参数涵盖加密媒体(SRTP/None)、DTMF 类型、噪声抑制、Webhook 配置、抖动缓冲等。
  4. FQDN 连接创建必填 connection_name,可选 transport_protocol(UDP/TCP/TLS)、microsoft_teams_sbc 等。
  5. 分页:使用 page.auto_paging_each { |item| puts item.id } 自动迭代。

错误处理:所有 API 调用可能因网络、限流(429)、校验(422)或认证(401)失败。需在生产代码中捕获 Telnyx::Errors::APIConnectionError、RateLimitError(429,可依据 Retry-After 延迟重试)、APIStatusError。常见错误码:401 密钥无效、403 权限不足、404 资源不存在、422 校验错误、429 触发限流。

适用场景:需要通过 Ruby 代码管理 Telnyx SIP 连接、PBX 对接、凭证/FQDN 连接生命周期及注册状态查询的集成开发。

限制:资料未提供定价、套餐或性能指标等信息;示例中占位 UUID、账号与密码均为示意,需替换为实际值;具体各接口的完整可选字段与枚举含义以 Telnyx 官方文档为准。