For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
cXMLREST API
cXMLREST API
  • Core
    • Compatibility API
    • cXML Specification
  • Guides
    • Compatibility API Webhooks
    • Receive SMS
    • Send SMS
    • Inbound Fax Callback
    • Add mustache template parameters to cXML responses
    • Gathering user input
  • Voice
    • Overview
    • Conference
    • Connect
    • Denoise
    • Dial
    • Echo
    • Enqueue
    • Gather
    • Hangup
    • Leave
    • Number
    • Pause
    • Pay
    • Play
    • Queue
    • Record
    • Redirect
    • Refer
    • Reject
    • Room
    • Say
    • Sip
    • Sms
    • Stream
    • Verto
    • VirtualAgent
  • Messaging
    • Overview
    • Message
    • Redirect
  • Fax
    • Overview
    • Receive
    • Reject
LogoLogoSignalWire Docs
Log inSign up
Support
On this page
  • Noun attributes
Voice

VirtualAgent

Deprecated
|View as Markdown|Open in Claude|
Was this page helpful?
Edit this page
Previous

Messaging Overview

Next
Built with
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

*Twilio and TwiML are trademarks of Twilio, Inc. SignalWire, Inc. and its products are not affiliated with or endorsed by Twilio, Inc.