SIST ES 203 915-15 V1.3.1:2008
Open Service Access (OSA) - Application Programming Interface (API) - Part 15: Multi-Media Messaging SCF (Parlay 5)
- Abstract
Update of ES 203 915 to become Parlay 5.2. Only those parts requiring modification will be updated (most parts require maintenance fixes).The present document is part 15 of the Stage 3 specification for an Application Programming Interface (API) for Open Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality through an open standardised interface, i.e. the OSA APIs.
The present document specifies the Multi Media Messaging Service Capability Feature (SCF) aspects of the interface.
All aspects of the Multi Media Messaging SCF are defined here, these being:
• Sequence Diagrams.
• Class Diagrams.
• Interface specification plus detailed method descriptions.
• State Transition diagrams.
• Data Definitions.
• IDL Description of the interfaces.
The process by which this task is accomplished is through the use of object modelling techniques described by the Unified Modelling Language (UML).
- Status
- Published
- Publication Date
- 15-Jul-2008
- Technical Committee
- SPN - Services and Protocols for Networks
- Current Stage
- 6060 - National Implementation/Publication (Adopted Project)
- Start Date
- 11-Jun-2008
- Due Date
- 16-Aug-2008
- Completion Date
- 16-Jul-2008
Buy Documents
ETSI ES 203 915-15 V1.3.1 (2008-02) - Open Service Access (OSA); Application Programming Interface (API); Part 15: Multi-Media Messaging SCF (Parlay 5)
ETSI ES 203 915-15 V1.3.1 (2008-04) - Open Service Access (OSA); Application Programming Interface (API); Part 15: Multi-Media Messaging SCF (Parlay 5)
SIST ES 203 915-15 V1.3.1:2008 is an ETSI standard for Open Service Access (OSA) Application Programming Interface (API), Part 15: Multi-Media Messaging SCF (Parlay 5). It specifies the stage 3 interface for sending, storing, receiving, and reporting multi-media messages through the OSA APIs, for application developers and network-side service implementations. The document defines the service manager, mailbox, and messaging interfaces, together with their callbacks, data types, service properties, exceptions, and UML-based descriptions.
What does SIST ES 203 915-15 V1.3.1:2008 specify?
SIST ES 203 915-15 V1.3.1:2008 specifies the Multi Media Messaging Service Capability Feature (SCF) aspects of the OSA interface. In practice, that means it describes how an application can open mailbox or messaging sessions, send and receive messages, subscribe to notifications, and inspect message and mailbox content through standardized APIs.
The document is organized as a stage 3 specification. Clause 5 gives sequence diagrams, clause 6 gives class diagrams, clause 7 gives service interface specifications, clause 8 details the interface classes, clause 9 covers state transition diagrams, clause 10 lists service properties, clause 11 defines data types, and clause 12 lists exception classes. The specification uses Unified Modelling Language (UML) object modelling.
| Annex | What it covers |
|---|---|
| Annex A | Normative OMG IDL description of the Multi-Media Messaging SCF |
| Annex B | Informative W3C WSDL description of the Multi-Media Messaging SCF |
| Annex C | Informative Java API description of the Multi-Media Messaging SCF |
| Annex D | Informative contents of 3GPP OSA R6 Multi-Media Messaging |
| Annex E | Informative description of Multi Media Messaging for 3GPP2 cdma2000 networks |
| Annex F | Informative record of changes |
What are the key requirements of SIST ES 203 915-15 V1.3.1:2008?
SIST ES 203 915-15 V1.3.1:2008 sets out how applications and network services interact for Multi Media Messaging. The most important requirement is that any method an implementation supports must work for at least one valid set of parameter values, and an unsupported service-interface method shall return P_METHOD_NOT_SUPPORTED. That matters because an integrator must check capability support before relying on a function.
Service manager behavior
Clause 8.1 defines IpMultiMediaMessagingManager, the service manager for the SCF. It opens mailbox objects with openMailbox() and messaging objects with openMultiMediaMessaging(), and it also creates, changes, destroys, enables, and disables notifications. In practice, this is the entry point used by applications to start interacting with messaging services.
openMailbox() accepts a mailbox ID and authentication information, while openMultiMediaMessaging() can take default destination and source addresses. That matters because an application can either work with fixed defaults or supply addresses later in individual send operations.
Callback handling and asynchronous control
Clause 8.2 defines IpAppMultiMediaMessagingManager, the callback interface used by the client application. It receives mailbox termination events, notification reports, interruptions and resumptions of notifications, and termination notices for messaging sessions. The callbacks carry identifiers so the application can match reports to the mailbox or session being used.
Clause 8.6 defines IpAppMultiMediaMessaging, which receives asynchronous responses to send, cancel, and status-query requests, plus messageStatusReport() and messageReceived(). This is important in practice because the API is not purely request-response: message delivery and receipt information can arrive later, and the application has to correlate them with sessionID, assignmentID, and message-related identifiers.
Mailbox access and message content handling
Clause 8.3 defines IpMailbox, which lets an application create, list, copy, move, and delete folders and messages. Folders use fully qualified names with / as the delimiter, and names are case sensitive. That matters because folder paths must be built exactly and consistently when retrieving or moving content.
getFoldersReq() returns top-level folders when the folder ID is empty, and putMessageReq() places a message into a named folder. If the folder used for sending matches the service property P_PUT_MESSAGE_FOLDER_TO_SEND, the message is automatically sent. The mailbox interface also provides methods to list messages, inspect body parts, retrieve headers, fetch message content, and obtain mailbox, folder, and message properties.
Non-mailbox messaging and message submission
Clause 8.5 defines IpMultiMediaMessaging for messaging outside the mailbox paradigm. It supports sendMessageReq(), cancelMessageReq(), queryStatusReq(), close(), and the newer sendMessageWithNotifyReq(). This is the interface used when the application sends messages directly rather than placing them in a mailbox folder first.
sendMessageReq() and sendMessageWithNotifyReq() accept destination address lists, source addresses, delivery type, treatment instructions, raw message content, and additional headers. The document states that default source and destination addresses can be supplied when the session is opened, and later overridden per request. If there is a conflict, the explicit source and destination parameters take priority over the additional headers. That matters because applications need a clear rule for which address data the network will actually use.
The messageTreatment parameters can request delivery reports, read receipts, expiry handling, or billing-related behavior. The deliveryType must be valid for the network and message format, or an exception is returned. This is the part that affects interoperability most directly, because message encoding, addressing, and delivery policy must match what the network supports.
Notifications, service properties, data definitions, and errors
Clause 5 and clause 8.2 show that the SCF supports notification flows for new messages and delivery status reports. In the mailbox case, reportNotification() can deliver the message ID, location, and description, while the message content is retrieved separately from the mailbox. In the non-mailbox case, messageReceived() delivers the full message contents directly. That difference matters when designing whether the application should retrieve content later or handle it immediately.
Clause 10 defines service properties such as P_MESSAGE_DELIVERY_TYPE, P_PUT_MESSAGE_FOLDER_TO_SEND, P_NOTIFICATION_ADDRESS_RANGES, and P_SOURCE_ADDRESS_RANGES. These properties describe what the service supports and what an application is allowed to request. In practice, they are used to check delivery capabilities and enforce address-range restrictions.
Clause 11 defines the main data types for folders, messages, headers, delivery types, treatment sets, event criteria, notification requests, and error sets. Clause 12 lists the exception classes for invalid mailbox, folder, message, part, header, delivery type, delivery time, validity time, and cancellation cases. For implementers and test teams, these definitions are the basis for correct parameter checking, error handling, and conformance tests.
What terms does SIST ES 203 915-15 V1.3.1:2008 define?
- Open Service Access (OSA) - OSA is the architecture that lets application developers use network functionality through an open standardized interface.
- Application Programming Interface (API) - An API is the software interface that applications call to use the messaging functions defined in the standard.
- Service Capability Feature (SCF) - An SCF is one service area of the OSA API, and this part covers the Multi Media Messaging SCF.
- Unified Modelling Language (UML) - UML is the object-modelling notation used to describe the interface classes, sequence diagrams, and state-related behavior.
- Interface Definition Language (IDL) - IDL is the formal interface description used in Annex A to represent the API in OMG IDL form.
- IpMultiMediaMessagingManager - This is the service manager interface that opens mailbox and messaging objects and controls notifications.
- IpMailbox - This is the interface used to access and manipulate mailbox folders, messages, and properties.
- IpAppMultiMediaMessaging - This is the application callback interface used to receive responses, status reports, and incoming messages.
Who uses SIST ES 203 915-15 V1.3.1:2008?
SIST ES 203 915-15 V1.3.1:2008 is used by telecom application developers, platform vendors, and service integrators who need a standard way to work with messaging services. The document explicitly targets developers who implement the service manager callback interface and the mailbox/application interfaces.
It is relevant for services and applications that handle voice mail, electronic mail, instant messaging, SMS, MMS, and GSM USSD. Quality and test teams use it to verify request/response behavior, message status reporting, mailbox access, notification handling, and exception handling across those messaging contexts.
What changed in SIST ES 203 915-15 V1.3.1:2008 from the previous edition?
SIST ES 203 915-15 V1.3.1:2008 replaces ES 203 915-15 V1.2.1. Annex F states that the WSDL code was reworked and replaced in Annex B.
Which standards are used with SIST ES 203 915-15 V1.3.1:2008?
- ETSI ES 203 915-1: Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview (Parlay 5) - This part provides the overall OSA framework, the shared definitions and abbreviations, and the reference list that applies to this part.
- ETSI ES 203 915-2: Common Data Definitions - Clause 4 and clause 11 rely on common data types that are defined in the common data definitions part.
- 3GPP TS 29.198-15 V6.6.0 (Release 6) - The foreword identifies this standard as equivalent to that 3GPP specification.
What does the SIST ES 203 915-15 V1.3.1:2008 document contain?
SIST ES 203 915-15 V1.3.1:2008 contains sequence diagrams for message sending, receiving, mailbox use, notification subscription, and delivery-status reporting. It also contains class diagrams and detailed interface method descriptions for the service manager, mailbox, and messaging interfaces.
Clause 11 is a large data-definition section covering message descriptions, property sets, delivery and treatment types, notification criteria, and error-related types. Clause 12 collects the exception classes used by the API, with structured ExtraInformation to help identify the source of an error.
Annex A provides the formal OMG IDL version of the interface, Annex B gives the W3C WSDL version, and Annex C gives the Java API realization. Annex D and Annex E place the specification in the 3GPP and 3GPP2 contexts, and Annex F records changes across releases.
Buy Documents
ETSI ES 203 915-15 V1.3.1 (2008-02) - Open Service Access (OSA); Application Programming Interface (API); Part 15: Multi-Media Messaging SCF (Parlay 5)
ETSI ES 203 915-15 V1.3.1 (2008-04) - Open Service Access (OSA); Application Programming Interface (API); Part 15: Multi-Media Messaging SCF (Parlay 5)
Get Certified
Connect with accredited certification bodies for this standard

