List Manage Numbers Jobs
Lists all Manage Numbers jobs for the given organization in order of most recent one to oldest one irrespective of its status.
The public API only supports initiating jobs which move numbers between locations.
Via Control Hub they can initiate both the move and delete, so this listing can show both.
This API requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
Query Parameters
Retrieve list of Manage Number jobs for this organization.
Start at the zero-based offset in the list of jobs. Default is 0.
Limit the number of jobs returned to this maximum count. Default is 2000.
Response Properties
Lists all jobs for the customer in order of most recent one to oldest one irrespective of its status.
Job name.
Unique identifier of the job.
Job type.
Unique identifier to track the flow of HTTP requests.
Unique identifier to identify which user has run the job.
Unique identifier to identify the customer who has run the job.
Unique identifier to identify the customer for which the job was run.
Unique identifier to identify the instance of the job.
Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job.
Unique identifier that identifies each instance of the job.
Last updated time (in UTC format) post one of the step execution completion.
Displays status for overall steps that are part of the job.
Exit Code for a job.
Job creation time in UTC format.
Time lapsed since the job execution started.
Indicates the most recent status (STARTING, STARTED, COMPLETED, FAILED) of the job at the time of invocation.
Most recent exit code of the job at the time of invocation.
Job is in progress.
Job has completed successfully.
Job has failed.
Job has been stopped.
Job has completed with errors.
Indicates operation type that was carried out.
Unique location identifier for which the job was run.
Unique location identifier for which the numbers have been moved.
Job statistics.
Indicates the total number of phone numbers requested to be moved.
Indicates the total number of phone numbers successfully deleted.
Indicates the total number of phone numbers successfully moved.
Indicates the total number of phone numbers failed.
Count of phone numbers for which usage changed.
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. |
Header
Query Parameters
- Retrieve list of Manage Number jobs for this organization.
- Start at the zero-based offset in the list of jobs. Default is 0.
- Limit the number of jobs returned to this maximum count. Default is 2000.
{
"items": [{
"id": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC84YTI0ZjM5NC1lMTdjLTRiMTYtOTU3Ni0zNzA3YjY5YmU3Mzc",
"jobType": "managenumbers",
"trackingId": "ROUTER_6332CCCB-E492-01BB-0165-48A3DC0A0165",
"sourceUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNTUyZjY3Yi01OWE5LTQxYmItODczNi0xYjA0MWQxZGRkNWU",
"sourceCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM",
"targetCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM",
"instanceId": 251110,
"jobExecutionStatus": [{
"id": 252158,
"startTime": "2022-09-27T10:13:43.130Z",
"endTime": "2022-09-27T10:13:47.191Z",
"lastUpdated": "2022-09-27T10:13:47.595Z",
"statusMessage": "COMPLETED",
"exitCode": "COMPLETED",
"createdTime": "2022-09-27T10:13:43.106Z",
"stepExecutionStatuses": [{
"id": 1224428,
"startTime": "2022-09-27T10:13:43.404Z",
"endTime": "2022-09-27T10:13:44.664Z",
"lastUpdated": "2022-09-27T10:13:44.664Z",
"statusMessage": "COMPLETED",
"exitCode": "COMPLETED",
"name": "manageNumbersDeciderStep",
"timeElapsed": "PT1.26S"
},
{
"id": 1224429,
"startTime": "2022-09-27T10:13:44.684Z",
"endTime": "2022-09-27T10:13:47.182Z",
"lastUpdated": "2022-09-27T10:13:47.183Z",
"statusMessage": "COMPLETED",
"exitCode": "COMPLETED_WITH_ERRORS",
"name": "managenumbersMoveNumbers",
"timeElapsed": "PT2.498S"
}
],
"timeElapsed": "PT3.758S"
}],
"latestExecutionStatus": "COMPLETED",
"latestExecutionExitCode": "COMPLETED",
"operationType": "MOVE",
"sourceLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyMjNiYmVkLTQyYzktNDU0ZC1hMWYzLTdmYWQ1Y2M3ZTZlMw",
"targetLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgxYjUzYzk3LTQxNGQtNDhjYy1hZThiLWNhZmM0MDc4NDAwNw",
"sourceLocationName": "ABS",
"targetLocationName": "Hydra-ABS",
"counts": {
"totalNumbers": 1,
"numbersDeleted": 0,
"numbersMoved": 0,
"numbersFailed": 1,
"numbersUsageChanged": 0
}
},
{
"id": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU",
"jobType": "managenumbers",
"trackingId": "ATLAS_06a92f81-244d-4fd2-b8db-121bc1eeb6c8_11",
"sourceUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNTUyZjY3Yi01OWE5LTQxYmItODczNi0xYjA0MWQxZGRkNWU",
"sourceCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM",
"targetCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM",
"instanceId": 238972,
"jobExecutionStatus": [{
"id": 239746,
"startTime": "2022-08-24T06:18:31.092Z",
"endTime": "2022-08-24T06:18:38.448Z",
"lastUpdated": "2022-08-24T06:18:38.825Z",
"statusMessage": "COMPLETED",
"exitCode": "COMPLETED",
"createdTime": "2022-08-24T06:18:31.070Z",
"stepExecutionStatuses": [{
"id": 1172935,
"startTime": "2022-08-24T06:18:31.203Z",
"endTime": "2022-08-24T06:18:32.823Z",
"lastUpdated": "2022-08-24T06:18:32.823Z",
"statusMessage": "COMPLETED",
"exitCode": "COMPLETED",
"name": "manageNumbersDeciderStep",
"timeElapsed": "PT1.62S"
},
{
"id": 1172936,
"startTime": "2022-08-24T06:18:32.839Z",
"endTime": "2022-08-24T06:18:38.439Z",
"lastUpdated": "2022-08-24T06:18:38.439Z",
"statusMessage": "COMPLETED",
"exitCode": "COMPLETED",
"name": "managenumbersMoveNumbers",
"timeElapsed": "PT5.6S"
}
],
"timeElapsed": "PT7.22S"
}],
"latestExecutionStatus": "COMPLETED",
"latestExecutionExitCode": "COMPLETED",
"operationType": "MOVE",
"sourceLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E2MmRlOWRkLWRmODEtNDg3My04MGY5LTY2MmYyZmM3ZTI2NQ",
"targetLocationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyMjNiYmVkLTQyYzktNDU0ZC1hMWYzLTdmYWQ1Y2M3ZTZlMw",
"sourceLocationName": "Test2428",
"targetLocationName": "ABS",
"counts": {
"totalNumbers": 1,
"numbersDeleted": 0,
"numbersMoved": 1,
"numbersFailed": 0,
"numbersUsageChanged": 0
}
}
]
}