Salesforce Console Integration Toolkit Developer's Guide

Introducing the Salesforce Console Integration Toolkit
Working with the Salesforce Console Integration Toolkit
Methods for Primary Tabs and Subtabs
Methods for Navigation Tabs
Methods for Computer-Telephony Integration (CTI)
Methods for Application-Level Custom Console Components
Methods for Push Notifications
Methods for Console Events
Methods for Live Agent
acceptChat()
cancelFileTransferByAgent()
declineChat()
endChat()
getAgentInput()
getAgentState()
getChatLog()
getChatRequests()
getDetailsByChatKey()
getDetailsByPrimaryTabId()
getEngagedChats()
getMaxCapacity()
initFileTransfer()
onAgentSend()
onAgentStateChanged()
onChatCanceled()
onChatCriticalWaitState()
onChatDeclined()
onChatEnded()
onChatRequested()
onChatStarted()
onChatTransferredOut()
onCurrentCapacityChanged()
onCustomEvent()
onFileTransferCompleted()
onNewMessage()
onTypingUpdate()
sendCustomEvent()
sendMessage()
setAgentInput()
setAgentState()
Methods for Live Agent Chat Visitors
Methods for Omni-Channel
Glossary
PDF

Newer Version Available

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

onAgentSend()

Registers a function to call when an agent sends a chat message through the Salesforce console. This method intercepts the message and occurs before it is sent to the chat visitor. Available in API version 29.0 or later.

This method is only called when an agent sends a message through the chat window interface. This method doesn’t apply when a sendMessage() method is called in the API.

Note

Syntax

Arguments

Name Type Description
chatKey String The chatKey associated with the chat for which to call a function when the agent sends a message.
callback function JavaScript method called upon completion of the method.

Sample Code–Visualforce

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 the agent’s message.
name String The name of the agent who is attempting to send the message as it appears in the chat log.
type String The type of message that was received—for example, agent.
timestamp Date/Time The date and time the agent attempted to send the chat message.
success Boolean true if firing event was successful; false if firing event wasn’t successful.