BSI Group
BSI (British Standards Institution) is the business standards company that helps organizations make excellence a habit.

NYCE
Mexican standards and certification body.
Sponsored listings
Frequently Asked Questions
SIST ES 203 915-15 V1.3.1:2008 is a standard published by the Slovenian Institute for Standardization (SIST). Its full title is "Open Service Access (OSA) - Application Programming Interface (API) - Part 15: Multi-Media Messaging SCF (Parlay 5)". This standard covers: Update of ES 203 915 to become Parlay 5.2. Only those parts requiring modification will be updated (most parts require maintenance fixes).The present document is part 15 of the Stage 3 specification for an Application Programming Interface (API) for Open Service Access (OSA). The OSA specifications define an architecture that enables application developers to make use of network functionality through an open standardised interface, i.e. the OSA APIs. The present document specifies the Multi Media Messaging Service Capability Feature (SCF) aspects of the interface. All aspects of the Multi Media Messaging SCF are defined here, these being: • Sequence Diagrams. • Class Diagrams. • Interface specification plus detailed method descriptions. • State Transition diagrams. • Data Definitions. • IDL Description of the interfaces. The process by which this task is accomplished is through the use of object modelling techniques described by the Unified Modelling Language (UML).
Update of ES 203 915 to become Parlay 5.2. Only those parts requiring modification will be updated (most parts require maintenance fixes).The present document is part 15 of the Stage 3 specification for an Application Programming Interface (API) for Open Service Access (OSA). The OSA specifications define an architecture that enables application developers to make use of network functionality through an open standardised interface, i.e. the OSA APIs. The present document specifies the Multi Media Messaging Service Capability Feature (SCF) aspects of the interface. All aspects of the Multi Media Messaging SCF are defined here, these being: • Sequence Diagrams. • Class Diagrams. • Interface specification plus detailed method descriptions. • State Transition diagrams. • Data Definitions. • IDL Description of the interfaces. The process by which this task is accomplished is through the use of object modelling techniques described by the Unified Modelling Language (UML).
SIST ES 203 915-15 V1.3.1:2008 is classified under the following ICS (International Classification for Standards) categories: 35.100.01 - Open systems interconnection in general. The ICS classification helps identify the subject area and facilitates finding related standards.
SIST ES 203 915-15 V1.3.1:2008 is available in PDF format for immediate download after purchase. The document can be added to your cart and obtained through the secure checkout process. Digital delivery ensures instant access to the complete standard document.
Standards Content (Sample)
Final draft ETSI ES 203 915-15 V1.3.1 (2008-02)
ETSI Standard
Open Service Access (OSA);
Application Programming Interface (API);
Part 15: Multi-Media Messaging SCF
(Parlay 5)
�
2 Final draft ETSI ES 203 915-15 V1.3.1 (2008-02)
Reference
RES/TISPAN-01055-15-OSA
Keywords
API, IDL, OSA, UML
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
3 Final draft ETSI ES 203 915-15 V1.3.1 (2008-02)
Contents
Intellectual Property Rights.8
Foreword.8
1 Scope.9
2 References.9
3 Definitions and abbreviations.9
3.1 Definitions.9
3.2 Abbreviations.9
4 Multi Media Messaging SCF .10
5 Sequence Diagrams.10
5.1 Sending messages and receiving delivery notification .10
5.2 Sending, and receiving messages in same context .12
5.3 Setting notification of received messages .13
5.4 Using Mailbox functions.14
5.5 Using Mailbox to send and receive .16
5.6 Setting notification of received messages .18
6 Class Diagrams.19
7 The Service Interface Specifications.20
7.1 Interface Specification Format .20
7.1.1 Interface Class.20
7.1.2 Method descriptions.20
7.1.3 Parameter descriptions.20
7.1.4 State Model.20
7.2 Base Interface.20
7.2.1 Interface Class IpInterface .20
7.3 Service Interfaces.20
7.3.1 Overview.20
7.4 Generic Service Interface .21
7.4.1 Interface Class IpService .21
7.4.1.1 Method setCallback().21
7.4.1.2 Method setCallbackWithSessionID().21
8 Multi Media Messaging Interface Classes .22
8.1 Interface Class IpMultiMediaMessagingManager .22
8.1.1 Method openMailbox().23
8.1.2 Method openMultiMediaMessaging().24
8.1.3 Method createNotification().25
8.1.4 Method destroyNotification().25
8.1.5 Method changeNotification().25
8.1.6 Method getNextNotification().26
8.1.7 Method enableNotifications().27
8.1.8 Method disableNotifications().27
8.2 Interface Class IpAppMultiMediaMessagingManager.27
8.2.1 Method mailboxTerminated().28
8.2.2 Method reportNotification().28
8.2.3 Method notificationsInterrupted().29
8.2.4 Method notificationsResumed().29
8.2.5 Method multiMediaMessagingTerminated().29
8.2.6 Method terminateMultipleMailboxes().29
8.2.7 Method terminateMultipleMultiMediaMessagingSessions().30
8.3 Interface Class IpMailbox .30
8.3.1 Method close().31
8.3.2 Method createFolderReq().32
ETSI
4 Final draft ETSI ES 203 915-15 V1.3.1 (2008-02)
8.3.3 Method getFoldersReq().32
8.3.4 Method deleteFolderReq().33
8.3.5 Method copyFolderReq().33
8.3.6 Method moveFolderReq().34
8.3.7 Method putMessageReq().34
8.3.8 Method copyMessageReq().35
8.3.9 Method moveMessageReq().36
8.3.10 Method deleteMessageReq().36
8.3.11 Method listMessagesReq().37
8.3.12 Method listMessageBodyPartsReq().37
8.3.13 Method getMessageBodyPartsReq().38
8.3.14 Method getMessageHeadersReq().39
8.3.15 Method getMessageContentReq().39
8.3.16 Method getFullMessageReq().40
8.3.17 Method getMailboxInfoPropertiesReq().40
8.3.18 Method getFolderInfoPropertiesReq().41
8.3.19 Method getMessageInfoPropertiesReq().41
8.3.20 Method setMessageInfoPropertiesReq().42
8.4 Interface Class IpAppMailbox .42
8.4.1 Method createFolderRes().44
8.4.2 Method createFolderErr().45
8.4.3 Method getFoldersRes().45
8.4.4 Method getFoldersErr().45
8.4.5 Method deleteFolderRes().46
8.4.6 Method deleteFolderErr().46
8.4.7 Method copyFolderRes().46
8.4.8 Method copyFolderErr().47
8.4.9 Method moveFolderRes().47
8.4.10 Method moveFolderErr().47
8.4.11 Method putMessageRes().48
8.4.12 Method putMessageErr().48
8.4.13 Method copyMessageRes().48
8.4.14 Method copyMessageErr().49
8.4.15 Method moveMessageRes().49
8.4.16 Method moveMessageErr().49
8.4.17 Method deleteMessageRes().50
8.4.18 Method deleteMessageErr().50
8.4.19 Method listMessagesRes().50
8.4.20 Method listMessagesErr().51
8.4.21 Method listMessageBodyPartsRes().51
8.4.22 Method listMessageBodyPartsErr().51
8.4.23 Method getMessageBodyPartsRes().52
8.4.24 Method getMessageBodyPartsErr().52
8.4.25 Method getMessageHeadersRes().52
8.4.26 Method getMessageHeadersErr().53
8.4.27 Method getMessageContentRes().53
8.4.28 Method getMessageContentErr().54
8.4.29 Method getFullMessageRes().54
8.4.30 Method getFullMessageErr().54
8.4.31 Method getMailboxInfoPropertiesRes().55
8.4.32 Method getFolderInfoPropertiesRes().55
8.4.33 Method getMessageInfoPropertiesRes().55
8.4.34 Method setMessageInfoPropertiesRes().56
8.4.35 Method setMessageInfoPropertiesErr().56
8.4.36 Method getMailboxInfoPropertiesErr().57
8.4.37 Method getFolderInfoPropertiesErr().57
8.4.38 Method getMessageInfoPropertiesErr().57
8.5 Interface Class IpMultiMediaMessaging.58
8.5.1 Method sendMessageReq().58
8.5.2 Method cancelMessageReq().59
8.5.3 Method queryStatusReq().60
8.5.4 Method close().60
ETSI
5 Final draft ETSI ES 203 915-15 V1.3.1 (2008-02)
8.5.5 Method <> sendMessageWithNotifyReq().61
8.6 Interface Class IpAppMultiMediaMessaging.62
8.6.1 Method sendMessageRes().62
8.6.2 Method sendMessageErr().63
8.6.3 Method cancelMessageRes().63
8.6.4 Method cancelMessageErr().63
8.6.5 Method queryStatusRes().64
8.6.6 Method queryStatusErr().64
8.6.7 Method messageStatusReport().64
8.6.8 Method messageReceived().65
8.6.9 Method <> sendMessageWithNotifyRes() .65
8.6.10 Method <> sendMessageWithNotifyErr() .66
9 State Transition Diagrams.66
10 Multi-Media Messaging Service Properties .67
11 Data Definitions.68
11.1 Multi-Media Messaging data definitions.68
11.1.1 IpMultiMediaMessagingManager.68
11.1.2 IpMultiMediaMessagingManagerRef.68
11.1.3 IpAppMultiMediaMessagingManager.68
11.1.4 IpAppMultiMediaMessagingManagerRef.68
11.1.5 IpMailbox.68
11.1.6 IpMailboxRef.68
11.1.7 IpAppMailbox.68
11.1.8 IpAppMailboxRef.68
11.1.9 IpMultiMediaMessaging.68
11.1.10 IpMultiMediaMessagingRef.68
11.1.11 IpAppMultiMediaMessaging.68
11.1.12 IpAppMultiMediaMessagingRef.69
11.1.13 TpBodyPartDescription.69
11.1.14 TpBodyPartDescriptionList.69
11.1.15 TpBodyPart.69
11.1.16 TpBodyPartList.69
11.1.17 TpDeliveryTime.69
11.1.18 TpDeliveryTimeType.70
11.1.19 TpFolderInfoProperty.70
11.1.20 TpFolderInfoPropertyName.70
11.1.21 TpFolderInfoPropertySet.70
11.1.22 TpGenericHeaderField.70
11.1.23 TpListMessagesCriteria.71
11.1.24 TpMailboxFolderStatusInformation.71
11.1.25 TpMailboxIdentifier.71
11.1.26 TpMailboxIdentifierSet.71
11.1.27 TpMailboxInfoProperty.71
11.1.28 TpMailboxInfoPropertyName.72
11.1.29 TpMailboxInfoPropertySet.72
11.1.30 TpMailboxMessageStatus.72
11.1.31 TpMessageDeliveryType.73
11.1.32 TpMessageInfoProperty.73
11.1.33 TpMessageInfoPropertyName.73
11.1.34 TpMessageInfoPropertySet.73
11.1.35 TpMessageHeaderFieldType.74
11.1.36 TpMessageHeaderField.75
11.1.37 TpMessageHeaderFieldSet.75
11.1.38 TpMessagePriority.75
11.1.39 TpMessageDeliveryReportType.76
11.1.40 TpMessageTreatment.76
11.1.41 TpMessageTreatmentType.76
11.1.42 TpMessageTreatmentSet.76
11.1.43 TpMultiMediaMessagingIdentifier.76
11.1.44 TpMultiMediaMessagingIdentifierSet.77
ETSI
6 Final draft ETSI ES 203 915-15 V1.3.1 (2008-02)
11.1.45 TpQueryStatusReport.77
11.1.46 TpQueryStatusReportSet.77
11.1.47 TpTerminatingAddressList.77
11.2 Event Notification data definitions.77
11.2.1 TpMessagingEventName.77
11.2.2 TpMessagingEventCriteria.77
11.2.3 TpMessagingEventCriteriaSet.78
11.2.4 TpNewMailboxMessageArrivedCriteria.78
11.2.5 TpNewMessageArrivedCriteria.78
11.2.6 TpMessagingEventInfo.78
11.2.7 TpMessagingEventInfoSet.79
11.2.8 TpNewMailboxMessageArrivedInfo.79
11.2.9 TpNewMessageArrivedInfo.79
11.2.10 TpMessageDescription.79
11.2.11 TpMessageDescriptionList.80
11.2.12 TpMessagingNotificationRequested.80
11.2.13 TpMessagingNotificationRequestedSet.80
11.2.14 TpMessagingNotificationRequestedSetEntry.80
11.2.15 TpNewMessageStatusReportArrivedInfo.80
11.3 Error type data definitions.81
11.3.1 TpMessageInfoPropertyError.81
11.3.2 TpMessagingError .81
11.3.3 TpMessageInfoPropertyErrorSet.82
11.3.4 TpSetPropertyError.82
12 Exception Classes.82
Annex A (normative): OMG IDL Description of Multi-Media Messaging SCF .84
Annex B (informative): W3C WSDL Description of Multi-Media Messaging SCF.85
Annex C (informative): Java API Description of the Multi-Media Messaging SCF.86
Annex D (informative): Contents of 3GPP OSA R6 Multi-Media Messaging .87
Annex E (informative): Description of Multi Media Messaging for 3GPP2 cdma2000
networks.88
E.1 General Exceptions.88
E.2 Specific Exceptions.88
E.2.1 Clause 1: Scope .88
E.2.2 Clause 2: References .88
E.2.3 Clause 3: Definitions and abbreviations.88
E.2.4 Clause 4: Multi Media Messaging SCF.88
E.2.5 Clause 5: Sequence Diagrams .88
E.2.6 Clause 6: Class Diagrams.88
E.2.7 Clause 7: The Service Interface Specifications .88
E.2.8 Clause 8: Multi Media Messaging Interface Classes.89
E.2.9 Clause 9: State Transition Diagrams .89
E.2.10 Clause 10: Multi-Media Messaging Service Properties .89
E.2.11 Clause 11: Data Definitions.89
E.2.12 Clause 12: Exception Classes.89
E.2.13 Annex A (normative): OMG IDL Description of Multi-Media Messaging SCF .89
E.2.14 Annex B (informative): W3C WSDL Description of Multi-Media Messaging SCF .89
E.2.15 Annex C (informative): Java API Description of the Multi-Media Messaging SCF.89
Annex F (informative): Record of changes .90
F.1 Interfaces.90
F.1.1 New.90
F.1.2 Deprecated.90
F.1.3 Removed.90
ETSI
7 Final draft ETSI ES 203 915-15 V1.3.1 (2008-02)
F.2 Methods.91
F.2.1 New.91
F.2.2 Deprecated.91
F.2.3 Modified.91
F.2.4 Removed.91
F.3 Data Definitions.92
F.3.1 New.92
F.3.2 Modified.92
F.3.3 Removed.92
F.4 Service Properties.92
F.4.1 New.92
F.4.2 Deprecated.93
F.4.3 Modified.93
F.4.4 Removed.93
F.5 Exceptions.93
F.5.1 New.93
F.5.2 Modified.94
F.5.3 Removed.94
F.6 Others.94
History .95
ETSI
8 Final draft ETSI ES 203 915-15 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 15 of a multi-part deliverable covering Open Service Access (OSA); Application
Programming Interface (API), as identified below. The API specification (ES 203 915) is structured in the following
parts:
Part 1: "Overview";
Part 2: "Common Data Definitions";
Part 3: "Framework";
Part 4: "Call Control";
Part 5: "User Interaction SCF";
Part 6: "Mobility SCF";
Part 7: "Terminal Capabilities SCF";
Part 8: "Data Session Control SCF";
Part 9: "Generic Messaging SCF";
Part 10: "Connectivity Manager SCF";
Part 11: "Account Management SCF";
Part 12: "Charging SCF";
Part 13: "Policy Management SCF";
Part 14: "Presence and Availability Management SCF";
Part 15: "Multi-Media Messaging SCF".
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP,
in co-operation with a number of JAIN™ Community (http://www.java.sun.com/products/jain) member companies.
The present document forms part of the Parlay 5.2 set of specifications.
The present document is equivalent to 3GPP TS 29.198-15 V6.6.0 (Release 6).
ETSI
9 Final draft ETSI ES 203 915-15 V1.3.1 (2008-02)
1 Scope
The present document is part 15 of the Stage 3 specification for an Application Programming Interface (API) for Open
Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardised interface, i.e. the OSA APIs.
The present document specifies the Multi Media Messaging Service Capability Feature (SCF) aspects of the interface.
All aspects of the Multi Media Messaging SCF are defined here, these being:
• Sequence Diagrams.
• Class Diagrams.
• Interface specification plus detailed method descriptions.
• State Transition diagrams.
• Data Definitions.
• IDL Description of the interfaces.
The process by which this task is accomplished is through the use of object modelling techniques described by the
Unified Modelling Language (UML).
2 References
The references listed in clause 2 of ES 203 915-1 contain provisions which, through reference in this text, constitute
provisions of the present document.
ETSI ES 203 915-1: "Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview
(Parlay 5)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 203 915-1 apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations defined in ES 203 915-1 apply.
ETSI
10 Final draft ETSI ES 203 915-15 V1.3.1 (2008-02)
4 Multi Media Messaging SCF
The following clauses describe each aspect of the Multi Media Messaging Service Capability Feature (SCF).
The order is as follows:
• The Sequence diagrams give the reader a practical idea of how each of the SCF is implemented.
• The Class relationships clause shows how each of the interfaces applicable to the SC
...
ETSI Standard
Open Service Access (OSA);
Application Programming Interface (API);
Part 15: Multi-Media Messaging SCF
(Parlay 5)
�
2 ETSI ES 203 915-15 V1.3.1 (2008-04)
Reference
RES/TISPAN-01055-15-OSA
Keywords
API, IDL, OSA, UML
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
3 ETSI ES 203 915-15 V1.3.1 (2008-04)
Contents
Intellectual Property Rights.8
Foreword.8
1 Scope.9
2 References.9
3 Definitions and abbreviations.9
3.1 Definitions.9
3.2 Abbreviations.9
4 Multi Media Messaging SCF .10
5 Sequence Diagrams.10
5.1 Sending messages and receiving delivery notification .10
5.2 Sending, and receiving messages in same context .12
5.3 Setting notification of received messages .13
5.4 Using Mailbox functions.14
5.5 Using Mailbox to send and receive .16
5.6 Setting notification of received messages .17
6 Class Diagrams.18
7 The Service Interface Specifications.19
7.1 Interface Specification Format .19
7.1.1 Interface Class.19
7.1.2 Method descriptions.19
7.1.3 Parameter descriptions.19
7.1.4 State Model.19
7.2 Base Interface.19
7.2.1 Interface Class IpInterface .19
7.3 Service Interfaces.20
7.3.1 Overview.20
7.4 Generic Service Interface .20
7.4.1 Interface Class IpService .20
7.4.1.1 Method setCallback().20
7.4.1.2 Method setCallbackWithSessionID().20
8 Multi Media Messaging Interface Classes .21
8.1 Interface Class IpMultiMediaMessagingManager .21
8.1.1 Method openMailbox().22
8.1.2 Method openMultiMediaMessaging().23
8.1.3 Method createNotification().24
8.1.4 Method destroyNotification().24
8.1.5 Method changeNotification().25
8.1.6 Method getNextNotification().25
8.1.7 Method enableNotifications().26
8.1.8 Method disableNotifications().26
8.2 Interface Class IpAppMultiMediaMessagingManager.26
8.2.1 Method mailboxTerminated().27
8.2.2 Method reportNotification().27
8.2.3 Method notificationsInterrupted().28
8.2.4 Method notificationsResumed().28
8.2.5 Method multiMediaMessagingTerminated().28
8.2.6 Method terminateMultipleMailboxes().28
8.2.7 Method terminateMultipleMultiMediaMessagingSessions().28
8.3 Interface Class IpMailbox .29
8.3.1 Method close().31
8.3.2 Method createFolderReq().31
ETSI
4 ETSI ES 203 915-15 V1.3.1 (2008-04)
8.3.3 Method getFoldersReq().31
8.3.4 Method deleteFolderReq().32
8.3.5 Method copyFolderReq().32
8.3.6 Method moveFolderReq().33
8.3.7 Method putMessageReq().33
8.3.8 Method copyMessageReq().34
8.3.9 Method moveMessageReq().35
8.3.10 Method deleteMessageReq().35
8.3.11 Method listMessagesReq().36
8.3.12 Method listMessageBodyPartsReq().37
8.3.13 Method getMessageBodyPartsReq().37
8.3.14 Method getMessageHeadersReq().38
8.3.15 Method getMessageContentReq().38
8.3.16 Method getFullMessageReq().39
8.3.17 Method getMailboxInfoPropertiesReq().40
8.3.18 Method getFolderInfoPropertiesReq().40
8.3.19 Method getMessageInfoPropertiesReq().40
8.3.20 Method setMessageInfoPropertiesReq().41
8.4 Interface Class IpAppMailbox .42
8.4.1 Method createFolderRes().43
8.4.2 Method createFolderErr().44
8.4.3 Method getFoldersRes().44
8.4.4 Method getFoldersErr().45
8.4.5 Method deleteFolderRes().45
8.4.6 Method deleteFolderErr().45
8.4.7 Method copyFolderRes().46
8.4.8 Method copyFolderErr().46
8.4.9 Method moveFolderRes().46
8.4.10 Method moveFolderErr().47
8.4.11 Method putMessageRes().47
8.4.12 Method putMessageErr().47
8.4.13 Method copyMessageRes().48
8.4.14 Method copyMessageErr().48
8.4.15 Method moveMessageRes().48
8.4.16 Method moveMessageErr().49
8.4.17 Method deleteMessageRes().49
8.4.18 Method deleteMessageErr().49
8.4.19 Method listMessagesRes().50
8.4.20 Method listMessagesErr().50
8.4.21 Method listMessageBodyPartsRes().50
8.4.22 Method listMessageBodyPartsErr().51
8.4.23 Method getMessageBodyPartsRes().51
8.4.24 Method getMessageBodyPartsErr().51
8.4.25 Method getMessageHeadersRes().52
8.4.26 Method getMessageHeadersErr().52
8.4.27 Method getMessageContentRes().53
8.4.28 Method getMessageContentErr().53
8.4.29 Method getFullMessageRes().53
8.4.30 Method getFullMessageErr().54
8.4.31 Method getMailboxInfoPropertiesRes().54
8.4.32 Method getFolderInfoPropertiesRes().54
8.4.33 Method getMessageInfoPropertiesRes().55
8.4.34 Method setMessageInfoPropertiesRes().55
8.4.35 Method setMessageInfoPropertiesErr().56
8.4.36 Method getMailboxInfoPropertiesErr().56
8.4.37 Method getFolderInfoPropertiesErr().56
8.4.38 Method getMessageInfoPropertiesErr().57
8.5 Interface Class IpMultiMediaMessaging.57
8.5.1 Method sendMessageReq().58
8.5.2 Method cancelMessageReq().59
8.5.3 Method queryStatusReq().60
8.5.4 Method close().60
ETSI
5 ETSI ES 203 915-15 V1.3.1 (2008-04)
8.5.5 Method <> sendMessageWithNotifyReq().60
8.6 Interface Class IpAppMultiMediaMessaging.62
8.6.1 Method sendMessageRes().62
8.6.2 Method sendMessageErr().63
8.6.3 Method cancelMessageRes().63
8.6.4 Method cancelMessageErr().63
8.6.5 Method queryStatusRes().64
8.6.6 Method queryStatusErr().64
8.6.7 Method messageStatusReport().64
8.6.8 Method messageReceived().65
8.6.9 Method <> sendMessageWithNotifyRes() .65
8.6.10 Method <> sendMessageWithNotifyErr() .66
9 State Transition Diagrams.66
10 Multi-Media Messaging Service Properties .66
11 Data Definitions.67
11.1 Multi-Media Messaging data definitions.67
11.1.1 IpMultiMediaMessagingManager.67
11.1.2 IpMultiMediaMessagingManagerRef.67
11.1.3 IpAppMultiMediaMessagingManager.67
11.1.4 IpAppMultiMediaMessagingManagerRef.67
11.1.5 IpMailbox.67
11.1.6 IpMailboxRef.67
11.1.7 IpAppMailbox.67
11.1.8 IpAppMailboxRef.67
11.1.9 IpMultiMediaMessaging.67
11.1.10 IpMultiMediaMessagingRef.68
11.1.11 IpAppMultiMediaMessaging.68
11.1.12 IpAppMultiMediaMessagingRef.68
11.1.13 TpBodyPartDescription.68
11.1.14 TpBodyPartDescriptionList.68
11.1.15 TpBodyPart.68
11.1.16 TpBodyPartList.69
11.1.17 TpDeliveryTime.69
11.1.18 TpDeliveryTimeType.69
11.1.19 TpFolderInfoProperty.69
11.1.20 TpFolderInfoPropertyName.69
11.1.21 TpFolderInfoPropertySet.70
11.1.22 TpGenericHeaderField.70
11.1.23 TpListMessagesCriteria.70
11.1.24 TpMailboxFolderStatusInformation.70
11.1.25 TpMailboxIdentifier.70
11.1.26 TpMailboxIdentifierSet.70
11.1.27 TpMailboxInfoProperty.71
11.1.28 TpMailboxInfoPropertyName.71
11.1.29 TpMailboxInfoPropertySet.71
11.1.30 TpMailboxMessageStatus.71
11.1.31 TpMessageDeliveryType.72
11.1.32 TpMessageInfoProperty.72
11.1.33 TpMessageInfoPropertyName.73
11.1.34 TpMessageInfoPropertySet.73
11.1.35 TpMessageHeaderFieldType.74
11.1.36 TpMessageHeaderField.75
11.1.37 TpMessageHeaderFieldSet.75
11.1.38 TpMessagePriority.75
11.1.39 TpMessageDeliveryReportType.76
11.1.40 TpMessageTreatment.76
11.1.41 TpMessageTreatmentType.76
11.1.42 TpMessageTreatmentSet.76
11.1.43 TpMultiMediaMessagingIdentifier.77
11.1.44 TpMultiMediaMessagingIdentifierSet.77
ETSI
6 ETSI ES 203 915-15 V1.3.1 (2008-04)
11.1.45 TpQueryStatusReport.77
11.1.46 TpQueryStatusReportSet.77
11.1.47 TpTerminatingAddressList.77
11.2 Event Notification data definitions.78
11.2.1 TpMessagingEventName.78
11.2.2 TpMessagingEventCriteria.78
11.2.3 TpMessagingEventCriteriaSet.78
11.2.4 TpNewMailboxMessageArrivedCriteria.78
11.2.5 TpNewMessageArrivedCriteria.79
11.2.6 TpMessagingEventInfo.79
11.2.7 TpMessagingEventInfoSet.79
11.2.8 TpNewMailboxMessageArrivedInfo.79
11.2.9 TpNewMessageArrivedInfo.80
11.2.10 TpMessageDescription.80
11.2.11 TpMessageDescriptionList.80
11.2.12 TpMessagingNotificationRequested.80
11.2.13 TpMessagingNotificationRequestedSet.80
11.2.14 TpMessagingNotificationRequestedSetEntry.81
11.2.15 TpNewMessageStatusReportArrivedInfo.81
11.3 Error type data definitions.81
11.3.1 TpMessageInfoPropertyError.81
11.3.2 TpMessagingError .81
11.3.3 TpMessageInfoPropertyErrorSet.82
11.3.4 TpSetPropertyError.82
12 Exception Classes.83
Annex A (normative): OMG IDL Description of Multi-Media Messaging SCF .84
Annex B (informative): W3C WSDL Description of Multi-Media Messaging SCF.85
Annex C (informative): Java API Description of the Multi-Media Messaging SCF.86
Annex D (informative): Contents of 3GPP OSA R6 Multi-Media Messaging .87
Annex E (informative): Description of Multi Media Messaging for 3GPP2 cdma2000
networks.88
E.1 General Exceptions.88
E.2 Specific Exceptions.88
E.2.1 Clause 1: Scope .88
E.2.2 Clause 2: References .88
E.2.3 Clause 3: Definitions and abbreviations.88
E.2.4 Clause 4: Multi Media Messaging SCF.88
E.2.5 Clause 5: Sequence Diagrams .88
E.2.6 Clause 6: Class Diagrams.88
E.2.7 Clause 7: The Service Interface Specifications .88
E.2.8 Clause 8: Multi Media Messaging Interface Classes.89
E.2.9 Clause 9: State Transition Diagrams .89
E.2.10 Clause 10: Multi-Media Messaging Service Properties .89
E.2.11 Clause 11: Data Definitions.89
E.2.12 Clause 12: Exception Classes.89
E.2.13 Annex A (normative): OMG IDL Description of Multi-Media Messaging SCF .89
E.2.14 Annex B (informative): W3C WSDL Description of Multi-Media Messaging SCF .89
E.2.15 Annex C (informative): Java API Description of the Multi-Media Messaging SCF.89
Annex F (informative): Record of changes .90
F.1 Interfaces.90
F.1.1 New.90
F.1.2 Deprecated.90
F.1.3 Removed.90
ETSI
7 ETSI ES 203 915-15 V1.3.1 (2008-04)
F.2 Methods.91
F.2.1 New.91
F.2.2 Deprecated.91
F.2.3 Modified.91
F.2.4 Removed.91
F.3 Data Definitions.92
F.3.1 New.92
F.3.2 Modified.92
F.3.3 Removed.92
F.4 Service Properties.92
F.4.1 New.92
F.4.2 Deprecated.93
F.4.3 Modified.93
F.4.4 Removed.93
F.5 Exceptions.93
F.5.1 New.93
F.5.2 Modified.94
F.5.3 Removed.94
F.6 Others.94
History .95
ETSI
8 ETSI ES 203 915-15 V1.3.1 (2008-04)
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 15 of a multi-part deliverable covering Open Service Access (OSA); Application
Programming Interface (API), as identified below. The API specification (ES 203 915) is structured in the following
parts:
Part 1: "Overview";
Part 2: "Common Data Definitions";
Part 3: "Framework";
Part 4: "Call Control";
Part 5: "User Interaction SCF";
Part 6: "Mobility SCF";
Part 7: "Terminal Capabilities SCF";
Part 8: "Data Session Control SCF";
Part 9: "Generic Messaging SCF";
Part 10: "Connectivity Manager SCF";
Part 11: "Account Management SCF";
Part 12: "Charging SCF";
Part 13: "Policy Management SCF";
Part 14: "Presence and Availability Management SCF";
Part 15: "Multi-Media Messaging SCF".
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP,
in co-operation with a number of JAIN™ Community (http://www.java.sun.com/products/jain) member companies.
The present document forms part of the Parlay 5.2 set of specifications.
The present document is equivalent to 3GPP TS 29.198-15 V6.6.0 (Release 6).
ETSI
9 ETSI ES 203 915-15 V1.3.1 (2008-04)
1 Scope
The present document is part 15 of the Stage 3 specification for an Application Programming Interface (API) for Open
Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardised interface, i.e. the OSA APIs.
The present document specifies the Multi Media Messaging Service Capability Feature (SCF) aspects of the interface.
All aspects of the Multi Media Messaging SCF are defined here, these being:
• Sequence Diagrams.
• Class Diagrams.
• Interface specification plus detailed method descriptions.
• State Transition diagrams.
• Data Definitions.
• IDL Description of the interfaces.
The process by which this task is accomplished is through the use of object modelling techniques described by the
Unified Modelling Language (UML).
2 References
The references listed in clause 2 of ES 203 915-1 contain provisions which, through reference in this text, constitute
provisions of the present document.
ETSI ES 203 915-1: "Open Service Access (OSA); Application Programming Interface (API); Part 1: Overview
(Parlay 5)".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in ES 203 915-1 apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations defined in ES 203 915-1 apply.
ETSI
10 ETSI ES 203 915-15 V1.3.1 (2008-04)
4 Multi Media Messaging SCF
The following clauses describe each aspect of the Multi Media Messaging Service Capability Feature (SCF).
The order is as follows:
• The Sequence diagrams give the reader a practical idea of how each of the SCF is implemented.
• The Class relationships clause shows how each of the interfaces applicable to the SCF, relate to one another.
• The Interface specification clause describes in detail each of the interfaces shown within the Class diagram
part.
• The State Transition Diagrams (STD) show the tra
...
SLOVENSKI STANDARD
01-september-2008
2GSUWLGRVWRSGRVWRULWYH26$$SOLNDFLMVNLSURJUDPVNLYPHVQLN$3,GHO
9HþSUHGVWDYQRVWQRVSRURþDQMH6&)3DUOD\
Open Service Access (OSA) - Application Programming Interface (API) - Part 15: Multi-
Media Messaging SCF (Parlay 5)
Ta slovenski standard je istoveten z: ES 203 915-15 Version 1.3.1
ICS:
35.100.01 Medsebojno povezovanje Open systems
odprtih sistemov na splošno interconnection in general
2003-01.Slovenski inštitut za standardizacijo. Razmnoževanje celote ali delov tega standarda ni dovoljeno.
ETSI Standard
Open Service Access (OSA);
Application Programming Interface (API);
Part 15: Multi-Media Messaging SCF
(Parlay 5)
�
2 ETSI ES 203 915-15 V1.3.1 (2008-04)
Reference
RES/TISPAN-01055-15-OSA
Keywords
API, IDL, OSA, UML
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
3 ETSI ES 203 915-15 V1.3.1 (2008-04)
Contents
Intellectual Property Rights.8
Foreword.8
1 Scope.9
2 References.9
3 Definitions and abbreviations.9
3.1 Definitions.9
3.2 Abbreviations.9
4 Multi Media Messaging SCF .10
5 Sequence Diagrams.10
5.1 Sending messages and receiving delivery notification .10
5.2 Sending, and receiving messages in same context .12
5.3 Setting notification of received messages .13
5.4 Using Mailbox functions.14
5.5 Using Mailbox to send and receive .16
5.6 Setting notification of received messages .17
6 Class Diagrams.18
7 The Service Interface Specifications.19
7.1 Interface Specification Format .19
7.1.1 Interface Class.19
7.1.2 Method descriptions.19
7.1.3 Parameter descriptions.19
7.1.4 State Model.19
7.2 Base Interface.19
7.2.1 Interface Class IpInterface .19
7.3 Service Interfaces.20
7.3.1 Overview.20
7.4 Generic Service Interface .20
7.4.1 Interface Class IpService .20
7.4.1.1 Method setCallback().20
7.4.1.2 Method setCallbackWithSessionID().20
8 Multi Media Messaging Interface Classes .21
8.1 Interface Class IpMultiMediaMessagingManager .21
8.1.1 Method openMailbox().22
8.1.2 Method openMultiMediaMessaging().23
8.1.3 Method createNotification().24
8.1.4 Method destroyNotification().24
8.1.5 Method changeNotification().25
8.1.6 Method getNextNotification().25
8.1.7 Method enableNotifications().26
8.1.8 Method disableNotifications().26
8.2 Interface Class IpAppMultiMediaMessagingManager.26
8.2.1 Method mailboxTerminated().27
8.2.2 Method reportNotification().27
8.2.3 Method notificationsInterrupted().28
8.2.4 Method notificationsResumed().28
8.2.5 Method multiMediaMessagingTerminated().28
8.2.6 Method terminateMultipleMailboxes().28
8.2.7 Method terminateMultipleMultiMediaMessagingSessions().28
8.3 Interface Class IpMailbox .29
8.3.1 Method close().31
8.3.2 Method createFolderReq().31
ETSI
4 ETSI ES 203 915-15 V1.3.1 (2008-04)
8.3.3 Method getFoldersReq().31
8.3.4 Method deleteFolderReq().32
8.3.5 Method copyFolderReq().32
8.3.6 Method moveFolderReq().33
8.3.7 Method putMessageReq().33
8.3.8 Method copyMessageReq().34
8.3.9 Method moveMessageReq().35
8.3.10 Method deleteMessageReq().35
8.3.11 Method listMessagesReq().36
8.3.12 Method listMessageBodyPartsReq().37
8.3.13 Method getMessageBodyPartsReq().37
8.3.14 Method getMessageHeadersReq().38
8.3.15 Method getMessageContentReq().38
8.3.16 Method getFullMessageReq().39
8.3.17 Method getMailboxInfoPropertiesReq().40
8.3.18 Method getFolderInfoPropertiesReq().40
8.3.19 Method getMessageInfoPropertiesReq().40
8.3.20 Method setMessageInfoPropertiesReq().41
8.4 Interface Class IpAppMailbox .42
8.4.1 Method createFolderRes().43
8.4.2 Method createFolderErr().44
8.4.3 Method getFoldersRes().44
8.4.4 Method getFoldersErr().45
8.4.5 Method deleteFolderRes().45
8.4.6 Method deleteFolderErr().45
8.4.7 Method copyFolderRes().46
8.4.8 Method copyFolderErr().46
8.4.9 Method moveFolderRes().46
8.4.10 Method moveFolderErr().47
8.4.11 Method putMessageRes().47
8.4.12 Method putMessageErr().47
8.4.13 Method copyMessageRes().48
8.4.14 Method copyMessageErr().48
8.4.15 Method moveMessageRes().48
8.4.16 Method moveMessageErr().49
8.4.17 Method deleteMessageRes().49
8.4.18 Method deleteMessageErr().49
8.4.19 Method listMessagesRes().50
8.4.20 Method listMessagesErr().50
8.4.21 Method listMessageBodyPartsRes().50
8.4.22 Method listMessageBodyPartsErr().51
8.4.23 Method getMessageBodyPartsRes().51
8.4.24 Method getMessageBodyPartsErr().51
8.4.25 Method getMessageHeadersRes().52
8.4.26 Method getMessageHeadersErr().52
8.4.27 Method getMessageContentRes().53
8.4.28 Method getMessageContentErr().53
8.4.29 Method getFullMessageRes().53
8.4.30 Method getFullMessageErr().54
8.4.31 Method getMailboxInfoPropertiesRes().54
8.4.32 Method getFolderInfoPropertiesRes().54
8.4.33 Method getMessageInfoPropertiesRes().55
8.4.34 Method setMessageInfoPropertiesRes().55
8.4.35 Method setMessageInfoPropertiesErr().56
8.4.36 Method getMailboxInfoPropertiesErr().56
8.4.37 Method getFolderInfoPropertiesErr().56
8.4.38 Method getMessageInfoPropertiesErr().57
8.5 Interface Class IpMultiMediaMessaging.57
8.5.1 Method sendMessageReq().58
8.5.2 Method cancelMessageReq().59
8.5.3 Method queryStatusReq().60
8.5.4 Method close().60
ETSI
5 ETSI ES 203 915-15 V1.3.1 (2008-04)
8.5.5 Method <> sendMessageWithNotifyReq().60
8.6 Interface Class IpAppMultiMediaMessaging.62
8.6.1 Method sendMessageRes().62
8.6.2 Method sendMessageErr().63
8.6.3 Method cancelMessageRes().63
8.6.4 Method cancelMessageErr().63
8.6.5 Method queryStatusRes().64
8.6.6 Method queryStatusErr().64
8.6.7 Method messageStatusReport().64
8.6.8 Method messageReceived().65
8.6.9 Method <> sendMessageWithNotifyRes() .65
8.6.10 Method <> sendMessageWithNotifyErr() .66
9 State Transition Diagrams.66
10 Multi-Media Messaging Service Properties .66
11 Data Definitions.67
11.1 Multi-Media Messaging data definitions.67
11.1.1 IpMultiMediaMessagingManager.67
11.1.2 IpMultiMediaMessagingManagerRef.67
11.1.3 IpAppMultiMediaMessagingManager.67
11.1.4 IpAppMultiMediaMessagingManagerRef.67
11.1.5 IpMailbox.67
11.1.6 IpMailboxRef.67
11.1.7 IpAppMailbox.67
11.1.8 IpAppMailboxRef.67
11.1.9 IpMultiMediaMessaging.67
11.1.10 IpMultiMediaMessagingRef.68
11.1.11 IpAppMultiMediaMessaging.68
11.1.12 IpAppMultiMediaMessagingRef.68
11.1.13 TpBodyPartDescription.68
11.1.14 TpBodyPartDescriptionList.68
11.1.15 TpBodyPart.68
11.1.16 TpBodyPartList.69
11.1.17 TpDeliveryTime.69
11.1.18 TpDeliveryTimeType.69
11.1.19 TpFolderInfoProperty.69
11.1.20 TpFolderInfoPropertyName.69
11.1.21 TpFolderInfoPropertySet.70
11.1.22 TpGenericHeaderField.70
11.1.23 TpListMessagesCriteria.70
11.1.24 TpMailboxFolderStatusInformation.70
11.1.25 TpMailboxIdentifier.70
11.1.26 TpMailboxIdentifierSet.70
11.1.27 TpMailboxInfoProperty.71
11.1.28 TpMailboxInfoPropertyName.71
11.1.29 TpMailboxInfoPropertySet.71
11.1.30 TpMailboxMessageStatus.71
11.1.31 TpMessageDeliveryType.72
11.1.32 TpMessageInfoProperty.72
11.1.33 TpMessageInfoPropertyName.73
11.1.34 TpMessageInfoPropertySet.73
11.1.35 TpMessageHeaderFieldType.74
11.1.36 TpMessageHeaderField.75
11.1.37 TpMessageHeaderFieldSet.75
11.1.38 TpMessagePriority.75
11.1.39 TpMessageDeliveryReportType.76
11.1.40 TpMessageTreatment.76
11.1.41 TpMessageTreatmentType.76
11.1.42 TpMessageTreatmentSet.76
11.1.43 TpMultiMediaMessagingIdentifier.77
11.1.44 TpMultiMediaMessagingIdentifierSet.77
ETSI
6 ETSI ES 203 915-15 V1.3.1 (2008-04)
11.1.45 TpQueryStatusReport.77
11.1.46 TpQueryStatusReportSet.77
11.1.47 TpTerminatingAddressList.77
11.2 Event Notification data definitions.78
11.2.1 TpMessagingEventName.78
11.2.2 TpMessagingEventCriteria.78
11.2.3 TpMessagingEventCriteriaSet.78
11.2.4 TpNewMailboxMessageArrivedCriteria.78
11.2.5 TpNewMessageArrivedCriteria.79
11.2.6 TpMessagingEventInfo.79
11.2.7 TpMessagingEventInfoSet.79
11.2.8 TpNewMailboxMessageArrivedInfo.79
11.2.9 TpNewMessageArrivedInfo.80
11.2.10 TpMessageDescription.80
11.2.11 TpMessageDescriptionList.80
11.2.12 TpMessagingNotificationRequested.80
11.2.13 TpMessagingNotificationRequestedSet.80
11.2.14 TpMessagingNotificationRequestedSetEntry.81
11.2.15 TpNewMessageStatusReportArrivedInfo.81
11.3 Error type data definitions.81
11.3.1 TpMessageInfoPropertyError.81
11.3.2 TpMessagingError .81
11.3.3 TpMessageInfoPropertyErrorSet.82
11.3.4 TpSetPropertyError.82
12 Exception Classes.83
Annex A (normative): OMG IDL Description of Multi-Media Messaging SCF .84
Annex B (informative): W3C WSDL Description of Multi-Media Messaging SCF.85
Annex C (informative): Java API Description of the Multi-Media Messaging SCF.86
Annex D (informative): Contents of 3GPP OSA R6 Multi-Media Messaging .87
Annex E (informative): Description of Multi Media Messaging for 3GPP2 cdma2000
networks.88
E.1 General Exceptions.88
E.2 Specific Exceptions.88
E.2.1 Clause 1: Scope .88
E.2.2 Clause 2: References .88
E.2.3 Clause 3: Definitions and abbreviations.88
E.2.4 Clause 4: Multi Media Messaging SCF.88
E.2.5 Clause 5: Sequence Diagrams .88
E.2.6 Clause 6: Class Diagrams.88
E.2.7 Clause 7: The Service Interface Specifications .88
E.2.8 Clause 8: Multi Media Messaging Interface Classes.89
E.2.9 Clause 9: State Transition Diagrams .89
E.2.10 Clause 10: Multi-Media Messaging Service Properties .89
E.2.11 Clause 11: Data Definitions.89
E.2.12 Clause 12: Exception Classes.89
E.2.13 Annex A (normative): OMG IDL Description of Multi-Media Messaging SCF .89
E.2.14 Annex B (informative): W3C WSDL Description of Multi-Media Messaging SCF .89
E.2.15 Annex C (informative): Java API Description of the Multi-Media Messaging SCF.89
Annex F (informative): Record of changes .90
F.1 Interfaces.90
F.1.1 New.90
F.1.2 Deprecated.90
F.1.3 Removed.90
ETSI
7 ETSI ES 203 915-15 V1.3.1 (2008-04)
F.2 Methods.91
F.2.1 New.91
F.2.2 Deprecated.91
F.2.3 Modified.91
F.2.4 Removed.91
F.3 Data Definitions.92
F.3.1 New.92
F.3.2 Modified.92
F.3.3 Removed.92
F.4 Service Properties.92
F.4.1 New.92
F.4.2 Deprecated.93
F.4.3 Modified.93
F.4.4 Removed.93
F.5 Exceptions.93
F.5.1 New.93
F.5.2 Modified.94
F.5.3 Removed.94
F.6 Others.94
History .95
ETSI
8 ETSI ES 203 915-15 V1.3.1 (2008-04)
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 15 of a multi-part deliverable covering Open Service Access (OSA); Application
Programming Interface (API), as identified below. The API specification (ES 203 915) is structured in the following
parts:
Part 1: "Overview";
Part 2: "Common Data Definitions";
Part 3: "Framework";
Part 4: "Call Control";
Part 5: "User Interaction SCF";
Part 6: "Mobility SCF";
Part 7: "Terminal Capabilities SCF";
Part 8: "Data Session Control SCF";
Part 9: "Generic Messaging SCF";
Part 10: "Connectivity Manager SCF";
Part 11: "Account Management SCF";
Part 12: "Charging SCF";
Part 13: "Policy Management SCF";
Part 14: "Presence and Availability Management SCF";
Part 15: "Multi-Media Messaging SCF".
The present document has been defined jointly between ETSI, The Parlay Group (http://www.parlay.org) and the 3GPP,
in co-operation with a number of JAIN™ Community (http://www.java.sun.com/products/jain) member companies.
The present document forms part of the Parlay 5.2 set of specifications.
The present document is equivalent to 3GPP TS 29.198-15 V6.6.0 (Release 6).
ETSI
9 ETSI ES 203 915-15 V1.3.1 (2008-04)
1 Scope
The present document is part 15 of the Stage 3 specification for an Application Programming Interface (API) for Open
Service Access (OSA).
The OSA specifications define an architecture that enables application developers to make use of network functionality
through an open standardised interface, i.e. the OSA APIs.
The present document specifies the Multi Media Messaging Service Capability Feature (SCF) aspects of the interface.
All aspects of the Multi Media Messaging SCF are defined here, these being:
• Sequence Diagrams.
• Class Diagrams.
• Interface specification plus detailed method descriptions.
• State Transition diagrams.
• Data Definitions.
• IDL Description of the interfaces.
The process by which this task is accomplished is through the use of object modelling techniques described by the
Unified Modelling Language (UML).
2 References
The references listed in clause 2 of ES 203 915-1 contain provisions which, through refere
...











