1、 ETSI ES 202 391-11 V1.3.1 (2008-05)ETSI Standard Open Service Access (OSA);Parlay X Web Services;Part 11: Audio Call(Parlay X 2)floppy3 ETSI ETSI ES 202 391-11 V1.3.1 (2008-05) 2 Reference RES/TISPAN-01056-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 391-11 V1.3.1 (2008-05) 3 Contents Intellectual Property Rights4 Foreword.4 1 Scope 5 2 References 5 2.1 Normative references .5 3 Definitions and abbreviations.6 3.1 Definitions6 3.2 Abbreviations .6 4
8、Detailed service description .6 5 Namespaces6 6 Sequence diagrams.6 6.1 Play audio and check status6 6.2 Play audio and cancel .8 7 XML Schema data type definition .8 7.1 MessageStatus enumeration .8 8 Web Service interface definition9 8.1 Interface: PlayAudio.9 8.1.1 Operation: playTextMessage 9 8.
9、1.1.1 Input message: playTextMessageRequest.9 8.1.1.2 Output message: playTextMessageResponse9 8.1.1.3 Referenced faults.9 8.1.2 Operation: playAudioMessage10 8.1.2.1 Input message: playAudioMessageRequest 10 8.1.2.2 Output message: playAudioMessageResponse .10 8.1.2.3 Referenced faults.10 8.1.3 Ope
10、ration: playVoiceXmlMessage.10 8.1.3.1 Input message: playVoiceXmlMessageRequest10 8.1.3.2 Output message: playVoiceXMLMessageResponse.11 8.1.3.3 Referenced faults.11 8.1.4 Operation: getMessageStatus11 8.1.4.1 Input message: getMessageStatusRequest 11 8.1.4.2 Output message: getMessageStatusRespons
11、e .11 8.1.4.3 Referenced faults.11 8.1.5 Operation: endMessage.11 8.1.5.1 Input message: endMessageRequest .12 8.1.5.2 Output message: endMessageResponse 12 8.1.5.3 Referenced faults.12 9 Fault definitions12 10 Service policies 12 Annex A (normative): WSDL for Audio Call13 Annex B (informative): Bib
12、liography.14 History 15 ETSI ETSI ES 202 391-11 V1.3.1 (2008-05) 4 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-m
13、embers, 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/ho
14、me.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 th
15、e 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
16、 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
17、“; Part 11: “Audio Call“; Part 12: “Multimedia Conference“; Part 13: “Address List Management“; Part 14: “Presence“. 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 2.2 set of specificat
18、ions. The present document is equivalent to 3GPP TS 29.199-11 V6.5.0 (Release 6). ETSI ETSI ES 202 391-11 V1.3.1 (2008-05) 5 1 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
19、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
20、detailed method descriptions. Fault definitions. Service Policies. WSDL Description of the interfaces. 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.
21、 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 do
22、cuments 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 shou
23、ld 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 uppe
24、r 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. 2.1 Normative references The following referenced documents are indispensable for the application of the present document. For dated
25、 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/. ETSI E
26、TSI ES 202 391-11 V1.3.1 (2008-05) 6 2 ETSI ES 202 391-1: “Open Service Access (OSA); Parlay X Web Services; Part 1: Common (Parlay X 2)“. 3 Definitions and abbreviations 3.1 Definitions For the purposes of the present document, the terms and definitions given in ES 202 391-1 2 apply. 3.2 Abbreviati
27、ons For the purposes of the present document, the abbreviations given in ES 202 391-1 2 apply. 4 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
28、 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 rendere
29、d 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. 5 Namespaces The AudioCall interface uses the namespace: http:/www.csapi.org/wsdl/parlayx/audio_call/v2_2 The data types are de
30、fined 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. 6 Sequence diagrams 6.1 Play audio and check status
31、 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 ETSI ES
32、202 391-11 V1.3.1 (2008-05) 7 : Application : Audio CallPlay audio requestCorrelatorCreate callRequest statusPENDINGPlay audio messageRequest statusPLAYINGRequest statusPLAYEDAudio completesSome time laterRelease status informationRequest statusService exceptionFigure 1 ETSI ETSI ES 202 391-11 V1.3.
33、1 (2008-05) 8 6.2 Play audio and cancel Pattern: Request / response. The playing of a message may be ended by the requester, as shown. : Application : Audio CallPlay audio requestCorrelatorCreate callPlay audio messageCancel requestCancel callFigure 2 7 XML Schema data type definition 7.1 MessageSta
34、tus 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 ETSI ES 202
35、391-11 V1.3.1 (2008-05) 9 8 Web Service interface definition 8.1 Interface: PlayAudio The PlayAudio interface allows the playing of audio messages using different forms of audio content, and operations to monitor or cancel requests. In all operations, the address is restricted to the use of “tel:“ a
36、nd “sip:“ URIs as specified in ES 202 391-1 2, and wildcards are not permitted in these URIs. 8.1.1 Operation: playTextMessage The invocation of playTextMessage requests to set up a call to the user identified by address and play a text identified by text. The text will be read through a Text-to-Spe
37、ech engine, according to the specified language. The invocation returns as soon as the request is received by the system, i.e. the actual call is performed asynchronously. The correlator, returned by the invocation, can be used to identify the request, e.g. to get information on the request status.
38、This operation is intended to play a message to a single terminal. The URI provided is for a single terminal, not a group URI. If a group URI is provided, a PolicyException will be returned to the application. 8.1.1.1 Input message: playTextMessageRequest Part name Part type Optional Description add
39、ress xsd:anyURI No Address to which message is to be played text xsd:string No Text to process with a Text-To-Speech engine language xsd:string No Language of text (ISO string) charging common:Charging Information Yes Charge to apply for the playing of this message. If charging is not supported then
40、 a PolicyException (POL0008) will be returned 8.1.1.2 Output message: playTextMessageResponse Part name Part type Optional Description result xsd:string No Correlator for this message for subsequent interactions 8.1.1.3 Referenced faults ServiceException from ES 202 391-1 2: SVC0001: Service error.
41、SVC0002: Invalid input value. PolicyException from ES 202 391-1 2: POL0001: Policy error. POL0002: Privacy error. POL0006: Groups not allowed. POL0008: Charging not supported. ETSI ETSI ES 202 391-11 V1.3.1 (2008-05) 108.1.2 Operation: playAudioMessage The invocation of playAudioMessage requests to
42、set up a call to the user identified by address and play an audio file located at audioUrl. The invocation returns as soon as the request is received by the system, i.e. the actual call is performed asynchronously. The correlator, returned by the invocation, can be used to identify the request, e.g.
43、 to get information on the request status. This operation is intended to play a message to a single terminal. The URI provided is for a single terminal, not a group URI. If a group URI is provided, a PolicyException will be returned to the application. 8.1.2.1 Input message: playAudioMessageRequest
44、Part name Part type Optional Description address xsd:anyURI No Address to which message is to be played audioUrl xsd:anyURI No Location of audio content to play charging common:Charging Information Yes Charge to apply for the playing of this message. If charging is not supported then a PolicyExcepti
45、on (POL0008) will be returned 8.1.2.2 Output message: playAudioMessageResponse Part name Part type Optional Description result xsd:string No Correlator for this message for subsequent interactions 8.1.2.3 Referenced faults ServiceException from ES 202 391-1 2: SVC0001: Service error. SVC0002: Invali
46、d input value. PolicyException from ES 202 391-1 2: POL0001: Policy error. POL0002: Privacy error. POL0006: Groups not allowed. POL0008: Charging not supported. 8.1.3 Operation: playVoiceXmlMessage The invocation of playVoiceXmlMessage requests to set up a call to the user identified by address and
47、process VoiceXML content located at voiceXmlUrl. The invocation returns as soon as the request is received by the system, i.e. the actual call is performed asynchronously. The correlator, returned by the invocation, can be used to identify the request, e.g. to get information on the request status.
48、This operation is intended to play a message to a single terminal. The URI provided is for a single terminal, not a group URI. If a group URI is provided, a PolicyException will be returned to the application. 8.1.3.1 Input message: playVoiceXmlMessageRequest Part name Part type Optional Description
49、 address xsd:anyURI No Address to which message is to be played voiceXmlUrl xsd:anyURI No Location of VoiceXML content to process charging common:Charging Information Yes Charge to apply for the playing of this message. If charging is not supported then a PolicyException (POL0008) will be returned ETSI ETSI ES 202 391-11 V1.3.1 (2008-05) 118.1.3.2 Output message: playVoiceXMLMessageResponse Part name Part type Optional Description result xsd:string No Correlator for this message for subsequent interaction
