Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const actionRequirements = await client.portingOrders.actionRequirements.list('porting_order_id'); console.log(actionRequirements.data);

{ "data": [ { "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58", "record_type": "porting_action_requirement", "porting_order_id": "12ade33a-21c0-473b-b055-b3c836e1c292", "requirement_type_id": "53970723-fbff-4f46-a975-f62be6c1a585", "action_type": "document_upload", "action_url": "https://example.com/action", "status": "created", "cancel_reason": null, "created_at": "2018-02-02T22:25:27.521Z", "updated_at": "2018-02-02T22:25:27.521Z" } ], "meta": { "page_number": 2, "page_size": 25, "total_pages": 3, "total_results": 55 } }

Authorizations

Authorization

string

header

required

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

Path Parameters

porting_order_id

string

required

The ID of the porting order

Query Parameters

page

object

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

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

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[id][in][], filter[requirement_type_id], filter[action_type], filter[status]

Show child attributes

filter[id]

string<uuid>[]

Filter action requirements by a list of IDs

filter[requirement_type_id]

string<uuid>

Filter action requirements by requirement type ID

filter[action_type]

enum<string>

Filter action requirements by action type

Available options:

au_id_verification

filter[status]

enum<string>

Filter action requirements by status

Available options:

created,

pending,

completed,

cancelled,

failed

sort

object

Consolidated sort parameter (deepObject style). Originally: sort[value]

Show child attributes

sort[value]

enum<string>

Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

Available options:

created_at,

-created_at,

updated_at,

-updated_at

Example:

"created_at"

Response

Successful response

data

object[]

Show child attributes

data.id

string

Identifies the action requirement

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

data.record_type

enum<string>

Identifies the type of the resource

Available options:

porting_action_requirement

Example:

"porting_action_requirement"

data.porting_order_id

string

The ID of the porting order this action requirement belongs to

Example:

"12ade33a-21c0-473b-b055-b3c836e1c292"

data.requirement_type_id

string

The ID of the requirement type

Example:

"53970723-fbff-4f46-a975-f62be6c1a585"

data.action_type

string

The type of action required

Example:

"document_upload"

data.action_url

string | null

Optional URL for the action

Example:

"https://example.com/action"

data.status

enum<string>

Current status of the action requirement

Available options:

created,

pending,

completed,

cancelled,

failed

Example:

"created"

data.cancel_reason

string | null

Reason for cancellation if status is 'cancelled'

Example:

null

data.created_at

string<date-time>

ISO 8601 formatted date-time indicating when the resource was created

Example:

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

data.updated_at

string<date-time>

ISO 8601 formatted date-time indicating when the resource was updated

Example:

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

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup