ETSI TS 129 198-5-2010 Digital cellular telecommunications system (Phase 2+) Universal Mobile Telecommunications System (UMTS) LTE Open Service Access (OSA) Application Programming_1.pdf

1、 ETSI TS 129 198-5 V9.0.0 (2010-01)Technical Specification Digital cellular telecommunications system (Phase 2+);Universal Mobile Telecommunications System (UMTS);LTE;Open Service Access (OSA)Application Programming Interface (API);Part 5: User interaction Service Capability Feature (SCF) (3GPP TS 2

2、9.198-05 version 9.0.0 Release 9)floppy3ETSI ETSI TS 129 198-5 V9.0.0 (2010-01)13GPP TS 29.198-05 version 9.0.0 Release 9Reference RTS/TSGC-0029198-05v900 Keywords GSM, LTE, UMTS 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

3、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 may be made available in more than one electronic version or i

4、n 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 Secretaria

5、t. 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 you

6、r 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 Standa

7、rds Institute 2010. 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 registered for the benefit of its Members and of the 3GPP Organizational Partners. LTE i

8、s a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners. GSM and the GSM logo are Trade Marks registered and owned by the GSM Association. ETSI ETSI TS 129 198-5 V9.0.0 (2010-01)23GPP TS 29.198-05 version 9.0.0 Release 9Intellectual Pr

9、operty 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);

10、 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

11、, 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 Technical Specification (TS) has been produced b

12、y ETSI 3rd Generation Partnership Project (3GPP). The present document may refer to technical specifications or reports using their 3GPP identities, UMTS identities or GSM identities. These should be interpreted as being references to the corresponding ETSI deliverables. The cross reference between

13、GSM, UMTS, 3GPP and ETSI identities can be found under http:/webapp.etsi.org/key/queryform.asp. ETSI ETSI TS 129 198-5 V9.0.0 (2010-01)33GPP TS 29.198-05 version 9.0.0 Release 9Contents Intellectual Property Rights 2g3Foreword . 2g3Foreword . 7g3Introduction 7g31 Scope 9g32 References 9g33 Definitio

14、ns and abbreviations . 10g33.1 Definitions 10g33.2 Abbreviations . 10g34 Generic and Call User Interaction and Administration SCF 10g34.1 Generic and Call User Interaction SCF 10g34.2 Generic User Interaction Administration SCF . 11g34.3 Generic User Interaction SCF Design Aspects . 11g34.4 General

15、requirements on support of methods . 12g35 Sequence Diagrams 12g35.1 Generic and Call User Interaction Sequence Diagrams 12g35.1.1 Alarm Call 12g35.1.2 Call Barring 1 . 14g35.1.3 Network Controlled Notifications . 15g35.1.4 Prepaid 16g35.1.5 Pre-Paid with Advice of Charge (AoC) 18g35.2 Generic User

16、Interaction Administration Sequence Diagrams . 21g35.2.1 Message Administration . 21g36 Class Diagrams . 22g36.1 Generic and Call User Interaction Class Diagrams 22g36.2 Generic User Interaction Administration Class Diagrams . 23g37 The Service Interface Specifications 24g37.1 Interface Specificatio

17、n Format . 24g37.1.1 Interface Class 24g37.1.2 Method descriptions 25g37.1.3 Parameter descriptions 25g37.1.4 State Model . 25g37.2 Base Interface . 25g37.2.1 Interface Class IpInterface 25g37.3 Service Interfaces . 25g37.3.1 Overview 25g37.4 Generic Service Interface . 25g37.4.1 Interface Class IpS

18、ervice 25g37.4.1.1 Method setCallback() 26g37.4.1.2 Method setCallbackWithSessionID() 26g38 Generic User Interaction Interface Classes 26g38.1 Generic and Call User Interaction Interface Classes 26g38.1.1 Interface Class IpUIManager 27g38.1.1.1 Method createUI() . 27g38.1.1.2 Method createUICall() 2

