免费在 GitHub 公开

telnyx-video-ruby

Create and manage video rooms for real-time video communication and conferencing. This skill provides Ruby SDK examples.

中文简介正在准备中。当前显示原文说明。

team-telnyx/ai

查看安装方法

包含的文件（1）

SKILL.md16.1 KB

SKILL.md（原文）

安装前可以查看交给 AI 代理的指令内容。

Telnyx Video - Ruby

Installation

gem install telnyx

Setup

require "telnyx"

client = Telnyx::Client.new(
  api_key: ENV["TELNYX_API_KEY"], # This is the default and can be omitted
  public_key: ENV["TELNYX_PUBLIC_KEY"], # Required for client.webhooks.unwrap (webhook verification)
)

All examples below assume client is already initialized as shown above.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

begin
  result = client.messages.send_(to: "+13125550001", from: "+13125550002", text: "Hello")
rescue Telnyx::Errors::APIConnectionError
  puts "Network error — check connectivity and retry"
  raise
rescue Telnyx::Errors::RateLimitError
  # 429: rate limited — wait, then retry the request (bounded exponential backoff)
  sleep(1) # Check Retry-After header for actual delay
  # ...retry the call here (give up after a few attempts); otherwise re-raise:
  raise
rescue Telnyx::Errors::APIStatusError => e
  puts "API error #{e.status}: #{e.message}"
  if e.status == 422
    puts "Validation error — check required fields and formats"
  end
  raise # A failed request must never look like success to the caller
end

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

View a list of room compositions.

Returns a paginated list of room compositions. Filter compositions by creation date, room session, or processing status.

GET /room_compositions

page = client.room_compositions.list

puts(page)

Returns: completed_at (date-time), created_at (date-time), download_url (string), duration_secs (integer), ended_at (date-time), format (enum: mp4), id (uuid), record_type (string), resolution (string), room_id (uuid), session_id (uuid), size_mb (float), started_at (date-time), status (enum: completed, enqueued, processing), updated_at (date-time), user_id (uuid), video_layout (object), webhook_event_failover_url (uri), webhook_event_url (uri), webhook_timeout_secs (integer)

Create a room composition.

Asynchronously create a room composition.

POST /room_compositions

Optional: format (string), resolution (string), session_id (uuid), video_layout (object), webhook_event_failover_url (uri), webhook_event_url (uri), webhook_timeout_secs (integer)

room_composition = client.room_compositions.create

puts(room_composition)

View a room composition.

Returns the composition identified by room_composition_id, including its room and session, processing status, media details, video layout, lifecycle timestamps, and download URL.

GET /room_compositions/{room_composition_id}

room_composition = client.room_compositions.retrieve("5219b3af-87c6-4c08-9b58-5a533d893e21")

puts(room_composition)

Delete a room composition.

Synchronously delete a room composition.

DELETE /room_compositions/{room_composition_id}

result = client.room_compositions.delete("5219b3af-87c6-4c08-9b58-5a533d893e21")

puts(result)

View a list of room participants.

Returns a paginated list of room participants across sessions. Filter participants by session, join, update, or leave date and by participant context.

GET /room_participants

page = client.room_participants.list

puts(page)

Returns: context (string), id (uuid), joined_at (date-time), left_at (date-time), record_type (string), session_id (uuid), updated_at (date-time)

View a room participant.

Returns the participant identified by room_participant_id, including its session, context, and join, update, and leave timestamps.

GET /room_participants/{room_participant_id}

room_participant = client.room_participants.retrieve("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")

puts(room_participant)

Returns: context (string), id (uuid), joined_at (date-time), left_at (date-time), record_type (string), session_id (uuid), updated_at (date-time)

View a list of room recordings.

Returns a paginated list of room recordings. Filter recordings by room, session, participant, recording type, status, duration, or start and end dates.

GET /room_recordings

page = client.room_recordings.list

puts(page)

Returns: codec (string), completed_at (date-time), created_at (date-time), download_url (string), duration_secs (integer), ended_at (date-time), id (uuid), participant_id (uuid), record_type (string), room_id (uuid), session_id (uuid), size_mb (float), started_at (date-time), status (enum: completed, processing), type (enum: audio, video), updated_at (date-time)

Delete several room recordings in a bulk.

Deletes the room recordings that match the supplied filters and returns the number of recordings affected. Filters support room, session, participant, recording type, status, duration, and start or end dates.

