Receiving Data from VCC (Chatbot)
Use these instructions to send data from the Engagement Workflow IVR to a Studio IVA chatbot task.
IVR Data
The IVR data is in one or more IVR script variables. For each script variable, fill in the fields as follows.
|
Field |
Description |
|---|---|
|
Name |
Name the variable containing the data to send. For example, enter <IVRDataToSend>. |
|
Type |
Select type STRING. |
|
Input Variable |
Select this option. |
IVR Set Variable Module (PUT)
Add a set variable module to the IVR script. Create these IVR script variables if you have not already done so. The IVR set variable module uses these script variables to send data to Studio.
|
Variable |
Type |
Description |
|---|---|---|
|
putResult |
String |
Prepares the information the IVR sends to Studio. |
|
toStudio |
KVLIST |
Sends the data to Studio. |
Fill in the set variable module properties as follows.
-
Open the Set Variable Module in your IVR script.
-
Click Add.
The Assignment dialog opens.
-
In the Variable field, select the variable (example putResult) to prepare the information the IVR sends to Studio.
-
For the Assigned Value, select Function and PUT(KVLIST, STRING, STRING).
-
Supply Function Arguments as follows.
Number
Type
Value
#1
Variable
The name of the KVLIST the IVR sends to Studio.
For example, enter toStudio.
#2
Constant
The name of the variable in the JSON payload received by Studio.
For example, enter <VariableInJSONPayload>.
#3
Variable
The value of the variable in the JSON payload received by Studio.
Enter the name of the IVR script variable. For example, enter <IVRDataToSend>.
Data in Studio
Studio receives the data in a JSON payload.
Access the data in start.response or the sys.MESSAGE_JSON system variable. For more information on how to do this, see Evaluating JSON Objects and Arrays.
If you supply sample data on the start node, the schema is available to the expression builder when evaluating start.response. See Start.
{
"<VariableInJSONPayload>": ""
}
Use Cases
|
Use Case |
Description |
||||||||
|---|---|---|---|---|---|---|---|---|---|
|
Send to Studio the language the user selected in Web Messenger |
When a customer selects a language in Web Messenger, their selection is automatically saved to the TranslationSourceLanguageCode IVR script variable. Create an IVR script variable with this name. Fill in the IVR script variable fields as follows. Use the above instructions to pass this IVR script variable to the Studio IVA.
|