1、 ETSI ES 202 504-11 V1.1.1 (2008-05)ETSI Standard Open Service Access (OSA);Parlay X Web Services;Part 11: Audio Call(Parlay X 3)floppy3 ETSI ETSI ES 202 504-11 V1.1.1 (2008-05) 2 Reference DES/TISPAN-01034-11-OSA Keywords API, OSA, service ETSI 650 Route des Lucioles F-06921 Sophia Antipolis Cedex
2、- 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 enregistre la Sous-Prfecture 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
3、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 v
4、ersion 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.a
5、sp 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
6、 reproduction in all media. European Telecommunications Standards Institute 2008. The Parlay Group 2008. All rights reserved. DECTTM, PLUGTESTSTM, UMTSTM, TIPHONTM, the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered for the benefit of its Members. 3GPPTM is a Trade Mark of ETSI reg
7、istered for the benefit of its Members and of the 3GPP Organizational Partners. ETSI ETSI ES 202 504-11 V1.1.1 (2008-05) 3 Contents Intellectual Property Rights5 Foreword.5 1 Scope 7 2 References 7 2.1 Normative references .8 3 Definitions and abbreviations.8 3.1 Definitions8 3.2 Abbreviations .8 4
8、Detailed service description .8 5 Namespaces9 6 Sequence diagrams.9 6.1 Play audio and check status9 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 d
9、efinition .14 7.1 MessageStatus enumeration .14 7.2 DigitConfig structure15 7.3 RecConfig structure15 7.4 PlayConfig structure.15 7.5 AnnouncementFormat enumeration .15 7.6 MediaMessageStatus structure .15 7.7 MediaParticipantInfo structure.16 8 Web Service interface definition16 8.1 Interface: Play
10、Media 16 8.1.1 Operation: playTextMessage 16 8.1.1.1 Input message: playTextMessageRequest.16 8.1.1.2 Output message: playTextMessageResponse16 8.1.1.3 Referenced faults.17 8.1.2 Operation: playAudioMessage17 8.1.2.1 Input message: playAudioMessageRequest 17 8.1.2.2 Output message: playAudioMessageR
11、esponse .17 8.1.2.3 Referenced faults.17 8.1.3 Operation: playVoiceXmlMessage.18 8.1.3.1 Input message: playVoiceXmlMessageRequest18 8.1.3.2 Output message: playVoiceXMLMessageResponse.18 8.1.3.3 Referenced faults.18 8.1.3a Operation: playVideoMessage19 8.1.3a.1 Input message: playVideoMessageReques
12、t 19 8.1.3a.2 Output message: playVideoMessageResponse .19 8.1.3a.3 Referenced faults.19 8.1.4 Operation: getMessageStatus19 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 Inpu
13、t message: endMessageRequest .20 8.1.5.2 Output message: endMessageResponse 20 8.1.5.3 Referenced faults.20 8.2 Interface: CaptureMedia.20 ETSI ETSI ES 202 504-11 V1.1.1 (2008-05) 4 8.2.1 Operation: startPlayAndCollectInteraction.20 8.2.1.1 Input message: startPlayAndCollectInteractionRequest .21 8.
14、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
15、 8.2.3 Operation: stopMediaInteraction 22 8.2.3.1 Input message: stopMediaInteractionRequest.22 8.2.3.2 Output message: stopMediaInteractionResponse22 8.2.3.3 Referenced faults.23 8.3 Interface: Multimedia .23 8.3.1 Operation: addMediaForParticipants 23 8.3.1.1 Input message: addMediaForParticipants
16、Request.23 8.3.1.2 Output message: addMediaForParticipantsResponse23 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: deleteMediaForParticipantsResponse24 8.3.2.3 Referenced faults.24 8.3.3
17、 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: getMediaForCallRequest25 8.3.4.2 Output message: getMediaF
18、orCallResponse.25 8.3.4.3 Referenced faults.25 9 Fault definitions26 9.1 ServiceException26 9.1.1 SVC0290: Duplicate media stream.26 9.1.2 SVC0291: Media stream does not match26 10 Service policies 26 Annex A (normative): WSDL for Audio Call27 Annex B (informative): Bibliography.28 History 29 ETSI E
19、TSI ES 202 504-11 V1.1.1 (2008-05) 5 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 ET
20、SI 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
21、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 T
22、his 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
23、 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
24、 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: “Mult
25、imedia Multicast Session Management“. ETSI ETSI ES 202 504-11 V1.1.1 (2008-05) 6 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 equiva
26、lent to 3GPP TS 29.199-11 V7.2.0 (Release 7). ETSI ETSI ES 202 504-11 V1.1.1 (2008-05) 7 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 ma
27、ke 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
28、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 revisio
29、ns 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 reference
30、s. 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 referenc
31、ed 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
32、 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 ETSI ES 202 504-11 V1.1.1 (2008-05) 8 2.1 Normative references The following referenced documents are indispens
33、able 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
34、 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
35、. 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
36、 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), e
37、nabling 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) invo
38、lved 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
39、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
40、 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 ETSI ES 202 504-11 V1.1.1 (2008-05) 9 The service allows application control of the call par
41、ticipants 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 st
42、atus 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/a
43、udio_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.csap
44、i.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 exa
45、mple 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 ETSI ES 202 504-11 V1.1.1 (2008-05) 10: Applic
46、ation : Audio Call Play audio request Correlator Request status PENDING Play audio message Request status PLAYING Request status PLAYED Audio completes Sometime later Release status information Request status Service exception Obtain Call session Figure 1 ETSI ETSI ES 202 504-11 V1.1.1 (2008-05) 116
47、.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 Play audio message Cancel request Cancel call Obtain Call session Figure 2 ETSI ETSI ES 202 504-11 V1.1.1 (2008-05) 126.3 A
48、dding 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 response result Return media information for all participants deleteMediaForPartic
49、ipants response Obtain Obtain Store media info for participant. Issue request to participant terminal Call session Store media info for participant. Issue request to participant terminal Call Session Participant A media info: add: Video: IN Participant A media info: Audio: IN/OUT Video: IN Participant B media info: Audio: IN/OUT Video: IN/OUT Participant C media info: Audio: IN/OUT Video: IN/OUT Participant A media info: delete: Audio: OUT getMediaForParticipant getMediaForCall result Return media for participants
