Telnyx Sip Integrations – 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
)

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

List all call recordings

Returns a list of your call recordings.

GET /recordings

page = client.recordings.list

puts(page)

Retrieve a call recording

Retrieves the details of an existing call recording.

GET /recordings/{recording_id}

recording = client.recordings.retrieve("recording_id")

puts(recording)

Delete a call recording

Permanently deletes a call recording.

DELETE /recordings/{recording_id}

recording = client.recordings.delete("recording_id")

puts(recording)

Delete a list of call recordings

Permanently deletes a list of call recordings.

POST /recordings/actions/delete

result = client.recordings.actions.delete(
  ids: ["428c31b6-7af4-4bcb-b7f5-5013ef9657c1", "428c31b6-7af4-4bcb-b7f5-5013ef9657c2"]
)

puts(result)

List all recording transcriptions

Returns a list of your recording transcriptions.

GET /recording_transcriptions

recording_transcriptions = client.recording_transcriptions.list

puts(recording_transcriptions)

Retrieve a recording transcription

Retrieves the details of an existing recording transcription.

GET /recording_transcriptions/{recording_transcription_id}

recording_transcription = client.recording_transcriptions.retrieve("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(recording_transcription)

Delete a recording transcription

Permanently deletes a recording transcription.

DELETE /recording_transcriptions/{recording_transcription_id}

recording_transcription = client.recording_transcriptions.delete("6a09cdc3-8948-47f0-aa62-74ac943d6c58")

puts(recording_transcription)

Retrieve a stored credential

Returns the information about custom storage credentials.

GET /custom_storage_credentials/{connection_id}

custom_storage_credential = client.custom_storage_credentials.retrieve("connection_id")

puts(custom_storage_credential)

Create a custom storage credential

Creates a custom storage credentials configuration.

POST /custom_storage_credentials/{connection_id}

custom_storage_credential = client.custom_storage_credentials.create("connection_id", backend: :gcs, configuration: {backend: :gcs})

puts(custom_storage_credential)

Update a stored credential

Updates a stored custom credentials configuration.

PUT /custom_storage_credentials/{connection_id}

custom_storage_credential = client.custom_storage_credentials.update("connection_id", backend: :gcs, configuration: {backend: :gcs})

puts(custom_storage_credential)

Delete a stored credential

Deletes a stored custom credentials configuration.

DELETE /custom_storage_credentials/{connection_id}

result = client.custom_storage_credentials.delete("connection_id")

puts(result)

Retrieve stored Dialogflow Connection

Return details of the Dialogflow connection associated with the given CallControl connection.

GET /dialogflow_connections/{connection_id}

dialogflow_connection = client.dialogflow_connections.retrieve("connection_id")

puts(dialogflow_connection)

Create a Dialogflow Connection

Save Dialogflow Credentiails to Telnyx, so it can be used with other Telnyx services.

POST /dialogflow_connections/{connection_id}

dialogflow_connection = client.dialogflow_connections.create(
  "connection_id",
  service_account: {
    type: "bar",
    project_id: "bar",
    private_key_id: "bar",
    private_key: "bar",
    client_email: "bar",
    client_id: "bar",
    auth_uri: "bar",
    token_uri: "bar",
    auth_provider_x509_cert_url: "bar",
    client_x509_cert_url: "bar"
  }
)

puts(dialogflow_connection)

Update stored Dialogflow Connection

Updates a stored Dialogflow Connection.

PUT /dialogflow_connections/{connection_id}

dialogflow_connection = client.dialogflow_connections.update(
  "connection_id",
  service_account: {
    type: "bar",
    project_id: "bar",
    private_key_id: "bar",
    private_key: "bar",
    client_email: "bar",
    client_id: "bar",
    auth_uri: "bar",
    token_uri: "bar",
    auth_provider_x509_cert_url: "bar",
    client_x509_cert_url: "bar"
  }
)

puts(dialogflow_connection)

Delete stored Dialogflow Connection

Deletes a stored Dialogflow Connection.

DELETE /dialogflow_connections/{connection_id}

result = client.dialogflow_connections.delete("connection_id")

puts(result)

List all External Connections

This endpoint returns a list of your External Connections inside the ‘data’ attribute of the response.

GET /external_connections

page = client.external_connections.list

puts(page)

Creates an External Connection

Creates a new External Connection based on the parameters sent in the request.

POST /external_connections — Required: external_sip_connection, outbound

Optional: active (boolean), inbound (object), tags (array[string]), webhook_event_failover_url (uri), webhook_event_url (uri), webhook_timeout_secs ([‘integer’, ‘null’])

external_connection = client.external_connections.create(external_sip_connection: :zoom, outbound: {})

puts(external_connection)

Retrieve an External Connection

Return the details of an existing External Connection inside the ‘data’ attribute of the response.

GET /external_connections/{id}

external_connection = client.external_connections.retrieve("1293384261075731499")

puts(external_connection)

Update an External Connection

Updates settings of an existing External Connection based on the parameters of the request.

PATCH /external_connections/{id} — Required: outbound

Optional: active (boolean), inbound (object), tags (array[string]), webhook_event_failover_url (uri), webhook_event_url (uri), webhook_timeout_secs ([‘integer’, ‘null’])

external_connection = client.external_connections.update(
  "1293384261075731499",
  outbound: {outbound_voice_profile_id: "1911630617284445511"}
)

puts(external_connection)

Deletes an External Connection

Permanently deletes an External Connection.

DELETE /external_connections/{id}

external_connection = client.external_connections.delete("1293384261075731499")

puts(external_connection)

List all civic addresses and locations

Returns the civic addresses and locations from Microsoft Teams.

GET /external_connections/{id}/civic_addresses

civic_addresses = client.external_connections.civic_addresses.list("1293384261075731499")

puts(civic_addresses)

Retrieve a Civic Address

Return the details of an existing Civic Address with its Locations inside the ‘data’ attribute of the response.

GET /external_connections/{id}/civic_addresses/{address_id}

civic_address = client.external_connections.civic_addresses.retrieve(
  "318fb664-d341-44d2-8405-e6bfb9ced6d9",
  id: "1293384261075731499"
)

puts(civic_address)

Update a location’s static emergency address

PATCH /external_connections/{id}/locations/{location_id} — Required: static_emergency_address_id

response = client.external_connections.update_location(
  "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  static_emergency_address_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
)

puts(response)

List all phone numbers

Returns a list of all active phone numbers associated with the given external connection.

GET /external_connections/{id}/phone_numbers

page = client.external_connections.phone_numbers.list("1293384261075731499")

puts(page)

Retrieve a phone number

Return the details of a phone number associated with the given external connection.

GET /external_connections/{id}/phone_numbers/{phone_number_id}

phone_number = client.external_connections.phone_numbers.retrieve("1234567889", id: "1293384261075731499")

puts(phone_number)

Update a phone number

Asynchronously update settings of the phone number associated with the given external connection.

PATCH /external_connections/{id}/phone_numbers/{phone_number_id}

Optional: location_id (uuid)

phone_number = client.external_connections.phone_numbers.update("1234567889", id: "1293384261075731499")

puts(phone_number)

List all Releases

Returns a list of your Releases for the given external connection.

GET /external_connections/{id}/releases

page = client.external_connections.releases.list("1293384261075731499")

puts(page)

Retrieve a Release request

Return the details of a Release request and its phone numbers.

GET /external_connections/{id}/releases/{release_id}

release = client.external_connections.releases.retrieve(
  "7b6a6449-b055-45a6-81f6-f6f0dffa4cc6",
  id: "1293384261075731499"
)

puts(release)

List all Upload requests

Returns a list of your Upload requests for the given external connection.

GET /external_connections/{id}/uploads

page = client.external_connections.uploads.list("1293384261075731499")

puts(page)

Creates an Upload request

Creates a new Upload request to Microsoft teams with the included phone numbers.

POST /external_connections/{id}/uploads — Required: number_ids

Optional: additional_usages (array[string]), civic_address_id (uuid), location_id (uuid), usage (enum)

upload = client.external_connections.uploads.create(
  "1293384261075731499",
  number_ids: ["3920457616934164700", "3920457616934164701", "3920457616934164702", "3920457616934164703"]
)

puts(upload)

Refresh the status of all Upload requests

Forces a recheck of the status of all pending Upload requests for the given external connection in the background.

POST /external_connections/{id}/uploads/refresh

response = client.external_connections.uploads.refresh_status("1293384261075731499")

puts(response)

Get the count of pending upload requests

Returns the count of all pending upload requests for the given external connection.

GET /external_connections/{id}/uploads/status

response = client.external_connections.uploads.pending_count("1293384261075731499")

puts(response)

Retrieve an Upload request

Return the details of an Upload request and its phone numbers.

GET /external_connections/{id}/uploads/{ticket_id}

upload = client.external_connections.uploads.retrieve(
  "7b6a6449-b055-45a6-81f6-f6f0dffa4cc6",
  id: "1293384261075731499"
)

puts(upload)

Retry an Upload request

If there were any errors during the upload process, this endpoint will retry the upload request.

POST /external_connections/{id}/uploads/{ticket_id}/retry

response = client.external_connections.uploads.retry_(
  "7b6a6449-b055-45a6-81f6-f6f0dffa4cc6",
  id: "1293384261075731499"
)

puts(response)

List all log messages

Retrieve a list of log messages for all external connections associated with your account.

GET /external_connections/log_messages

page = client.external_connections.log_messages.list

puts(page)

Retrieve a log message

Retrieve a log message for an external connection associated with your account.

GET /external_connections/log_messages/{id}

log_message = client.external_connections.log_messages.retrieve("1293384261075731499")

puts(log_message)

Dismiss a log message

Dismiss a log message for an external connection associated with your account.

DELETE /external_connections/log_messages/{id}

response = client.external_connections.log_messages.dismiss("1293384261075731499")

puts(response)

Refresh Operator Connect integration

This endpoint will make an asynchronous request to refresh the Operator Connect integration with Microsoft Teams for the current user.

POST /operator_connect/actions/refresh

response = client.operator_connect.actions.refresh

puts(response)

List uploaded media

Returns a list of stored media files.

GET /media

media = client.media.list

puts(media)

Upload media

Upload media file to Telnyx so it can be used with other Telnyx services

POST /media — Required: media_url

Optional: media_name (string), ttl_secs (integer)

response = client.media.upload(media_url: "http://www.example.com/audio.mp3")

puts(response)

Retrieve stored media

Returns the information about a stored media file.

GET /media/{media_name}

media = client.media.retrieve("media_name")

puts(media)

Update stored media

Updates a stored media file.

PUT /media/{media_name}

Optional: media_url (string), ttl_secs (integer)

media = client.media.update("media_name")

puts(media)

Deletes stored media

Deletes a stored media file.

DELETE /media/{media_name}

result = client.media.delete("media_name")

puts(result)

Download stored media

Downloads a stored media file.

GET /media/{media_name}/download

response = client.media.download("media_name")

puts(response)