ETSI ES 202 391-4 V1.3.1 (2008-05)
Open Service Access (OSA); Parlay X Web Services; Part 4: Short Messaging (Parlay X 2)
Open Service Access (OSA); Parlay X Web Services; Part 4: Short Messaging (Parlay X 2)
RES/TISPAN-01056-04-OSA
Odprti dostop do storitve (OSA) - Spletne storitve Parlay X - 4. del: Kratko sporočanje (Parlay X 2)
General Information
Buy Standard
Standards Content (Sample)
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)
�
---------------------- Page: 1 ----------------------
2 ETSI ES 202 391-4 V1.3.1 (2008-05)
Reference
RES/TISPAN-01056-04-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 enregistrée à la
Sous-Préfecture 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 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 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.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 to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
---------------------- Page: 2 ----------------------
3 ETSI ES 202 391-4 V1.3.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
2.1 Normative references.6
3 Definitions and abbreviations.7
3.1 Definitions.7
3.2 Abbreviations.7
4 Detailed service description .7
5 Namespaces.9
6 Sequence diagrams.9
6.1 Send SMS and report status.9
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 definition.11
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: sendSmsResponse.12
8.1.1.3 Referenced faults.12
8.1.2 Operation: sendSmsLogo.13
8.1.2.1 Input message: sendSmsLogoRequest .13
8.1.2.2 Output message: sendSmsLogoResponse .13
8.1.2.3 Referenced faults.13
8.1.3 Operation: sendSmsRingtone.14
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: getSmsDeliveryStatusRequest.15
8.1.4.2 Output message: getSmsDeliveryStatusResponse .15
8.1.4.3 Referenced faults.15
8.2 Interface: SmsNotification.15
8.2.1 Operation: notifySmsReception.16
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: notifySmsDeliveryReceipt.16
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: ReceiveSms.17
8.3.1 Operation: getReceivedSms.17
8.3.1.1 Input message: getReceivedSmsRequest .17
8.3.1.2 Output message: getReceivedSmsResponse.17
8.3.1.3 Referenced faults.17
8.4 Interface: SmsNotificationManager.18
8.4.1 Operation: startSmsNotification.18
ETSI
---------------------- Page: 3 ----------------------
4 ETSI ES 202 391-4 V1.3.1 (2008-05)
8.4.1.1 Input message: startSmsNotificationRequest.18
8.4.1.2 Output message: startSmsNotificationResponse.18
8.4.1.3 Referenced Faults.18
8.4.2 Operation: stopSmsNotification.19
8.4.2.1 Input message: stopSmsNotificationRequest .19
8.4.2.2 Output message: stopSmsNotificationResponse.19
8.4.2.3 Referenced Faults.19
9 Fault definitions.19
9.1 ServiceException.19
9.1.1 SVC0280: Message too long .19
9.1.2 SVC0281: Unrecognized 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 Messaging.21
Annex B (informative): Bibliography.22
History .23
ETSI
---------------------- Page: 4 ----------------------
5 ETSI ES 202 391-4 V1.3.1 (2008-05)
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 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/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 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 Telecommunications 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";
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: "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 specifications.
The present document is equivalent to 3GPP TS 29.199-04 V6.8.0 (Release 6).
ETSI
---------------------- Page: 5 ----------------------
6 ETSI ES 202 391-4 V1.3.1 (2008-05)
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. 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 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.
• 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 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 referenced 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 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.
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 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
---------------------- Page: 6 ----------------------
7 ETSI ES 202 391-4 V1.3.1 (2008-05)
[2] ETSI ES 202 391-1: "Open Service Access (OSA); Parlay X Web Services; Part 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.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 present 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 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 capabilities, 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 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 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 receive 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 SMS 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 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 with a direct
interaction between the SMS Web Service and the Mobile network.
ETSI
---------------------- Page: 7 ----------------------
8 ETSI ES 202 391-4 V1.3.1 (2008-05)
SMS Web
Weather Info
Info meteo SMS-X
Service
Web Service
Web Service component
Parlay X I/F
SCS-SMS
SCS-SMS
4
1 Parlay API
Parlay Gateway
5
3
…….
You have
getMeteoInfo()
a new SMS…
….
…Weather info
SMS-C
Retrieve
SMS-C
user Profile
….
2
Mobile network
SendSms (
“Weather inf.o.”,,,)
User
6
profile
Figure 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 (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).
4
Third Party Call
3PC-X
Web Service
component
Mobile network
Parlay X I/F
SMS Web 1
SMS-X
Service
3 component
Parlay X I/F
SOAP
2
SOAP
Call
mary@company.com
…….
2
notifySmsReception()
{….
Retrieve
user number
….
2
3
makeACall(“.”,,,)
User
profile }
Figure 2: Receive SMS Scenario
ETSI
---------------------- Page: 8 ----------------------
9 ETSI ES 202 391-4 V1.3.1 (2008-05)
5 Namespaces
The SendSms interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/sms/send/v2_3
The ReceiveSms interface 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
The 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 report 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
---------------------- Page: 9 ----------------------
10 ETSI ES 202 391-4 V1.3.1 (2008-05)
: End User : Self Serve : Send Sms
Portal Web Service
Enter message text and address
Send SMS message
Message identifier
Short delay
Get message status
Message status
Display result page
Figure 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 status 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.
DeliveredToTerminal Successful delivered to Terminal
DeliveryNotificationNotS Unable to provide delivery receipt notification. The notifySMSDeliveryReceipt
upported operation will return "DeliveryNotificationNotSupported" to indicate that delivery
receipt for the specified address in a sendSMS…Request message is not
supported.
ETSI
---------------------- Page: 10 ----------------------
11 ETSI ES 202 391-4 V1.3.1 (2008-05)
7.2 SmsFormat enumeration
List of SMS format values.
Enumeration value Description
Ems Enhanced Messaging Service, standardized in TS 123 040 [], which defines a
logo/ringtone format
TM
Defines a logo/ringtone format
SmartMessaging
7.3 DeliveryInformation structure
Delivery status information.
Element name Element type Optional Description
address xsd:anyURI No It indicates the destination address to which the notification is related
deliveryStatus DeliveryStatus No Indicates the delivery result for the destination address
7.4 SmsMessage structure
SMS message information. The senderAddress is the address from which the message was actually sent, which may or
may not match the senderName value provided in the sendSms operation.
Element name Element type Optional Description
message xsd:string No Text received in SMS
senderAddress xsd:anyURI No It indicates address sending the SMS
smsServiceActivation xsd:anyURI No Number associated with the invoked Message service, i.e. the
Number destination address used to send the message
dateTime xsd:dateTime Yes Time when message was received by operator
8 Web Service interface definition
8.1 Interface: SendSms
This interface defines operations to send various types of Short Messages and to subsequently poll for delivery status.
The Short Message types are:
• SMS message, as described in clause 8.1.1.
• SMS logo, as described in clause 8.1.2.
• SMS ringtone, as described in clause 8.1.3.
The send operations for the Short Message types are similar. A description of the common message parts follows:
• addresses specifies the destination address or address set for the Short Message. It may include group URIs as
defined in the Address List Management specification. If groups are not supported, a PolicyException
(POL0006) will be returned to the application.
• senderName is optional and specifies the sender's name: i.e. the string that is displayed on the user's terminal
as the originator of the message.
• charging specifies the charging information.
ETSI
---------------------- Page: 11 ----------------------
12 ETSI ES 202 391-4 V1.3.1 (2008-05)
• receiptRequest is optional and is specified when the application requires to receive notification of the status
of the SMS delivery. It is a SimpleReference structure that indicates the application endpoint, interface used
for notification of delivery receipt and a correlator that uniquely identifies the sending request:
- If the notification mechanism is not supported by a network, a ServiceException (SVC0283) will be
returned to the application and the message will not be sent to the addresses specified.
- The correlator provided in the receiptRequest must be unique for this Web Service and application at
the time the notification is initiated, otherwise a ServiceException (SVC0005) will be returned to the
application.
- Notification to the application is done by invoking the notifySmsDeliveryReceipt operation at the
endpoint specified in receiptRequest.
• requestIdentifier is specified in the response message associated with each send operation. The application
can use it to invoke the getSmsDeliveryStatus operation to poll for the delivery status.
8.1.1 Operation: sendSms
The application invokes the sendSms operation to send an SMS message, specified by the String message.
If message is longer than the maximum supported length, the message content will be sent as several concatenated short
messages.
8.1.1.1 Input message: sendSmsRequest
Part name Part type Optional Description
addresses xsd:anyURI [1.unbounded] No Addresses to which the SMS will be sent
senderName xsd:string Yes If present, it indicates the SMS sender name, i.e. the
string that is displayed on the user's terminal as the
originator of the message
charging common:ChargingInformation Yes Charge to apply to this message
message xsd:string No Text to be sent in SMS
receiptRequest common:SimpleReference Yes It defines the application endpoint, interfaceName and
correlator that will be used to notify the application when
the message has been delivered to the terminal or if
delivery is impossible
8.1.1.2 Output message: sendSmsResponse
Part name Part type Optional Description
result xsd:string No It identifies a specific SMS delivery request
8.1.1.3 Referenced faults
ServiceException from ES 202 391-1 [2]:
• SVC0001 - Service error.
• SVC0002 - Invalid input value.
• SVC0004 - No valid addresses.
• SVC0006 - Invalid group.
• SVC0280 - Message too long.
• SVC0283 - Delivery Receipt Notification not supported.
ETSI
---------------------- Page: 12 ----------------------
13 ETSI ES 202 391-4 V1.3.1 (2008-05)
PolicyException from ES 202 391-1 [2]:
• POL0001 - Policy error.
• POL0006 - Groups not allowed.
• POL0007 - Nested groups not allowed.
• POL0008 - Charging not allowed.
8.1.2 Operation: sendSmsLogo
The application invokes the sendSmsLogo operation to send an SMS logo, specified by the byte array image.
8.1.2.1 Input message: sendSmsLogoRequest
Part name Part type Optional Description
addresses xsd:anyURI [1.unbounded] No Addresses to which the SMS logo will be sent
senderName xsd:string Yes SMS sender name, i.e. the string that is displayed on the
user's terminal as the originator of the message
charging common:ChargingInformation Yes Charge to apply to this message
image xsd:base64Binary No The image in jpeg, gif or png format. The image will be
scaled to the proper format
smsFormat SmsFormat No Conversion to be applied to the message prior to
delivery. Possible values are: "Ems" or
"SmartMessaging"
receiptRequest common:SimpleReference Yes It defines the application endpoint, interfaceName and
correlator that will be used to notify the application when
the message has been delivered to the terminal or if
delivery is impossible.
8.1.2.2 Output message: sendSmsLogoResponse
Part name Part type Optional Description
result xsd:string No It identifies a specific SMS delivery request
8.1.2.3 Referenced faults
ServiceException from ES 202 391-1 [2]:
• SVC0001 - Service error.
• SVC0002 - Invalid input value.
• SVC0004 - No valid addresses.
• SVC0006 - Invalid group.
• SVC0281 - Unrecognized data format.
• SVC
...
Final draft ETSI ES 202 391-4 V1.3.1 (2008-02)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 4: Short Messaging
(Parlay X 2)
�
---------------------- Page: 1 ----------------------
2 Final draft ETSI ES 202 391-4 V1.3.1 (2008-02)
Reference
RES/TISPAN-01056-04-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 enregistrée à la
Sous-Préfecture 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 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 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.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 to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
---------------------- Page: 2 ----------------------
3 Final draft ETSI ES 202 391-4 V1.3.1 (2008-02)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
2.1 Normative references.6
3 Definitions and abbreviations.7
3.1 Definitions.7
3.2 Abbreviations.7
4 Detailed service description .7
5 Namespaces.9
6 Sequence diagrams.9
6.1 Send SMS and report status.9
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 definition.11
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: sendSmsResponse.12
8.1.1.3 Referenced faults.12
8.1.2 Operation: sendSmsLogo.13
8.1.2.1 Input message: sendSmsLogoRequest .13
8.1.2.2 Output message: sendSmsLogoResponse .13
8.1.2.3 Referenced faults.13
8.1.3 Operation: sendSmsRingtone.14
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: getSmsDeliveryStatusRequest.15
8.1.4.2 Output message: getSmsDeliveryStatusResponse .15
8.1.4.3 Referenced faults.15
8.2 Interface: SmsNotification.15
8.2.1 Operation: notifySmsReception.16
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: notifySmsDeliveryReceipt.16
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: ReceiveSms.17
8.3.1 Operation: getReceivedSms.17
8.3.1.1 Input message: getReceivedSmsRequest .17
8.3.1.2 Output message: getReceivedSmsResponse.17
8.3.1.3 Referenced faults.17
8.4 Interface: SmsNotificationManager.18
8.4.1 Operation: startSmsNotification.18
ETSI
---------------------- Page: 3 ----------------------
4 Final draft ETSI ES 202 391-4 V1.3.1 (2008-02)
8.4.1.1 Input message: startSmsNotificationRequest.18
8.4.1.2 Output message: startSmsNotificationResponse.18
8.4.1.3 Referenced Faults.18
8.4.2 Operation: stopSmsNotification.19
8.4.2.1 Input message: stopSmsNotificationRequest .19
8.4.2.2 Output message: stopSmsNotificationResponse.19
8.4.2.3 Referenced Faults.19
9 Fault definitions.19
9.1 ServiceException.19
9.1.1 SVC0280: Message too long .19
9.1.2 SVC0281: Unrecognized 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 Messaging.21
Annex B (informative): Bibliography.22
History .23
ETSI
---------------------- Page: 4 ----------------------
5 Final draft ETSI ES 202 391-4 V1.3.1 (2008-02)
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 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/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 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 Telecommunications and Internet
converged Services and Protocols for Advanced Networking (TISPAN), and is now submitted for the ETSI standards
Membership Approval Procedure.
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";
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: "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 specifications.
The present document is equivalent to 3GPP TS 29.199-04 V6.8.0 (Release 6).
ETSI
---------------------- Page: 5 ----------------------
6 Final draft ETSI ES 202 391-4 V1.3.1 (2008-02)
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. 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 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.
• 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 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 referenced 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 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.
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 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
---------------------- Page: 6 ----------------------
7 Final draft ETSI ES 202 391-4 V1.3.1 (2008-02)
[2] ETSI ES 202 391-1: "Open Service Access (OSA); Parlay X Web Services; Part 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.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 present 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 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 capabilities, 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 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 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 receive 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 SMS 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 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 with a direct
interaction between the SMS Web Service and the Mobile network.
ETSI
---------------------- Page: 7 ----------------------
8 Final draft ETSI ES 202 391-4 V1.3.1 (2008-02)
SMS Web
Weather Info
Info meteo SMS-X
Service
Web Service
Web Service component
Parlay X I/F
SCS-SMS
SCS-SMS
4
1 Parlay API
Parlay Gateway
5
3
…….
You have
getMeteoInfo()
a new SMS…
….
…Weather info
SMS-C
Retrieve
SMS-C
user Profile
….
2
Mobile network
SendSms (
“Weather inf.o.”,,,)
User
6
profile
Figure 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 (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).
4
Third Party Call
3PC-X
Web Service
component
Mobile network
Parlay X I/F
SMS Web 1
SMS-X
Service
3 component
Parlay X I/F
SOAP
2
SOAP
Call
mary@company.com
…….
2
notifySmsReception()
{….
Retrieve
user number
….
2
3
makeACall(“.”,,,)
User
profile }
Figure 2: Receive SMS Scenario
ETSI
---------------------- Page: 8 ----------------------
9 Final draft ETSI ES 202 391-4 V1.3.1 (2008-02)
5 Namespaces
The SendSms interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/sms/send/v2_3
The ReceiveSms interface 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
The 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 report 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
---------------------- Page: 9 ----------------------
10 Final draft ETSI ES 202 391-4 V1.3.1 (2008-02)
: End User : Self Serve : Send Sms
Portal Web Service
Enter message text and address
Send SMS message
Message identifier
Short delay
Get message status
Message status
Display result page
Figure 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 status 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.
DeliveredToTerminal Successful delivered to Terminal
DeliveryNotificationNotS Unable to provide delivery receipt notification. The notifySMSDeliveryReceipt
upported operation will return "DeliveryNotificationNotSupported" to indicate that delivery
receipt for the specified address in a sendSMS…Request message is not
supported.
ETSI
---------------------- Page: 10 ----------------------
11 Final draft ETSI ES 202 391-4 V1.3.1 (2008-02)
7.2 SmsFormat enumeration
List of SMS format values.
Enumeration value Description
Ems Enhanced Messaging Service, standardized in TS 123 040 [], which defines a
logo/ringtone format
TM
Defines a logo/ringtone format
SmartMessaging
7.3 DeliveryInformation structure
Delivery status information.
Element name Element type Optional Description
address xsd:anyURI No It indicates the destination address to which the notification is related
deliveryStatus DeliveryStatus No Indicates the delivery result for the destination address
7.4 SmsMessage structure
SMS message information. The senderAddress is the address from which the message was actually sent, which may or
may not match the senderName value provided in the sendSms operation.
Element name Element type Optional Description
message xsd:string No Text received in SMS
senderAddress xsd:anyURI No It indicates address sending the SMS
smsServiceActivation xsd:anyURI No Number associated with the invoked Message service, i.e. the
Number destination address used to send the message
dateTime xsd:dateTime Yes Time when message was received by operator
8 Web Service interface definition
8.1 Interface: SendSms
This interface defines operations to send various types of Short Messages and to subsequently poll for delivery status.
The Short Message types are:
• SMS message, as described in clause 8.1.1 Operation: sendSms.
• SMS logo, as described in clause 8.1.2 Operation: sendSmsLogo.
• SMS ringtone, as described in clause 8.1.3 Operation: sendSmsRingtone.
The send operations for the Short Message types are similar. A description of the common message parts follows:
• addresses specifies the destination address or address set for the Short Message. It may include group URIs as
defined in the Address List Management specification. If groups are not supported, a PolicyException
(POL0006) will be returned to the application.
• senderName is optional and specifies the sender's name: i.e. the string that is displayed on the user's terminal
as the originator of the message.
• charging specifies the charging information.
ETSI
---------------------- Page: 11 ----------------------
12 Final draft ETSI ES 202 391-4 V1.3.1 (2008-02)
• receiptRequest is optional and is specified when the application requires to receive notification of the status
of the SMS delivery. It is a SimpleReference structure that indicates the application endpoint, interface used
for notification of delivery receipt and a correlator that uniquely identifies the sending request:
- If the notification mechanism is not supported by a network, a ServiceException (SVC0283) will be
returned to the application and the message will not be sent to the addresses specified.
- The correlator provided in the receiptRequest must be unique for this Web Service and application at
the time the notification is initiated, otherwise a ServiceException (SVC0005) will be returned to the
application.
- Notification to the application is done by invoking the notifySmsDeliveryReceipt operation at the
endpoint specified in receiptRequest.
• requestIdentifier is specified in the response message associated with each send operation. The application
can use it to invoke the getSmsDeliveryStatus operation to poll for the delivery status.
8.1.1 Operation: sendSms
The application invokes the sendSms operation to send an SMS message, specified by the String message.
If message is longer than the maximum supported length, the message content will be sent as several concatenated short
messages.
8.1.1.1 Input message: sendSmsRequest
Part name Part type Optional Description
addresses xsd:anyURI [1.unbounded] No Addresses to which the SMS will be sent
senderName xsd:string Yes If present, it indicates the SMS sender name, i.e. the
string that is displayed on the user's terminal as the
originator of the message
charging common:ChargingInformation Yes Charge to apply to this message
message xsd:string No Text to be sent in SMS
receiptRequest common:SimpleReference Yes It defines the application endpoint, interfaceName and
correlator that will be used to notify the application when
the message has been delivered to the terminal or if
delivery is impossible
8.1.1.2 Output message: sendSmsResponse
Part name Part type Optional Description
result xsd:string No It identifies a specific SMS delivery request
8.1.1.3 Referenced faults
ServiceException from ES 202 391-1 [2]:
• SVC0001 - Service error.
• SVC0002 - Invalid input value.
• SVC0004 - No valid addresses.
• SVC0006 - Invalid group.
• SVC0280 - Message too long.
• SVC0283 - Delivery Receipt Notification not supported.
ETSI
---------------------- Page: 12 ----------------------
13 Final draft ETSI ES 202 391-4 V1.3.1 (2008-02)
PolicyException from ES 202 391-1 [2]:
• POL0001 - Policy error.
• POL0006 - Groups not allowed.
• POL0007 - Nested groups not allowed.
• POL0008 - Charging not allowed.
8.1.2 Operation: sendSmsLogo
The application invokes the sendSmsLogo operation to send an SMS logo, specified by the byte array image.
8.1.2.1 Input message: sendSmsLogoRequest
Part name Part type Optional Description
addresses xsd:anyURI [1.unbounded] No Addresses to which the SMS logo will be sent
senderName xsd:string Yes SMS sender name, i.e. the string that is displayed on the
user's terminal as the originator of the message
charging common:ChargingInformation Yes Charge to apply to this message
image xsd:base64Binary No The image in jpeg, gif or png format. The image will be
scaled to the proper format
smsFormat SmsFormat No Conversion to be applied to the message prior to
delivery. Possible values are: "Ems" or
"SmartMessaging"
receiptRequest common:SimpleReference Yes It defines the application endpoint, interfaceName and
correlator that will be used to notify the application when
the message has been delivered to the terminal or if
delivery is impossible.
8.1.2.2 Output message: sendSmsLogoResponse
Part name Part type Optional Description
res
...
SLOVENSKI STANDARD
SIST ES 202 391-4 V1.3.1:2008
01-september-2008
2GSUWLGRVWRSGRVWRULWYH 26$ 6SOHWQHVWRULWYH3DUOD\;GHO .UDWNR
VSRURþDQMH 3DUOD\;
Open Service Access (OSA) - Parlay X Web Services - Part 4: Short Messaging (Parlay
X 2)
Ta slovenski standard je istoveten z: ES 202 391-4 Version 1.3.1
ICS:
35.100.01 Medsebojno povezovanje Open systems
odprtih sistemov na splošno interconnection in general
SIST ES 202 391-4 V1.3.1:2008 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.
---------------------- Page: 1 ----------------------
SIST ES 202 391-4 V1.3.1:2008
---------------------- Page: 2 ----------------------
SIST ES 202 391-4 V1.3.1:2008
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)
�
---------------------- Page: 3 ----------------------
SIST ES 202 391-4 V1.3.1:2008
2 ETSI ES 202 391-4 V1.3.1 (2008-05)
Reference
RES/TISPAN-01056-04-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 enregistrée à la
Sous-Préfecture 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 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 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.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 to reproduction in all media.
© European Telecommunications Standards Institute 2008.
© The Parlay Group 2008.
All rights reserved.
TM TM TM TM
DECT , PLUGTESTS , UMTS , TIPHON , the TIPHON logo and the ETSI logo are Trade Marks of ETSI registered
for the benefit of its Members.
TM
3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners.
ETSI
---------------------- Page: 4 ----------------------
SIST ES 202 391-4 V1.3.1:2008
3 ETSI ES 202 391-4 V1.3.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.6
2 References.6
2.1 Normative references.6
3 Definitions and abbreviations.7
3.1 Definitions.7
3.2 Abbreviations.7
4 Detailed service description .7
5 Namespaces.9
6 Sequence diagrams.9
6.1 Send SMS and report status.9
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 definition.11
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: sendSmsResponse.12
8.1.1.3 Referenced faults.12
8.1.2 Operation: sendSmsLogo.13
8.1.2.1 Input message: sendSmsLogoRequest .13
8.1.2.2 Output message: sendSmsLogoResponse .13
8.1.2.3 Referenced faults.13
8.1.3 Operation: sendSmsRingtone.14
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: getSmsDeliveryStatusRequest.15
8.1.4.2 Output message: getSmsDeliveryStatusResponse .15
8.1.4.3 Referenced faults.15
8.2 Interface: SmsNotification.15
8.2.1 Operation: notifySmsReception.16
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: notifySmsDeliveryReceipt.16
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: ReceiveSms.17
8.3.1 Operation: getReceivedSms.17
8.3.1.1 Input message: getReceivedSmsRequest .17
8.3.1.2 Output message: getReceivedSmsResponse.17
8.3.1.3 Referenced faults.17
8.4 Interface: SmsNotificationManager.18
8.4.1 Operation: startSmsNotification.18
ETSI
---------------------- Page: 5 ----------------------
SIST ES 202 391-4 V1.3.1:2008
4 ETSI ES 202 391-4 V1.3.1 (2008-05)
8.4.1.1 Input message: startSmsNotificationRequest.18
8.4.1.2 Output message: startSmsNotificationResponse.18
8.4.1.3 Referenced Faults.18
8.4.2 Operation: stopSmsNotification.19
8.4.2.1 Input message: stopSmsNotificationRequest .19
8.4.2.2 Output message: stopSmsNotificationResponse.19
8.4.2.3 Referenced Faults.19
9 Fault definitions.19
9.1 ServiceException.19
9.1.1 SVC0280: Message too long .19
9.1.2 SVC0281: Unrecognized 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 Messaging.21
Annex B (informative): Bibliography.22
History .23
ETSI
---------------------- Page: 6 ----------------------
SIST ES 202 391-4 V1.3.1:2008
5 ETSI ES 202 391-4 V1.3.1 (2008-05)
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 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/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 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 Telecommunications 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";
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: "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 specifications.
The present document is equivalent to 3GPP TS 29.199-04 V6.8.0 (Release 6).
ETSI
---------------------- Page: 7 ----------------------
SIST ES 202 391-4 V1.3.1:2008
6 ETSI ES 202 391-4 V1.3.1 (2008-05)
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. 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 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.
• 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 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 referenced 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 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.
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 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
---------------------- Page: 8 ----------------------
SIST ES 202 391-4 V1.3.1:2008
7 ETSI ES 202 391-4 V1.3.1 (2008-05)
[2] ETSI ES 202 391-1: "Open Service Access (OSA); Parlay X Web Services; Part 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.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 present 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 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 capabilities, 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 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 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 receive 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 SMS 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 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 with a direct
interaction between the SMS Web Service and the Mobile network.
ETSI
---------------------- Page: 9 ----------------------
SIST ES 202 391-4 V1.3.1:2008
8 ETSI ES 202 391-4 V1.3.1 (2008-05)
SMS Web
Weather Info
Info meteo SMS-X
Service
Web Service
Web Service component
Parlay X I/F
SCS-SMS
SCS-SMS
4
1 Parlay API
Parlay Gateway
5
3
…….
You have
getMeteoInfo()
a new SMS…
….
…Weather info
SMS-C
Retrieve
SMS-C
user Profile
….
2
Mobile network
SendSms (
“Weather inf.o.”,,,)
User
6
profile
Figure 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 (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).
4
Third Party Call
3PC-X
Web Service
component
Mobile network
Parlay X I/F
SMS Web 1
SMS-X
Service
3 component
Parlay X I/F
SOAP
2
SOAP
Call
mary@company.com
…….
2
notifySmsReception()
{….
Retrieve
user number
….
2
3
makeACall(“.”,,,)
User
profile }
Figure 2: Receive SMS Scenario
ETSI
---------------------- Page: 10 ----------------------
SIST ES 202 391-4 V1.3.1:2008
9 ETSI ES 202 391-4 V1.3.1 (2008-05)
5 Namespaces
The SendSms interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/sms/send/v2_3
The ReceiveSms interface 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
The 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 report 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
---------------------- Page: 11 ----------------------
SIST ES 202 391-4 V1.3.1:2008
10 ETSI ES 202 391-4 V1.3.1 (2008-05)
: End User : Self Serve : Send Sms
Portal Web Service
Enter message text and address
Send SMS message
Message identifier
Short delay
Get message status
Message status
Display result page
Figure 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 status 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.
DeliveredToTerminal Successful delivered to Terminal
DeliveryNotificationNotS Unable to provide delivery receipt notification. The notifySMSDeliveryReceipt
upported operation will return "DeliveryNotificationNotSupported" to indicate that delivery
receipt for the specified address in a sendSMS…Request message is not
supported.
ETSI
---------------------- Page: 12 ----------------------
SIST ES 202 391-4 V1.3.1:2008
11 ETSI ES 202 391-4 V1.3.1 (2008-05)
7.2 SmsFormat enumeration
List of SMS format values.
Enumeration value Description
Ems Enhanced Messaging Service, standardized in TS 123 040 [], which defines a
logo/ringtone format
TM
Defines a logo/ringtone format
SmartMessaging
7.3 DeliveryInformation structure
Delivery status information.
Element name Element type Optional Description
address xsd:anyURI No It indicates the destination address to which the notification is related
deliveryStatus DeliveryStatus No Indicates the delivery result for the destination address
7.4 SmsMessage structure
SMS message information. The senderAddress is the address from which the message was actually sent, which may or
may not match the senderName value provided in the sendSms operation.
Element name Element type Optional Description
message xsd:string No Text received in SMS
senderAddress xsd:anyURI No It indicates address sending the SMS
smsServiceActivation xsd:anyURI No Number associated with the invoked Message service, i.e. the
Number destination address used to send the message
dateTime xsd:dateTime Yes Time when message was received by operator
8 Web Service interface definition
8.1 Interface: SendSms
This interface defines operations to send various types of Short Messages and to subsequently poll for delivery status.
The Short Message types are:
• SMS message, as described in clause 8.1.1.
• SMS logo, as described in clause 8.1.2.
• SMS ringtone, as described in clause 8.1.3.
The send operations for the Short Message types are similar. A description of the common message parts follows:
• addresses specifies the destination address or address set for the Short Message. It may include group URIs as
defined in the Address List Management specification. If groups are not supported, a PolicyException
(POL0006) will be returned to the application.
• senderName is optional and specifies the sender's name: i.e. the string that is displayed on the user's terminal
as the originator of the message.
• charging specifies the charging information.
ETSI
---------------------- Page: 13 ----------------------
SIST ES 202 391-4 V1.3.1:2008
12 ETSI ES 202 391-4 V1.3.1 (2008-05)
• receiptRequest is optional and is specified when the application requires to receive notification of the status
of the SMS delivery. It is a SimpleReference structure that indicates the application endpoint, interface used
for notification of delivery receipt and a correlator that uniquely identifies the sending request:
- If the notification mechanism is not supported by a network, a ServiceException (SVC0283) will be
returned to the application and the message will not be sent to the addresses specified.
- The correlator provided in the receiptRequest must be unique for this Web Service and application at
the time the notification is initiated, otherwise a ServiceException (SVC0005) will be returned to the
application.
- Notification to the application is done by invoking the notifySmsDeliveryReceipt operation at the
endpoint specified in receiptRequest.
• requestIdentifier is specified in the response message associated with each send operation. The application
can use it to invoke the getSmsDeliveryStatus operation to poll for the delivery status.
8.1.1 Operation: sendSms
The application invokes the sendSms operation to send an SMS message, specified by the String message.
If message is longer than the maximum supported length, the message content will be sent as several concatenated short
messages.
8.1.1.1 Input message: sendSmsRequest
Part name Part type Optional Description
addresses xsd:anyURI [1.unbounded] No Addresses to which the SMS will be sent
senderName xsd:string Yes If present, it indicates the SMS sender name, i.e. the
string that is displayed on the user's terminal as the
originator of the message
charging common:ChargingInformation Yes Charge to apply to this message
message xsd:string No Text to be sent in SMS
receiptRequest common:SimpleReference Yes It defines the application endpoint, interfaceName and
correlator that will be used to notify the application when
the message has been delivered to the terminal or if
delivery is impossible
8.1.1.2 Output message: sendSmsResponse
Part name Part type Optional Description
result xsd:string No It identifies a specific SMS delivery request
8.1.1.3 Referenced faults
ServiceException from ES 202 391-1 [2]:
• SVC0001 - Service error.
• SVC0002 - Invalid input value.
• SVC0004 - No valid addresses.
• SVC0006 - Invalid group.
• SVC0280 - Message too long.
• SVC0283 - Delivery Receipt Notification not supported.
ETSI
---------------------- Page: 14 ----------------------
SIST ES 202 391-4 V1.3.1:2008
13 ETSI ES 202 391-4 V1.3.1 (2008-05)
PolicyException from ES 202 391-1 [2]:
• POL0001 - Policy error.
• POL0006 - Groups not allowed.
• POL0007 - Nested groups not allowed.
• POL0008 - Charging not allowed.
8.1.2 Operation: sendSmsLogo
The application invokes the sendSmsLogo operation to send an SMS logo, specified by the byte array image.
8.1.2.1 Input message: sendSmsLogoRequest
Part name Part type Optional Description
address
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.