Slim List phone numbers
GET/phone_numbers/slim
List phone numbers, This endpoint is a lighter version of the /phone_numbers endpoint having higher performance and rate limit.
Request
Query Parameters
Possible values: >= 1
Default value: 1
The page number to load
Possible values: >= 1
and <= 250
Default value: 20
The size of the page
Include the connection associated with the phone number.
Include the tags associated with the phone number.
Filter by phone number tags. (This requires the include_tags param)
Filter by phone number. Requires at least three digits. Non-numerical characters will result in no values being returned.
Possible values: [purchase_pending
, purchase_failed
, port_pending
, active
, deleted
, port_failed
, emergency_only
, ported_out
, port_out_pending
]
Filter by phone number status.
Filter by connection_id.
Filter contains connection name. Requires at least three characters and the include_connection param.
Filter starts with connection name. Requires at least three characters and the include_connection param.
Filter ends with connection name. Requires at least three characters and the include_connection param.
Filter by connection name , requires the include_connection param and the include_connection param.
Possible values: [pay-per-minute
, channel
]
Filter by usage_payment_method.
Filter by the billing_group_id associated with phone numbers. To filter to only phone numbers that have no billing group associated them, set the value of this filter to the string 'null'.
Filter by the emergency_address_id associated with phone numbers. To filter only phone numbers that have no emergency address associated with them, set the value of this filter to the string 'null'.
Filter numbers via the customer_reference set.
Possible values: [purchased_at
, phone_number
, connection_name
, usage_payment_method
]
Specifies the sort order for results. If not given, results are sorted by created_at in descending order.
Responses
200: Successful response with a list of phone numbers.
- application/json
default: Unexpected error
- application/json
Request samples
curl -L 'https://api.telnyx.com/v2/phone_numbers/slim' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
Response samples
{
"data": [
{
"id": "1293384261075731499",
"record_type": "phone_number",
"phone_number": "+19705555098",
"status": "active",
"external_pin": "1234",
"connection_id": "1293384261075731499",
"customer_reference": "customer-reference",
"billing_group_id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
"emergency_enabled": true,
"emergency_address_id": "1315261609962112019",
"call_forwarding_enabled": true,
"cnam_listing_enabled": true,
"caller_id_name_enabled": true,
"call_recording_enabled": true,
"t38_fax_gateway_enabled": true,
"number_level_routing": "disabled",
"phone_number_type": "local",
"inbound_call_screening": "disabled",
"purchased_at": "2019-10-23T18:10:00.000Z",
"created_at": "2019-10-23T18:10:00.000Z",
"updated_at": "2019-10-24T18:10:00.000Z",
"hd_voice_enabled": true
}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}
{
"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"
}
}
]
}