Skip to main content

Lists the phone numbers jobs

GET 
/phone_numbers/jobs

Lists the phone numbers jobs

Request​

Query Parameters

    filter[type] string

    Possible values: [update_emergency_settings, delete_phone_numbers, update_phone_numbers]

    Filter the phone number jobs by type.

    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.

Responses​

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

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, expired]

    Default value: pending

    Indicates the completion status of the background update.

    type string

    Possible values: [update_emergency_settings, delete_phone_numbers, update_phone_numbers]

    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.

    phone_numbers

    PhoneNumbersJobPhoneNumber[]

  • Array [

    • phone_number e164

    The phone number in e164 format.

    id int64

    The phone number's ID

  • ]

    • successful_operations

    PhoneNumbersJobSuccessfulOperation[]

  • Array [

    • phone_number e164

    The phone number in e164 format.

    id int64

    The phone number's ID

  • ]

    • pending_operations

    PhoneNumbersJobPendingOperation[]

  • Array [

    • phone_number e164

    The phone number in e164 format.

    id int64

    The phone number's ID

  • ]

    • failed_operations

    PhoneNumbersJobFailedOperation[]

  • 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

401: Unauthorized

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.

  • ]

422: Unprocessable Entity

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.

  • ]

default: Unexpected error

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.

  • ]

Request samples

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

Response samples

{
  "data": [
    {
      "id": "42587e44-3a3e-46de-9255-0c9a7a1d1ec7",
      "record_type": "phone_numbers_job",
      "status": "pending",
      "type": "update_emergency_settings",
      "etc": "2020-10-30T18:10:00.000Z",
      "created_at": "2020-10-23T18:10:00.000Z",
      "updated_at": "2020-10-23T18:10:01.000Z",
      "phone_numbers": [
        {
          "id": "2637816387126861836"
        },
        {
          "phone_number": "+19715555098"
        },
        {
          "phone_number": "+19705555099"
        },
        {
          "id": "3388768018273"
        }
      ],
      "successful_operations": [
        {
          "id": "2637816387126861836",
          "phone_number": "+19705555098"
        },
        {
          "id": "33081887126861836",
          "phone_number": "+19715555098"
        }
      ],
      "pending_operations": [
        {
          "id": "2637816387126861837",
          "phone_number": "+19705555099"
        }
      ],
      "failed_operations": [
        {
          "id": "3388768018273",
          "phone_number": "+19705551234",
          "errors": [
            {
              "code": "10015",
              "title": "Bad Request",
              "detail": "The field is invalid.",
              "source": "/emergency_address_id"
            }
          ]
        }
      ]
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}