Interaction SDK
(Web Services)

com.genesyslab.ail.ws.resource

Class Summary
CustomAttachedData 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.
CustomAttachedDataValue 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
InteractionAttributeMetaData This class describes the metadata of an interaction attribute value. InteractionAttributeMetaData is a facility for application to add new information in interaction for specific purposes. InteractionAttributeMetaDatas are defined in the Configuration Layer in the Business Attributes/Interaction Attributes enumerator folder.
InteractionAttributeValue This class describes the attribute value for a specific InteractionAttributeMetaData.
ActionCode This class describes an action code.
AgentGroup Describes an agent group. This class associates the list of IDs of the agents that belong to the group with a group name.
AttachedDataProperty This class describes attached data property.
DnSummaryDTO This class describes the DTO data for a DN summary.
Enumerator This class describes the enumerator.
EnumeratorValue This class describes the enumerator value.
MediaTypeName This class gives information about association media name media type.
PersonSummaryDTO Describes the DTO data for a person summary. Summary objects are intended for getting quickly a list of objects without having to fully download each object.
PlaceSummaryDTO Describes the DTO data for a place summary. Summary objects are intended for getting quickly a list of objects without having to fully download each object.
QueueSummaryDTO Describes the DTO data for a queue summary. Summary objects are intended for getting quickly a list of objects without having to fully download each object.
SkillSummaryDTO Describes the DTO data for a skill summary. Summary objects are intended for getting quickly a list of objects without having to fully download each object.
Timezone Describes a time zone.
WorkbinSummaryDTO Describes the DTO data for a workbin summary. Summary objects are intended for getting quickly a list of objects without having to fully download each object.

Enum Summary
InteractionAttributeMetaDataType This enum lists the possible types of an interaction attribute metaData.
ActionCodeType This enum describes the possible action codes.
CustomAttachedDataType This enum lists the possible types of custom attached data.
DnSummaryType This enum lists the different summary types for a DN.
EnumeratorType This enum lists the possible types of an enumerator.

Class Detail

CustomAttachedData

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.

Fields:

  id  String
   The CustomAttachedData identifier.

  name  String
   The name of this CustomAttachedData as defined in the configuration layer.

  displayName  String
   The display name of this CustomAttachedData as defined in the configuration layer.

  description  String
   The description of this CustomAttachedData as defined in the configuration layer.

  type  com.genesyslab.ail.ws.resource.CustomAttachedDataType
   The type of this CustomAttachedData as defined in the configuration layer.

  values  com.genesyslab.ail.ws.resource.CustomAttachedDataValue[]
   A list of preset values for this CustomAttachedData as defined in the configuration layer. When setting a value, it is recommended but not mandatory to use one of the preset values.

CustomAttachedDataValue

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

Fields:

  id  String
   The identifier of this custom attached data instance.

  displayName  String
   The display name of this CustomAttachedDataValue as defined in the configuration layer. The display name is intended for GUI purposes.

  name  String
   The name of this CustomAttachedDataValue as defined in the configuration layer.

  type  com.genesyslab.ail.ws.resource.CustomAttachedDataType
   The type of this CustomAttachedData as defined in the configuration layer.

  default  boolean
   This is the default value.

InteractionAttributeMetaData

This class describes the metadata of an interaction attribute value. InteractionAttributeMetaData is a facility for application to add new information in interaction for specific purposes. InteractionAttributeMetaDatas are defined in the Configuration Layer in the Business Attributes/Interaction Attributes enumerator folder.

Fields:

  name  String
   The attribute name.

  displayName  String
   The attribute display name.

  format  String
   The format of this attribute.

  modifiedDate  long
   The modified date of this attribute.

  id  String
   The attribute metadata identifier.

  type  com.genesyslab.ail.ws.resource.InteractionAttributeMetaDataType
   The type of this attribute.

  active  boolean
   Is this attribute in an active state.

  sortable  boolean
   Is this attribute sortable.

  predefinedValues  com.genesyslab.ail.ws.resource.InteractionAttributeValue[]
   A list of predefined interaction attribute values or null. These values are defined in the the Business Attributes folder in the Configuration Layer.

InteractionAttributeValue

This class describes the attribute value for a specific InteractionAttributeMetaData.

Fields:

  id  String
   The identifier of this attribute instance. In set mode, if the identifier is null, the attribute is added; otherwise, this instance is updated.

  description  String
   The description.

  name  String
   The name.

  value  Object
   The attribute value. Can be a string, an int or a long (for a date).

  default  boolean
   true, if this attribute instance a default one.

  type  com.genesyslab.ail.ws.resource.InteractionAttributeMetaDataType
   The type of this attribute. On set mode, this field is not taken into account.

ActionCode

This class describes an action code.

Fields:

  name  String
   The action code name.

  code  String
   The action code.

  type  com.genesyslab.ail.ws.resource.ActionCodeType
   The action code type.

  subCodes  com.genesyslab.ail.ws.KeyValue[]
   The action sub-codes where the key is the code of the sub-code as a String and the value is the name of the sub-code as a String.

  annex  com.genesyslab.ail.ws.KeyValue[]
   The annex properties defined in the Configuration Layer.

AgentGroup

