SuperAPI AI 工具集

telnyx-video-javascript

设计与创作

查看项目

更新于 10-16 03:35

技能介绍

用途:面向使用 JavaScript 的开发者,演示如何通过 Telnyx 官方 Node SDK 调用 Video API,创建和管理实时视频房间、会议会话及相关资源。安装方式为 npm install telnyx@6.74.2。初始化时导入 Telnyx 并用 TELNYX_API_KEY 环境变量创建客户端,后续所有示例均基于已初始化的 client。

主要能力:

  • 房间管理:GET/POST /rooms、GET/PATCH/DELETE /rooms/{room_id},可设置 unique_name、max_participants、enable_recording、webhook 地址与超时。
  • 加入令牌:POST /rooms/{room_id}/actions/generate_join_client_token 生成加入所需 Client Token(含 refresh_token 与过期时间);POST /rooms/{room_id}/actions/refresh_client_token 刷新令牌。
  • 会话管理:查看房间会话列表与会话详情,POST .../sessions/{id}/actions/end 结束会话并踢出参与者,另有 kick、mute、unmute 动作;可查询会话内参与者。
  • 参与者:GET /room_participants 及详情。
  • 录制:GET/DELETE /room_recordings、批量删除 DELETE /room_recordings;录制含 codec、status、type(audio/video)、download_url 等字段。
  • 合成:GET/POST /room_compositions、详情与删除,状态为 enqueued、processing、completed。

使用方式:全部通过 client.rooms、client.rooms.sessions、client.rooms.actions、client.roomCompositions、client.roomParticipants、client.roomRecordings 等对象调用;列表接口支持异步分页迭代(for await)。生产代码需处理错误:Telnyx.APIConnectionError、RateLimitError(429,可指数退避重试)、APIError(如 422 校验错误),常见码包括 401 无效密钥、403 权限不足、404 未找到。

适用场景:需要在 JavaScript 应用中集成实时视频会议、房间生命周期管理、会话控制、录制与合成能力的后端服务。

限制:资料仅给出 API 调用与字段说明,未提供前端音视频接入、计费、价格或平台支持等细节;使用前须自行配置 API Key。