Below are is the web services service to call up to interact with the bot.
Asking a question
To ask a question (any type of text sent by the customer) to the Bot specify the standard "RFAQ" node in the request and pass the text of the question in the "hda_sematic_question" parameter.
Syntax:
where “brainURL” is the url configured in the bot configuration stored in “botconfigurations” collection in mongoDB
Query string parameters:
Name | Description |
|---|---|
hda_semantic_question | Text that will be passed to the bot to be interpreted |
...
Text Response:
...
| language | json |
|---|
...
Type: JSON
The “node” object must contain the “contents” object. This object must contain the “content” array. This array of objects must contain the text response sent back to the customer. The “contentType” property identifies the content of the text response and can assume one of the following values:
“TEXT_CONTENT_RICH” for formatted text
“READABLE_PLAIN” for only plain text
The “text” property must contain the response sent back to the customer.
In “web” chat, the “TEXT_CONTENT_RICH” response (if present) will be considered, if not present the “READABLE_PLAIN” response will be considered.
In other chat types (whatsapp, messenger, instagram channel), the “READABLE_PLAIN” response will be considered.
| Code Block | ||
|---|---|---|
| ||
{ "node":{ "brain_id":"n_22367", "brain_version":"5.10.0-SNAPSHOT", "id":"n_22367_725744298", "key":"TEST_NODE_MSG", "serviceName":"enghouse-brain-bot", "serviceVersion":"1", "contents":{ "content":[ { "nodebargein":{"true", "brain_id":"nc_22367_3", "brain_version "contentType":"5.10.0-SNAPSHOTTEXT_CONTENT_RICH", "id":"nc_22367_3_72574429841735189", "keyusePreviousText":"TEST_NODE_MSGfalse", "serviceName":"enghouse-brain-bot", "serviceVersiontext":"1", Questo è un contenuto di <b>test</b>." "contents":{ "content":[}, { "bargein":"true", "brain_id":"c_22367_32", "contentType":"TEXTREADABLE_CONTENT_RICHPLAIN", "id":"c_22367_32_417351891418502948", "usePreviousText":"false", "text":"Questo è un contenuto di <b>test</b>*test*." }, { "bargein":"true", "brain_id":"c_22367_2", ] } "contentType":"READABLE_PLAIN", "id":"c_22367_2_1418502948", "usePreviousText":"false", "text":"Questo è un contenuto di *test*." } ] } } } |
...
}
} |
Menu Response:
Type: JSON
The “node” object must contain the “actions” object. This object must conatin the “action” object. The “command” property of this object must be set to “menu” and the “actions” object must contain the “action” array with the menu options.
In the example the menu has 3 child actions, each action has a command : "load-item" or "open-url".
For each menu item are specified : a label ( "content" ) and a target /target url.
“targetUrl”: url to call when the user selects the item. Relative url where the base is stored in the "brainUrl" parameter of the connector configuration saved in the database
“open-url”:( e.g. "https://www.google.com" ) : url to open ( browser/client side) when the user selects the item. Use the array of object “param” in the “param” property to specify the object with the properties “name”: “where” and “text”:”_blank” to indicate where to open the link
| Code Block | ||
|---|---|---|
| ||
{
"node":{
"brain_id":"n_22369",
"brain_version":"5.10.0-SNAPSHOT",
"id":"n_22369_698945808",
"key":"TEST_MENU",
"serviceName":"enghouse-brain-bot",
"serviceVersion":"1",
"contents":{
"content":[
{
"bargein":"true",
"brain_id":"c_22369_3",
"contentType":"TEXT_CONTENT_RICH",
"id":"c_22369_3_1619889357",
"usePreviousText":"false",
"text":"Choose an option"
}
]
},
"actions":{
"action":{
"brain_id":"a_34423",
"command":"menu",
"content":"",
"id":"a_34423_1259541208",
"order":"1",
"runAt":"-1",
"target":"",
"actions":{
"action":[
{
"brain_id":"a_34424",
"command":"load-item",
"content":"OPTION 1",
"id":"a_34424_1211377995",
"order":"1",
"runAt":"-1",
"target":"TEST_M_1",
"node_ref":{
"key":"TEST_M_1",
"targetUrl":"/enghouse-brain-bot/1/TEST_M_1?referrerActionId=34424"
}
},
{
"brain_id":"a_34425",
"command":"load-item",
"content":"OPTION 2",
"id":"a_34425_308197190",
"order":"2",
"runAt":"-1",
"target":"TEST_MENU_2",
"node_ref":{
"key":"TEST_MENU_2",
"targetUrl":"/enghouse-brain-bot/1/TEST_MENU_2?referrerActionId=34425"
}
},
{
"brain_id":"a_34426",
"command":"open-url",
"content":"PAT WEBSITE",
"id":"a_34426_1665019718",
"order":"3",
"runAt":"-1",
"target":"https://www.pat.eu",
"params":{
"param":[
{
"name":"method",
"text":"GET"
},
{
"name":"where",
"text":"_blank"
}
]
}
}
]
},
"params":{
"param":{
"name":"display",
"text":"v"
}
}
}
}
}
} |
Calling a specific node
This service must be called whenever it is specified by a previous response. For example, in the case of a menu, one of the options can specify a node url to be called in the "targetUrl" parameter if the option is chosen by the user.
Syntax:
HTTP GET http://{brain-host}:{port}/brain/autojson/{brain-service}/{node} {brainURL}/targetURL
headers = {
cookie: <BRAINSID_SessionCookie>
};
...
| Code Block | ||
|---|---|---|
| ||
{
"node":{
"brain_id":"n_22370",
"brain_version":"5.10.0-SNAPSHOT",
"id":"n_22370_1287493518",
"key":"TEST_M_1",
"serviceName":"enghouse-brain-bot",
"serviceVersion":"1",
"contents":{
"content":[
{
"bargein":"true",
"brain_id":"c_22370_3",
"contentType":"TEXT_CONTENT_RICH",
"id":"c_22370_3_266538648",
"usePreviousText":"false",
"text":"Option 1 selected"
}
]
}
}
} |
Redirect to operator
The human escalation is triggered by a redirect-to-operator action. It is possible to specify the target queue, the requested service level and skills.
...