Asynchronous API

If a request successfully enters the queue for processing (that is, it has passed capacity and validation checks before entering the queue), a HTTP 202 response with the following Location URL in the header is returned: https://<ipaddress>:8111/cvp-config /asynchrequeststatus/<JOBID>

The following XML body is returned in the response.

<asyncResult>
   <progress>IN_QUEUE</progress>
</asyncResult>

The media file and VXML application delete APIs are asynchronous by default to ensure the response time meets the requirements.

The following table lists the values for <progress> in the returned XML content:

Values for <progress> in the Returned XML Content
Value	Description
IN_QUEUE	The request has passed validation and capacity checks, and the request has been queued.
IN_PROGRESS	The request has been taken out of the queue and is being processed.

If the initial request completes successfully, an asynchrequeststatus query responds with the 200 Ok response code .

If the initial request fails, an asynchrequeststatus query responds with 500 response code along with the API errors in the response body.

Processing Errors

The following list describes the exceptions that are returned and the conditions under which they are returned:

Tasks that cannot be put in a queue because the maximum capacity has been reached return an HTTP status code of 503, with an API error indicating the queue is full.
If a task is not completed in 5 minutes, it is marked as deemed-failure. On the next poll for the status of this task, an HTTP status code of 503 is returned, with an API error indicating that the task timed out.