Skip to main content

List all porting phone numbers

GET 
/porting_phone_numbers

Returns a list of your porting phone numbers.

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[porting_order_id] uuid

    Filter results by porting order id

    filter[porting_order_id][in][] uuid[]

    Filter results by a list of porting order ids

    filter[support_key][eq] string

    Filter results by support key

    filter[support_key][in][] string[]

    Filter results by a list of support keys

    filter[phone_number] string

    Filter results by phone number

    filter[phone_number][in][] string[]

    Filter results by a list of phone numbers

    filter[porting_order_status] string

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

    Filter results by porting order status

    filter[activation_status] PortingOrderActivationStatus

    Possible values: [New, Pending, Conflict, Cancel Pending, Failed, Concurred, Activate RDY, Disconnect Pending, Concurrence Sent, Old, Sending, Active, Canceled]

    Filter results by activation status

    filter[portability_status] PortabilityStatus

    Possible values: [pending, confirmed, provisional]

    Filter results by portability status

Responses​

200: Successful response

Schema

    data

    object[]

  • Array [

    • porting_order_status string

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

    The current status of the porting order

    phone_number_type string

    Possible values: [landline, local, mobile, national, shared_cost, toll_free]

    The type of the phone number

    phone_number string

    E164 formatted phone number

    porting_order_id uuid

    Identifies the associated port request

    support_key string

    A key to reference this porting order when contacting Telnyx customer support

    activation_status PortingOrderActivationStatus (string)

    Possible values: [New, Pending, Conflict, Cancel Pending, Failed, Concurred, Activate RDY, Disconnect Pending, Concurrence Sent, Old, Sending, Active, Canceled]

    Activation status

    portability_status PortabilityStatus (string)

    Possible values: [pending, confirmed, provisional]

    Specifies whether Telnyx is able to confirm portability this number in the United States & Canada. International phone numbers are provisional by default.

    requirements_status string

    Possible values: [requirement-info-pending, requirement-info-under-review, requirement-info-exception, approved]

    The current status of the requirements in a INTL porting order

    record_type string

    Identifies the type of the resource.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

401: Unauthorized

422: Unprocessable entity. Check message field in response for details.

Request samples

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

Response samples

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