19、8g38.1.1.3 Method createNotification() 28g38.1.1.4 Method destroyNotification() 29g38.1.1.5 Method changeNotification() 29g38.1.1.6 Method getNotification() 30g38.1.1.7 Method enableNotifications() . 30g3ETSI ETSI TS 129 198-5 V9.0.0 (2010-01)43GPP TS 29.198-05 version 9.0.0 Release 98.1.1.8 Method

20、disableNotifications(). 31g38.1.2 Interface Class IpAppUIManager . 31g38.1.2.1 Method userInteractionAborted() 31g38.1.2.2 Method userInteractionNotificationInterrupted() 32g38.1.2.3 Method userInteractionNotificationContinued() . 32g38.1.2.4 Method reportEventNotification() . 32g38.1.2.5 Method abo

21、rtMultipleUserInteractions() 32g38.1.2.6 Method reportEventReq() . 33g38.1.3 Interface Class IpUI 33g38.1.3.1 Method sendInfoReq() 34g38.1.3.2 Method sendInfoAndCollectReq() 35g38.1.3.3 Method release() . 36g38.1.3.4 Method setOriginatingAddress() . 36g38.1.3.5 Method getOriginatingAddress() 37g38.1

22、.3.6 Method reportEventRes() . 37g38.1.3.7 Method reportEventErr() 37g38.1.4 Interface Class IpAppUI . 38g38.1.4.1 Method sendInfoRes() . 38g38.1.4.2 Method sendInfoErr() 38g38.1.4.3 Method sendInfoAndCollectRes() 39g38.1.4.4 Method sendInfoAndCollectErr() . 39g38.1.4.5 Method userInteractionFaultDe

23、tected() 39g38.1.5 Interface Class IpUICall . 40g38.1.5.1 Method recordMessageReq() 40g38.1.5.2 Method deleteMessageReq() . 41g38.1.5.3 Method abortActionReq() . 41g38.1.5.4 Method getMessageReq() . 42g38.1.6 Interface Class IpAppUICall. 42g38.1.6.1 Method recordMessageRes(). 43g38.1.6.2 Method reco

24、rdMessageErr() . 43g38.1.6.3 Method deleteMessageRes() . 43g38.1.6.4 Method deleteMessageErr() 44g38.1.6.5 Method abortActionRes() 44g38.1.6.6 Method abortActionErr() 44g38.1.6.7 Method getMessageRes() 45g38.1.6.8 Method getMessageErr() . 45g38.2 Generic User Interaction Administration Interface Cla

25、sses . 45g38.2.1 Interface Class IpUIAdminManager . 45g38.2.1.1 Method getMessageReq() . 46g38.2.1.2 Method putMessageReq() . 46g38.2.1.3 Method deleteMessageReq() . 46g38.2.1.4 Method getMessageListReq() . 47g38.2.2 Interface Class IpAppUIAdminManager 47g38.2.2.1 Method getMessageRes() 48g38.2.2.2

26、Method getMessageErr() . 48g38.2.2.3 Method deleteMessageRes() . 48g38.2.2.4 Method deleteMessageErr() 49g38.2.2.5 Method putMessageRes() 49g38.2.2.6 Method putMessageErr() 49g38.2.2.7 Method getMessageListRes() 49g38.2.2.8 Method getMessageListErr(). 50g39 State Transition Diagrams 50g39.1 Generic

27、and Call User Interaction State Transition Diagrams 50g39.1.1 State Transition Diagrams for IpUIManager 50g39.1.1.1 Active State . 51g39.1.1.2 Notification Terminated State . 51g39.1.2 State Transition Diagrams for IpUI 51g39.1.2.1 Active State . 51g39.1.2.2 Release Pending State . 51g39.1.2.3 Finis

