onNewMessage()

Registers a function to call when a new message is sent from a customer, agent, or supervisor. Available in API version 29.0 or later.

Syntax

1sforce.console.chat.onNewMessage(chatKey:String, callback:Function)

Arguments

Name	Type	Description
`chatKey`	string	The `chatKey` associated with the chat for which to call a function when a new customer message is received.
`callback`	function	JavaScript method called upon completion of the method.

Sample Code–Visualforce

1<apex:page >
2    <apex:includeScript value="/support/console/68.0/integration.js"/>
3    <script type="text/javascript">
4        var eventHandler = function (result) {
5            alert('There is a new message in this chat: ' + result.content);
6        }
7        //Get the value for 'myChatKey'from the sforce.console.chat.getDetailsByPrimaryTabId() or other chat methods. 
8        //These values are for example purposes only
9        var chatKey = 'myChatKey';
10        sforce.console.chat.onNewMessage(chatKey, eventHandler);
11    </script>
12</apex:page>

Response

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

Name	Type	Description
`content`	String	The text of a message in the chat log.
`name`	String	The name of the user who sent the message. This appears exactly as it is displayed in the chat log.
`type`	String	The type of message that was received, such as an Agent or Visitor message.
`timestamp`	Date/Time	The date and time the message was received.
`success`	Boolean	`true` if firing event was successful; `false` if firing event wasn’t successful.