Interaction SDK
(Web Services)

com.genesyslab.ail.ws.agent

Class Summary
AfterCallWorkVoiceForm This class defines a data form used by the agent service to perform an After Call Work agent action.
AgentListDTO This class describes a list of agent DTOs.
DnActionsPossible This class lists the possible actions that an agent can perform on this DN.
DnWorkmodesPossible This class lists the workmode types that an agent can use with this DN.
LoginIdPersonId This class describes the login identifier associated to a person identifier.
LoginIdsSwitch This class describes the Login identifiers of a switch.
LoginVoiceForm This class defines a voice data form used by the agent service to perform a Login agent action.
LogoutVoiceForm This class defines a voice data form used by the agent service to perform a Logout agent action.
MediaActionsPossible This class lists the possible actions that an agent can perform on this medium.
MediaForm This class defines a data form for an agent action applied to a medium.
MediaInfoError This container describes the updated media or voice media information and error (if one) after an agent action was performed on a media.
PasswordReason This class defines result which occurred when updating or checking the password of a person.
PersonDTO This class describes the DTO data for a person.
PersonError This class defines an error which occurred when updating the data of a person.
ReadyVoiceForm This class defines a voice data form used by the agent service to perform an Ready or Not-ready agent action.
ResourceProperty This class describes a resource which is an agent's element for configuration purpose Example: dictionary, color of background and so on. The value type is either a byte[] or a String.
ResourcePropertyKeyValue This class describes a resource key-value which is an agent's element for configuration purpose Example: dictionary, color of background and so on. The value type is either a byte[] or a String.
Skill This class defines an agent skill. Refer to the Configuration Layer documentation for further information.

Enum Summary
AgentDnAction This enumeration lists the possible actions of an agent on a DN.
AgentDnEventReason This enum lists the possible event reasons on an agent’s DN.
AgentMediaAction This enum lists an agent’s possible actions on a medium.
AgentMediaEventReason This enum lists the possible event reasons on an agent’s medium.
WorkmodeType This enum defines a workmode type.

Class Detail

AfterCallWorkVoiceForm

This class defines a data form used by the agent service to perform an After Call Work agent action.

Fields:

  dnIds  String[]
   The after-call work action applies to those Dns. If this field is null, the after-call work action applies to all DNs associated with the agent specified in parameter of the afterCallwork() method.

  queue  String
   The queue to apply this after-call work action to. Can be null.

  reasons  com.genesyslab.ail.ws.KeyValue[]
   The User defined reasons for getting after call work. Can be null. The value of the key-value can be a string, an int, a byte[] or com.genesyslab.ail.ws.KeyValue[] type.

  TExtensions  com.genesyslab.ail.ws.KeyValue[]
   Additional data that takes into account switch-specific features. Can be null. The value of the key-value can be a string, an int, a byte[] or com.genesyslab.ail.ws.KeyValue[] type.

AgentListDTO

This class describes a list of agent DTOs.

Fields:

  agentsDTO  com.genesyslab.ail.ws.agent.PersonDTO[]
   The agent DTOs.

  nbAgents  int
   The total number of agents configured in CME.

DnActionsPossible

This class lists the possible actions that an agent can perform on this DN.

Fields:

  dnId  String
   The DN identifier.

  agentActions  com.genesyslab.ail.ws.agent.AgentDnAction[]
   The actions that an agent can perform on this DN.

DnWorkmodesPossible

This class lists the workmode types that an agent can use with this DN.

Fields:

  dnId  String
   The DN identifier.

  workmodeTypes  com.genesyslab.ail.ws.agent.WorkmodeType[]
   The possible workmode types on this DN.

LoginIdPersonId

This class describes the login identifier associated to a person identifier.

Fields:

  loginId  String
   The Login identifier.

  personId  String
   The Person identifier.

LoginIdsSwitch

This class describes the Login identifiers of a switch.

Fields:

  loginIds  String[]
   The Login identifiers.

  switch  com.genesyslab.ail.ws.Switch
   The switch description.

LoginVoiceForm

This class defines a voice data form used by the agent service to perform a Login agent action.

Fields:

  dnIds  String[]
   The login() method is applied to these DNs. If this field is null, this method is applied to all DNs associated with this agent.

  loginId  String
   The Login ID of the agent.

  password  String
   The password for this Login ID.

  queue  String
   The queue to apply this (Login) action to. Can be null.

  workmode  com.genesyslab.ail.ws.agent.WorkmodeType
   The workmode to apply this (Login) action.

  reasons  com.genesyslab.ail.ws.KeyValue[]
   Reasons specified by this agent for this Login action. Can be null.

  TExtensions  com.genesyslab.ail.ws.KeyValue[]
   Switch-specific data. Can be null. Refer to your T-Server documentation for further information.

LogoutVoiceForm

This class defines a voice data form used by the agent service to perform a Logout agent action.

Fields:

  dnIds  String[]
   The logout() method is applied to these DNs. If this field is null, this method is applied to all DNs associated with this agent.

  queue  String
   The queue to apply this Logout action to. Can be null.

  reasons  com.genesyslab.ail.ws.KeyValue[]
   Reasons specified by this agent for this Logout action. Can be null. The value of the key-value can be a string, an int, a byte[] or com.genesyslab.ail.ws.KeyValue[] type.

  TExtensions  com.genesyslab.ail.ws.KeyValue[]
   Switch-specific data. Can be null. Refer to your T-Server documentation for further information. The value of the key-value can be a string, an int, a byte[] or com.genesyslab.ail.ws.KeyValue[] type.

