Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The GET /interactionPlans endpoint gets a list of all interaction plans within the VCC account.

...

Type

Required

Example

integerFalse25

The required number of items per page. Minimum of 1. Maximum of 5000. Default is 25.

page

Type

Required

Example

integerFalse1

The required page. Minimum of 1, maximum of 1000000000. Default is 1.

Requests

Request all interaction plans

...

Code Block
languagepowershell
themeMidnight
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

Code Block
languagejs
themeMidnight
{
  "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.

Insert excerpt
_ExcerptRunInPostman
_ExcerptRunInPostman
nopaneltrue