The Callr API utilizes standard HTTP response codes to signify the outcome of API requests:
| Code range | Description |
|---|---|
| 200 | Everything worked as expected. |
| 201 | An object was successfully created. |
| 202 | A request is being processed. |
| 204 | Everyting worked as expected (empty response). |
| 400 | Bad Request. |
| 401 | Unauthorized (authentication failed). |
| 403 | Forbidden (authentication required or failed, or action is not permitted). |
| 405 | Method not allowed (GET, POST, PUT...). |
| 500 | Problem with Callr's servers (should not happen). |
By adhering to these conventions, the Callr API ensures clear communication regarding the status of each request.
Most errors will return a JSON object:
{
"code": "machine-error-code",
"message": "human readable error message"
}