Numbers - List Manage Numbers Job errors

List Manage Numbers Job errors

Lists all error details of Manage Numbers job. This will not list any errors if exitCode is COMPLETED. If the status is COMPLETED_WITH_ERRORS then this lists the cause of failures.

List of possible Errors:

BATCH-1017021 - Failed to move because it is an inactive number.
BATCH-1017022 - Failed to move because the source location and target location have different CCP providers.
BATCH-1017023 - Failed because it is not an unassigned number.
BATCH-1017024 - Failed because it is a main number.
BATCH-1017027 - Manage Numbers Move Operation is not supported.
BATCH-1017031 - Hydra request is supported only for single number move job.

This API requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

GET/v1/telephony/config/jobs/numbers/manageNumbers/{jobId}/errors

URI Parameters

jobId

string

Retrieve the error details for this jobId.

Query Parameters

orgId

string

Retrieve list of jobs for this organization.

start

number

Specifies the error offset from the first result that you want to fetch.

Default: 0

max

number

Specifies the maximum number of records that you want to fetch.

Default: 2000

Response Properties

items

array[ItemObject]

item

string

Phone number

itemNumber

number

Index of error number.

trackingId

string

Unique identifier to track the HTTP requests.

error

ErrorObject

key

string

HTTP error code.

message

array[ErrorMessageObject]

Message string with further error information.

description

string

Error message.

code

string

Internal error code.

locationId

string

Error messages describing the location id in which the error occurs. For a move operation this is the target location ID.

Response Codes

The list below describes the common success and error responses you should expect from the API:

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
403	Forbidden	The request is understood, but it has been refused or access is not allowed.
404	Not Found	The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405	Method Not Allowed	The request was made to a resource using an HTTP request method that is not supported.
409	Conflict	The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410	Gone	The requested resource is no longer available.
415	Unsupported Media Type	The request was made to a resource without specifying a media type or used a media type that is not supported.
423	Locked	The requested resource is temporarily unavailable. A `Retry-After` header may be present that specifies how many seconds you need to wait before attempting the request again.
428	Precondition Required	File(s) cannot be scanned for malware and need to be force downloaded.
429	Too Many Requests	Too many requests have been sent in a given amount of time and the request has been rate limited. A `Retry-After` header should be present that specifies how many seconds you need to wait before a successful request can be made.
500	Internal Server Error	Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502	Bad Gateway	The server received an invalid response from an upstream server while processing the request. Try again later.
503	Service Unavailable	Server is overloaded with requests. Try again later.
504	Gateway Timeout	An upstream server failed to respond on time. If your query uses `max` parameter, please try to reduce it.

GET

/v1/telephony/config/jobs/numbers/manageNumbers//errors{?orgId,start,max}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

orgId
string
Retrieve list of jobs for this organization.
start
number
Specifies the error offset from the first result that you want to fetch.
max
number
Specifies the maximum number of records that you want to fetch.

https://webexapis.com/v1/telephony/config/jobs/numbers/manageNumbers/Y2lzY29zcGFyazovL3VzL0pPQl9JRC84YTI0ZjM5NC1lMTdjLTRiMTYtOTU3Ni0zNzA3YjY5YmU3Mzc/errors?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM&start=0&max=100

200 / OK

{
    "items": [{
        "itemNumber": 1,
        "item": "+12025558374",
        "error": {
            "key": "400",
            "message": [{
                "description": "Failed because it is not an unassigned number.",
                "code": "BATCH-1017023",
                "locationid": "5223bbed-42c9-454d-a1f3-7fad5cc7e6e3"
            }]
        },
        "trackingId": "ROUTER_6332cccb-e492-01bb-0165-48a3dc0a0165_0"
    }]
}