Interface IPhoneMedia

All Superinterfaces:

IDisposable, IEntity, IInteractionMedia

public interface IPhoneMedia
extends IInteractionMedia

Represents a phone media.

Method Summary

Modifier and Type	Method	Description
void	addDigitsCollectedListener(DigitsCollectedListener listener)	Registers the DigitsCollectedListener.
void	addMessagePlayedAndDigitsCollectedListener(MessagePlayedAndDigitsCollectedListener listener)	Registers the MessagePlayedAndDigitsCollectedListener.
void	addPhoneErrorListener(PhoneErrorListener listener)	Registers the PhoneErrorListener.
void	addPhoneGenericDataReceivedListener(PhoneGenericDataReceivedListener listener)	Registers the PhoneGenericDataReceivedListener.
void	addPhoneListener(PhoneListener listener)	Registers the PhoneListener.
void	addPhoneMonitoredListener(PhoneMonitoredListener listener)	Registers the PhoneMonitoredListener.
void	addPhoneOperationStoppedListener(PhoneOperationStoppedListener listener)	Registers the PhoneOperationStoppedListener.
void	addPhoneProgressListener(PhoneProgressListener listener)	Registers the PhoneProgressListener.
void	answerSupervisionRequest(SupervisionMode supervisionMode)	Answer the supervise request
void	blindTransfer(String agentName, String number, String campaignName, int directoryId, int contactProfileId, boolean differentInstance, Attribute[] attributes, byte[] blindData, BlindTransferMode blindTransferMode, boolean synchronous)	Performs a phone and data blind transfer between agents.
void	cancelSupervisionRequest()	Cancel supervision request.
void	clear(boolean synchronous)	Clears the call profile.
void	clearDigits()	Requests to clear DTMF digits.
void	collectDigits(int maximumNumberOfDigits, String stopCharactersList, int durationTimeout, int digitTimeout)	Requests to collect DTMF digits and returns the digits through the event DigitsCollectedEvent.
void	collectDigits(int maximumNumberOfDigits, String stopCharactersList, int durationTimeout, int startTimeout, int digitTimeout)	Requests to collect DTMF digits and returns the digits through the event DigitsCollectedEvent.
CollectDigitsResult	collectDigitsSynchronous(int maximumNumberOfDigits, String stopCharactersList, int durationTimeout, int digitTimeout)	Requests to collect DTMF digits and returns the digits immediately.
CollectDigitsResult	collectDigitsSynchronous(int maximumNumberOfDigits, String stopCharactersList, int durationTimeout, int startTimeout, int digitTimeout)	Requests to collect DTMF digits and returns the digits immediately.
void	conference(boolean synchronous)	Performs a conference call between users.
void	dequeue(DequeueRequestReason reason, boolean synchronous)	Dequeues calls from the queue of the instance.
void	divert(String agentName, String extension, String campaignName, int directoryId, int contactProfileId, boolean differentInstance, Attribute[] attributes, byte[] blindData, boolean synchronous)	Diverts a call to another agent.
void	divert(String agentName, String extension, String campaignName, int directoryId, int contactProfileId, boolean differentInstance, Attribute[] attributes, byte[] blindData, DivertType divertType, boolean synchronous)	Diverts a call to another agent.
void	endReservation(boolean synchronous)	Ends the reservation.
void	enqueue(String[] agentNames, String campaignName, int directoryId, int contactProfileId, Attribute[] attributes, byte[] blindData, int priority, int handicap, String skillProfileName, SkillInProfile[] skills, boolean onlyIfAgentAvailable, Duration maxExpectedWaitingTime, boolean synchronous)	Enqueues calls in the queue of the instance.
void	enqueue(String agentName, String campaignName, int directoryId, int contactProfileId, Attribute[] attributes, byte[] blindData, int priority, int handicap, String skillProfileName, SkillInProfile[] skills, boolean onlyIfAgentAvailable, boolean synchronous)	Enqueues calls in the queue of the instance.
void	extend(String agentName, String number, String campaignName, int directoryId, int contactProfileId, boolean differentInstance, Attribute[] attributes, byte[] blindData, ExtendPurpose purpose, boolean synchronous)	Performs a phone and data extend operation.
String	getAcd()	The ACD.
PhoneMediaCanDo	getAllowedOperations()	Gets the allowed voice interaction operations.
byte[]	getBlindData()	The blind data.
PhoneInteractionData	getData()	Enumerated PhoneInteractionData with the data of the phone interaction.
String	getDialedNumber()	The dialed number.
String	getDnis()	The DNIS.
String	getInteractionKey()	The interaction key.
boolean	getIsEnqueued()	True if the interaction is enqueued.
boolean	getIsNewPending()	True if the interaction is new pending.
boolean	getIsRecording()	True if the interaction is being recorded.
boolean	getIsSuspended()	True if the interaction is suspended.
String	getNumber()	The Number of the phone.
String	getPbxDisplayName()	Returns the display name of the device related with IPhoneMedia.Number, configured in the PBX.
InteractionParties	getPrimaryParties()	Primary interaction parties.
QueueStatus	getQueueStatus()	Gets the information of the interaction in the queue.
InteractionParties	getSecondaryParties()	Secondary interaction parties.
PhoneInteractionState	getState()	Enumerated PhoneInteractionState with the phone state for the session.
SupervisedTransferType	getSupervisedTransferType()	Type of supervised transfer.
String	getTrunk()	The trunk.
String	getUcid()	Avaya UCID.
void	hangUp(boolean synchronous)	Hangs up a phone call.
void	hangUp(HangUpAction hangUpAction, boolean synchronous)	Hangs up a phone call.
void	hold(boolean synchronous)	Puts a phone call on hold.
void	monitor(String monitorDeviceNumber, String campaignName, boolean differentInstance, Attribute[] attributes, boolean fullParticipation, boolean synchronous)	Requests to monitor a phone operation (single step conference).
void	playMessage(String message, boolean stopIfDtmfDetected, MediaEncodingType encoding, MediaSampleRate sampleRate, MediaFileFormat fileFormat, boolean synchronous)	Plays a message.
void	playMessageAndCollectDigits(String message, boolean stopIfDtmfDetected, boolean startCollectingImmediately, int maximumNumberOfDigits, String stopCharactersList, int durationTimeout, int digitTimeout)	Plays a message and collect digits.
void	playMessageAndCollectDigits(String message, boolean stopIfDtmfDetected, int languageId, boolean playInLoop, boolean startCollectingImmediately, int maximumNumberOfDigits, String stopCharactersList, int durationTimeout, int startTimeout, int digitTimeout)	Plays a message and collect digits.
CollectDigitsResult	playMessageAndCollectDigitsSynchronous(String message, boolean stopIfDtmfDetected, boolean startCollectingImmediately, int maximumNumberOfDigits, String stopCharactersList, int durationTimeout, int digitTimeout)	Plays a message and collect digits.
CollectDigitsResult	playMessageAndCollectDigitsSynchronous(String message, boolean stopIfDtmfDetected, int languageId, boolean playInLoop, boolean startCollectingImmediately, int maximumNumberOfDigits, String stopCharactersList, int durationTimeout, int startTimeout, int digitTimeout)	Plays a message and collect digits.
void	playMusic(String promptToPlay)	Play music.
void	recordMessage(String repository, boolean playBeep, int maximumFileSize, int initialSilenceTimeout, int silenceTimeout, int durationTimeout, int maximumNumberOfDigits, String stopCharactersList, MediaEncodingType encoding, MediaSampleRate sampleRate, MediaFileFormat fileFormat, boolean synchronous)	Records a message.
void	refuseSupervisionRequest()	Refuse the supervise help.
void	removeDigitsCollectedListener(DigitsCollectedListener listener)	Unregisters the DigitsCollectedListener.
void	removeMessagePlayedAndDigitsCollectedListener(MessagePlayedAndDigitsCollectedListener listener)	Unregisters the MessagePlayedAndDigitsCollectedListener.
void	removePhoneErrorListener(PhoneErrorListener listener)	Unregisters the PhoneErrorListener.
void	removePhoneGenericDataReceivedListener(PhoneGenericDataReceivedListener listener)	Unregisters the PhoneGenericDataReceivedListener.
void	removePhoneListener(PhoneListener listener)	Unregisters the PhoneListener.
void	removePhoneMonitoredListener(PhoneMonitoredListener listener)	Unregisters the PhoneMonitoredListener.
void	removePhoneOperationStoppedListener(PhoneOperationStoppedListener listener)	Unregisters the PhoneOperationStoppedListener.
void	removePhoneProgressListener(PhoneProgressListener listener)	Unregisters the PhoneProgressListener.
void	requestSupervision()	Request supervision.
void	resumeEnqueue()	Requests to resume the enqueue.
void	retrieve(boolean synchronous)	Retrieves a phone call.
void	sendDigits(String digits)	Sends a sequence of digits.
void	sendGenericData(GenericDataType genericDataType, byte[] data)	Requests for a generic service.
void	startRecording(boolean synchronous, boolean withScreenCapture)	Records the phone call.
void	stopMediaOperation()	Stop media operation.
void	stopRecording(boolean synchronous)	Stops recording the phone call.
void	suspendEnqueue()	Requests to suspend the enqueue.
void	transfer(boolean synchronous)	Performs a phone transfer between agents.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Methods inherited from interface IInteractionMedia

