Skip to main content

List sub number orders

GET 
/sub_number_orders

Get a paginated list of sub number orders.

Request​

Query Parameters

    filter[status] string

    Filter sub number orders by status.

    filter[order_request_id] uuid

    ID of the number order the sub number order belongs to

    filter[country_code] string

    ISO alpha-2 country code.

    filter[phone_number_type] string

    Phone Number Type

    filter[phone_numbers_count] integer

    Amount of numbers in the sub number order

    filter[include_phone_numbers] boolean

    Include the first 50 phone number objects for each sub order in the results. Note: use of this filter could produce unexpected results due to payload size.

Responses​

200: Successful response with a list of sub number orders.

Schema

    data

    SubNumberOrder[]

  • Array [

    • id uuid
    order_request_id uuid
    country_code string
    phone_number_type string

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

    user_id uuid

    regulatory_requirements

    SubNumberOrderRegulatoryRequirement[]

  • Array [

    • record_type string
    requirement_id uuid

    Unique id for a requirement.

    field_type string

    Possible values: [textual, datetime, address, document]

  • ]

    • record_type string
    phone_numbers_count integer

    The count of phone numbers in the number order.

    created_at datetime

    An ISO 8901 datetime string denoting when the number order was created.

    updated_at datetime

    An ISO 8901 datetime string for when the number order was updated.

    requirements_met boolean

    True if all requirements are met for every phone number, false otherwise.

    status string

    Possible values: [pending, success, failure]

    The status of the order.

    customer_reference string

    A customer reference string for customer look ups.

    is_block_sub_number_order boolean

    True if the sub number order is a block sub number order

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta

    object

    url string

    URL with additional information on the error.

  • ]

Request samples

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

Response samples

{
  "data": [
    {
      "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      "order_request_id": "12ade33a-21c0-473b-b055-b3c836e1c293",
      "country_code": "US",
      "phone_number_type": "local",
      "user_id": "d70873cd-7c98-401a-81b6-b1ae08246995",
      "regulatory_requirements": [
        {
          "record_type": "phone_number_regulatory_requirement",
          "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
          "field_type": "address"
        }
      ],
      "record_type": "sub_number_order",
      "phone_numbers_count": 1,
      "created_at": "2018-01-01T00:00:00.000000Z",
      "updated_at": "2018-01-01T00:00:00.000000Z",
      "requirements_met": true,
      "status": "pending",
      "customer_reference": "MY REF 001",
      "is_block_sub_number_order": false
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}