1、 ETSI ES 202 391-4 V1.3.1 (2008-05)ETSI Standard Open Service Access (OSA);Parlay X Web Services;Part 4: Short Messaging(Parlay X 2)floppy3 ETSI ETSI ES 202 391-4 V1.3.1 (2008-05) 2 Reference RES/TISPAN-01056-04-OSA Keywords API, OSA, service ETSI 650 Route des Lucioles F-06921 Sophia Antipolis Cede
2、x - 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 documen
3、t 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
4、 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
5、.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
6、to 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 r
7、egistered for the benefit of its Members and of the 3GPP Organizational Partners. ETSI ETSI ES 202 391-4 V1.3.1 (2008-05) 3 Contents Intellectual Property Rights5 Foreword.5 1 Scope 6 2 References 6 2.1 Normative references .6 3 Definitions and abbreviations.7 3.1 Definitions7 3.2 Abbreviations .7 4
8、 Detailed service description .7 5 Namespaces9 6 Sequence diagrams.9 6.1 Send SMS and report status9 7 XML Schema data type definition .10 7.1 DeliveryStatus enumeration .10 7.2 SmsFormat enumeration.11 7.3 DeliveryInformation structure 11 7.4 SmsMessage structure 11 8 Web Service interface definiti
9、on11 8.1 Interface: SendSms.11 8.1.1 Operation: sendSms 12 8.1.1.1 Input message: sendSmsRequest.12 8.1.1.2 Output message: sendSmsResponse12 8.1.1.3 Referenced faults.12 8.1.2 Operation: sendSmsLogo13 8.1.2.1 Input message: sendSmsLogoRequest 13 8.1.2.2 Output message: sendSmsLogoResponse .13 8.1.2
10、.3 Referenced faults.13 8.1.3 Operation: sendSmsRingtone14 8.1.3.1 Input message: sendSmsRingtoneRequest 14 8.1.3.2 Output message: sendSmsRingtoneResponse .14 8.1.3.3 Referenced faults.14 8.1.4 Operation: getSmsDeliveryStatus.15 8.1.4.1 Input message: getSmsDeliveryStatusRequest15 8.1.4.2 Output me
11、ssage: getSmsDeliveryStatusResponse 15 8.1.4.3 Referenced faults.15 8.2 Interface: SmsNotification15 8.2.1 Operation: notifySmsReception16 8.2.1.1 Input message: notifySmsReceptionRequest 16 8.2.1.2 Output message: notifySmsReceptionResponse .16 8.2.1.3 Referenced faults.16 8.2.2 Operation: notifySm
12、sDeliveryReceipt16 8.2.2.1 Input message: notifySmsDeliveryReceiptRequest 17 8.2.2.2 Output message: notifySmsDeliveryReceiptResponse .17 8.2.2.3 Referenced faults.17 8.3 Interface: ReceiveSms17 8.3.1 Operation: getReceivedSms17 8.3.1.1 Input message: getReceivedSmsRequest 17 8.3.1.2 Output message:
13、 getReceivedSmsResponse .17 8.3.1.3 Referenced faults.17 8.4 Interface: SmsNotificationManager .18 8.4.1 Operation: startSmsNotification .18 ETSI ETSI ES 202 391-4 V1.3.1 (2008-05) 4 8.4.1.1 Input message: startSmsNotificationRequest18 8.4.1.2 Output message: startSmsNotificationResponse.18 8.4.1.3
14、Referenced Faults18 8.4.2 Operation: stopSmsNotification19 8.4.2.1 Input message: stopSmsNotificationRequest 19 8.4.2.2 Output message: stopSmsNotificationResponse .19 8.4.2.3 Referenced Faults19 9 Fault definitions19 9.1 ServiceException19 9.1.1 SVC0280: Message too long 19 9.1.2 SVC0281: Unrecogni
15、zed data format.19 9.1.3 Void 19 9.1.4 SVC0283: Delivery Receipt Notification not supported.20 10 Service policies 20 Annex A (normative): WSDL for Short Messaging21 Annex B (informative): Bibliography.22 History 23 ETSI ETSI ES 202 391-4 V1.3.1 (2008-05) 5 Intellectual Property Rights IPRs essentia
16、l 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
17、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 E
18、TSI. 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 Telecommun
19、ications and Internet converged Services and Protocols for Advanced Networking (TISPAN). The present document is part 4 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
20、“; 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: “Pres
21、ence“. 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 specifications. The present document is equivalent to 3GPP TS 29.199-04 V6.8.0 (Release 6). ETSI ETSI ES 202 391-4 V1.3.
22、1 (2008-05) 6 1 Scope The present document is part 4 of the Stage 3 Parlay X 2 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.
23、 the OSA APIs. The present document specifies the Short Messaging 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. 2 Refer
24、ences 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 ca
25、ses: - 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.e
26、tsi.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 va
27、lid 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 pu
28、blication 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 references, only the edition cited applies. For non-specific references, the latest edition of the referenced
29、 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 ETSI ES 202 391-4 V1.3.1 (2008-05) 7 2 ETSI ES 202 391-1: “Open Service Access (OSA); Parlay X Web Services; P
30、art 1: Common (Parlay X 2)“. 3 ETSI TS 123 040: “Digital cellular telecommunications system (Phase 2+); Universal Mobile Telecommunications System (UMTS); Technical realization of Short Message Service (SMS) (3GPP TS 23.040)“. 4 IETF RFC 2822: “Internet Message Format“. NOTE: Available at: http:/www
31、.ietf.org/rfc/rfc2822.txt 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 and the following apply: Whitespace: See definition for CFWS as defined in RFC 2822 . 3.2 Abbreviations For the purposes of the presen
32、t document, the abbreviations given in ES 202 391-1 2 and the following apply: SMS Short Message Service SMS-C Short Message Service - Centre 4 Detailed service description Currently, in order to programmatically receive and send SMS it is necessary to write applications using specific protocols to
33、access SMS functions provided by network elements (e.g. SMS-C). This approach requires a high degree of network expertise. Alternatively it is possible to use the Parlay/OSA approach, invoking standard interfaces (e.g. User Interaction or Messaging Service Interfaces) to gain access to SMS capabilit
34、ies, but these interfaces are usually perceived to be quite complex by IT application developers. Developers must have advanced telecommunication skills to use OSA interfaces. In this clause is described a Parlay X 2 Web Service, for sending and receiving SMS messages. The overall scope of this Web
35、Service is to provide to application developers primitives to handle SMS in a simple way. In fact, using the SMS Web Service, application developers can invoke SMS functions without specific Telco knowledge. ShortMessaging provides operations (see clause 8.1, SendSms API) for sending an SMS message
36、to the network and a polling mechanism for monitoring the delivery status of a sent SMS message. It also provide an asynchronous notification mechanism for delivery status (see clause 8.2.2, SmsNotification API: notifySmsDeliveryReceipt operation). ShortMessaging also allows an application to receiv
37、e SMS messages. Both a polling (see clause 8.3, ReceiveSms API) and an asynchronous notification mechanism (see clause 8.2.1, SmsNotification API: notifySmsReception operation and clause 8.4, SmsNotificationManager API) are available. Figure 1 shows a scenario using the SMS Web Service to send an SM
38、S message from an application. The application invokes a Web Service to retrieve a weather forecast for a subscriber (1) and (2) and a Parlay X 2 Interface (3) to use the SMS Web Service operations (i.e. to send an SMS). After invocation, the SMS Web Service invokes a Parlay API method (4) using the
39、 Parlay/OSA SCS (Generic User Interaction) interface. This SCS handles the invocation and sends an UCP operation (5) to an SMS-C. Subsequently the weather forecast is delivered (6) to the subscriber. In an alternative scenario, the Parlay API interaction involving steps (4) and (5) could be replaced
40、 with a direct interaction between the SMS Web Service and the Mobile network. ETSI ETSI ES 202 391-4 V1.3.1 (2008-05) 8 SMS-XcomponentParlay X I/FParlay GatewaySMS-CSMS-CSCS-SMSSCS-SMSParlay APIMobile networkYou havea new SMSWeather infoInfo meteoWeb ServiceWeb ServicegetMeteoInfo()Retrieveuser Pro
41、file.SendSms (“Weather info”,)Userprofile123456Weather Info SMS WebServiceFigure 1: Send SMS Scenario Figure 2 shows a scenario using the SMS Web Service to deliver a received SMS message to an application. The application receives a Parlay X 2 Web Service invocation for an SMS sent by a subscriber
42、(1) and (2). The SMS message contains the e-mail address of the person the user wishes to call. The application invokes a Parlay X Interface (3) to the Third Party Call Web Service in order to initiate the call (4). SMS-XcomponentSMS WebServiceParlay X I/FMobile networkCnotifySmsReception()Retrieveu
43、ser number.makeACall(“”,)Userprofile221SOAP3PC-XcomponentThird Party CallWeb ServiceParlay X I/FSOAP2343Figure 2: Receive SMS Scenario ETSI ETSI ES 202 391-4 V1.3.1 (2008-05) 9 5 Namespaces The SendSms interface uses the namespace: http:/www.csapi.org/wsdl/parlayx/sms/send/v2_3 The ReceiveSms interf
44、ace uses the namespace: http:/www.csapi.org/wsdl/parlayx/sms/receive/v2_3 The SmsNotification interface uses the namespace: http:/www.csapi.org/wsdl/parlayx/sms/notification/v2_2 The SmsNotificationManager interface uses the namespace: http:/www.csapi.org/wsdl/parlayx/sms/notification_manager/v2_4 T
45、he data types are defined in the namespace: http:/www.csapi.org/schema/parlayx/sms/v2_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 Send SMS and r
46、eport status Sending SMS message from Web portals is a common capability offered by Service Providers. This sequence diagram shows a portal providing this service. ETSI ETSI ES 202 391-4 V1.3.1 (2008-05) 10: End User : Self Serve Portal: Send Sms Web ServiceEnter message text and addressSend SMS mes
47、sageMessage identifierGet message statusMessage statusDisplay result pageShort delayFigure 3 7 XML Schema data type definition 7.1 DeliveryStatus enumeration List of delivery status values. Enumeration value Description DeliveredToNetwork Successful delivery to network. DeliveryUncertain Delivery st
48、atus unknown: e.g. because it was handed off to another network. DeliveryImpossible Unsuccessful delivery; the message could not be delivered before it expired. MessageWaiting The message is still queued for delivery. This is a temporary state, pending transition to one of the preceding states. Deli
49、veredToTerminal Successful delivered to Terminal DeliveryNotificationNotSupported Unable to provide delivery receipt notification. The notifySMSDeliveryReceipt operation will return “DeliveryNotificationNotSupported“ to indicate that delivery receipt for the specified address in a sendSMSRequest message is not supported. ETSI ETSI ES 202 391-4 V1.3.1 (2008-05) 117.2 SmsFormat enumeration List of SMS format values. Enumeration value Description Ems Enhanced Messaging Service, standardized in TS 123 0
