Index

Classes


Class FaxSession

Class Summary
Constructor Attributes Constructor Name and Description
 
FaxSession(fax, agtCommand)
A Fax session, in other term, a fax document presented to the agent
Field Summary
Field Attributes Field Name and Description
 
- list of FaxSessionActionAllowed 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)
 
- Fax campaign description for this fax
 
- Fax campaign id for this fax
 
- campaign type for this fax.
 
- TimeZone of this client, in minutes (MediaServer TimeZone for now)
 
- Fax phonenumber of this contact
 
- Adress book used to display contact informations and history
 
- Fax date recept in format yyyyMMddHHmmss
 
- Oid of holidays group used on the campaign
 
- Client file indice
 
- Fax unique id (the SessionId change on each agent treatment on the same fax)
 
- Oid of Openings group used on the campaign
 
- Planning used to display or set appointment
 
- Qualification code selected by the agent for this fax
 
- Qualification detail code selected by the agent for this fax
 
- Group of status to use to qualify this fax
 
- Queue used to distribute this fax to this agent
 
- URL for the script to display defined in the Hermes.Net Admin
 
- 0 : no script, 1 : InterfaceDesigner script, 2 : free url
 
unused
 
- Sentence group that the agent can use when sending an email for this session
 
- 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 fax search
 
Close the session.
 
Hangup the call linked to this fax
 
HoldCall(holdMessage)
Set the call linked to this fax 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 fax
 
SearchModeSelect(mediaUID, data, memo, campaignId)
Select a fax to manage.
 
SetCallStatus(status, detail, callbackTime, callbackNumber, callbackValidity, comment)
Qualify the session.
 
Transfer(number, type, data)
Transfer the fax to another party.
Class Detail
FaxSession(fax, agtCommand)
A Fax session, in other term, a fax document presented to the agent
Parameters:
fax
agtCommand
Field Detail
{COMArray} ActionsAllowed
- list of FaxSessionActionAllowed 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
- Fax campaign description for this fax

{string} CampaignId
- Fax campaign id for this fax

{CampaignTypes} CampaignType
- campaign type for this fax. Not used for FaxSession

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

{string} ContactNumber
- Fax phonenumber of this contact

{string} CrmOid
- Adress book used to display contact informations and history

{string} DateRecept
- Fax date recept in format yyyyMMddHHmmss

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

{number} Indice
- Client file indice

{string} MediaServerUID
- Fax unique id (the SessionId change on each agent treatment on the same fax)

{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 fax

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

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

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

ScriptParams
unused

{string} SentenceGroup
- Sentence group that the agent can use when sending an email for this session

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

{SessionFaxStates} SessionState
- the current session state

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

{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.Fax.GetSession(thesessionid).ActionIsReady(FaxSessionActionAllowed.CloseSession)) {
        //agent can close the current fax session - no need to qualify
    }
Parameters:
{FaxSessionActionAllowed} 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 fax.
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 fax search

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

HangupCall()
Hangup the call linked to this fax

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

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

SetCallStatus(status, detail, callbackTime, callbackNumber, callbackValidity, comment)
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

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

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