ETSI TS 129 199-15 V7.2.1 (2008-01)

Universal Mobile Telecommunications System (UMTS); Open Service Access (OSA); Parlay X web services; Part 15: Message broadcast (3GPP TS 29.199-15 version 7.2.1 Release 7)

RTS/TSGC-0529199-15v721

General Information

• Status: Published
• Publication Date: 28-Jan-2008
• Technical Committee: 3GPP CT 5 - OSA (formely CN5)
• Current Stage: 12 - Completion
• Due Date: 26-Dec-2007
• Completion Date: 29-Jan-2008

Standards Content (Sample)

ETSI TS 129 199-15 V7.2.1 (2008-01)
Technical Specification


Universal Mobile Telecommunications System (UMTS);
Open Service Access (OSA);
Parlay X web services;
Part 15: Message broadcast
(3GPP TS 29.199-15 version 7.2.1 Release 7)




�

---------------------- Page: 1 ----------------------
3GPP TS 29.199-15 version 7.2.1 Release 7 1 ETSI TS 129 199-15 V7.2.1 (2008-01)



Reference
RTS/TSGC-0529199-15v721
Keywords
UMTS
ETSI
650 Route des Lucioles
F-06921 Sophia Antipolis Cedex - FRANCE

Tel.: [phone]  Fax: [phone]

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.
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 ----------------------
3GPP TS 29.199-15 version 7.2.1 Release 7 2 ETSI TS 129 199-15 V7.2.1 (2008-01)
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 Technical Specification (TS) has been produced by ETSI 3rd Generation Partnership Project (3GPP).
The present document may refer to technical specifications or reports using their 3GPP identities, UMTS identities or
GSM identities. These should be interpreted as being references to the corresponding ETSI deliverables.
The cross reference between GSM, UMTS, 3GPP and ETSI identities can be found under
http://webapp.etsi.org/key/queryform.asp.
ETSI

---------------------- Page: 3 ----------------------
3GPP TS 29.199-15 version 7.2.1 Release 7 3 ETSI TS 129 199-15 V7.2.1 (2008-01)
Contents
Intellectual Property Rights.2
Foreword.2
Foreword.5
Introduction .5
1 Scope.6
2 References.6
3 Definitions and abbreviations.7
3.1 Definitions.7
3.2 Abbreviations.7
4 Detailed service description .8
5 Namespaces.9
6 Sequence Diagrams.10
6.1 Send broadcast message, get the status and cancel it .10
6.2 Broadcast Status Notification .11
7 XML Schema data type definition .12
7.1 BroadcastStatus Enumeration.12
7.2 RetrievalStatus Enumeration.12
7.3 BroadcastStatusInformation Structure.12
7.4 BroadcastStatusData Structure.13
7.5 LocationPoint Structure.13
7.6 Circle Structure.13
7.7 Polygon Structure.13
7.8 AreaType Enumeration.13
7.9 BroadcastArea Union.14
7.10 MessagePriority Enumeration.14
8 Web Service interface definition.15
8.1 Interface: SendBroadcastMessage.15
8.1.1 Operation: sendBroadcastMessage.15
8.1.1.1 Input message: sendBroadcastMessageRequest.16
8.1.1.2 Output message : sendBroadcastMessageResponse.16
8.1.1.3 Referenced faults.16
8.1.2 Operation: getBroadcastStatus.17
8.1.2.1 Input message: getBroadcastStatusRequest .19
8.1.2.2 Output message : getBroadcastStatusResponse .19
8.1.2.3 Referenced faults.19
8.1.3 Operation: cancelBroadcastMessage.21
8.1.3.1 Input message: cancelBroadcastMessageRequest.21
8.1.3.2 Output message : cancelBroadcastMessageResponse.21
8.1.3.3 Referenced faults.21
8.2 Interface: MessageBroadcastNotification.22
8.2.1 Operation: notifyBroadcastDeliveryReceipt.22
8.2.1.1 Input message: notifyBroadcastDeliveryReceiptRequest .23
8.2.1.2 Output message : notifyBroadcastDeliveryReceiptResponse .23
8.2.1.3 Referenced faults.23
8.3 Interface: MessageBroadcastNotificationManager .23
8.3.1 Operation: startDeliveryReceiptNotification .24
8.3.1.1 Input message: startDeliveryReceiptNotificationRequest.24
8.3.1.2 Output message: startDeliveryReceiptNotificationResponse.24
8.3.1.3 Referenced faults.24
8.3.2 Operation: stopDeliveryReceiptNotification .25
ETSI

