Interaction SDK
(Web Services)

com.genesyslab.ail.ws

Class Summary
Attachment This class defines a container for a file attachment, for example for a text file attached to an e-mail interaction.
AttributeError This class describes an error which occurred during an attribute update. It may be returned on calls to set*DTO() methods.
KeyValue This container describes a key-value pair used in a Data Transfer Object. The key-value pair corresponds to a service attribute. The KeyValue.value field can be a basic type such as string, boolean or int, or it can have a type defined in the attribute's namespace. For instance, in the com.genesyslab.ail.ws.outbound namespace, the OutboundChainDTO.data field can be one of the object types listed in the outbound.chain attributes definitions, which include OutboundChainReason, CampaignMode, TreatmentType, or OutboundEventType.
ShortAttachment This class defines a container for an attachment's short form, for example for a text file attached to an e-mail interaction. This short form contains the filename and mime type of the attachment, but it does not include the attachment's data.
Switch This class defines a switch.
WServiceException This class describes an exception thrown by the services of the com.genesyslab.ail packages.

Enum Summary
InteractionServerErrorType This enum describes the different Interaction Server error types. These errors are send under the following code : 'error.common.InteractionServerCode::Type:x1::Number:x2' where x1 is the error type (ex : PLACE_NOT_SPECIFIED) and x2 : the error number.
SwitchType This enumeration lists the switch types used with services.

Class Detail

Attachment

This class defines a container for a file attachment, for example for a text file attached to an e-mail interaction.

Fields:

  data  byte[]
   The content of the attachment as a buffer.

  filename  String
   The attachment name.

  mimeType  String
   The mime type attachment.

  identifier  String
   The attachment identifier. Note : Genesys recommends that you do not use this parameter to append this attachment to an interaction.

AttributeError

This class describes an error which occurred during an attribute update. It may be returned on calls to set*DTO() methods.

Fields:

  error  String
   The error code.

  attribute  String
   The attribute name.

KeyValue

This container describes a key-value pair used in a Data Transfer Object. The key-value pair corresponds to a service attribute. The KeyValue.value field can be a basic type such as string, boolean or int, or it can have a type defined in the attribute's namespace. For instance, in the com.genesyslab.ail.ws.outbound namespace, the OutboundChainDTO.data field can be one of the object types listed in the outbound.chain attributes definitions, which include OutboundChainReason, CampaignMode, TreatmentType, or OutboundEventType.

Fields:

  value  Object
   The value.

  key  String
   The key.

ShortAttachment

This class defines a container for an attachment's short form, for example for a text file attached to an e-mail interaction. This short form contains the filename and mime type of the attachment, but it does not include the attachment's data.

Fields:

  filename  String
   The attachment name.

  mimeType  String
   The mime type attachment.

  identifier  String
   The attachment identifier.

  size  int
   The size of this attachment in bytes.

Switch

This class defines a switch.

Fields:

  name  String
   The switch name.

  switchType  com.genesyslab.ail.ws.SwitchType
   The switch type.

WServiceException

This class describes an exception thrown by the services of the com.genesyslab.ail packages.

Fields:

  errorName  String
   The error name.

Enum Detail

InteractionServerErrorType

This enum describes the different Interaction Server error types. These errors are send under the following code : 'error.common.InteractionServerCode::Type:x1::Number:x2' where x1 is the error type (ex : PLACE_NOT_SPECIFIED) and x2 : the error number.

