List number block orders
GET/number_block_orders
Get a paginated list of number block orders.
Request
Query Parameters
Filter number block orders by status.
Filter number block orders later than this value.
Filter number block orders earlier than this value.
Filter number block orders having these phone numbers.
Possible values: >= 1
Default value: 1
The page number to load
Possible values: >= 1
and <= 250
Default value: 20
The size of the page
Responses
200: Successful response with a list of number block orders.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
data
NumberBlockOrder[]
Starting phone number block
The phone number range included in the block.
The count of phone numbers in the number order.
Identifies the connection associated to all numbers in the phone number block.
Identifies the messaging profile associated to all numbers in the phone number block.
Possible values: [pending
, success
, failure
]
The status of the order.
A customer reference string for customer look ups.
An ISO 8901 datetime string denoting when the number order was created.
An ISO 8901 datetime string for when the number order was updated.
True if all requirements are met for every phone number, false otherwise.
meta
object
{
"data": [
{
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"starting_number": "+19705555000",
"range": 10,
"record_type": "number_block_order",
"connection_id": "346789098765567",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
"phone_numbers_count": 10,
"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
}
],
"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"
}
}
]
}