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

Telnyx Account Management - JavaScript

Installation

npm install telnyx@6.74.2

Setup

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
  publicKey: process.env['TELNYX_PUBLIC_KEY'], // Required for client.webhooks.unwrap() (webhook verification)
});

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:

try {
  const result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('Network error — check connectivity and retry');
  } else if (err instanceof Telnyx.RateLimitError) {
    // 429: rate limited — wait, then retry the request (bounded exponential backoff)
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
    // ...retry the call here (give up after a few attempts)
  } else if (err instanceof Telnyx.APIError) {
    console.error(`API error ${err.status}: ${err.message}`);
    if (err.status === 422) {
      console.error('Validation error — check required fields and formats');
    }
  }
  throw err; // Re-throw: a failed request must never look like success to the caller
}

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

Important Notes

• Pagination: List methods return an auto-paginating iterator. Use for await (const item of result) { ... } to iterate through all pages automatically.

Lists accounts managed by the current user.

Lists the accounts managed by the current user. Users need to be explictly approved by Telnyx in order to become manager accounts.

GET /managed_accounts

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

Returns: api_user (string), created_at (string), email (email), id (uuid), managed_account_allow_custom_pricing (boolean), manager_account_id (string), organization_name (string), record_type (enum: managed_account), rollup_billing (boolean), updated_at (string)

Create a new managed account.

Create a new managed account owned by the authenticated user. You need to be explictly approved by Telnyx in order to become a manager account.

POST /managed_accounts — Required: business_name

Optional: email (string), managed_account_allow_custom_pricing (boolean), password (string), rollup_billing (boolean)

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

console.log(managedAccount.data);

Returns: api_key (string), api_token (string), api_user (string), balance (object), created_at (string), email (email), id (uuid), managed_account_allow_custom_pricing (boolean), manager_account_id (string), organization_name (string), record_type (enum: managed_account), rollup_billing (boolean), updated_at (string)

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

Display information about allocatable global outbound channels for the current user. Only usable by account managers.

GET /managed_accounts/allocatable_global_outbound_channels

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

console.log(response.data);

Returns: allocatable_global_outbound_channels (integer), managed_account_allow_custom_pricing (boolean), record_type (string), total_global_channels_allocated (integer)

Retrieve a managed account

Retrieves the details of a single managed account.

GET /managed_accounts/{id}

const managedAccount = await client.managedAccounts.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(managedAccount.data);

Returns: api_key (string), api_token (string), api_user (string), balance (object), created_at (string), email (email), id (uuid), managed_account_allow_custom_pricing (boolean), manager_account_id (string), organization_name (string), record_type (enum: managed_account), rollup_billing (boolean), updated_at (string)

Update a managed account

Updates the specified managed account's attributes and returns the updated account.

PATCH /managed_accounts/{id}

Optional: managed_account_allow_custom_pricing (boolean)

const managedAccount = await client.managedAccounts.update('550e8400-e29b-41d4-a716-446655440000');

console.log(managedAccount.data);

Returns: api_key (string), api_token (string), api_user (string), balance (object), created_at (string), email (email), id (uuid), managed_account_allow_custom_pricing (boolean), manager_account_id (string), organization_name (string), record_type (enum: managed_account), rollup_billing (boolean), updated_at (string)

Disables a managed account

Disables a managed account, forbidding it to use Telnyx services, including sending or receiving phone calls and SMS messages. Ongoing phone calls will not be affected. The managed account and its sub-users will no longer be able to log in via the mission control portal.

POST /managed_accounts/{id}/actions/disable

const response = await client.managedAccounts.actions.disable('550e8400-e29b-41d4-a716-446655440000');

console.log(response.data);

Returns: api_key (string), api_token (string), api_user (string), balance (object), created_at (string), email (email), id (uuid), managed_account_allow_custom_pricing (boolean), manager_account_id (string), organization_name (string), record_type (enum: managed_account), rollup_billing (boolean), updated_at (string)

Enables a managed account

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

POST /managed_accounts/{id}/actions/enable

Optional: reenable_all_connections (boolean)

const response = await client.managedAccounts.actions.enable('550e8400-e29b-41d4-a716-446655440000');

console.log(response.data);

Returns: api_key (string), api_token (string), api_user (string), balance (object), created_at (string), email (email), id (uuid), managed_account_allow_custom_pricing (boolean), manager_account_id (string), organization_name (string), record_type (enum: managed_account), rollup_billing (boolean), updated_at (string)

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

PATCH /managed_accounts/{id}/update_global_channel_limit

Optional: channel_limit (integer)

const response = await client.managedAccounts.updateGlobalChannelLimit('550e8400-e29b-41d4-a716-446655440000');

console.log(response.data);

Returns: channel_limit (integer), email (string), id (string), manager_account_id (string), record_type (string)

List organization users

Returns a list of the users in your organization.

GET /organizations/users

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

Returns: created_at (string), email (email), groups (array[object]), id (string), last_sign_in_at (string | null), organization_user_bypasses_sso (boolean), record_type (string), user_status (enum: enabled, disabled, blocked)

Get organization users groups report

Returns a report of all users in your organization with their group memberships. This endpoint returns all users without pagination and always includes group information. The report can be retrieved in JSON or CSV format by sending specific content-type headers.

GET /organizations/users/users_groups_report

const response = await client.organizations.users.getGroupsReport();

console.log(response.data);

Returns: created_at (string), email (email), groups (array[object]), id (string), last_sign_in_at (string | null), organization_user_bypasses_sso (boolean), record_type (string), user_status (enum: enabled, disabled, blocked)

Get organization user

Returns the details of a user in your organization, optionally including the groups the user belongs to.

GET /organizations/users/{id}

const user = await client.organizations.users.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(user.data);

Returns: created_at (string), email (email), groups (array[object]), id (string), last_sign_in_at (string | null), organization_user_bypasses_sso (boolean), record_type (string), user_status (enum: enabled, disabled, blocked)

Delete organization user

Removes the specified user from your organization and returns the result of the removal.

POST /organizations/users/{id}/actions/remove

const action = await client.organizations.users.actions.remove('550e8400-e29b-41d4-a716-446655440000');

console.log(action.data);

Returns: created_at (string), email (email), groups (array[object]), id (string), last_sign_in_at (string | null), organization_user_bypasses_sso (boolean), record_type (string), user_status (enum: enabled, disabled, blocked)