Class VoicemailSession
Constructor Attributes | Constructor Name and Description |
---|---|
VoicemailSession(voicemail, agtCommand)
A Voicemail session, in other term, a voicemail presented to the agent
|
Field Attributes | Field Name and Description |
---|---|
- list of VoiceMailSessionActionAllowed 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)
|
|
- Inbound campaign description for this voicemail
|
|
- Inbound campaign id for this voicemail
|
|
- Inbound campaign type for this voicemail
|
|
- TimeZone of this client, in minutes (MediaServer TimeZone for now)
|
|
- phonenumber of this contact
|
|
- Adress book used to display contact informations and history
|
|
- Voicemail date recept in format yyyyMMddHHmmss
|
|
- Oid of holidays group used on the campaign
|
|
- Client file indice
|
|
- Oid of Openings group used on the campaign
|
|
- Planning used to display or set appointment
|
|
- Qualification code selected by the agent for this voicemail
|
|
- Qualification detail code selected by the agent for this voicemail
|
|
- Group of status to use to qualify this voicemail
|
|
- Queue used to distribute this voicemail 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
|
|
- detail for the current state.
|
|
- textual representation of the current SessionState
|
|
- time of the last session state change
|
|
- Duration of the Voicemail in seconds
|
|
- File path of the Voicemail
|
|
- Right to send a free attachment file by email to the customer
|
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 voicemail search
|
|
Close the session.
|
|
Hangup the call linked to this voicemail
|
|
HoldCall(holdMessage)
Set the call linked to this voicemail on hold
|
|
This function allow to know if the session has to be qualified before being closed
|
|
Play(startingPosition)
Start to play the voicemail on the first agent line
|
|
PlayStop()
Stop to play the voicemail
|
|
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 voicemail
|
|
SearchModeSelect(mediaUID, data, memo, campaignId)
Select a voicemail to manage.
|
|
SetCallStatus(status, detail, callbackTime, callbackNumber, callbackValidity, comment)
Qualify the session.
|
|
Transfer(number, type, data)
Transfer the voicemail to another party.
|
Class Detail
VoicemailSession(voicemail, agtCommand)
A Voicemail session, in other term, a voicemail presented to the agent
- Parameters:
- voicemail
- agtCommand
Field Detail
{COMArray}
ActionsAllowed
- list of VoiceMailSessionActionAllowed 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
- Inbound campaign description for this voicemail
{string}
CampaignId
- Inbound campaign id for this voicemail
{CampaignTypes}
CampaignType
- Inbound campaign type for this voicemail
{number}
ClientTZ
- TimeZone of this client, in minutes (MediaServer TimeZone for now)
{string}
ContactNumber
- phonenumber of this contact
{string}
CrmOid
- Adress book used to display contact informations and history
{string}
DateRecept
- Voicemail date recept in format yyyyMMddHHmmss
{string}
HolidayGroup
- Oid of holidays group used on the campaign
{number}
Indice
- Client file indice
{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 voicemail
{number}
QualificationDetail
- Qualification detail code selected by the agent for this voicemail
{string}
QualificationGroup
- Group of status to use to qualify this voicemail
{number}
QueuedID
- Queue used to distribute this voicemail 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)
{SessionVoiceMailStates}
SessionState
- the current session state
{number}
SessionStateDetail
- detail for the current state. Not used for VoicemailSession
{string}
SessionStateLabel
- textual representation of the current SessionState
{number}
SessionStateTime
- time of the last session state change
{number}
SoundFileLength
- Duration of the Voicemail in seconds
{string}
SoundFilePath
- File path of the Voicemail
{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
You have to check the return of this function before calling an action on the session
if (agentlink.VoiceMail.GetSession(thesessionid).ActionIsReady(VoiceMailSessionActionAllowed.VoicemailPlayStart)) { //agent can starting to listen the vociemail }
- Parameters:
- {VoiceMailSessionActionAllowed} 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 voicemail.
- 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 voicemail search
CloseSession()
Close the session. After this function call, the agent will be available for next voicemail
HangupCall()
Hangup the call linked to this voicemail
HoldCall(holdMessage)
Set the call linked to this voicemail 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
Play(startingPosition)
Start to play the voicemail on the first agent line
- Parameters:
- {number} startingPosition
- - shift the start of the voicemail (in second)
PlayStop()
Stop to play the voicemail
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 voicemail
SearchModeSelect(mediaUID, data, memo, campaignId)
Select a voicemail to manage. Available only on search session (check current actions allowed)
- Parameters:
- {string} mediaUID
- - voicemail uid
- {string} data
- - unused
- {string} memo
- - unused
- {string} campaignId
- - campaign id of the voicemail 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 voicemail to another party.
- Parameters:
- {string} number
- - destinatory id
- {DestinaryTypes} type
- - type of destinatory (DestinaryTypes.Agent or DestinaryTypes.Campaign)
- {string} data
- - UUI data to set on the voicemail