Retrieve a sub number order

GET 
/sub_number_orders/:sub_number_order_id

Get an existing sub number order.

Path Parameters

sub_number_order_id stringrequired

The sub number order ID.

Query Parameters

filter[include_phone_numbers] boolean

Include the first 50 phone number objects in the results

200: Successful response with details about a sub number order.

application/json

• Schema
• Example (from schema)

Schema

data

SubNumberOrder

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

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

default: Unexpected error

application/json

• Schema
• Example (from schema)

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.

]

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

Request samples

• cURL

---

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

Response samples

• 200
• default

---

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

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "string"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}