VA Sync

Prev Next

Integration node for Virtual Agent (VA) Sync in-parts API.

Parameters

name
description
default
Address Address of VA Orchestrator Service http://cai-magpie-api/magpie/ext-api/messages/synchronized
IgnoreSslErrors Ignore any certificate errors if address contains "https" false
Credential OAuth 2.0 Credential for reaching VA Sync API. None
Project Name The name of the project defined in VA interface. None

Inputs

Audio

 none

Events

name description possible nodes this event may be received from
Any event that has Data.Text Any Text based event such as: SR Milestone, SR Partial etc. SR Http, SR Websocket, Translate etc.
VA Activity Object If the user wants to send structural information that does not quite fit "Text" field. Entry, External Relay, Custom Nodes

Outputs

Audio

 none

Events

name description
VA External Contains an ActivityObject field that contains the VA Activity Response, and a Text field for compatibility with all other nodes.

Remarks

Requirements

"StartMessage" requirements

"StartMessage" can contain

  • "CallProperties.ExternalId": If this is provided, data flow will send this value for the external conversation id to VA.
{
    "CallProperties": 
    {
      "ExternalId":"ConversationId"
    },
}

Project Structure

A simple VA Project that takes audio user input, and returns the responses can be built as such:
Image

After this, any node that manipulates or uses the Data.Text field can be utilized freely.

Image

Supported flow types

Batch, Stream

Release Notes

v4.6.0
  • Introduced Node.