Interaction SDK
(Web Services)

Service: RoutingService


This service manages interactions that has been routed on a routing point.
Attribute Summary
String routing.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.
String routing.dn:dnId
           The DN identifier.
com.genesyslab.ail.ws.routing.RoutingDnEventReason routing.dn:eventReason
           The event reason of this DN event.
com.genesyslab.ail.ws.routing.RoutingDnType routing.dn:routingType
           The type of the routing point.
com.genesyslab.ail.ws.routing.RoutingDnStatus routing.dn:status
           The current status of this DN.
com.genesyslab.ail.ws.dn.SwitchInfo routing.dn:switchInfo
           Information about the switch of this routing point.
com.genesyslab.ail.ws.interaction.AttachedData[] routing.interaction:addAttachedData
           Adds the data attached to this interaction.
String routing.interaction:ANI
           The ANI (Automatic Number Identification) parameter associated with this voice interaction.
com.genesyslab.ail.ws.interaction.AttachedData[] routing.interaction:attachedData
           The data attached to this interaction.
com.genesyslab.ail.ws.routing.RoutingCallType routing.interaction:calltype
           The call type of the routed interaction on this routing point.
String routing.interaction:dnId
           The DN on which this interaction is bound.
String routing.interaction:DNIS
           The DNIS (Dialed Number Identification Service) parameter associated with this voice interaction.
com.genesyslab.ail.ws.routing.RoutingInteractionEventReason routing.interaction:eventReason
           The event reason.
com.genesyslab.ail.ws.routing.RoutingInteractionExtension[] routing.interaction:extensions
           The extended information about this interaction.
String routing.interaction:interactionId
           The interaction identifier.
com.genesyslab.ail.ws.interaction.AttachedData[] routing.interaction:modifiedAttachedData
           Present when attached data may have changed through an interaction event. Contains all attached data, not only the modified ones.
String[] routing.interaction:removeAttachedData
           Removes the data attached to this interaction.
com.genesyslab.ail.ws.routing.RoutingInteractionStatus routing.interaction:status
           The current status of this interaction.
String routing.interaction:TConnectionId
           The TConnectionId of this interaction. This ID is an internal T-Server data. Consider this as an advanced feature and rather use the interactionId attribute.

Method Summary
com.genesyslab.ail.ws.routing.RoutingDnDTO[] getRoutingDnsDTO
           Retrieves all the requested attributes on the specified routing DNs.
com.genesyslab.ail.ws.routing.RoutingDnInteractionDTO[] getRoutingInteractionsDTO
           Retrieves all the requested attributes on routing interactions.
com.genesyslab.ail.ws.routing.RoutingInteractionError[] setRoutingInteractionsDTO
           Sets the data on these routing interactions.

Event Summary
DnEvent
           Routing DN event.
InteractionEvent
           Routing interaction event.

Attribute Detail

Attributes of domain routing.dn

Routing DN attributes definition


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


dnId

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


eventReason

Type: com.genesyslab.ail.ws.routing.RoutingDnEventReason
The event reason of this DN event.
Properties: event-default event


routingType

Type: com.genesyslab.ail.ws.routing.RoutingDnType
The type of the routing point.
Properties: read read-default


status

Type: com.genesyslab.ail.ws.routing.RoutingDnStatus
The current status of this DN.
Properties: read read-default


switchInfo

Type: com.genesyslab.ail.ws.dn.SwitchInfo
Information about the switch of this routing point.
Properties: read read-default


Attributes of domain routing.interaction

Routing interaction attributes definition


addAttachedData

Type: com.genesyslab.ail.ws.interaction.AttachedData[]
Adds the data attached to this interaction.
Properties: write


ANI

Type: String
The ANI (Automatic Number Identification) parameter associated with this voice interaction.
Properties: read read-default event-default event


attachedData

Type: com.genesyslab.ail.ws.interaction.AttachedData[]
The data attached to this interaction.
Properties: read read-default write event


calltype

Type: com.genesyslab.ail.ws.routing.RoutingCallType
The call type of the routed interaction on this routing point.
Properties: read read-default event-default event


dnId

Type: String
The DN on which this interaction is bound.
Properties: read read-default event-default event


DNIS

Type: String
The DNIS (Dialed Number Identification Service) parameter associated with this voice interaction.
Properties: read read-default event-default event


eventReason

Type: com.genesyslab.ail.ws.routing.RoutingInteractionEventReason
The event reason.
Properties: event-default event


extensions

Type: com.genesyslab.ail.ws.routing.RoutingInteractionExtension[]
The extended information about this interaction.
Properties: event


interactionId

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


modifiedAttachedData

Type: com.genesyslab.ail.ws.interaction.AttachedData[]
Present when attached data may have changed through an interaction event. Contains all attached data, not only the modified ones.
Properties: event


removeAttachedData

Type: String[]
Removes the data attached to this interaction.
Properties: write


status

Type: com.genesyslab.ail.ws.routing.RoutingInteractionStatus
The current status of this interaction.
Properties: read read-default event-default event


TConnectionId

Type: String
The TConnectionId of this interaction. This ID is an internal T-Server data. Consider this as an advanced feature and rather use the interactionId attribute.
Properties: read event


Method Detail

getRoutingDnsDTO

Retrieves all the requested attributes on the specified routing DNs.
Parameters:

  dnIds  String[]
   The DN identifiers.

  attributes  String[]
   The attributes to retrieve (routing.dn:*).

Returns:

  Type:  com.genesyslab.ail.ws.routing.RoutingDnDTO[]

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

Errors:

  error.common.AilFactoryNotInitialized


getRoutingInteractionsDTO

Retrieves all the requested attributes on routing interactions.
Parameters:

  dnIds  String[]
   The DN identifiers.

  attributes  String[]
   The attributes to retrieve (routing.interaction:*).

Returns:

  Type:  com.genesyslab.ail.ws.routing.RoutingDnInteractionDTO[]

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

Errors:

  error.common.AilFactoryNotInitialized


setRoutingInteractionsDTO

Sets the data on these routing interactions.
Parameters:

  datas  com.genesyslab.ail.ws.routing.RoutingInteractionDTO[]
   The attributes to set for each routing interaction (routing.interaction:*).

Returns:

  Type:  com.genesyslab.ail.ws.routing.RoutingInteractionError[]

   The errors on each routing interaction.

Errors:

  error.common.AilFactoryNotInitialized

  error.routing.BadInteractionId
  

  error.common.RequestFailed
  

  error.common.BadAttributeType
  


Event Detail

DnEvent

Routing DN event.
Available attributes:  routing.dn:*

Filters:

  Key: EVENT_REASON   Value: one routing Dn event reason value.  -  See RoutingDnEventReason definition

  Key: STATUS_CHANGED   Value: one routing Dn status value.  -  See RoutingDnStatus definition

Triggers:

  Key: DN   Value: dnId  -  Subscribes on this routing DN


InteractionEvent

Routing interaction event.
Available attributes:  routing.interaction:*

Filters:

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

  Key: STATUS_CHANGED   Value: one interaction status value.  -  See RoutingInteractionStatus definition

Triggers:

  Key: DN   Value: dnId  -  Subscribes on this DN


Interaction SDK
(Web Services)