Skip to main content

List all associated phone numbers

GET 
/porting_orders/:porting_order_id/associated_phone_numbers

Returns a list of all associated phone numbers for a porting order. Associated phone numbers are used for partial porting in GB to specify which phone numbers should be kept or disconnected.

Request ​

Path Parameters

    porting_order_id uuidrequired

    Identifies the Porting Order associated with the phone numbers

Query Parameters

    page object

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

    filter object

    Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[action]

    sort object

    Consolidated sort parameter (deepObject style). Originally: sort[value]

Responses ​

200: Successful response

Schema

    data

    object[]

  • Array [

    • id uuid

    Uniquely identifies this associated phone number.

    porting_order_id uuid

    Identifies the porting order associated with this phone number.

    country_code string

    Specifies the country code for this associated phone number. It is a two-letter ISO 3166-1 alpha-2 country code.

    phone_number_type string

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

    Specifies the phone number type for this associated phone number.

    phone_number_range

    object

    Specifies the phone number range for this associated phone number.

    start_at string

    Possible values: Value must match regular expression ^\+\d{7,15}$

    Specifies the start of the phone number range for this associated phone number.

    end_at string

    Possible values: Value must match regular expression ^\+\d{7,15}$

    Specifies the end of the phone number range for this associated phone number.

    Specifies the phone number range for this associated phone number.

    action string

    Possible values: [keep, disconnect]

    Specifies the action to take with this phone number during partial porting.

    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 last updated.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

401: Unauthorized

404: Not found

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

Request samples

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

Response samples

{
  "data": [
    {
      "id": "f24151b6-3389-41d3-8747-7dd8c681e5e2",
      "porting_order_id": "a24151b6-3389-41d3-8747-7dd8c681e5e2",
      "country_code": "GB",
      "phone_number_type": "local",
      "phone_number_range": {
        "start_at": "+441234567890",
        "end_at": "+441234567899"
      },
      "action": "keep",
      "record_type": "porting_associated_phone_number",
      "created_at": "2021-03-19T10:07:15.527Z",
      "updated_at": "2021-03-19T10:07:15.527Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}