Voice API applet
Overview
Vonage AI Studio's Voice API uses artificial intelligence (AI) to interpret a contact's request. It can then ask clarifying questions to formulate an appropriate response. That response may, for example, reference content from an FAQ, propose an action to update or read the contact's data, or route the interaction to a real agent using an appropriate interaction plan.
The Voice API applet routes interactions to virtual agents within Vonage's AI Studio's Voice API.
For information about using the Voice API applet, see Setting up routing interactions to Vonage AI Studio's Voice API.
Set up your connection to Vonage AI Studio’s Voice API
Provide virtual agent credentials to connect your VCC account to a virtual agent in Voice API.
Field | Options | Description |
|---|---|---|
Interaction type | Call or Chat | Select the type of interaction that the virtual agent works with. |
API key | Text | Your API key for Vonage AI API. You should have generated and saved the API key. |
ID | Text | The ID of the virtual agent in Voice API. You should have created a virtual agent and saved its ID. |
Number | Text | The number for the virtual agent that will handle the interaction. You should have created a virtual agent and saved its number. Number is only available if Interaction type is Call. |
Region | EU or US | The region is defined in AI Studio while creating a virtual agent. The value is set automatically using data from AI Studio when connection details are verified. |
Send VCC data to Voice API
Define which VCC data source values to send to the virtual agent in Voice API. Map these data sources to Voice API parameters that will use the data.
Field | Options | Description |
|---|---|---|
VCC data source | Data source | Name of the VCC data source whose data you want to send to the virtual agent in Voice API. Identify data sources using the $(DataSourceName) format, for example, $(name). |
Voice API parameter | List of Voice API parameters | The list of parameters defined in Voice API in AI Studio. Select a Voice API parameter that will receive the corresponding data source value. For example, CALLER_PHONE_NUMBER. |
Get data from Voice API
Add Voice API parameters containing data collected by the virtual agent in Voice API. Map the parameters to VCC data sources that will use the data.
Field | Options | Description |
|---|---|---|
Voice API parameter | List of Voice API parameters | The list of parameters defined in Voice API in AI Studio. Select a Voice API parameter that will contain data to set in the corresponding VCC data source. For example, CALLER_PHONE_NUMBER. Parameters with more than one value are not supported. |
VCC data source | Data source | Name of the VCC data source you want to receive Voice API parameter data from the virtual agent in Voice API. Identify data sources using the $(DataSourceName) format, for example, $(name). |
Routing
Choose where interactions should go next, on either success or failure.
Field | Options | Description |
|---|---|---|
Next Applet | List of available applets | Select the applet that the interaction is routed to when interaction with the virtual agent is completed. |
Next Applet On Failure | List of available applets | Select the applet that the interaction is routed to if it cannot be transferred to the virtual agent. |