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 /{userId}/presence endpoint, you must replace {userId} with the real value to retrieve the specific user’s presence data.
Path parameters are required.
Query parameters
Query parameters are described for each request individually.
Header parameters
All Agents API requests require the following header parameters:
accept
Required. The Accept header describes the content types that the response can return. The content-type of the Agents 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 (Agents API).
Example application/vnd.newvoicemedia.v1+json
authorization
Required. To make a request to the Agents 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 Requesting your bearer access token in How to authenticate with a Vonage Contact Center (VCC) API.