List all port-out events

GET /portout/events

Returns a list of all port-out events.

Request

Query Parameters

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page

filter[event_type] string

Possible values: [portout.status_changed, portout.new_comment, portout.foc_date_changed]

Filter by event type.

filter[portout_id] uuid

Filter by port-out order ID.

filter[created_at][gte] date-time

Filter by created at greater than or equal to.

filter[created_at][lte] date-time

Filter by created at less than or equal to.

Responses

200: Successful response

application/json

Schema

data

object[]

Array [

id uuid

Uniquely identifies the event.

event_type string

Possible values: [portout.status_changed, portout.foc_date_changed, portout.new_comment]

Identifies the event type

portout_id uuid

Identifies the port-out order associated with the event.

available_notification_methods string[]

Possible values: [email, webhook]

Indicates the notification methods used.

payload_status string

Possible values: [created, completed]

The status of the payload generation.

payload

object

oneOf

The webhook payload for the portout.status_changed event

id uuid

Identifies the port out that was moved.

status string

Possible values: [pending, authorized, ported, rejected, rejected-pending, canceled]

The new status of the port out.

phone_numbers string[]

Phone numbers associated with this port-out order

carrier_name string

Carrier the number will be ported out to

spid string

The new carrier SPID.

user_id uuid

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

subscriber_name string

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

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

attempted_pin string

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

record_type string

Identifies the type of the resource.

created_at date-time

ISO 8601 formatted date indicating when the resource was created.

updated_at date-time

ISO 8601 formatted date indicating when the resource was updated.

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "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": {},
      "record_type": "portout_event",
      "created_at": "2021-03-19T10:07:15.527000Z",
      "updated_at": "2021-03-19T10:07:15.527000Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

500: Internal server error

Request samples

curl -L 'https://api.telnyx.com/v2/portout/events' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "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": {},
      "record_type": "portout_event",
      "created_at": "2021-03-19T10:07:15.527000Z",
      "updated_at": "2021-03-19T10:07:15.527000Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

List all port-out events

Request ​

Query Parameters

Responses ​

Request

Responses