Error Handling

Bad Request

The 400 (Bad request) status code indicates that server cannot process the request due to something that is perceived to be a client error

Malformed Payload

{
    "type": "https://developers.avayacloud.com/onecloud-ccaas/v1.0/docs/error-handling#bad-request",
    "title": "Bad Request",
    "status": 400,
    "detail": "The request could not be understood by the server due to malformed syntax."
}

Invalid AccountID

{
    "type": "https://developers.avayacloud.com/onecloud-ccaas/v1.0/docs/error-handling#bad-request",
    "title": "Bad Request",
    "status": "400",
    "detail": "Invalid AccountID"
}

Unauthorized

The 401 (Unauthorized) status code indicates that the authentication credentials received are not authorized.

Invalid App Key

{
    "type": "https://developers.avayacloud.com/onecloud-ccaas/v1.0/docs/error-handling#unauthorized",
    "title": "Unauthorized",
    "status": 401,
    "detail": "The client request has not been completed because it lacks valid authentication credentials(Appkey)"
}

Invalid Access Token

{
    "type": "https://developers.avayacloud.com/onecloud-ccaas/v1.0/docs/error-handling#unauthorized",
    "title": "Unauthorized",
    "status": 401,
    "detail": "The client request has not been completed because it lacks valid authentication credentials(Access-Token)"
}

Resource Not Found

The 404 (Resource not found) status code indicates that the server cannot find the requested resource

{
    "type": "https://developers.avayacloud.com/onecloud-ccaas/docs/error-handling#resource-not-found",
    "title": "Resource Not Found",
    "status": 404,
    "detail": "Either there is no API method associated with the URL path of the request, or the request refers to one or more resources that were not found."
}

Too Many Requests

The 429 (Too many requests) status code indicates that the client has sent too many requests in a given time frame.

For further details on 429 scenarios and how to handle such responses please see -- HTTP Headers

Spike Limit Exhausted

{
    "type": "https://developers.avayacloud.com/onecloud-ccaas/v1.0/docs/error-handling#too-many-requests",
    "title": "Too Many Requests",
    "status": 429,
    "detail": "Spike limit has been exhausted"
}

Tenant Quota Exhausted

{
    "type": "https://developers.avayacloud.com/onecloud-ccaas/v1.0/docs/error-handling#too-many-requests",
    "title": "Too Many Requests",
    "status": 429,
    "detail": "Tenant Quota has been exhausted"
}

Internal Server Error

The 500 (Internal Server Error) status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

{
    "type": "https://developers.avayacloud.com/onecloud-ccaas/v1.0/docs/error-handling#internal-server-error",
    "title": "Internal Server Error",
    "status": 500,
    "detail": "The server encountered an unexpected condition that prevented it from fulfilling the request."
}