...
Each bot is configured through an object with the following properties:
...
Property
...
Type
...
Description
...
Notes
...
Localizable
...
_id
...
| Status | ||
|---|---|---|
|
...
Unique bot identifier
...
technology
...
| Status | ||
|---|---|---|
|
...
Technology used by the bot
...
It can take on one of the following values:
“DF” Dialogflow
“PAT”
...
nickname
...
| Status | ||
|---|---|---|
|
...
Virtual agent nickname shown by the chat interface when a reply message is received from the bot
...
...
configuration
...
| Status | ||
|---|---|---|
|
...
String in JOSN format containing the bot configuration parameters
...
It varies based on the bot technology
...
inactivityTimeoutInSeconds
...
| Status | ||
|---|---|---|
|
...
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 | ||
|---|---|---|
|
| Status | ||
|---|---|---|
|
...
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
properties described here Bot Configuration Object
Example
| Code Block | ||
|---|---|---|
| ||
{
"_id" : "BOT1",
"technology" : "DF",
"nickname" : "Bot 1",
"configuration" : "{\"type\":\"service_account\",\"project_id\":\"bot1-dfc4a\",\"private_key_id\":\"6bf906784139d3d34e6cd6d78e06acae942535bb6bf906784139...\",\"private_key\":\"-----BEGIN PRIVATE KEY-----\\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDbiCNAeWL2Lf3l\\n88FQAIc3xZqLs9PytcMsTKiZLPJh8DKZ/kVZS25K464ZVvpYozR0zV7vYhEbMCbd\\nc+du8t2XU4C/qfMFfKgEZKxGav7iCmrLECNKgu9TH27G21r4SYxi3wEJGQWwNdUG\\nyLHVzvZ5tmFQchFXTJ7ho74MmMJnhicMfjB2Rtta2A8zX15hnHl9NLShA0pXI0aN\\nxGfxcZrNdqyg7sL9DUG8vQFANCVFIPImRj1ysS8CqpjWHDkqhonU6S2Q4jg738SE\\nFNer7ANElBJc5mQ1M3MOeTFZsvpuu+pgo9PMD31GVYtfqjXnId1CECKc0ABmU4XK\\nePXntZTBAgMBAAECggEAF7DLcBbhZHRuYsFBNmlWLkE5djPF7rppeWd85snMTuAh\\nT8+6K2KZ4IRNOpARtFzJaYTrpqzoMG1L9mg+fJFCM0VIPrbAAnKzPYUhN7iucJWD\\n9I21Z0I1wjxBQ72yhZqHRziuV41fGSbYCjNAiLSc0eHqAsjKgQekWjCFzv1xtkLX\\nTd5TZDNbbKvp8JlnY8zxC+5tKjqEQd7D8ake/Yz1qFLqzKna/3NvveItTGYlHMcK\\ni4NgVXB02tZ9QKIjesVJi743mq06U4KB1FUEoedG5czYESO2hwEJ7eVeKERovVc0\\nOAQUD2TWjJta+znzUWeR6PyhAKANA7N0ClnJQBAHqQKBgQD4LbpCaQ6EvrlwLofI\\nx43n/rDa5N3gAi+5TRaNCxQeZ4XF0J7MfAUA2Erxzdb1uF0DjXOhQ3usH8CBfz6G\\nXtS4qexDoFHnKMZRMim0hufaSSsFc3J0FxhwKei3/cCm6vHQ/GkLMtKcktlP5NHL\\n6GUJKxGWRIOe2EGmyQD1erGIWQKBgQDic0qOTfxlUq1HfTizqSFNJ2z09EI/Nia6\\nTFY3W/1dqBM4m3xrt63EY7/a5Q1iVlnV4aGzHhKewIhh9uN8YrQ+kFEi+OGwFo7I\\n78jQiVOQ17FudsLUBCZVmekWXAoI/m6aqWoPEirNx/HVcjSsrO54drLAcQmGPHgO\\nWYUn2sTiqQKBgQCRG7OPRvv9M8MbS6mLBNr9LdbcdfshEkYzM1afKz4dNOxrqDph\\nV5ZZUx4m2fL5A04nWJqmTN3P21TkorC9Qk9glcIWHHQnE5k5OnpWGpcP874a1tCx\\n/hsE4gw3IEB3mGHBjwQgTxwD/nzfkOv2LLB+ttb2pKLMyqdATMCpx45sKQKBgQDE\\nadOlEqd1Cv0ZINfpnS0xSp0K6kH7qfB1bnjpk3Rzo7DoTJTiqXKjARILvtiZDuTk\\nyswCHHdyEvU4Y3h1DvffvDVj7BN1NFusla7MkhBVdYCEm6XpV6AYZ2Lw7ewWWPl+\\nVKuVXuCZlG+B/4kIrQY6nln06RalxBUt/R+tredP4QKBgH2TmQQ6hjmdAXb2cT5/\\nrT5nLVE3gPbAmf561v7hKOSXVqjIwxjXBFkHngSCD/Njizk0w8GAGguvras/nQ4d\\naSTzBqprJKzAc2PwjzXt5ELAmLe27tA8gMlF7hCPnxG53Swf6OxjPWQrHbVQAioP\\nI5Jtqi4NMA3nsbxXkVT0lp3P\\n-----END PRIVATE KEY-----\\n\",\"client_email\":\"nuovoserviziobot@bot1-dfc4a.iam.gserviceaccount.com\",\"client_id\":\"116835411680007641352\",\"auth_uri\":\"https://accounts.google.com/o/oauth2/auth\",\"token_uri\":\"https://oauth2.googleapis.com/token\",\"auth_provider_x509_cert_url\":\"https://www.googleapis.com/oauth2/v1/certs\",\"client_x509_cert_url\":\"https://www.googleapis.com/robot/v1/metadata/x509/nuovoserviziobot%40bot1-dfc4a.iam.gserviceaccount.comnMIIEvgIBADANBgkqhkiG9w...\"}",
"inactivityTimeoutInSeconds" : 300,
"welcomeMessage" : {
"it-it" : "L'operatore virtuale è entrato in chat",
"en-gb" : "Virtual agent is online",
"default" : "L'operatore virtuale è entrato in chat"
}
} |