Telnyx

JavaScript

import Telnyx from 'telnyx';

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

const requirementGroups = await client.requirementGroups.list();

console.log(requirementGroups);

[
  {
    "id": "<string>",
    "country_code": "<string>",
    "phone_number_type": "<string>",
    "status": "approved",
    "action": "<string>",
    "customer_reference": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "record_type": "requirement_group",
    "regulatory_requirements": [
      {
        "requirement_id": "<string>",
        "field_value": "<string>",
        "field_type": "<string>",
        "status": "approved",
        "expires_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

GET

requirement_groups

JavaScript

import Telnyx from 'telnyx';

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

const requirementGroups = await client.requirementGroups.list();

console.log(requirementGroups);

[
  {
    "id": "<string>",
    "country_code": "<string>",
    "phone_number_type": "<string>",
    "status": "approved",
    "action": "<string>",
    "customer_reference": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "record_type": "requirement_group",
    "regulatory_requirements": [
      {
        "requirement_id": "<string>",
        "field_value": "<string>",
        "field_type": "<string>",
        "status": "approved",
        "expires_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

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[country_code], filter[phone_number_type], filter[action], filter[status], filter[customer_reference]

Show child attributes

filter[country_code]

string

Filter requirement groups by country code (iso alpha 2)

filter[phone_number_type]

enum<string>

Filter requirement groups by phone number type.

Available options:

local,

toll_free,

mobile,

national,

shared_cost

filter[action]

enum<string>

Filter requirement groups by action type

Available options:

ordering,

porting,

action

filter[status]

enum<string>

Filter requirement groups by status

Available options:

approved,

unapproved,

pending-approval,

declined,

expired

filter[customer_reference]

string

Filter requirement groups by customer reference

Response

List requirement groups

string

country_code

string

phone_number_type

string

status

enum<string>

Available options:

approved,

unapproved,

pending-approval,

declined,

expired

action

string

customer_reference

string

created_at

string<date-time>

updated_at

string<date-time>

record_type

string

Example:

"requirement_group"

regulatory_requirements

object[]

Show child attributes

regulatory_requirements.requirement_id

string

regulatory_requirements.field_value

string

regulatory_requirements.field_type

string

regulatory_requirements.status

enum<string>

Available options:

approved,

unapproved,

pending-approval,

declined,

expired

regulatory_requirements.expires_at

string<date-time>

regulatory_requirements.created_at

string<date-time>

regulatory_requirements.updated_at

string<date-time>

Retrieve regulatory requirements Create a new requirement group

⌘I

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

List requirement groups

Authorizations

Query Parameters

Response