SIST ES 202 504-11 V1.1.1:2008
Open Service Access (OSA) - Parlay X Web Services - Part 11: Audio Call (Parlay X 3)
- Abstract
New edition of ParlayX specification based on requirements in EG 201 988-4, corresponding to 3GPP TS 29.199 Rel-7.The present document is part 11 of the Stage 3 Parlay X 3 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, i.e. 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.
The web service had been extended to support media.
- Status
- Published
- Publication Date
- 02-Jul-2008
- Technical Committee
- SPN - Services and Protocols for Networks
- Current Stage
- 6060 - National Implementation/Publication (Adopted Project)
- Start Date
- 12-Jun-2008
- Due Date
- 17-Aug-2008
- Completion Date
- 03-Jul-2008
Buy Documents
ETSI ES 202 504-11 V1.1.1 (2008-02) - Open Service Access (OSA); Parlay X Web Services; Part 11: Audio Call (Parlay X 3)
ETSI ES 202 504-11 V1.1.1 (2008-05) - Open Service Access (OSA); Parlay X Web Services; Part 11: Audio Call (Parlay X 3)
SIST ES 202 504-11 V1.1.1:2008 is the ETSI standard for Open Service Access (OSA) Parlay X Web Services, Part 11: Audio Call (Parlay X 3). It specifies the Call Handling Web Service for applications that control an ongoing call through an open standardized interface, including playing media, collecting digits, recording media, and changing media types for call participants. It is aimed at application developers, service providers, and system integrators that need to expose or use call-media control through the OSA APIs.
What does SIST ES 202 504-11 V1.1.1:2008 specify?
SIST ES 202 504-11 V1.1.1:2008 specifies the Audio Call web service in the Parlay X 3 Stage 3 specification for OSA. The document describes how an application can address an existing call session, select one or more call participants, and manage media interactions for them.
Clause 4 gives the service model, clause 5 defines namespaces, clause 6 gives sequence diagrams, clause 7 defines XML Schema data types, clause 8 defines the web service interfaces, clause 9 defines faults, and clause 10 defines service policies. Annex A contains the WSDL, and Annex B is the bibliography.
| Annex | What it covers |
|---|---|
| Annex A | Normative WSDL for Audio Call |
| Annex B | Informative bibliography |
What are the key requirements of SIST ES 202 504-11 V1.1.1:2008?
The standard is built around an existing Call Session and its Call Participants. In practice, that means an application does not create the call itself here - it targets a pre-existing session and then adds, removes, plays, or records media for selected participants.
Service model and capability control
Clause 4 says the service supports dynamic management of media for participants in an ongoing call. It covers audio and video streams and their direction, including incoming, outgoing, and bidirectional flow. For implementers, this means the service is not just about sending a prompt - it can change what media each participant can use during the call.
Clause 10 defines service policies such as TextToSpeechAvailable, AudioContentAvailable, VoiceXMLAvailable, DigitCollectionAvailable, RecordMessageAvailable, VideoAvailable, MultimediaSupported, and ChargingSupported. These policy flags matter because they tell an application what the service will accept before it tries a play, collect, record, or multimedia operation.
Media playback and status handling
Clause 8.1 defines the PlayMedia interface. The play operations - playTextMessage, playAudioMessage, playVoiceXmlMessage, and playVideoMessage - act asynchronously and return a correlator. In practice, the correlator is the handle the application uses later to query status or stop the request.
If no participants are listed, the message is played to all participants in the call session. If participants are listed, the service applies the message only to those addresses within the session. The service raises an invalid input value exception for an invalid call session or invalid participant list, so applications must validate the session and addresses before calling.
Clause 8.1.4 and 8.1.5 cover getMessageStatus and endMessage. getMessageStatus returns the current status for the request, while endMessage stops a previous request and returns the status at the moment it was aborted. This is what an application uses when it needs monitoring, cancellation, or both.
Interactive media capture
Clause 8.2 defines CaptureMedia. startPlayAndCollectInteraction plays media and collects digits, while startPlayAndRecordInteraction plays media and records end-user media input. Both can target one participant or all participants in the call, and both return a media identifier.
That media identifier is then used by stopMediaInteraction to interrupt an ongoing interaction. This matters for IVR-style flows, on-hold prompts, and similar interactions where the application may need to stop playback or recording before the natural end.
Dynamic multimedia management
Clause 8.3 defines the Multimedia interface. addMediaForParticipants adds media types to one or more participants, deleteMediaForParticipants removes them, and getMediaForParticipant and getMediaForCall report current media status. The standard requires compatibility with the participant device’s supported media types, so the application must choose media the terminal can actually handle.
Two ServiceException values are defined for these operations: SVC0290 for a duplicate media stream and SVC0291 for a media stream that does not match the type specified. In practice, this means the application should not request the same media and direction twice, and it should only remove media that is actually present.
Data used by the interface
Clause 7 defines the data structures that drive the service. These include MessageStatus, DigitConfig, RecConfig, PlayConfig, AnnouncementFormat, MediaMessageStatus, and MediaParticipantInfo. They tell the application how to configure digit collection, recording limits, play content locations, and the per-participant status returned by the service.
What terms does SIST ES 202 504-11 V1.1.1:2008 define?
- Call Session - the ongoing call identified by callSessionIdentifier, which is the unit the service acts on.
- Call Participant - a participant in the call session, usually addressed by a URI.
- Media - the audio, video, chat, or data stream used by a participant in the call.
- Correlator - the identifier returned by play operations so the application can later query status or cancel the request.
- MessageStatus - the status of a played message, with values such as Pending, Playing, Played, and Error.
- AnnouncementFormat - the format used for an announcement, including Audio, VoiceXML, TextToSpeech, Video, and ApplicationSpecificFormat.
- Service policy - a capability rule that tells the application whether a media type or interaction is supported.
- Text-To-Speech (TTS) - the engine used to turn text into speech for playTextMessage.
Who uses SIST ES 202 504-11 V1.1.1:2008?
Application developers use this standard to build services that play prompts, collect digits, record responses, and control media streams during calls. Service providers and network platform vendors use it when they expose OSA APIs for telephony and converged services.
System integrators and test teams use it to verify WSDL compatibility, message flow, faults, and service-policy behavior. Buyers and solution architects use it to check whether a platform supports audio playback, VoiceXML, digit collection, recording, video, or multimedia control before integration.
What changed in SIST ES 202 504-11 V1.1.1:2008 from the previous edition?
SIST ES 202 504-11 V1.1.1:2008 is presented as a new edition of the Parlay X specification, based on requirements in EG 201 988-4 and equivalent to 3GPP TS 29.199-11 V7.2.0 (Release 7). The scope also states that the web service has been extended to support media.
Which standards are used with SIST ES 202 504-11 V1.1.1:2008?
- W3C Recommendation: XML Schema Part 2: Datatypes - supplies the XML Schema datatypes used in the service schemas.
- ETSI ES 202 504-1: Open Service Access (OSA); Parlay X Web Services; Part 1: Common (Parlay X 3) - supplies the shared terms, abbreviations, and common definitions used throughout this part.
What does the SIST ES 202 504-11 V1.1.1:2008 document contain?
The document contains sequence diagrams for play, cancel, add and remove media, and play-and-collect or play-and-record interactions. These diagrams show how the request/response patterns work in a real call flow.
It also contains XML Schema data type definitions for the message status and media configuration structures, plus detailed web service interface definitions for PlayMedia, CaptureMedia, and Multimedia. Those interface clauses are the main implementation guidance for developers and test teams.
Annex A provides the normative WSDL in document/literal form, and the WSDL is stated to be compliant with ES 202 504-1. Annex B gives the bibliography used for background and traceability.
Buy Documents
ETSI ES 202 504-11 V1.1.1 (2008-02) - Open Service Access (OSA); Parlay X Web Services; Part 11: Audio Call (Parlay X 3)
ETSI ES 202 504-11 V1.1.1 (2008-05) - Open Service Access (OSA); Parlay X Web Services; Part 11: Audio Call (Parlay X 3)
Get Certified
Connect with accredited certification bodies for this standard
BSI Group
BSI (British Standards Institution) is the business standards company that helps organizations make excellence a habit.
NYCE
Mexican standards and certification body.
Sponsored listings
Frequently Asked Questions
SIST ES 202 504-11 V1.1.1:2008 is a standard published by the Slovenian Institute for Standardization (SIST). Its full title is "Open Service Access (OSA) - Parlay X Web Services - Part 11: Audio Call (Parlay X 3)". This standard covers: New edition of ParlayX specification based on requirements in EG 201 988-4, corresponding to 3GPP TS 29.199 Rel-7.The present document is part 11 of the Stage 3 Parlay X 3 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, i.e. 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. The web service had been extended to support media.
New edition of ParlayX specification based on requirements in EG 201 988-4, corresponding to 3GPP TS 29.199 Rel-7.The present document is part 11 of the Stage 3 Parlay X 3 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, i.e. 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. The web service had been extended to support media.
SIST ES 202 504-11 V1.1.1:2008 is classified under the following ICS (International Classification for Standards) categories: 35.100.01 - Open systems interconnection in general. The ICS classification helps identify the subject area and facilitates finding related standards.
SIST ES 202 504-11 V1.1.1:2008 is available in PDF format for immediate download after purchase. The document can be added to your cart and obtained through the secure checkout process. Digital delivery ensures instant access to the complete standard document.
Standards Content (Sample)
Final draft ETSI ES 202 504-11 V1.1.1 (2008-02)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 11: Audio Call
(Parlay X 3)
�
2 Final draft ETSI ES 202 504-11 V1.1.1 (2008-02)
Reference
DES/TISPAN-01034-11-OSA
Keywords
API, OSA, service
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.org
The present document may be made available in more than one electronic version or in print. In any case of existing or
perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF).
In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive
within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
http://portal.etsi.org/tb/status/status.asp
If you find errors in the present document, please send your comment to one of the following services:
http://portal.etsi.org/chaircor/ETSI_support.asp
Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
3 Final draft ETSI ES 202 504-11 V1.1.1 (2008-02)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.7
2 References.7
2.1 Normative references.8
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Detailed service description .8
5 Namespaces.9
6 Sequence diagrams.9
6.1 Play audio and check status.9
6.2 Play audio and cancel .11
6.3 Adding and removing media .12
6.4 Play media file and collect digits from end user.13
6.5 Play media file and retrieve media from end user .14
7 XML Schema data type definition .14
7.1 MessageStatus enumeration.14
7.2 DigitConfig structure.15
7.3 RecConfig structure.15
7.4 PlayConfig structure.15
7.5 AnnouncementFormat enumeration.15
7.6 MediaMessageStatus structure.15
7.7 MediaParticipantInfo structure.16
8 Web Service interface definition.16
8.1 Interface: PlayMedia.16
8.1.1 Operation: playTextMessage.16
8.1.1.1 Input message: playTextMessageRequest.16
8.1.1.2 Output message: playTextMessageResponse.16
8.1.1.3 Referenced faults.17
8.1.2 Operation: playAudioMessage.17
8.1.2.1 Input message: playAudioMessageRequest.17
8.1.2.2 Output message: playAudioMessageResponse.17
8.1.2.3 Referenced faults.17
8.1.3 Operation: playVoiceXmlMessage.18
8.1.3.1 Input message: playVoiceXmlMessageRequest.18
8.1.3.2 Output message: playVoiceXMLMessageResponse.18
8.1.3.3 Referenced faults.18
8.1.3a Operation: playVideoMessage.19
8.1.3a.1 Input message: playVideoMessageRequest.19
8.1.3a.2 Output message: playVideoMessageResponse.19
8.1.3a.3 Referenced faults.19
8.1.4 Operation: getMessageStatus.19
8.1.4.1 Input message: getMessageStatusRequest .19
8.1.4.2 Output message: getMessageStatusResponse .20
8.1.4.3 Referenced faults.20
8.1.5 Operation: endMessage.20
8.1.5.1 Input message: endMessageRequest.20
8.1.5.2 Output message: endMessageResponse.20
8.1.5.3 Referenced faults.20
8.2 Interface: CaptureMedia.20
ETSI
4 Final draft ETSI ES 202 504-11 V1.1.1 (2008-02)
8.2.1 Operation: startPlayAndCollectInteraction.20
8.2.1.1 Input message: startPlayAndCollectInteractionRequest .21
8.2.1.2 Output message: startPlayAndCollectInteractionResponse .21
8.2.1.3 Referenced faults.21
8.2.2 Operation: startPlayAndRecordInteraction.21
8.2.2.1 Input message: startPlayAndRecordInteractionRequest .22
8.2.2.2 Output message: startPlayAndRecordInteractionResponse.22
8.2.2.3 Referenced faults.22
8.2.3 Operation: stopMediaInteraction.22
8.2.3.1 Input message: stopMediaInteractionRequest.22
8.2.3.2 Output message: stopMediaInteractionResponse.22
8.2.3.3 Referenced faults.23
8.3 Interface: Multimedia.23
8.3.1 Operation: addMediaForParticipants.23
8.3.1.1 Input message: addMediaForParticipantsRequest.23
8.3.1.2 Output message: addMediaForParticipantsResponse.23
8.3.1.3 Referenced faults.23
8.3.2 Operation: deleteMediaForParticipants .24
8.3.2.1 Input message: deleteMediaForParticipantsRequest.24
8.3.2.2 Output message: deleteMediaForParticipantsResponse.24
8.3.2.3 Referenced faults.24
8.3.3 Operation: getMediaForParticipant.24
8.3.3.1 Input message: getMediaForParticipantRequest .25
8.3.3.2 Output message: getMediaForParticipantResponse.25
8.3.3.3 Referenced faults.25
8.3.4 Operation: getMediaForCall.25
8.3.4.1 Input message: getMediaForCallRequest.25
8.3.4.2 Output message: getMediaForCallResponse.25
8.3.4.3 Referenced faults.25
9 Fault definitions.26
9.1 ServiceException.26
9.1.1 SVC0290: Duplicate media stream.26
9.1.2 SVC0291: Media stream does not match.26
10 Service policies .26
Annex A (normative): WSDL for Audio Call.27
Annex B (informative): Bibliography.28
History .29
ETSI
5 Final draft ETSI ES 202 504-11 V1.1.1 (2008-02)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN), and is now submitted for the ETSI standards
Membership Approval Procedure.
The present document is part 11 of a multi-part deliverable covering Open Service Access (OSA); Parlay X
Web Services, as identified below:
Part 1: "Common";
Part 2: "Third Party Call";
Part 3: "Call Notification";
Part 4: "Short Messaging";
Part 5: "Multimedia Messaging";
Part 6: "Payment";
Part 7: "Account Management";
Part 8: "Terminal Status";
Part 9: "Terminal Location";
Part 10: "Call Handling";
Part 11: "Audio Call";
Part 12: "Multimedia Conference";
Part 13: "Address List Management";
Part 14: "Presence";
Part 15: "Message Broadcast";
Part 16: "Geocoding";
Part 17: "Application-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
ETSI
6 Final draft ETSI ES 202 504-11 V1.1.1 (2008-02)
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP.
The present document forms part of the Parlay X 3.0 set of specifications.
The present document is equivalent to 3GPP TS 29.199-11 V7.2.0 (Release 7).
ETSI
7 Final draft ETSI ES 202 504-11 V1.1.1 (2008-02)
1 Scope
The present document is part 11 of the Stage 3 Parlay X 3 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, i.e. 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.
The web service had been extended to support media.
2 References
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific.
• For a specific reference, subsequent revisions do not apply.
• Non-specific reference may be made only to a complete document or a part thereof and only in the following
cases:
- if it is accepted that it will be possible to use all future changes of the referenced document for the
purposes of the referring document;
- for informative references.
Referenced documents which are not found to be publicly available in the expected location might be found at
http://docbox.etsi.org/Reference.
For online referenced documents, information sufficient to identify and locate the source shall be provided. Preferably,
the primary source of the referenced document should be cited, in order to ensure traceability. Furthermore, the
reference should, as far as possible, remain valid for the expected life of the document. The reference shall include the
method of access to the referenced document and the full network address, with the same punctuation and use of upper
case and lower case letters.
NOTE: While any hyperlinks included in this clause were valid at the time of publication ETSI cannot guarantee
their long term validity.
ETSI
8 Final draft ETSI ES 202 504-11 V1.1.1 (2008-02)
2.1 Normative references
The following referenced documents are indispensable for the application of the present document. For dated
references, only the edition cited applies. For non-specific references, the latest edition of the referenced document
(including any amendments) applies.
[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 504-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 504-1 [2] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-1 [2] apply.
4 Detailed service description
The web service provides a flexible way to provide multimedia message delivery and the dynamic management of the
media involved for the call participants. The interface is very simple, not requiring the developer to manage the creation
of the call.
The Audio Call web service allows media to be added/dropped for any ongoing call. This web service also allows
interaction with other call control web services (e.g. multimedia conference, third party call), enabling delivery of
multimedia to call participants in an ongoing call.
The underlying model of the service is based on the following entities:
• Call Session: a call (uniquely identified) to which participants can be added/removed.
• Call Participant: each of the call parties (uniquely identified) involved in the call session.
• Media: the call can utilize multiple media types to support the participants' communication. In particular both
audio and video streams are available, including the specific stream direction (i.e. incoming, outgoing,
bidirectional).
NOTE: Call participants in a Call Session are anticipated to be uniquely identifiable using their URI address.
There are several mechanisms which may be utilized for the 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.
• Video, to provide video streaming to the user.
• Capture media input from the end user.
The service may provide one or more of these mechanisms, as determined by service policy.
ETSI
9 Final draft ETSI ES 202 504-11 V1.1.1 (2008-02)
The service allows application control of the call participants’ multimedia in a call:
• Allow multiple media types for each participant. In particular both audio and video as well as chat and data.
• Add and delete media types.
• Control the specific media stream direction (i.e. incoming, outgoing, bidirectional) for each media type.
• Get the current media status of a single call participant or for all the call participants in a call.
• Control the media interactions for a call participant.
A service policy determines if multimedia application control is supported.
5 Namespaces
The PlayMedia interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/audio_call/play_media/v3_2
The CaptureMedia interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/audio_call/capture_media/v3_1
The Multimedia interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/audio_call/multimedia/v3_1
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/audio_call/v3_2
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.
6 Sequence diagrams
6.1 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.
ETSI
10 Final draft ETSI ES 202 504-11 V1.1.1 (2008-02)
: Application : Audio
Call
Play audio
request
Correlator
Obtain
Call session
Request
status
PENDING
Play audio
message
Request
status
PLAYING
Audio
complete
Request
s
status
PLAYED
Sometime
later
Release status
information
Request
status
Service exception
Figure 1
ETSI
11 Final draft ETSI ES 202 504-11 V1.1.1 (2008-02)
6.2 Play audio and cancel
Pattern: Request / response.
The playing of a message may be ended by the requester, as shown.
: Application : Audio
Call
Play audio request
Correlator
Obtain
Call session
Play audio message
Cancel
request
Cancel call
Figure 2
ETSI
12 Final draft ETSI ES 202 504-11 V1.1.1 (2008-02)
6.3 Adding and removing media
Pattern: Request / response.
This example shows how to add media, read media information, and remove media for a participant on an existing call.
Application
Audio Call
addMediaForParticipants
Participant A media info:
response
add: Video: IN
Obtain
Call session
Store media info for participant.
Issue request to participant terminal
getMediaForCall
Participant A media info:
Audio: IN/OUT
Video: IN
Return media information for all
Participant B media info:
participants
Audio: IN/OUT
result
Video: IN/OUT
Participant C media info:
Audio: IN/OUT
Video: IN/OUT
deleteMediaForParticipants
Obtain
Participant A media info:
Call Session
response
delete: Audio: OUT
Store media info for participant.
Issue request to participant terminal
getMediaForParticipant
Return media for participants
Participant A media info:
result
Audio: IN
Video: IN
Figure 3
ETSI
13 Final draft ETSI ES 202 504-11 V1.1.1 (2008-02)
6.4 Play media file and collect digits from end user
This example shows an application playing a media file and retrieving digits from the end user.
Audio Call Call Notification
Application User
Web Service Web Service
startPlayAndCollectNotification
startPlayAndCollectInteraction
Obtain
call session
Play audio message
An audio message is
played to the user
The user respondsby
entering a set of digits
that are recorded
by the service
Collect digits
notifyPlayAndCollectEvent
stopMediaInteractionNotification
Figure 4
ETSI
14 Final draft ETSI ES 202 504-11 V1.1.1 (2008-02)
6.5 Play media file and retrieve media from end user
This example shows an application playing a media file, retrieving media from the end user and recording it.
Audio Call Call Notification
Application User
Web Service Web Service
startPlayAndRecordNotification
startPlayAndRecordInteraction
Obtain
call session
Play media
A media messageis
played to the user
The user responds with
a video message that is
recorded by the service
Record information
notifyPlayAndRecordEvent
stopMediaInteractionNotification
Figure 5
7 XML Schema data type definition
7.1 MessageStatus enumeration
Status of the message after play message operation has been invoked.
Enumeration value Description
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
ETSI
15 Final draft ETSI ES 202 504-11 V1.1.1 (2008-02)
7.2 DigitConfig structure
Configuration parameters related to digit collection.
Element name Element type Optional Description
maxDigits xsd:int Yes The maximum number of digits that will be collected.
minDigits xsd:int Yes The minimum number of digits that will be collected. If
this isn't achieved, then a default prompt shall be played
requesting that more digits be entered.
interruptMedia xsd:boolean No Indicates whether the application allows the end user to
interrupt, or pause, the playing of the prompt.
7.3 RecConfig structure
Configuration parameters related to media recording.
Element name Element type Optional Descripti
...
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 11: Audio Call
(Parlay X 3)
�
2 ETSI ES 202 504-11 V1.1.1 (2008-05)
Reference
DES/TISPAN-01034-11-OSA
Keywords
API, OSA, service
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.org
The present document may be made available in more than one electronic version or in print. In any case of existing or
perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF).
In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive
within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
http://portal.etsi.org/tb/status/status.asp
If you find errors in the present document, please send your comment to one of the following services:
http://portal.etsi.org/chaircor/ETSI_support.asp
Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
3 ETSI ES 202 504-11 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.7
2 References.7
2.1 Normative references.8
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Detailed service description .8
5 Namespaces.9
6 Sequence diagrams.9
6.1 Play audio and check status.9
6.2 Play audio and cancel .11
6.3 Adding and removing media .12
6.4 Play media file and collect digits from end user.13
6.5 Play media file and retrieve media from end user .14
7 XML Schema data type definition .14
7.1 MessageStatus enumeration.14
7.2 DigitConfig structure.15
7.3 RecConfig structure.15
7.4 PlayConfig structure.15
7.5 AnnouncementFormat enumeration.15
7.6 MediaMessageStatus structure.15
7.7 MediaParticipantInfo structure.16
8 Web Service interface definition.16
8.1 Interface: PlayMedia.16
8.1.1 Operation: playTextMessage.16
8.1.1.1 Input message: playTextMessageRequest.16
8.1.1.2 Output message: playTextMessageResponse.16
8.1.1.3 Referenced faults.17
8.1.2 Operation: playAudioMessage.17
8.1.2.1 Input message: playAudioMessageRequest.17
8.1.2.2 Output message: playAudioMessageResponse.17
8.1.2.3 Referenced faults.17
8.1.3 Operation: playVoiceXmlMessage.18
8.1.3.1 Input message: playVoiceXmlMessageRequest.18
8.1.3.2 Output message: playVoiceXMLMessageResponse.18
8.1.3.3 Referenced faults.18
8.1.3a Operation: playVideoMessage.19
8.1.3a.1 Input message: playVideoMessageRequest.19
8.1.3a.2 Output message: playVideoMessageResponse.19
8.1.3a.3 Referenced faults.19
8.1.4 Operation: getMessageStatus.19
8.1.4.1 Input message: getMessageStatusRequest .19
8.1.4.2 Output message: getMessageStatusResponse .20
8.1.4.3 Referenced faults.20
8.1.5 Operation: endMessage.20
8.1.5.1 Input message: endMessageRequest.20
8.1.5.2 Output message: endMessageResponse.20
8.1.5.3 Referenced faults.20
8.2 Interface: CaptureMedia.20
ETSI
4 ETSI ES 202 504-11 V1.1.1 (2008-05)
8.2.1 Operation: startPlayAndCollectInteraction.20
8.2.1.1 Input message: startPlayAndCollectInteractionRequest .21
8.2.1.2 Output message: startPlayAndCollectInteractionResponse .21
8.2.1.3 Referenced faults.21
8.2.2 Operation: startPlayAndRecordInteraction.21
8.2.2.1 Input message: startPlayAndRecordInteractionRequest .22
8.2.2.2 Output message: startPlayAndRecordInteractionResponse.22
8.2.2.3 Referenced faults.22
8.2.3 Operation: stopMediaInteraction.22
8.2.3.1 Input message: stopMediaInteractionRequest.22
8.2.3.2 Output message: stopMediaInteractionResponse.22
8.2.3.3 Referenced faults.23
8.3 Interface: Multimedia.23
8.3.1 Operation: addMediaForParticipants.23
8.3.1.1 Input message: addMediaForParticipantsRequest.23
8.3.1.2 Output message: addMediaForParticipantsResponse.23
8.3.1.3 Referenced faults.23
8.3.2 Operation: deleteMediaForParticipants .24
8.3.2.1 Input message: deleteMediaForParticipantsRequest.24
8.3.2.2 Output message: deleteMediaForParticipantsResponse.24
8.3.2.3 Referenced faults.24
8.3.3 Operation: getMediaForParticipant.24
8.3.3.1 Input message: getMediaForParticipantRequest .25
8.3.3.2 Output message: getMediaForParticipantResponse.25
8.3.3.3 Referenced faults.25
8.3.4 Operation: getMediaForCall.25
8.3.4.1 Input message: getMediaForCallRequest.25
8.3.4.2 Output message: getMediaForCallResponse.25
8.3.4.3 Referenced faults.25
9 Fault definitions.26
9.1 ServiceException.26
9.1.1 SVC0290: Duplicate media stream.26
9.1.2 SVC0291: Media stream does not match.26
10 Service policies .26
Annex A (normative): WSDL for Audio Call.27
Annex B (informative): Bibliography.28
History .29
ETSI
5 ETSI ES 202 504-11 V1.1.1 (2008-05)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN).
The present document is part 11 of a multi-part deliverable covering Open Service Access (OSA); Parlay X
Web Services, as identified below:
Part 1: "Common";
Part 2: "Third Party Call";
Part 3: "Call Notification";
Part 4: "Short Messaging";
Part 5: "Multimedia Messaging";
Part 6: "Payment";
Part 7: "Account Management";
Part 8: "Terminal Status";
Part 9: "Terminal Location";
Part 10: "Call Handling";
Part 11: "Audio Call";
Part 12: "Multimedia Conference";
Part 13: "Address List Management";
Part 14: "Presence";
Part 15: "Message Broadcast";
Part 16: "Geocoding";
Part 17: "Application-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
ETSI
6 ETSI ES 202 504-11 V1.1.1 (2008-05)
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP.
The present document forms part of the Parlay X 3.0 set of specifications.
The present document is equivalent to 3GPP TS 29.199-11 V7.2.0 (Release 7).
ETSI
7 ETSI ES 202 504-11 V1.1.1 (2008-05)
1 Scope
The present document is part 11 of the Stage 3 Parlay X 3 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, i.e. 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.
The web service had been extended to support media.
2 References
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific.
• For a specific reference, subsequent revisions do not apply.
• Non-specific reference may be made only to a complete document or a part thereof and only in the following
cases:
- if it is accepted that it will be possible to use all future changes of the referenced document for the
purposes of the referring document;
- for informative references.
Referenced documents which are not found to be publicly available in the expected location might be found at
http://docbox.etsi.org/Reference.
For online referenced documents, information sufficient to identify and locate the source shall be provided. Preferably,
the primary source of the referenced document should be cited, in order to ensure traceability. Furthermore, the
reference should, as far as possible, remain valid for the expected life of the document. The reference shall include the
method of access to the referenced document and the full network address, with the same punctuation and use of upper
case and lower case letters.
NOTE: While any hyperlinks included in this clause were valid at the time of publication ETSI cannot guarantee
their long term validity.
ETSI
8 ETSI ES 202 504-11 V1.1.1 (2008-05)
2.1 Normative references
The following referenced documents are indispensable for the application of the present document. For dated
references, only the edition cited applies. For non-specific references, the latest edition of the referenced document
(including any amendments) applies.
[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 504-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 504-1 [2] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-1 [2] apply.
4 Detailed service description
The web service provides a flexible way to provide multimedia message delivery and the dynamic management of the
media involved for the call participants. The interface is very simple, not requiring the developer to manage the creation
of the call.
The Audio Call web service allows media to be added/dropped for any ongoing call. This web service also allows
interaction with other call control web services (e.g. multimedia conference, third party call), enabling delivery of
multimedia to call participants in an ongoing call.
The underlying model of the service is based on the following entities:
• Call Session: a call (uniquely identified) to which participants can be added/removed.
• Call Participant: each of the call parties (uniquely identified) involved in the call session.
• Media: the call can utilize multiple media types to support the participants' communication. In particular both
audio and video streams are available, including the specific stream direction (i.e. incoming, outgoing,
bidirectional).
NOTE: Call participants in a Call Session are anticipated to be uniquely identifiable using their URI address.
There are several mechanisms which may be utilized for the 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.
• Video, to provide video streaming to the user.
• Capture media input from the end user.
The service may provide one or more of these mechanisms, as determined by service policy.
ETSI
9 ETSI ES 202 504-11 V1.1.1 (2008-05)
The service allows application control of the call participants’ multimedia in a call:
• Allow multiple media types for each participant. In particular both audio and video as well as chat and data.
• Add and delete media types.
• Control the specific media stream direction (i.e. incoming, outgoing, bidirectional) for each media type.
• Get the current media status of a single call participant or for all the call participants in a call.
• Control the media interactions for a call participant.
A service policy determines if multimedia application control is supported.
5 Namespaces
The PlayMedia interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/audio_call/play_media/v3_2
The CaptureMedia interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/audio_call/capture_media/v3_1
The Multimedia interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/audio_call/multimedia/v3_1
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/audio_call/v3_2
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.
6 Sequence diagrams
6.1 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.
ETSI
10 ETSI ES 202 504-11 V1.1.1 (2008-05)
: Application : Audio
Call
Play audio
request
Correlator
Obtain
Call session
Request
status
PENDING
Play audio
message
Request
status
PLAYING
Audio
complete
Request
s
status
PLAYED
Sometime
later
Release status
information
Request
status
Service exception
Figure 1
ETSI
11 ETSI ES 202 504-11 V1.1.1 (2008-05)
6.2 Play audio and cancel
Pattern: Request / response.
The playing of a message may be ended by the requester, as shown.
: Application : Audio
Call
Play audio request
Correlator
Obtain
Call session
Play audio message
Cancel
request
Cancel call
Figure 2
ETSI
12 ETSI ES 202 504-11 V1.1.1 (2008-05)
6.3 Adding and removing media
Pattern: Request / response.
This example shows how to add media, read media information, and remove media for a participant on an existing call.
Application
Audio Call
addMediaForParticipants
Participant A media info:
response
add: Video: IN
Obtain
Call session
Store media info for participant.
Issue request to participant terminal
getMediaForCall
Participant A media info:
Audio: IN/OUT
Video: IN
Return media information for all
Participant B media info:
participants
Audio: IN/OUT
result
Video: IN/OUT
Participant C media info:
Audio: IN/OUT
Video: IN/OUT
deleteMediaForParticipants
Obtain
Participant A media info:
Call Session
response
delete: Audio: OUT
Store media info for participant.
Issue request to participant terminal
getMediaForParticipant
Return media for participants
Participant A media info:
result
Audio: IN
Video: IN
Figure 3
ETSI
13 ETSI ES 202 504-11 V1.1.1 (2008-05)
6.4 Play media file and collect digits from end user
This example shows an application playing a media file and retrieving digits from the end user.
Audio Call Call Notification
Application User
Web Service Web Service
startPlayAndCollectNotification
startPlayAndCollectInteraction
Obtain
call session
Play audio message
An audio message is
played to the user
The user respondsby
entering a set of digits
that are recorded
by the service
Collect digits
notifyPlayAndCollectEvent
stopMediaInteractionNotification
Figure 4
ETSI
14 ETSI ES 202 504-11 V1.1.1 (2008-05)
6.5 Play media file and retrieve media from end user
This example shows an application playing a media file, retrieving media from the end user and recording it.
Audio Call Call Notification
Application User
Web Service Web Service
startPlayAndRecordNotification
startPlayAndRecordInteraction
Obtain
call session
Play media
A media messageis
played to the user
The user responds with
a video message that is
recorded by the service
Record information
notifyPlayAndRecordEvent
stopMediaInteractionNotification
Figure 5
7 XML Schema data type definition
7.1 MessageStatus enumeration
Status of the message after play message operation has been invoked.
Enumeration value Description
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
ETSI
15 ETSI ES 202 504-11 V1.1.1 (2008-05)
7.2 DigitConfig structure
Configuration parameters related to digit collection.
Element name Element type Optional Description
maxDigits xsd:int Yes The maximum number of digits that will be collected.
minDigits xsd:int Yes The minimum number of digits that will be collected. If
this isn't achieved, then a default prompt shall be played
requesting that more digits be entered.
interruptMedia xsd:boolean No Indicates whether the application allows the end user to
interrupt, or pause, the playing of the prompt.
7.3 RecConfig structure
Configuration parameters related to media recording.
Element name Element type Optional Description
recFileLocation xsd:anyURI Yes The location for stori
...
SLOVENSKI STANDARD
01-september-2008
2GSUWLGRVWRSGRVWRULWYH 26$ 6SOHWQHVWRULWYH3DUOD\;GHO =YRþQLNOLF
3DUOD\;
Open Service Access (OSA) - Parlay X Web Services - Part 11: Audio Call (Parlay X 3)
Ta slovenski standard je istoveten z: ES 202 504-11 Version 1.1.1
ICS:
35.100.01 Medsebojno povezovanje Open systems
odprtih sistemov na splošno interconnection in general
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 11: Audio Call
(Parlay X 3)
�
2 ETSI ES 202 504-11 V1.1.1 (2008-05)
Reference
DES/TISPAN-01034-11-OSA
Keywords
API, OSA, service
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE
Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16
Siret N° 348 623 562 00017 - NAF 742 C
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° 7803/88
Important notice
Individual copies of the present document can be downloaded from:
http://www.etsi.org
The present document may be made available in more than one electronic version or in print. In any case of existing or
perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF).
In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive
within ETSI Secretariat.
Users of the present document should be aware that the document may be subject to revision or change of status.
Information on the current status of this and other ETSI documents is available at
http://portal.etsi.org/tb/status/status.asp
If you find errors in the present document, please send your comment to one of the following services:
http://portal.etsi.org/chaircor/ETSI_support.asp
Copyright Notification
No part may be reproduced except as authorized by written permission.
The copyright and the foregoing restriction extend to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
3 ETSI ES 202 504-11 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.7
2 References.7
2.1 Normative references.8
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Detailed service description .8
5 Namespaces.9
6 Sequence diagrams.9
6.1 Play audio and check status.9
6.2 Play audio and cancel .11
6.3 Adding and removing media .12
6.4 Play media file and collect digits from end user.13
6.5 Play media file and retrieve media from end user .14
7 XML Schema data type definition .14
7.1 MessageStatus enumeration.14
7.2 DigitConfig structure.15
7.3 RecConfig structure.15
7.4 PlayConfig structure.15
7.5 AnnouncementFormat enumeration.15
7.6 MediaMessageStatus structure.15
7.7 MediaParticipantInfo structure.16
8 Web Service interface definition.16
8.1 Interface: PlayMedia.16
8.1.1 Operation: playTextMessage.16
8.1.1.1 Input message: playTextMessageRequest.16
8.1.1.2 Output message: playTextMessageResponse.16
8.1.1.3 Referenced faults.17
8.1.2 Operation: playAudioMessage.17
8.1.2.1 Input message: playAudioMessageRequest.17
8.1.2.2 Output message: playAudioMessageResponse.17
8.1.2.3 Referenced faults.17
8.1.3 Operation: playVoiceXmlMessage.18
8.1.3.1 Input message: playVoiceXmlMessageRequest.18
8.1.3.2 Output message: playVoiceXMLMessageResponse.18
8.1.3.3 Referenced faults.18
8.1.3a Operation: playVideoMessage.19
8.1.3a.1 Input message: playVideoMessageRequest.19
8.1.3a.2 Output message: playVideoMessageResponse.19
8.1.3a.3 Referenced faults.19
8.1.4 Operation: getMessageStatus.19
8.1.4.1 Input message: getMessageStatusRequest .19
8.1.4.2 Output message: getMessageStatusResponse .20
8.1.4.3 Referenced faults.20
8.1.5 Operation: endMessage.20
8.1.5.1 Input message: endMessageRequest.20
8.1.5.2 Output message: endMessageResponse.20
8.1.5.3 Referenced faults.20
8.2 Interface: CaptureMedia.20
ETSI
4 ETSI ES 202 504-11 V1.1.1 (2008-05)
8.2.1 Operation: startPlayAndCollectInteraction.20
8.2.1.1 Input message: startPlayAndCollectInteractionRequest .21
8.2.1.2 Output message: startPlayAndCollectInteractionResponse .21
8.2.1.3 Referenced faults.21
8.2.2 Operation: startPlayAndRecordInteraction.21
8.2.2.1 Input message: startPlayAndRecordInteractionRequest .22
8.2.2.2 Output message: startPlayAndRecordInteractionResponse.22
8.2.2.3 Referenced faults.22
8.2.3 Operation: stopMediaInteraction.22
8.2.3.1 Input message: stopMediaInteractionRequest.22
8.2.3.2 Output message: stopMediaInteractionResponse.22
8.2.3.3 Referenced faults.23
8.3 Interface: Multimedia.23
8.3.1 Operation: addMediaForParticipants.23
8.3.1.1 Input message: addMediaForParticipantsRequest.23
8.3.1.2 Output message: addMediaForParticipantsResponse.23
8.3.1.3 Referenced faults.23
8.3.2 Operation: deleteMediaForParticipants .24
8.3.2.1 Input message: deleteMediaForParticipantsRequest.24
8.3.2.2 Output message: deleteMediaForParticipantsResponse.24
8.3.2.3 Referenced faults.24
8.3.3 Operation: getMediaForParticipant.24
8.3.3.1 Input message: getMediaForParticipantRequest .25
8.3.3.2 Output message: getMediaForParticipantResponse.25
8.3.3.3 Referenced faults.25
8.3.4 Operation: getMediaForCall.25
8.3.4.1 Input message: getMediaForCallRequest.25
8.3.4.2 Output message: getMediaForCallResponse.25
8.3.4.3 Referenced faults.25
9 Fault definitions.26
9.1 ServiceException.26
9.1.1 SVC0290: Duplicate media stream.26
9.1.2 SVC0291: Media stream does not match.26
10 Service policies .26
Annex A (normative): WSDL for Audio Call.27
Annex B (informative): Bibliography.28
History .29
ETSI
5 ETSI ES 202 504-11 V1.1.1 (2008-05)
Intellectual Property Rights
IPRs essential or potentially essential to the present document may have been declared to ETSI. The information
pertaining to these essential IPRs, if any, is publicly available for ETSI members and non-members, and can be found
in ETSI SR 000 314: "Intellectual Property Rights (IPRs); Essential, or potentially Essential, IPRs notified to ETSI in
respect of ETSI standards", which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web
server (http://webapp.etsi.org/IPR/home.asp).
Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee
can be given as to the existence of other IPRs not referenced in ETSI SR 000 314 (or the updates on the ETSI Web
server) which are, or may be, or may become, essential to the present document.
Foreword
This ETSI Standard (ES) has been produced by ETSI Technical Committee Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN).
The present document is part 11 of a multi-part deliverable covering Open Service Access (OSA); Parlay X
Web Services, as identified below:
Part 1: "Common";
Part 2: "Third Party Call";
Part 3: "Call Notification";
Part 4: "Short Messaging";
Part 5: "Multimedia Messaging";
Part 6: "Payment";
Part 7: "Account Management";
Part 8: "Terminal Status";
Part 9: "Terminal Location";
Part 10: "Call Handling";
Part 11: "Audio Call";
Part 12: "Multimedia Conference";
Part 13: "Address List Management";
Part 14: "Presence";
Part 15: "Message Broadcast";
Part 16: "Geocoding";
Part 17: "Application-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
ETSI
6 ETSI ES 202 504-11 V1.1.1 (2008-05)
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP.
The present document forms part of the Parlay X 3.0 set of specifications.
The present document is equivalent to 3GPP TS 29.199-11 V7.2.0 (Release 7).
ETSI
7 ETSI ES 202 504-11 V1.1.1 (2008-05)
1 Scope
The present document is part 11 of the Stage 3 Parlay X 3 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, i.e. 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.
The web service had been extended to support media.
2 References
References are either specific (identified by date of publication and/or edition number or version number) or
non-specific.
• For a specific reference, subsequent revisions do not apply.
• Non-specific reference may be made only to a complete document or a part thereof and only in the following
cases:
- if it is accepted that it will be possible to use all future changes of the referenced document for the
purposes of the referring document;
- for informative references.
Referenced documents which are not found to be publicly available in the expected location might be found at
http://docbox.etsi.org/Reference.
For online referenced documents, information sufficient to identify and locate the source shall be provided. Preferably,
the primary source of the referenced document should be cited, in order to ensure traceability. Furthermore, the
reference should, as far as possible, remain valid for the expected life of the document. The reference shall include the
method of access to the referenced document and the full network address, with the same punctuation and use of upper
case and lower case letters.
NOTE: While any hyperlinks included in this clause were valid at the time of publication ETSI cannot guarantee
their long term validity.
ETSI
8 ETSI ES 202 504-11 V1.1.1 (2008-05)
2.1 Normative references
The following referenced documents are indispensable for the application of the present document. For dated
references, only the edition cited applies. For non-specific references, the latest edition of the referenced document
(including any amendments) applies.
[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 504-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 3)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 202 504-1 [2] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-1 [2] apply.
4 Detailed service description
The web service provides a flexible way to provide multimedia message delivery and the dynamic management of the
media involved for the call participants. The interface is very simple, not requiring the developer to manage the creation
of the call.
The Audio Call web service allows media to be added/dropped for any ongoing call. This web service also allows
interaction with other call control web services (e.g. multimedia conference, third party call), enabling delivery of
multimedia to call participants in an ongoing call.
The underlying model of the service is based on the following entities:
• Call Session: a call (uniquely identified) to which participants can be added/removed.
• Call Participant: each of the call parties (uniquely identified) involved in the call session.
• Media: the call can utilize multiple media types to support the participants' communication. In particular both
audio and video streams are available, including the specific stream direction (i.e. incoming, outgoing,
bidirectional).
NOTE: Call participants in a Call Session are anticipated to be uniquely identifiable using their URI address.
There are several mechanisms which may be utilized for the 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.
• Video, to provide video streaming to the user.
• Capture media input from the end user.
The service may provide one or more of these mechanisms, as determined by service policy.
ETSI
9 ETSI ES 202 504-11 V1.1.1 (2008-05)
The service allows application control of the call participants’ multimedia in a call:
• Allow multiple media types for each participant. In particular both audio and video as well as chat and data.
• Add and delete media types.
• Control the specific media stream direction (i.e. incoming, outgoing, bidirectional) for each media type.
• Get the current media status of a single call participant or for all the call participants in a call.
• Control the media interactions for a call participant.
A service policy determines if multimedia application control is supported.
5 Namespaces
The PlayMedia interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/audio_call/play_media/v3_2
The CaptureMedia interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/audio_call/capture_media/v3_1
The Multimedia interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/audio_call/multimedia/v3_1
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/audio_call/v3_2
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.
6 Sequence diagrams
6.1 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.
ETSI
10 ETSI ES 202 504-11 V1.1.1 (2008-05)
: Application : Audio
Call
Play audio
request
Correlator
Obtain
Call session
Request
status
PENDING
Play audio
message
Request
status
PLAYING
Audio
complete
Request
s
status
PLAYED
Sometime
later
Release status
information
Request
status
Service exception
Figure 1
ETSI
11 ETSI ES 202 504-11 V1.1.1 (2008-05)
6.2 Play audio and cancel
Pattern: Request / response.
The playing of a message may be ended by the requester, as shown.
: Application : Audio
Call
Play audio request
Correlator
Obtain
Call session
Play audio message
Cancel
request
Cancel call
Figure 2
ETSI
12 ETSI ES 202 504-11 V1.1.1 (2008-05)
6.3 Adding and removing media
Pattern: Request / response.
This example shows how to add media, read media information, and remove media for a participant on an existing call.
Application
Audio Call
addMediaForParticipants
Participant A media info:
response
add: Video: IN
Obtain
Call session
Store media info for participant.
Issue request to participant terminal
getMediaForCall
Participant A media info:
Audio: IN/OUT
Video: IN
Return media information for all
Participant B media info:
participants
Audio: IN/OUT
result
Video: IN/OUT
Participant C media info:
Audio: IN/OUT
Video: IN/OUT
deleteMediaForParticipants
Obtain
Participant A media info:
Call Session
response
delete: Audio: OUT
Store media info for participant.
Issue request to participant terminal
getMediaForParticipant
Return media for participants
Participant A media info:
result
Audio: IN
Video: IN
Figure 3
ETSI
13 ETSI ES 202 504-11 V1.1.1 (2008-05)
6.4 Play media file and collect digits from end user
This example shows an application playing a media file and retrieving digits from the end user.
Audio Call Call Notification
Application User
Web Service Web Service
startPlayAndCollectNotification
startPlayAndCollectInteraction
Obtain
call session
Play audio message
An audio message is
played to the user
The user respondsby
entering a set of digits
that are recorded
by the service
Collect digits
notifyPlayAndCollectEvent
stopMediaInteractionNotification
Figure 4
ETSI
14 ETSI ES 202 504-11 V1.1.1 (2008-05)
6.5 Play media file and retrieve media from end user
This example shows an application playing a media file, retrieving media from the end user and recording it.
Audio Call Call Notification
Application User
Web Service Web Service
startPlayAndRecordNotification
startPlayAndRecordInteraction
Obtain
call session
Play media
A media messageis
played to the user
The user responds with
a video message that is
recorded by the service
Record information
notifyPlayAndRecordEvent
stopMediaInteractionNotification
Figure 5
7 XML Schema data type definition
7.1 MessageStatus enumeration
Status of the message after play message operation has been invoked.
Enumeration value Description
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
ETSI
15 ETSI ES 202 504-11 V1.1.1 (2008-05)
7.2 DigitConfig structure
Configuration parameters related to digit collection.
Element name Element type Optional Description
maxDigits xsd:int Yes The maximum number of digits that will be collected.
minDigits xsd:int Yes The minimum number of digits that will be collected. If
this isn't achieved, then a default prompt sha
...