Telnyx Texml - Ruby

Installation

bash

gem install telnyx

Setup

ruby

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.

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:

ruby

begin
  result = client.messages.send_(to: "+13125550001", from: "+13125550002", text: "Hello")
rescue Telnyx::Errors::APIConnectionError
  puts "Network error — check connectivity and retry"
rescue Telnyx::Errors::RateLimitError
  # 429: rate limited — wait and retry with exponential backoff
  sleep(1) # Check Retry-After header for actual delay
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
end

Common error codes:

invalid API key,

insufficient permissions,

resource not found,

validation error (check field formats),

rate limited (retry with exponential backoff).

Important Notes

Pagination: Use

.auto_paging_each

for automatic iteration:

page.auto_paging_each { |item| puts item.id }

Fetch multiple call resources

Returns multiple call resources for an account. This endpoint is eventually consistent.

GET /texml/Accounts/{account_sid}/Calls

ruby

response = client.texml.accounts.calls.retrieve_calls("account_sid")

puts(response)

Returns:

calls

(array[object]),

end

(integer),

first_page_uri

(string),

next_page_uri

(string),

page

(integer),

page_size

(integer),

start

(integer),

uri

(string)

Initiate an outbound call

Initiate an outbound TeXML call. Telnyx will request TeXML from the XML Request URL configured for the connection in the Mission Control Portal.

POST /texml/Accounts/{account_sid}/Calls

— Required:

To

From

ApplicationSid

Optional:

AsyncAmd

(boolean),

AsyncAmdStatusCallback

(string),

AsyncAmdStatusCallbackMethod

(enum: GET, POST),

CallerId

(string),

CancelPlaybackOnDetectMessageEnd

(boolean),

CancelPlaybackOnMachineDetection

(boolean),

CustomHeaders

(array[object]),

DetectionMode

(enum: Premium, Regular),

FallbackUrl

(string),

MachineDetection

(enum: Enable, Disable, DetectMessageEnd),

MachineDetectionSilenceTimeout

(integer),

MachineDetectionSpeechEndThreshold

(integer),

MachineDetectionSpeechThreshold

(integer),

MachineDetectionTimeout

(integer),

PreferredCodecs

(string),

Record

(boolean),

RecordingChannels

(enum: mono, dual),

RecordingStatusCallback

(string),

RecordingStatusCallbackEvent

(string),

RecordingStatusCallbackMethod

(enum: GET, POST),

RecordingTimeout

(integer),

RecordingTrack

(enum: inbound, outbound, both),

SendRecordingUrl

(boolean),

SipAuthPassword

(string),

SipAuthUsername

(string),

SipRegion

(enum: US, Europe, Canada, Australia, Middle East),

StatusCallback

(string),

StatusCallbackEvent

(enum: initiated, ringing, answered, completed),

StatusCallbackMethod

(enum: GET, POST),

SuperviseCallSid

(string),

SupervisingRole

(enum: barge, whisper, monitor),

Texml

(string),

TimeLimit

(integer),

Timeout

(integer),

Trim

(enum: trim-silence, do-not-trim),

Url

(string),

UrlMethod

(enum: GET, POST)

ruby

response = client.texml.accounts.calls.calls(
  "account_sid",
  application_sid: "example-app-sid",
  from: "+13120001234",
  to: "+13121230000"
)

puts(response)

Returns:

from

(string),

status

(string),

to

(string)

Fetch a call

Returns an individual call identified by its CallSid. This endpoint is eventually consistent.

GET /texml/Accounts/{account_sid}/Calls/{call_sid}

ruby

call = client.texml.accounts.calls.retrieve("call_sid", account_sid: "550e8400-e29b-41d4-a716-446655440000")

puts(call)

Returns:

account_sid

(string),

answered_by

(enum: human, machine, not_sure),

caller_name

(string),

date_created

(string),

date_updated

(string),

direction

(enum: inbound, outbound),

duration

(string),

end_time

(string),

from

(string),

from_formatted

(string),

price

(string),

price_unit

(string),

sid

(string),

start_time

(string),

status

(enum: ringing, in-progress, canceled, completed, failed, busy, no-answer),

to

(string),

to_formatted

(string),

uri

(string)

Update call

Update TeXML call. Please note that the keys present in the payload MUST BE formatted in CamelCase as specified in the example.

POST /texml/Accounts/{account_sid}/Calls/{call_sid}

ruby