DELETE /room_recordings

response = client.room_recordings.delete_bulk

puts(response)

Returns: room_recordings (integer)

View a room recording.

Returns the recording identified by room_recording_id, including its room, session, participant, status, media details, lifecycle timestamps, and download URL.

GET /room_recordings/{room_recording_id}

room_recording = client.room_recordings.retrieve("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")

puts(room_recording)

Delete a room recording.

Synchronously deletes the specified video room recording. The recording's media is removed permanently.

DELETE /room_recordings/{room_recording_id}

result = client.room_recordings.delete("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")

puts(result)

View a list of room sessions.

Returns a paginated list of room sessions across the account. Filter sessions by room, creation, update, or end date and active status, and use include_participants to include participant records.

GET /room_sessions

page = client.rooms.sessions.list_0

puts(page)

Returns: active (boolean), created_at (date-time), ended_at (date-time), id (uuid), participants (array[object]), record_type (string), room_id (uuid), updated_at (date-time)

View a room session.

Returns the room session identified by room_session_id, including its room, active status, and lifecycle timestamps. Use include_participants to include its participant records.

GET /room_sessions/{room_session_id}

session = client.rooms.sessions.retrieve("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")

puts(session)

Returns: active (boolean), created_at (date-time), ended_at (date-time), id (uuid), participants (array[object]), record_type (string), room_id (uuid), updated_at (date-time)

End a room session.

Note: this will also kick all participants currently present in the room

POST /room_sessions/{room_session_id}/actions/end

response = client.rooms.sessions.actions.end_("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")

puts(response)

Returns: result (string)

Kick participants from a room session.

Removes the selected participants from the specified room session. Apply the action to a list of participant IDs or to all, with optional participant IDs excluded from the action.

POST /room_sessions/{room_session_id}/actions/kick

Optional: exclude (array[string]), participants (object)

response = client.rooms.sessions.actions.kick("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")

puts(response)

Returns: result (string)

Mute participants in room session.

Mutes the selected participants in the specified room session. Apply the action to a list of participant IDs or to all, with optional participant IDs excluded from the action.

POST /room_sessions/{room_session_id}/actions/mute

Optional: exclude (array[string]), participants (object)

response = client.rooms.sessions.actions.mute("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")

puts(response)

Returns: result (string)

Unmute participants in room session.

Unmutes the selected participants in the specified room session. Apply the action to a list of participant IDs or to all, with optional participant IDs excluded from the action.

POST /room_sessions/{room_session_id}/actions/unmute

Optional: exclude (array[string]), participants (object)

response = client.rooms.sessions.actions.unmute("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")

puts(response)

Returns: result (string)

View a list of room participants.

Returns a paginated list of participants for the specified room session. Filter participants by join, update, or leave date and by participant context.

GET /room_sessions/{room_session_id}/participants

page = client.rooms.sessions.retrieve_participants("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")

puts(page)

Returns: context (string), id (uuid), joined_at (date-time), left_at (date-time), record_type (string), session_id (uuid), updated_at (date-time)

View a list of rooms.

Returns a paginated list of rooms. Filter the results by creation or update date and unique name, and use include_sessions to include each room’s sessions.

GET /rooms

page = client.rooms.list

puts(page)

Returns: active_session_id (uuid), created_at (date-time), enable_recording (boolean), id (uuid), max_participants (integer), record_type (string), sessions (array[object]), unique_name (string), updated_at (date-time), webhook_event_failover_url (uri), webhook_event_url (uri), webhook_timeout_secs (integer)

Create a room.

Synchronously creates a new video room with the provided configuration and returns the created room.

POST /rooms

Optional: enable_recording (boolean), max_participants (integer), unique_name (string), webhook_event_failover_url (uri), webhook_event_url (uri), webhook_timeout_secs (integer)

room = client.rooms.create(unique_name: "my-meeting-room", max_participants: 10)
puts(room)

View a room.

Returns the room identified by room_id, including its participant limit, recording and webhook configuration, and active session identifier. Use include_sessions to include its sessions.

GET /rooms/{room_id}

room = client.rooms.retrieve("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")

puts(room)

Update a room.

Synchronously updates the specified video room's configuration and returns the updated room.

PATCH /rooms/{room_id}

