Skip to main content

Retrieve a phone numbers job

GET 

/phone_numbers/jobs/:id

Retrieve a phone numbers job

Request

Path Parameters

    id stringrequired

    Identifies the Phone Numbers Job.

Responses

200: Phone numbers job details.

Schema

    data

    object

    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.

  • ]

  • ]

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.

  • ]

404: Not Found

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.

  • ]

Loading...