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 eventListResponse of client.portouts.events.list()) {
  console.log(eventListResponse);
}

{
  "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"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

portouts

events

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 eventListResponse of client.portouts.events.list()) {
  console.log(eventListResponse);
}

{
  "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"
    }
  ],
  "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

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[event_type], filter[portout_id], filter[created_at]

Show child attributes

filter[event_type]

enum<string>

Filter by event type.

Available options:

portout.status_changed,

portout.new_comment,

portout.foc_date_changed

Example:

"portout.status_changed"

filter[portout_id]

string<uuid>

Filter by port-out order ID.

Example:

"34dc46a9-53ed-4e01-9454-26227ea13326"

filter[created_at]

object

Filter by created_at date range using nested operations

Show child attributes

filter[created_at][gte]

string<date-time>

Filter by created at greater than or equal to.

Example:

"2021-01-01T00:00:00Z"

filter[created_at][lte]

string<date-time>

Filter by created at less than or equal to.

Example:

"2021-01-01T00:00:00Z"

Response

Successful response

data

object[]

Option 1
Option 2
Option 3

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

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 | null

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"

Coverage

Regulatory

Searching

Ordering

Port In

Port Out

Management & Configurations

All Others

List all port-out events

Authorizations

Query Parameters

Response