28、hed State 52g39.1.3 State Transition Diagrams for IpUICall 52g3ETSI ETSI TS 129 198-5 V9.0.0 (2010-01)53GPP TS 29.198-05 version 9.0.0 Release 99.1.3.1 Active State . 52g39.1.3.2 Release Pending State . 52g39.1.3.3 Finished State 53g39.2 Generic User Interaction Administration State Transition Diagr

29、ams . 53g39.2.1 State Transition Diagrams for IpUIAdminManager . 53g39.2.1.1 Active State . 53g310 Service Properties . 54g310.1 User Interaction Service Properties 54g311 Data Definitions . 54g311.1 TpUIFault . 54g311.2 IpUI 54g311.3 IpUIRef 55g311.4 IpAppUI . 55g311.5 IpAppUIRef 55g311.6 IpAppUIMa

30、nager . 55g311.7 IpAppUIManagerRef 55g311.8 TpUICallIdentifier 55g311.9 TpUICollectCriteria 55g311.10 TpUIError . 57g311.11 TpUIEventCriteria 57g311.12 TpUIEventCriteriaResultSet. 57g311.13 TpUIEventCriteriaResult 57g311.14 TpUIEventInfoDataType 58g311.15 TpUIIdentifier 58g311.16 TpUIIdentifierSet .

31、 58g311.17 TpUIInfo. 58g311.18 TpUIInfoType 59g311.19 TpUIMessageCriteria . 59g311.20 TpUIReport 60g311.21 TpUIResponseRequest . 60g311.22 TpUITargetObjectType 60g311.23 TpUITargetObject 61g311.24 TpUIVariableInfo . 61g311.25 TpUIVariableInfoSet 61g311.26 TpUIVariablePartType . 61g311.27 TpUIEventNo

32、tificationInfo 62g311.28 TpUISynthesisInfoData 62g311.29 TpUISynthesisGender 62g311.30 TpUISynthesisAge . 62g311.31 TpUISynthesisRate . 63g311.32 TpUISynthesisRange 63g311.33 TpUIWordOverrideSet . 63g311.34 TpUIWordOverride 63g311.35 TpUIPronounceType 63g311.36 TpUICollectMode 64g311.37 TpUIRecognit

33、ionCriteria 64g311.38 TpUIRecognitionSpeakerID . 64g311.39 TpUIRecognitionPropertySet . 64g311.40 TpUIRecognitionProperty 64g311.41 TpUIRecognitionGrammar. 65g311.42 TpMessageIDList . 66g312 Exception Classes . 66g3Annex A (normative): OMG IDL Description of User Interaction SCF . 67g3Annex B (infor

34、mative): WSDL Description of User Interaction SCF . 68g3Annex C (informative): Java API Description of the User Interaction SCF . 69g3ETSI ETSI TS 129 198-5 V9.0.0 (2010-01)63GPP TS 29.198-05 version 9.0.0 Release 9Annex D (informative): Description of Generic User Interaction SCF for 3GPP2 cdma2000

35、 networks 70g3D.1 General Exceptions. 70g3D.2 Specific Exceptions 70g3D.2.1 Clause 1: Scope 70g3D.2.2 Clause 2: References 70g3D.2.3 Clause 3: Definitions and abbreviations . 70g3D.2.4 Clause 4: Generic and Call User Interaction SCF 70g3D.2.5 Clause 5: Class Diagrams . 70g3D.2.6 Clause 6: Class Diag

36、rams . 71g3D.2.7 Clause 7: The Service Interface Specifications 71g3D.2.8 Clause 8: Generic User Interaction Interface Classes Definitions 71g3D.2.9 Clause 9: State Transition Diagrams 71g3D.2.10 Clause 10: Service Properties . 71g3D.2.11 Clause 11: Data Definitions 71g3D.2.12 Clause 12: Exception C

