Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const event = await client.portouts.events.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e'); console.log(event.data);

{ "data": { "id": "eef3340b-8903-4466-b445-89b697315a3a", "event_type": "portout.status_changed", "portout_id": "9471c873-e3eb-4ca1-957d-f9a451334d52", "available_notification_methods": [ "email" ], "payload_status": "created", "payload": { "id": "96dfa9e4-c753-4fd3-97cd-42d66f26cf0c", "status": "authorized", "phone_numbers": [ "+35312345678" ], "carrier_name": "Testing Carrier", "spid": "987H", "user_id": "96dfa9e4-c753-4fd3-97cd-42d66f26cf0c", "subscriber_name": "John Doe", "rejection_reason": null, "attempted_pin": "1234" }, "record_type": "portout_event", "created_at": "2021-03-19T10:07:15.527000Z", "updated_at": "2021-03-19T10:07:15.527000Z" } }

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Identifies the port-out event.

Response

Successful response

data

object

Show child attributes

data.id

string<uuid>

Uniquely identifies the event.

Example:

"eef3340b-8903-4466-b445-89b697315a3a"

data.event_type

enum<string>

Identifies the event type

Available options:

portout.status_changed,

portout.foc_date_changed,

portout.new_comment

Example:

"portout.status_changed"

data.portout_id

string<uuid>

Identifies the port-out order associated with the event.

Example:

"9471c873-e3eb-4ca1-957d-f9a451334d52"

data.available_notification_methods

enum<string>[]

Indicates the notification methods used.

Available options:

email,

webhook

data.payload_status

enum<string>

The status of the payload generation.

Available options:

created,

completed

Example:

"created"

data.payload

object

The webhook payload for the portout.status_changed event

Option 1
Option 2
Option 3

Show child attributes

data.payload.id

string<uuid>

Identifies the port out that was moved.

Example:

"96dfa9e4-c753-4fd3-97cd-42d66f26cf0c"

data.payload.status

enum<string>

The new status of the port out.

Available options:

pending,

authorized,

ported,

rejected,

rejected-pending,

canceled

Example:

"authorized"

data.payload.phone_numbers

string[]

Phone numbers associated with this port-out order

E164 formatted phone number

Example:

["+35312345678"]

data.payload.carrier_name

string

Carrier the number will be ported out to

Example:

"Testing Carrier"

data.payload.spid

string

The new carrier SPID.

Example:

"987H"

data.payload.user_id

string<uuid>

Identifies the user that the port-out order belongs to.

Example:

"96dfa9e4-c753-4fd3-97cd-42d66f26cf0c"

data.payload.subscriber_name

string

The name of the port-out's end user.

Example:

"John Doe"

data.payload.rejection_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.payload.attempted_pin

string

The PIN that was attempted to be used to authorize the port out.

Example:

"1234"

data.record_type

string

Identifies the type of the resource.

Example:

"portout_event"

data.created_at

string<date-time>

ISO 8601 formatted date indicating when the resource was created.

Example:

"2021-03-19T10:07:15.527000Z"

data.updated_at

string<date-time>

ISO 8601 formatted date indicating when the resource was updated.

Example:

"2021-03-19T10:07:15.527000Z"

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