telnyx-webrtc-ruby

name	telnyx-webrtc-ruby
description	Manage WebRTC credentials and mobile push notification settings. Use when building browser-based or mobile softphone applications. This skill provides Ruby SDK examples.
metadata	{"author":"telnyx","product":"webrtc","language":"ruby","generated_by":"telnyx-ext-skills-generator"}

Telnyx Webrtc - 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 mobile push credentials

GET /mobile_push_credentials

page = client.mobile_push_credentials.list

puts(page)

Creates a new mobile push credential

POST /mobile_push_credentials

push_credential_response = client.mobile_push_credentials.create(
  create_mobile_push_credential_request: {
    alias: "LucyIosCredential",
    certificate: "-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----",
    private_key: "-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----",
    type: :ios
  }
)

puts(push_credential_response)

Retrieves a mobile push credential

Retrieves mobile push credential based on the given push_credential_id

GET /mobile_push_credentials/{push_credential_id}

push_credential_response = client.mobile_push_credentials.retrieve("0ccc7b76-4df3-4bca-a05a-3da1ecc389f0")

puts(push_credential_response)

Deletes a mobile push credential

Deletes a mobile push credential based on the given push_credential_id

DELETE /mobile_push_credentials/{push_credential_id}

result = client.mobile_push_credentials.delete("0ccc7b76-4df3-4bca-a05a-3da1ecc389f0")

puts(result)

List all credentials

List all On-demand Credentials.

GET /telephony_credentials

page = client.telephony_credentials.list

puts(page)

Create a credential

Create a credential.

POST /telephony_credentials — Required: connection_id

telephony_credential = client.telephony_credentials.create(connection_id: "1234567890")

puts(telephony_credential)

Get a credential

Get the details of an existing On-demand Credential.

GET /telephony_credentials/{id}

telephony_credential = client.telephony_credentials.retrieve("id")

puts(telephony_credential)

Update a credential

Update an existing credential.

PATCH /telephony_credentials/{id}

telephony_credential = client.telephony_credentials.update("id")

puts(telephony_credential)

Delete a credential

Delete an existing credential.

DELETE /telephony_credentials/{id}

telephony_credential = client.telephony_credentials.delete("id")

puts(telephony_credential)

Create an Access Token.

Create an Access Token (JWT) for the credential.

POST /telephony_credentials/{id}/token

response = client.telephony_credentials.create_token("id")

puts(response)