Interaction SDK
(Web Services)

Service: DnService


The DN Service handles DN specifics.
Attribute Summary
com.genesyslab.ail.ws.dn.DnAction[] dn:actionsPossible
           The possible actions of this DN.
String dn:agentId
           The ID of the agent currently logged in this DN.
com.genesyslab.ail.ws.KeyValue[] dn:annex
           Additional infomation about this DN. This corresponds to the 'Annex' tab in the Configuration Layer.
String dn:callableNumber
           Callable number of this DN recognized by the switch. You have to use it for making calls, transfering calls, conferencing calls, and so on.
com.genesyslab.ail.ws.agent.WorkmodeType dn:currentWorkmode
           The current workmode of the agent on this DN.
com.genesyslab.ail.ws.dn.DnStatus dn:dndStatus
           The DND status of this DN. Note: Status.ON means here that an DNDOn event has been received on this DN. Status.OFF means that an DNDOff event has been received on this DN.
String dn:dnId
           The DN identifier.
com.genesyslab.ail.ws.dn.DnEventReason dn:eventReason
           The reason why this event occurred.
String dn:forwardNumber
           The destination number, if the forward is active; otherwise null.
com.genesyslab.ail.ws.dn.DnStatus dn:forwardStatus
           The Forward status of this DN.
com.genesyslab.ail.ws.dn.DnStatus dn:hookStatus
           The Hook status of this DN. Note: Status.ON means here that an OnHook event has been received on this DN. Status.OFF means that an OffHook event has been received on this DN.
com.genesyslab.ail.ws.KeyValue[] dn:lastReasonCode
           Provides the last reason code and reasons data seen on this DN.
String[] dn:loggedQueues
           Queues where the agent is logged in.
com.genesyslab.ail.ws.dn.DnStatus dn:status
           The current status of this DN.
com.genesyslab.ail.ws.dn.SwitchInfo dn:switchInfo
           Information about the switch of this DN.
com.genesyslab.ail.ws.KeyValue[] dn:TEventExtensions
           TEvent extensions. TEvent extensions are additional data that take into account switch-specific features.
com.genesyslab.ail.ws.KeyValue[] dn:TEventReasons
           Switch-specific reasons that might have come with the TEvent that caused this event.
com.genesyslab.ail.ws.agent.WorkmodeType[] dn:workmodesPossible
           The possible workmodes for this DN.
String dn.user-data:TConnectionId
           The TConnectionId associated with the user event, if any.
com.genesyslab.ail.ws.KeyValue[] dn.user-data:userData
           Attached data sent with a user event to the T-Server.

Method Summary
void cancelForward
           Cancels the forward on the associated DN.
com.genesyslab.ail.ws.dn.DnDTO[] getDnsDTO
           Retrieves all the requested attributes about DNs.
com.genesyslab.ail.ws.dn.SwitchInfo[] getSwitchInfos
           Gets information about swithes.
void releaseDn
           Releases all the interactions currently running on this DN.
void sendUserEvent
           Sends a user event to the T-Server with attached data.
void setDNDOff
           Sets the Do-Not-Disturb feature to Off.
void setDNDOn
           Sets the Do-Not-Disturb feature to On.
void setForward
           Sets the forward on the associated DN.

Event Summary
DnEvent
           DN event.
DnUserEvent
           DN user event.

Attribute Detail

Attributes of domain dn

DN attributes definition


actionsPossible

Type: com.genesyslab.ail.ws.dn.DnAction[]
The possible actions of this DN.
Properties: read event


agentId

Type: String
The ID of the agent currently logged in this DN.
Properties: read read-default


annex

Type: com.genesyslab.ail.ws.KeyValue[]
Additional infomation about this DN. This corresponds to the 'Annex' tab in the Configuration Layer.
Properties: read


callableNumber

Type: String
Callable number of this DN recognized by the switch. You have to use it for making calls, transfering calls, conferencing calls, and so on.
Properties: read


currentWorkmode

Type: com.genesyslab.ail.ws.agent.WorkmodeType
The current workmode of the agent on this DN.
Properties: read event


dndStatus

Type: com.genesyslab.ail.ws.dn.DnStatus
The DND status of this DN. Note: Status.ON means here that an DNDOn event has been received on this DN. Status.OFF means that an DNDOff event has been received on this DN.
Properties: read event


dnId

Type: String
The DN identifier.
Properties: event-default event


eventReason

Type: com.genesyslab.ail.ws.dn.DnEventReason
The reason why this event occurred.
Properties: event-default event


forwardNumber

Type: String
The destination number, if the forward is active; otherwise null.
Properties: read event


forwardStatus

Type: com.genesyslab.ail.ws.dn.DnStatus
The Forward status of this DN.
Properties: read event


hookStatus

Type: com.genesyslab.ail.ws.dn.DnStatus
The Hook status of this DN. Note: Status.ON means here that an OnHook event has been received on this DN. Status.OFF means that an OffHook event has been received on this DN.
Properties: read event


lastReasonCode

Type: com.genesyslab.ail.ws.KeyValue[]
Provides the last reason code and reasons data seen on this DN.
Properties: read


