Retrieve a number order

GET 
/number_orders/:number_order_id

Get an existing phone number order.

Request

Path Parameters

number_order_id stringrequired

The number order ID.

Responses

200: Successful response with details about a number order.

application/json

• Schema
• Example (from schema)

Schema

data

object

id uuid

record_type string

phone_numbers_count integer

The count of phone numbers in the number order.

connection_id string

Identifies the connection associated with this phone number.

messaging_profile_id string

Identifies the messaging profile associated with the phone number.

billing_group_id string

Identifies the messaging profile associated with the phone number.

phone_numbers

PhoneNumber[]

Array [

id uuid

record_type string

phone_number e164_phone_number

regulatory_requirements

SubNumberOrderRegulatoryRequirementWithValue[]

Array [

record_type string

requirement_id uuid

Unique id for a requirement.

field_type string

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

field_value string

The value of the requirement, this could be an id to a resource or a string value.

]

requirements_met boolean

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

requirements_status string

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

Status of document requirements (if applicable)

status string

Possible values: [pending, success, failure]

The status of the phone number in the order.

bundle_id uuid

phone_number_type string

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

Phone number type

country_code string

Country code of the phone number

]

sub_number_orders_ids string[]

status string

Possible values: [pending, success, failure]

The status of the order.

customer_reference string

A customer reference string for customer look ups.

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.

{
  "data": {
    "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    "record_type": "number_order",
    "phone_numbers_count": 1,
    "connection_id": "346789098765567",
    "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
    "billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",
    "phone_numbers": [
      {
        "id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
        "record_type": "number_order_phone_number",
        "phone_number": "+19705555098",
        "bundle_id": "bc8e4d67-33a0-4cbb-af74-7b58f05bd474",
        "regulatory_requirements": [
          {
            "record_type": "phone_number_regulatory_requirement",
            "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
            "field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
            "field_type": "address"
          }
        ],
        "requirements_met": true,
        "status": "success"
      }
    ],
    "sub_number_orders_ids": [
      "string"
    ],
    "status": "pending",
    "customer_reference": "MY REF 001",
    "created_at": "2018-01-01T00:00:00.000000Z",
    "updated_at": "2018-01-01T00:00:00.000000Z",
    "requirements_met": true
  }
}

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

Loading...