Voice

VirtualAgent

Deprecated
View as Markdown
Deprecated Notice

Dialogflow application creation and management through the SignalWire Compatibility API is deprecated. Only existing Dialog applications will continue to function; new Dialog applications can no longer be created.

<Connect> verb’s <VirtualAgent> noun permits connecting the call to a Dialogflow agent.

For example, one can connect to Dialogflow with:

1<?xml version="1.0" encoding="UTF-8"?>
2<Response>
3  <Connect action="https://example.com/next-xml-instructions" >
4    <VirtualAgent connectorName="my-agent" />
5  </Connect>
6</Response>

Noun attributes

connectorName
stringRequired

The Google Project ID of the agent to use. Find a list of IDs in the Dialogflow page in the UI.

After a Dialogflow conversation is completed, SignalWire can make a request to the <Connect> verb’s action attribute. In addition to the Standard Request Parameters, the following are parameters passed back to your application when SignalWire makes the request.

VirtualAgentError
string

An error message, in case VirtualAgentStatus is "failed".

VirtualAgentErrorCode
string

An error code, in case VirtualAgentStatus is "failed".

VirtualAgentProvider
string

The provider of the VirtualAgent (e.g., Dialogflow)

VirtualAgentProviderData
string

A JSON object (serialized as a string) containing data about the Dialogflow interaction.

VirtualAgentStatus
string

E.g. failed or transfer