Telnyx

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

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

{
  "data": [
    {
      "record_type": "managed_account",
      "id": "f65ceda4-6522-4ad6-aede-98de83385123",
      "email": "[email protected]",
      "api_user": "[email protected]",
      "manager_account_id": "f65ceda4-6522-4ad6-aede-98de83385123",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "organization_name": "Example Company LLC",
      "managed_account_allow_custom_pricing": true,
      "rollup_billing": false
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

managed_accounts

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

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

{
  "data": [
    {
      "record_type": "managed_account",
      "id": "f65ceda4-6522-4ad6-aede-98de83385123",
      "email": "[email protected]",
      "api_user": "[email protected]",
      "manager_account_id": "f65ceda4-6522-4ad6-aede-98de83385123",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "organization_name": "Example Company LLC",
      "managed_account_allow_custom_pricing": true,
      "rollup_billing": false
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[email][contains], filter[email][eq], filter[organization_name][contains], filter[organization_name][eq]

Show child attributes

filter[email]

object

Show child attributes

filter[email][contains]

string

If present, email containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.

filter[email][eq]

string

If present, only returns results with the email matching exactly the value given.

filter[organization_name]

object

Show child attributes

filter[organization_name][contains]

string

If present, only returns results with the organization_name containing the given value. Matching is not case-sensitive. Requires at least three characters.

filter[organization_name][eq]

string

If present, only returns results with the organization_name matching exactly the value given.

Example:

{
  "email": { "contains": "john" },
  "organization_name": { "eq": "Example Company LLC" }
}

page

object

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Show child attributes

page[number]

integer

default:1

The page number to load

Required range: x >= 1

page[size]

integer

default:20

The size of the page

Required range: 1 <= x <= 250

sort

enum<string>

default:created_at

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

That is:

email: sorts the result by the email field in ascending order.
-email: sorts the result by the email field in descending order.

If not given, results are sorted by created_at in descending order.

Available options:

created_at,

email

Example:

"email"

include_cancelled_accounts

boolean

default:false

Specifies if cancelled accounts should be included in the results.

Example:

true

Response

Successful response with a list of managed accounts.

data

ManagedAccount · object[]

Show child attributes

data.record_type

enum<string>

required

Identifies the type of the resource.

Available options:

managed_account

Example:

"managed_account"

data.id

string<uuid>

required

Uniquely identifies the managed account.

Example:

"f65ceda4-6522-4ad6-aede-98de83385123"

data.email

string<email>

required

The managed account's email.

Example:

"[email protected]"

data.api_user

string

required

The manager account's email, which serves as the V1 API user identifier

Example:

"[email protected]"

data.manager_account_id

string

required

The ID of the manager account associated with the managed account.

Example:

"f65ceda4-6522-4ad6-aede-98de83385123"

data.created_at

string

required

ISO 8601 formatted date indicating when the resource was created.

Example:

"2018-02-02T22:25:27.521Z"

data.updated_at

string

required

ISO 8601 formatted date indicating when the resource was updated.

Example:

"2018-02-02T22:25:27.521Z"

data.organization_name

string

The organization the managed account is associated with.

Example:

"Example Company LLC"

data.managed_account_allow_custom_pricing

boolean

Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. There may be time lag between when the value is changed and pricing changes take effect.

Example:

true

data.rollup_billing

boolean

Boolean value that indicates if the billing information and charges to the managed account "roll up" to the manager account. If true, the managed account will not have its own balance and will use the shared balance with the manager account. This value cannot be changed after account creation without going through Telnyx support as changes require manual updates to the account ledger. Defaults to false.

Example:

false

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

Lists accounts managed by the current user.

Authorizations

Query Parameters

Response