Lists the phone number blocks jobs
GET/phone_number_blocks/jobs
Lists the phone number blocks jobs
Request
Query Parameters
Possible values: [delete_phone_number_block
]
Filter the phone number blocks jobs by type.
Possible values: [pending
, in_progress
, completed
, failed
]
Filter the phone number blocks jobs by status.
Possible values: >= 1
Default value: 1
The page number to load
Possible values: >= 1
and <= 250
Default value: 20
The size of the page
Possible values: [created_at
]
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 number blocks background jobs.
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
Array [
]
]
]
data
object[]
Identifies the resource.
Identifies the type of the resource.
Possible values: [pending
, in_progress
, completed
, failed
]
Default value: pending
Indicates the completion status of the background operation.
Possible values: [delete_phone_number_block
]
Identifies the type of the background job.
ISO 8601 formatted date indicating when the estimated time of completion of the background job.
ISO 8601 formatted date indicating when the resource was created.
ISO 8601 formatted date indicating when the resource was updated.
successful_operations
PhoneNumberBlocksJobSuccessfulOperation[]
The phone number in e164 format.
The phone number's ID
failed_operations
PhoneNumberBlocksJobFailedOperation[]
The phone number in e164 format.
The phone number's ID
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.
meta
object
{
"data": [
{
"id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
"record_type": "phone_numbers_job",
"status": "pending",
"type": "delete_phone_number_block",
"etc": "2020-10-30T18:10:00.000Z",
"created_at": "2020-10-23T18:10:00.000Z",
"updated_at": "2020-10-23T18:10:01.000Z",
"successful_operations": [],
"failed_operations": []
}
],
"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"
}
}
]
}