MediaActionsPossible

This class lists the possible actions that an agent can perform on this medium.

Fields:

  mediaType  com.genesyslab.ail.ws.place.MediaType
   The media type.

  agentActions  com.genesyslab.ail.ws.agent.AgentMediaAction[]
   The actions that an agent can perform on this media.

  mediaName  String
   The media name.

MediaForm

This class defines a data form for an agent action applied to a medium.

Fields:

  mediaNames  String[]
   The media name list. If this field is null, the agent action applies to all media associated with this agent.

  reason  String
   The reason associated to the media list. Null, if no reason.

  reasonDescription  String
   The reason description associated to the media list. Null, if no description.

MediaInfoError

This container describes the updated media or voice media information and error (if one) after an agent action was performed on a media.

Fields:

  error  String
   The agent action error code. Null if no error.

  mediaInfo  com.genesyslab.ail.ws.place.MediaInfo
   The media information. Null if the container concerns a voice media (DN).

  voiceMediaInfo  com.genesyslab.ail.ws.place.VoiceMediaInfo
   The voice media (DN) information. Null if the container concerns a media.

  errorDescription  String
   The agent action error description. Null if no error.

PasswordReason

This class defines result which occurred when updating or checking the password of a person.

Fields:

  success  boolean
   The operation success.

  reason  String
   The last reason.

PersonDTO

This class describes the DTO data for a person.

Fields:

  data  com.genesyslab.ail.ws.KeyValue[]
   The key-value pair attributes.

  personId  String
   The person identifier.

PersonError

This class defines an error which occurred when updating the data of a person.

Fields:

  personError  String
   The person error code.

  personId  String
   The person identifier.

  attributeErrors  com.genesyslab.ail.ws.AttributeError[]
   The person attributes' error codes.

ReadyVoiceForm

This class defines a voice data form used by the agent service to perform an Ready or Not-ready agent action.

Fields:

  dnIds  String[]
   The Ready() or notReady() method is applied to these DNs. If this field is null, this method is applied to all DNs associated with this agent.

  queue  String
   The queue to apply this Ready or Not-ready action to. Can be null.

  workmode  com.genesyslab.ail.ws.agent.WorkmodeType
   The workmode. If null, the value is then interpreted as WorkmodeType.UNKNOWN.

  reasons  com.genesyslab.ail.ws.KeyValue[]
   Reasons specified by this agent for this Ready or Not-ready action. Can be null. The value of the key-value can be a string, an int, a byte[] or com.genesyslab.ail.ws.KeyValue[] type.

  TExtensions  com.genesyslab.ail.ws.KeyValue[]
   Switch-specific data. Can be null. Refer to your T-Server documentation for further information. The value of the key-value can be a string, an int, a byte[] or com.genesyslab.ail.ws.KeyValue[] type.

ResourceProperty

This class describes a resource which is an agent's element for configuration purpose Example: dictionary, color of background and so on. The value type is either a byte[] or a String.

Fields:

  key  String
   The resource key for example: "SpellDictionary"..

  id  String
   The resource identifier.

  personId  String
   The person identifier who is the owner of this resource.

  binValue  byte[]
   The resource value as a byte[].

  stringValue  String
   The resource value as a String.

ResourcePropertyKeyValue

This class describes a resource key-value which is an agent's element for configuration purpose Example: dictionary, color of background and so on. The value type is either a byte[] or a String.

Fields:

  key  String
   The resource key for example: "SpellDictionary"..

  binValue  byte[]
   The resource value as a byte[].

  stringValue  String
   The resource value as a String.

Skill

This class defines an agent skill. Refer to the Configuration Layer documentation for further information.

Fields:

  name  String
   The skill name.

  level  int
   The skill level.

Enum Detail

AgentDnAction

This enumeration lists the possible actions of an agent on a DN.

Members:

  LOGIN
   'login' action.

  LOGOUT
   'logout' action.

  READY
   'ready' action.

  NOT_READY
   'not-ready' action.

  AFTERCALLWORK
   'after-call work' action.

  CREATE_INTERACTION
   'create interaction' action. Related to createInteraction() in InteractionVoiceService.

  RELEASE_DN
   'release DN' action. Related to releaseDn() in DnService.

AgentDnEventReason

This enum lists the possible event reasons on an agent’s DN.

Members:

  LOGGED_IN
   Logged-in reason.

  STATUS_CHANGED
   Status-changed reason.

  INFO_CHANGED
   Info-changed reason.

AgentMediaAction

This enum lists an agent’s possible actions on a medium.

Members:

  LOGIN
   'login' action.

  LOGOUT
   'logout' action.

  READY
   'ready' action.

  NOT_READY
   'not-ready' action.

  CREATE_INTERACTION
   'create interaction' action.

AgentMediaEventReason

This enum lists the possible event reasons on an agent’s medium.

Members:

  STATUS_CHANGED
   Status-changed reason.

WorkmodeType

This enum defines a workmode type.

Members:

  UNKNOWN
   workmode 'unknown'.

  AFTERCALLWORK
   workmode 'after-call work'.

  AUTO_IN
   workmode 'auto in'.

  AUX_WORK
   workmode 'aux work'.

  MANUAL_IN
   workmode 'manual in'.

  NO_CALL_DISCONNECT
   workmode 'no call disconnect'.

  RETURN_BACK
   workmode 'return back'.

  WALK_AWAY
   workmode 'walk away'.

Interaction SDK
(Web Services)