Response for Successful Requests
If the start call request was successfully completed, then a 200 OK response is returned. The response body contains the following entities (JSON object members):
Entity Name | Data Type | String |
|---|---|---|
sessionId | String | Unique ID for the call |
Response for Unsuccessful Requests
If the request failed then an HTTP 4XX error status code is returned. The body of the response may provide details of why the request failed. HTTP error status codes specific to failed Call Status requests are as follows:
Error Condition | HTTP Status Code Used |
|---|---|
Use of an invalid HTTP method for the action | 405 Method Not Allowed |
Invalid URI path | 404 Not Found |
API version (mandatory) is invalid | 404 Not Found |
Contact ID (mandatory) s invalid | 404 Not Found |
Call template identified by Contact ID cannot be found | 404 Not Found |
Visitor phone number (mandatory) is invalid | 404 Not Found |
Call delay parameter (optional) is invalid | 400 Bad request |
User extension parameter (optional) is invalid | 400 Bad Request |
Pre‐call authorization checks fail | 403 Forbidden |
Start call attempt failed | 404 Not Found |
A full list of HTTP status codes used by the API can be found in Appendix A: Use of HTTP Status Codes.