37、lasses . 71g3D.2.13 Annex A (normative): OMG IDL Description of Generic User Interaction SCF. 71g3D.2.14 Annex B (informative): W3C WSDL Description of Generic User Interaction SCF . 71g3D.2.15 Annex C (informative): Java API Description of Generic User Interaction SCF . 71g3Annex E (informative): C

38、hange history . 72g3History 74g3ETSI ETSI TS 129 198-5 V9.0.0 (2010-01)73GPP TS 29.198-05 version 9.0.0 Release 9Foreword This Technical Specification has been produced by the 3rdGeneration Partnership Project (3GPP). The contents of the present document are subject to continuing work within the TSG

39、 and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: Version x.y.z where: x the first digit: 1 presented to TSG for informa

40、tion; 2 presented to TSG for approval; 3 or greater indicates TSG approved document under change control. y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. z the third digit is incremented when editorial only changes have been inc

41、orporated in the document. Introduction The present document is part 5 of a multi-part TS covering the 3rdGeneration Partnership Project: Technical Specification Group Core Network; Open Service Access (OSA); Application Programming Interface (API), as identified below. The API specification (3GPP T

42、S 29.198) is structured in the following Parts: Part 1: “Overview“; Part 2: “Common Data Definitions“; Part 3: “Framework“; Part 4: “Call Control“; Sub-part 1: “Call Control Common Definitions“; Sub-part 2: “Generic Call Control SCF“; Sub-part 3: “Multi-Party Call Control SCF“; Sub-part 4: “Multi-Me

43、dia Call Control SCF“; Sub-part 5: “Conference Call Control SCF“; Part 5: “User Interaction SCF“; Part 6: “Mobility SCF“; Part 7: “Terminal Capabilities SCF“; Part 8: “Data Session Control SCF“; Part 9: “Generic Messaging SCF“; (not part of 3GPP Release 8) Part 10: “Connectivity Manager SCF“; (new i

44、n 3GPP Release 8) Part 11: “Account Management SCF“; Part 12: “Charging SCF“. Part 13: “Policy Management SCF“; Part 14: “Presence and Availability Management SCF“; Part 15: “Multi Media Messaging SCF“; Part 16: “Service Broker SCF“. The Mapping specification of the OSA APIs and network protocols (3

45、GPP TR 29.998) is also structured as above. A mapping to network protocols is however not applicable for all Parts, but the numbering of Parts is kept. Also in case a Part is not supported in a Release, the numbering of the parts is maintained. ETSI ETSI TS 129 198-5 V9.0.0 (2010-01)83GPP TS 29.198-

46、05 version 9.0.0 Release 9Table: Overview of the OSA APIs Application Programming Interface; Part 1: Overview“. 2 3GPP TS 22.127: “Service Requirement for the Open Services Access (OSA); Stage 1“. 3 3GPP TS 23.198: “Open Service Access (OSA); Stage 2“. 4 Speech Recognition Grammar Specification Vers

47、ion 1: http:/www.w3.org/TR/2004/REC-speech-grammar-20040316/ ETSI ETSI TS 129 198-5 V9.0.0 (2010-01)103GPP TS 29.198-05 version 9.0.0 Release 93 Definitions and abbreviations 3.1 Definitions For the purposes of the present document, the terms and definitions given in TS 29.198-1 1 apply. 3.2 Abbrevi

48、ations For the purposes of the present document, the abbreviations given in TS 29.198-1 1 apply. 4 Generic and Call User Interaction and Administration SCF 4.1 Generic and Call User Interaction SCF The Generic User Interaction service capability feature is used by applications to interact with end u

49、sers. It consists of three interfaces: 1) User Interaction Manager, containing management functions for User Interaction related issues. 2) Generic User Interaction, containing methods to interact with an end-user. 3) Call User Interaction, containing methods to interact with an end-user engaged in a call. The Generic User Interaction service capability feature is described in terms of the methods in the Generic User Interaction interfaces. The following table gives an overview of the Generic User Interaction methods and to which interfaces these methods belong.