Responses (Interaction Content API)

Owned by Helen Griffith
Last updated: Aug 06, 2024

All requests to the Interaction Content 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 OK code with a JSON object in the response body or a 204 No Content code with an empty response body. For specific details on the payload of each endpoint response, see API reference (Interaction Content API).

Pagination

Responses from endpoints that return multiple resources contain the nextContinuationToken within the meta section.

nextContinuationToken contains a value you can use to get the next available page of data.

To get the next page of data, use the value of nextContinuationToken as the continuationToken request parameter in your subsequent request. If you do not provide the continuationToken request parameter, your request will return the first available page of data.

Use consecutively generated nextContinuationToken values from responses to request pages one by one.

If the nextContinuationToken value returned is null, the response contains the last available page of data.

Response codes and errors

Error code 400 Bad Request

The Interaction Content 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:

{
  "message": "Invalid api-version! Valid values: 'application/vnd.newvoicemedia.v2+json', 'application/vnd.newvoicemedia.v3+json'"
}

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:

{
  "message": "Invalid api-version! Valid values: 'application/vnd.newvoicemedia.v3+json'"
}

GUID incorrect length

If you provide one or more GUIDs of incorrect length (more than or fewer than 36 characters), you will receive the following error message:

{
  "message": "GUID must be 36 characters in length"
}

Invalid GUID

{
  "message": "GUID '111414121313' is not a valid UUID string"
}

Error code 401 Unauthorized

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

Error code 403 Forbidden

The Interaction Content 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 Interaction Content 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 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.