Porting Orders

List all porting phone numbers

Changed on

Returns a list of your porting phone numbers.

get/porting_phone_numbers

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/porting_phone_numbers
  • Auth: HTTP bearer

Query parameters

sizeinteger

The size of the page

numberinteger

The page number to load

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

porting_order_status'draft' | 'in-process' | 'submitted' | 'exception' | 'foc-date-confirmed' | 'cancel-pending' | 'ported' | 'cancelled'

Filter results by porting order status

Consolidated filter parameter (deepObject style). Originally: filter[porting_order_status]

{
  "porting_order_status": "in-process"
}

Response

Successful response

Example response

{
  "data": [
    {
      "porting_order_status": "in-process",
      "phone_number_type": "local",
      "phone_number": "13035550987",
      "porting_order_id": "f1486bae-f067-460c-ad43-73a92848f902",
      "support_key": "sr_a12345",
      "activation_status": "Active",
      "portability_status": "confirmed",
      "requirements_status": "approved",
      "record_type": "porting_phone_number"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Changes

  • 042186142b82Revision changes
    • warning

      added the new localcommercial enum value to the // response property for the response status

  • 9cad62ef6199Revision changes
    • warning

      added the new multipurpose enum value to the // response property for the response status

    • warning

      added the new other enum value to the // response property for the response status