---------------------- Page: 4 ----------------------
3GPP TS 29.199-15 version 7.2.1 Release 7 4 ETSI TS 129 199-15 V7.2.1 (2008-01)
8.3.2.1 Input message: stopDeliveryReceiptNotificationRequest .25
8.3.2.2 Output message: stopDeliveryReceiptNotificationResponse.25
8.3.2.3 Referenced faults.25
9 Fault definitions.26
9.1 ServiceException.26
9.1.1 SVC0280: Message too long .26
9.1.2 SVC0283: Delivery Status Notification not supported.26
9.1.3 SVC0300: Broadcast Area not supported .26
9.1.4 SVC0301: Too high load situation .26
9.2 PolicyException.26
9.2.1 POL0330: Multiple areas not allowed .26
9.2.2 POL0331: Maximum Number of Areas exceeded.26
9.2.3 POL0332: Too Many Broadcasts requested .26
9.2.4 POL0333: Min/Max Interval Violation .27
10 Service policies .27
Annex A (normative): WSDL for Message Broadcast.28
Annex B (informative): Description of Parlay X Web Services Part 15: Message Broadcast
for 3GPP2 cdma2000 networks .29
B.1 General Exceptions.29
B.2 Specific Exceptions.29
B.2.1 Clause 1: Scope .29
B.2.2 Clause 2: References .29
B.2.3 Clause 3: Definitions and abbreviations.29
B.2.4 Clause 4: Detailed service description.29
B.2.5 Clause 5: Namespaces .29
B.2.6 Clause 6: Sequence diagrams .30
B.2.7 Clause 7: XML Schema data type definition.30
B.2.8 Clause 8: Web Service interface definition .30
B.2.9 Clause 9: Fault definitions.30
B.2.10 Clause 10: Service policies.30
B.2.11 Annex A (normative):WSDL for Message Broadcast.30
Annex C (informative): Change history .31
History .32

ETSI

---------------------- Page: 5 ----------------------
3GPP TS 29.199-15 version 7.2.1 Release 7 5 ETSI TS 129 199-15 V7.2.1 (2008-01)
Foreword
rd
This Technical Specification has been produced by the 3 Generation Partnership Project (3GPP).
3GPP acknowledges the contribution of the Parlay X Web Services specifications from The Parlay Group. The Parlay
Group is pleased to see 3GPP acknowledge and publish the present document, and the Parlay Group looks forward to
working with the 3GPP community to improve future versions of the present document.
The contents of the present document are subject to continuing work within the TSG and may change following formal
TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an
identifying change of release date and an increase in version number as follows:
Version x.y.z
where:
x the first digit:
1 presented to TSG for information;
2 presented to TSG for approval;
3 or greater indicates TSG approved document under change control.
y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections,
updates, etc.
z the third digit is incremented when editorial only changes have been incorporated in the document.
Introduction
rd
The present document is part 15 of a multi-part deliverable covering the 3 Generation Partnership Project; Technical
Specification Group Core Network and Terminals; 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: 6 ----------------------
3GPP TS 29.199-15 version 7.2.1 Release 7 6 ETSI TS 129 199-15 V7.2.1 (2008-01)
1 Scope
The present document is Part 15 of the Stage 3 Parlay X 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 concepts and the functional architecture for the OSA are
contained in 3GPP TS 23.198 [3]. The requirements for OSA are contained in 3GPP TS 22.127 [2].
The present document specifies the Message Broadcast Web Service aspects of the interface. All aspects of the Message
Broadcast Web Service are defined here, these being:
• Name spaces.
• Sequence diagrams.
• Data definitions.
• Interface specification plus detailed method descriptions.
• Fault definitions.
• Service policies.
• WSDL description of the interfaces.
The present document has been defined jointly between 3GPP TSG CT WG5, ETSI TISPAN and The Parlay Group.
2 References
The following documents contain provisions which, through reference in this text, constitute provisions of the present
document.
• References are either specific (identified by date of publication, edition number, version number, etc.) or
non-specific.
• For a specific reference, subsequent revisions do not apply.
• For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including
a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same
Release as the present document.
[1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".
[2] 3GPP TS 22.127: "Service requirement for the Open Services Access (OSA); Stage 1".
[3] 3GPP TS 23.198: "Open Service Access (OSA); Stage 2".
[4] 3GPP TS 22.101: "Service aspects; Service principles".
[5] W3C Recommendation (2 May 2001): "XML Schema Part 2: Datatypes".
NOTE: Available at http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/.
[6] 3GPP TS 29.199-1: "Open Service Access (OSA); Parlay X web services; Part 1: Common".
[7] 3GPP TS 23.041: "Technical realization of Cell Broadcast Service (CBS)".
[8] 3GPP TS 23.032: "Universal Geographical Area Description (GAD)".
[9] 3GPP TS 29.199-9: "Open Service Access (OSA); Parlay X web services; Part 9: Terminal
location".
ETSI

---------------------- Page: 7 ----------------------
3GPP TS 29.199-15 version 7.2.1 Release 7 7 ETSI TS 129 199-15 V7.2.1 (2008-01)
[10] 3GPP TS 29.199-4: "Open Service Access (OSA); Parlay X web services; Part 4: Short
messaging".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and
3GPP TS 29.199-1 [6] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1], 3GPP TS 29.199-1 [6],
3GPP TS 29.199-4 [10] and the following apply:
CBC Cell Broadcast Centre
CBS Cell Broadcast Service
ETSI

