Retrieve a phone numbers job
GET/phone_numbers/jobs/:id
Retrieve a phone numbers job
Request
Path Parameters
Identifies the Phone Numbers Job.
Responses
200: Phone numbers job details.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Array [
]
Array [
Array [
]
]
data
object
Identifies the resource.
Identifies the type of the resource.
Possible values: [pending
, in_progress
, completed
, failed
, expired
]
Default value: pending
Indicates the completion status of the background update.
Possible values: [update_emergency_settings
, delete_phone_numbers
, update_phone_numbers
]
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.
phone_numbers
PhoneNumbersJobPhoneNumber[]
The phone number in e164 format.
The phone number's ID
successful_operations
PhoneNumbersJobSuccessfulOperation[]
The phone number in e164 format.
The phone number's ID
pending_operations
PhoneNumbersJobPendingOperation[]
The phone number in e164 format.
The phone number's ID
failed_operations
PhoneNumbersJobFailedOperation[]
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.
{
"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"
}
]
}
]
}
}
401: Unauthorized
- application/json
- Schema
- Example (from schema)
- Authentication Failed
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"
}
}
]
}
{
"errors": [
{
"code": "10009",
"title": "Authentication failed",
"detail": "Could not understand the provided credentials.",
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10009"
}
}
]
}
404: Not Found
- application/json
- Schema
- Example (from schema)
- Resource not found
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"
}
}
]
}
{
"errors": [
{
"code": "10005",
"title": "Resource not found",
"detail": "The requested resource or URL could not be found.",
"source": {
"pointer": "/base"
},
"meta": {
"url": "https://developers.telnyx.com/docs/overview/errors/10005"
}
}
]
}
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"
}
}
]
}