Get all interaction plans
The GET /interactionPlans endpoint gets a list of all interaction plans within the VCC account.
In this page
Most URLs in the example code use the following values:
- ***. 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 - <ACCESS_TOKEN>. The value represents a bearer access token which you must use to validate every request. Replace <ACCESS_TOKEN> where used with your bearer access token. For information about getting a bearer access token, see How to authenticate with a Vonage Contact Center (VCC) API.
Headers
Header parameters in Requests (User Admin API) apply to this endpoint.
Authorization scopes supported:
| Scope | Access granted |
|---|---|
users:read | Entire endpoint |
users:write | Entire endpoint |
Parameters
The endpoint accepts the following query parameters:
limit
Type | Required | Example |
|---|---|---|
| integer | False | 25 |
The required number of items per page. Minimum of 1. Maximum of 5000. Default is 25.
page
Type | Required | Example |
|---|---|---|
| integer | False | 1 |
The required page. Minimum of 1, maximum of 1000000000. Default is 1.
Requests
Request all interaction plans
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/interactionPlans" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>"
Request second page of interaction plans
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/interactionPlans?page=2" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>"
Responses
Responses contain a list of all interaction plans within the VCC account.
Successful response
Successful requests return a 200 Success code and a collection of interaction plans.
Example response
{
"meta": {
"page": 1,
"count": 2,
"pageCount": 1,
"totalCount": 2
},
"interactionPlans": [
{
"interactionPlanId": "b934d01c-8ea6-44b0-af12-ca289bd6eb32",
"interactionPlanName": "interaction plan 1"
},
{
"interactionPlanId": "4f6d9417-1c75-41f7-b9b7-cad3357be478",
"interactionPlanName": "interaction plan 2"
}
]
}
where:
interactionPlans. A collection of interaction plans.interactionPlanId. The unique ID of the interaction plan.interactionPlanName. The user-friendly name of the interaction plan.
Try it out
For information, see Trying out Vonage Contact Center APIs.