ETSI ES 202 504-15 V1.1.1 (2008-05)
Open Service Access (OSA); Parlay X Web Services; Part 15: Message Broadcast (Parlay X3)
Open Service Access (OSA); Parlay X Web Services; Part 15: Message Broadcast (Parlay X3)
DES/TISPAN-01034-15-OSA
Odprti dostop do storitve (OSA) - Spletne storitve Parlay X - 15. del: Razpršeno oddajanje sporočil (Parlay X3)
General Information
Buy Standard
Standards Content (Sample)
ETSI ES 202 504-15 V1.1.1 (2008-05)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 15: Message Broadcast
(Parlay X 3)
�
---------------------- Page: 1 ----------------------
2 ETSI ES 202 504-15 V1.1.1 (2008-05)
Reference
DES/TISPAN-01034-15-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-15 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.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.14
8.1 Interface: SendBroadcastMessage.14
8.1.1 Operation: sendBroadcastMessage.14
8.1.1.1 Input message: sendBroadcastMessageRequest.15
8.1.1.2 Output message: sendBroadcastMessageResponse.16
8.1.1.3 Referenced faults.16
8.1.2 Operation: getBroadcastStatus.16
8.1.2.1 Input message: getBroadcastStatusRequest .18
8.1.2.2 Output message: getBroadcastStatusResponse.18
8.1.2.3 Referenced faults.18
8.1.3 Operation: cancelBroadcastMessage.19
8.1.3.1 Input message: cancelBroadcastMessageRequest.19
8.1.3.2 Output message: cancelBroadcastMessageResponse.19
8.1.3.3 Referenced faults.19
8.2 Interface: MessageBroadcastNotification.19
8.2.1 Operation: notifyBroadcastDeliveryReceipt.19
8.2.1.1 Input message: notifyBroadcastDeliveryReceiptRequest .20
8.2.1.2 Output message: notifyBroadcastDeliveryReceiptResponse .20
8.2.1.3 Referenced faults.20
8.3 Interface: MessageBroadcastNotificationManager .20
8.3.1 Operation: startDeliveryReceiptNotification .21
8.3.1.1 Input message: startDeliveryReceiptNotificationRequest.21
8.3.1.2 Output message: startDeliveryReceiptNotificationResponse.21
8.3.1.3 Referenced faults.21
8.3.2 Operation: stopDeliveryReceiptNotification .21
8.3.2.1 Input message: stopDeliveryReceiptNotificationRequest .21
8.3.2.2 Output message: stopDeliveryReceiptNotificationResponse.21
ETSI
---------------------- Page: 3 ----------------------
4 ETSI ES 202 504-15 V1.1.1 (2008-05)
8.3.2.3 Referenced faults.22
9 Fault definitions.22
9.1 ServiceException.22
9.1.1 SVC0280: Message too long .22
9.1.2 SVC0283: Delivery Status Notification not supported.22
9.1.3 SVC0300: Broadcast Area not supported .22
9.1.4 SVC0301: Too high load situation .22
9.2 PolicyException.22
9.2.1 POL0330: Multiple areas not allowed .22
9.2.2 POL0331: Maximum Number of Areas exceeded.23
9.2.3 POL0332: Too Many Broadcasts requested .23
9.2.4 POL0333: Min/Max Interval Violation .23
10 Service policies .23
Annex A (normative): WSDL for Message Broadcast.24
Annex B (informative): Bibliography.25
History .26
ETSI
---------------------- Page: 4 ----------------------
5 ETSI ES 202 504-15 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 15 of a multi-part deliverable covering Open Service Access (OSA); Parlay X 3 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-15 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-15 V7.2.0 (Release 7).
ETSI
---------------------- Page: 6 ----------------------
7 ETSI ES 202 504-15 V1.1.1 (2008-05)
1 Scope
The present document is part 15 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 Message Broadcast 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-15 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] ETSI TS 123 041: "Digital cellular telecommunications system (Phase 2+); Universal Mobile
Telecommunications System (UMTS); Technical realization of Cell Broadcast Service (CBS)
(3GPP TS 23.041)".
[4] ETSI TS 123 032: "Digital cellular telecommunications system (Phase 2+); Universal Mobile
Telecommunications System (UMTS); Universal Geographical Area Description (GAD)
(3GPP TS 23.032)".
[5] ETSI ES 202 504-9: "Open Service Access (OSA); Parlay X Web Services; Part 9: Terminal
Location (Parlay X 3)".
[6] ETSI ES 202 504-4: "Open Service Access (OSA); Parlay X Web Services; Part 4: Short
Messaging (Parlay X 3)".
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] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-1 [2], ES 202 504-4 [6] and the
following apply.
CBC Cell Broadcast Centre
CBS Cell Broadcast Service
4 Detailed service description
Message broadcast is 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 purposes as follows:
• To provide area-based public information such as weather, traffic and other information of common interest.
• To provide emergency information such as severe weather warnings (e.g. typhoon, tsunami), environmental
hazards (e.g. chemical spills) and terrorism alerts.
ETSI
---------------------- Page: 8 ----------------------
9 ETSI ES 202 504-15 V1.1.1 (2008-05)
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””;;
….….
SShhoopp mmananagageerr
sendBsendBrrooadadccaastMessagstMessagee((aarea, mrea, mssg, g,
sendsenderNerNaame);me);
} }
SMSMSMSSS SMSMSMSSS SMSMSMSSS SMSMSMSSS
SShhoppiopping mng maallll
bubuyy som someeththing (oing (offfflliinnee))
Figure 1: Send Broadcast Message Scenario
Figure 1 shows an advertising scenario using the Message Broadcast Web Service to broadcast messages describing
shop discount offers inside, and in the vicinity of, a shopping mall. A shop manager who wants to increase sales during
a holiday period can make use of a message broadcast application. By using the application, the manager can set the
targeted area, compose the sales message and identify the shop offering the discount (1). Then, the application uses the
Parlay X interface to invoke the Message Broadcast Web Service operation (2). After invocation, the Message
Broadcast Web Service sends a message delivery operation to the messaging centre, e.g. the CBC (3). Subsequently, the
shop discount message is delivered to all the terminals within the targeted area.
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 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.
ETSI
---------------------- Page: 9 ----------------------
10 ETSI ES 202 504-15 V1.1.1 (2008-05)
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 poll for the delivery status from the Message
Broadcast Web Service. If the application subsequently wishes to abort message broadcasting, it 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 2: Message Broadcast Operations
ETSI
---------------------- Page: 10 ----------------------
11 ETSI ES 202 504-15 V1.1.1 (2008-05)
6.2 Broadcast Status Notification
Pattern: Application Correlated Multiple Notification
An application can request a message be broadcast to multiple areas and, using a specified correlator parameter, can
subsequently be notified of the broadcast delivery status for each area.
: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 3: Message Broadcast Status Notification
ETSI
---------------------- Page: 11 ----------------------
12 ETSI ES 202 504-15 V1.1.1 (2008-05)
7 XML Schema data type definition
7.1 BroadcastStatus Enumeration
List of possible broadcast delivery status values.
Enumeration value 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 value Description
Retrieved Status retrieved, with result in currentStatus element.
Status not retrieved, currentStatus is not provided (does not indicate an error, no attempt may
NotRetrieved
have 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 BroadcastStatus No Broadcast status of this area.
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: 12 ----------------------
13 ETSI ES 202 504-15 V1.1.1 (2008-05)
7.4 BroadcastStatusData Structure
Data structure containing area and its status. As this can be related to a query of multiple areas, the reportStatus
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 longitude values follows the terms defined in
clause 7.1 of ES 202 504-9 [5].
Element name Element type Optional Description
latitude xsd:float No Latitude value of a location
longitude xsd:float No Longitude value of a location
7.6 Circle Structure
Circle representation of a geographical area.
Element name Element type Optional Description
center LocationPoint No The center point of circle
radius xsd:float No Radius of circle (in meters)
7.7 Polygon Structure
Set of coordinates to configure the polygonal type of a geographical area.
Element name Element type Optional Description
locationPoints LocationPoint No Set of location points to make a polygon. See also clause 5.7,
[3.13] 7.3.7 of TS 123 032 [4].
7.8 AreaType Enumeration
This indicates the types of area that may be used by an application to define a broadcast area.
Enumeration value Description
Alias Alias name shared by both application and network
Circle Area represented as a circle shape
Polygon Area represented as a polygon shape
ETSI
---------------------- Page: 13 ----------------------
14 ETSI ES 202 504-15 V1.1.1 (2008-05)
7.9 BroadcastArea Union
Representation methods of broadcast area.
Element name Element type Optional Description
UnionElement AreaType No Type of geographical area. One of the following:
Alias xsd:string Yes An alias name for a geographical area. The alias name shall be
understood and translated by the network.
Circle Circle Yes Circle representation
Polygon Polygon Yes Polygon representation
7.10 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
8 Web Service interface definition
8.1 Interface: SendBroadcastMessage
This interface defines operations to send a broadcast message and to subsequently poll for delivery status. It also defines
an operation to cancel the previous request.
8.1.1 Operation: sendBroadcastMessage
The application invokes the sendBroadcastMessage operation to send a broadcast message into the designated area(s),
respectively specified by the mandatory message and broadcastArea parts:
• If message is longer than the maximum supported length in the network, the message content will be sent as
several concatenated messages. For example a CBS message can consist of up to 15 CBS pages, where each
page contains 82 octets, which, using the default character set, equates to 93 characters per CBS page
(TS 123 041 [3]).
• The broadcastArea is an area (or a set of areas) that are the representation of the geographical area(s) to
which a message is to be delivered. Areas can be defined by an alias name or a geometric shape such as circle
or polygon.
- In the case of an alias, the alias name shall be defined during provisioning and understood by both
application and network.
- In the case of a geometric shape, the network can restrict the maximum and minimum size of an area.
Areas shall be covered by the mobile or wireline network. A message cannot be delivered to terminals that are
out of network coverage even though the application has indicated the area(s) in the sendBroadcastMessage
operation. If a specified area is out-of-coverage, the Message Broadcast Web Service will generate a
ServiceException (SVC0300).
The application can also specify optional parameters as follows:
• senderName specifies the sender's name, i.e. the string that is displayed on the user's terminal as the originator
...
Final draft ETSI ES 202 504-15 V1.1.1 (2008-02)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 15: Message Broadcast
(Parlay X 3)
�
---------------------- Page: 1 ----------------------
2 Final draft ETSI ES 202 504-15 V1.1.1 (2008-02)
Reference
DES/TISPAN-01034-15-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-15 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.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.14
8.1 Interface: SendBroadcastMessage.14
8.1.1 Operation: sendBroadcastMessage.14
8.1.1.1 Input message: sendBroadcastMessageRequest.15
8.1.1.2 Output message: sendBroadcastMessageResponse.16
8.1.1.3 Referenced faults.16
8.1.2 Operation: getBroadcastStatus.16
8.1.2.1 Input message: getBroadcastStatusRequest .18
8.1.2.2 Output message: getBroadcastStatusResponse.18
8.1.2.3 Referenced faults.18
8.1.3 Operation: cancelBroadcastMessage.19
8.1.3.1 Input message: cancelBroadcastMessageRequest.19
8.1.3.2 Output message: cancelBroadcastMessageResponse.19
8.1.3.3 Referenced faults.19
8.2 Interface: MessageBroadcastNotification.19
8.2.1 Operation: notifyBroadcastDeliveryReceipt.19
8.2.1.1 Input message: notifyBroadcastDeliveryReceiptRequest .20
8.2.1.2 Output message: notifyBroadcastDeliveryReceiptResponse .20
8.2.1.3 Referenced faults.20
8.3 Interface: MessageBroadcastNotificationManager .20
8.3.1 Operation: startDeliveryReceiptNotification .21
8.3.1.1 Input message: startDeliveryReceiptNotificationRequest.21
8.3.1.2 Output message: startDeliveryReceiptNotificationResponse.21
8.3.1.3 Referenced faults.21
8.3.2 Operation: stopDeliveryReceiptNotification .21
8.3.2.1 Input message: stopDeliveryReceiptNotificationRequest .21
8.3.2.2 Output message: stopDeliveryReceiptNotificationResponse.21
ETSI
---------------------- Page: 3 ----------------------
4 Final draft ETSI ES 202 504-15 V1.1.1 (2008-02)
8.3.2.3 Referenced faults.22
9 Fault definitions.22
9.1 ServiceException.22
9.1.1 SVC0280: Message too long .22
9.1.2 SVC0283: Delivery Status Notification not supported.22
9.1.3 SVC0300: Broadcast Area not supported .22
9.1.4 SVC0301: Too high load situation .22
9.2 PolicyException.22
9.2.1 POL0330: Multiple areas not allowed .22
9.2.2 POL0331: Maximum Number of Areas exceeded.23
9.2.3 POL0332: Too Many Broadcasts requested .23
9.2.4 POL0333: Min/Max Interval Violation .23
10 Service policies .23
Annex A (normative): WSDL for Message Broadcast.24
Annex B (informative): Bibliography.25
History .26
ETSI
---------------------- Page: 4 ----------------------
5 Final draft ETSI ES 202 504-15 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 15 of a multi-part deliverable covering Open Service Access (OSA); Parlay X 3 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-15 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-15 V7.2.0 (Release 7).
ETSI
---------------------- Page: 6 ----------------------
7 Final draft ETSI ES 202 504-15 V1.1.1 (2008-02)
1 Scope
The present document is part 15 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 Message Broadcast 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-15 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] ETSI TS 123 041: "Digital cellular telecommunications system (Phase 2+); Universal Mobile
Telecommunications System (UMTS); Technical realization of Cell Broadcast Service (CBS)
(3GPP TS 23.041)".
[4] ETSI TS 123 032: "Digital cellular telecommunications system (Phase 2+); Universal Mobile
Telecommunications System (UMTS); Universal Geographical Area Description (GAD)
(3GPP TS 23.032)".
[5] ETSI ES 202 504-9: "Open Service Access (OSA); Parlay X Web Services; Part 9: Terminal
Location (Parlay X 3)".
[6] ETSI ES 202 504-4: "Open Service Access (OSA); Parlay X Web Services; Part 4: Short
Messaging (Parlay X 3)".
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] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-1 [2], ES 202 504-4 [6] and the
following apply.
CBC Cell Broadcast Centre
CBS Cell Broadcast Service
4 Detailed service description
Message broadcast is 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 purposes as follows:
• To provide area-based public information such as weather, traffic and other information of common interest.
• To provide emergency information such as severe weather warnings (e.g. typhoon, tsunami), environmental
hazards (e.g. chemical spills) and terrorism alerts.
ETSI
---------------------- Page: 8 ----------------------
9 Final draft ETSI ES 202 504-15 V1.1.1 (2008-02)
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 1: Send Broadcast Message Scenario
Figure 1 shows an advertising scenario using the Message Broadcast Web Service to broadcast messages describing
shop discount offers inside, and in the vicinity of, a shopping mall. A shop manager who wants to increase sales during
a holiday period can make use of a message broadcast application. By using the application, the manager can set the
targeted area, compose the sales message and identify the shop offering the discount (1). Then, the application uses the
Parlay X interface to invoke the Message Broadcast Web Service operation (2). After invocation, the Message
Broadcast Web Service sends a message delivery operation to the messaging centre, e.g. the CBC (3). Subsequently, the
shop discount message is delivered to all the terminals within the targeted area.
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 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.
ETSI
---------------------- Page: 9 ----------------------
10 Final draft ETSI ES 202 504-15 V1.1.1 (2008-02)
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 poll for the delivery status from the Message
Broadcast Web Service. If the application subsequently wishes to abort message broadcasting, it 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 2: Message Broadcast Operations
ETSI
---------------------- Page: 10 ----------------------
11 Final draft ETSI ES 202 504-15 V1.1.1 (2008-02)
6.2 Broadcast Status Notification
Pattern: Application Correlated Multiple Notification
An application can request a message be broadcast to multiple areas and, using a specified correlator parameter, can
subsequently be notified of the broadcast delivery status for each area.
: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 3: Message Broadcast Status Notification
ETSI
---------------------- Page: 11 ----------------------
12 Final draft ETSI ES 202 504-15 V1.1.1 (2008-02)
7 XML Schema data type definition
7.1 BroadcastStatus Enumeration
List of possible broadcast delivery status values.
Enumeration value 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 value Description
Retrieved Status retrieved, with result in currentStatus element.
Status not retrieved, currentStatus is not provided (does not indicate an error, no attempt may
NotRetrieved
have 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 BroadcastStatus No Broadcast status of this area.
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: 12 ----------------------
13 Final draft ETSI ES 202 504-15 V1.1.1 (2008-02)
7.4 BroadcastStatusData Structure
Data structure containing area and its status. As this can be related to a query of multiple areas, the reportStatus
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 longitude values follows the terms defined in
clause 7.1 of ES 202 504-9 [5].
Element name Element type Optional Description
latitude xsd:float No Latitude value of a location
longitude xsd:float No Longitude value of a location
7.6 Circle Structure
Circle representation of a geographical area.
Element name Element type Optional Description
center LocationPoint No The center point of circle
radius xsd:float No Radius of circle (in meters)
7.7 Polygon Structure
Set of coordinates to configure the polygonal type of a geographical area.
Element name Element type Optional Description
locationPoints LocationPoint No Set of location points to make a polygon. See also clause 5.7,
[3.13] 7.3.7 of TS 123 032 [4].
7.8 AreaType Enumeration
This indicates the types of area that may be used by an application to define a broadcast area.
Enumeration value Description
Alias Alias name shared by both application and network
Circle Area represented as a circle shape
Polygon Area represented as a polygon shape
ETSI
---------------------- Page: 13 ----------------------
14 Final draft ETSI ES 202 504-15 V1.1.1 (2008-02)
7.9 BroadcastArea Union
Representation methods of broadcast area.
Element name Element type Optional Description
UnionElement AreaType No Type of geographical area. One of the following:
Alias xsd:string Yes An alias name for a geographical area. The alias name shall be
understood and translated by the network.
Circle Circle Yes Circle representation
Polygon Polygon Yes Polygon representation
7.10 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
8 Web Service interface definition
8.1 Interface: SendBroadcastMessage
This interface defines operations to send a broadcast message and to subsequently poll for delivery status. It also defines
an operation to cancel the previous request.
8.1.1 Operation: sendBroadcastMessage
The application invokes the sendBroadcastMessage operation to send a broadcast message into the designated area(s),
respectively specified by the mandatory message and broadcastArea parts:
• If message is longer than the maximum supported length in the network, the message content will be sent as
several concatenated messages. For example a CBS message can consist of up to 15 CBS pages, where each
page contains 82 octets, which, using the default character set, equates to 93 characters per CBS page
(TS 123 041 [3]).
• The broadcastArea is an area (or a set of areas) that are the representation of the geographical area(s) to
which a message is to be delivered. Areas can be defined by an alias name or a geometric shape such as circle
or polygon.
- In the case of an alias, the alias name shall be defined during provisioning and understood by both
application and network.
- In the case of a geometric shape, the network can restrict the maximum and minimum size of an area.
Areas shall be covered by the mobile or wireline network. A message cannot be delivered to terminals that are
out of network coverage even though the application has indicated the area(s) in the sendBroadcastMessage
operation. If a specified area is out-of-coverage, the Message Broadca
...
SLOVENSKI STANDARD
SIST ES 202 504-15 V1.1.1:2008
01-september-2008
2GSUWLGRVWRSGRVWRULWYH 26$ 6SOHWQHVWRULWYH3DUOD\;GHO 5D]SUãHQR
RGGDMDQMHVSRURþLO 3DUOD\;
Open Service Access (OSA) - Parlay X Web Services - Part 15: Message Broadcast
(Parlay X3)
Ta slovenski standard je istoveten z: ES 202 504-15 Version 1.1.1
ICS:
35.100.01 Medsebojno povezovanje Open systems
odprtih sistemov na splošno interconnection in general
SIST ES 202 504-15 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-15 V1.1.1:2008
---------------------- Page: 2 ----------------------
SIST ES 202 504-15 V1.1.1:2008
ETSI ES 202 504-15 V1.1.1 (2008-05)
ETSI Standard
Open Service Access (OSA);
Parlay X Web Services;
Part 15: Message Broadcast
(Parlay X 3)
�
---------------------- Page: 3 ----------------------
SIST ES 202 504-15 V1.1.1:2008
2 ETSI ES 202 504-15 V1.1.1 (2008-05)
Reference
DES/TISPAN-01034-15-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-15 V1.1.1:2008
3 ETSI ES 202 504-15 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.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.14
8.1 Interface: SendBroadcastMessage.14
8.1.1 Operation: sendBroadcastMessage.14
8.1.1.1 Input message: sendBroadcastMessageRequest.15
8.1.1.2 Output message: sendBroadcastMessageResponse.16
8.1.1.3 Referenced faults.16
8.1.2 Operation: getBroadcastStatus.16
8.1.2.1 Input message: getBroadcastStatusRequest .18
8.1.2.2 Output message: getBroadcastStatusResponse.18
8.1.2.3 Referenced faults.18
8.1.3 Operation: cancelBroadcastMessage.19
8.1.3.1 Input message: cancelBroadcastMessageRequest.19
8.1.3.2 Output message: cancelBroadcastMessageResponse.19
8.1.3.3 Referenced faults.19
8.2 Interface: MessageBroadcastNotification.19
8.2.1 Operation: notifyBroadcastDeliveryReceipt.19
8.2.1.1 Input message: notifyBroadcastDeliveryReceiptRequest .20
8.2.1.2 Output message: notifyBroadcastDeliveryReceiptResponse .20
8.2.1.3 Referenced faults.20
8.3 Interface: MessageBroadcastNotificationManager .20
8.3.1 Operation: startDeliveryReceiptNotification .21
8.3.1.1 Input message: startDeliveryReceiptNotificationRequest.21
8.3.1.2 Output message: startDeliveryReceiptNotificationResponse.21
8.3.1.3 Referenced faults.21
8.3.2 Operation: stopDeliveryReceiptNotification .21
8.3.2.1 Input message: stopDeliveryReceiptNotificationRequest .21
8.3.2.2 Output message: stopDeliveryReceiptNotificationResponse.21
ETSI
---------------------- Page: 5 ----------------------
SIST ES 202 504-15 V1.1.1:2008
4 ETSI ES 202 504-15 V1.1.1 (2008-05)
8.3.2.3 Referenced faults.22
9 Fault definitions.22
9.1 ServiceException.22
9.1.1 SVC0280: Message too long .22
9.1.2 SVC0283: Delivery Status Notification not supported.22
9.1.3 SVC0300: Broadcast Area not supported .22
9.1.4 SVC0301: Too high load situation .22
9.2 PolicyException.22
9.2.1 POL0330: Multiple areas not allowed .22
9.2.2 POL0331: Maximum Number of Areas exceeded.23
9.2.3 POL0332: Too Many Broadcasts requested .23
9.2.4 POL0333: Min/Max Interval Violation .23
10 Service policies .23
Annex A (normative): WSDL for Message Broadcast.24
Annex B (informative): Bibliography.25
History .26
ETSI
---------------------- Page: 6 ----------------------
SIST ES 202 504-15 V1.1.1:2008
5 ETSI ES 202 504-15 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 15 of a multi-part deliverable covering Open Service Access (OSA); Parlay X 3 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-15 V1.1.1:2008
6 ETSI ES 202 504-15 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-15 V7.2.0 (Release 7).
ETSI
---------------------- Page: 8 ----------------------
SIST ES 202 504-15 V1.1.1:2008
7 ETSI ES 202 504-15 V1.1.1 (2008-05)
1 Scope
The present document is part 15 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 Message Broadcast 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-15 V1.1.1:2008
8 ETSI ES 202 504-15 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] ETSI TS 123 041: "Digital cellular telecommunications system (Phase 2+); Universal Mobile
Telecommunications System (UMTS); Technical realization of Cell Broadcast Service (CBS)
(3GPP TS 23.041)".
[4] ETSI TS 123 032: "Digital cellular telecommunications system (Phase 2+); Universal Mobile
Telecommunications System (UMTS); Universal Geographical Area Description (GAD)
(3GPP TS 23.032)".
[5] ETSI ES 202 504-9: "Open Service Access (OSA); Parlay X Web Services; Part 9: Terminal
Location (Parlay X 3)".
[6] ETSI ES 202 504-4: "Open Service Access (OSA); Parlay X Web Services; Part 4: Short
Messaging (Parlay X 3)".
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] apply.
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in ES 202 504-1 [2], ES 202 504-4 [6] and the
following apply.
CBC Cell Broadcast Centre
CBS Cell Broadcast Service
4 Detailed service description
Message broadcast is 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 purposes as follows:
• To provide area-based public information such as weather, traffic and other information of common interest.
• To provide emergency information such as severe weather warnings (e.g. typhoon, tsunami), environmental
hazards (e.g. chemical spills) and terrorism alerts.
ETSI
---------------------- Page: 10 ----------------------
SIST ES 202 504-15 V1.1.1:2008
9 ETSI ES 202 504-15 V1.1.1 (2008-05)
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””;;
….….
SShhoopp mmananagageerr
sendBsendBrrooadadccaastMessagstMessagee((aarea, mrea, mssg, g,
sendsenderNerNaame);me);
} }
SMSMSMSSS SMSMSMSSS SMSMSMSSS SMSMSMSSS
SShhoppiopping mng maallll
bubuyy som someeththing (oing (offfflliinnee))
Figure 1: Send Broadcast Message Scenario
Figure 1 shows an advertising scenario using the Message Broadcast Web Service to broadcast messages describing
shop discount offers inside, and in the vicinity of, a shopping mall. A shop manager who wants to increase sales during
a holiday period can make use of a message broadcast application. By using the application, the manager can set the
targeted area, compose the sales message and identify the shop offering the discount (1). Then, the application uses the
Parlay X interface to invoke the Message Broadcast Web Service operation (2). After invocation, the Message
Broadcast Web Service sends a message delivery operation to the messaging centre, e.g. the CBC (3). Subsequently, the
shop discount message is delivered to all the terminals within the targeted area.
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 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.
ETSI
---------------------- Page: 11 ----------------------
SIST ES 202 504-15 V1.1.1:2008
10 ETSI ES 202 504-15 V1.1.1 (2008-05)
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 poll for the delivery status from the Message
Broadcast Web Service. If the application subsequently wishes to abort message broadcasting, it 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 2: Message Broadcast Operations
ETSI
---------------------- Page: 12 ----------------------
SIST ES 202 504-15 V1.1.1:2008
11 ETSI ES 202 504-15 V1.1.1 (2008-05)
6.2 Broadcast Status Notification
Pattern: Application Correlated Multiple Notification
An application can request a message be broadcast to multiple areas and, using a specified correlator parameter, can
subsequently be notified of the broadcast delivery status for each area.
: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 3: Message Broadcast Status Notification
ETSI
---------------------- Page: 13 ----------------------
SIST ES 202 504-15 V1.1.1:2008
12 ETSI ES 202 504-15 V1.1.1 (2008-05)
7 XML Schema data type definition
7.1 BroadcastStatus Enumeration
List of possible broadcast delivery status values.
Enumeration value 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 value Description
Retrieved Status retrieved, with result in currentStatus element.
Status not retrieved, currentStatus is not provided (does not indicate an error, no attempt may
NotRetrieved
have 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 BroadcastStatus No Broadcast status of this area.
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: 14 ----------------------
SIST ES 202 504-15 V1.1.1:2008
13 ETSI ES 202 504-15 V1.1.1 (2008-05)
7.4 BroadcastStatusData Structure
Data structure containing area and its status. As this can be related to a query of multiple areas, the reportStatus
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 longitude values follows the terms defined in
clause 7.1 of ES 202 504-9 [5].
Element name Element type Optional Description
latitude xsd:float No Latitude value of a location
longitude xsd:float No Longitude value of a location
7.6 Circle Structure
Circle representation of a geographical area.
Element name Element type Optional Description
center LocationPoint No The center point of circle
radius xsd:float No Radius of circle (in meters)
7.7 Polygon Structure
Set of coordinates to configure the polygonal type of a geographical area.
Element name Element type Optional Description
locationPoints LocationPoint No Set of location points to make a polygon. See also clause 5.7,
[3.13] 7.3.7 of TS 123 032 [4].
7.8 AreaType Enumeration
This indicates the types of area that may be used by an application to define a broadcast area.
Enumeration value Description
Alias Alias name shared by both application and network
Circle Area represented as a circle shape
Polygon Area represented as a polygon shape
ETSI
---------------------- Page: 15 ----------------------
SIST ES 202 504-15 V1.1.1:2008
14 ETSI ES 202 504-15 V1.1.1 (2008-05)
7.9 BroadcastArea Union
Representation methods of broadcast area.
Element name Element type Optional Description
UnionElement AreaType No Type of geographical area. One of the following:
Alias xsd:string Yes An alias name for a geographical area. The alias name shall be
understood and translated by the network.
Circle Circle Yes Circle representation
Polygon Polygon Yes Polygon representation
7.10 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
8 Web Service interface definition
8.1 Interface: SendBroadcastMessage
This interface defines operations to send a broadcast message and to subsequently poll for delivery status. It also defines
an operation to cancel the previous request.
8.1.1 Operation: sendBroadcastMessage
The application invokes the sendBroadcastMessage operation to send a broadcast message into the designated area(s),
respectively specified by the mandatory message and broadcastArea parts:
• If message is longer than the maximum supported length in the network, the message content will be sent as
s
...
Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.