Lists the phone number blocks jobs

GET 
/phone_number_blocks/jobs

Lists the phone number blocks jobs

Query Parameters

filter[type] string

Possible values: [delete_phone_number_block]

Filter the phone number blocks jobs by type.

filter[status] string

Possible values: [pending, in_progress, completed, failed]

Filter the phone number blocks jobs by status.

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page

sort string

Possible values: [created_at]

Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

200: Successful response with a list of phone number blocks background jobs.

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

id uuid

Identifies the resource.

record_type string

Identifies the type of the resource.

status string

Possible values: [pending, in_progress, completed, failed]

Default value: pending

Indicates the completion status of the background operation.

type string

Possible values: [delete_phone_number_block]

Identifies the type of the background job.

etc date-time

ISO 8601 formatted date indicating when the estimated time of completion of the background job.

created_at string

ISO 8601 formatted date indicating when the resource was created.

updated_at string

ISO 8601 formatted date indicating when the resource was updated.

successful_operations

PhoneNumberBlocksJobSuccessfulOperation[]

Array [

phone_number e164

The phone number in e164 format.

id int64

The phone number's ID

]

failed_operations

PhoneNumberBlocksJobFailedOperation[]

Array [

phone_number e164

The phone number in e164 format.

id int64

The phone number's ID

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.

]

]

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "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

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

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/phone_number_blocks/jobs' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

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

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