Describes an agent group. This class associates the list of IDs of the agents that belong to the group with a group name.

Fields:

  name  String
   The agent group name.

  agentIds  String[]
   The agent identifiers.

AttachedDataProperty

This class describes attached data property.

Fields:

  key  String
   The AttachedData key.

  readOnly  boolean
   Is this attached data in read only mode. Checks wether an attached data can be modified by an agent. An agent application should not allow the user to delete or modify the attached data that are used for routing or other internal purposes.

DnSummaryDTO

This class describes the DTO data for a DN summary.

Fields:

  data  com.genesyslab.ail.ws.KeyValue[]
   The DTO attributes.

  dnId  String
   The DN identifier.

Enumerator

This class describes the enumerator.

Fields:

  enumeratorId  String
   The identifier of this enumerator.

  description  String
   The enumerator description.

  type  com.genesyslab.ail.ws.resource.EnumeratorType
   The type of this enumerator, null if no type is defined.

  defaultValue  com.genesyslab.ail.ws.resource.EnumeratorValue
   The default value of this enumerator, if any.

  values  com.genesyslab.ail.ws.resource.EnumeratorValue[]
   The values of this enumerator.

  displayName  String
   The display name of this enumerator.

EnumeratorValue

This class describes the enumerator value.

Fields:

  description  String
   The description.

  annex  com.genesyslab.ail.ws.KeyValue[]
   The annex.

  displayName  String
   The display name of this value. This display name should be used for all GUI purposes.

  id  String
   The identifier of this enumerator value.

MediaTypeName

This class gives information about association media name media type.

Fields:

  name  String
   The medium name.

  type  com.genesyslab.ail.ws.place.MediaType
   The medium type.

PersonSummaryDTO

Describes the DTO data for a person summary. Summary objects are intended for getting quickly a list of objects without having to fully download each object.

Fields:

  data  com.genesyslab.ail.ws.KeyValue[]
   The DTO attributes.

  personId  String
   The person identifier.

PlaceSummaryDTO

Describes the DTO data for a place summary. Summary objects are intended for getting quickly a list of objects without having to fully download each object.

Fields:

  data  com.genesyslab.ail.ws.KeyValue[]
   The DTO attributes.

  placeId  String
   The place identifier.

QueueSummaryDTO

Describes the DTO data for a queue summary. Summary objects are intended for getting quickly a list of objects without having to fully download each object.

Fields:

  data  com.genesyslab.ail.ws.KeyValue[]
   The DTO attributes.

  queueId  String
   The queue identifier.

SkillSummaryDTO

Describes the DTO data for a skill summary. Summary objects are intended for getting quickly a list of objects without having to fully download each object.

Fields:

  data  com.genesyslab.ail.ws.KeyValue[]
   The DTO attributes.

  skillId  String
   The skill identifier.

Timezone

Describes a time zone.

Fields:

  id  String
   The time zone identifier.

  displayName  String
  

  rawOffset  int
   The amount of time in seconds to add to UTC to get standard time in this time zone. Because this value is not affected by daylight saving time.

WorkbinSummaryDTO

Describes the DTO data for a workbin summary. Summary objects are intended for getting quickly a list of objects without having to fully download each object.

Fields:

  data  com.genesyslab.ail.ws.KeyValue[]
   The DTO attributes.

  workbinId  String
   The workbin identifier.

Enum Detail

InteractionAttributeMetaDataType

This enum lists the possible types of an interaction attribute metaData.

Members:

  INTEGER
   Interaction attribute type Integer.

  STRING
   Interaction attribute type String.

  DATE
   Interaction attribute type date.

ActionCodeType

This enum describes the possible action codes.

Members:

  NONE
   'none' action code.

  BUSY_OFF
   'busy-off' action code.

  BUSY_ON
   'busy-on' action code.

  FORWARD_OFF
   'forward-off' action code.

  FORWARD_ON
   'forward-on' action code.

  INBOUND_CALL
   'inbound-call' action code.

  OUTBOUND_CALL
   'outbound-call' action code.

  INTERNAL_CALL
   'internal-call' action code.

  LOGIN
   'login' action code.

  LOGOUT
   'logout' action code.

  READY
   'ready' action code.

  NOT_READY
   'not-ready' action code.

  CONFERENCE
   'conference' action code.

  TRANSFER
   'transfer' action code.

CustomAttachedDataType

This enum lists the possible types of custom attached data.

Members:

  STRING
   Custom attached data type String.

  INTEGER
   Custom attached datatype Integer.

DnSummaryType

This enum lists the different summary types for a DN.

Members:

  EXT_ROUTING_POINT
   External routing point.

  ROUTING_POINT
   Routing point.

  ROUTING_QUEUE
   Routing queue.

  VIRTUAL_ROUTING_POINT
   Virtual routing point.

  QUEUE
   Queue.

  MEDIA
   Media.

  VIRTUAL_QUEUE
   Virtual ACD Queue.

EnumeratorType

This enum lists the possible types of an enumerator.

Members:

  CONTACT_ATTRIBUTE
   Contact attribute.

  CUSTOM
   Custom.

  INT_OP_ATT
   Interaction operational attribute.

  ROLE
   Role.

Interaction SDK
(Web Services)