How to use the NewVoiceMedia Developer Portal with NewVoiceMedia APIs
If you’re reading this, you’ve found the NewVoiceMedia Developer Portal. (Unless of course someone has printed the guide for you. That’s cheating.)
The NewVoiceMedia Developer Portal contains all you need to use the NewVoiceMedia APIs. Currently NewVoiceMedia has five APIs that you can access through the portal: Authentication, Agent Availability, Conversation Analyzer, Insights Stats and Interactions. More on those later.
This guide aims to help you find what you’re looking for. It doesn’t go into any detail about the APIs or their functions but it will give you a head start in using them.
When you first visit the NewVoiceMedia Developer Portal, you will see the home page. From here you can access documentation for each of the NewVoiceMedia APIs. Click a link in the Get started section to open the API documentation in a new window.
Along the top of the portal and each API’s documentation site is the banner. The banner contains links and a search field that remain visible at all times. Each API documentation site has a different colored banner to help you know where you are!
To get back to the home page for the API you’re looking at or the portal (if you’re in the developer portal) at any time, click the NewVoiceMedia logo in the top-left corner:
If the API you’re looking at has multiple versions, a list of available versions appears alongside the logo. Click to select the version of the API you want to see documentation for.
The Documentation section provides a general overview of each of the APIs.
What is the API for? Who is the API for? What resources are available through the API? What do I need to use the API? What format do I need to provide dates and times in?
The information in each API’s Documentation section applies to most, if not all, of the end points in the API. You can also see some example requests and responses, and find out about what errors you might see and how to avoid them.
Some APIs have an API Reference section. API Reference contains the nitty-gritty of the API documentation; that is, more detailed information about each resource and end point in the API.
Not all APIs have an API Reference section.
Come here to find out about:
The resources are the objects, items, or things that the API returns. The Insights Stats API, for example, returns Agent Activities, Agent Statuses, Agent Summaries, Interactions, Queue Times and Queues. The resources appear in the sidebar:
Under the name of each resource is a list of available methods. An Overview page provides a description of the resource.
Methods and end points
The methods describe actions you can perform using the API on the available resources.
Click a method/end point name to open a page that describes how to make a request including the required/optional parameters, and what to expect in a successful response.
In the developer portal, Guides contains general guides that are not specific to any one API. This guide for example! If an API has any specific guides, the Guides section within the API’s documentation space is where you’ll find them.
Not all APIs have guides.
Guides contain information to guide (!) you when using the API for specific use cases or performing common tasks with the API.
To get to the guides, click Guides in the banner. That link is always there so you can get to the Guides any time you need them.
An Explorer lists all the resources in the API and the methods/end points a little like the reference section. The main difference is that in the Explorer section you can test out API requests before using them for real.
For information about using explorers, see How to use an explorer in the NewVoiceMedia Developer Portal.