answer, getInteractionId, getMediaId, getMediaType, getSession, getStartTime

Method Details

addDigitsCollectedListener

void addDigitsCollectedListener(DigitsCollectedListener listener)

Registers the DigitsCollectedListener.

Parameters:

listener - Event listener to add.

removeDigitsCollectedListener

void removeDigitsCollectedListener(DigitsCollectedListener listener)

Unregisters the DigitsCollectedListener.

Parameters:

listener - Event listener to remove.

addMessagePlayedAndDigitsCollectedListener

void addMessagePlayedAndDigitsCollectedListener(MessagePlayedAndDigitsCollectedListener listener)

Registers the MessagePlayedAndDigitsCollectedListener.

Parameters:

listener - Event listener to add.

removeMessagePlayedAndDigitsCollectedListener

void removeMessagePlayedAndDigitsCollectedListener(MessagePlayedAndDigitsCollectedListener listener)

Unregisters the MessagePlayedAndDigitsCollectedListener.

Parameters:

listener - Event listener to remove.

addPhoneErrorListener

void addPhoneErrorListener(PhoneErrorListener listener)

Registers the PhoneErrorListener.

Parameters:

listener - Event listener to add.

removePhoneErrorListener

void removePhoneErrorListener(PhoneErrorListener listener)

Unregisters the PhoneErrorListener.

