SIST ES 202 504-5 V1.1.1:2008
Open Service Access (OSA) - Parlay X Web Services - Part 5: Multimedia Messaging (Parlay X 3)
Open Service Access (OSA) - Parlay X Web Services - Part 5: Multimedia Messaging (Parlay X 3)
New edition of ParlayX specification based on requirements in EG 201 988-4, corresponding to 3GPP TS 29.199 Rel-7. The present document is part 5 of the Stage 3 Parlay X 3 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 Multimedia 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.
Odprti dostop do storitve (OSA) - Spletne storitve Parlay X - 5. del: Večpredstavnostno sporočanje (Parlay X 3)
General Information
Buy Standard
Standards Content (Sample)
ETSI ES 202 504-5 V1.1.1 (2008-05)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 5: Multimedia Messaging
(Parlay X 3)
�
---------------------- Page: 1 ----------------------
2 ETSI ES 202 504-5 V1.1.1 (2008-05)
Reference
DES/TISPAN-01034-5-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 504-5 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.7
2 References.7
2.1 Normative references.7
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Detailed service description .8
5 Namespaces.10
6 Sequence diagrams.10
6.1 Send picture.10
6.2 Send WAP Push message.11
7 XML Schema data type definition .12
7.1 DeliveryStatus enumeration.12
7.2 MessagePriority enumeration.12
7.3 DeliveryInformation structure.13
7.4 MessageReference structure.13
7.5 MessageURI structure.13
7.5 ScheduledDeliveryStatus enumeration.13
7.6 ScheduledDeliveryInformation structure.14
8 Web Service interface definition.14
8.1 Interface: SendMessage.14
8.1.1 Operation: sendMessage.14
8.1.1.1 Input message: sendMessageRequest.15
8.1.1.2 Output message: sendMessageResponse.15
8.1.1.3 Referenced faults.15
8.1.2 Operation: getMessageDeliveryStatus.15
8.1.2.1 Input message: getMessageDeliveryStatusRequest .16
8.1.2.2 Output message: getMessageDeliveryStatusResponse .16
8.1.2.3 Referenced faults.16
8.1.3 Operation: scheduleMessage.16
8.1.3.1 Input message: scheduleMessageRequest.16
8.1.3.2 Output message: scheduleMessageResponse.17
8.1.3.3 Referenced faults.17
8.1.4 Operation: cancelScheduledMessage.17
8.1.4.1 Input message: cancelScheduledMessageRequest.17
8.1.4.2 Output message : cancelScheduledMessageResponse .17
8.1.4.3 Referenced faults.17
8.1.5 Operation: getScheduledMessageStatus.18
8.1.5.1 Input message: getScheduledMessageStatusRequest.18
8.1.5.2 Output message: getScheduledMessageStatusResponse.18
8.1.5.3 Referenced faults.18
8.2 Interface: ReceiveMessage.18
8.2.1 Operation: getReceivedMessages.18
8.2.1.1 Input message: getReceivedMessagesRequest.18
8.2.1.2 Output message: getReceivedMessagesResponse.19
8.2.1.3 Referenced faults.19
8.2.2 Operation: getMessageURIs.19
8.2.2.1 Input message: getMessageURIsRequest.19
8.2.2.2 Output message: getMessageURIsResponse.19
8.2.2.3 Referenced faults.19
8.2.3 Operation: getMessage.19
ETSI
---------------------- Page: 3 ----------------------
4 ETSI ES 202 504-5 V1.1.1 (2008-05)
8.2.3.1 Input message: getMessageRequest .20
8.2.3.2 Output message: getMessageResponse.20
8.2.3.3 Referenced faults.20
8.3 Interface: MessageNotification.20
8.3.1 Operation: notifyMessageReception.20
8.3.1.1 Input message: notifyMessageReceptionRequest .20
8.3.1.2 Output message: notifyMessageReceptionResponse.20
8.3.1.3 Referenced faults.20
8.3.2 Operation: notifyMessageDeliveryReceipt.21
8.3.2.1 Input message: notifyMessageDeliveryReceiptRequest .21
8.3.2.2 Output message: notifyMessageDeliveryReceiptResponse .21
8.3.2.3 Referenced faults.21
8.4 Interface: MessageNotificationManager .21
8.4.1 Operation: startMessageNotification.21
8.4.1.1 Input message: startMessageNotificationRequest.22
8.4.1.2 Output message: startMessageNotificationResponse.22
8.4.1.3 Referenced faults.22
8.4.2 Operation: stopMessageNotification.22
8.4.2.1 Input message: stopMessageNotificationRequest .22
8.4.2.2 Output message: stopMessageNotificationResponse.23
8.4.2.3 Referenced faults.23
8.4.3 Operation: startDeliveryReceiptNotification .23
8.4.3.1 Input message: startDeliveryReceiptNotificationRequest.23
8.4.3.2 Output message: startDeliveryReceiptNotificationResponse.23
8.4.3.3 Referenced faults.23
8.4.4 Operation: stopDeliveryReceiptNotification .24
8.4.4.1 Input message: stopDeliveryReceiptNotificationRequest .24
8.4.4.2 Output message: stopDeliveryReceiptNotificationResponse.24
8.4.4.3 Referenced faults.24
9 Fault definitions.24
9.1 ServiceException.24
9.1.1 Void.24
9.1.2 SVC0283: Delivery Receipt Notification not supported.24
10 Service policies .25
Annex A (normative): WSDL for Multimedia Messaging.26
Annex B (informative): Bibliography.27
History .28
ETSI
---------------------- Page: 4 ----------------------
5 ETSI ES 202 504-5 V1.1.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 5 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";
Part 15: "Message Broadcast";
Part 16: "Geocoding";
Part 17: "Application-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
ETSI
---------------------- Page: 5 ----------------------
6 ETSI ES 202 504-5 V1.1.1 (2008-05)
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 3.0 set of specifications.
The present document is equivalent to 3GPP TS 29.199-05 V7.2.0 (Release 7).
ETSI
---------------------- Page: 6 ----------------------
7 ETSI ES 202 504-5 V1.1.1 (2008-05)
1 Scope
The present document is part 5 of the Stage 3 Parlay X 3 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 Multimedia 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: 7 ----------------------
8 ETSI ES 202 504-5 V1.1.1 (2008-05)
[2] ETSI ES 202 504-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 3)".
[3] W3C Note (11 December 2000): "SOAP Messages with Attachments".
NOTE: Available at: http://www.w3.org/TR/SOAP-attachments.
[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 504-1 [2] and the following apply:
Whitespace: See definition for CFWS as defined in RFC 2822 [4].
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-1 [2] and the following apply:
EMS Enhanced Messaging Service
IM Instant Messaging
MMS Multimedia Messaging Service
MMS-C Multimedia Messaging Service-Centre
OMA Open Mobile Alliance
SMS Short Message Service
WAP Wireless Application Protocol
4 Detailed service description
Currently, in order to programmatically receive and send Multimedia Messages, it is necessary to write applications
using specific protocols to access MMS functions provided by network elements (e.g. MMS-C). This approach requires
application developers to have a high degree of network expertise.
This contribution defines a Multimedia Messaging Web Service that can map to SMS, EMS, MMS, IM, E-mail, etc.
The choice is between defining one set of interfaces per messaging network or a single set common to all networks;
e.g. we could define sendMMS, sendEMS, sendSMS, etc., or just use sendMessage. Although the more specific the API
the easier it is to use, there are advantages to a single set of network-neutral APIs. These advantages include:
• improved service portability;
• lower complexity, by providing support for generic user terminal capabilities only.
For this version of the Parlay X 3 specification, we provide sets of interfaces for two messaging Web Services:
Short Messaging (part 4) and Multimedia Messaging (the present document), which provides generic messaging
features (including SMS).
Multimedia Messaging provides operations (see clause 8.1, SendMessage API) for sending a Multimedia message to
the network and a polling mechanism for monitoring the delivery status of a sent Multimedia message. It also provides
an asynchronous notification mechanism for delivery status (see clause 8.3, MessageNotification API). In addition, a
mechanism is provided to start and stop the notification of delivery receipts (see clause 8.4,
MessageNotificationManager API).
ETSI
---------------------- Page: 8 ----------------------
9 ETSI ES 202 504-5 V1.1.1 (2008-05)
Multimedia Messaging also allows an application to receive Multimedia messages. Both a polling (see clause 8.2,
ReceiveMessage API) and an asynchronous notification mechanism (see clause 8.3, MessageNotification API and
clause 8.4, MessageNotificationManager API) are available.
Figure 1 shows an example scenario using sendMessage and getMessageDeliveryStatus to send data to subscribers
and to determine if the data has been received by the subscriber. The application invokes a Web Service to retrieve a
stock quote (1) and (2) and sends the current quote - sendMessage - using the Parlay X Interface (3) of the Multimedia
Messaging Web Service. After invocation, the Multimedia Message Web Service sends the message to an MMS-C
using the MM7 interface (4) for onward transmission (5) to the subscriber over the Mobile network.
Later, when the next quote is ready, the application checks to see - getMessageDeliveryStatus - if the previous quote
has been successfully delivered to the subscriber. If not, it may for instance perform an action (not shown) to provide a
credit for the previous message transmission. This way, the subscriber is only charged for a stock quote if it is delivered
on time.
Multimedia
Stock Quote
Message Web
Stock Quote MMSC -X
Web Service
Service 4
Web Service component
Parlay X I/F
MMS-C
MMSC
MM7 VASP
Interface
1
3
5
…… .
content1 =getStockQuote ()
….
Retrieve
user Profile
Mobile network
….
messageId= sendMessage( content )
1
….
2
6
status= getMessageDeliveryStatus (messageId)
if status=Message_Waiting
….
fi
User
…
profile
content2 =getStockQuote ()
messageId= sendMessage ( content2 )
Figure 1: Multimedia Messaging Scenario
Alternatively this service could have been built using WAP Push features in the network.
Figure 2 shows an example scenario using sendMessage and getMessageDeliveryStatus to send a link to subscribers
and to determine if the data has been received by the subscriber. The application invokes a Web Service to generate a
stock quote graph (1) and (2) and sends the current quote as a WAP Push link - sendMessage - using the Parlay X
Interface (3) of the Multimedia Messaging Web Service. After invocation, the Multimedia Message Web Service sends
the message to an SMS-C (4) for onward transmission (5) to the subscriber over the Mobile network. The subscriber
can then open the link and access his content.
ETSI
---------------------- Page: 9 ----------------------
10 ETSI ES 202 504-5 V1.1.1 (2008-05)
Figure 2: WAP Push scenario
5 Namespaces
The SendMessage interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/multimedia_messaging/send/v3_1
The ReceiveMessage interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/multimedia_messaging/receive/v3_1
The MessageNotification interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/multimedia_messaging/notification/v3_1
The MessageNotificationManager interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/multimedia_messaging/notification_manager/v3_2
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/multimedia_messaging/v3_0
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 picture
With the advent of picture capable phones, the exchange of photos to mobile phones is becoming more common place.
This sequence diagram shows an application where a person can send a picture from an online photo album to a mobile
phone.
ETSI
---------------------- Page: 10 ----------------------
11 ETSI ES 202 504-5 V1.1.1 (2008-05)
: End User : Online Photo : Send MMS
Album Web Service
User logs on
User selects photo to send
User fills in send information
Send multimedia message
Message identifier
Short wait
Get message status
Status
Acknowledgement page
Figure 3
6.2 Send WAP Push message
For phones capable of receiving WAP Push messages, link to content can be sent using this example. The suggested
MIME type for the attachment, as defined by the OMA, is text/vnd.wap.sl for sending HTTP links or WAP links to a
mobile phone. This sequence diagram shows an application sending a link to a mobile phone, and the mobile phone
using the link to retrieve the content.
ETSI
---------------------- Page: 11 ----------------------
12 ETSI ES 202 504-5 V1.1.1 (2008-05)
Service Content
Send MMS
Mobile
provider
Web Service
Phone
Add
attachments
Send multimedia message
Message identifier
Link sent to phone
Short wait Phone
processes
Get message status
message
Status
Access
link
User enjoys
content
Figure 4
7 XML Schema data type definition
7.1 DeliveryStatus enumeration
List of delivery status values.
Enumeration value Description
DeliveredToNetwork Successful delivery to the network enabler responsible for distributing the multimedia
message further in the 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 delivery to Terminal.
DeliveryNotificationNot Unable to provide delivery receipt notification. The notifyMessageDeliveryReceipt
Supported operation will provide "DeliveryNotificationNotSupported" to indicate that delivery
receipt for the specified address in a sendMessageRequest message is not
supported.
7.2 MessagePriority enumeration
List of delivery priority values.
Enumeration value Description
Default Default message priority
Low Low message priority
Normal Normal message priority
High High message priority
ETSI
---------------------- Page: 12 ----------------------
13 ETSI ES 202 504-5 V1.1.1 (2008-05)
7.3 DeliveryInformation structure
Delivery status information.
Element name Element type Optional Description
address xsd:anyURI No Address associated with the delivery status. The address field
is coded as a URI.
deliveryStatus DeliveryStatus No Indicates delivery status for the destination address.
7.4 MessageReference structure
Message information.
Element name Element type Optional Description
messageIdentifier xsd:string If present, contains a reference to a message stored in the Parlay
Yes
X gateway. If the message is pure text, this parameter is not
present.
messageService xsd:string No Number associated with the invoked Message service, i.e. the
ActivationNumber destination address used by the
...
Final draft ETSI ES 202 504-5 V1.1.1 (2008-02)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 5: Multimedia Messaging
(Parlay X 3)
�
---------------------- Page: 1 ----------------------
2 Final draft ETSI ES 202 504-5 V1.1.1 (2008-02)
Reference
DES/TISPAN-01034-5-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 504-5 V1.1.1 (2008-02)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.7
2 References.7
2.1 Normative references.7
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Detailed service description .8
5 Namespaces.10
6 Sequence diagrams.10
6.1 Send picture.10
6.2 Send WAP Push message.11
7 XML Schema data type definition .12
7.1 DeliveryStatus enumeration.12
7.2 MessagePriority enumeration.12
7.3 DeliveryInformation structure.13
7.4 MessageReference structure.13
7.5 MessageURI structure.13
7.5 ScheduledDeliveryStatus enumeration.13
7.6 ScheduledDeliveryInformation structure.13
8 Web Service interface definition.14
8.1 Interface: SendMessage.14
8.1.1 Operation: sendMessage.14
8.1.1.1 Input message: sendMessageRequest.15
8.1.1.2 Output message: sendMessageResponse.15
8.1.1.3 Referenced faults.15
8.1.2 Operation: getMessageDeliveryStatus.15
8.1.2.1 Input message: getMessageDeliveryStatusRequest .16
8.1.2.2 Output message: getMessageDeliveryStatusResponse .16
8.1.2.3 Referenced faults.16
8.1.3 Operation: scheduleMessage.16
8.1.3.1 Input message: scheduleMessageRequest.16
8.1.3.2 Output message: scheduleMessageResponse.17
8.1.3.3 Referenced faults.17
8.1.4 Operation: cancelScheduledMessage.17
8.1.4.1 Input message: cancelScheduledMessageRequest.17
8.1.4.2 Output message : cancelScheduledMessageResponse .17
8.1.4.3 Referenced faults.17
8.1.5 Operation: getScheduledMessageStatus.18
8.1.5.1 Input message: getScheduledMessageStatusRequest.18
8.1.5.2 Output message: getScheduledMessageStatusResponse.18
8.1.5.3 Referenced faults.18
8.2 Interface: ReceiveMessage.18
8.2.1 Operation: getReceivedMessages.18
8.2.1.1 Input message: getReceivedMessagesRequest.18
8.2.1.2 Output message: getReceivedMessagesResponse.19
8.2.1.3 Referenced faults.19
8.2.2 Operation: getMessageURIs.19
8.2.2.1 Input message: getMessageURIsRequest.19
8.2.2.2 Output message: getMessageURIsResponse.19
8.2.2.3 Referenced faults.19
8.2.3 Operation: getMessage.19
ETSI
---------------------- Page: 3 ----------------------
4 Final draft ETSI ES 202 504-5 V1.1.1 (2008-02)
8.2.3.1 Input message: getMessageRequest .20
8.2.3.2 Output message: getMessageResponse.20
8.2.3.3 Referenced faults.20
8.3 Interface: MessageNotification.20
8.3.1 Operation: notifyMessageReception.20
8.3.1.1 Input message: notifyMessageReceptionRequest .20
8.3.1.2 Output message: notifyMessageReceptionResponse.20
8.3.1.3 Referenced faults.20
8.3.2 Operation: notifyMessageDeliveryReceipt.21
8.3.2.1 Input message: notifyMessageDeliveryReceiptRequest .21
8.3.2.2 Output message: notifyMessageDeliveryReceiptResponse .21
8.3.2.3 Referenced faults.21
8.4 Interface: MessageNotificationManager .21
8.4.1 Operation: startMessageNotification.21
8.4.1.1 Input message: startMessageNotificationRequest.22
8.4.1.2 Output message: startMessageNotificationResponse.22
8.4.1.3 Referenced faults.22
8.4.2 Operation: stopMessageNotification.22
8.4.2.1 Input message: stopMessageNotificationRequest .22
8.4.2.2 Output message: stopMessageNotificationResponse.23
8.4.2.3 Referenced faults.23
8.4.3 Operation: startDeliveryReceiptNotification .23
8.4.3.1 Input message: startDeliveryReceiptNotificationRequest.23
8.4.3.2 Output message: startDeliveryReceiptNotificationResponse.23
8.4.3.3 Referenced faults.23
8.4.4 Operation: stopDeliveryReceiptNotification .24
8.4.4.1 Input message: stopDeliveryReceiptNotificationRequest .24
8.4.4.2 Output message: stopDeliveryReceiptNotificationResponse.24
8.4.4.3 Referenced faults.24
9 Fault definitions.24
9.1 ServiceException.24
9.1.1 Void.24
9.1.2 SVC0283: Delivery Receipt Notification not supported.24
10 Service policies .25
Annex A (normative): WSDL for Multimedia Messaging.26
Annex B (informative): Bibliography.27
History .28
ETSI
---------------------- Page: 4 ----------------------
5 Final draft ETSI ES 202 504-5 V1.1.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 5 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";
Part 15: "Message Broadcast";
Part 16: "Geocoding";
Part 17: "Application-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
ETSI
---------------------- Page: 5 ----------------------
6 Final draft ETSI ES 202 504-5 V1.1.1 (2008-02)
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 3.0 set of specifications.
The present document is equivalent to 3GPP TS 29.199-05 V7.2.0 (Release 7).
ETSI
---------------------- Page: 6 ----------------------
7 Final draft ETSI ES 202 504-5 V1.1.1 (2008-02)
1 Scope
The present document is part 5 of the Stage 3 Parlay X 3 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 Multimedia 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: 7 ----------------------
8 Final draft ETSI ES 202 504-5 V1.1.1 (2008-02)
[2] ETSI ES 202 504-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 3)".
[3] W3C Note (11 December 2000): "SOAP Messages with Attachments".
NOTE: Available at: http://www.w3.org/TR/SOAP-attachments.
[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 504-1 [2] and the following apply:
Whitespace: See definition for CFWS as defined in RFC 2822 [4].
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-1 [2] and the following apply:
EMS Enhanced Messaging Service
IM Instant Messaging
MMS Multimedia Messaging Service
MMS-C Multimedia Messaging Service-Centre
OMA Open Mobile Alliance
SMS Short Message Service
WAP Wireless Application Protocol
4 Detailed service description
Currently, in order to programmatically receive and send Multimedia Messages, it is necessary to write applications
using specific protocols to access MMS functions provided by network elements (e.g. MMS-C). This approach requires
application developers to have a high degree of network expertise.
This contribution defines a Multimedia Messaging Web Service that can map to SMS, EMS, MMS, IM, E-mail, etc.
The choice is between defining one set of interfaces per messaging network or a single set common to all networks;
e.g. we could define sendMMS, sendEMS, sendSMS, etc., or just use sendMessage. Although the more specific the API
the easier it is to use, there are advantages to a single set of network-neutral APIs. These advantages include:
• improved service portability;
• lower complexity, by providing support for generic user terminal capabilities only.
For this version of the Parlay X 3 specification, we provide sets of interfaces for two messaging Web Services:
Short Messaging (part 4) and Multimedia Messaging (the present document), which provides generic messaging
features (including SMS).
Multimedia Messaging provides operations (see clause 8.1, SendMessage API) for sending a Multimedia message to
the network and a polling mechanism for monitoring the delivery status of a sent Multimedia message. It also provides
an asynchronous notification mechanism for delivery status (see clause 8.3, MessageNotification API). In addition, a
mechanism is provided to start and stop the notification of delivery receipts (see clause 8.4,
MessageNotificationManager API).
ETSI
---------------------- Page: 8 ----------------------
9 Final draft ETSI ES 202 504-5 V1.1.1 (2008-02)
Multimedia Messaging also allows an application to receive Multimedia messages. Both a polling (see clause 8.2,
ReceiveMessage API) and an asynchronous notification mechanism (see clause 8.3, MessageNotification API and
clause 8.4, MessageNotificationManager API) are available.
Figure 1 shows an example scenario using sendMessage and getMessageDeliveryStatus to send data to subscribers
and to determine if the data has been received by the subscriber. The application invokes a Web Service to retrieve a
stock quote (1) and (2) and sends the current quote - sendMessage - using the Parlay X Interface (3) of the Multimedia
Messaging Web Service. After invocation, the Multimedia Message Web Service sends the message to an MMS-C
using the MM7 interface (4) for onward transmission (5) to the subscriber over the Mobile network.
Later, when the next quote is ready, the application checks to see - getMessageDeliveryStatus - if the previous quote
has been successfully delivered to the subscriber. If not, it may for instance perform an action (not shown) to provide a
credit for the previous message transmission. This way, the subscriber is only charged for a stock quote if it is delivered
on time.
Multimedia
Stock Quote
Message Web
Stock Quote MMSC -X
Web Service
Service 4
Web Service component
Parlay X I/F
MMS-C
MMSC
MM7 VASP
Interface
1
3
5
…… .
content1 =getStockQuote ()
….
Retrieve
user Profile
Mobile network
….
messageId= sendMessage( content )
1
….
2
6
status= getMessageDeliveryStatus (messageId)
if status=Message_Waiting
….
fi
User
…
profile
content2 =getStockQuote ()
messageId= sendMessage ( content2 )
Figure 1: Multimedia Messaging Scenario
Alternatively this service could have been built using WAP Push features in the network.
Figure 2 shows an example scenario using sendMessage and getMessageDeliveryStatus to send a link to subscribers
and to determine if the data has been received by the subscriber. The application invokes a Web Service to generate a
stock quote graph (1) and (2) and sends the current quote as a WAP Push link - sendMessage - using the Parlay X
Interface (3) of the Multimedia Messaging Web Service. After invocation, the Multimedia Message Web Service sends
the message to an SMS-C (4) for onward transmission (5) to the subscriber over the Mobile network. The subscriber
can then open the link and access his content.
ETSI
---------------------- Page: 9 ----------------------
10 Final draft ETSI ES 202 504-5 V1.1.1 (2008-02)
Figure 2: WAP Push scenario
5 Namespaces
The SendMessage interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/multimedia_messaging/send/v3_1
The ReceiveMessage interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/multimedia_messaging/receive/v3_1
The MessageNotification interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/multimedia_messaging/notification/v3_1
The MessageNotificationManager interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/multimedia_messaging/notification_manager/v3_2
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/multimedia_messaging/v3_0
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 picture
With the advent of picture capable phones, the exchange of photos to mobile phones is becoming more common place.
This sequence diagram shows an application where a person can send a picture from an online photo album to a mobile
phone.
ETSI
---------------------- Page: 10 ----------------------
11 Final draft ETSI ES 202 504-5 V1.1.1 (2008-02)
: End User : Online Photo : Send MMS
Album Web Service
User logs on
User selects photo to send
User fills in send information
Send multimedia message
Message identifier
Short wait
Get message status
Status
Acknowledgement page
Figure 3
6.2 Send WAP Push message
For phones capable of receiving WAP Push messages, link to content can be sent using this example. The suggested
MIME type for the attachment, as defined by the OMA, is text/vnd.wap.sl for sending HTTP links or WAP links to a
mobile phone. This sequence diagram shows an application sending a link to a mobile phone, and the mobile phone
using the link to retrieve the content.
ETSI
---------------------- Page: 11 ----------------------
12 Final draft ETSI ES 202 504-5 V1.1.1 (2008-02)
Service Content
Send MMS
Mobile
provider
Web Service
Phone
Add
attachments
Send multimedia message
Message identifier
Link sent to phone
Short wait Phone
processes
Get message status
message
Status
Access
link
User enjoys
content
Figure 4
7 XML Schema data type definition
7.1 DeliveryStatus enumeration
List of delivery status values.
Enumeration value Description
DeliveredToNetwork Successful delivery to the network enabler responsible for distributing the multimedia
message further in the 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 delivery to Terminal.
DeliveryNotificationNot Unable to provide delivery receipt notification. The notifyMessageDeliveryReceipt
Supported operation will provide "DeliveryNotificationNotSupported" to indicate that delivery
receipt for the specified address in a sendMessageRequest message is not
supported.
7.2 MessagePriority enumeration
List of delivery priority values.
Enumeration value Description
Default Default message priority
Low Low message priority
Normal Normal message priority
High High message priority
ETSI
---------------------- Page: 12 ----------------------
13 Final draft ETSI ES 202 504-5 V1.1.1 (2008-02)
7.3 DeliveryInformation structure
Delivery status information.
Element name Element type Optional Description
address xsd:anyURI No Address associated with the delivery status. The address field
is coded as a URI.
deliveryStatus DeliveryStatus No Indicates delivery status for the destination address.
7.4 MessageReference structure
Message information.
Element name Element type Optional Description
messageIdentifier xsd:string If present, contains a reference to a message stored
...
SLOVENSKI STANDARD
SIST ES 202 504-5 V1.1.1:2008
01-september-2008
2GSUWLGRVWRSGRVWRULWYH 26$ 6SOHWQHVWRULWYH3DUOD\;GHO
9HþSUHGVWDYQRVWQRVSRURþDQMH 3DUOD\;
Open Service Access (OSA) - Parlay X Web Services - Part 5: Multimedia Messaging
(Parlay X 3)
Ta slovenski standard je istoveten z: ES 202 504-5 Version 1.1.1
ICS:
35.100.01 Medsebojno povezovanje Open systems
odprtih sistemov na splošno interconnection in general
SIST ES 202 504-5 V1.1.1:2008 en
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.
---------------------- Page: 1 ----------------------
SIST ES 202 504-5 V1.1.1:2008
---------------------- Page: 2 ----------------------
SIST ES 202 504-5 V1.1.1:2008
ETSI ES 202 504-5 V1.1.1 (2008-05)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 5: Multimedia Messaging
(Parlay X 3)
�
---------------------- Page: 3 ----------------------
SIST ES 202 504-5 V1.1.1:2008
2 ETSI ES 202 504-5 V1.1.1 (2008-05)
Reference
DES/TISPAN-01034-5-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 504-5 V1.1.1:2008
3 ETSI ES 202 504-5 V1.1.1 (2008-05)
Contents
Intellectual Property Rights.5
Foreword.5
1 Scope.7
2 References.7
2.1 Normative references.7
3 Definitions and abbreviations.8
3.1 Definitions.8
3.2 Abbreviations.8
4 Detailed service description .8
5 Namespaces.10
6 Sequence diagrams.10
6.1 Send picture.10
6.2 Send WAP Push message.11
7 XML Schema data type definition .12
7.1 DeliveryStatus enumeration.12
7.2 MessagePriority enumeration.12
7.3 DeliveryInformation structure.13
7.4 MessageReference structure.13
7.5 MessageURI structure.13
7.5 ScheduledDeliveryStatus enumeration.13
7.6 ScheduledDeliveryInformation structure.14
8 Web Service interface definition.14
8.1 Interface: SendMessage.14
8.1.1 Operation: sendMessage.14
8.1.1.1 Input message: sendMessageRequest.15
8.1.1.2 Output message: sendMessageResponse.15
8.1.1.3 Referenced faults.15
8.1.2 Operation: getMessageDeliveryStatus.15
8.1.2.1 Input message: getMessageDeliveryStatusRequest .16
8.1.2.2 Output message: getMessageDeliveryStatusResponse .16
8.1.2.3 Referenced faults.16
8.1.3 Operation: scheduleMessage.16
8.1.3.1 Input message: scheduleMessageRequest.16
8.1.3.2 Output message: scheduleMessageResponse.17
8.1.3.3 Referenced faults.17
8.1.4 Operation: cancelScheduledMessage.17
8.1.4.1 Input message: cancelScheduledMessageRequest.17
8.1.4.2 Output message : cancelScheduledMessageResponse .17
8.1.4.3 Referenced faults.17
8.1.5 Operation: getScheduledMessageStatus.18
8.1.5.1 Input message: getScheduledMessageStatusRequest.18
8.1.5.2 Output message: getScheduledMessageStatusResponse.18
8.1.5.3 Referenced faults.18
8.2 Interface: ReceiveMessage.18
8.2.1 Operation: getReceivedMessages.18
8.2.1.1 Input message: getReceivedMessagesRequest.18
8.2.1.2 Output message: getReceivedMessagesResponse.19
8.2.1.3 Referenced faults.19
8.2.2 Operation: getMessageURIs.19
8.2.2.1 Input message: getMessageURIsRequest.19
8.2.2.2 Output message: getMessageURIsResponse.19
8.2.2.3 Referenced faults.19
8.2.3 Operation: getMessage.19
ETSI
---------------------- Page: 5 ----------------------
SIST ES 202 504-5 V1.1.1:2008
4 ETSI ES 202 504-5 V1.1.1 (2008-05)
8.2.3.1 Input message: getMessageRequest .20
8.2.3.2 Output message: getMessageResponse.20
8.2.3.3 Referenced faults.20
8.3 Interface: MessageNotification.20
8.3.1 Operation: notifyMessageReception.20
8.3.1.1 Input message: notifyMessageReceptionRequest .20
8.3.1.2 Output message: notifyMessageReceptionResponse.20
8.3.1.3 Referenced faults.20
8.3.2 Operation: notifyMessageDeliveryReceipt.21
8.3.2.1 Input message: notifyMessageDeliveryReceiptRequest .21
8.3.2.2 Output message: notifyMessageDeliveryReceiptResponse .21
8.3.2.3 Referenced faults.21
8.4 Interface: MessageNotificationManager .21
8.4.1 Operation: startMessageNotification.21
8.4.1.1 Input message: startMessageNotificationRequest.22
8.4.1.2 Output message: startMessageNotificationResponse.22
8.4.1.3 Referenced faults.22
8.4.2 Operation: stopMessageNotification.22
8.4.2.1 Input message: stopMessageNotificationRequest .22
8.4.2.2 Output message: stopMessageNotificationResponse.23
8.4.2.3 Referenced faults.23
8.4.3 Operation: startDeliveryReceiptNotification .23
8.4.3.1 Input message: startDeliveryReceiptNotificationRequest.23
8.4.3.2 Output message: startDeliveryReceiptNotificationResponse.23
8.4.3.3 Referenced faults.23
8.4.4 Operation: stopDeliveryReceiptNotification .24
8.4.4.1 Input message: stopDeliveryReceiptNotificationRequest .24
8.4.4.2 Output message: stopDeliveryReceiptNotificationResponse.24
8.4.4.3 Referenced faults.24
9 Fault definitions.24
9.1 ServiceException.24
9.1.1 Void.24
9.1.2 SVC0283: Delivery Receipt Notification not supported.24
10 Service policies .25
Annex A (normative): WSDL for Multimedia Messaging.26
Annex B (informative): Bibliography.27
History .28
ETSI
---------------------- Page: 6 ----------------------
SIST ES 202 504-5 V1.1.1:2008
5 ETSI ES 202 504-5 V1.1.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 5 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";
Part 15: "Message Broadcast";
Part 16: "Geocoding";
Part 17: "Application-driven Quality of Service (QoS)";
Part 18: "Device Capabilities and Configuration";
Part 19: "Multimedia Streaming Control";
Part 20: "Multimedia Multicast Session Management".
ETSI
---------------------- Page: 7 ----------------------
SIST ES 202 504-5 V1.1.1:2008
6 ETSI ES 202 504-5 V1.1.1 (2008-05)
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 3.0 set of specifications.
The present document is equivalent to 3GPP TS 29.199-05 V7.2.0 (Release 7).
ETSI
---------------------- Page: 8 ----------------------
SIST ES 202 504-5 V1.1.1:2008
7 ETSI ES 202 504-5 V1.1.1 (2008-05)
1 Scope
The present document is part 5 of the Stage 3 Parlay X 3 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 Multimedia 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: 9 ----------------------
SIST ES 202 504-5 V1.1.1:2008
8 ETSI ES 202 504-5 V1.1.1 (2008-05)
[2] ETSI ES 202 504-1: "Open Service Access (OSA); Parlay X Web Services; Part 1: Common
(Parlay X 3)".
[3] W3C Note (11 December 2000): "SOAP Messages with Attachments".
NOTE: Available at: http://www.w3.org/TR/SOAP-attachments.
[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 504-1 [2] and the following apply:
Whitespace: See definition for CFWS as defined in RFC 2822 [4].
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-1 [2] and the following apply:
EMS Enhanced Messaging Service
IM Instant Messaging
MMS Multimedia Messaging Service
MMS-C Multimedia Messaging Service-Centre
OMA Open Mobile Alliance
SMS Short Message Service
WAP Wireless Application Protocol
4 Detailed service description
Currently, in order to programmatically receive and send Multimedia Messages, it is necessary to write applications
using specific protocols to access MMS functions provided by network elements (e.g. MMS-C). This approach requires
application developers to have a high degree of network expertise.
This contribution defines a Multimedia Messaging Web Service that can map to SMS, EMS, MMS, IM, E-mail, etc.
The choice is between defining one set of interfaces per messaging network or a single set common to all networks;
e.g. we could define sendMMS, sendEMS, sendSMS, etc., or just use sendMessage. Although the more specific the API
the easier it is to use, there are advantages to a single set of network-neutral APIs. These advantages include:
• improved service portability;
• lower complexity, by providing support for generic user terminal capabilities only.
For this version of the Parlay X 3 specification, we provide sets of interfaces for two messaging Web Services:
Short Messaging (part 4) and Multimedia Messaging (the present document), which provides generic messaging
features (including SMS).
Multimedia Messaging provides operations (see clause 8.1, SendMessage API) for sending a Multimedia message to
the network and a polling mechanism for monitoring the delivery status of a sent Multimedia message. It also provides
an asynchronous notification mechanism for delivery status (see clause 8.3, MessageNotification API). In addition, a
mechanism is provided to start and stop the notification of delivery receipts (see clause 8.4,
MessageNotificationManager API).
ETSI
---------------------- Page: 10 ----------------------
SIST ES 202 504-5 V1.1.1:2008
9 ETSI ES 202 504-5 V1.1.1 (2008-05)
Multimedia Messaging also allows an application to receive Multimedia messages. Both a polling (see clause 8.2,
ReceiveMessage API) and an asynchronous notification mechanism (see clause 8.3, MessageNotification API and
clause 8.4, MessageNotificationManager API) are available.
Figure 1 shows an example scenario using sendMessage and getMessageDeliveryStatus to send data to subscribers
and to determine if the data has been received by the subscriber. The application invokes a Web Service to retrieve a
stock quote (1) and (2) and sends the current quote - sendMessage - using the Parlay X Interface (3) of the Multimedia
Messaging Web Service. After invocation, the Multimedia Message Web Service sends the message to an MMS-C
using the MM7 interface (4) for onward transmission (5) to the subscriber over the Mobile network.
Later, when the next quote is ready, the application checks to see - getMessageDeliveryStatus - if the previous quote
has been successfully delivered to the subscriber. If not, it may for instance perform an action (not shown) to provide a
credit for the previous message transmission. This way, the subscriber is only charged for a stock quote if it is delivered
on time.
Multimedia
Stock Quote
Message Web
Stock Quote MMSC -X
Web Service
Service 4
Web Service component
Parlay X I/F
MMS-C
MMSC
MM7 VASP
Interface
1
3
5
…… .
content1 =getStockQuote ()
….
Retrieve
user Profile
Mobile network
….
messageId= sendMessage( content )
1
….
2
6
status= getMessageDeliveryStatus (messageId)
if status=Message_Waiting
….
fi
User
…
profile
content2 =getStockQuote ()
messageId= sendMessage ( content2 )
Figure 1: Multimedia Messaging Scenario
Alternatively this service could have been built using WAP Push features in the network.
Figure 2 shows an example scenario using sendMessage and getMessageDeliveryStatus to send a link to subscribers
and to determine if the data has been received by the subscriber. The application invokes a Web Service to generate a
stock quote graph (1) and (2) and sends the current quote as a WAP Push link - sendMessage - using the Parlay X
Interface (3) of the Multimedia Messaging Web Service. After invocation, the Multimedia Message Web Service sends
the message to an SMS-C (4) for onward transmission (5) to the subscriber over the Mobile network. The subscriber
can then open the link and access his content.
ETSI
---------------------- Page: 11 ----------------------
SIST ES 202 504-5 V1.1.1:2008
10 ETSI ES 202 504-5 V1.1.1 (2008-05)
Figure 2: WAP Push scenario
5 Namespaces
The SendMessage interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/multimedia_messaging/send/v3_1
The ReceiveMessage interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/multimedia_messaging/receive/v3_1
The MessageNotification interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/multimedia_messaging/notification/v3_1
The MessageNotificationManager interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/multimedia_messaging/notification_manager/v3_2
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/multimedia_messaging/v3_0
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 picture
With the advent of picture capable phones, the exchange of photos to mobile phones is becoming more common place.
This sequence diagram shows an application where a person can send a picture from an online photo album to a mobile
phone.
ETSI
---------------------- Page: 12 ----------------------
SIST ES 202 504-5 V1.1.1:2008
11 ETSI ES 202 504-5 V1.1.1 (2008-05)
: End User : Online Photo : Send MMS
Album Web Service
User logs on
User selects photo to send
User fills in send information
Send multimedia message
Message identifier
Short wait
Get message status
Status
Acknowledgement page
Figure 3
6.2 Send WAP Push message
For phones capable of receiving WAP Push messages, link to content can be sent using this example. The suggested
MIME type for the attachment, as defined by the OMA, is text/vnd.wap.sl for sending HTTP links or WAP links to a
mobile phone. This sequence diagram shows an application sending a link to a mobile phone, and the mobile phone
using the link to retrieve the content.
ETSI
---------------------- Page: 13 ----------------------
SIST ES 202 504-5 V1.1.1:2008
12 ETSI ES 202 504-5 V1.1.1 (2008-05)
Service Content
Send MMS
Mobile
provider
Web Service
Phone
Add
attachments
Send multimedia message
Message identifier
Link sent to phone
Short wait Phone
processes
Get message status
message
Status
Access
link
User enjoys
content
Figure 4
7 XML Schema data type definition
7.1 DeliveryStatus enumeration
List of delivery status values.
Enumeration value Description
DeliveredToNetwork Successful delivery to the network enabler responsible for distributing the multimedia
message further in the 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 delivery to Terminal.
DeliveryNotificationNot Unable to provide delivery receipt notification. The notifyMessageDeliveryReceipt
Supported operation will provide "DeliveryNotificationNotSupported" to indicate that deliv
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.