5. Responses

All requests to the Conversation Analyzer API endpoints return standard HTTP headers, including the response status code, and a response body in JSON format.

Success response code and parameters

Successful requests return a 200 Success code with a JSON object in the response body. For specific details on the payload of each endpoint response, see the Conversation Analyzer API Reference.

Response codes and errors

Error code 400 Bad Request

The Conversation Analyzer API returns 400 Bad Request in response to an invalid request.

Missing API version

If you do not provide the required API version in the accept header, you will receive the following message in addition to the 400 error code:

{
    "error": {
        "code": "ApiVersionUnspecified",
        "message": "An API version is required, but was not specified.",
        "innerError": null
    }
}

Invalid API version

If you provide an invalid API version in the accept header, you will receive the following message in addition to the 400 error code:

{
    "error": {
        "code": "UnsupportedApiVersion",
        "message": "The HTTP resource that matches the request URI 'http://c11-transcriptions.contact-world.net/public/interactions/asdf?transcript=true' does not support the API version '4'.",
        "innerError": null
    }
}

Error code 401 Unauthorized

The Conversation Analyzer API returns 401 Unauthorized in response to an invalid, expired or missing bearer access token.

Error code 403 Forbidden

The Conversation Analyzer API returns 403 Forbidden in response to a request that is not authorized. This error is generally caused by a token that is missing one or more required scopes.

Error code 404 Not Found

The Conversation Analyzer API returns 404 Not Found in response to a request for an item that was not found. You may have requested an interaction that doesn’t exist.

Invalid GUID

Invalid GUIDs may result in a 404 Not Found, depending on the endpoint used.

An invalid GUID may otherwise result in a 500 Internal Server Error or will simply be skipped.

Error code 405 Method Not Allowed

The Conversation Analyzer API returns 405 Method Not Allowed in response to a call to a method that is not allowed. For example, a POST method. If you send a request using a method that is not allowed, you will receive the following message in addition to the 405 error code:

{
    "error": {
        "code": "UnsupportedApiVersion",
        "message": "The HTTP resource that matches the request URI 'http://c11-transcriptions.contact-world.net/public/interactions/asdf?transcript=true' with API version '1' does not support HTTP method 'POST'.",
        "innerError": null
    }
}

Error code 500 Internal Server Error

An internal server error occurred.

Invalid GUID

Invalid GUIDs may result in a 500 Internal Server Error, depending on the endpoint used.

An invalid GUID may otherwise result in a 404 Not Found or will simply be skipped.