Parameters:

listener - Event listener to remove.

addPhoneListener

void addPhoneListener(PhoneListener listener)

Registers the PhoneListener.

Parameters:

listener - Event listener to add.

removePhoneListener

void removePhoneListener(PhoneListener listener)

Unregisters the PhoneListener.

Parameters:

listener - Event listener to remove.

addPhoneGenericDataReceivedListener

void addPhoneGenericDataReceivedListener(PhoneGenericDataReceivedListener listener)

Registers the PhoneGenericDataReceivedListener.

Parameters:

listener - Event listener to add.

removePhoneGenericDataReceivedListener

void removePhoneGenericDataReceivedListener(PhoneGenericDataReceivedListener listener)

Unregisters the PhoneGenericDataReceivedListener.

Parameters:

listener - Event listener to remove.

addPhoneMonitoredListener

void addPhoneMonitoredListener(PhoneMonitoredListener listener)

Registers the PhoneMonitoredListener.

Parameters:

listener - Event listener to add.

removePhoneMonitoredListener

void removePhoneMonitoredListener(PhoneMonitoredListener listener)

Unregisters the PhoneMonitoredListener.

Parameters:

listener - Event listener to remove.

addPhoneOperationStoppedListener

void addPhoneOperationStoppedListener(PhoneOperationStoppedListener listener)

Registers the PhoneOperationStoppedListener.

Parameters:

listener - Event listener to add.

removePhoneOperationStoppedListener

void removePhoneOperationStoppedListener(PhoneOperationStoppedListener listener)

Unregisters the PhoneOperationStoppedListener.

Parameters:

listener - Event listener to remove.

addPhoneProgressListener

void addPhoneProgressListener(PhoneProgressListener listener)

Registers the PhoneProgressListener.

Parameters:

listener - Event listener to add.

removePhoneProgressListener

void removePhoneProgressListener(PhoneProgressListener listener)

Unregisters the PhoneProgressListener.

Parameters:

listener - Event listener to remove.

answerSupervisionRequest

void answerSupervisionRequest(SupervisionMode supervisionMode)
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Answer the supervise request

Parameters:

supervisionMode - Mode of supervison request.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

blindTransfer

void blindTransfer(String agentName,
 String number,
 String campaignName,
 int directoryId,
 int contactProfileId,
 boolean differentInstance,
 Attribute[] attributes,
 byte[] blindData,
 BlindTransferMode blindTransferMode,
 boolean synchronous)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Performs a phone and data blind transfer between agents.

Parameters:

agentName - Identifier of the agent that receives the call. The value can be NULL.

number - Number to where the call is transferred. The value can be NULL.

campaignName - Name of the destination campaign. The value can be NULL.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

differentInstance - If true, the transference has a different instance as destination.

attributes - Attributes transferred with the phone call. The value can be NULL.

blindData - Data stream transferred with the phone call. The value can be NULL.

blindTransferMode - Mode of the blind transfer.

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

cancelSupervisionRequest

void cancelSupervisionRequest()
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Cancel supervision request.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

clear

void clear(boolean synchronous)
    throws Exception,
altitude.integrationServer.exceptions.ISException

Clears the call profile.

Parameters:

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

clearDigits

void clearDigits()
          throws Exception,
altitude.integrationServer.exceptions.ISException

Requests to clear DTMF digits.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

collectDigits

void collectDigits(int maximumNumberOfDigits,
 String stopCharactersList,
 int durationTimeout,
 int digitTimeout)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Requests to collect DTMF digits and returns the digits through the event DigitsCollectedEvent.

Parameters:

maximumNumberOfDigits - Maximum number of digits to collect.

stopCharactersList - List with the characters that stop the operation.

durationTimeout - Duration of the collect operation.

digitTimeout - Digit input timeout.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

collectDigits

void collectDigits(int maximumNumberOfDigits,
 String stopCharactersList,
 int durationTimeout,
 int startTimeout,
 int digitTimeout)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Requests to collect DTMF digits and returns the digits through the event DigitsCollectedEvent.

Parameters:

maximumNumberOfDigits - Maximum number of digits to collect.

stopCharactersList - List with the characters that stop the operation.

durationTimeout - Duration of the collect operation.

startTimeout - Start timeout.

digitTimeout - Digit input timeout.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

collectDigitsSynchronous

CollectDigitsResult collectDigitsSynchronous(int maximumNumberOfDigits,
 String stopCharactersList,
 int durationTimeout,
 int digitTimeout)
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Requests to collect DTMF digits and returns the digits immediately.

Parameters:

maximumNumberOfDigits - Maximum number of digits to collect.

stopCharactersList - List with the characters that stop the operation.

durationTimeout - Duration of the collect operation.

digitTimeout - Digit input timeout.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

collectDigitsSynchronous

CollectDigitsResult collectDigitsSynchronous(int maximumNumberOfDigits,
 String stopCharactersList,
 int durationTimeout,
 int startTimeout,
 int digitTimeout)
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Requests to collect DTMF digits and returns the digits immediately.

Parameters:

maximumNumberOfDigits - Maximum number of digits to collect.

stopCharactersList - List with the characters that stop the operation.

durationTimeout - Duration of the collect operation.

startTimeout - Start timeout.

digitTimeout - Digit input timeout.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

conference

void conference(boolean synchronous)
         throws Exception,
altitude.integrationServer.exceptions.ISException

Performs a conference call between users.

Parameters:

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

dequeue

void dequeue(DequeueRequestReason reason,
 boolean synchronous)
      throws Exception,
altitude.integrationServer.exceptions.ISException

Dequeues calls from the queue of the instance.

Parameters:

reason - DequeueRequestReason with the reason to dequeue the call.

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

divert

void divert(String agentName,
 String extension,
 String campaignName,
 int directoryId,
 int contactProfileId,
 boolean differentInstance,
 Attribute[] attributes,
 byte[] blindData,
 boolean synchronous)
     throws Exception,
altitude.integrationServer.exceptions.ISException

Diverts a call to another agent.

Parameters:

agentName - Identifier of the agent that diverts the call. The value can be Null.

extension - Extension where to divert the call. The value can be NULL.

campaignName - Name of the destination campaign. The value can be NULL.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

differentInstance - If true, the transference has a different instance as destination.

attributes - Attributes to send with the phone call. The value can be NULL.

blindData - Data stream transferred with the phone call. The value can be NULL.

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

divert

void divert(String agentName,
 String extension,
 String campaignName,
 int directoryId,
 int contactProfileId,
 boolean differentInstance,
 Attribute[] attributes,
 byte[] blindData,
 DivertType divertType,
 boolean synchronous)
     throws Exception,
altitude.integrationServer.exceptions.ISException

Diverts a call to another agent.

Parameters:

agentName - Identifier of the agent that diverts the call. The value can be Null.

extension - Extension where to divert the call. The value can be NULL.

campaignName - Name of the destination campaign. The value can be NULL.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

differentInstance - If true, the transference has a different instance as destination.

attributes - Attributes to send with the phone call. The value can be NULL.

blindData - Data stream transferred with the phone call. The value can be NULL.

divertType - Type of the divert.

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

endReservation

void endReservation(boolean synchronous)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Ends the reservation.

Parameters:

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

enqueue

void enqueue(String agentName,
 String campaignName,
 int directoryId,
 int contactProfileId,
 Attribute[] attributes,
 byte[] blindData,
 int priority,
 int handicap,
 String skillProfileName,
 SkillInProfile[] skills,
 boolean onlyIfAgentAvailable,
 boolean synchronous)
      throws Exception,
altitude.integrationServer.exceptions.ISException

Enqueues calls in the queue of the instance.

Parameters:

agentName - Identifier of the agent that receives the call. The value can be NULL.

campaignName - Mandatory. Name of the campaign that receives the call.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

attributes - Attributes to send with the phone call. The value can be NULL.

blindData - External data to send with the call.

priority - Relative priority associated with the enqueued call.

handicap - Handicap associated with the enqueued call.

skillProfileName - The skill profile name used by the server in skills-based phone routing. The value can be NULL.

skills - Optional agent skills required to handle the call, used by the server in skills-based phone routing. This parameter will be ignored if the skillProfileName is specified.

onlyIfAgentAvailable - If true, only enqueue the call if an agent is available.

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

enqueue

void enqueue(String[] agentNames,
 String campaignName,
 int directoryId,
 int contactProfileId,
 Attribute[] attributes,
 byte[] blindData,
 int priority,
 int handicap,
 String skillProfileName,
 SkillInProfile[] skills,
 boolean onlyIfAgentAvailable,
 Duration maxExpectedWaitingTime,
 boolean synchronous)
      throws Exception,
altitude.integrationServer.exceptions.ISException

Enqueues calls in the queue of the instance.

Parameters:

agentNames - Identifiers of the agents that receives the calls. The value can be NULL.

campaignName - Mandatory. Name of the campaign that receives the call.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

attributes - Attributes to send with the phone call. The value can be NULL.

blindData - External data to send with the call.

priority - Relative priority associated with the enqueued call.

handicap - Handicap associated with the enqueued call.

skillProfileName - The skill profile name used by the server in skills-based phone routing. The value can be NULL.

skills - Optional agent skills required to handle the call, used by the server in skills-based phone routing. This parameter will be ignored if the skillProfileName is specified.

onlyIfAgentAvailable - If true, only enqueue the call if an agent is available.

maxExpectedWaitingTime - Maximum expected waiting time.

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

extend

void extend(String agentName,
 String number,
 String campaignName,
 int directoryId,
 int contactProfileId,
 boolean differentInstance,
 Attribute[] attributes,
 byte[] blindData,
 ExtendPurpose purpose,
 boolean synchronous)
     throws Exception,
altitude.integrationServer.exceptions.ISException

Performs a phone and data extend operation.

Parameters:

agentName - Identifier of the agent that receives the call. The value can be NULL.

number - Number of the destination agent. The value can be NULL.

campaignName - Campaign to send the campaign script of the call. The value can be NULL.

directoryId - Identifier of the directory.

contactProfileId - Identifier of the contact profile.

differentInstance - If true, the operation extend has a different instance as destination.

attributes - Attributes to transfer with the phone call. The value can be NULL.

blindData - Data stream transferred with the phone call. The value can be NULL.

purpose - Purpose of the operation extend. Required by some switches.

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAcd

String getAcd()
       throws Exception,
altitude.integrationServer.exceptions.ISException

The ACD.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getAllowedOperations

PhoneMediaCanDo getAllowedOperations()
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the allowed voice interaction operations.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getBlindData

byte[] getBlindData()
             throws Exception,
altitude.integrationServer.exceptions.ISException

The blind data.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getData

PhoneInteractionData getData()
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Enumerated PhoneInteractionData with the data of the phone interaction.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDialedNumber

String getDialedNumber()
                throws Exception,
altitude.integrationServer.exceptions.ISException

The dialed number.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDnis

String getDnis()
        throws Exception,
altitude.integrationServer.exceptions.ISException

The DNIS.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInteractionKey

String getInteractionKey()
                  throws Exception,
altitude.integrationServer.exceptions.ISException

The interaction key.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getIsEnqueued

boolean getIsEnqueued()
               throws Exception,
altitude.integrationServer.exceptions.ISException

True if the interaction is enqueued.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getIsNewPending

boolean getIsNewPending()
                 throws Exception,
altitude.integrationServer.exceptions.ISException

True if the interaction is new pending.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getIsRecording

boolean getIsRecording()
                throws Exception,
altitude.integrationServer.exceptions.ISException

True if the interaction is being recorded.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getIsSuspended

boolean getIsSuspended()
                throws Exception,
altitude.integrationServer.exceptions.ISException

True if the interaction is suspended.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getNumber

String getNumber()
          throws Exception,
altitude.integrationServer.exceptions.ISException

The Number of the phone.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPbxDisplayName

String getPbxDisplayName()
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Returns the display name of the device related with IPhoneMedia.Number, configured in the PBX. Currently this property only applies to OXE PBX types. Returns null on all other PBX types, or if the display name is not configured.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getPrimaryParties

InteractionParties getPrimaryParties()
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Primary interaction parties.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getQueueStatus

QueueStatus getQueueStatus()
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the information of the interaction in the queue.

Returns:

QueueStatus with the requested information.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSecondaryParties

InteractionParties getSecondaryParties()
                                throws Exception,
altitude.integrationServer.exceptions.ISException

Secondary interaction parties.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getState

PhoneInteractionState getState()
                        throws Exception,
altitude.integrationServer.exceptions.ISException

Enumerated PhoneInteractionState with the phone state for the session.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getSupervisedTransferType

SupervisedTransferType getSupervisedTransferType()
                                          throws Exception,
altitude.integrationServer.exceptions.ISException

Type of supervised transfer.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getTrunk

String getTrunk()
         throws Exception,
altitude.integrationServer.exceptions.ISException

The trunk.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getUcid

String getUcid()
        throws Exception,
altitude.integrationServer.exceptions.ISException

Avaya UCID.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

hangUp

void hangUp(boolean synchronous)
     throws Exception,
altitude.integrationServer.exceptions.ISException

Hangs up a phone call.

Parameters:

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

hangUp

void hangUp(HangUpAction hangUpAction,
 boolean synchronous)
     throws Exception,
altitude.integrationServer.exceptions.ISException

Hangs up a phone call.

Parameters:

hangUpAction - Action to take on hang up.

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

hold

void hold(boolean synchronous)
   throws Exception,
altitude.integrationServer.exceptions.ISException

