Class finesse.restservices.Dialog
Extends
finesse.restservices.RestBase.
A Dialog is an attempted connection between or among multiple participants,
for example, a regular phone call, a conference, or a silent monitor session.
Defined in: finesse.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Method Attributes | Method Name and Description |
---|---|
cancelCallback(mediaAddress, handlers)
Invoke a request to server to cancel a callback.
|
|
dropParticipant(targetMediaAddress, handlers)
Wrapper around "requestAction" to request PARTICIPANT_DROP action.
|
|
Retrieves information about the currently scheduled callback, if any.
|
|
Getter for the callType.
|
|
getDNIS()
Getter for the DNIS.
|
|
getDroppableParticipants(filterExtension)
Determines the droppable participants.
|
|
Getter for the from address.
|
|
Retrieves a list of media properties from the dialog object.
|
|
Getter for the media type.
|
|
Retrieves a list of participants within the Dialog object.
|
|
getParticipantTimerCounters(participantExt)
gets the participant timer counters
|
|
getState()
Getter for the Dialog state.
|
|
Getter for the to address.
|
|
initiateDirectTransfer(mediaAddress, toAddress, handlers)
Invoke a single step transfer request.
|
|
isParticipantDroppable(participantExt)
Is the participant droppable
|
|
makeConsultCall(mediaAddress, toAddress, handlers)
Invoke a consult call out to a destination.
|
|
reclassifyCall(mediaAddress, callbackNumber, handlers)
Invoke a request to server to reclassify the call type.
|
|
requestAction(mediaAddress, action, handlers)
Invoke a request to server based on the action given.
|
|
sendDTMFRequest(mediaAddress, action, handlers)
Invoke a request to server to send DTMF digit tones.
|
|
updateCallbackNumber(mediaAddress, callbackNumber, handlers)
Invoke a request to server to set the number for a callback.
|
|
updateCallbackTime(mediaAddress, callbackTime, handlers)
Invoke a request to server to set the time for a callback.
|
|
updateWrapUpReason(wrapUpReason, handlers)
Update this dialog's wrap-up reason.
|
- Methods borrowed from class finesse.restservices.RestBase:
- addHandler, getData, getId, getProperty, hasProperty, isLoaded, refresh, removeHandler
Method Detail
cancelCallback(mediaAddress, handlers)
Invoke a request to server to cancel a callback.
- Parameters:
- {String} mediaAddress
- {finesse.interfaces.RequestHandlers} handlers
- An object containing the handlers for the request
dropParticipant(targetMediaAddress, handlers)
Wrapper around "requestAction" to request PARTICIPANT_DROP action.
- Parameters:
- targetMediaAddress
- is the address to drop
- {finesse.interfaces.RequestHandlers} handlers
- An object containing the handlers for the request
{Object}
getCallbackInfo()
Retrieves information about the currently scheduled callback, if any.
- Returns:
- {Object} If no callback has been set, will return undefined. If a callback has been set, it will return a map with one or more of the following entries, depending on what values have been set. callbackTime - the callback time, if it has been set. callbackNumber - the callback number, if it has been set.
{String}
getCallType()
Getter for the callType.
- Deprecated:
- Use getMediaProperties().callType instead.
- Returns:
- {String} The callType.
{String}
getDNIS()
Getter for the DNIS. This is usually the actual number dialed.
- Deprecated:
- Use getMediaProperties().DNIS instead.
- Returns:
- {String} The callType.
{Array}
getDroppableParticipants(filterExtension)
Determines the droppable participants. A droppable participant is a participant that is an agent extension.
(It is not a CTI Route Point, IVR Port, or the caller)
- Parameters:
- {String} filterExtension
- used to remove a single extension from the list
- Returns:
- {Array} Participants which is an array of all participants which can be dropped.
{String}
getFromAddress()
Getter for the from address.
- Returns:
- {String} The from address.
{Object}
getMediaProperties()
Retrieves a list of media properties from the dialog object.
- Returns:
- {Object} Map of call variables; names mapped to values.
Variables may include the following:
- dialedNumber: The number dialed.
- callType: The type of call. Call types include:
- ACD_IN
- PREROUTE_ACD_IN
- PREROUTE_DIRECT_AGENT
- TRANSFER
- OTHER_IN
- OUT
- AGENT_INSIDE
- CONSULT
- CONFERENCE
- SUPERVISOR_MONITOR
- OUTBOUND
- OUTBOUND_PREVIEW
- DNIS: The DNIS provided. For routed calls, this is the route point.
- wrapUpReason: A description of the call.
- Call Variables, by name. The name indicates whether it is a call variable or ECC variable. Call variable names start with callVariable#, where # is 1-10. ECC variable names (both scalar and array) are prepended with "user". ECC variable arrays include an index enclosed within square brackets located at the end of the ECC array name.
- The following call variables provide additional details about an Outbound Option call:
- BACampaign
- BAAccountNumber
- BAResponse
- BAStatus
- PREDICTIVE_OUTBOUND: A predictive outbound call.
- PROGRESSIVE_OUTBOUND: A progressive outbound call.
- PREVIEW_OUTBOUND_RESERVATION: Agent is reserved for a preview outbound call.
- PREVIEW_OUTBOUND: Agent is on a preview outbound call.
- BADialedListID
- BATimeZone
- BABuddyName
{String}
getMediaType()
Getter for the media type.
- Returns:
- {String} The media type.
{Object}
getParticipants()
Retrieves a list of participants within the Dialog object.
- Returns:
- {Object} Array list of participants.
{Object}
getParticipantTimerCounters(participantExt)
gets the participant timer counters
- Parameters:
- {String} participantExt
- Extension of participant.
- Returns:
- {Object} which contains state, startTime, and stateChangeTime fields
{String}
getState()
Getter for the Dialog state.
- Returns:
- {String} The Dialog state.
{String}
getToAddress()
Getter for the to address.
- Returns:
- {String} The to address.
initiateDirectTransfer(mediaAddress, toAddress, handlers)
Invoke a single step transfer request.
- Parameters:
- {String} mediaAddress
- The media address of the user performing the single step transfer.
- {String} toAddress
- The destination address of the single step transfer.
- {finesse.interfaces.RequestHandlers} handlers
- An object containing the handlers for the request
{Boolean}
isParticipantDroppable(participantExt)
Is the participant droppable
- Parameters:
- {String} participantExt
- Extension of participant.
- Returns:
- {Boolean} True is droppable.
makeConsultCall(mediaAddress, toAddress, handlers)
Invoke a consult call out to a destination.
- Parameters:
- {String} mediaAddress
- The media address of the user performing the consult call.
- {String} toAddress
- The destination address of the consult call.
- {finesse.interfaces.RequestHandlers} handlers
- An object containing the handlers for the request
reclassifyCall(mediaAddress, callbackNumber, handlers)
Invoke a request to server to reclassify the call type.
- Parameters:
- {String} mediaAddress
- {String} callbackNumber
- The requested number to call for the callback
- {finesse.interfaces.RequestHandlers} handlers
- An object containing the handlers for the request
requestAction(mediaAddress, action, handlers)
Invoke a request to server based on the action given.
- Parameters:
- {String} mediaAddress
- The media address of the user performing the action.
- {finesse.restservices.Dialog.Actions} action
- The action string indicating the action to invoke on dialog.
- {finesse.interfaces.RequestHandlers} handlers
- An object containing the handlers for the request
sendDTMFRequest(mediaAddress, action, handlers)
Invoke a request to server to send DTMF digit tones.
- Parameters:
- {String} mediaAddress
- {String} action
- The action string indicating the action to invoke on dialog.
- {finesse.interfaces.RequestHandlers} handlers
- An object containing the handlers for the request
updateCallbackNumber(mediaAddress, callbackNumber, handlers)
Invoke a request to server to set the number for a callback.
- Parameters:
- {String} mediaAddress
- {String} callbackNumber
- The requested number to call for the callback
- {finesse.interfaces.RequestHandlers} handlers
- An object containing the handlers for the request
updateCallbackTime(mediaAddress, callbackTime, handlers)
Invoke a request to server to set the time for a callback.
- Parameters:
- {String} mediaAddress
- {String} callbackTime
- The requested time for the callback, in YYYY-MM-DDTHH:MM format (ex: 2013-12-24T23:59)
- {finesse.interfaces.RequestHandlers} handlers
- An object containing the handlers for the request
updateWrapUpReason(wrapUpReason, handlers)
Update this dialog's wrap-up reason.
- Parameters:
- {String} wrapUpReason
- The new wrap-up reason for this dialog
- {finesse.interfaces.RequestHandlers} handlers
- An object containing the handlers for the request