SuperAPI AI 工具集

telnyx-video-curl

通用与其它

查看项目

更新于 10-16 05:36

技能介绍

用途

Telnyx Video - curl 是一个面向 Telnyx Video REST API 的命令行(curl)示例技能,用于创建和管理实时视频通信与会议房间。它通过一组可直接运行的 curl 命令,展示如何对 Telnyx 视频相关资源进行增删改查,适合在脚本、后端服务或调试过程中直接调用 API。

主要能力

该技能覆盖以下资源与操作:

  • 房间(rooms):查看房间列表、创建房间、查看单个房间、更新房间、删除房间。创建与更新时可设置 unique_name、max_participants、enable_recording、webhook_event_url、webhook_event_failover_url、webhook_timeout_secs 等可选字段。删除房间会踢出该房间内的参与者,参与者将无法再加入该房间。
  • 加入令牌:为房间生成 Client Token(POST /rooms/{room_id}/actions/generate_join_client_token),可设置 token_ttl_secs 与 refresh_token_ttl_secs;以及刷新 Client Token(POST /rooms/{room_id}/actions/refresh_client_token),需要提供 refresh_token,可选 token_ttl_secs。Client Token 是加入 Telnyx Room 所必需的。
  • 房间会话(room_sessions):查看会话列表、查看单个会话、结束会话、踢出参与者、静音参与者、取消静音参与者,以及查看某会话下的参与者列表。结束会话会同时踢出当前房间内的所有参与者。
  • 房间参与者(room_participants):查看参与者列表、查看单个参与者。
  • 房间录制(room_recordings):查看录制列表、查看单个录制、删除单个录制、批量删除多个录制。
  • 房间合成(room_compositions):查看合成列表、创建合成(异步)、查看单个合成、删除单个合成。

使用方式

安装:curl 在 macOS、Linux 和 Windows 10+ 上已预装。

设置认证:

export TELNYX_API_KEY="YOUR_API_KEY_HERE"

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

示例(创建房间):

curl
-X POST
-H "Authorization: Bearer $TELNYX_API_KEY"
-H "Content-Type: application/json"
-d '{ "unique_name": "my-meeting-room", "max_participants": 10 }'
"https://api.telnyx.com/v2/rooms"

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

适用场景

  • 在脚本或 CI 流程中直接调用 Telnyx Video REST API 进行房间与会话管理。
  • 后端服务集成实时视频会议能力时,参考 curl 示例快速验证接口。
  • 调试房间、参与者、录制与合成相关接口。

限制

资料未提供该技能的具体收费、价格、平台支持范围、性能指标或使用配额等信息。部分接口的请求体字段在资料中仅标注为可选或必填,未给出完整字段说明与取值约束。