Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Each bot is configured through an object with the following properties:

...

Property

...

Type

...

Description

...

Notes

...

Localizable

...

_id

...

Status
titlestring

...

Unique bot identifier

...

technology

...

Status
titlestring

...

Technology used by the bot

...

It can take on one of the following values:

...

nickname

...

Status
titlestring

...

Virtual agent nickname shown by the chat interface when a reply message is received from the bot

...

...

configuration

...

Status
titlestring

...

String in JOSN format containing the bot configuration parameters

...

It varies based on the bot technology

...

inactivityTimeoutInSeconds

...

Status
titlenumber

...

Number of seconds to wait for a message from the customer to the bot after which the chat is automatically ended

...

If not configured, the default value is 300 seconds.

...

welcomeMessage

...

Status
titlestring
/
Status
titleobject

...

Message shown in chat when a bot enters the room

...

Can be localized.

Accepts a string representing the label to be displayed or an object whose key is the country code and whose value is the relative label to be displayed.
Example:
{
"it-it" : "L’operatore virtaule è entrato in chat",
"en-gb" : "Virtual agent is online"
}

...

X

Example

properties described here Bot Configuration Object

Example

Code Block
languagejson
{
    "_id" : "BOT1",
    "technology" : "DF",
    "nickname" : "Bot 1",
    "configuration" : "{\"type\":\"service_account\",\"project_id\":\"bot1-dfc4a\",\"private_key_id\":\"6bf906784139d3d34e6cd6d78e06acae942535bb6bf906784139...\",\"private_key\":\"-----BEGIN PRIVATE KEY-----\\nMIIEvgIBADANBgkqhkiG9w...\"}",
    "inactivityTimeoutInSeconds" : 300,
    "welcomeMessage" : {
        "it-it" : "L'operatore virtuale è entrato in chat",
        "en-gb" : "Virtual agent is online",
        "default" : "L'operatore virtuale è entrato in chat"
    }
}