Class ChatSession
Constructor Attributes | Constructor Name and Description |
---|---|
ChatSession(context, agtCommand)
A Chat session, in other term, an active chat conversation
|
Field Attributes | Field Name and Description |
---|---|
- list of ChatSessionActionAllowed for this session
|
|
- Name of the agent displayed on the websurfer side
|
|
- Default length in minute for callback (used for display only)
|
|
- the last day allowed to take callback on the campaign (format : yyyyMMddHHmm)
|
|
- TheWave campaign description for this chat
|
|
- TheWave campaign id for this chat
|
|
- campaign type for this chat.
|
|
- Name of the websurfer
|
|
- TimeZone of this client, in minutes
|
|
- Phonenumber of this contact
|
|
- Phonenumber of this contact, used for session not of telephony type
|
|
- Adress book used to display contact informations and history
|
|
- Geolocalisation of the websurfer (if a geolocalisation plugin is activate on MediaServer)
|
|
- Oid of holidays group used on the campaign
|
|
- Client file indice
|
|
- Websurfer ip adress
|
|
- list (comma separated) of keywords the websurfer type on search engine to find the website
|
|
- ChatRoom unique identifier
|
|
- Infos about this session
|
|
- if true, the VideoConference has to be managed with the SIP Softphone and not the flash module (for example TheDrive chat)
|
|
- Oid of Openings group used on the campaign
|
|
- Unique identifier of origin session before the call to ChatSession#NextFile
|
|
- Name of website page where the websurfer ask the chat
|
|
- Planning used to display or set appointment
|
|
- Qualification code selected by the agent for this chat
|
|
- Qualification detail code selected by the agent for this chat
|
|
- Group of status to use to qualify this chat
|
|
- Queue used to distribute this chat to this agent
|
|
- URL for the script to display defined in the Hermes.Net Admin
|
|
- 0 : no script, 1 : InterfaceDesigner script, 2 : free url
|
|
- Sentence group that the agent can use to answer the chat
|
|
- Unique identifier of this session (is unique across all session)
|
|
- the current session state
|
|
- detail for the current state.
|
|
- textual representation of the current SessionState
|
|
- time of the last session state change
|
|
- Right to send a free attachment file by email to the customer
|
|
- Bandwidth for video to set for videoconference
|
|
- Height for video to set for videoconference
|
|
- Quality for video (0 to 100) to set for videoconference
|
|
- Img/sec for video (0 to 100) to set for videoconference
|
|
- Width for video to set for videoconference
|
|
- Time in second the websurfer browse before asking chat
|
|
- Real wait time in second of the client before getting the agent
|
|
- Announced wait time in second gived to the client
|
|
- Name of the website
|
Method Attributes | Method Name and Description |
---|---|
ActionIsReady(action)
Used to know if an action is authorized on the session.
|
|
Alternate(holdMessage)
Alternate the consult mode between talking to websurfer or talking to third party agent
|
|
BlindTransfer(dest, destType, holdMessage)
Transfer the chat to another agent
|
|
CallSession(phoneNumber, type, data, memo)
Call the websurfer on it's phone.
|
|
Close the session.
|
|
When a consultation is in progress - enter the three party in conference
|
|
End the current conferance.
|
|
Consultation(agentId, type, data)
Consult another agent for the conversation
|
|
End the running consultation
|
|
Hangup()
Stop the chat conversation
|
|
Hangup the call linked to this chat
|
|
HoldCall(holdMessage)
Set the call linked to this chat on hold
|
|
This function allow to know if the session has to be qualified before being closed
|
|
NextFile()
Open a new customer record file without closing the chat.
|
|
RedialCall(number, type, data)
On communication lost, allow to redial the same customer (a new session will not be created)
|
|
Retrieve the holded call linked to this chat
|
|
SendChatEmailFeed(emailAdress)
Send the content of conversation to the email adress
|
|
SendChatMsg(typeMessage, messageStr)
Send a new message on the conversation
|
|
SetCallStatus(status, detail, callbackTime, callbackNumber, callbackValidity, comment, blockSurfer)
Qualify the session.
|
|
Start a cobrowsing session with the websurfer
|
|
Stop the cobrowsing session in progress with the websurfer
|
|
Transfer()
Transfer the chat to the consulted agent
|
Class Detail
ChatSession(context, agtCommand)
A Chat session, in other term, an active chat conversation
- Parameters:
- context
- agtCommand
Field Detail
{COMArray}
ActionsAllowed
- list of ChatSessionActionAllowed for this session
{string}
AgentFakeName
- Name of the agent displayed on the websurfer side
{number}
CallbackDefaultLength
- Default length in minute for callback (used for display only)
{string}
CallbackLastAllowedDay
- the last day allowed to take callback on the campaign (format : yyyyMMddHHmm)
{string}
CampaignDescription
- TheWave campaign description for this chat
{string}
CampaignId
- TheWave campaign id for this chat
{CampaignTypes}
CampaignType
- campaign type for this chat. Not used for ChatSession
{string}
ChatterName
- Name of the websurfer
{number}
ClientTZ
- TimeZone of this client, in minutes
{string}
ContactNumber
- Phonenumber of this contact
{string}
ContactPhone
- Phonenumber of this contact, used for session not of telephony type
{string}
CrmOid
- Adress book used to display contact informations and history
{GeolocalisationInfos}
Geolocalisation
- Geolocalisation of the websurfer (if a geolocalisation plugin is activate on MediaServer)
{string}
HolidayGroup
- Oid of holidays group used on the campaign
{number}
Indice
- Client file indice
{string}
IPAddress
- Websurfer ip adress
{string}
Keywords
- list (comma separated) of keywords the websurfer type on search engine to find the website
{string}
MediaServerUID
- ChatRoom unique identifier
{string}
Memo
- Infos about this session
{boolean}
NeedSipPhone
- if true, the VideoConference has to be managed with the SIP Softphone and not the flash module (for example TheDrive chat)
{string}
OpeningGroup
- Oid of Openings group used on the campaign
{string}
OriginSessionId
- Unique identifier of origin session before the call to ChatSession#NextFile
{string}
Page
- Name of website page where the websurfer ask the chat
{string}
PlanningId
- Planning used to display or set appointment
{number}
QualificationCode
- Qualification code selected by the agent for this chat
{number}
QualificationDetail
- Qualification detail code selected by the agent for this chat
{string}
QualificationGroup
- Group of status to use to qualify this chat
{number}
QueuedID
- Queue used to distribute this chat to this agent
{string}
ScriptAddress
- URL for the script to display defined in the Hermes.Net Admin
{number}
ScriptMode
- 0 : no script, 1 : InterfaceDesigner script, 2 : free url
{string}
SentenceGroup
- Sentence group that the agent can use to answer the chat
{string}
SessionId
- Unique identifier of this session (is unique across all session)
{SessionChatStates}
SessionState
- the current session state
{number}
SessionStateDetail
- detail for the current state. Not used for ChatSession
{string}
SessionStateLabel
- textual representation of the current SessionState
{number}
SessionStateTime
- time of the last session state change
{boolean}
UploadAttachmentRight
- Right to send a free attachment file by email to the customer
{number}
VideoBandwidth
- Bandwidth for video to set for videoconference
{number}
VideoHeight
- Height for video to set for videoconference
{number}
VideoQuality
- Quality for video (0 to 100) to set for videoconference
{number}
VideoRate
- Img/sec for video (0 to 100) to set for videoconference
{number}
VideoWidth
- Width for video to set for videoconference
{number}
VisitDuration
- Time in second the websurfer browse before asking chat
{number}
WaitDuration
- Real wait time in second of the client before getting the agent
{number}
WaitDurationAnnounced
- Announced wait time in second gived to the client
{string}
WebSite
- Name of the website
Method Detail
ActionIsReady(action)
Used to know if an action is authorized on the session.
You have to check the return of this function before calling an action on the session
You have to check the return of this function before calling an action on the session
if (agentlink.Chat.GetSession(thesessionid).ActionIsReady(ChatSessionActionAllowed.Hangup)) { //agent can close the current chat }
- Parameters:
- {ChatSessionActionAllowed} action
- - The action to test
- Returns:
- true if the action is currently authorized
Alternate(holdMessage)
Alternate the consult mode between talking to websurfer or talking to third party agent
- Parameters:
- holdMessage
BlindTransfer(dest, destType, holdMessage)
Transfer the chat to another agent
- Parameters:
- {number} dest
- - Id of the agent to transfert to
- {DestinaryTypes} destType
- - Always DestinaryTypes.Agent for chat
- {string} holdMessage
- - message displayed to the surfer during the transfer
CallSession(phoneNumber, type, data, memo)
Call the websurfer on it's phone. Call will be linked to the chat.
- Parameters:
- {string} phoneNumber
- - phonenumber to call
- {PhoneNumberTypes} type
- - type of the phone number to dial
- {string} data
- - UUI data to set on the call
- {string} memo
- - free string that will be set on the call session
CloseSession()
Close the session. After this function call, the agent will be available for next chat
Conference()
When a consultation is in progress - enter the three party in conference
ConferenceCancel()
End the current conferance. Third party agent will exit from the conversation
Consultation(agentId, type, data)
Consult another agent for the conversation
- Parameters:
- {number} agentId
- - Id of the agent to consult
- {DestinaryTypes} type
- - Always DestinaryTypes.Agent for chat
- {string} data
- - additial data that will be passed to third party agent
ConsultationCancel()
End the running consultation
Hangup()
Stop the chat conversation
HangupCall()
Hangup the call linked to this chat
HoldCall(holdMessage)
Set the call linked to this chat on hold
- Parameters:
- {string} holdMessage
- - full path of the wav file to diffuse on customer during the hold. Empty string to use the default message defined on the campaign.
MustQualify()
This function allow to know if the session has to be qualified before being closed
- Returns:
- true if the session has to be qualified
NextFile()
Open a new customer record file without closing the chat.
RedialCall(number, type, data)
On communication lost, allow to redial the same customer (a new session will not be created)
- Parameters:
- {string} number
- - phonenumber to call
- {PhoneNumberTypes} type
- - type of the phone number to dial
- {string} data
- - UUI data to set on the call
RetrieveCall()
Retrieve the holded call linked to this chat
SendChatEmailFeed(emailAdress)
Send the content of conversation to the email adress
- Parameters:
- {string} emailAdress
- - email adress
SendChatMsg(typeMessage, messageStr)
Send a new message on the conversation
var sessionChat = agentlink.Chat.GetSession(thesessionid); var mess = { type: "TEXT", text: "Hello world" }; var messStr = JSON.stringify(mess); //Send the message on the conversation sessionChat.SendChatMsg(ChatMessageTypes.TextMessage, messStr);
- Parameters:
- {ChatMessageTypes} typeMessage
- - the message to send
- {string} messageStr
- - the message content
SetCallStatus(status, detail, callbackTime, callbackNumber, callbackValidity, comment, blockSurfer)
Qualify the session.
- Parameters:
- {number} status
- - status code
- {number} detail
- - status detailed code
- {string} callbackTime
- - for callback and personal callbacks code, specify the datetime for callback (format yyyyMMddHHmm)
- {string} callbackNumber
- - phonenumber to dial on callback
- {number} callbackValidity
- - unused
- {string} comment
- - free agent comment saved with the session qualification
- {boolean} blockSurfer
- - signal abusive chat, will block the websurfer during certain amont of time
StartCobrowsing()
Start a cobrowsing session with the websurfer
StopCobrowsing()
Stop the cobrowsing session in progress with the websurfer
Transfer()
Transfer the chat to the consulted agent