Telnyx Webrtc - JavaScript

Installation

bash

npm install telnyx

Setup

javascript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.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

javascript

// Automatically fetches more pages as needed.
for await (const pushCredential of client.mobilePushCredentials.list()) {
  console.log(pushCredential.id);
}

Creates a new mobile push credential

POST /mobile_push_credentials

javascript

const pushCredentialResponse = await client.mobilePushCredentials.create({
  createMobilePushCredentialRequest: {
    alias: 'LucyIosCredential',
    certificate:
      '-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----',
    private_key:
      '-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----',
    type: 'ios',
  },
});

console.log(pushCredentialResponse.data);

Retrieves a mobile push credential

Retrieves mobile push credential based on the given push_credential_id

GET /mobile_push_credentials/{push_credential_id}

javascript

const pushCredentialResponse = await client.mobilePushCredentials.retrieve(
  '0ccc7b76-4df3-4bca-a05a-3da1ecc389f0',
);

console.log(pushCredentialResponse.data);

Deletes a mobile push credential

Deletes a mobile push credential based on the given push_credential_id

DELETE /mobile_push_credentials/{push_credential_id}

javascript

await client.mobilePushCredentials.delete('0ccc7b76-4df3-4bca-a05a-3da1ecc389f0');

List all credentials

List all On-demand Credentials.

GET /telephony_credentials

javascript

// Automatically fetches more pages as needed.
for await (const telephonyCredential of client.telephonyCredentials.list()) {
  console.log(telephonyCredential.id);
}

Create a credential

Create a credential.

POST /telephony_credentials — Required: connection_id

javascript

const telephonyCredential = await client.telephonyCredentials.create({
  connection_id: '1234567890',
});

console.log(telephonyCredential.data);

Get a credential

Get the details of an existing On-demand Credential.

GET /telephony_credentials/{id}

javascript

const telephonyCredential = await client.telephonyCredentials.retrieve('id');

console.log(telephonyCredential.data);

Update a credential

Update an existing credential.

PATCH /telephony_credentials/{id}

javascript

const telephonyCredential = await client.telephonyCredentials.update('id');

console.log(telephonyCredential.data);

Delete a credential

Delete an existing credential.

DELETE /telephony_credentials/{id}

javascript

const telephonyCredential = await client.telephonyCredentials.delete('id');

console.log(telephonyCredential.data);

Create an Access Token.

Create an Access Token (JWT) for the credential.

POST /telephony_credentials/{id}/token

javascript

const response = await client.telephonyCredentials.createToken('id');

console.log(response);