4. Requests

Request parameters

Path parameters

In requests to some API endpoints you can provide your own values in place of path parameters.

For example, in the GET conversation-analyzer/interactions/{guid} endpoint, you must replace {guid} with the real value for the interaction you require.

Path parameters are required.

Query string parameters

In most API endpoints you can use query string parameters to specify options that limit the data included in responses.

Some query string parameters are required; others are optional.

For example, in the GET /interactions endpoint, you can optionally add a transcript parameter to the query string:


Header parameters

All Conversation Analyzer API requests require the following header parameters:


Required The Accept header describes the content types that the response can return. The content-type of the Conversation Analyzer API’s responses is always in JSON format so you must set the accept header to accept JSON. You must also specify the version of the API you are using. For information about specifying the version, see Versioning.

Example application/vnd.newvoicemedia.v2+json


Required To make a request to the Conversation Analyzer API, you must provide your bearer access token in the Authorization header.

You get your bearer access token using your client credentials. For information about getting and using your bearer access token, see How to authenticate with a Vonage Contact Center API (using the new API gateway).

Request body parameters

Currently the Conversation Analyzer API endpoints have only a GET method and therefore do not accept request body parameters.