FreeClimb uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the
2xx range indicate success, codes in the
4xx range indicate an error in the HTTP request provided, and codes in the
5xx range indicate an internal FreeClimb error.
When a POST request is made FreeClimb generates a unique request ID that is returned in the response header. FreeClimb will reuse this request ID if there are multiple webhooks for your initial request. This request ID can be used with the Performance Query Language (PQL) to Filter Logs.
|200 - OK||Request was successfully processed.|
|201 - Created||Resource was successfully created.|
|202 - Accepted||Request was successfully queued and is being processed|
|204 - No Content||Request was successfully processed; the response does not include a message body.|
|400 - Bad Request||Request was unacceptable, often due to an invalid parameter value or missing a required parameter.|
|401 - Unauthorized||Account credentials were invalid.|
|403 - Forbidden||Account credentials not authorized.|
|404 - Not Found||Requested resource doesn’t exist. In most cases it means the call/queue/conference/etc doesn't exist.|
Note that when working with calls within queues and conferences, it may mean the particular call doesn't exist within the conference or the queue.
Using the REST API to manipulate a completed call can also result in a 404, even though the live call did exist in the past. While a completed call can be used with a GET, it can't be used with a POST.
|405 - Method Not Allowed||HTTP Method in the request was invalid.|
|409 - Conflict||Request could not be completed due to a conflict with the current state of the resource.|
|500, 502, 503, 504 - Server Errors||Error on FreeClimb's end.|