Index

Classes


Class MailSession

Class Summary
Constructor Attributes Constructor Name and Description
 
MailSession(context, agtCommand)
A Mail session, in other term, an email presented to the agent
Field Summary
Field Attributes Field Name and Description
 
- list of MailSessionActionAllowed for this session
 
- Default length in minute for callback (used for display only)
 
- the last day allowed to take callback on the campaign (format : yyyyMMddHHmm)
 
- email campaign description for this email
 
- email campaign id for this email
 
- campaign type for this email.
 
- TimeZone of this client, in minutes (MediaServer TimeZone for now)
 
- Email adress of this contact
 
- Phonenumber of this contact, used for session not of telephony type
 
- Adress book used to display contact informations and history
 
- Oid of holidays group used on the campaign
 
- client file indice
 
- Email unique id (the SessionId change on each agent treatment for the same email)
 
- Infos about this session (filled only on email transfer)
 
- Oid of Openings group used on the campaign
 
- Planning used to display or set appointment
 
- Qualification code selected by the agent for this email
 
- Qualification detail code selected by the agent for this email
 
- Group of status to use to qualify this email
 
- Queue used to distribute this email 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 email
 
- 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
Method Summary
Method Attributes Method Name and Description
 
ActionIsReady(action)
Used to know if an action is authorized on the session.
 
CallSession(phoneNumber, type, data, memo)
Call the contact on it's phone.
 
Cancel the current email search
 
Close the session.
 
Notify supervision of one forward action done by the agent
 
Hangup the call linked to this email
 
HoldCall(holdMessage)
Set the call linked to this email on hold
 
This function allow to know if the session has to be qualified before being closed
 
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 email
 
SearchModeSelect(mediaUID, data, memo, campaignId)
Select an email to manage.
 
SetCallStatus(status, detail, callbackTime, callbackNumber, callbackValidity, comment, blackListSender)
Qualify the session.
 
Set the current email answer editing mode.
 
Transfer(number, type, data)
Transfer the email to another party.
 
Set the session state in wrapup.
Class Detail
MailSession(context, agtCommand)
A Mail session, in other term, an email presented to the agent
Parameters:
context
agtCommand
Field Detail
{COMArray} ActionsAllowed
- list of MailSessionActionAllowed for this session

{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
- email campaign description for this email

{string} CampaignId
- email campaign id for this email

{CampaignTypes} CampaignType
- campaign type for this email. Not used for MailSession

{number} ClientTZ
- TimeZone of this client, in minutes (MediaServer TimeZone for now)

{string} ContactNumber
- Email adress 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

{string} HolidayGroup
- Oid of holidays group used on the campaign

{number} Indice
- client file indice

{string} MediaServerUID
- Email unique id (the SessionId change on each agent treatment for the same email)

{string} Memo
- Infos about this session (filled only on email transfer)

{string} OpeningGroup
- Oid of Openings group used on the campaign

{string} PlanningId
- Planning used to display or set appointment

{number} QualificationCode
- Qualification code selected by the agent for this email

{number} QualificationDetail
- Qualification detail code selected by the agent for this email

{string} QualificationGroup
- Group of status to use to qualify this email

{number} QueuedID
- Queue used to distribute this email 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 email

{string} SessionId
- Unique identifier of this session (is unique across all session)

{SessionMailStates} SessionState
- the current session state

{number} SessionStateDetail
- detail for the current state. Not used for MailSession

{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
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
    if (agentlink.Mail.GetSession(thesessionid).ActionIsReady(MailSessionActionAllowed.CloseSession)) {
        //agent can close the current email session - no need to qualify
    }
Parameters:
{MailSessionActionAllowed} action
- The action to test
Returns:
true if the action is currently authorized

CallSession(phoneNumber, type, data, memo)
Call the contact on it's phone. Call will be linked to the email.
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

CancelSearchMode()
Cancel the current email search

CloseSession()
Close the session. After this function call, the agent will be available for next email

ForwardNotify()
Notify supervision of one forward action done by the agent

HangupCall()
Hangup the call linked to this email

HoldCall(holdMessage)
Set the call linked to this email 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

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 email

SearchModeSelect(mediaUID, data, memo, campaignId)
Select an email to manage. Available only on search session (check current actions allowed)
Parameters:
{string} mediaUID
- email uid
{string} data
- unused
{string} memo
- unused
{string} campaignId
- campaign id of the email to manage

SetCallStatus(status, detail, callbackTime, callbackNumber, callbackValidity, comment, blackListSender)
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} blackListSender
- true for spam, email sender will be blacklisted

SetEditMode(mode)
Set the current email answer editing mode.
Parameters:
{boolean} mode
- true : agent is editing the answer

Transfer(number, type, data)
Transfer the email to another party.
Parameters:
{string} number
- destinatory id
{DestinaryTypes} type
- type of destinatory (DestinaryTypes.Agent or DestinaryTypes.Campaign or DestinaryTypes.Free)
{string} data
- UUI data to set on the email

Wrapup()
Set the session state in wrapup. On wrapup state, agent can qualify the email but not reply it.

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Nov 05 2014 12:49:32 GMT+0100 (CET)