call = client.texml.accounts.calls.update("call_sid", account_sid: "550e8400-e29b-41d4-a716-446655440000")

puts(call)

Returns:

account_sid

(string),

answered_by

(enum: human, machine, not_sure),

caller_name

(string),

date_created

(string),

date_updated

(string),

direction

(enum: inbound, outbound),

duration

(string),

end_time

(string),

from

(string),

from_formatted

(string),

price

(string),

price_unit

(string),

sid

(string),

start_time

(string),

status

(enum: ringing, in-progress, canceled, completed, failed, busy, no-answer),

to

(string),

to_formatted

(string),

uri

(string)

Fetch recordings for a call

Returns recordings for a call identified by call_sid.

GET /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json

ruby

response = client.texml.accounts.calls.recordings_json.retrieve_recordings_json(
  "call_sid",
  account_sid: "550e8400-e29b-41d4-a716-446655440000"
)

puts(response)

Returns:

end

(integer),

first_page_uri

(uri),

next_page_uri

(string),

page

(integer),

page_size

(integer),

previous_page_uri

(uri),

recordings

(array[object]),

start

(integer),

uri

(string)

Request recording for a call

Starts recording with specified parameters for call identified by call_sid.

POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json

ruby

response = client.texml.accounts.calls.recordings_json.recordings_json("call_sid", account_sid: "550e8400-e29b-41d4-a716-446655440000")

puts(response)

Returns:

account_sid

(string),

call_sid

(string),

channels

(enum: 1, 2),

conference_sid

(uuid),

date_created

(date-time),

date_updated

(date-time),

duration

(string | null),

error_code

(string | null),

price

(string | null),

price_unit

(string | null),

sid

(string),

source

(enum: StartCallRecordingAPI, StartConferenceRecordingAPI, OutboundAPI, DialVerb, Conference, RecordVerb, Trunking),

start_time

(date-time),

track

(enum: inbound, outbound, both),

uri

(string)

Update recording on a call

Updates recording resource for particular call.

POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings/{recording_sid}.json

ruby

response = client.texml.accounts.calls.recordings.recording_sid_json(
  "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  account_sid: "550e8400-e29b-41d4-a716-446655440000",
  call_sid: "550e8400-e29b-41d4-a716-446655440000"
)

puts(response)

Returns:

account_sid

(string),

call_sid

(string),

channels

(enum: 1, 2),

conference_sid

(uuid),

date_created

(date-time),

date_updated

(date-time),

duration

(string | null),

error_code

(string | null),

price

(string | null),

price_unit

(string | null),

sid

(string),

source

(enum: StartCallRecordingAPI, StartConferenceRecordingAPI, OutboundAPI, DialVerb, Conference, RecordVerb, Trunking),

start_time

(date-time),

track

(enum: inbound, outbound, both),

uri

(string)

Request siprec session for a call

Starts siprec session with specified parameters for call identified by call_sid.

POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Siprec.json

ruby

response = client.texml.accounts.calls.siprec_json("call_sid", account_sid: "550e8400-e29b-41d4-a716-446655440000")

puts(response)

Returns:

account_sid

(string),

call_sid

(string),

date_created

(string),

date_updated

(string),

error_code

(string),

sid

(string),

start_time

(string),

status

(enum: in-progress, stopped),

track

(enum: both_tracks, inbound_track, outbound_track),

uri

(string)

Updates siprec session for a call

Updates siprec session identified by siprec_sid.

POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Siprec/{siprec_sid}.json

ruby

response = client.texml.accounts.calls.siprec.siprec_sid_json(
  "siprec_sid",
  account_sid: "550e8400-e29b-41d4-a716-446655440000",
  call_sid: "550e8400-e29b-41d4-a716-446655440000"
)

puts(response)

Returns:

account_sid

(string),

call_sid

(string),

date_updated

(string),

error_code

(string),

sid

(string),

status

(enum: in-progress, stopped),

uri

(string)

Start streaming media from a call.

Starts streaming media from a call to a specific WebSocket address.

POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Streams.json

ruby

response = client.texml.accounts.calls.streams_json("call_sid", account_sid: "550e8400-e29b-41d4-a716-446655440000")

puts(response)

Returns:

account_sid

(string),

call_sid

(string),

date_updated

(date-time),

name

(string),

sid

(string),

status

(enum: in-progress),

uri

(string)

Update streaming on a call

Updates streaming resource for particular call.

POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Streams/{streaming_sid}.json

ruby

response = client.texml.accounts.calls.streams.streaming_sid_json(
  "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  account_sid: "550e8400-e29b-41d4-a716-446655440000",
  call_sid: "550e8400-e29b-41d4-a716-446655440000"
)

puts(response)

Returns:

account_sid

(string),

call_sid

(string),

date_updated

(date-time),

sid

(string),

status

(enum: stopped),

uri

(string)

List conference resources

Lists conference resources.

GET /texml/Accounts/{account_sid}/Conferences

ruby

response = client.texml.accounts.conferences.retrieve_conferences("account_sid")

puts(response)

Returns:

conferences

(array[object]),

end

(integer),

first_page_uri

(string),

next_page_uri

(string),

page

(integer),

page_size

(integer),

start

(integer),

uri

(string)

Fetch a conference resource

Returns a conference resource.

GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}

ruby

conference = client.texml.accounts.conferences.retrieve("conference_sid", account_sid: "550e8400-e29b-41d4-a716-446655440000")

puts(conference)

Returns:

account_sid

(string),

api_version

(string),

call_sid_ending_conference

(string),

date_created

(string),

date_updated

(string),

friendly_name

(string),

reason_conference_ended

(enum: participant-with-end-conference-on-exit-left, last-participant-left, conference-ended-via-api, time-exceeded),

region

(string),

sid

(string),

status

(enum: init, in-progress, completed),

subresource_uris

(object),

uri

(string)

Update a conference resource

Updates a conference resource.

POST /texml/Accounts/{account_sid}/Conferences/{conference_sid}

ruby

conference = client.texml.accounts.conferences.update("conference_sid", account_sid: "550e8400-e29b-41d4-a716-446655440000")

puts(conference)

Returns:

account_sid

(string),

api_version

(string),

call_sid_ending_conference

(string),

date_created

(string),

date_updated

(string),

friendly_name

(string),

reason_conference_ended

(enum: participant-with-end-conference-on-exit-left, last-participant-left, conference-ended-via-api, time-exceeded),

region

(string),

sid

(string),

status

(enum: init, in-progress, completed),

subresource_uris

(object),

uri

(string)

List conference participants

Lists conference participants

GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants

ruby

response = client.texml.accounts.conferences.participants.retrieve_participants(
  "conference_sid",
  account_sid: "550e8400-e29b-41d4-a716-446655440000"
)

puts(response)

Returns:

end

(integer),

first_page_uri

(string),

next_page_uri

(string),

page

(integer),

page_size

(integer),

participants

(array[object]),

start

(integer),

uri

(string)

Dial a new conference participant

Dials a new conference participant

POST /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants

ruby

response = client.texml.accounts.conferences.participants.participants("conference_sid", account_sid: "550e8400-e29b-41d4-a716-446655440000")

puts(response)

Returns:

account_sid

(string),

call_sid

(string),

coaching

(boolean),

coaching_call_sid

(string),

conference_sid

(uuid),

end_conference_on_exit

(boolean),

hold

(boolean),

muted

(boolean),

status

(enum: connecting, connected, completed),

uri

(string)

Get conference participant resource

Gets conference participant resource

GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}

ruby

participant = client.texml.accounts.conferences.participants.retrieve(
  "call_sid_or_participant_label",
  account_sid: "550e8400-e29b-41d4-a716-446655440000",
  conference_sid: "550e8400-e29b-41d4-a716-446655440000"
)

puts(participant)

Returns:

account_sid

(string),

api_version

(string),

call_sid

(string),

call_sid_legacy

(string),

coaching

(boolean),

coaching_call_sid

(string),

coaching_call_sid_legacy

(string),

conference_sid

(uuid),

date_created

(string),

date_updated

(string),

end_conference_on_exit

(boolean),

hold

(boolean),

muted

(boolean),

status

(enum: connecting, connected, completed),

uri

(string)

Update a conference participant

Updates a conference participant

POST /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}

ruby

participant = client.texml.accounts.conferences.participants.update(
  "call_sid_or_participant_label",
  account_sid: "550e8400-e29b-41d4-a716-446655440000",
  conference_sid: "550e8400-e29b-41d4-a716-446655440000"
)

puts(participant)

Returns:

account_sid

(string),

api_version

(string),

call_sid

(string),

call_sid_legacy

(string),

coaching

(boolean),

coaching_call_sid

(string),

