Actions (Interactions API)

Owned by Helen Griffith
Last updated: Feb 15, 2022
2 min read

The Interactions API contains two actions: Invoke and Register.

Invoke

The Invoke action enables you to invoke interaction flows through one or more named routes within Vonage Contact Center (VCC). You can invoke an interaction flow through any interaction plan that you have configured in VCC’s Interaction Architect. Depending on the configuration of your interaction plan, you can perform a wide variety of tasks, such as:

  • Deliver the interaction to an agent
  • Send an SMS message using parameters passed within the request body
  • Send an email using data within VCC
  • Update a record in a third-party system

You can also use the Invoke action to release existing interactions.

You can perform one or more of these tasks within a single request to the POST /Invoke endpoint.

Register

The Register action enables you to register a provider. Registering a provider serves two functions:

  • To enable VCC to call the API associated with the registered provider. VCC can call the API at various points in the lifecycle of an associated interaction or interactions, previously routed using the Invoke action.
  • To permit or restrict agent actions on an associated interaction or interactions, previously routed using the Invoke action.

When you register the provider, you must define a name for the provider for future reference and permitted agent actions. You can optionally define the URL for an API endpoint and headers required by that endpoint. If you do not define an endpoint for the provider, the provider has no associated API. Registering the provider is used in this case only to permit or restrict agent actions.

You only need to register the provider once for each provider. If you register the provider multiple times the last settings are used.