Types of event
event — reaction to an event occurring in a channel, account or project.
Common events
| event | Description |
|---|---|
tariffBlocked |
account blocking |
sessionDataSoftLimitExceededᅠᅠᅠᅠᅠᅠ |
the soft limit of saving data to the object $session is reached |
clientDataSoftLimitExceeded |
the soft limit of saving data to the object $client is reached |
sessionDataHardLimitExceeded |
the hard limit of saving data in the object $session is reached |
clientDataHardLimitExceeded |
the hard limit of saving data in the object $client is reached |
STS classifier events
| event | Description |
|---|---|
match ᅠᅠᅠᅠᅠ |
sent text is detected |
noMatch |
sent text is unrecognized |
timeLimit |
request processing time limit is exceeded |
lengthLimitᅠᅠᅠᅠᅠᅠᅠᅠᅠᅠᅠᅠ |
limit on the number of characters is exceeded ᅠᅠᅠᅠᅠᅠᅠᅠᅠᅠ |
Channels events
Learn more about fileEvent as a unified event format when sending messages with attached data
| Channel | event | Description |
|---|---|---|
| Chat widget | fileEvent |
customer sent a file |
| Telegram | telegramSendContact |
customer sent a contact |
telegramSendLocation |
customer sent a location | |
telegramApiRequestFailed |
file failed to upload | |
fileTooBigEvent |
sent file size more than 50 Mbytes | |
telegramAnyMessage |
could not identify the type of message | |
telegramCallbackQuery |
click on the button with callback_data |
|
fileEvent |
customer sent a file | |
telegramAnyRequest |
the request did not fall into any other event |
|
| VK | fileEvent |
customer sent a file |
| Viber | viberSendLocation |
customer sent a location |
fileEvent |
customer sent a file | |
fileTooBigEvent |
sent file size more than 50 Mbytes | |
facebookSendLocation |
customer sent a location | |
fileEvent |
customer sent a file | |
fileTooBigEvent |
sent file size more than 50 Mbytes | |
rawRequestEvent |
the request did not fall into any other event, no text in the message |
|
fileEvent |
customer sent a file | |
fileTooBigEvent |
sent file size more than 50 Mbytes | |
weChatSendLocation |
customer sent a location | |
weChatAnyMessage |
could not identify the type of message | |
| Webim | fileEvent |
customer sent a file |
| Microsoft Teams | fileEvent |
customer sent a file |
fileTooBigEvent |
sent file size more than 50 Mbytes | |
| Vonage WhatsApp | fileEvent |
customer sent a file |
fileTooBigEvent |
sent file size more than 50 Mbytes | |
| edna.chatCenter | fileEvent |
customer has sent a message with attached data |
fileTooBigEvent |
sent file size more than 50 Mbytes | |
| i-Digital: WhatsApp | fileEvent |
customer has sent a message with attached data |
fileTooBigEvent |
sent file size more than 50 Mbytes | |
| MFMS: WhatsApp | fileEvent |
customer has sent a message with attached data |
locationEvent |
customer sent a location | |
fileTooBigEvent |
sent file size more than 50 Mbytes | |
| Bitrix24 | ONAPPINSTALL |
application installation |
ONAPPUPDATE |
application update | |
ONIMBOTMESSAGEADD |
chatbot got a message | |
ONIMBOTMESSAGEUPDATE |
chatbot update message | |
ONIMBOTMESSAGEDELETE |
chatbot deleted messages | |
ONIMCOMMANDADD |
chatbot got the task | |
ONIMJOINCHAT |
chatbot has been informed about its inclusion in a chat or personal messages | |
ONIMBOTDELETE |
chatbot has been removed | |
CRM_SUCCESS_EVENT |
CRM event Bitrix24 has been updated | |
CRM_FAILED_EVENT |
CRM event Bitrix24 not updated | |
| Telephony | speechNotRecognized |
customer's request cannot be recognized within 5 seconds or nothing has come up |
hangup |
customer hung up | |
botHangup |
conversation is over at the chatbot's request | |
noDtmfAnswerEvent |
caller has not entered the DTMF message (tone dialling) | |
| Operator channels | livechatFinished |
dialogue with the operator is over |
noLivechatOperatorsOnline |
no operators online |
Note that for the Vonage WhatsApp channel, when not a text message arrives, event with the type name (e.g. event: audio) is sent to the script. In this case eventData receives all incoming request from Vonage WhatsApp.