Members:

  NO_ERROR
   Operation successfully completed

  NOT_REGISTERED
   Client not registered

  UNKNOWN_CLIENT_ID
   Unknown client id in request from proxy

  UNSUPPORTED_PROTOCOL_ELEMENT
   Unsupported protocol element

  PROXY_THROUGH_PROXY
   Proxy chain error

  TENANT_NOT_SPECIFIED
   Tenant identifier not specified in request

  UNKNOWN_TENANT_IN_REQUEST
   Unknown tenant specified in request

  PLACE_NOT_SPECIFIED
   Place identifier not specified in request

  UNKNOWN_PLACE_IN_REQUEST
   Unknown place specified in request

  UNKNOWN_AGENT_IN_REQUEST
   Unknown agent specified in request

  PLACE_DISABLED
   Disabled place specified in request

  PLACE_OCCUPIED
   Place is already occupied

  AGENT_DISABLED
   Disabled agent specified in request

  ALREADY_LOGGED_IN
   Agent already logged in

  PLACE_NOT_OCCUPIED
   Place is not logged in

  PLACE_NOT_OCCUPIED_BY_AGENT
   Specified agent is not logged in at specified place

  INCORRECT_MEDIA_LIST
   Incorrect media list format

  UNSUPPORTED_MEDIA_TYPE
   Unsupported media type

  INTERACTION_ID_NOT_SPECIFIED
   Interaction identifier is not specified

  QUEUE_NOT_SPECIFIED
   Queue identifier is not specified

  UNKNOWN_QUEUE_IN_REQUEST
   Unknown queue specified in request

  MEDIA_TYPE_NOT_SPECIFIED
   Media type is not specified

  INTERACTION_TYPE_NOT_SPECIFIED
   Interaction type is not specified

  INTERACTION_SUBTYPE_NOT_SPECIFIED
   Interaction subtype is not specified

  UNSUPPORTED_INTERACTION_TYPE
   Unsupported interaction type

  UNSUPPORTED_INTERACTION_SUBTYPE
   Unsupported interaction subtype

  DBMANAGER_FAILED
   DB Manager failure

  DATABASE_FAILED
   Database failure

  VIEW_ID_NOT_SPECIFIED
   View identifier is not specified

  PULL_FAILED
   Pull operation failed

  INVALID_TIME_FORMAT
   Invalid time format specified for one of the attributes

  WRONG_TENANT
   Wrong tenant specified in the request

  WORKBIN_NOT_SPECIFIED
   Workbin type identifier is not specified

  CLIENT_NOT_LOGGED_IN
   Client is not logged in

  NOT_AN_OWNER
   Client does not own the interaction

  TENANCY_VIOLATION
   Tenancy violation

  ITX_MANAGER_INTERNAL
   Interaction manager failure (or database failure)

  AGENT_NOT_SPECIFIED
   Agent identifier is not specified in request

  PLACE_GROUP_NOT_SPECIFIED
   Place group identifier is not specified in request

  AGENT_GROUP_NOT_SPECIFIED
   Agent group identifier is not specified in request

  WORKBIN_INACCESSIBLE
   Specified workbin is not accessible

  UNKNOWN_VIEW_IN_REQUEST
   Unknown view specified in request

  UNKNOWN_INTERACTION
   Unknown interaction identifier specified

  TARGET_IS_NOT_SPECIFIED
   Target is not specified

  AMBIGUOUS_TARGET_SPECIFIED
   Ambiguous target specification

  PARTY_UNAVAILABLE
   Specified party is no longer available

  NOT_INVITED
   Party not invited or invalid ticket identifier

  PULL_PARAMETER_ABSENT
   Parameter required for 'pull' request is absent

  PULL_PARAMETER_INVALID
   Parameter required for 'pull' request is invalid

  ROUTING_TARGET_INVALID
   Invalid routing target specified

  TRANSFER_TARGET_INVALID
   Invalid transfer target specified

  ALREADY_PARTICIPATING
   Party is already participating in the interaction or is being invited

  SNAPSHOT_VIEW_FAILED
   Unknown view or invalid condition or order

  SNAPSHOT_DBREQUEST_FAILED
   Failed to execute database request

  SNAPSHOT_DBREQUEST_ERROR
   Failed to execute database request

  SNAPSHOT_GETPARAM_INVALID
   Unknown snapshot identifier

  SNAPSHOT_POSPARAM_INVALID
   Invalid start position specified (zero based)

  SNAPSHOT_COUNTPARAM_INVALID
   Invalid number of records requested

  SNAPSHOT_NO_INTERACTION_ID
   Interaction is not taken by specified snapshot

  SNAPSHOT_NO_RECORD
   No records selected, check condition

  SNAPSHOT_LIMIT_REACHED
   Snapshots limit reached, try again later

  SNAPSHOT_CAN_NOT_LOCK_INTERACTION
   Can't lock interaction. (Locked or processing)

  SNAPSHOT_INTERACTION_LOCKED
   Interaction is locked

  SNAPSHOT_INTERACTION_UNLOCKED
   Interaction is not locked by this snapshot

  INVALID_PROPERTY_TYPE
   Invalid property type specified

  READ_ONLY_PROPERTY
   Attempt to set/change read-only property

  DUPLICATE_MEDIA_TYPES
   Duplicate media types specified

  LICENSE_UNAVAILABLE
   Could not checkout license

  DO_NOT_HAVE_MEDIA
   Not logged in with specified media

  ALREADY_HAVE_MEDIA
   Already logged in with specified media

  DND_ALREADY_ON
   'Do not disturb' is already on

  DND_ALREADY_OFF
   'Do not disturb' is already off

  ALREADY_READY_FOR_MEDIA
   Already in state 'ready' for specified media

  ALREADY_NOT_READY_FOR_MEDIA
   Already in state 'not ready' for specified media

  HAVE_TO_CONTACT_PRIMARY
   Operation can only be performed by primary server

  HAVE_TO_CONTACT_SECONDARY
   Operation can only be performed by secondary server

  INVALID_INTERACTION_IDENTIFIER
   Invalid interaction identifier (too short/long or invalid characters)

  TRANSFER_IN_PROGRESS
   Transfer operation is in progress

  INVALID_PROTOCOL_MESSAGE
   Invalid protocol message

  INVALID_INTERACTION_DATA
   Invalid interaction data

  DUPLICATED_INTERACTION_ID
   Duplicate interaction id

  DBMANAGER_NO_DBCONNECTIONS
   Database connection unavailable

  VIEW_DEFINITION_INVALID
   View configuration is invalid

  NOT_IMPLEMENTED
   Feature not implemented

  DUPLICATED_PROPERTIES
   Duplicated properties detected

  LIMIT_PROXY_CLIENTS_REACHED
   Number of through-proxy cleints has reached its limit

  DND_ON
   'Do not disturb' is on for the target agent

SwitchType

This enumeration lists the switch types used with services.

Members:

  UNDEFINED
   Undefined switch type.

  A4400_LIKE
   A4400 switch type.

  ASPECT_LIKE
   Aspect switch type.

  DMS100_LIKE
   DMS 1000 switch type.

  DHARMA_LIKE
   Datavoice Dharma switch type.

  ERICSSON_MD110_LIKE
   Ericsson MD110 switch type.

  GENERIC
   Generic switch type.

  HICOM_LIKE
   Hicom switch type.

  IPMX_LIKE
   IPMX switch type.

  KNOWLEDGE_WORKER
   Knowledge worker switch type.

  MERIDIAN_LIKE
   Meridian switch type.

  NEC_APEX_LIKE
   NEC apex switch type.

Interaction SDK
(Web Services)