Telnyx

{ "data": [ { "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "record_type": "portout", "phone_numbers": [ "+35312345678" ], "authorized_name": "McPortersen", "carrier_name": "test", "current_carrier": "telnyx", "end_user_name": "McPortersen", "city": "Chicago", "state": "IL", "zip": "00000", "lsr": [ "https://example.com/files/lsr.pdf" ], "pon": "00000000", "reason": null, "rejection_code": 1002, "service_address": "000 Example Street", "foc_date": "2018-02-02T22:25:27.521Z", "requested_foc_date": "2018-02-02T22:25:27.521Z", "spid": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0", "support_key": "PO_764725", "status": "rejected", "already_ported": false, "user_id": "7865816a-ee85-4e50-b19e-52983dcc6d4a", "vendor": "0e66ed3b-37e6-4fed-93d6-a30ce2493661", "created_at": "2018-02-02T22:25:27.521Z", "inserted_at": "2018-02-02T22:25:27.521Z", "updated_at": "2018-02-02T22:25:27.521Z", "host_messaging": false } ], "meta": { "total_pages": 13, "total_results": 13, "page_number": 3, "page_size": 1 } }

Authorizations

Authorization

string

header

required

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

Query Parameters

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

filter

object

Consolidated filter parameter (deepObject style). Originally: filter[carrier_name], filter[country_code], filter[country_code_in], filter[foc_date], filter[inserted_at], filter[phone_number], filter[pon], filter[ported_out_at], filter[spid], filter[status], filter[status_in], filter[support_key]

Show child attributes

filter[carrier_name]

string

Filter by new carrier name.

filter[pon]

string

Filter by Port Order Number (PON).

filter[spid]

string

Filter by new carrier spid.

filter[status]

enum<string>

Filter by portout status.

Available options:

pending,

authorized,

ported,

rejected,

rejected-pending,

canceled

filter[status_in]

enum<string>[]

Filter by a list of portout statuses

Available options:

pending,

authorized,

ported,

rejected,

rejected-pending,

canceled

filter[country_code]

string

Filter by 2-letter country code

Example:

"US"

filter[country_code_in]

string[]

Filter by a list of 2-letter country codes

Example:

["CA", "US"]

filter[ported_out_at]

object

Filter by ported_out_at date range using nested operations

Show child attributes

filter[ported_out_at][gte]

string<date-time>

Filter by ported_out_at date greater than or equal.

Example:

"2024-09-04T00:00:00.000Z"

filter[ported_out_at][lte]

string<date-time>

Filter by ported_out_at date less than or equal.

Example:

"2024-09-04T00:00:00.000Z"

filter[inserted_at]

object

Filter by inserted_at date range using nested operations

Show child attributes

filter[inserted_at][gte]

string<date-time>

Filter by inserted_at date greater than or equal.

Example:

"2024-09-04T00:00:00.000Z"

filter[inserted_at][lte]

string<date-time>

Filter by inserted_at date less than or equal.

Example:

"2024-09-04T00:00:00.000Z"

filter[foc_date]

string<date-time>

Filter by foc_date. Matches all portouts with the same date

Example:

"2024-09-04T00:00:00.000Z"

filter[phone_number]

string

Filter by a phone number on the portout. Matches all portouts with the phone number

Example:

"+13035551212"

filter[support_key]

string

Filter by the portout's support_key

Example:

"PO_abc123"

Response

Portout Response

data

object[]

Show child attributes

data.id

string

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

data.record_type

string

Identifies the type of the resource.

Example:

"portout"

data.phone_numbers

string[]

Phone numbers associated with this portout

E164 formatted phone number

Example:

["+35312345678"]

data.authorized_name

string

Name of person authorizing the porting order

Example:

"McPortersen"

data.carrier_name

string

Carrier the number will be ported out to

Example:

"test"

data.current_carrier

string

The current carrier

Example:

"telnyx"

data.end_user_name

string

Person name or company name requesting the port

Example:

"McPortersen"

data.city

string

City or municipality of billing address

Example:

"Chicago"

data.state

string

State, province, or similar of billing address

Example:

"IL"

data.zip

string

Postal Code of billing address

Example:

"00000"

data.lsr

string<uri>[]

The Local Service Request

A link to the Local Service Request

Example:

["https://example.com/files/lsr.pdf"]

data.pon

string

Port order number assigned by the carrier the number will be ported out to

Example:

"00000000"

data.reason

string

The reason why the order is being rejected by the user. If the order is authorized, this field can be left null

Example:

null

data.rejection_code

integer

The rejection code for one of the valid rejections to reject a port out order

Example:

1002

data.service_address

string

First line of billing address (street address)

Example:

"000 Example Street"

data.foc_date

string

ISO 8601 formatted Date/Time of the FOC date

Example:

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

data.requested_foc_date

string

ISO 8601 formatted Date/Time of the user requested FOC date

Example:

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

data.spid

string

New service provider spid

Example:

"0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"

data.support_key

string

A key to reference this port out request when contacting Telnyx customer support

Example:

"PO_764725"

data.status

enum<string>

Status of portout request

Available options:

pending,

authorized,

ported,

rejected,

rejected-pending,

canceled

Example:

"rejected"

data.already_ported

boolean

Is true when the number is already ported

Example:

false

data.user_id

string<uuid>

Identifies the user (or organization) who requested the port out

Example:

"7865816a-ee85-4e50-b19e-52983dcc6d4a"

data.vendor

string<uuid>

Telnyx partner providing network coverage

Example:

"0e66ed3b-37e6-4fed-93d6-a30ce2493661"

data.created_at

string

ISO 8601 formatted date of when the portout was created

Example:

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

data.inserted_at

string

ISO 8601 formatted date of when the portout was created

Example:

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

data.updated_at

string

ISO 8601 formatted date of when the portout was last updated

Example:

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

data.host_messaging

boolean

default:false

Indicates whether messaging services should be maintained with Telnyx after the port out completes

Example:

false

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