2. Getting Started

After reading through this guide, check out the API Reference within the Explorer section to see all available API requests, and use the Explorer to test calls in real-time with your own data.

To start using the Vonage Contact Center Conversation Analyzer API you must have completed the following tasks:

  • Sign up for a Vonage Contact Center account. Find more information about how to do this at Vonage Cloud Contact Center.
  • Set up a working interaction plan in which interactions are delivered to your agents through an Automatic Call Distributor or Universal Contact Distributor. For information about setting up interactions plans and using Vonage Contact Center to make and receive interactions, go to Vonage Contact Center Product Documentation.
  • Get your client credentials from Vonage Contact Center, adding the View Conversation Analyzer transcripts, metadata and insights scope.
  • Use your client credentials to get your bearer access token. You must use your bearer access token to send API requests. The Authentication section contains information about getting your bearer access token.

The root URL for the Conversation Analyzer API is https://***.api.newvoicemedia.com/conversation-analyzer, where *** represents a regional subdomain. URLs in the example code use *** in place of the region. To access the API for your region, replace *** with the correct subdomain for your region.

Region URL subdomain Base URL
EMEA emea https://emea.api.newvoicemedia.com
USA nam https://nam.api.newvoicemedia.com
APAC apac https://apac.api.newvoicemedia.com

Add the resource name to the URL to form the endpoint you need to access the resource and its fields. For example, https://***.api.newvoicemedia.com/conversation-analyzer/interactions provides access to the interactions resource and its fields.