Callable number available on the switch for this DN. You use this callable number to make calls, to transfer calls, to make
a conference call, and so on.
Cancels this outbound record. An agent may decide, because of history or record data, that this contact (and all its chained
records) does not need any call. The record will no longer be handled by the current campaign. This action ends record processing
in this interaction.
Cancels this chain's active record. An agent may decide, because of history or record data, that this contact (and all its
chained records) does not need any call. The record is no longer handled in the current campaign. Note: This method does not
modify the interaction (if any) associated with the records of this chain.
Determines that this record (and only this one) does not need any call, due to its history or record data. This record will
no longer be handled by the current campaign.
Determines that this record (and only this one) does not need any call, due to its history or record data. This record will
no longer be handled by the current campaign.
Cancels an outbound record. Used when an agent updates data of a contact outside of the processing of a campaign (during an
inbound call, for example) and decides that there is no need to call this customer again.
Cancels an outbound record. Used when an agent updates a contacts data outside of campaign processing (during an inbound
call, for example), and decides that there is no need to call this customer again.
The children of this item. Child interactions are interactions that reply to another interaction. For instance, an InteractionMailOut
is a child of the InteractionMailIn to which it replies.
Disconnects from the Chat Server in after_action mode 'ForceClose' or 'CloseIfNoAgents'. To disconnect in after_action mode
'KeepAlive' , use release method.
CLIENT - a member in enum
com.genesyslab.ail.ws.interaction.chat.ChatPartyType
Requests an agent or supervisor to join the chat session. If failure, the initiator will receive an Error InteractionEvent
containing error description in extensions. If success, the invited agent will receive a RINGING InteractionEvent containing
in extensions: RINGING_CONFERENCED = initiator, RINGING_CONFERENCE_REASON = reason, RINGING_CONFERENCE_VISIBILITY = ChatPartyVisibility
Requests an agent or supervisor to join the chat session. If failure, the initiator will receive an Error InteractionEvent
containing error description in extensions. If success, the invited agent will receive a RINGING InteractionEvent containing
in extensions: RINGING_CONFERENCED = initiator, RINGING_CONFERENCE_REASON = reason, RINGING_CONFERENCE_VISIBILITY = ChatPartyVisibility
IDs of the voice interactions that were initiated during this interaction (only consultation calls). Empty unless an initTransfer()
or an initConference() was done.
This class describes the metadata of a contact attribute. The metadata contains useful information available for all the values
of this type of contact attribute. For example, a metadata can describe an e-mail address; this metadata is available for
any contact attribute value which contains an e-mail address. ContactAttributeMetaData is defined in the Configuration Layer
in the Business Attributes/Contact Attributes enumerator folder.
This class is a container for a contact attribute value. This class has two usages. If the ContactAttributeValue object contains
a contact attribute value from the ContactServer database, the isPredefined() method always returns false, and the getId()
method returns the ContactServerID. If the ContactAttributeValue object contains a predefined value from the Configuration
Layer, the isPredefined() method always returns true, the getId() method returns the name of the Configuration Layer value,
and the getValue() method contains the display name in the Configuration Layer, the getDescription() method is the description,
and the isPrimary() method returns true if the current value is the default Configuration Layer value.
This class describes a contact filter leaf. A contact filter leaf contains an expression such as: "EMailAddress = myE-Mail@Address.com"
or "primary EMailAddress == myE-Mail@Address.com"
This class describes the form used to merge two contacts. The 'from' contact attributes are not deleted, all its contact attribute
values are assigned to the 'to' contact with primary status set to false (if needed). The merge might affect the default values
for 'to' contact's attributes. If after merging, no default title is defined for the 'to' contact, the default title of 'from'
contact, if it exists, is used for default title for this contact. If after merging, no default first name is defined for
the 'to' contact, the default first name of the 'from' contact, if it exists, is used for default firstname for this contact.
If after merging no default last name is defined for the 'to' contact, the default last name of the 'from' contact, if it
exists, is used for default last name for this contact. If after merging no default e-mail address is defined for the 'to'
contact, the default e-mail address of the 'from' contact, if it exists, is used for default e-mail address for this contact.
If no default e-mail address exists, another value is taken from the list (if any). If after merging no default phone number
is defined for the 'to' contact, the default phone number of the 'from' contact, if it exists, is used for default phone number
for this contact. If no default phone number exists, another value is taken from the list (if any).
This class defines the template for contact searches. It defines a contact filter tree to search contacts and specifies a
set of attributes used to sort the matching contacts. The list of matching contacts may be too huge to be retrieved. This
form can specify the size and the index of the matching contacts' sorted list which is returned. For example: if index = 0
and length = -1, the returned list contains all the matching contacts; if index = 0 and length = 8, the returned list contains
the first eight matching contacts; if index = 8 and length = 8, the returned list contains the next eight matching contacts.
This class describes the information of a contact. Each object reference is unique, two or several client applications do
not handle the same reference even though the ID of the contact (ContactServerID) is identical. Objects, that handle the same
contact ID, may not store the same contact attribute values. Therefore, one contact value object can contain a subset of contact
attribute values of another contact value object with the same contact identifier that is fullfilled.
Creates new InteractionMultiMedia without submitting it, uses submit method in InteractionMultimedia to put it into workflow.
Valid interaction types are only EMAILOUT_REPLY, EMAILOUT or PHONE_CALL. Valid parent interactions are null if no parent or
Chat, EmailIn or Voice interaction.
Creates a new interaction and makes a call on this DN if destNumber is not null. The Interaction will be created only if an
Agent is logged on this DN.
Creates a new interaction on a Dn of this place. For voice interactions: The Dn will be affected when you call makeCall().
For instant messaging interactions, if your place handles a SIP DN, specify MediaType.CHAT in parameters.
ID of this agent's current place. An agent is considered as 'sitting' on the place of the last DN on which the agent has logged
in. Only the last logged DN is taken into account. It means that, if the agent logs into a DN of another place, he is no more
seen as sitting on the first place but on the one of the last logged DN. And this despite the fact that he is still logged
on the first DN. If the agent is not logged in anywhere, this method will return null if the agent has no default place.
This class describes the custom metadata of an interaction attribute value. CustomAttachedData is a set of keys for interaction
attached data. These keys come with preset values, among which the user can chose the value to assign as attached data to
an interaction.
This class describes a preset value for a CustomAttachedData. When setting an attached data to an interaction, the user can
chose the value among the CustomAttachedDataValues