Package com.ibm.soa.parlayx21.call_handling

Call Handling.

See:
          Description

Interface Summary
CallHandling The CallHandling class provides a rules based processing capability that is accessible to Applications through a set of operations that allow definition of discrete rules.
CallHandling_RI  
CallHandlingHome  
CallHandlingService  
 

Class Summary
CallHandlingBindingStub  
CallHandlingProxy  
CallHandlingRules This structure containing the set of rules that are applied when the call is handled.
CallHandlingRules_Deser  
CallHandlingRules_Helper  
CallHandlingRules_Ser  
CallHandlingServiceInformation  
CallHandlingServiceLocator  
ConditionalForward This is the information on the handling of the forwarding for specific calling numbers.
ConditionalForward_Deser  
ConditionalForward_Helper  
ConditionalForward_Ser  
InteractionContent These are the types of the content that may be used for user interaction.
SetRulesResult This is the result of the setRules operation for each address.
SetRulesResult_Deser  
SetRulesResult_Helper  
SetRulesResult_Ser  
TextInteraction Information for the processing by a text to speech engine.
TextInteraction_Deser  
TextInteraction_Helper  
TextInteraction_Ser  
UnconditionalForward This is the information for the handling of the forwarding unconditionally.
UnconditionalForward_Deser  
UnconditionalForward_Helper  
UnconditionalForward_Ser  
VoiceInteraction This is the inforamation provided to the system for a call that is to be handled by an interactive voice system.
VoiceInteraction_Deser  
VoiceInteraction_Helper  
VoiceInteraction_Ser  
 

Package com.ibm.soa.parlayx21.call_handling Description

Call Handling.

Common Data Types

For common data types associated with this package see Common Data Types.

Scope

The present document is part 10 of the Stage 3 Parlay X 2 Web Services specification for Open Service Access (OSA).

The OSA specifications define an architecture that enables application developers to make use of network functionality through an open standardized interface, for example, the OSA APIs.

The present document specifies the Call Handling Web Service. The following are defined here:
  * Name spaces.
  * Sequence diagrams.
  * Data definitions.
  * Interface specification plus detailed method descriptions.
  * Fault definitions.
  * Service Policies.
  * WSDL Description of the interfaces.

References

The following documents contain provisions which, through reference in this text, constitute provisions of the present document.
  * References are either specific (identified by date of publication and/or edition number or version number) or nonspecific.
  * For a specific reference, subsequent revisions do not apply.
  * For a non-specific reference, the latest version applies.

Referenced documents which are not found to be publicly available in the expected location might be found at http://docbox.etsi.org/Reference.

[1] W3C Recommendation (2 May 2001): "XML Schema Part 2: Datatypes".

NOTE: Available at http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/.

[2] ETSI ES 202 391-1: "Open Service Access (OSA); Parlay X 2 Web Services; Part 1: Common".

Definitions and abbreviations

Definitions

For the purposes of the present document, the terms and definitions given in ES 202 391-1 [2] apply.

Abbreviations

For the purposes of the present document, the abbreviations defined in ES 202 391-1 [2] apply.

Detailed service description

The Call Handling Web Service provides a mechanism for an application to specify how calls are to be handled for a specific number. Call handling includes commonly utilized actions:
  * Call accepting - only accepting calls from a list of numbers.
  * Call blocking - blocking calls if they are on a blocking list.
  * Conditional call forwarding - changing the destination of a call to another number for a specific calling number.
  * Unconditional call forwarding - changing the destination of a call to another number.
  * Play audio - initiate audio with the caller (for example, an announcement or menu).

The set of rules are provided to the Web Service which is responsible for establishing the call handling function. Only one action is taken for a call, and once this action is started the rules will stop being processed.

There is a specific order in which these rules are processed, providing a predictable call handling expectation for rules provided. The processing is done as follows:

1) Call accepting determines if the call is accepted or rejected. If the caller is not on the accept list, the call is rejected and rule processing ends.

2) Call blocking determines if the call is rejected. If the caller is on the block list, the call is rejected and rule processing ends.

3) Conditional call forwarding - each calling number that has a specific forwarding instruction is checked, and the call is forwarded on a match, and rule processing ends.

