.getChatsWithFilter()
This API allows you to programmatically get a list of all chats had by the visitor provided a filter value based on chat status. This API can be used as a source of data to make custom support user interfaces.:
Parameters:
Name | Description |
chatType | Status of chats to be returned |
Chat Properties:
Property | Datatype | Description |
id | String | ID of the chat |
question | String | The question with which the chat was initiated |
attenderName | String | Name of the chat attender |
attenderEmail | String | Email of the chat attender |
attenderID | String | ID of the chat attender |
departmentName | String | Name of the department to which the chat is associated |
feedback | String | Feedback provided for the chat |
lastMessage | String | Last message in the chat |
status | String | The status of the chat |
rating | String | Rating given for the chat |
unreadCount | int | Unread message count for the chat |
isBotAttender | Boolean | Flag to check if the last chat was attended by a bot |
lastMessageSender | String | Name of the last message sender |
lastMessageTime | long | Time of the last message in chat |
ChatType | Description |
CHATTYPE.OPEN | List of all open chats |
CHATTYPE.WAITING | List of all chats that are yet to be picked up by an operator |
CHATTYPE.CONNECTED | List of all connected chats |
CHATTYPE.ENDED | List of all ended chats |
CHATTYPE.CLOSED | List of all closed chats |
CHATTYPE.MISSED | List of all missed chats |
Callbacks:
Name | Description |
error | Error is returned if an error occurs while using the API. The list of possible error codes returned by the API is listed below. |
chats | List of chats |
Error Codes:
Code | Message |
500 | mobilisten not initialized |
605 | mobilisten disabled |
604 | invalid filter type |
600 | no network connection |
609 | salesiq API exception |