菜单
Build voice applications using TeXML markup language (TwiML-compatible). Manage applications, calls, conferences, recordings, queues, and streams. This skill provides Ruby SDK examples.
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/team-telnyx/telnyx-toolkit --skill telnyx-texml-ruby命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
Complete Telnyx toolkit — ready-to-use tools (STT, TTS, RAG, Networking, 10DLC) plus SDK documentation for JavaScript, Python, Go, Java, and Ruby.
Automated Telnyx bot account signup via challenge-response
Track agent activities using the Telnyx AI Missions API. Use this skill when executing multi-step tasks that should be logged and tracked. Supports creating voice/SMS agents, scheduling calls, and retrieving conversation insights. Use when tasks involve calling people, sending SMS, or any substantial tracked work.
正在显示 SKILL.md
基于 SOC 职业分类
| name | telnyx-texml-ruby |
| description | Build voice applications using TeXML markup language (TwiML-compatible). Manage applications, calls, conferences, recordings, queues, and streams. This skill provides Ruby SDK examples. |
| metadata | {"author":"telnyx","product":"texml","language":"ruby","generated_by":"telnyx-ext-skills-generator"} |
gem install telnyx
require "telnyx"
client = Telnyx::Client.new(
api_key: ENV["TELNYX_API_KEY"], # This is the default and can be omitted
)
All examples below assume client is already initialized as shown above.
Returns a list of your TeXML Applications.
GET /texml_applications
page = client.texml_applications.list
puts(page)
Creates a TeXML Application.
POST /texml_applications — Required: friendly_name, voice_url
texml_application = client.texml_applications.create(friendly_name: "call-router", voice_url: )
puts(texml_application)
Retrieves the details of an existing TeXML Application.
GET /texml_applications/{id}
texml_application = client.texml_applications.retrieve("1293384261075731499")
puts(texml_application)
Updates settings of an existing TeXML Application.
PATCH /texml_applications/{id} — Required: friendly_name, voice_url
texml_application = client.texml_applications.update(
"1293384261075731499",
friendly_name: "call-router",
voice_url: "https://example.com"
)
puts(texml_application)
Deletes a TeXML Application.
DELETE /texml_applications/{id}
texml_application = client.texml_applications.delete("1293384261075731499")
puts(texml_application)
Returns multiple call resources for an account.
GET /texml/Accounts/{account_sid}/Calls
response = client.texml.accounts.calls.retrieve_calls("account_sid")
puts(response)
Initiate an outbound TeXML call.
POST /texml/Accounts/{account_sid}/Calls — Required: To, From, ApplicationSid
response = client.texml.accounts.calls.calls(
"account_sid",
application_sid: "example-app-sid",
from: "+13120001234",
to: "+13121230000"
)
puts(response)
Returns an individual call identified by its CallSid.
GET /texml/Accounts/{account_sid}/Calls/{call_sid}
call = client.texml.accounts.calls.retrieve("call_sid", account_sid: "account_sid")
puts(call)
Update TeXML call.
POST /texml/Accounts/{account_sid}/Calls/{call_sid}
call = client.texml.accounts.calls.update("call_sid", account_sid: "account_sid")
puts(call)
Lists conference participants
GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants
response = client.texml.accounts.conferences.participants.retrieve_participants(
"conference_sid",
account_sid: "account_sid"
)
puts(response)
Dials a new conference participant
POST /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants
response = client.texml.accounts.conferences.participants.participants("conference_sid", account_sid: "account_sid")
puts(response)
Gets conference participant resource
GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}
participant = client.texml.accounts.conferences.participants.retrieve(
"call_sid_or_participant_label",
account_sid: "account_sid",
conference_sid: "conference_sid"
)
puts(participant)
Updates a conference participant
POST /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}
participant = client.texml.accounts.conferences.participants.update(
"call_sid_or_participant_label",
account_sid: "account_sid",
conference_sid: "conference_sid"
)
puts(participant)
Deletes a conference participant
DELETE /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}
result = client.texml.accounts.conferences.participants.delete(
"call_sid_or_participant_label",
account_sid: "account_sid",
conference_sid: "conference_sid"
)
puts(result)
Lists conference resources.
GET /texml/Accounts/{account_sid}/Conferences
response = client.texml.accounts.conferences.retrieve_conferences("account_sid")
puts(response)
Returns a conference resource.
GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}
conference = client.texml.accounts.conferences.retrieve("conference_sid", account_sid: "account_sid")
puts(conference)
Updates a conference resource.
POST /texml/Accounts/{account_sid}/Conferences/{conference_sid}
conference = client.texml.accounts.conferences.update("conference_sid", account_sid: "account_sid")
puts(conference)
Lists queue resources.
GET /texml/Accounts/{account_sid}/Queues
page = client.texml.accounts.queues.list("account_sid")
puts(page)
Creates a new queue resource.
POST /texml/Accounts/{account_sid}/Queues
queue = client.texml.accounts.queues.create("account_sid")
puts(queue)
Returns a queue resource.
GET /texml/Accounts/{account_sid}/Queues/{queue_sid}
queue = client.texml.accounts.queues.retrieve("queue_sid", account_sid: "account_sid")
puts(queue)
Updates a queue resource.
POST /texml/Accounts/{account_sid}/Queues/{queue_sid}
queue = client.texml.accounts.queues.update("queue_sid", account_sid: "account_sid")
puts(queue)
Delete a queue resource.
DELETE /texml/Accounts/{account_sid}/Queues/{queue_sid}
result = client.texml.accounts.queues.delete("queue_sid", account_sid: "account_sid")
puts(result)
Returns multiple recording resources for an account.
GET /texml/Accounts/{account_sid}/Recordings.json
response = client.texml.accounts.retrieve_recordings_json("account_sid")
puts(response)
Returns recording resource identified by recording id.
GET /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json
texml_get_call_recording_response_body = client.texml.accounts.recordings.json.retrieve_recording_sid_json(
"6a09cdc3-8948-47f0-aa62-74ac943d6c58",
account_sid: "account_sid"
)
puts(texml_get_call_recording_response_body)
Deletes recording resource identified by recording id.
DELETE /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json
result = client.texml.accounts.recordings.json.delete_recording_sid_json(
"6a09cdc3-8948-47f0-aa62-74ac943d6c58",
account_sid: "account_sid"
)
puts(result)
Returns recordings for a call identified by call_sid.
GET /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json
response = client.texml.accounts.calls.recordings_json.retrieve_recordings_json(
"call_sid",
account_sid: "account_sid"
)
puts(response)
Starts recording with specified parameters for call idientified by call_sid.
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json
response = client.texml.accounts.calls.recordings_json.recordings_json("call_sid", account_sid: "account_sid")
puts(response)
Updates recording resource for particular call.
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings/{recording_sid}.json
response = client.texml.accounts.calls.recordings.recording_sid_json(
"6a09cdc3-8948-47f0-aa62-74ac943d6c58",
account_sid: "account_sid",
call_sid: "call_sid"
)
puts(response)
Lists conference recordings
GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings
response = client.texml.accounts.conferences.retrieve_recordings("conference_sid", account_sid: "account_sid")
puts(response)
Returns recordings for a conference identified by conference_sid.
GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings.json
response = client.texml.accounts.conferences.retrieve_recordings_json("conference_sid", account_sid: "account_sid")
puts(response)
Create a TeXML secret which can be later used as a Dynamic Parameter for TeXML when using Mustache Templates in your TeXML.
POST /texml/secrets — Required: name, value
response = client.texml.secrets(name: "My Secret Name", value: "My Secret Value")
puts(response)
Starts siprec session with specified parameters for call idientified by call_sid.
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Siprec.json
response = client.texml.accounts.calls.siprec_json("call_sid", account_sid: "account_sid")
puts(response)
Updates siprec session identified by siprec_sid.
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Siprec/{siprec_sid}.json
response = client.texml.accounts.calls.siprec.siprec_sid_json(
"siprec_sid",
account_sid: "account_sid",
call_sid: "call_sid"
)
puts(response)
Starts streaming media from a call to a specific WebSocket address.
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Streams.json
response = client.texml.accounts.calls.streams_json("call_sid", account_sid: "account_sid")
puts(response)
Updates streaming resource for particular call.
POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Streams/{streaming_sid}.json
response = client.texml.accounts.calls.streams.streaming_sid_json(
"6a09cdc3-8948-47f0-aa62-74ac943d6c58",
account_sid: "account_sid",
call_sid: "call_sid"
)
puts(response)
Returns multiple recording transcription resources for an account.
GET /texml/Accounts/{account_sid}/Transcriptions.json
response = client.texml.accounts.retrieve_transcriptions_json("account_sid")
puts(response)
Returns the recording transcription resource identified by its ID.
GET /texml/Accounts/{account_sid}/Transcriptions/{recording_transcription_sid}.json
response = client.texml.accounts.transcriptions.json.retrieve_recording_transcription_sid_json(
"6a09cdc3-8948-47f0-aa62-74ac943d6c58",
account_sid: "account_sid"
)
puts(response)
Permanently deletes a recording transcription.
DELETE /texml/Accounts/{account_sid}/Transcriptions/{recording_transcription_sid}.json
result = client.texml.accounts.transcriptions.json.delete_recording_transcription_sid_json(
"6a09cdc3-8948-47f0-aa62-74ac943d6c58",
account_sid: "account_sid"
)
puts(result)
The following webhook events are sent to your configured webhook URL.
All webhooks include telnyx-timestamp and telnyx-signature-ed25519 headers for verification (Standard Webhooks compatible).
| Event | Description |
|---|---|
TexmlCallAnsweredWebhook | TeXML Call Answered. Webhook sent when a TeXML call is answered |
TexmlCallCompletedWebhook | TeXML Call Completed. Webhook sent when a TeXML call is completed |
TexmlCallInitiatedWebhook | TeXML Call Initiated. Webhook sent when a TeXML call is initiated |
TexmlCallRingingWebhook | TeXML Call Ringing. Webhook sent when a TeXML call is ringing |
TexmlCallAmdWebhook | TeXML Call AMD. Webhook sent when Answering Machine Detection (AMD) completes during a TeXML call |
TexmlCallDtmfWebhook | TeXML Call DTMF. Webhook sent when a DTMF digit is received during a TeXML call |
TexmlGatherWebhook | TeXML Gather. Webhook sent when a Gather command completes (sent to the action URL) |
TexmlHttpRequestWebhook | TeXML HTTP Request. Webhook sent as response to an HTTP Request instruction |
TexmlAiGatherWebhook | TeXML AI Gather. Webhook sent when AI Gather completes with transcription results |
TexmlConferenceJoinWebhook | TeXML Conference Join. Webhook sent when a participant joins a TeXML conference |
TexmlConferenceLeaveWebhook | TeXML Conference Leave. Webhook sent when a participant leaves a TeXML conference |
TexmlConferenceSpeakerWebhook | TeXML Conference Speaker. Webhook sent when a participant starts or stops speaking in a TeXML conference |
TexmlConferenceEndWebhook | TeXML Conference End. Webhook sent when a TeXML conference ends |
TexmlConferenceStartWebhook | TeXML Conference Start. Webhook sent when a TeXML conference starts |
TexmlQueueWebhook | TeXML Queue. Webhook sent for queue status events (triggered by Enqueue command waitUrl) |
TexmlRecordingCompletedWebhook | TeXML Recording Completed. Webhook sent when a recording is completed during a TeXML call (triggered by recordingStatusCallbackEvent) |
TexmlRecordingInProgressWebhook | TeXML Recording In-Progress. Webhook sent when a recording starts during a TeXML call (triggered by recordingStatusCallbackEvent) |
TexmlSiprecWebhook | TeXML SIPREC. Webhook sent for SIPREC session status updates |
TexmlStreamWebhook | TeXML Stream. Webhook sent for media streaming status updates |
TexmlTranscriptionWebhook | TeXML Transcription. Webhook sent when a recording transcription is completed |