Response for successful requests
If the request is successful a 200 OK response should be received. The response body contains the following entity as a JSON attribute:
Entity Name | Data Type | Description |
|---|---|---|
callState | String | This holds the value ended to denote that the call has ended. |
Response for unsuccessful requests
If the request failed then an HTTP 4XX error status code should be returned. The body of the response may provide details of why the request failed.
Error codes specific to failed End Call requests are as follows:
Error Condition | HTTP Status Code Used |
|---|---|
Invalid URI path | 404 Not Found |
Use of an invalid HTTP method | 405 Method Not Allowed |
Call session does not exist | 404 Not Found |
The call is already ending | 403 Forbidden |
A full list of HTTP status codes used by the Call Setup API can be found in Appendix 1: Use of HTTP Status Codes.
