List all porting events

GET 
/porting/events

Returns a list of all porting events.

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[type] string

Possible values: [porting_order.deleted, porting_order.loa_updated, porting_order.messaging_changed, porting_order.status_changed, porting_order.sharing_token_expired, porting_order.new_comment, porting_order.split]

Filter by event type.

filter[porting_order_id] uuid

Filter by porting 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.

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

id uuid

Uniquely identifies the event.

event_type string

Possible values: [porting_order.deleted, porting_order.loa_updated, porting_order.messaging_changed, porting_order.status_changed, porting_order.sharing_token_expired, porting_order.new_comment, porting_order.split]

Identifies the event type

porting_order_id uuid

Identifies the porting order associated with the event.

available_notification_methods string[]

Possible values: [email, webhook, webhook_v1]

Indicates the notification methods used.

payload_status string

Possible values: [created, completed]

The status of the payload generation.

payload

object

oneOf

• WebhookPortingOrderDeletedPayload
• WebhookPortingOrderMessagingChangedPayload
• WebhookPortingOrderStatusChangedPayload
• WebhookPortingOrderNewCommentPayload
• WebhookPortingOrderSplitPayload

The webhook payload for the porting_order.deleted event

id uuid

Identifies the porting order that was deleted.

customer_reference string

Identifies the customer reference associated with the porting order.

deleted_at date-time

ISO 8601 formatted date indicating when the porting order was deleted.

The webhook payload for the porting_order.messaging_changed event

id uuid

Identifies the porting order that was moved.

customer_reference string

Identifies the customer reference associated with the porting order.

support_key string

Identifies the support key associated with the porting order.

messaging

object

The messaging portability status of the porting order.

messaging_capable boolean

Indicates whether the porting order is messaging capable.

enable_messaging boolean

Indicates whether Telnyx will port messaging capabilities from the losing carrier. If false, any messaging capabilities will stay with their current provider.

messaging_port_status string

Possible values: [not_applicable, pending, activating, exception, canceled, partial_port_complete, ported]

Indicates the messaging port status of the porting order.

messaging_port_completed boolean

Indicates whether the messaging port is completed.

The messaging portability status of the porting order.

The webhook payload for the porting_order.status_changed event

id uuid

Identifies the porting order that was moved.

customer_reference string

Identifies the customer reference associated with the porting order.

status

object

Porting order status

details

object[]

A list of 0 or more details about this porting order's status

Array [

code string

Possible values: [ACCOUNT_NUMBER_MISMATCH, AUTH_PERSON_MISMATCH, BTN_ATN_MISMATCH, ENTITY_NAME_MISMATCH, FOC_EXPIRED, FOC_REJECTED, LOCATION_MISMATCH, LSR_PENDING, MAIN_BTN_PORTING, OSP_IRRESPONSIVE, OTHER, PASSCODE_PIN_INVALID, PHONE_NUMBER_HAS_SPECIAL_FEATURE, PHONE_NUMBER_MISMATCH, PHONE_NUMBER_NOT_PORTABLE, PORT_TYPE_INCORRECT, PORTING_ORDER_SPLIT_REQUIRED, POSTAL_CODE_MISMATCH, RATE_CENTER_NOT_PORTABLE, SV_CONFLICT, SV_UNKNOWN_FAILURE]

Identifier of an exception type

description string

Description of an exception type

]

A list of 0 or more details about this porting order's status

value string

Possible values: [draft, in-process, submitted, exception, foc-date-confirmed, ported, cancelled, cancel-pending]

The current status of the porting order

Porting order status

support_key string

Identifies the support key associated with the porting order.

updated_at date-time

ISO 8601 formatted date indicating when the porting order was moved.

webhook_url string

The URL to send the webhook to.

The webhook payload for the porting_order.new_comment event

porting_order_id uuid

Identifies the porting order that the comment was added to.

support_key string

Identifies the support key associated with the porting order.

comment

object

The comment that was added to the porting order.

id uuid

Identifies the comment.

body string

The body of the comment.

user_id uuid

Identifies the user that create the comment.

user_type string

Possible values: [user, admin, system]

Identifies the type of the user that created the comment.

inserted_at date-time

ISO 8601 formatted date indicating when the comment was created.

The comment that was added to the porting order.

The webhook payload for the porting_order.split event

from

object

The porting order that was split.

id uuid

Identifies the porting order that was split.

The porting order that was split.

to

object

The new porting order that the phone numbers was moved to.

id uuid

Identifies the porting order that was split.

The new porting order that the phone numbers was moved to.

porting_phone_numbers

object[]

The list of porting phone numbers that were moved to the new porting order.

Array [

id uuid

Identifies the porting phone number that was moved.

]

The list of porting phone numbers that were moved to the new porting order.

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": "porting_order.deleted",
      "porting_order_id": "9471c873-e3eb-4ca1-957d-f9a451334d52",
      "available_notification_methods": [
        "email"
      ],
      "payload_status": "created",
      "payload": {},
      "record_type": "porting_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

---

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

Response samples

• 200

---

{
  "data": [
    {
      "id": "eef3340b-8903-4466-b445-89b697315a3a",
      "event_type": "porting_order.deleted",
      "porting_order_id": "9471c873-e3eb-4ca1-957d-f9a451334d52",
      "available_notification_methods": [
        "email"
      ],
      "payload_status": "created",
      "payload": {},
      "record_type": "porting_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
  }
}