Namespace: Chat

Chat

Source:

Methods

(static) AgentLibrary#chatAgentEnd(uii, agentId)

set chat in state of agent-chat-end
Parameters:
Name Type Description
uii string Unique identifier for the chat session
agentId string Current logged in agent id
Source:

(static) AgentLibrary#chatDisposition(uii, agentId, dispositionId, notesopt, sendAcknowlegement, scriptopt, sessionId)

Send a disposition to end a chat session
Parameters:
Name Type Attributes Default Description
uii string Unique identifier for the chat session
agentId number The agent's id
dispositionId number Id of the selected disposition
notes string <optional>
 "" Agent notes
sendAcknowlegement boolean Whether or not to fire callback
script object <optional>
 null Script data associated with the chat session
sessionId number Id for chat session
Source:

(static) AgentLibrary#chatList(agentId, monitorAgentId, callbackopt)

Request a list of active chats by agent id
Parameters:
Name Type Attributes Default Description
agentId string Current logged in agent id
monitorAgentId string Agent id handling chats
callback function <optional>
 null Callback function when chat-list request received
Source:

(static) AgentLibrary#chatMessage(uii, agentId, message)

Send an external chat message
Parameters:
Name Type Description
uii string Unique identifier for the chat session
agentId string The agent associated with the chat
message string The message sent by the agent
Source:

(static) AgentLibrary#chatPresentedResponse(uii, messageId, response, responseReason)

Send accept/decline response when a chat is presented to an agent
Parameters:
Name Type Description
uii string Unique identifier for the chat session
messageId string Id tied to chat presented notification which this response is connected to.
response string ACCEPT|REJECT response
responseReason string Agent reason for Reject
Source:

(static) AgentLibrary#chatRequeue(uii, agentId, chatQueueId, skillId, maintainAgentopt)

Send the chat to a different Chat Queue
Parameters:
Name Type Attributes Default Description
uii string Unique identifier for the chat session
agentId number The agent's id
chatQueueId number Id of the Chat Queue to requeue to
skillId number Skill id associated with the Chat Queue
maintainAgent boolean <optional>
 false Whether or not to keep the current agent connected to the chat on requeue
Source:

(static) AgentLibrary#chatTyping(uii, message)

Sent when agent starts/stops typing
Parameters:
Name Type Description
uii string Unique identifier for the chat session
message string Pending Agent message - sent to any monitoring Supervisors
Source:

(static) AgentLibrary#chatWhisper(uii, agentId, message)

Send an whisper type chat message
Parameters:
Name Type Description
uii string Unique identifier for the chat session
agentId string The agent associated with the chat
message string The message sent by the agent
Source:

(static) AgentLibrary#getSupervisors(callbackopt)

Get list of supervisors for logged in agent
Parameters:
Name Type Attributes Default Description
callback function <optional>
 null Callback function when chat message received
Deprecated:
  • Yes
Source:

(static) AgentLibrary#leaveChat(uii, agentId, sessionId)

Request to terminate an active chat session
Parameters:
Name Type Description
uii string Unique identifier for the chat session
agentId string Current logged in agent id
sessionId string Chat session id
Source:

(static) AgentLibrary#monitorAgentChats(monitorAgentId)

Request to add a session on an existing chat
Parameters:
Name Type Description
monitorAgentId string Agent id handling this chat, the agent being monitored
Source:

(static) AgentLibrary#privateChatRoom(action, roomId, agentOne, agentTwo)

Request to enter/exit a private chat room
Parameters:
Name Type Description
action string "ENTER" | "EXIT"
roomId number Chat room id
agentOne number Id for the logged in agent
agentTwo number Id for the agent or supervisor the logged in agent is chatting with
Deprecated:
  • Yes
Source:

(static) AgentLibrary#publicChatRoom(action, roomId)

Request to enter/exit a public chat room
Parameters:
Name Type Description
action string "ENTER" | "EXIT"
roomId number Chat room id
Deprecated:
  • Yes
Source:

(static) AgentLibrary#sendChat(roomId, message, callbackopt)

Send a chat message to the given room
Parameters:
Name Type Attributes Default Description
roomId number Id for chat room
message string The message to be sent
callback function <optional>
 null Callback function when chat message received
Deprecated:
  • Yes
Source:

(static) AgentLibrary#sendManualOutboundSms(agentId, chatQueueId, ani, dnis, message)

initialize a chat session by sending a manual outbound sms
Parameters:
Name Type Description
agentId string Current logged in agent id
chatQueueId number Id of the Chat Queue to send this sms through
ani number to receive the sms
dnis number to be used for the sms
message string content
Source:

(static) AgentLibrary#setChatAlias(alias)

Set the agent chat alias
Parameters:
Name Type Description
alias string The alias string to be used for agent chat messages
Deprecated:
  • Yes
Source:

(static) AgentLibrary#stopMonitoringAllAgentChats()

Request to drop all chat monitoring sessions for the logged in agent
Source:

(static) AgentLibrary#stopMonitoringChatsByAgent(monitorAgentId)

Request to stop a chat monitoring session for a specific agent
Parameters:
Name Type Description
monitorAgentId string Agent id of agent being monitored
Source: