com.genesyslab.ail
Interface InteractionVoice

All Superinterfaces:
AbstractInteraction, IdObject, Interaction, Possible, Savable
All Known Subinterfaces:
InteractionVoiceCallback, InteractionVoiceOutbound

public interface InteractionVoice
extends Interaction

A voice interaction.

This interface is for managing a phone call. It provides the following actions, depending on the capabilities of the underlying switch:

For details about these features, see the corresponding methods. Use TExtensions parameters to fine-tune your calls with switch-specific data.

To get instances of this interface, your application can:

To receive InteractionEvent events for new and ringing voice interactions, use a listener inheriting InteractionListener. See DnListener, PlaceListener, and AgentListener. For a new phone call, your application receives an InteractionEvent for an interaction that has an Interaction.Status.NEW status. For a ringing call, your application receives an InteractionEvent for an interaction that has an Interaction.Status.RINGING status.

To determine which actions are available at a certain time, test the corresponding InteractionVoice.Action value by calling the isPossible method. For example, use the possible actions to activate or deactivate buttons that make calls to the corresponding InteractionVoice methods.

Actions on the voice interaction generate InteractionEvent events. For example, these events propagate the interactions' status, changes in the possible actions, or changes in the attached data. Your application can listen for these events and update its state accordingly.

To get the InteractionEvent events of this InteractionVoice interface, you can implement and add an InteractionListener, as shown in the following code snippet.

public class SimpleInteractionVoiceExample implements InteractionListener
{
    public SimpleInteractionVoiceExample(InteractionVoice exampleInteractionVoice)
    {
        //Adding the listener
        exampleInteractionVoice.addInteractionListener(this);
    }
    //Implementation of the listener methods
    //...
    public void handleInteractionEvent(InteractionEvent event)
    {
        //Implement this method to refresh your application
        //with the new interaction information.
    }
    //...
}

Note: If your application adds a listener to this InteractionVoice interface, it can monitor only this voice interaction. To monitor several interactions, see Agent, Place, and Dn interfaces.

InteractionEvent events can propagate AIL extensions depending on the action to which they are related. For example, if the InteractionEvent event notifies a new interaction due to a transfer, your application can get the reason for the call transfer in the AIL extensions.

See Also:
InteractionEvent.Extension, InteractionEvent.getExtensions()

Nested Class Summary
static class InteractionVoice.Action
          Enum for the actions that are possible on this interaction.
static class InteractionVoice.CallType
          Enum for the type of the phone call.
static class InteractionVoice.MakeCallType
          Enum for the type of phone call to make.
static class InteractionVoice.NetworkStatus
          Enum the possible network status of an interaction.
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.Interaction
Interaction.Status, Interaction.Type
 
Nested classes/interfaces inherited from interface com.genesyslab.ail.AbstractInteraction
AbstractInteraction.AbstractCallType
 
Method Summary
 void acceptPreview(java.util.Map tReasons, java.util.Map tExtensions)
          Accepts a preview interaction.
 void alternateCall(InteractionVoice otherInteraction, java.util.Map reasons, java.util.Map tExtensions)
          Alternates between this call and another given call.
 void alternateCall(java.util.Map reasons)
          Deprecated. Use alternateCall( Map, Map ).
 void alternateCall(java.util.Map reasons, java.util.Map tExtensions)
          Alternates between this call and a held call.
 void answerCall(java.util.Map reasons, java.util.Map tExtensions)
          Answers this call.
 void completeConference(InteractionVoice otherInteraction, java.util.Map reasons, java.util.Map tExtensions)
          Completes the conference.
 void completeConference(java.util.Map reasons)
          Deprecated. Use completeConference( Map, Map ).
 void completeConference(java.util.Map reasons, java.util.Map tExtensions)
          Completes the conference.
 void completeTransfer(InteractionVoice other, java.util.Map reasons, java.util.Map tExtensions)
          Completes the transfer between this interaction and the specified interaction.
 void completeTransfer(java.util.Map reasons)
          Deprecated. Use completeTransfer( Map, Map ).
 void completeTransfer(java.util.Map reasons, java.util.Map tExtensions)
          Completes the transfer.
 void deleteFromConference(java.lang.String dn, java.util.Map reasons)
          Deprecated. Use deleteFromConference( String, Map, Map ).
 void deleteFromConference(java.lang.String dn, java.util.Map reasons, java.util.Map tExtensions)
          Deletes a party from the conference.
 java.lang.String getANI()
          Returns the ANI (Automatic Number Identification) parameter associated with this phone call.
 InteractionVoice.CallType getCallType()
          Returns the call type of this interaction.
 java.lang.String getConferenceOwner()
          Deprecated. Not accurate, use isConferenceOwner() instead.
 java.util.Collection getConsultationInteractions()
          Returns the consultation calls of this interaction.
 Dn getDn()
          Returns the DN to which this interaction is bound.
 java.lang.String getDNIS()
          Returns the DNIS (Dialed Number Identification Service) parameter associated with this phone call.
 int getDuration()
          Returns the duration of this call.
 java.lang.String getHomeLocation()
          Returns the location this phone call comes from.
 InteractionVoice getInitialInteraction()
          If this interaction is a consultation call, returns the initial or parent interaction.
 java.lang.String getNetworkLocation()
          Returns this interaction's network location.
 java.lang.String getNetworkParty()
          Returns this interaction's NAT/C (Network Attended Transfer/Conference) party.
 InteractionVoice.NetworkStatus getNetworkStatus()
          Returns this interaction's NAT/C (Network Attended Transfer/Conference) status.
 java.util.Set getParties()
          Returns all the parties of this call.
 java.lang.String getPhoneNumber()
          Returns the phone numbers to which this interaction has been connected.
 java.lang.String getPhysicalDnId()
          Returns the ID of the DN on which this interaction physically is in the Switch.
 int getTCallId()
          Returns the internal switch call ID of this interaction or -1 if it is not available.
 int getTrunk()
          Returns the Trunk parameter associated with this phone call.
 void holdCall(java.util.Map reasons)
          Deprecated. Use holdCall( Map, Map ).
 void holdCall(java.util.Map reasons, java.util.Map tExtensions)
          Holds this call so that it can be retrieved later.
 InteractionVoice initiateConference(InteractionVoice consult, java.lang.String otherDn, java.lang.String location, java.util.Map attachedData, java.util.Map reasons, java.util.Map tExtensions)
          Initiates a conference on an existing NEW consult interaction.
 InteractionVoice initiateConference(java.lang.String otherDn, java.lang.String location, java.util.Map reasons)
          Deprecated. Use initiateConference( String, String, Map, Map, Map ).
 InteractionVoice initiateConference(java.lang.String otherDn, java.lang.String location, java.util.Map reasons, java.util.Map tExtensions)
          Deprecated. Use initiateConference( String, String, Map, Map, Map ).
 InteractionVoice initiateConference(java.lang.String otherDn, java.lang.String location, java.util.Map attachedData, java.util.Map reasons, java.util.Map tExtensions)
          Initiates a conference.
 InteractionVoice initiateTransfer(InteractionVoice consult, java.lang.String otherDn, java.lang.String location, java.lang.String reason, java.util.Map attachedData, java.util.Map reasons, java.util.Map tExtensions)
          Initiates a transfer on an existing NEW consult interaction.
 InteractionVoice initiateTransfer(java.lang.String otherDn, java.lang.String location, java.lang.String reason, java.util.Map reasons)
          Deprecated. Use initiateTransfer( String, String, String, Map, Map, Map ).
 InteractionVoice initiateTransfer(java.lang.String otherDn, java.lang.String location, java.lang.String reason, java.util.Map reasons, java.util.Map tExtensions)
          Deprecated. Use initiateTransfer( String, String, String, Map, Map, Map ).
 InteractionVoice initiateTransfer(java.lang.String otherDn, java.lang.String location, java.lang.String reason, java.util.Map attachedData, java.util.Map reasons, java.util.Map tExtensions)
          Initiates a transfer.
 boolean isBridged()
          Returns true if this interaction status is bridged.
 java.lang.Boolean isConferenceOwner()
          Indicates if this party has initiated the conference.
 boolean isDualStepPossible()
          Deprecated. Use Possible.isPossible(com.genesyslab.ail.Enum) instead.
 java.lang.Boolean isIncoming()
          Returns the direction of this call.
 boolean isNetworkControllingParty()
          Returns true if this interaction is the controlling party in a network attended transfer or conference consultation.
 boolean isSingleStepPossible()
          Deprecated. Use Possible.isPossible(com.genesyslab.ail.Enum) instead.
 void leaveConference(java.util.Map reasons)
          Deprecated. Use leaveConference( Map, Map ).
 void leaveConference(java.util.Map reasons, java.util.Map tExtensions)
          Leaves the conference.
 void listenDisconnect(java.lang.String dn, java.util.Map reasons, java.util.Map tExtensions)
          Plays 'music on hold' to a party in the conference.
 void listenReconnect(java.lang.String dn, java.util.Map reasons, java.util.Map tExtensions)
          Cancels 'music on hold' to a party in the conference.
 void makeCall(java.lang.String dn, java.lang.String location, InteractionVoice.MakeCallType callType, java.util.Map attachedData, java.util.Map reasons)
          Deprecated. Use makeCall( String, String, InteractionVoice.MakeCallType, Map, Map, Map ).
 void makeCall(java.lang.String dn, java.lang.String location, InteractionVoice.MakeCallType callType, java.util.Map attachedData, java.util.Map reasons, java.util.Map tExtensions)
          Dials a number on a new interaction.
 void muteOff(java.util.Map reasons, java.util.Map tExtensions)
          Cancels call muting (enables the microphone).
 void muteOn(java.util.Map reasons, java.util.Map tExtensions)
          Mutes this call (disables the microphone).
 void muteTransfer(java.lang.String otherDn, java.lang.String location, java.lang.String reason, java.util.Map reasons)
          Deprecated. Use muteTransfer( String, String, String, Map, Map, Map ).
 void muteTransfer(java.lang.String otherDn, java.lang.String location, java.lang.String reason, java.util.Map reasons, java.util.Map tExtensions)
          Deprecated. Use muteTransfer( String, String, String, Map, Map, Map ).
 void muteTransfer(java.lang.String otherDn, java.lang.String location, java.lang.String reason, java.util.Map attachedData, java.util.Map reasons, java.util.Map tExtensions)
          Directly transfers this call.
 void networkAlternate(java.util.Map reasons, java.util.Map tExtensions)
          Alternates between the network consult party and the external party.
 void networkConference(java.util.Map reasons, java.util.Map tExtensions)
          Merges the network consult call and the external call into a network conference.
 void networkConsult(java.lang.String destination, java.lang.String location, java.util.Map reasons, java.util.Map tExtensions)
          Initiates a consultation call through the network.
 void networkReconnect(java.util.Map reasons, java.util.Map tExtensions)
          Releases the network consult party and reconnects to the original external party.
 void networkSingleStepTransfer(java.lang.String destination, java.lang.String location, java.util.Map reasons, java.util.Map tExtensions)
          Initiates a single step transfer through the network.
 void networkTransfer(java.util.Map reasons, java.util.Map tExtensions)
          Transfers this call to the network consult party.
 void reconnectCall(InteractionVoice otherInteraction, java.util.Map reasons, java.util.Map tExtensions)
          Reconnects this held call and releases another active call.
 void reconnectCall(java.util.Map reasons)
          Deprecated. Use reconnectCall( Map, Map ).
 void reconnectCall(java.util.Map reasons, java.util.Map tExtensions)
          Reconnects this held call and releases another active call.
 void redirectCall(java.lang.String destination, java.util.Map reasons)
          Deprecated. Use redirectCall( String, Map, Map ).
 void redirectCall(java.lang.String destination, java.util.Map reasons, java.util.Map tExtensions)
          Redirects this call.
 void rejectPreview(java.util.Map tReasons, java.util.Map tExtensions)
          Rejects a preview interaction.
 void releaseCall(java.util.Map reasons, java.util.Map tExtensions)
          Releases this call.
 void retrieveCall(java.util.Map reasons)
          Deprecated. Use retrieveCall( Map, Map ).
 void retrieveCall(java.util.Map reasons, java.util.Map tExtensions)
          Retrieves a call that was held.
 void sendDTMF(java.lang.String digits, java.util.Map reasons)
          Deprecated. Use sendDTMF( String, Map, Map ).
 void sendDTMF(java.lang.String digits, java.util.Map reasons, java.util.Map tExtensions)
          Sends digits as DTMF tones on this phones call.
 void setAttachedData(java.lang.String key, java.lang.Object value)
          Sets an attached key-value pair.
 void singleStepConference(java.lang.String otherDn, java.lang.String location, java.util.Map reasons)
          Deprecated. Use singleStepConference( String, String, Map, Map, Map ).
 void singleStepConference(java.lang.String otherDn, java.lang.String location, java.util.Map reasons, java.util.Map tExtensions)
          Deprecated. Use singleStepConference( String, String, Map, Map, Map ).
 void singleStepConference(java.lang.String otherDn, java.lang.String location, java.util.Map attachedData, java.util.Map reasons, java.util.Map tExtensions)
          Conferences this call in one step.
 void singleStepTransfer(java.lang.String otherDn, java.lang.String location, java.lang.String reason, java.util.Map reasons)
          Deprecated. Use singleStepTransfer( String, String, String, Map, Map, Map ).
 void singleStepTransfer(java.lang.String otherDn, java.lang.String location, java.lang.String reason, java.util.Map reasons, java.util.Map tExtensions)
          Deprecated. Use singleStepTransfer( String, String, String, Map, Map, Map ).
 void singleStepTransfer(java.lang.String otherDn, java.lang.String location, java.lang.String reason, java.util.Map attachedData, java.util.Map reasons, java.util.Map tExtensions)
          Transfers this call in one step.
 
Methods inherited from interface com.genesyslab.ail.Interaction
answerCall, countOtherPendingInteractions, getContactId, getContentBinary, getContentBinaryMimeType, getContentBinarySize, getDateCreated, getEndDate, getMedia, getNotepad, getParentInteraction, getPlace, getQueue, getStatus, getStructTextMimeType, getStructuredText, getSubject, getText, getType, getUserName, isDone, markDone, merge, releaseCall, save, setContactId, setContentBinary, setContentBinaryMimeType, setContentBinarySize, setNotepad, setStructTextMimeType, setStructuredText, setSubject, setText
 
Methods inherited from interface com.genesyslab.ail.AbstractInteraction
addInteractionListener, getAttachedData, getAttachedData, getAttachedDataEx, getTConnectionId, queryStatus, removeAttachedData, removeInteractionListener, saveAttachedData, setAttachedData
 
Methods inherited from interface com.genesyslab.ail.Possible
arePossible, isPossible
 
Methods inherited from interface com.genesyslab.ail.Savable
getContactServerId, isDirty
 

Method Detail

getCallType

InteractionVoice.CallType getCallType()
Returns the call type of this interaction.


getTCallId

int getTCallId()
Returns the internal switch call ID of this interaction or -1 if it is not available.


getDn

Dn getDn()
Returns the DN to which this interaction is bound.

Specified by:
getDn in interface Interaction
Returns:
null for multimedia interactions.

getPhysicalDnId

java.lang.String getPhysicalDnId()
Returns the ID of the DN on which this interaction physically is in the Switch.


getParties

java.util.Set getParties()
Returns all the parties of this call. A party can be Use this method when the phone call is active. When the phone call is in the History, use getPhoneNumber(). Please note that, as a limitation, this method returns no more than two parties, even if this call involves four or more parties.

Returns:
all the parties as a set of String. Can be empty if no party is present.

getConferenceOwner

java.lang.String getConferenceOwner()
Deprecated. Not accurate, use isConferenceOwner() instead.

Returns the party that has initiated the conference. It is called 'conference owner'. If this interaction is not a conference, returns null. It may also be null in case the conference was already initiated when the AIL was launched.

Returns:
the phone number of the owner of the conference

isConferenceOwner

java.lang.Boolean isConferenceOwner()
Indicates if this party has initiated the conference.

Returns:
  • Boolean.TRUE if this party is the conference owner.
  • Boolean.FALSE if this party is in conference but not the owner.
  • null if this party is not in conference.

isBridged

boolean isBridged()
Returns true if this interaction status is bridged. Interactions initiated by supervisor monitoring are bridged.


isIncoming

java.lang.Boolean isIncoming()
Returns the direction of this call. Boolean.FALSE means that this interaction was initiated by this agent, Boolean.TRUE means that this agent was called through this interaction. null means that the direction could not be determined.


getPhoneNumber

java.lang.String getPhoneNumber()
Returns the phone numbers to which this interaction has been connected. Use this method after the phone call was closed, and is in the History. When the call is active, use getParties().

Returns:
the phone numbers separated by commas.

getHomeLocation

java.lang.String getHomeLocation()
Returns the location this phone call comes from.

Returns:
The location, or null if this phone call location has never changed.

getDuration

int getDuration()
Returns the duration of this call.

Returns:
the duration in seconds.

getANI

java.lang.String getANI()
Returns the ANI (Automatic Number Identification) parameter associated with this phone call.


getDNIS

java.lang.String getDNIS()
Returns the DNIS (Dialed Number Identification Service) parameter associated with this phone call.


getTrunk

int getTrunk()
Returns the Trunk parameter associated with this phone call.


holdCall

void holdCall(java.util.Map reasons)
              throws RequestFailedException
Deprecated. Use holdCall( Map, Map ).

Holds this call so that it can be retrieved later.

Parameters:
reasons - user defined reasons for holding this call.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

holdCall

void holdCall(java.util.Map reasons,
              java.util.Map tExtensions)
              throws RequestFailedException
Holds this call so that it can be retrieved later.

Parameters:
reasons - user defined reasons for holding this call.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

retrieveCall

void retrieveCall(java.util.Map reasons)
                  throws RequestFailedException
Deprecated. Use retrieveCall( Map, Map ).

Retrieves a call that was held.

Parameters:
reasons - user defined reasons for retrieving this call
Throws:
InvalidStatusException - if this interaction is not in Interaction.Status.HELD status.
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

retrieveCall

void retrieveCall(java.util.Map reasons,
                  java.util.Map tExtensions)
                  throws RequestFailedException
Retrieves a call that was held.

Parameters:
reasons - user defined reasons for retrieving this call
tExtensions - additional data that take into account. switch-specific features. Can be null.
Throws:
InvalidStatusException - if this interaction is not in Interaction.Status.HELD status.
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

alternateCall

void alternateCall(java.util.Map reasons)
                   throws RequestFailedException
Deprecated. Use alternateCall( Map, Map ).

Alternates between this call and a held call.

Parameters:
reasons - user defined reasons for alternating.
Throws:
NoOtherInteractionException - if there is no call with which to alternate.
InvalidStatusException - if the calls are not in correct status for alternating (both are held for instance)
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

alternateCall

void alternateCall(java.util.Map reasons,
                   java.util.Map tExtensions)
                   throws RequestFailedException
Alternates between this call and a held call.

Parameters:
reasons - user defined reasons for alternating.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
NoOtherInteractionException - if there is no call with which to alternate.
InvalidStatusException - if the calls are not in correct status for alternating (both are held for instance)
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

alternateCall

void alternateCall(InteractionVoice otherInteraction,
                   java.util.Map reasons,
                   java.util.Map tExtensions)
                   throws RequestFailedException
Alternates between this call and another given call.

Parameters:
otherInteraction - the other Interaction to alternalte with.
reasons - user defined reasons for alternating.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
InvalidParameterException - if this call cannot be alternated with otherInteraction.
InvalidStatusException - if the calls are not in correct status for alternating (both are held for instance)
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

reconnectCall

void reconnectCall(java.util.Map reasons)
                   throws RequestFailedException
Deprecated. Use reconnectCall( Map, Map ).

Reconnects this held call and releases another active call. This function is commonly used to clear an active call and to return to a held call, or to cancel a consult call (because of no answer, called device busy, and so on) and then to return to a held call. If there is no other call to release, use retrieveCall(Map, Map).

Parameters:
reasons - user defined reasons for reconnecting
Throws:
InvalidStatusException - if this call is not in Interaction.Status.HELD status.
NoOtherInteractionException - if there is no other call to release.
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

reconnectCall

void reconnectCall(java.util.Map reasons,
                   java.util.Map tExtensions)
                   throws RequestFailedException
Reconnects this held call and releases another active call. This function is commonly used to clear an active call and to return to a held call, or to cancel a consult call (because of no answer, called device busy, and so on) and then to return to a held call. If there is no other call to release, use retrieveCall(Map, Map).

Parameters:
reasons - user defined reasons for reconnecting
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
InvalidStatusException - if this call is not in Interaction.Status.HELD status.
NoOtherInteractionException - if there is no other call to release.
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

reconnectCall

void reconnectCall(InteractionVoice otherInteraction,
                   java.util.Map reasons,
                   java.util.Map tExtensions)
                   throws RequestFailedException
Reconnects this held call and releases another active call. This function is commonly used to clear an active call and to return to a held call, or to cancel a consult call (because of no answer, called device busy, and so on) and then to return to a held call. If there is no other call to release, use retrieveCall(Map, Map).

Parameters:
otherInteraction - the other Interaction to release.
reasons - user defined reasons for alternating.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
InvalidParameterException - if this call cannot be reconnected with otherInteraction.
InvalidStatusException - if this call is not in Interaction.Status.HELD status.
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

singleStepTransfer

void singleStepTransfer(java.lang.String otherDn,
                        java.lang.String location,
                        java.lang.String reason,
                        java.util.Map reasons)
                        throws RequestFailedException
Deprecated. Use singleStepTransfer( String, String, String, Map, Map, Map ).

Transfers this call in one step.
If the Switch is not capable of doing a single step transfer, but can do a mute transfer, this method will actually do a mute transfer.

Parameters:
otherDn - the DN to which this call will be transferred.
location - the name of the T-Server of the switch to use, in the form of <SwitchName> or <T-ServerApplicationName>@<SwitchName>. Typically used to transfer user data along with the call in multi-site contact centers.
reason - a reason submitted by the user for this transfer. This reason will be appended at the end of the notepad.
reasons - user defined reasons for this transfer.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

singleStepTransfer

void singleStepTransfer(java.lang.String otherDn,
                        java.lang.String location,
                        java.lang.String reason,
                        java.util.Map reasons,
                        java.util.Map tExtensions)
                        throws RequestFailedException
Deprecated. Use singleStepTransfer( String, String, String, Map, Map, Map ).

Transfers this call in one step.
If the Switch is not capable of doing a single step transfer, but can do a mute transfer, this method will actually do a mute transfer.

Parameters:
otherDn - the DN to which this call will be transferred.
location - the name of the T-Server of the switch to use, in the form of <SwitchName> or <T-ServerApplicationName>@<SwitchName>. Typically used to transfer user data along with the call in multi-site contact centers.
reason - a reason submitted by the user for this transfer. This reason will be appended at the end of the notepad.
reasons - user defined reasons for this transfer.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

singleStepTransfer

void singleStepTransfer(java.lang.String otherDn,
                        java.lang.String location,
                        java.lang.String reason,
                        java.util.Map attachedData,
                        java.util.Map reasons,
                        java.util.Map tExtensions)
                        throws RequestFailedException
Transfers this call in one step.
If the Switch is not capable of doing a single step transfer, but can do a mute transfer, this method will actually do a mute transfer.

Parameters:
otherDn - the DN to which this call will be transferred.
location - the name of the T-Server of the switch to use, in the form of <SwitchName> or <T-ServerApplicationName>@<SwitchName>. Typically used to transfer user data along with the call in multi-site contact centers.
reason - a reason submitted by the user for this transfer. This reason will be appended at the end of the notepad.
attachedData - attached data for the consultation call.
reasons - user defined reasons for this transfer.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

singleStepConference

void singleStepConference(java.lang.String otherDn,
                          java.lang.String location,
                          java.util.Map reasons)
                          throws RequestFailedException
Deprecated. Use singleStepConference( String, String, Map, Map, Map ).

Conferences this call in one step.

Parameters:
otherDn - the DN with which this call will be conferenced.
location - this parameter is reserved for future use. Set it to null.
reasons - user defined reasons for this conference.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

singleStepConference

void singleStepConference(java.lang.String otherDn,
                          java.lang.String location,
                          java.util.Map reasons,
                          java.util.Map tExtensions)
                          throws RequestFailedException
Deprecated. Use singleStepConference( String, String, Map, Map, Map ).

Conferences this call in one step.

Parameters:
otherDn - the DN with which this call will be conferenced.
location - this parameter is reserved for future use. Set it to null.
reasons - user defined reasons for this conference.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

singleStepConference

void singleStepConference(java.lang.String otherDn,
                          java.lang.String location,
                          java.util.Map attachedData,
                          java.util.Map reasons,
                          java.util.Map tExtensions)
                          throws RequestFailedException
Conferences this call in one step.

Parameters:
otherDn - the DN with which this call will be conferenced.
location - this parameter is reserved for future use. Set it to null.
attachedData - attached data for the consultation call.
reasons - user defined reasons for this conference.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

muteTransfer

void muteTransfer(java.lang.String otherDn,
                  java.lang.String location,
                  java.lang.String reason,
                  java.util.Map reasons)
                  throws RequestFailedException
Deprecated. Use muteTransfer( String, String, String, Map, Map, Map ).

Directly transfers this call.

Parameters:
otherDn - the DN to which this call will be transferred.
location - the name of the T-Server of the switch to use, in the form of <SwitchName> or <T-ServerApplicationName>@<SwitchName>. Typically used to transfer user data along with the call in multi-site contact centers.
reason - a reason submitted by the user for this transfer. This reason will be appended at the end of the notepad.
reasons - user defined reasons for this transfer.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

muteTransfer

void muteTransfer(java.lang.String otherDn,
                  java.lang.String location,
                  java.lang.String reason,
                  java.util.Map reasons,
                  java.util.Map tExtensions)
                  throws RequestFailedException
Deprecated. Use muteTransfer( String, String, String, Map, Map, Map ).

Directly transfers this call.

Parameters:
otherDn - the DN to which this call will be transferred.
location - the name of the T-Server of the switch to use, in the form of <SwitchName> or <T-ServerApplicationName>@<SwitchName>. Typically used to transfer user data along with the call in multi-site contact centers.
reason - a reason submitted by the user for this transfer. This reason will be appended at the end of the notepad.
reasons - user defined reasons for this transfer.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

muteTransfer

void muteTransfer(java.lang.String otherDn,
                  java.lang.String location,
                  java.lang.String reason,
                  java.util.Map attachedData,
                  java.util.Map reasons,
                  java.util.Map tExtensions)
                  throws RequestFailedException
Directly transfers this call.

Parameters:
otherDn - the DN to which this call will be transferred.
location - the name of the T-Server of the switch to use, in the form of <SwitchName> or <T-ServerApplicationName>@<SwitchName>. Typically used to transfer user data along with the call in multi-site contact centers.
reason - a reason submitted by the user for this transfer. This reason will be appended at the end of the notepad.
attachedData - attached data for the consultation call.
reasons - user defined reasons for this transfer.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

initiateTransfer

InteractionVoice initiateTransfer(java.lang.String otherDn,
                                  java.lang.String location,
                                  java.lang.String reason,
                                  java.util.Map reasons)
                                  throws RequestFailedException
Deprecated. Use initiateTransfer( String, String, String, Map, Map, Map ).

Initiates a transfer. Holds the current call and dials another one.

Parameters:
otherDn - the DN to which this call will be transferred.
location - the name of the T-Server of the switch to use, in the form of <SwitchName> or <T-ServerApplicationName>@<SwitchName>. Typically used to transfer user data along with the call in multi-site contact centers.
reason - a reason submitted by the user for this transfer. This reason will be appended at the end of the notepad.
reasons - user defined reasons for this transfer.
Returns:
the newly created interaction (consult call).
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

initiateTransfer

InteractionVoice initiateTransfer(java.lang.String otherDn,
                                  java.lang.String location,
                                  java.lang.String reason,
                                  java.util.Map reasons,
                                  java.util.Map tExtensions)
                                  throws RequestFailedException
Deprecated. Use initiateTransfer( String, String, String, Map, Map, Map ).

Initiates a transfer. Holds the current call and dials another one.

Parameters:
otherDn - the DN to which this call will be transferred.
location - the name of the T-Server of the switch to use, in the form of <SwitchName> or <T-ServerApplicationName>@<SwitchName>. Typically used to transfer user data along with the call in multi-site contact centers.
reason - a reason submitted by the user for this transfer. This reason will be appended at the end of the notepad.
reasons - user defined reasons for this transfer.
tExtensions - additional data that take into account switch-specific features. Can be null.
Returns:
the newly created interaction (consult call).
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

initiateTransfer

InteractionVoice initiateTransfer(java.lang.String otherDn,
                                  java.lang.String location,
                                  java.lang.String reason,
                                  java.util.Map attachedData,
                                  java.util.Map reasons,
                                  java.util.Map tExtensions)
                                  throws RequestFailedException
Initiates a transfer. Holds the current call and dials another one.

Parameters:
otherDn - the DN to which this call will be transferred.
location - the name of the T-Server of the switch to use, in the form of <SwitchName> or <T-ServerApplicationName>@<SwitchName>. Typically used to transfer user data along with the call in multi-site contact centers.
reason - a reason submitted by the user for this transfer. This reason will be appended at the end of the notepad.
attachedData - attached data for the consultation call.
reasons - user defined reasons for this transfer.
tExtensions - additional data that take into account switch-specific features. Can be null.
Returns:
the newly created interaction (consult call).
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

initiateTransfer

InteractionVoice initiateTransfer(InteractionVoice consult,
                                  java.lang.String otherDn,
                                  java.lang.String location,
                                  java.lang.String reason,
                                  java.util.Map attachedData,
                                  java.util.Map reasons,
                                  java.util.Map tExtensions)
                                  throws RequestFailedException
Initiates a transfer on an existing NEW consult interaction.

Parameters:
consult - an interaction to use as the consult call. It must have been previouslu created with #Place.createInteraction for instance.
otherDn - the DN to which this call will be transferred.
location - the name of the T-Server of the switch to use, in the form of <SwitchName> or <T-ServerApplicationName>@<SwitchName>. Typically used to transfer user data along with the call in multi-site contact centers.
reason - a reason submitted by the user for this transfer. This reason will be appended at the end of the notepad.
attachedData - attached data for the consultation call.
reasons - user defined reasons for this transfer.
tExtensions - additional data that take into account switch-specific features. Can be null.
Returns:
the newly created interaction (consult call).
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.
Since:
7.6.5

completeTransfer

void completeTransfer(java.util.Map reasons)
                      throws RequestFailedException
Deprecated. Use completeTransfer( Map, Map ).

Completes the transfer. Releases both interactions on this DN.

Parameters:
reasons - user defined reasons for this transfer
Throws:
NoOtherInteractionException - if there is no call with which the transfer can be completed.
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

completeTransfer

void completeTransfer(java.util.Map reasons,
                      java.util.Map tExtensions)
                      throws RequestFailedException
Completes the transfer. Releases both interactions on this DN.

Parameters:
reasons - user defined reasons for this transfer
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
NoOtherInteractionException - if there is no call with which the transfer can be completed.
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

completeTransfer

void completeTransfer(InteractionVoice other,
                      java.util.Map reasons,
                      java.util.Map tExtensions)
                      throws RequestFailedException
Completes the transfer between this interaction and the specified interaction. Releases both interactions on this DN.

Parameters:
other - the other Interaction to complete transfer.
reasons - user defined reasons for this transfer
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
InvalidParameterException - if complete transfer cannot be done between this call and otherInteraction.
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

initiateConference

InteractionVoice initiateConference(java.lang.String otherDn,
                                    java.lang.String location,
                                    java.util.Map reasons)
                                    throws RequestFailedException
Deprecated. Use initiateConference( String, String, Map, Map, Map ).

Initiates a conference. Holds the current call and dials a new one.

Parameters:
otherDn - the DN with which this call will be conferenced.
location - the name of the T-Server of the switch to use, in the form of <SwitchName> or <T-ServerApplicationName>@<SwitchName>. Typically used to transfer user data along with the call in multi-site contact centers.
reasons - user defined reasons for this conference.
Returns:
the newly created interaction (consult call).
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

initiateConference

InteractionVoice initiateConference(java.lang.String otherDn,
                                    java.lang.String location,
                                    java.util.Map reasons,
                                    java.util.Map tExtensions)
                                    throws RequestFailedException
Deprecated. Use initiateConference( String, String, Map, Map, Map ).

Initiates a conference. Holds the current call and dials a new one.

Parameters:
otherDn - the DN with which this call will be conferenced.
location - the name of the T-Server of the switch to use, in the form of <SwitchName> or <T-ServerApplicationName>@<SwitchName>. Typically used to transfer user data along with the call in multi-site contact centers.
reasons - user defined reasons for this conference.
tExtensions - additional data that take into account switch-specific features. Can be null.
Returns:
the newly created interaction (consult call).
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

initiateConference

InteractionVoice initiateConference(java.lang.String otherDn,
                                    java.lang.String location,
                                    java.util.Map attachedData,
                                    java.util.Map reasons,
                                    java.util.Map tExtensions)
                                    throws RequestFailedException
Initiates a conference. Holds the current call and dials a new one.

Parameters:
otherDn - the DN with which this call will be conferenced.
location - the name of the T-Server of the switch to use, in the form of <SwitchName> or <T-ServerApplicationName>@<SwitchName>. Typically used to transfer user data along with the call in multi-site contact centers.
attachedData - attached data for the consultation call.
reasons - user defined reasons for this conference.
tExtensions - additional data that take into account switch-specific features. Can be null.
Returns:
the newly created interaction (consult call).
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

initiateConference

InteractionVoice initiateConference(InteractionVoice consult,
                                    java.lang.String otherDn,
                                    java.lang.String location,
                                    java.util.Map attachedData,
                                    java.util.Map reasons,
                                    java.util.Map tExtensions)
                                    throws RequestFailedException
Initiates a conference on an existing NEW consult interaction.

Parameters:
consult - an interaction to use as the consult call. It must have been previouslu created with
otherDn - the DN with which this call will be conferenced.
location - the name of the T-Server of the switch to use, in the form of <SwitchName> or <T-ServerApplicationName>@<SwitchName>. Typically used to transfer user data along with the call in multi-site contact centers.
attachedData - attached data for the consultation call.
reasons - user defined reasons for this conference.
tExtensions - additional data that take into account switch-specific features. Can be null.
Returns:
the newly created interaction (consult call).
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.
Since:
7.6.5

completeConference

void completeConference(java.util.Map reasons)
                        throws RequestFailedException
Deprecated. Use completeConference( Map, Map ).

Completes the conference.

Parameters:
reasons - user defined reasons for this conference.
Throws:
NoOtherInteractionException - if there is no call with which the conference can be completed.
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

completeConference

void completeConference(java.util.Map reasons,
                        java.util.Map tExtensions)
                        throws RequestFailedException
Completes the conference.

Parameters:
reasons - user defined reasons for this conference.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
NoOtherInteractionException - if there is no call with which the conference can be completed.
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

completeConference

void completeConference(InteractionVoice otherInteraction,
                        java.util.Map reasons,
                        java.util.Map tExtensions)
                        throws RequestFailedException
Completes the conference.

Parameters:
otherInteraction - the other Interaction to complete transfer.
reasons - user defined reasons for this conference.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
InvalidParameterException - if complete conference cannot be done between this call and otherInteraction.
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

leaveConference

void leaveConference(java.util.Map reasons)
                     throws RequestFailedException
Deprecated. Use leaveConference( Map, Map ).

Leaves the conference.

Parameters:
reasons - user defined reasons for leaving this conference.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

leaveConference

void leaveConference(java.util.Map reasons,
                     java.util.Map tExtensions)
                     throws RequestFailedException
Leaves the conference.

Parameters:
reasons - user defined reasons for leaving this conference.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

deleteFromConference

void deleteFromConference(java.lang.String dn,
                          java.util.Map reasons)
                          throws RequestFailedException
Deprecated. Use deleteFromConference( String, Map, Map ).

Deletes a party from the conference. This method can be used only by the party who has done the conference.

Parameters:
dn - the DN to drop out of the conference.
reasons - user defined reasons for this conference.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

deleteFromConference

void deleteFromConference(java.lang.String dn,
                          java.util.Map reasons,
                          java.util.Map tExtensions)
                          throws RequestFailedException
Deletes a party from the conference. This method can be used only by the party who has done the conference.

Parameters:
dn - the DN to drop out of the conference.
reasons - user defined reasons for this conference.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

listenDisconnect

void listenDisconnect(java.lang.String dn,
                      java.util.Map reasons,
                      java.util.Map tExtensions)
                      throws RequestFailedException
Plays 'music on hold' to a party in the conference. This method can be used only by the party who has done the conference.

Parameters:
dn - the DN play music to.
reasons - user defined reasons.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

listenReconnect

void listenReconnect(java.lang.String dn,
                     java.util.Map reasons,
                     java.util.Map tExtensions)
                     throws RequestFailedException
Cancels 'music on hold' to a party in the conference. This method can be used only by the party who has done the conference.

Parameters:
dn - the DN to reconnect.
reasons - user defined reasons.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

makeCall

void makeCall(java.lang.String dn,
              java.lang.String location,
              InteractionVoice.MakeCallType callType,
              java.util.Map attachedData,
              java.util.Map reasons)
              throws RequestFailedException
Deprecated. Use makeCall( String, String, InteractionVoice.MakeCallType, Map, Map, Map ).

Dials a number on a new interaction.

Parameters:
dn - the DN to dial on or null if you don't want to specify one.
location - the name of the T-Server of the switch to use, in the form of <SwitchName> or <T-ServerApplicationName>@<SwitchName>. Typically used to transfer user data along with the call in multi-site contact centers. Can be null.
callType - the type of call to make.
attachedData - attached data for this new phone call.
reasons - user defined reasons for this call.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

makeCall

void makeCall(java.lang.String dn,
              java.lang.String location,
              InteractionVoice.MakeCallType callType,
              java.util.Map attachedData,
              java.util.Map reasons,
              java.util.Map tExtensions)
              throws RequestFailedException
Dials a number on a new interaction.

Parameters:
dn - the DN to dial on or null if you don't want to specify one.
location - the name of the T-Server of the switch to use, in the form of <SwitchName> or <T-ServerApplicationName>@<SwitchName>. Typically used to transfer user data along with the call in multi-site contact centers. Can be null.
callType - the type of call to make.
attachedData - attached data for this new phone call.
reasons - user defined reasons for this call.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

getInitialInteraction

InteractionVoice getInitialInteraction()
If this interaction is a consultation call, returns the initial or parent interaction.

Returns:
the initial interaction or null if this interaction call type is InteractionVoice.CallType.CONSULT.

getConsultationInteractions

java.util.Collection getConsultationInteractions()
Returns the consultation calls of this interaction.

Returns:
a collection of InteractionVoice. Empty if none.

sendDTMF

void sendDTMF(java.lang.String digits,
              java.util.Map reasons)
              throws RequestFailedException
Deprecated. Use sendDTMF( String, Map, Map ).

Sends digits as DTMF tones on this phones call.

Parameters:
digits - the numbers to send.
reasons - user defined reasons for sending digits.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

sendDTMF

void sendDTMF(java.lang.String digits,
              java.util.Map reasons,
              java.util.Map tExtensions)
              throws RequestFailedException
Sends digits as DTMF tones on this phones call.

Parameters:
digits - the numbers to send.
reasons - user defined reasons for sending digits.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

answerCall

void answerCall(java.util.Map reasons,
                java.util.Map tExtensions)
                throws RequestFailedException
Answers this call.

Parameters:
reasons - user defined reasons for answering this call.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

releaseCall

void releaseCall(java.util.Map reasons,
                 java.util.Map tExtensions)
                 throws RequestFailedException
Releases this call.

Parameters:
reasons - user defined reasons for releasing this call
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

redirectCall

void redirectCall(java.lang.String destination,
                  java.util.Map reasons)
                  throws RequestFailedException
Deprecated. Use redirectCall( String, Map, Map ).

Redirects this call.

Parameters:
destination - the destination DN where to redirect this call.
reasons - user defined reasons for redirecting this call.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

redirectCall

void redirectCall(java.lang.String destination,
                  java.util.Map reasons,
                  java.util.Map tExtensions)
                  throws RequestFailedException
Redirects this call.

Parameters:
destination - the destination DN where to redirect this call.
reasons - user defined reasons for redirecting this call.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

muteOn

void muteOn(java.util.Map reasons,
            java.util.Map tExtensions)
            throws RequestFailedException
Mutes this call (disables the microphone).

Parameters:
reasons - user defined reasons for muting this call.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

muteOff

void muteOff(java.util.Map reasons,
             java.util.Map tExtensions)
             throws RequestFailedException
Cancels call muting (enables the microphone).

Parameters:
reasons - user defined reasons for cancelling call muting.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

acceptPreview

void acceptPreview(java.util.Map tReasons,
                   java.util.Map tExtensions)
                   throws RequestFailedException
Accepts a preview interaction.

Parameters:
tReasons - user defined reasons for accepting the preview interaction.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

rejectPreview

void rejectPreview(java.util.Map tReasons,
                   java.util.Map tExtensions)
                   throws RequestFailedException
Rejects a preview interaction.

Parameters:
tReasons - user defined reasons for rejecting the preview interaction.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
TelephonyServiceException - if an error occurred with the T-Server.
RequestFailedException - if the request fails for any other reason.

isNetworkControllingParty

boolean isNetworkControllingParty()
Returns true if this interaction is the controlling party in a network attended transfer or conference consultation.


getNetworkStatus

InteractionVoice.NetworkStatus getNetworkStatus()
Returns this interaction's NAT/C (Network Attended Transfer/Conference) status.


getNetworkLocation

java.lang.String getNetworkLocation()
Returns this interaction's network location.


getNetworkParty

java.lang.String getNetworkParty()
Returns this interaction's NAT/C (Network Attended Transfer/Conference) party.

See Also:
isNetworkControllingParty()

networkConsult

void networkConsult(java.lang.String destination,
                    java.lang.String location,
                    java.util.Map reasons,
                    java.util.Map tExtensions)
                    throws RequestFailedException
Initiates a consultation call through the network.

Parameters:
destination - the DN to be consulted.
location - location of the target DN.
reasons - user defined reasons for this consultation.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
RequestFailedException

networkSingleStepTransfer

void networkSingleStepTransfer(java.lang.String destination,
                               java.lang.String location,
                               java.util.Map reasons,
                               java.util.Map tExtensions)
                               throws RequestFailedException
Initiates a single step transfer through the network.

Parameters:
destination - the DN to which this call will be transferred.
location - the name of the T-Server of the switch to use, in the form of <SwitchName> or <T-ServerApplicationName>@<SwitchName>.
Typically used to transfer user data along with the call in multi-site contact centers.
reasons - user defined reasons for this transfer.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
RequestFailedException

networkAlternate

void networkAlternate(java.util.Map reasons,
                      java.util.Map tExtensions)
                      throws RequestFailedException
Alternates between the network consult party and the external party.

Parameters:
reasons - user defined reasons.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
RequestFailedException

networkReconnect

void networkReconnect(java.util.Map reasons,
                      java.util.Map tExtensions)
                      throws RequestFailedException
Releases the network consult party and reconnects to the original external party.

Parameters:
reasons - user defined reasons.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
RequestFailedException

networkTransfer

void networkTransfer(java.util.Map reasons,
                     java.util.Map tExtensions)
                     throws RequestFailedException
Transfers this call to the network consult party.

Parameters:
reasons - user defined reasons.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
RequestFailedException

networkConference

void networkConference(java.util.Map reasons,
                       java.util.Map tExtensions)
                       throws RequestFailedException
Merges the network consult call and the external call into a network conference.

Parameters:
reasons - user defined reasons.
tExtensions - additional data that take into account switch-specific features. Can be null.
Throws:
RequestFailedException

isDualStepPossible

boolean isDualStepPossible()
Deprecated. Use Possible.isPossible(com.genesyslab.ail.Enum) instead.

Returns true if dual step transfer and conference are possible on this switch.


isSingleStepPossible

boolean isSingleStepPossible()
Deprecated. Use Possible.isPossible(com.genesyslab.ail.Enum) instead.

Returns true if single step transfer and conference are possible on this switch.


setAttachedData

void setAttachedData(java.lang.String key,
                     java.lang.Object value)
Sets an attached key-value pair. Use AbstractInteraction.saveAttachedData() to apply this modification.

Specified by:
setAttachedData in interface AbstractInteraction
Parameters:
key - The key of the pair.
value - The value of the pair. Valid objects are:
  • a String,
  • an Integer,
  • a List of Byte, or a byte[],
  • a List, containing those types of objects,
  • a Map, recursively containing the same types of pairs.
Warning: set null value for a key is not allowed.
See Also:
for specific behaviour., for specific behaviour.