Index

Classes


Class TelephonySession

Class Summary
Constructor Attributes Constructor Name and Description
 
TelephonySession(telephony, agtCommand)
A telephony session, in other term, an active call.
Field Summary
Field Attributes Field Name and Description
 
- list of TelephonySessionActionAllowed for this session
 
- UUI field
 
- Default length in minute for callback (used for display only)
 
- the last day allowed to take callback on the campaign (format : yyyyMMddHHmm)
 
- campaign description for this call
 
- campaign id for this call
 
- campaign type for this call
 
- TimeZone of this client, in minutes
 
- Phonenumber of this contact
 
- Type of the TelephonySession#ContactNumber property
 
- Adress book used to display contact informations and history
 
- Oid of holidays group used on the campaign
 
- Client file indice
 
- Infos about this session (retrieved from CallFile)
 
- Oid of Openings group used on the campaign
 
- Planning used to display or set appointment
 
- Last call status code (for previous call)
 
- Qualification code selected by the agent for this call
 
- Qualification detail code selected by the agent for this call
 
- Group of status to use to qualify this call
 
- Queue used to distribute this call 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 when sending an email for this session
 
- Unique identifier of this session (is unique across all session)
 
- the current session state
 
- the detail of the state for SessionTelephonyStates.Online 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
 
- Real wait time in second of the client before getting the agent
 
- Announced wait time in second gived to the client
Method Summary
Method Attributes Method Name and Description
 
ActionIsReady(action)
Used to know if an action is authorized on the session.
 
Alternate(holdMessage)
During a consult, alternate the active agent line
 
BlindTransfer(number, type, data, holdMessage)
Transfer the client to another party.
 
Cancel the current search session
 
Close the session.
 
On consult, initiate a conference between the three parts
 
Cancel the conference in progress
 
ConsultationCall(number, type, data)
Consult a third party.
 
Cancel the current consult.
 
Initiate a conference with the given number.
 
Extend the wrapup time when the agent configuration is set as automatic ready
 
Hangup the call
 
Hold(holdMessage)
Set the first agent line on hold.
 
This function allow to know if the session has to be qualified before being closed
 
PlayDTMF(sequence)
Send the DTMF sequence on the line
 
PreviewCall(number, type, data)
Call the current previewed customer
 
Cancel the current previewed customer and go to wrapup state
 
Redial(number, type, data, displayType, displayNumber)
On communication lost, allow to redial the same customer (a new session will not be created)
 
If the first agent line is on hold, retrieve it
 
SearchModeSelect(indice, makeCall, number, type, data, memo)
Call a customer for the current search session
 
SetCallStatus(status, detail, callbackTime, callbackNumber, callbackValidity, comment)
Qualify the session.
 
On consult or conference, transfer the call to the third party.
Class Detail
TelephonySession(telephony, agtCommand)
A telephony session, in other term, an active call.
Parameters:
telephony
agtCommand
Field Detail
{COMArray} ActionsAllowed
- list of TelephonySessionActionAllowed for this session

{string} AssociateData
- UUI field

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

{string} CampaignId
- campaign id for this call

{CampaignTypes} CampaignType
- campaign type for this call

{number} ClientTZ
- TimeZone of this client, in minutes

{string} ContactNumber
- Phonenumber of this contact

{PhoneNumberTypes} ContactNumberType
- Type of the TelephonySession#ContactNumber property

{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} Memo
- Infos about this session (retrieved from CallFile)

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

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

{number} PreviousQualificationCode
- Last call status code (for previous call)

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

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

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

{number} QueuedID
- Queue used to distribute this call 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 when sending an email for this session

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

{SessionTelephonyStates} SessionState
- the current session state

{SessionTelephonyOnlineDetails} SessionStateDetail
- the detail of the state for SessionTelephonyStates.Online state

{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} WaitDuration
- Real wait time in second of the client before getting the agent

{number} WaitDurationAnnounced
- Announced wait time in second gived to the client
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.Telephony.GetSession().ActionIsReady(TelephonySessionActionAllowed.Hangup)) {
        //agent can hangup the current call
    }
Parameters:
{TelephonySessionActionAllowed} action
- The action to test
Returns:
true if the action is currently authorized

Alternate(holdMessage)
During a consult, alternate the active agent line
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.

BlindTransfer(number, type, data, holdMessage)
Transfer the client to another party.
Parameters:
{string} number
- phonenumber to call (or destinatory id)
{DestinaryTypes} type
- type of destinatory
{string} data
- UUI data to set on the call
{string} holdMessage
- full path of the wav file to diffuse on customer during the transfer. Empty string to use the default message defined on the campaign.

CancelSearchMode()
Cancel the current search session

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

Conference()
On consult, initiate a conference between the three parts

ConferenceCancel()
Cancel the conference in progress

ConsultationCall(number, type, data)
Consult a third party.
Parameters:
{string} number
- phonenumber to call (or destinatory id)
{DestinaryTypes} type
- type of destinatory
{string} data
- UUI data to set on the call

ConsultationCancel()
Cancel the current consult. Hangup the third party.

DiscreetConference(number)
Initiate a conference with the given number. DTMF entered by the client will not be diffused to the agent
Parameters:
{string} number
- phonenumber to call of type External

ExtendWrapup()
Extend the wrapup time when the agent configuration is set as automatic ready

Hangup()
Hangup the call

Hold(holdMessage)
Set the first agent line 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

PlayDTMF(sequence)
Send the DTMF sequence on the line
Parameters:
{string} sequence
- dtmf string to send

PreviewCall(number, type, data)
Call the current previewed customer
Parameters:
{string} number
- phone number to dial
{PhoneNumberTypes} type
- type of the phone number to dial
{string} data
- UUI data to set on the call

PreviewCancel()
Cancel the current previewed customer and go to wrapup state

Redial(number, type, data, displayType, displayNumber)
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
{number} displayType
- type of phone number display for contact (Standard = 0, Specific = 1, Hidden = 2, Contact = 3)
{string} displayNumber
- phone number to display to contact when displayType = 1

Retrieve()
If the first agent line is on hold, retrieve it

SearchModeSelect(indice, makeCall, number, type, data, memo)
Call a customer for the current search session
Parameters:
{number} indice
- client file indice to set for the call to place
{boolean} makeCall
- true to call directly, false to preview the client file before calling it
{string} number
- 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

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
- validity time of the callback in seconds
{string} comment
- free agent comment saved with the session qualification

Transfer()
On consult or conference, transfer the call to the third party.

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