loggedQueues

Type: String[]
Queues where the agent is logged in.
Properties: read


status

Type: com.genesyslab.ail.ws.dn.DnStatus
The current status of this DN.
Properties: read event


switchInfo

Type: com.genesyslab.ail.ws.dn.SwitchInfo
Information about the switch of this DN.
Properties: read


TEventExtensions

Type: com.genesyslab.ail.ws.KeyValue[]
TEvent extensions. TEvent extensions are additional data that take into account switch-specific features.
Properties: event


TEventReasons

Type: com.genesyslab.ail.ws.KeyValue[]
Switch-specific reasons that might have come with the TEvent that caused this event.
Properties: event


workmodesPossible

Type: com.genesyslab.ail.ws.agent.WorkmodeType[]
The possible workmodes for this DN.
Properties: read


Attributes of domain dn.user-data

DN user attributes definition


TConnectionId

Type: String
The TConnectionId associated with the user event, if any.
Properties: event


userData

Type: com.genesyslab.ail.ws.KeyValue[]
Attached data sent with a user event to the T-Server.
Properties: event-default event


Method Detail

cancelForward

Cancels the forward on the associated DN.
Parameters:

  dnId  String
   The DN identifier.

  reasons  com.genesyslab.ail.ws.KeyValue[]
   Additional information associated with this action. Or null if no reason is provided. 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 switch-specific information that has to be transmitted with this request. Or null if no extension is provided. The value of the key-value can be a string, an int, a byte[] or com.genesyslab.ail.ws.KeyValue[] type.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.dn.DnNotExist


getDnsDTO

Retrieves all the requested attributes about DNs.
Parameters:

  dnIds  String[]
   The DN identifiers.

  attributes  String[]
   The keys of the attributes to retrieve (dn:*).

Returns:

  Type:  com.genesyslab.ail.ws.dn.DnDTO[]

   The attributes for each DN. NB : if the dn identifier is invalid, it does not return data for the associated dn.

Errors:

  error.common.AilFactoryNotInitialized


getSwitchInfos

Gets information about swithes.
Parameters:

  switchNames  String[]
   The switches names.

Returns:

  Type:  com.genesyslab.ail.ws.dn.SwitchInfo[]

   The Swithes information.

Errors:

  error.common.AilFactoryNotInitialized

  error.common.ParameterInvalid


releaseDn

Releases all the interactions currently running on this DN.
Parameters:

  dnId  String
   The DN identifier.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.dn.DnNotExist


sendUserEvent

Sends a user event to the T-Server with attached data.
Parameters:

  dnId  String
   The DN identifier.

  data  com.genesyslab.ail.ws.KeyValue[]
   The data to set in the user event. The value of the key-value supported can be a string, an int, a byte[] or com.genesyslab.ail.ws.Key[] type. If the "AttributeConnID" key is present, it is removed and its String value is used to fill the ConnID field of the user event.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.dn.DnNotExist


setDNDOff

Sets the Do-Not-Disturb feature to Off.
Parameters:

  dnId  String
   The DN identifier.

  reasons  com.genesyslab.ail.ws.KeyValue[]
   Additional information associated with this action. Or null if no reason is provided. The value of the key-value supported can be a string, an int, a byte[] or com.genesyslab.ail.ws.Key[] type.

  tExtensions  com.genesyslab.ail.ws.KeyValue[]
   Additional switch-specific information that has to be transmitted with this request. Or null if no extension is provided. The value of the key-value supported can be a string, an int, a byte[] or com.genesyslab.ail.ws.Key[] type.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.dn.DnNotExist


setDNDOn

Sets the Do-Not-Disturb feature to On.
Parameters:

  dnId  String
   The DN identifier.

  reasons  com.genesyslab.ail.ws.KeyValue[]
   Additional information associated with this action. Or null if no reason is provided. 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 switch-specific information that has to be transmitted with this request. Or null if no extension is provided. The value of the key-value can be a string, an int, a byte[] or com.genesyslab.ail.ws.KeyValue[] type.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.dn.DnNotExist


setForward

Sets the forward on the associated DN.
Parameters:

  dnId  String
   The DN identifier.

  number  String
   The number to forward to.

  reasons  com.genesyslab.ail.ws.KeyValue[]
   Additional information associated with this action. Or null if no reason is provided. 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 switch-specific information that has to be transmitted with this request. Or null if no extension is provided. The value of the key-value can be a string, an int, a byte[] or com.genesyslab.ail.ws.KeyValue[] type.

Returns:

  void

Errors:

  error.common.AilFactoryNotInitialized

  error.common.RequestFailed

  error.dn.DnNotExist


Event Detail

DnEvent

DN event.
Available attributes:  dn:*

Filters:

  Key: EVENT_REASON   Value: one event reason value.  -  See DnEventReason definition

Triggers:

  Key: DN   Value: dnId  -  Subscribes on this DN


DnUserEvent

DN user event.
Available attributes:  dn.user-data:*,dn:*

Filters:

Triggers:

  Key: DN   Value: dnId  -  Subscribes on this DN


Interaction SDK
(Web Services)