Supported activities and events
Activities
- GetAvailableOperators
- GetAvailableGroups
- Forward
- GetCallParams
- SetCallParams
- SendGuestOfflineEmail
- ChatbotOpenFileUploadPrompt
- GetGuestIdentity
- EnableGuestUpload
- DisableGuestUpload
- Text
- GetHeroCards
- SendHeroCard
Events
GetAvailableOperators
Acquires a list of registered operators. Returns only operators from the groups defined in routing, which meet the routing conditions.
Supported mluvii channels: chat, facebook, whatsapp
Request JSON:
{
"activity": "GetAvailableOperators"
}
Response:
{
"activity": "GetAvailableOperatorsResponse",
"availableOperators": [
{
"displayName":"Katka",
"userId":1
},
{
"displayName":"Tomáš",
"userId":2
}
]
}
GetAvailableGroups
Acquires a list of created groups. Returns only groups defined in routing, which meet the routing conditions.
Supported mluvii channels: chat, facebook, whatsapp
Request JSON:
{
"activity": "GetAvailableGroups"
}
Response:
{
"aActivity": "GetAvailableGroupsResponse",
"availableGroups": [
{
"displayName":"Group one",
"groupId":1
},
{
"displayName":"Group two",
"groupId":2
}
]
}
Forward
Redirects interaction for a live operator. If neither the target operator nor the group is defined, the group is automatically selected according to the settings of routing commands.
Supported mluvii channels: chat, facebook, whatsapp
Request JSON:
{
"activity": "Forward",
"operatorGroupId": <integer:optional>,
"userId": <integer:optional>
}
GetCallParams
Acquires CallParams associated with an active session.
Supported mluvii channels: chat, facebook, whatsapp
Request JSON:
{
"activity": "GetCallParams"
}
Response:
{
"activity": "GetCallParamsResponse",
"callParams": <dictionary>
}
SetCallParams
Set CallParams to active session.
Supported mluvii channels: chat, facebook, whatsapp
Request JSON:
{
"activity": "SetCallParams",
"callParams": <dictionary>
}
Response:
{
"activity": "SetCallParamsResponse",
"success": <boolean>,
"errorMessage": <string>
}
SendGuestOfflineEmail
Sends an email to an address for messages from an offline form.
Supported mluvii channels: chat
Request JSON:
{
"activity": "SendGuestOfflineEmail",
"subject": <string>,
"message": <string>,
"location": <string> (message source for resolution, e.g.: "Chatbot Mluviik")
}
ChatbotOpenFileUploadPrompt
Opens a dialog box to allow the user to upload the file.
Supported mluvii channels: chat
Request JSON:
{
"activity": "ChatbotOpenFileUploadPrompt"
}
Response:
{
"activity": "ChatbotOpenFileUploadPromptResponse",
"fileUrl": <string>, (file URL uploaded by guest)
}
GetGuestIdentity
Gets properties from customer identity.
Supported mluvii channels: chat, facebook, whatsapp
Request JSON:
{
"activity": "GetGuestIdentity"
}
Response:
{
"activity": "GetGuestIdentityResponse",
"trackedGuestGuid": <Guid>, (uniq identifier from cookie)
"phoneCallerId": <string>, (phone number)
"facebookPSID": <string>, (facebook identifier)
"facebookPageId": <string>, (facebook page identifier)
"whatsAppContactId": <string>, (whatsapp identifier)
"vkContactId": <string>, (vk identifier)
}
EnableGuestUpload
Enable functions that allow user file upload.
Supported mluvii channels: chat
Request JSON:
{
"activity": "EnableGuestUpload"
}
Response:
{
"activity": "EnableGuestUploadResponse",
"success": <boolean>,
"errorMessage": <string>
}
DisableGuestUpload
Disable functions that allow user file upload.
Supported mluvii channels: chat
Request JSON:
{
"activity": "DisableGuestUpload"
}
Response:
{
"activity": "DisableGuestUploadResponse",
"success": <boolean>,
"errorMessage": <string>
}
GuestFileUpload
If client loads file through pin in chat input, Activity in this format will be send to chatbot.
Supported mluvii channels: chat
Response:
{
"activity": "GuestFileUpload",
"fileUrl": <string>, (URL of file loaded by user)
}
Text
Send text.
This activity is supported only in chatbot API
Supported mluvii channels: chat, facebook, whatsapp
Request JSON:
{
"type": "message",
"timestamp": "2020-09-09T10:03:53.4976861+02:00",
"text": "Sample text"
}
This activity also behaves as an event when the client writes something and sends it to chat.
Response:
{
"activity": "Text",
"text": "Hello world"
}
GetHeroCards
Returns available Hero cards.
Supported mluvii channels: chat
Request JSON:
{
"activity": "GetHeroCards"
}
Response:
{
"activity": "GetHeroCardsResponse",
"heroCards": [
{
"displayName":"Hero card one",
"heroCardId":1
},
{
"displayName":"Hero card two",
"heroCardId":2
}
]
}
SendHeroCard
Send selected hero card to client chat.
Supported mluvii channels: chat
Request JSON:
{
"activity": "SendHeroCard",
"heroCardId": <integer:required>
}
Response:
{
"activity": "SendHeroCardResponse",
"success": <boolean>,
"errorMessage": <string>
}
Examples of general activities
Text
Send a text message
Supported mluvii channels: chat, facebook, whatsapp
Request JSON:
{
"type": "message",
"timestamp": "2020-09-09T10:03:53.4976861+02:00",
"text": "Sample text"
}
Buttons
Buttons can be sent using adaptive cards.
Supported mluvii channels: chat
Request JSON:
{
"type": "message",
"timestamp": "pátek 12. června 2020",
"attachments": [
{
"contentType": "application/vnd.microsoft.card.hero",
"content": {
"title": "Test buttons",
"buttons": [
{
"type": "imBack",
"title": "Button 1",
"value": "Button 1"
},
{
"type": "imBack",
"title": "Button 2",
"value": "Button 2"
}
]
}
}
]
}
AdaptiveCards
Api supports message formatting according to the standard https://adaptivecards.io.
Supported mluvii channels: chat
Example of using an adaptive card carousel.
{
"type": "message",
"timestamp": "2020-06-12T12:13:39.7593384+02:00",
"attachmentLayout": "carousel",
"attachments": [
{
"contentType": "application/vnd.microsoft.card.hero",
"content": {
"subtitle": "1. Street Foo 254 Czechia",
"images": [
{
"url": "https://dev.virtualearth.net/REST/V1/Imagery/Map/Road?form=BTCTRL&mapArea=49.7463607788086,13.1083498001099,49.7932815551758,13.1951398849487&mapSize=500,280&pp=49.7616882324219,13.1491804122925;1;1&dpi=1&logo=always&key=ApBn8xoItlENbFx-rr1kzt_JakWdFTH24taCasYxQCgit15NtDeYrztO4chDtrg5"
}
],
"buttons": [
{
"type": "imBack",
"title": "Street Foo 254",
"value": 1
}
]
}
},
{
"contentType": "application/vnd.microsoft.card.hero",
"content": {
"subtitle": "1. Úlice, Plzeň, Czechia",
"images": [
{
"url": "https://dev.virtualearth.net/REST/V1/Imagery/Map/Road?form=BTCTRL&mapArea=49.7463607788086,13.1083498001099,49.7932815551758,13.1951398849487&mapSize=500,280&pp=49.7616882324219,13.1491804122925;1;1&dpi=1&logo=always&key=ApBn8xoItlENbFx-rr1kzt_JakWdFTH24taCasYxQCgit15NtDeYrztO4chDtrg5"
}
],
"buttons": [
{
"type": "imBack",
"title": "Úlice, Plzeň, Czechia",
"value": 1
}
]
}
},
{
"contentType": "application/vnd.microsoft.card.hero",
"content": {
"subtitle": "1. Úlice, Plzeň, Czechia",
"images": [
{
"url": "https://dev.virtualearth.net/REST/V1/Imagery/Map/Road?form=BTCTRL&mapArea=49.7463607788086,13.1083498001099,49.7932815551758,13.1951398849487&mapSize=500,280&pp=49.7616882324219,13.1491804122925;1;1&dpi=1&logo=always&key=ApBn8xoItlENbFx-rr1kzt_JakWdFTH24taCasYxQCgit15NtDeYrztO4chDtrg5"
}
],
"buttons": [
{
"type": "imBack",
"title": "Úlice, Plzeň, Czechia",
"value": 1
}
]
}
}
]
}