getEngagedChats()

Returns the chat keys of the chats in which the agent is currently engaged. Available in API version 29.0 or later.

NameTypeDescription
callbackfunctionJavaScript method called upon completion of the method.

This method is asynchronous so it returns its response in an object in a callback method. The response object contains the following properties:

NameTypeDescription
chatKeyarrayArray of chatKey values, one for each of the currently engaged chats.
successbooleantrue if getting engaged chats was successful; false if getting engaged chats wasn’t successful.