Optional: enable_recording (boolean), max_participants (integer), unique_name (string), webhook_event_failover_url (uri), webhook_event_url (uri), webhook_timeout_secs (integer)

room = client.rooms.update("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")

puts(room)

Delete a room.

Synchronously delete a Room. Participants from that room will be kicked out, they won't be able to join that room anymore, and you won't be charged anymore for that room.

DELETE /rooms/{room_id}

result = client.rooms.delete("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")

puts(result)

Create Client Token to join a room.

Synchronously create an Client Token to join a Room. Client Token is necessary to join a Telnyx Room. Client Token will expire after token_ttl_secs, a Refresh Token is also provided to refresh a Client Token, the Refresh Token expires after refresh_token_ttl_secs.

POST /rooms/{room_id}/actions/generate_join_client_token

Optional: refresh_token_ttl_secs (integer), token_ttl_secs (integer)

response = client.rooms.actions.generate_join_client_token("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")

puts(response)

Returns: refresh_token (string), refresh_token_expires_at (date-time), token (string), token_expires_at (date-time)

Refresh Client Token to join a room.

Synchronously refresh an Client Token to join a Room. Client Token is necessary to join a Telnyx Room. Client Token will expire after token_ttl_secs.

POST /rooms/{room_id}/actions/refresh_client_token — Required: refresh_token

Optional: token_ttl_secs (integer)

response = client.rooms.actions.refresh_client_token(
  "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
  refresh_token: "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJ0ZWxueXhfdGVsZXBob255IiwiZXhwIjoxNTkwMDEwMTQzLCJpYXQiOjE1ODc1OTA5NDMsImlzcyI6InRlbG55eF90ZWxlcGhvbnkiLCJqdGkiOiJiOGM3NDgzNy1kODllLTRhNjUtOWNmMi0zNGM3YTZmYTYwYzgiLCJuYmYiOjE1ODc1OTA5NDIsInN1YiI6IjVjN2FjN2QwLWRiNjUtNGYxMS05OGUxLWVlYzBkMWQ1YzZhZSIsInRlbF90b2tlbiI6InJqX1pra1pVT1pNeFpPZk9tTHBFVUIzc2lVN3U2UmpaRmVNOXMtZ2JfeENSNTZXRktGQUppTXlGMlQ2Q0JSbWxoX1N5MGlfbGZ5VDlBSThzRWlmOE1USUlzenl6U2xfYURuRzQ4YU81MHlhSEd1UlNZYlViU1ltOVdJaVEwZz09IiwidHlwIjoiYWNjZXNzIn0.gNEwzTow5MLLPLQENytca7pUN79PmPj6FyqZWW06ZeEmesxYpwKh0xRtA0TzLh6CDYIRHrI8seofOO0YFGDhpQ"
)

puts(response)

Returns: token (string), token_expires_at (date-time)

View a list of room sessions.

Returns a paginated list of sessions for the specified room. Filter sessions by creation, update, or end date and active status, and use include_participants to include participant records.

GET /rooms/{room_id}/sessions

page = client.rooms.sessions.list_1("0ccc7b54-4df3-4bca-a65a-3da1ecc777f0")

puts(page)

Returns: active (boolean), created_at (date-time), ended_at (date-time), id (uuid), participants (array[object]), record_type (string), room_id (uuid), updated_at (date-time)

查看 team-telnyx 的全部技能

报告此技能的问题

安装

用命令安装

npx skills add https://github.com/team-telnyx/ai --skill telnyx-video-ruby

粘贴到终端中运行（需要 Node.js）。可以选择安装到 Claude Code、Codex 等代理。

让代理安装

请安装以下 Agent Skill。
https://github.com/team-telnyx/ai/tree/main/skills/telnyx-video-ruby

请先检查 SKILL.md 和附带文件的内容，确认没有可疑的处理（向外部发送数据、读取认证信息等）后，再放到 ~/.claude/skills/telnyx-video-ruby/（Claude Code）或 ~/.agents/skills/telnyx-video-ruby/（Codex）。

把这段文字直接发给 Claude Code 或 Codex，它会先检查内容再安装。

在 GitHub 查看源代码

仓库: team-telnyx/ai
星标: 222
复刻: 24
分类: 视频·图像·音频
许可证: MIT
原文语言: 英语
最后更新: 2026年10月21日

技能是给 AI 代理的指令和脚本的集合。cccskills 不保证其内容的安全性，安装前请务必确认内容。