Puts a phone call on hold.

Parameters:

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

monitor

void monitor(String monitorDeviceNumber,
 String campaignName,
 boolean differentInstance,
 Attribute[] attributes,
 boolean fullParticipation,
 boolean synchronous)
      throws Exception,
altitude.integrationServer.exceptions.ISException

Requests to monitor a phone operation (single step conference).

Parameters:

monitorDeviceNumber - The agent (ivr) destination number.

campaignName - Used to force the destination campaign.

differentInstance - If true, the target campaign is remote.

attributes - Attributes to send with the phone call. The value can be NULL.

fullParticipation - If true, the operation will be visible to everyone and the new agent can listen/talk. If false, the joining agent will only be able to listen and will be invisible to the other agent.

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

playMessage

void playMessage(String message,
 boolean stopIfDtmfDetected,
 MediaEncodingType encoding,
 MediaSampleRate sampleRate,
 MediaFileFormat fileFormat,
 boolean synchronous)
          throws Exception,
altitude.integrationServer.exceptions.ISException

Plays a message.

Parameters:

message - Path of the file with the message to play.

stopIfDtmfDetected - Stop if a dual-tone multi-frequency is detected.

encoding - The encoding type of the message.

sampleRate - The sample rate of the message.

fileFormat - The format of the message.

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

playMessageAndCollectDigits

void playMessageAndCollectDigits(String message,
 boolean stopIfDtmfDetected,
 boolean startCollectingImmediately,
 int maximumNumberOfDigits,
 String stopCharactersList,
 int durationTimeout,
 int digitTimeout)
                          throws Exception,
altitude.integrationServer.exceptions.ISException

Plays a message and collect digits.

Parameters:

message - Path of the message to play.

stopIfDtmfDetected - If true the operation ends when a DTMF is detected.

startCollectingImmediately - If true the digits are started to be collected when the message is played.

maximumNumberOfDigits - The maximum number of digits collected.

stopCharactersList - The list of the characters that end the operation.

durationTimeout - The maximum number of milliseconds of the operation.

digitTimeout - The maximum number of milliseconds to wait for a digit.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

playMessageAndCollectDigits

void playMessageAndCollectDigits(String message,
 boolean stopIfDtmfDetected,
 int languageId,
 boolean playInLoop,
 boolean startCollectingImmediately,
 int maximumNumberOfDigits,
 String stopCharactersList,
 int durationTimeout,
 int startTimeout,
 int digitTimeout)
                          throws Exception,
altitude.integrationServer.exceptions.ISException

Plays a message and collect digits.

Parameters:

message - Path of the message to play.

stopIfDtmfDetected - If true the operation ends when a DTMF is detected.

languageId - Identifier of the language.

playInLoop - If true the message plays in loop.

startCollectingImmediately - If true the digits are started to be collected when the message is played.

maximumNumberOfDigits - The maximum number of digits collected.

stopCharactersList - The list of the characters that end the operation.

durationTimeout - The maximum number of milliseconds of the operation.

startTimeout - The maximum number of milliseconds to start the operation.

digitTimeout - The maximum number of milliseconds to wait for a digit.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

playMessageAndCollectDigitsSynchronous

CollectDigitsResult playMessageAndCollectDigitsSynchronous(String message,
 boolean stopIfDtmfDetected,
 boolean startCollectingImmediately,
 int maximumNumberOfDigits,
 String stopCharactersList,
 int durationTimeout,
 int digitTimeout)
                                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Plays a message and collect digits.

Parameters:

message - Path of the message to play.

stopIfDtmfDetected - If true the operation ends if a DTMF is detected.

startCollectingImmediately - If true the digits are started to be collected when the message is played.

maximumNumberOfDigits - The maximum number of digits collected.

stopCharactersList - The list of the characters that end the operation.

durationTimeout - The maximum number of milliseconds of the operation.

digitTimeout - The maximum number of milliseconds to wait for a digit.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

playMessageAndCollectDigitsSynchronous

