Retrieve a list of phone numbers associated to orders
GET/number_order_phone_numbers
Get a list of phone numbers associated to orders.
Responses
200: Successful response with a list of number order phone numbers.
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
data
NumberOrderPhoneNumber[]
Possible values: [local
, toll_free
, mobile
, national
, shared_cost
, landline
]
regulatory_requirements
SubNumberOrderRegulatoryRequirementWithValue[]
Unique id for a requirement.
Possible values: [textual
, datetime
, address
, document
]
The value of the requirement, this could be an id to a resource or a string value.
True if all requirements are met for a phone number, false otherwise.
Possible values: [pending
, success
, failure
]
The status of the phone number in the order.
meta
object
{
"data": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"record_type": "number_order_phone_number",
"phone_number": "+19705555098",
"order_request_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd495",
"sub_number_order_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd496",
"country_code": "US",
"phone_number_type": "local",
"regulatory_requirements": [
{
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
"field_type": "address",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21"
}
],
"requirements_met": true,
"status": "pending"
}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}
default: Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
meta
object
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"
}
}
]
}