Newer Version Available

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

lightning:conversationAgentSend

Messaging event triggered when an agent sends a message through the Salesforce console. This method intercepts the message before it’s sent to the chat visitor. 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 text of the message in the conversation log.
name String The name of the agent who is attempting to send the message. This name matches the agent name displayed in the conversation log.
type String The type of message that was received, such as an Agent or EndUser message.
timestamp Date/Time The date and time that the agent attempted to send the message.

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:conversationAgentSend" action="{! c.onAgentSend}" />
4</aura:component>

Controller code:

1({
2    onAgentSend: 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})