---------------------- Page: 8 ----------------------
3GPP TS 29.199-15 version 7.2.1 Release 7 8 ETSI TS 129 199-15 V7.2.1 (2008-01)
4 Detailed service description
Message broadcast is a functionality that allows an application to send messages to all the fixed or mobile terminals in a
specified geographical area.
Message broadcast provides operations for sending a broadcast message to the network and a polling mechanism for
monitoring the delivery status of a sent broadcast message. It also provides an asynchronous notification mechanism for
broadcast delivery status. In addition, a mechanism is provided to start and stop the notification of delivery receipts.
There are various use cases of using Message Broadcast Web Service including the commercial application. This Web
Service could be also used for non-commercial purpose as follows:
• To provide area-based public information like weather, traffic and other commonly-interested information.
• To provide emergency information like severe weather warning(e.g. typhoon, tsunami), environments
hazards(e.g. chemical spills) and terrorism information.
MMeessassagege B Brrooaaddcascastt
WeWeb Serb Servvicicee
333
PPaarlarlayy X X I/I/FF
MMeesssaginsaging Cg Ceenntterer
SOSOAAPP (e.g., C(e.g., CBBCC))
222
111
mmobilobilee
fifixedxed
bbrrodcastCodcastCoupoupon( )on( )
nenettwwoorrkk
nenettwwoorrkk
{{
arareaea = = se setAtArea();rea();
mmssgg == “2 hours,  “2 hours,
2020%% di discount”;scount”;
senderNsenderNaammee == “ “GGAAPP””;;
….….
SShhopop m maannaagegerr
sendBsendBrrooadadccaastMessagstMessagee((aarea, mrea, mssg, g,
sendsenderNerNaame);me);
} } SMSMSMSSS SMSMSMSSS SMSMSMSSS SMSMSMSSS
SShhoppiopping mng maallll
bubuyy som someeththing (oing (offfflliinnee))

Figure 4.1: Send Broadcast Message Scenario
Figure 4.1 shows an advertising scenario using Message Broadcast Web Service to broadcast discount message around
and within the shopping mall area. A shop manager who wants to increase sales in a holiday can make use of a message
broadcast application. By using the application, he can set the targeted area and write a message and the sender's name
to be contacted (1). Then, the application invokes a Parlay X interface to use Message Broadcast Web Service
operation(2). After invocation, the Message Broadcast Web Service sends a message delivery operation to messaging
centre (e.g. CBC) (3). Subsequently, the message on discount information is delivered to all the terminals within the
targeted area.
ETSI

---------------------- Page: 9 ----------------------
3GPP TS 29.199-15 version 7.2.1 Release 7 9 ETSI TS 129 199-15 V7.2.1 (2008-01)
5 Namespaces
The SendBroadcastMessage interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/message_broadcast/send/v3_1
The MessageBroadcastNotification interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/message_broadcast/notification/v3_1
The MessageBroadcastNotificationManager interface uses the namespace:
http://www.csapi.org/wsdl/parlayx/message_broadcast/notification_manager/v3_0
The data types are defined in the namespace:
http://www.csapi.org/schema/parlayx/message_broadcast/v3_1
The 'xsd' namespace used in the present document refers to the XML Schema data types defined in XML Schema [5].
The use of the name 'xsd' is not semantically significant.
ETSI

