Response for successful requests
If the request is successful, then a 200 OK response will be received. The response body will contain the following entities as JSON attributes:
Entity Name | Data Type | Description |
|---|---|---|
sessionId | String | The session ID of the call. This is the same as the session ID that was passed in the status request. |
callState | String | Code to denote the overall status of the call. The values for this attribute are unknown, scheduled, initiated, connected, and disconnected. Please refer to the Call States section for more information on the call states. |
time | Integer | Indicates the time, in seconds since the Epoch (January 1 1970 00:00:00 UTC), that the specified state happened. This attribute is not returned for unknown call states. |
scheduledTime | Integer | Indicates the time, in seconds since the Epoch (January 1 1970 00:00:00 UTC), at which the call is scheduled to start. This attribute is only returned for scheduled call state. |
more | String | Indicates if there may be further changes in the call state. Values are: no: This is used if the call has ended. yes: This is used if the call is in progress. maybe: This is used if the call state is unknown, or if the call state has not changed since the last status request. |
hasChanged | String | Indicates if the status of the call has changed since the last time its status was requested. |
Response for unsuccessful requests
If the request failed then an HTTP 4XX error status code will be returned. The body of the response may provide details of why the request failed. HTTP error status codes specific to failed Get Call Status requests are as follows:
Error Condition | HTTP Status Code Used |
|---|---|
Invalid URI path | 404 Bad Request |
Invalid request parameters | 400 Bad Request |
Use of an invalid HTTP method | 405 Method Not Allowed |
Call session does not exist | 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.
