Package com.ibm.soa.parlayx21.audio_call

Audio Call.

See:
          Description

Interface Summary
AudioCall The AudioCall interface allows the playing of audio messages using different forms of audio content, and operations to monitor or cancel requests.
AudioCall_RI  
AudioCallHome  
AudioCallService  
 

Class Summary
AudioCallBindingStub  
AudioCallProxy  
AudioCallServiceInformation  
AudioCallServiceLocator  
MessageStatus Status of the message after the play message operation that has been invoked.
 

Package com.ibm.soa.parlayx21.audio_call Description

Audio Call.

Common Data Types

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

Scope

The present document is part 11 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 Audio Call service provides a flexible way to provide vocal message delivery. The interface is very simple, not requiring the developer to manage the creation of the call nor the interactions with the call to deliver the voice message.

There are three mechanisms which may be utilized for the vocal message content:
  * Text, to be rendered using a Text-To-Speech (TTS) engine.
  * Audio content (such as .WAV content), to be rendered by an audio player.
  * VoiceXML, to be rendered using a VoiceXML browser.

The service may provide one, two or all three mechanisms, with the service policies providing the mechanism for determining which are available.

Namespaces

The AudioCall interface uses the namespace: http://www.csapi.org/wsdl/parlayx/audio_call/v2_1

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

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

Play audio and check status

Pattern: Request / response.

This example shows an audio message being played, and the different responses to status requests that occur at different phases. Note that the last response, a service exception, reflects the transient nature of results, and that these results will expire.

Figure 1

Play audio and cancel

Pattern: Request / response.

The playing of a message may be ended by the requester, as shown.

Figure 2

XML Schema data type definition

MessageStatus enumeration

The Status of the message after the play message operation has been invoked.


Played Message has been played
Playing Message is currently playing
Pending Message has not yet started playing
Error An error has occurred, message will not be played

Web Service interface definition

Fault definitions

No new faults defined for this service.

Service policies

Service policies for this service.


TextToSpeechAvailable xsd:boolean Service accepts text as an input for processing with a TextToSpeech engine
AudioContentAvailable xsd:boolean Service accepts audio content for playing with an audio player
VoiceXMLAvailable xsd:boolean Service accepts VoiceXML as an input for processing with a VoiceXML browser
StatusRetainTime xsd:int Number of seconds status is retained for after a message is played or an error occurs
AudioFormatsSupported xsd:string Comma separated list of audio formats supported (for example, WAV, MP3, AU)
ChargingSupported xsd:boolean Is charging supported for the play operations



Copyright © 2003 IBM Corp. All Rights Reserved.