---------------------- Page: 10 ----------------------
3GPP TS 29.199-15 version 7.2.1 Release 7 10 ETSI TS 129 199-15 V7.2.1 (2008-01)
6 Sequence Diagrams
6.1 Send broadcast message, get the status and cancel it
Pattern: Request/Response, One way
An application can send a broadcast message to a specific area and also get the delivery status from Message Broadcast
Web services. If message broadcasting is no more needed, an application can send a cancellation request.
:Message
:Application
Broadcast
send broadcast message
message identifier
get the status
retrieve broadcast status
broadcast status info
cancel the previous request

Figure 6.1: Message Broadcast Operations
ETSI

---------------------- Page: 11 ----------------------
3GPP TS 29.199-15 version 7.2.1 Release 7 11 ETSI TS 129 199-15 V7.2.1 (2008-01)
6.2 Broadcast Status Notification
Pattern: Application Correlated Multiple Notification
An application can be notified of a broadcast delivery status of a specific area which is identified by correlator.
:Message :Notification :Notification
:Application
Broadcast Application Web Service
create correlator
send broadcast message
to multiple areas
Some times later, the completion of broadcasting
triggers a status notification for each area
status notification
status notification
status notification

Figure 6.2: Message Broadcast Status Notification
ETSI

---------------------- Page: 12 ----------------------
3GPP TS 29.199-15 version 7.2.1 Release 7 12 ETSI TS 129 199-15 V7.2.1 (2008-01)
7 XML Schema data type definition
7.1 BroadcastStatus Enumeration
List of possible broadcast delivery status values.
Enumeration Description
MessageWaiting The message is still queued and not delivered to the network yet. Broadcasting
has not commenced.
Broadcasting Broadcasting is initiated and the network is still attempting to deliver messages:
i.e. as many times as requested in the totalBroadcasts part of the
sendBroadcastMessageRequest message.
Broadcasted A final state that indicates broadcast requests were successfully delivered to
network: i.e. as many times as requested.
BroadcastImpossible Delivery of broadcast message is impossible. Reasons include: 'out of network
coverage', 'network overloads', 'expiry of valid period'.
BroadcastUnknown Delivery status unknown: e.g. delivery requested but no response.
BroadcastNotificationNotSupported Unable to provide broadcast delivery receipt notification. The
notifyBroadcastDeliveryReceipt operation will return
'BroadcastNotificationNotSupported' to indicate that delivery receipt for the
specified area in a sendBroadcastMessageRequest message is not supported.

7.2 RetrievalStatus Enumeration
Enumeration of the status items that are related to an individual retrieval in a set, as described in clause 7.4.
Enumeration Description
Retrieved Status retrieved, with result in currentStatus element.
Status not retrieved, currentStatus is not provided (does not indicate an error, no attempt may have
NotRetrieved
been made).
Error Error retrieving status.

7.3 BroadcastStatusInformation Structure
This indicates a broadcast status information of an area. It includes a mandatory broadcast status value with optional
values to provide additional information such as the number of broadcasts, success rate, broadcast end time.
Element name Element type Optional Description
status BroadcastStat No Broadcast status of this area.
us
numberOfBroadcasts xsd :int Yes The number of broadcasts successfully sent out. This is
optional and present only if status is either Broadcasting or
Broadcasted.
successRate xsd :int Yes Successful delivery rate expressed as a percentage. This is
optional and present only if status is either Broadcasting or
Broadcasted.
broadcastEndTime xsd :dateTime Yes Completed time of broadcast. This is optional and present only
if status is Broadcasted.

ETSI

---------------------- Page: 13 ----------------------
3GPP TS 29.199-15 version 7.2.1 Release 7 13 ETSI TS 129 199-15 V7.2.1 (2008-01)
7.4 BroadcastStatusData Structure
Data structure containing area and its status. As this can be related to a query of multiple areas, the RetrievalStatus
element is used to indicate whether the status information for an area was retrieved or not, or if an error occurred.
Element name Element type Optional Description
area BroadcastArea No Broadcast area to which status information applies.
reportStatus RetrievalStatus No Status of retrieval for this broadcast area.
currentStatus BroadcastStatusInformation Yes Broadcast status of this area. It is only provided if
reportStatus=Retrieved.
errorInformation common :ServiceError Yes If reportStatus is Error, this is the reason for the error.

7.5 LocationPoint Structure
This is used to describe a location point. The definition of latitude and l
...