Skip to main content

List all phone number blocks

GET 
/porting_orders/:porting_order_id/phone_number_blocks

Returns a list of all phone number blocks of a porting order.

Request ​

Path Parameters

    porting_order_id uuidrequired

    Identifies the Porting Order associated with the phone number blocks

Query Parameters

    filter[phone_number] string

    Filter results by phone number

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

    Filter results by a list of phone numbers

    sort[] string

    Possible values: [-created_at, created_at]

    Specifies the sort order for results. If not given, results are sorted by created_at in descending order

    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

Responses ​

200: Successful response

Schema

    data

    object[]

  • Array [

    • id uuid

    Uniquely identifies this porting phone number block.

    country_code string

    Specifies the country code for this porting phone number block. 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 porting phone number block.

    phone_number_range

    object

    Specifies the phone number range for this porting phone number block.

    start_at string

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

    Specifies the start of the phone number range for this porting phone number block.

    end_at string

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

    Specifies the end of the phone number range for this porting phone number block.

    Specifies the phone number range for this porting phone number block.

    activation_ranges

    object[]

    Specifies the activation ranges for this porting phone number block. The activation range must be within the phone number range and should not overlap with other activation ranges.

  • Array [

    • start_at string

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

    Specifies the start of the activation range. Must be greater or equal the start of the phone number range.

    end_at string

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

    Specifies the end of the activation range. It must be no more than the end of the phone number range.

  • ]

    • Specifies the activation ranges for this porting phone number block. The activation range must be within the phone number range and should not overlap with other activation ranges.

    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/phone_number_blocks' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "data": [
    {
      "id": "f24151b6-3389-41d3-8747-7dd8c681e5e2",
      "country_code": "DE",
      "phone_number_type": "local",
      "phone_number_range": {
        "start_at": "+4930244999901",
        "end_at": "+4930244999910"
      },
      "activation_ranges": [
        {
          "start_at": "+4930244999901",
          "end_at": "+4930244999910"
        }
      ],
      "record_type": "porting_phone_number_block",
      "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
  }
}