CollectDigitsResult playMessageAndCollectDigitsSynchronous(String message,
 boolean stopIfDtmfDetected,
 int languageId,
 boolean playInLoop,
 boolean startCollectingImmediately,
 int maximumNumberOfDigits,
 String stopCharactersList,
 int durationTimeout,
 int startTimeout,
 int digitTimeout)
                                                    throws Exception,
altitude.integrationServer.exceptions.ISException

Plays a message and collect digits.

Parameters:

message - Path of the message to play.

stopIfDtmfDetected - If true the operation ends if a DTMF is detected.

languageId - Identifier of the language.

playInLoop - If true the message plays in loop.

startCollectingImmediately - If true the digits are started to be collected when the message is played.

maximumNumberOfDigits - The maximum number of digits collected.

stopCharactersList - The list of the characters that end the operation.

durationTimeout - The maximum number of milliseconds of the operation.

startTimeout - The maximum number of milliseconds to start the operation.

digitTimeout - The maximum number of milliseconds to wait for a digit.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

playMusic

void playMusic(String promptToPlay)
        throws Exception,
altitude.integrationServer.exceptions.ISException

Play music.

Parameters:

promptToPlay - Prompt to play.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

recordMessage

void recordMessage(String repository,
 boolean playBeep,
 int maximumFileSize,
 int initialSilenceTimeout,
 int silenceTimeout,
 int durationTimeout,
 int maximumNumberOfDigits,
 String stopCharactersList,
 MediaEncodingType encoding,
 MediaSampleRate sampleRate,
 MediaFileFormat fileFormat,
 boolean synchronous)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Records a message.

Parameters:

repository - Path of the location to store the message file.

playBeep - If true a beep is played when record starts.

maximumFileSize - The maximum number of bytes to record.

initialSilenceTimeout - The maximum milliseconds of silence allowed at the beginning of record.

silenceTimeout - The number of milliseconds of silence that ends the operation.

durationTimeout - The maximum number of milliseconds of the message.

maximumNumberOfDigits - The maximum number of digits collected to end the operation.

stopCharactersList - The list of the characters that end the operation.

encoding - The encoding of the message file.

sampleRate - The sample rate to record.

fileFormat - The format of the message file.

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

refuseSupervisionRequest

void refuseSupervisionRequest()
                       throws Exception,
altitude.integrationServer.exceptions.ISException

Refuse the supervise help.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

requestSupervision

void requestSupervision()
                 throws Exception,
altitude.integrationServer.exceptions.ISException

Request supervision.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

resumeEnqueue

void resumeEnqueue()
            throws Exception,
altitude.integrationServer.exceptions.ISException

Requests to resume the enqueue.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

retrieve

void retrieve(boolean synchronous)
       throws Exception,
altitude.integrationServer.exceptions.ISException

Retrieves a phone call.

Parameters:

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

sendDigits

void sendDigits(String digits)
         throws Exception,
altitude.integrationServer.exceptions.ISException

Sends a sequence of digits.

Parameters:

digits - Phone tones.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

sendGenericData

void sendGenericData(GenericDataType genericDataType,
 byte[] data)
              throws Exception,
altitude.integrationServer.exceptions.ISException

Requests for a generic service.

Parameters:

genericDataType - Generic service type.

data - Data stream sent with the call not valid for the instance. The value can be NULL.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

startRecording

void startRecording(boolean synchronous,
 boolean withScreenCapture)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Records the phone call.

Parameters:

synchronous - If true, the method is synchronous.

withScreenCapture - If true, records the screen of the agent.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

stopMediaOperation

void stopMediaOperation()
                 throws Exception,
altitude.integrationServer.exceptions.ISException

Stop media operation.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

stopRecording

void stopRecording(boolean synchronous)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Stops recording the phone call.

Parameters:

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

suspendEnqueue

void suspendEnqueue()
             throws Exception,
altitude.integrationServer.exceptions.ISException

Requests to suspend the enqueue.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

transfer

void transfer(boolean synchronous)
       throws Exception,
altitude.integrationServer.exceptions.ISException

Performs a phone transfer between agents.

Parameters:

synchronous - If true, the method is synchronous.

Throws:

Exception

altitude.integrationServer.exceptions.ISException