coaching_call_sid_legacy

(string),

conference_sid

(uuid),

date_created

(string),

date_updated

(string),

end_conference_on_exit

(boolean),

hold

(boolean),

muted

(boolean),

status

(enum: connecting, connected, completed),

uri

(string)

Delete a conference participant

Deletes a conference participant

DELETE /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}

ruby

result = client.texml.accounts.conferences.participants.delete(
  "call_sid_or_participant_label",
  account_sid: "550e8400-e29b-41d4-a716-446655440000",
  conference_sid: "550e8400-e29b-41d4-a716-446655440000"
)

puts(result)

List conference recordings

Lists conference recordings

GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings

ruby

response = client.texml.accounts.conferences.retrieve_recordings("conference_sid", account_sid: "550e8400-e29b-41d4-a716-446655440000")

puts(response)

Returns:

end

(integer),

first_page_uri

(string),

next_page_uri

(string),

page

(integer),

page_size

(integer),

participants

(array[object]),

recordings

(array[object]),

start

(integer),

uri

(string)

Fetch recordings for a conference

Returns recordings for a conference identified by conference_sid.

GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings.json

ruby

response = client.texml.accounts.conferences.retrieve_recordings_json("conference_sid", account_sid: "550e8400-e29b-41d4-a716-446655440000")

puts(response)

Returns:

end

(integer),

first_page_uri

(uri),

next_page_uri

(string),

page

(integer),

page_size

(integer),

previous_page_uri

(uri),

recordings

(array[object]),

start

(integer),

uri

(string)

List queue resources

Lists queue resources.

GET /texml/Accounts/{account_sid}/Queues

ruby

page = client.texml.accounts.queues.list("account_sid")

puts(page)

Returns:

end

(integer),

first_page_uri

(string),

next_page_uri

(string),

page

(integer),

page_size

(integer),

queues

(array[object]),

start

(integer),

uri

(string)

Create a new queue

Creates a new queue resource.

POST /texml/Accounts/{account_sid}/Queues

ruby

queue = client.texml.accounts.queues.create("account_sid")

puts(queue)

Returns:

account_sid

(string),

average_wait_time

(integer),

current_size

(integer),

date_created

(string),

date_updated

(string),

max_size

(integer),

sid

(string),

subresource_uris

(object),

uri

(string)

Fetch a queue resource

Returns a queue resource.

GET /texml/Accounts/{account_sid}/Queues/{queue_sid}

ruby

queue = client.texml.accounts.queues.retrieve("queue_sid", account_sid: "550e8400-e29b-41d4-a716-446655440000")

puts(queue)

Returns:

account_sid

(string),

average_wait_time

(integer),

current_size

(integer),

date_created

(string),

date_updated

(string),

max_size

(integer),

sid

(string),

subresource_uris

(object),

uri

(string)

Update a queue resource

Updates a queue resource.

POST /texml/Accounts/{account_sid}/Queues/{queue_sid}

ruby

queue = client.texml.accounts.queues.update("queue_sid", account_sid: "550e8400-e29b-41d4-a716-446655440000")

puts(queue)

Returns:

account_sid

(string),

average_wait_time

(integer),

current_size

(integer),

date_created

(string),

date_updated

(string),

max_size

(integer),

sid

(string),

subresource_uris

(object),

uri

(string)

Delete a queue resource

Delete a queue resource.

DELETE /texml/Accounts/{account_sid}/Queues/{queue_sid}

ruby

result = client.texml.accounts.queues.delete("queue_sid", account_sid: "550e8400-e29b-41d4-a716-446655440000")

puts(result)

Fetch multiple recording resources

Returns multiple recording resources for an account.

GET /texml/Accounts/{account_sid}/Recordings.json

ruby

response = client.texml.accounts.retrieve_recordings_json("account_sid")

puts(response)

Returns:

end

(integer),

first_page_uri

(uri),

next_page_uri

(string),

page

(integer),

page_size

(integer),

previous_page_uri

(uri),

recordings

(array[object]),

start

(integer),

uri

(string)

Fetch recording resource

Returns recording resource identified by recording id.

GET /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json

ruby

texml_get_call_recording_response_body = client.texml.accounts.recordings.json.retrieve_recording_sid_json(
  "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  account_sid: "550e8400-e29b-41d4-a716-446655440000"
)

puts(texml_get_call_recording_response_body)

Returns:

account_sid

(string),

call_sid

(string),

channels

(enum: 1, 2),

conference_sid

(uuid),

date_created

(date-time),

date_updated

(date-time),

duration

(string | null),

error_code

(string | null),

media_url

(uri),

sid

(string),

source

(enum: StartCallRecordingAPI, StartConferenceRecordingAPI, OutboundAPI, DialVerb, Conference, RecordVerb, Trunking),

start_time

(date-time),

status

(enum: in-progress, completed, paused, stopped),

subresources_uris

(object),

uri

(string)

Delete recording resource

Deletes recording resource identified by recording id.

DELETE /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json

ruby

result = client.texml.accounts.recordings.json.delete_recording_sid_json(
  "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  account_sid: "550e8400-e29b-41d4-a716-446655440000"
)

puts(result)

List recording transcriptions

Returns multiple recording transcription resources for an account.

GET /texml/Accounts/{account_sid}/Transcriptions.json

ruby

response = client.texml.accounts.retrieve_transcriptions_json("account_sid")

puts(response)

Returns:

end

(integer),

first_page_uri

(uri),

next_page_uri

(string),

page

(integer),

page_size

(integer),

previous_page_uri

(uri),

start

(integer),

transcriptions

(array[object]),

uri

(string)

Fetch a recording transcription resource

Returns the recording transcription resource identified by its ID.

GET /texml/Accounts/{account_sid}/Transcriptions/{recording_transcription_sid}.json

ruby

response = client.texml.accounts.transcriptions.json.retrieve_recording_transcription_sid_json(
  "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  account_sid: "550e8400-e29b-41d4-a716-446655440000"
)

puts(response)

Returns:

account_sid

(string),

api_version

(string),

call_sid

(string),

date_created

(date-time),

date_updated

(date-time),

duration

(string | null),

recording_sid

(string),

sid

(string),

status

(enum: in-progress, completed),

transcription_text

(string),

uri

(string)

Delete a recording transcription

Permanently deletes a recording transcription.

DELETE /texml/Accounts/{account_sid}/Transcriptions/{recording_transcription_sid}.json

ruby

result = client.texml.accounts.transcriptions.json.delete_recording_transcription_sid_json(
  "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  account_sid: "550e8400-e29b-41d4-a716-446655440000"
)

puts(result)

Create a TeXML secret

Create a TeXML secret which can be later used as a Dynamic Parameter for TeXML when using Mustache Templates in your TeXML. In your TeXML you will be able to use your secret name, and this name will be replaced by the actual secret value when processing the TeXML on Telnyx side. The secrets are not visible in any logs.

POST /texml/secrets

— Required:

name

value

ruby

response = client.texml.secrets(name: "My Secret Name", value: "My Secret Value")

puts(response)

Returns:

name

(string),

value

(enum: REDACTED)

List all TeXML Applications

Returns a list of your TeXML Applications.

GET /texml_applications

ruby

page = client.texml_applications.list

puts(page)

Returns:

active

(boolean),

anchorsite_override

(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany),

call_cost_in_webhooks

(boolean),

created_at

(string),

dtmf_type

(enum: RFC 2833, Inband, SIP INFO),

first_command_timeout

(boolean),

first_command_timeout_secs

(integer),

friendly_name

(string),

id

(string),

inbound

(object),

outbound

(object),

record_type

(string),

status_callback

(uri),

status_callback_method

(enum: get, post),

tags

(array[string]),

updated_at

(string),

voice_fallback_url

(uri),

voice_method

(enum: get, post),

voice_url

(uri)

Creates a TeXML Application

Creates a TeXML Application.

POST /texml_applications

— Required:

friendly_name

voice_url

Optional:

active

(boolean),

anchorsite_override

(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany),

call_cost_in_webhooks

(boolean),

dtmf_type

(enum: RFC 2833, Inband, SIP INFO),

first_command_timeout

(boolean),

first_command_timeout_secs

(integer),

inbound

(object),

outbound

(object),

status_callback

(uri),

status_callback_method

(enum: get, post),

tags

(array[string]),

voice_fallback_url

(uri),

voice_method

(enum: get, post)

ruby

texml_application = client.texml_applications.create(friendly_name: "call-router", voice_url: "https://example.com")

puts(texml_application)

Returns:

active

(boolean),

anchorsite_override

(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany),

call_cost_in_webhooks

(boolean),

created_at

(string),

dtmf_type

(enum: RFC 2833, Inband, SIP INFO),

