1、 ETSI TR 102 397-11-1 V1.1.1 (2005-08)Technical Report Open Service Access (OSA);Mapping of Parlay X Web Services to Parlay/OSA APIs;Part 11: Audio Call Mapping;Sub-part 1: Mapping to Generic Call Control and User InteractionETSI ETSI TR 102 397-11-1 V1.1.1 (2005-08) 2 Reference DTR/TISPAN-01021-11-
2、01-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 enregistre la Sous-Prfecture de Grasse (06) N 7803/88 Important notice Individual co
3、pies 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
4、 (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 sta
5、tus 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 exce
6、pt as authorized by written permission. The copyright and the foregoing restriction extend to reproduction in all media. European Telecommunications Standards Institute 2005. The Parlay Group 2005. All rights reserved. DECTTM, PLUGTESTSTM and UMTSTM are Trade Marks of ETSI registered for the benefit
7、 of its Members. TIPHONTMand the TIPHON logo are Trade Marks currently being registered by ETSI for the benefit of its Members. 3GPPTM is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners. ETSI ETSI TR 102 397-11-1 V1.1.1 (2005-08) 3 Contents Inte
8、llectual Property Rights4 Foreword.4 1 Scope 5 2 References 5 3 Definitions and abbreviations.5 3.1 Definitions5 3.2 Abbreviations .5 4 Mapping description.5 5 Sequence diagrams.6 5.1 Play message and get message play status .6 5.2 Abandon playing of message7 6 Detailed mapping information8 6.1 Oper
9、ations 8 6.1.1 playTextMessage, playAudioMessage, playVoiceXmlMessage 8 6.1.1.1 Mapping to IpCallControlManager.createCall.8 6.1.1.2 Mapping to IpCall.routeReq .8 6.1.1.3 Mapping to IpUIManager.createUICall9 6.1.1.4 Mapping to IpUICall.sendInfoReq .9 6.1.1.5 Mapping of text 9 6.1.1.6 Mapping of voic
10、eXmlUrl .10 6.1.1.7 Mapping of audioURL.10 6.1.2 getMessageStatus11 6.1.3 endMessage.11 6.2 Exceptions 11 7 Additional notes .11 History 12 ETSI ETSI TR 102 397-11-1 V1.1.1 (2005-08) 4 Intellectual Property Rights IPRs essential or potentially essential to the present document may have been declared
11、 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
12、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 refe
13、renced 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 Technical Report (TR) has been produced by ETSI Technical Committee Telecommunications and Internet converged Services and Protocols for Advanced Ne
14、tworking (TISPAN). The present document is part 11, sub-part 1 of a multi-part deliverable covering Open Service Access (OSA); Mapping of Parlay X Web Services to Parlay/OSA APIs, as identified below: Part 1: “Common Mapping“; Part 2: “Third Party Call Mapping“; Part 3: “Call Notification Mapping“;
15、Part 4: “Short Messaging Mapping“; Part 5: “Multimedia Messaging Mapping“; Part 6: “Payment Mapping“; Part 7: “Account Management Mapping“; Part 8: “Terminal Status Mapping“; Part 9: “Terminal Location Mapping“; Part 10: “Call Handling Mapping“; Part 11: “Audio Call Mapping“; Sub-part 1: “Mapping to
16、 Generic Call Control and User Interaction“; Sub-part 2: “Mapping to Multi-Party Call Control and User Interaction“; Part 12: “Multimedia Conference Mapping“; Part 14: “Presence Mapping“. NOTE: Part 13 has not been provided as there is currently no defined mapping between ES 202 391-13 4 and the Par
17、lay/OSA APIs. If a mapping is developed, it will become part 13 of this series. The present document has been defined jointly between ETSI, The Parlay Group (http:/www.parlay.org) and the 3GPP. ETSI ETSI TR 102 397-11-1 V1.1.1 (2005-08) 5 1 Scope The present document specifies the mapping of the Par
18、lay X Audio Call Web Service to the Generic Call Control and User Interaction Service Capability Features (SCFs). The Parlay X Web Services provide powerful yet simple, highly abstracted, imaginative, telecommunications functions that application developers and the IT community can both quickly comp
19、rehend and use to generate new, innovative applications. The Open Service Access (OSA) specifications define an architecture that enables application developers to make use of network functionality through an open standardized interface, i.e. the Parlay/OSA APIs. 2 References For the purposes of thi
20、s Technical Report (TR), the following references apply: 1 ETSI TR 121 905: “Universal Mobile Telecommunications System (UMTS); Vocabulary for 3GPP Specifications (3GPP TR 21.905)“. 2 W3C Recommendation (2 May 2001): “XML Schema Part 2: Datatypes“. NOTE: Available at http:/www.w3.org/TR/2001/REC-xml
21、schema-2-20010502/. 3 ETSI TR 102 397-1: “Open Service Access (OSA); Mapping of Parlay X Web Services to Parlay/OSA APIs; Part 1: Common Mapping“. 4 ETSI ES 202 391-13: “Open Service Access (OSA); Parlay X Web Services; Part 13: Address List Management“. 5 ISO 639: “Codes for the representation of n
22、ames of languages“. 3 Definitions and abbreviations 3.1 Definitions For the purposes of the present document, the terms and definitions given in TR 102 397-1 3 apply. 3.2 Abbreviations For the purposes of the present document, the abbreviations given in TR 102 397-1 3 apply. 4 Mapping description Th
23、e Call Handling capability can be implemented with Parlay/OSA Generic Call Control and User Interaction. It is applicable to ETSI OSA 1.x/2.x/3.x, Parlay/OSA 3.x/4.x/5.x and 3GPP Releases 4 to 6. ETSI ETSI TR 102 397-11-1 V1.1.1 (2005-08) 6 5 Sequence diagrams 5.1 Play message and get message play s
24、tatus Audio Call IpAppCCManagerIp CC Manager IpApp Call IpCall Appl IpApp UICall IpUI Manager Ip UICall “new“ createUICall “new“ sendInfoReq sendInfoRes release “destroy“ “notify“ createCall “new“ routeReqrouteRes, P_CALL_REPORT_ANSWER “notify“ “new“ playXxxMessageRequest playXxxMessageResponse getM
25、essageStatusRequestgetMessageStatusResponse: PLAYING getMessageStatusRequestgetMessagegeStatusResponse: PENDING getMessageStatusRequest getMessageStatusResponse: PLAYED Figure 1 ETSI ETSI TR 102 397-11-1 V1.1.1 (2005-08) 7 5.2 Abandon playing of message Audio Call IpApp CCManager Ip CC Manager IpApp
26、 Call Ip Call Appl IpApp UICall IpUI Manager Ip UICall release “destroy“ createCall “new“ routeReq routeRes, P_CALL_REPORT_ANSWER “notify“ “new“ playXxxMessageRequest playXxxMessageResponse endMessageRequest endMessageResponse:PENDING Figure 2 ETSI ETSI TR 102 397-11-1 V1.1.1 (2005-08) 8 6 Detailed
27、mapping information 6.1 Operations 6.1.1 playTextMessage, playAudioMessage, playVoiceXmlMessage These operations interact with a call control service to establish a call, where the call is associated with a user interaction service context in which the audio is generated on the call. The sequence di
28、agram in clause 5.1 illustrates the flow for these operations. The playXxxMessage operation is synchronous from the Parlay X clients point of view. It is mapped to the following Parlay/OSA methods: IpCallControlManager.createCall; IpCall.routeReq; IpUIManager.createUICall; IpUICall.sendInfoReq. 6.1.
29、1.1 Mapping to IpCallControlManager.createCall The IpCallControlManager.createCall method is invoked with the following parameters. Name Type Comment appCall IpAppCallRef Reference to callback (internal). The result from IpCallControlManager.createCall is of type TpCallIdentifier and is used interna
30、lly to correlate the callbacks. Specifically it is correlated with the value of the correlator part returned to the application in the playXxxMessageResponse message. Parlay exceptions thrown by IpCallControlManager.createCall are mapped to Parlay X exceptions as defined in clause 6.2. 6.1.1.2 Mappi
31、ng to IpCall.routeReq The IpCall.routeReq method is invoked with the following parameters. Name Type Comment callSessionID TpSessionID Not mapped. The value provide in the result from IpCallControlManager.createCall. responseRequested TpCallReportRequest Set Not mapped. Requests call-related event r
32、eports: i.e. including Answer, Busy, No Answer, Not Reachable. targetAddress TpAddress Specifies the destination leg to which the call should be routed. It is constructed based on the URI provided in the address part of playXxxMessageRequest, mapped as described in TR 102 397-1 3. originatingAddress
33、 TpAddress Not mapped. Specifies the calling party leg. originalDestination Address TpAddress Not mapped. redirectingAddress TpAddress Not mapped. appInfo TpCallAppInfoSet No mappedThe result from IpCall.routeReq is of type TpSessionID and is used internally to correlate the callbacks. It is not map
34、ped to the Parlay X interface. Parlay exceptions thrown by IpCall.routeReq are mapped to Parlay X exceptions as defined in clause 6.2. ETSI ETSI TR 102 397-11-1 V1.1.1 (2005-08) 9 6.1.1.3 Mapping to IpUIManager.createUICall The IpUIManager.createUICall method is invoked with the following parameters
35、. Name Type Comment appUI IpAppUICallRef Not mapped: reference to callback (internal). uiTargetObject TpUITargetObject Not mapped. The value provide in the result from IpCallControlManager.createCall. The result from IpUIManager.createUICall is of type TpUICallIdentifier and is used internally to co
36、rrelate the callbacks. Specifically it is correlated with the value of the correlator part returned to the application in the playXxxMessageResponse message. Parlay exceptions thrown by IpUIManager.createUICall are mapped to Parlay X exceptions as defined in clause 6.2. 6.1.1.4 Mapping to IpUICall.s
37、endInfoReq The IpUICall.sendInfoReq method is invoked with the following parameters. Name Type Comment userInteraction SessionID TpSessionID Not mapped: reference to callback (internal) The value contained in the TpUICallIdentifier parameter returned by IpUIManager.createUICall. info TpUIInfo variab
38、leInfo TpUIVariableInfo Set The mapping from the text part is described in clause 6.1.1.5 The mapping from the voiceXmlUrl part is described in clause 6.1.1.6 The mapping from the audioURL part is described in clause 6.1.1.7 Some mapping support for the optional charging part: i.e. it could be mappe
39、d to a VariablePartPrice element(s) of the variableInfo parameter. language TpLanguage The language part is mapped to the language parameter; both part and parameter conform to ISO 639 5. repeatIndicator TpInt32 Not mapped. response Requested TpUIResponse Request Not mapped. Set to P_UI_RESPONSE_REQ
40、UIRED. The result from IpUICall.sendInfoReq is of type TpAssignmentID and is used internally to correlate the callbacks (e.g. invocation of IpAppUICall.sendInfoRes/Err). Specifically it is correlated with the value of the correlator part returned to the application in the playXxxMessageResponse mess
41、age. Parlay exceptions thrown by IpUICall.sendInfoReq are mapped to Parlay X exceptions as defined in clause 6.2. 6.1.1.5 Mapping of text The text part is of type xsd:string and represents the text to process and play through a Text-To-Speech engine. It is mapped to the info and variableInfo paramet
42、ers as follows: For ETSI OSA 1.x, Parlay/OSA 3.x and 3GPP Release 4.x and subsequent releases, the text part is mapped to InfoData (info.P_UI_INFO_DATA), which defines the data to be sent to an end-users terminal. The data is free-format and the encoding is depending on the resources being used. - T
43、he Audio Call web service needs to indicate that text-to-speech processing is required from a network resource. Options for indicating this are vendor-specific. square4 One option is to include an indicator in the InfoData parameter: e.g. by prefixing the value of the text part. square4 Another opti
44、on is to use the variableInfo parameter: e.g. the VariablePartInteger or VariablePartAddress element. ETSI ETSI TR 102 397-11-1 V1.1.1 (2005-08) 10 For ETSI OSA 3.x, Parlay/OSA 5.x and 3GPP Release 6.x, an alternative mapping of the text part is to InfoSynthData (info. P_UI_INFO_SYNTHESIS), which de
45、scribes the content and how the speech synthesis will be done. Specifically the text part is mapped to the InfoSynthData.TextData field. There is no mapping to the other fields of InfoSynthData that define how the synthesis should be done; these fields are provisioned by the vendor. 6.1.1.6 Mapping
46、of voiceXmlUrl The voiceXmlUrl part is of type xsd:anyURI and represents the location of VoiceXML to be processed by a VoiceXML browser. It is mapped to the info and variableInfo parameters as follows: For ETSI OSA 1.x, Parlay/OSA 3.x and 3GPP Release 4.x and subsequent releases, the voiceXmlUrl par
47、t is mapped to InfoAddress (info.P_UI_INFO_ADDRESS), which defines the URL of the stream to be sent to an end-users terminal. NOTE: In later releases of the API, the scope of the InfoAddress parameter is expanded to represent the URL of a voice application script or stream to be either sent to an en
48、d-users terminal or invoked in the network in order to carry out the interaction dialogue. However an alternative parameter mapping is also available in later API releases, as described below. - The Audio Call web service needs to indicate that VoiceXML browser processing is required from a network
49、resource. Options for indicating this are vendor-specific. square4 One option is to provide an indicator in the variableInfo parameter: e.g. the VariablePartInteger or VariablePartAddress element. For ETSI OSA 3.x, Parlay/OSA 5.x and 3GPP Release 6.x, an alternative mapping of the voiceXmlUrl part is to InfoVXMLData (info. P_UI_INFO_VXML), which defines the TpString that describes the VXML (Voice XML) page that is sent to the server for execution and interaction with the end-user. (See http:/www.w3.org/TR/2000/NOTE-voicexml-2
