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

Telnyx Account Management - JavaScript

Installation

npm install [email protected]

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.

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 and retry with exponential backoff
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
  } 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');
    }
  }
}

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: apiuser (string), createdat (string), email (email), id (uuid), managedaccountallowcustompricing (boolean), manageraccountid (string), organizationname (string), recordtype (enum: managedaccount), rollupbilling (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 /managedaccounts — Required: businessname

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

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

console.log(managedAccount.data);

Returns: apikey (string), apitoken (string), apiuser (string), balance (object), createdat (string), email (email), id (uuid), managedaccountallowcustompricing (boolean), manageraccountid (string), organizationname (string), recordtype (enum: managedaccount), rollupbilling (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 /managedaccounts/allocatableglobaloutboundchannels

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

console.log(response.data);

Returns: allocatableglobaloutboundchannels (integer), managedaccountallowcustompricing (boolean), recordtype (string), totalglobalchannels_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: apikey (string), apitoken (string), apiuser (string), balance (object), createdat (string), email (email), id (uuid), managedaccountallowcustompricing (boolean), manageraccountid (string), organizationname (string), recordtype (enum: managedaccount), rollupbilling (boolean), updated_at (string)

Update a managed account

Update a single managed account.

PATCH /managed_accounts/{id}

Optional: managedaccountallowcustompricing (boolean)

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

console.log(managedAccount.data);

Returns: apikey (string), apitoken (string), apiuser (string), balance (object), createdat (string), email (email), id (uuid), managedaccountallowcustompricing (boolean), manageraccountid (string), organizationname (string), recordtype (enum: managedaccount), rollupbilling (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: apikey (string), apitoken (string), apiuser (string), balance (object), createdat (string), email (email), id (uuid), managedaccountallowcustompricing (boolean), manageraccountid (string), organizationname (string), recordtype (enum: managedaccount), rollupbilling (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: reenableallconnections (boolean)

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

console.log(response.data);

Returns: apikey (string), apitoken (string), apiuser (string), balance (object), createdat (string), email (email), id (uuid), managedaccountallowcustompricing (boolean), manageraccountid (string), organizationname (string), recordtype (enum: managedaccount), rollupbilling (boolean), updated_at (string)

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

PATCH /managedaccounts/{id}/updateglobalchannellimit

Optional: channel_limit (integer)

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

console.log(response.data);

Returns: channellimit (integer), email (string), id (string), manageraccountid (string), recordtype (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: createdat (string), email (email), groups (array[object]), id (string), lastsigninat (string | null), organizationuserbypassessso (boolean), recordtype (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/usersgroupsreport

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

console.log(response.data);

Returns: createdat (string), email (email), groups (array[object]), id (string), lastsigninat (string | null), organizationuserbypassessso (boolean), recordtype (string), user_status (enum: enabled, disabled, blocked)

Get organization user

Returns a user in your organization.

GET /organizations/users/{id}

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

console.log(user.data);

Returns: createdat (string), email (email), groups (array[object]), id (string), lastsigninat (string | null), organizationuserbypassessso (boolean), recordtype (string), user_status (enum: enabled, disabled, blocked)

Delete organization user

Deletes a user in your organization.

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

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

console.log(action.data);

Returns: createdat (string), email (email), groups (array[object]), id (string), lastsigninat (string | null), organizationuserbypassessso (boolean), recordtype (string), user_status (enum: enabled, disabled, blocked)