Newer Version Available

This content describes an older version of this product. View Latest

lightning:conversationNewMessage

Messaging event triggered when the customer, agent, or supervisor sends a new message. This event is also triggered when using Enhanced Messaging channels.

Response

Name Type Description
recordId String The ID of the work record that’s associated with the current conversation.
content String The message sent by the agent.
name String The name of the user who sent the message. This name matches the username displayed in the conversation 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.

Example

Component code:

1<aura:component implements="flexipage:availableForAllPageTypes" access="global" description="Conversation toolkit api sample">
2  <lightning:conversationToolkitAPI aura:id="conversationKit" />
3  <aura:handler event="lightning:conversationNewMessage" action="{!c.onNewMessage}" />
4</aura:component>

Controller code:

1({
2    onNewMessage: function(cmp, evt, helper) {
3        var recordId = evt.getParam('recordId');
4        var content = evt.getParam('content');
5        var name = evt.getParam('name');
6        var type = evt.getParam('type');
7        var timestamp = evt.getParam('timestamp');
8
9        console.log("recordId:" + recordId + " content:" + content + " name:" + name + " timestamp:" + timestamp);
10    }
11})