first_command_timeout

(boolean),

first_command_timeout_secs

(integer),

friendly_name

(string),

id

(string),

inbound

(object),

outbound

(object),

record_type

(string),

status_callback

(uri),

status_callback_method

(enum: get, post),

tags

(array[string]),

updated_at

(string),

voice_fallback_url

(uri),

voice_method

(enum: get, post),

voice_url

(uri)

Retrieve a TeXML Application

Retrieves the details of an existing TeXML Application.

GET /texml_applications/{id}

ruby

texml_application = client.texml_applications.retrieve("1293384261075731499")

puts(texml_application)

Returns:

active

(boolean),

anchorsite_override

(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany),

call_cost_in_webhooks

(boolean),

created_at

(string),

dtmf_type

(enum: RFC 2833, Inband, SIP INFO),

first_command_timeout

(boolean),

first_command_timeout_secs

(integer),

friendly_name

(string),

id

(string),

inbound

(object),

outbound

(object),

record_type

(string),

status_callback

(uri),

status_callback_method

(enum: get, post),

tags

(array[string]),

updated_at

(string),

voice_fallback_url

(uri),

voice_method

(enum: get, post),

voice_url

(uri)

Update a TeXML Application

Updates settings of an existing TeXML Application.

PATCH /texml_applications/{id}

— Required:

friendly_name

voice_url

Optional:

active

(boolean),

anchorsite_override

(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany),

call_cost_in_webhooks

(boolean),

dtmf_type

(enum: RFC 2833, Inband, SIP INFO),

first_command_timeout

(boolean),

first_command_timeout_secs

(integer),

inbound

(object),

outbound

(object),

status_callback

(uri),

status_callback_method

(enum: get, post),

tags

(array[string]),

voice_fallback_url

(uri),

voice_method

(enum: get, post)

ruby

texml_application = client.texml_applications.update(
  "1293384261075731499",
  friendly_name: "call-router",
  voice_url: "https://example.com"
)

puts(texml_application)

Returns:

active

(boolean),

anchorsite_override

(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany),

call_cost_in_webhooks

(boolean),

created_at

(string),

dtmf_type

(enum: RFC 2833, Inband, SIP INFO),

first_command_timeout

(boolean),

first_command_timeout_secs

(integer),

friendly_name

(string),

id

(string),

inbound

(object),

outbound

(object),

record_type

(string),

status_callback

(uri),

status_callback_method

(enum: get, post),

tags

(array[string]),

updated_at

(string),

voice_fallback_url

(uri),

voice_method

(enum: get, post),

voice_url

(uri)

Deletes a TeXML Application

Deletes a TeXML Application.

DELETE /texml_applications/{id}

ruby

texml_application = client.texml_applications.delete("1293384261075731499")

puts(texml_application)

Returns:

active

(boolean),

anchorsite_override

(enum: Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany),

call_cost_in_webhooks

(boolean),

created_at

(string),

dtmf_type

(enum: RFC 2833, Inband, SIP INFO),

first_command_timeout

(boolean),

first_command_timeout_secs

(integer),

friendly_name

(string),

id

(string),

inbound

(object),

outbound

(object),

record_type

(string),

status_callback

(uri),

status_callback_method

(enum: get, post),

tags

(array[string]),

updated_at

(string),

voice_fallback_url

(uri),

voice_method

(enum: get, post),

voice_url

(uri)

telnyx-texml-ruby

NPX Install

Tags

SKILL.md Content

Telnyx Texml - Ruby

Installation

Setup

Error Handling

Important Notes

Fetch multiple call resources

Initiate an outbound call

Fetch a call

Update call

Fetch recordings for a call

Request recording for a call

Update recording on a call

Request siprec session for a call

Updates siprec session for a call

Start streaming media from a call.

Update streaming on a call

List conference resources

Fetch a conference resource

Update a conference resource

List conference participants

Dial a new conference participant

Get conference participant resource

Update a conference participant

Delete a conference participant

List conference recordings

Fetch recordings for a conference

List queue resources

Create a new queue

Fetch a queue resource

Update a queue resource

Delete a queue resource

Fetch multiple recording resources

Fetch recording resource

Delete recording resource

List recording transcriptions

Fetch a recording transcription resource

Delete a recording transcription

Create a TeXML secret

List all TeXML Applications

Creates a TeXML Application

Retrieve a TeXML Application

Update a TeXML Application

Deletes a TeXML Application