team-telnyx/telnyx-account-management-javascript

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Account Management - JavaScript

Installation

npm install telnyx

Setup

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.

Lists accounts managed by the current user.

Lists the accounts managed by the current user.

GET /managed_accounts

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

Create a new managed account.

Create a new managed account owned by the authenticated user.

POST /managed_accounts — Required: business_name

const managedAccount = await client.managedAccounts.create({
  business_name: "Larry's Cat Food Inc",
});

console.log(managedAccount.data);

Retrieve a managed account

Retrieves the details of a single managed account.

GET /managed_accounts/{id}

const managedAccount = await client.managedAccounts.retrieve('id');

console.log(managedAccount.data);

Update a managed account

Update a single managed account.

PATCH /managed_accounts/{id}

const managedAccount = await client.managedAccounts.update('id');

console.log(managedAccount.data);

Disables a managed account

Disables a managed account, forbidding it to use Telnyx services, including sending or receiving phone calls and SMS messages.

POST /managed_accounts/{id}/actions/disable

const response = await client.managedAccounts.actions.disable('id');

console.log(response.data);

Enables a managed account

Enables a managed account and its sub-users to use Telnyx services.

POST /managed_accounts/{id}/actions/enable

const response = await client.managedAccounts.actions.enable('id');

console.log(response.data);

Update the amount of allocatable global outbound channels allocated to a specific managed account.

PATCH /managed_accounts/{id}/update_global_channel_limit

const response = await client.managedAccounts.updateGlobalChannelLimit('id');

console.log(response.data);

Display information about allocatable global outbound channels for the current user.

GET /managed_accounts/allocatable_global_outbound_channels

const response = await client.managedAccounts.getAllocatableGlobalOutboundChannels();

console.log(response.data);