4) Unconditional call forwarding - the called number is changed to the call forwarding number and rule processing ends.

5) Play audio - the call is handled by a voice system, which handles all further processing of the call. Rule processing ends when the call is handed off.

6) Continue processing call, to complete call to the original called number.

If no rules are specified in a particular area, then that step is skipped. If the rule processing ends without any action being indicated, then the call will continue to the called number.

Call Handling provides its function without further interaction with the Application. This is in contrast to the Call Notification interfaces which provide notifications to the Application for processing.

Namespaces

The Call Handling interface uses the namespace: http://www.csapi.org/wsdl/parlayx/call_handling/v2_23

The data types are defined in the namespace: http://www.csapi.org/schema/parlayx/call_handling/v2_23

The 'xsd' namespace is used in the present document to refer to the XML Schema data types defined in XML Schema [1]. The use of the name 'xsd' is not semantically significant.

Sequence diagrams

Setup call handling, query and clear rules

Pattern: Request / Response.

This sequence shows the application setting up Call Handling with rules to be processed, querying those rules and clearing them.

Figure 1

XML Schema data type definition

ConditionalForward structure

Information on the handling of the forwarding for specific calling numbers.


callingAddress xsd:anyURI

Address that call is placed from
forwardingAddress xsd:anyURI

Address to forward call to
onBusyAddress xsd:anyURI

If line is busy at forwarding address, forward to this address
onNoAnswerAddress xsd:anyURI

If no answer at forwarding address, forward to this address

UnconditionalForward structure

Information for the handling of the forwarding unconditionally.


forwardingAddress xsd:anyURI

Address to forward call to
onBusyAddress xsd:anyURI

If line is busy at forwarding address, forward to this address
onNoAnswerAddress xsd:anyURI

If no answer at forwarding address, forward to this address

InteractionContent enumeration

The following are the types of the content that may be used for user interaction.


TextInfo Text to be processed by a Text-To-Speech engine.
VoiceXml VoiceXML to be processed by a VoiceXML browser.
Audio This is the Audio file to be played by an audio processor.

TextInteraction structure

This is the information for the processing by a text to speech engine.


text xsd:string

Text to play through a Text-To-Speech engine
language xsd:string

Language of text

VoiceInteraction union

For a call that is to be handled by an interactive voice system, the information to provide to that system.


UnionElement InteractionContent

Type of content provided (one of the following)
TextInfo TextInteraction

Announcement to play through a Text-To-Speech engine
VoiceXml xsd:anyURI

Location of VoiceXML to use in a VoiceXML browser
Audio xsd:anyURI

Location of audio content (WAV or MP3 file)

CallHandlingRules structure

Structure containing the set of rules that are applied when the call is handled.


acceptList xsd:anyURI [0..unbounded]

List of addresses to accept calls from
blockList xsd:anyURI [0..unbounded]

List of addresses to block calls from
forwardList ConditionalForward [0..unbounded]

List of conditional forwarding addresses and destinations
forward UnconditionalForward

Unconditional call forwarding address
voiceInteractionContent VoiceInteraction

Forward call to a user interaction system with information on content

SetRulesResult structure

The Result of the setRules operation for each address.


address xsd:anyURI

Address to be set
successful xsd:boolean

Successfully set rules or not
error common:ServiceError

Error message if unsuccessful

Web Service interface definition

Fault definitions

No new faults defined for this service.

Service policies

Service policies for this service.


VoiceMailAvailable xsd:boolean Voice mail available or not
TextToSpeechAvailable xsd:boolean Service accepts text as an input for processing with a TextTo-Speech engine
AudioContentAvailable xsd:boolean Service accepts audio content for playing with an audio player
VoiceXmlAvailable xsd:boolean Service accepts VoiceXML for processing with a VoiceXML browser
AudioFormatsSupported xsd:string Comma separated string of audio formats supported (e.g. WAV, MP3, AU)
GroupSupport xsd:boolean Groups may be included with addresses
NestedGroupSupport xsd:boolean Are nested groups supported in group definitions



Copyright © 2003 IBM Corp. All Rights Reserved.