ETSI TS 129 116 V15.2.0 (2020-01)

TECHNICAL SPECIFICATION
LTE;
5G;
Representational state transfer over xMB reference point
between content provider and BM-SC
(3GPP TS 29.116 version 15.2.0 Release 15)

3GPP TS 29.116 version 15.2.0 Release 15 1 ETSI TS 129 116 V15.2.0 (2020-01)

Reference
RTS/TSGC-0329116vf20
Keywords
5G,LTE
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
The present document can be downloaded from:
http://www.etsi.org/standards-search
The present document may be made available in electronic versions and/or in print. The content of any electronic and/or
print versions of the present document shall not be modified without the prior written authorization of ETSI. In case of any
existing or perceived difference in contents between such versions and/or in print, the prevailing version of an ETSI
deliverable is the one made publicly available in PDF format at www.etsi.org/deliver.
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
https://portal.etsi.org/TB/ETSIDeliverableStatus.aspx
If you find errors in the present document, please send your comment to one of the following services:
https://portal.etsi.org/People/CommiteeSupportStaff.aspx
Copyright Notification
No part may be reproduced or utilized in any form or by any means, electronic or mechanical, including photocopying
and microfilm except as authorized by written permission of ETSI.
The content of the PDF version shall not be modified without the written authorization of ETSI.
The copyright and the foregoing restriction extend to reproduction in all media.

© ETSI 2020.
All rights reserved.
DECT™, PLUGTESTS™, UMTS™ and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.

3GPP™ and LTE™ are trademarks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
oneM2M™ logo is a trademark of ETSI registered for the benefit of its Members and
of the oneM2M Partners. ®
GSM and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI
3GPP TS 29.116 version 15.2.0 Release 15 2 ETSI TS 129 116 V15.2.0 (2020-01)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables 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 (https://ipr.etsi.org/).
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.
Trademarks
The present document may include trademarks and/or tradenames which are asserted and/or registered by their owners.
ETSI claims no ownership of these except for any which are indicated as being the property of ETSI, and conveys no
right to use or reproduce any trademark and/or tradename. Mention of those trademarks in the present document does
not constitute an endorsement by ETSI of products, services or organizations associated with those trademarks.
Legal Notice
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. These shall be
interpreted as being references to the corresponding ETSI deliverables.
The cross reference between 3GPP and ETSI identities can be found under http://webapp.etsi.org/key/queryform.asp.
Modal verbs terminology
In the present document "shall", "shall not", "should", "should not", "may", "need not", "will", "will not", "can" and
"cannot" are to be interpreted as described in clause 3.2 of the ETSI Drafting Rules (Verbal forms for the expression of
provisions).
"must" and "must not" are NOT allowed in ETSI deliverables except when used in direct citation.
ETSI
3GPP TS 29.116 version 15.2.0 Release 15 3 ETSI TS 129 116 V15.2.0 (2020-01)
Contents
Intellectual Property Rights . 2
Legal Notice . 2
Modal verbs terminology . 2
Foreword . 5
1 Scope . 6
2 References . 6
3 Definitions, symbols and abbreviations . 7
3.1 Definitions . 7
3.2 Abbreviations . 7
4 xMB reference point . 8
4.1 Overview . 8
4.2 Reference model . 8
4.3 Functional ele me nts . 8
4.3.1 BM-SC . 8
4.3.2 Content Provider / Multicast Broadcast Source . 9
4.4 Procedures over xMB reference point . 9
4.4.1 Introduction. 9
4.4.2 Authentication Procedures . 9
4.4.3 Authorization Procedures . 9
4.4.4 Service Management Procedures . 9
4.4.4.1 Create Service . 9
4.4.4.2 Get Service Properties . 9
4.4.4.3 Update Service Properties . 9
4.4.4.4 Delete Service . 10
4.4.4.5 Service Notifications . 10
4.4.5 Session Management Procedures . 10
4.4.5.1 Create Session . 10
4.4.5.2 Get Session Properties. 10
4.4.5.3 Update Session Properties . 10
4.4.5.4 Delete Session . 10
5 xMB API . 10
5.1 Overview . 10
5.1.1 Supported Methods . 10
5.1.2 Error Handling . 11
5.1.3 xMB Entry Point Discovery . 11
5.2 Resources . 12
5.2.1 Services . 12
5.2.1.1 Properties . 12
5.2.1.2 API Operations . 16
5.2.1.2.1 Introduction . 16
5.2.1.2.2 Service Creation . 16
5.2.1.2.3 Service Modification . 17
5.2.1.2.4 Service Deletion . 18
5.2.1.2.5 Service Retrieval . 19
5.2.2 Sessions . 21
5.2.2.1 Properties . 21
5.2.2.2 API Operations . 47
5.2.2.2.1 Introduction . 47
5.2.2.2.2 Session Creation . 47
5.2.2.2.3 Session Modification . 47
5.2.2.2.4 Session Deletion . 49
5.2.2.2.5 Session Retrieval . 50
5.2.3 Reports . 52
ETSI
3GPP TS 29.116 version 15.2.0 Release 15 4 ETSI TS 129 116 V15.2.0 (2020-01)
5.2.3.1 Properties . 53
5.2.3.2 API Operations . 54
5.2.3.2.1 Introduction . 54
5.2.3.2.2 Report Retrieval. 54
5.2.4 Notifications . 58
5.2.4.1 Properties . 58
5.2.4.2 API Operations . 61
5.2.4.2.1 Introduction . 61
5.2.4.2.2 Notification Retrieval . 61
6 User Plane Procedures . 62
6.1 Introduction . 62
6.2 File Session . 63
6.2.1 General . 63
6.2.2 Push Mode . 63
6.2.3 Pull Mode . 63
6.3 Application Session . 63
6.3.1 General . 63
6.3.2 Push Mode . 63
6.33 Pull Mode . 64
6.4 RTP Streaming . 64
6.5 Transport . 65
7 Security. 65
7.1 Overview . 65
7.2 Authentication & Authorization . 65
8 Notification Push to the Content Provider. 65
8.1 Introduction . 65
8.2 Notification Post . 65
9 Feature negotiation . 66
9.1 General . 66
9.2 HTTP custom headers . 67
9.2.1 3gpp-Optional-Features . 67
9.2.2 3gpp-Required-Features . 67
9.2.3 3gpp-Accepted-Features . 68
Annex A (informative): Call Flows . 69
A.1 Introduction . 69
A.2 xMB Procedure example for Live DASH services (MBMS Broadcast only) . 69
A.3 xMB Procedure example for Live DASH services (with Service Continuity) . 72
A.4 xMB Procedure example for File Delivery Services (without File Schedule) . 72
Annex B (normative): JSON Schema . 80
Annex C (informative): Change history . 97
History . 98

ETSI
3GPP TS 29.116 version 15.2.0 Release 15 5 ETSI TS 129 116 V15.2.0 (2020-01)
Foreword
This Technical Specification has been produced by the 3rd Generation Partnership Project (3GPP).
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.
ETSI
3GPP TS 29.116 version 15.2.0 Release 15 6 ETSI TS 129 116 V15.2.0 (2020-01)
1 Scope
The present document describes the REST-based protocol for the xMB reference point between the Content Provider
and the BM-SC. The xMB reference point and related stage 2 protocol procedures are defined in 3GPP TS 23.246 [2]
and in 3GPP TS 26.346 [3].
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 23.246: "Multimedia Broadcast/Multicast Service (MBMS) Architecture and Functional
Description".
[3] 3GPP TS 26.346: "Multimedia Broadcast/Multicast Service (MBMS); Protocols and Codecs".
[4] IETF RFC 5246: "The Transport Layer Security (TLS) Protocol".
[5] Void.
[6] IETF RFC 7231: "Hypertext transfer protocol (HTTP/1.1): Semantics and Content".
[7] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security".
[8] IETF RFC 7235: "Hypertext Transfer Protocol (HTTP/1.1): Authentication"
[9] IETF RFC 4918, "HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)".
[10] 3GPP TS 26.234, "Transparent end-to-end Packet-switched Streaming Service (PSS); Protocols
and codecs".
[11] IETF RFC 3711, "The Secure Real-time Transport Protocol (SRTP)".
[12] IETF RFC 4347, "Datagram Transport Layer Security".
[13] Void
[14] Void.
[15] Void.
[16] Void.
[17] Void.
[18] 3GPP TS 26.247: "Transparent end-to-end Packet-switched Streaming Service (PSS); Progressive
Download and Dynamic Adaptive Streaming over HTTP (3GP-DASH)".
[19] IETF RFC 3926: "FLUTE - File Delivery over Unidirectional Transport".
[20] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting
packet based services and Packet Data Networks (PDN)".
ETSI
3GPP TS 29.116 version 15.2.0 Release 15 7 ETSI TS 129 116 V15.2.0 (2020-01)
[21] 3GPP TS 26.347: "MBMS URLs and APIs".
[22] Open API Initiative, "OpenAPI 2.0 Specification", https://github.com/OAI/OpenAPI-
Specification/blob/master/versions/2.0.md.
[23] 3GPP TS 23.285: "Architecture Enhancements for V2X services".
[24] 3GPP TS 33.246:"3G Security; Security of Multimedia Broadcast/Multicast Service (MBMS)".
[25] 3GPP TS 24.116: "Stage 3 aspects of system architecture enhancements for TV services".
[26] IETF RFC 2617: "HTTP Authentication: Basic and Digest Access Authentication".
[27] IETF RFC 5795: "The Robust Header Compression (ROHC) Framework".
[28] IETF RFC 3095, "Robust Header Compression (ROHC): Framework and four profiles: RTP,
UDP, ESP, and uncompressed"
[29] IETF RFC 6363: "Forward Error Correction (FEC) Framework,".
[30] Void.
[31] IETF RFC 1166: "Internet Numbers".
[32] IETF RFC 5952: "A recommendation for IPv6 address text representation".
3 Definitions, symbols and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and the following
apply. A term defined in the present document takes precedence over the definition of the same term, if any, in
3GPP TR 21.905 [1].
Content Provider: Entity/Entities which supplies/supply content in the form of streaming media or non-real-time
(NRT) files to be delivered to UEs over the 3GPP network, via MBMS Bearer and/or unicast bearer services. Also
referred to in this document as the Multicast Broadcast Source. The Content Provider may reside either inside or outside
the operator's network.
Service: One of the resource types exposed by the RESTful xMB API and operated on by a Content Provider using
HTTP methods. It corresponds to a Content Provider’s service offering for delivery over the MBMS network to UEs.
Each service instance created over the xMB API maps to an MBMS User Service as specified by 3GPP TS 26.346 [3].
The delivery of the contents of a created service is performed during one or more sessions associated with that service.
Session: One of the resource types exposed by the RESTful xMB API and operated on by a Content Provider using
HTTP methods. It represents one or more time intervals during which the MBMS Bearer is active for the transmission
of service contents from the BM-SC to the UE. Each session instance, besides the activity times, may contain various
properties pertaining to transport, media and application level information (session type, session state, data rate,
permitted delay, user plane ingestion mode, targeted delivery area, reporting parameters, identification of content
components delivered during the session, etc.).
3.2 Abbreviations
For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [1] and the following apply. An
abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in
3GPP TR 21.905 [1].
API Application Programming Interface
BM-SC Broadcast Multicast Service Center
CDN Content Delivery Network
CP Content Provider
ETSI
3GPP TS 29.116 version 15.2.0 Release 15 8 ETSI TS 129 116 V15.2.0 (2020-01)
DASH Dynamic Adaptive Streaming over HTTP
FEC Forward Error Correction
FLUTE File Delivery over Unidirectional Transport
HTTP HyperText Transfer Protocol
IS Initialization Segment
JSON JavaScript Object Notation
MPD Media Presentation Description
MSA MBMS Service Area
REST Representational State Transfer
ROHC Robust Header Compression
SACH Service Announcement Channel
SAF Service Announcement Function
SLA Service Level Agreement
TLS Transport Layer Security
TMGI Temporarily Mobile Group Identity
TSI Transport Session Identifier
URI Universal Resource Identifier
WebDAV Web Distributed Authoring and Versioning
V2X Vehicle-to-Everything
4 xMB reference point
4.1 Overview
4.2 Reference model
The xMB reference point resides between the BM-SC and the Content Provider as depicted in Figure 4.2.1. Control-
and user-plane procedures are operated over the xMB-C and xMB-U reference points, respectively. The overall xMB
reference model is depicted in subclause 5.4A of 3GPP TS 26.346 [3].

Figure 4.2.1 xMB reference point
For the V2X Localized User Plane supported feature, the reference model in Annex B.3 of 3GPP TS 23.285 [23]
applies.
4.3 Functional elements
4.3.1 BM-SC
The complete functionality of the BM-SC is defined in 3GPP TS 26.346 [3]. In the context of the xMB reference point,
the BM-SC represents the peer endpoint to the Content Provider in supporting all procedures on the xMB interface.
In addition to the functions defined in 3GPP TS 26.346 [3], the BM-SC may support, for V2X services, the V2X
Localized User Plane procedures as defined in 3GPP TS 23.285 [23] subclause 5.4.2.2 for receiving Local MBMS
information from the Content Provider acting as a V2X Application Server.
ETSI
3GPP TS 29.116 version 15.2.0 Release 15 9 ETSI TS 129 116 V15.2.0 (2020-01)
4.3.2 Content Provider / Multicast Broadcast Source
The functional role of the Content Provider is defined in subclause 4.4.1a of 3GPP TS 26.346 [3]. Using the xMB
reference point, a Content Provider/Multicast Broadcast Source may provide media, as well as service descriptions and
control data, to the BM-SC to set up and manage MBMS User Service(s) from the BM-SC to MBMS clients (the latter
is not depicted in Figure 4.2.1).
In addition, the Content Provider which acts as a V2X Application Server may support V2X Localized User Plane
procedures as defined in 3GPP TS 23.285 [23] subclause 5.4.2.2 for requesting the BM-SC to activate an MBMS bearer
for Local MBMS based MBMS data delivery.
4.4 Procedures over xMB reference point
4.4.1 Introduction
All procedures that operate across the xMB reference point, as specified in subclause 5.4A of 3GPP TS 26.346 [3], are
summarized in the following subclauses.
4.4.2 Authentication Procedures
Authentication procedures shall be performed via (D)TLS as specified by 3GPP TS 33.246 [24]. The Content Provider
shall act as the (D)TLS client and the BM-SC as the (D)TLS server when the Content Provider wants to provision new
services or manage existing services. Similarly, the BM-SC shall act as the client when the BM-SC wishes to send
reports and notifications to the Content Provider. All of the following procedures require the authentication procedure to
be completed successfully.
4.4.3 Authorization Procedures
The authorization procedure of the Content Provider towards the BM-SC may be based on the (D)TLS connection
established as part of the authentication procedure (see subclause 4.4.2). In that case, the BM-SC shall check if the
Content Provider who sent a request over an authenticated (D)TLS connection is authorized to send that specific
request. See subclause 7.2 for further details.
The authorization procedure of the BM-SC towards the Content Provider to allow pushing notifications to the Content
Provider may be based on the (D)TLS connection established as part of the authentication procedure (see subclause
4.4.2). In that case, the Content Provider shall check if the BM-SC who sent the notification over an authenticated (See
subclause 7.2 for further details)(D)TLS connection is authorized to send that specific notification.
4.4.4 Service Management Procedures
4.4.4.1 Create Service
This procedure is used by the Content Provider to create a service at the BM-SC and negotiate the supported features
for the created service. The Content Provider shall use HTTP POST for this purpose. A successfully created service is
associated with a resource identifier which is used by the Content Provider to discover, update and delete the service.
4.4.4.2 Get Service Properties
This procedure is used by the Content Provider to obtain the service properties from the BM-SC. The Content Provider
shall use HTTP GET for this purpose.
4.4.4.3 Update Service Properties
This procedure is used by the Content Provider for updating the service properties at the BM-SC. The Content Provider
shall use HTTP PUT or HTTP PATCH, corresponding to complete or partial update of service properties, respectively,
for this purpose.
ETSI
3GPP TS 29.116 version 15.2.0 Release 15 10 ETSI TS 129 116 V15.2.0 (2020-01)
4.4.4.4 Delete Service
This procedure is used by the Content Provider to terminate the service at the BM-SC. The Content Provider shall use
HTTP DELETE for this purpose.
4.4.4.5 Service Notifications
This procedure is used by the BM-SC to send service related notifications to the Content Provider.
4.4.5 Session Management Procedures
4.4.5.1 Create Session
This procedure is used by the Content Provider to create a session for a previously created service at the BM-SC. The
Content Provider shall use HTTP POST for this purpose. A successfully created session is associated with a resource
identifier which is used by the Content Provider to discover, update and delete the session.
4.4.5.2 Get Session Properties
This procedure is used by the Content Provider to obtain the session properties of a service from the BM-SC. The
Content Provider shall use HTTP GET for this purpose.
4.4.5.3 Update Session Properties
This procedure is used by the Content Provider for updating the session properties of a session at the BM-SC. The
Content Provider shall use HTTP PUT or HTTP PATCH, corresponding to complete or partial update of session
properties, respectively, for this purpose.
If the V2X Localized User Plane feature is supported, the Content Provider may wish to update the session properties
for Local MBMS based MBMS data delivery. If so, and the BM-SC decides to use the Local MBMS information, the
BM-SC shall use the received BM-SC IP address and port for user plane data delivery.
NOTE: The Local MBMS information is pre-configured in the Content Provider. At reception of such
information, the BM-SC will further send the M1 interface information (e.g. MBMS eNB multicast
address and GW source specific multicast address) to the MBMS-GW as specified in
3GPP TS 29.061 [20].
4.4.5.4 Delete Session
This procedure is used by the Content Provider to terminate a session of a service at the BM-SC. The Content Provider
shall use HTTP DELETE for this purpose.
5 xMB API
5.1 Overview
The xMB API is a RESTful API that allows Content Providers to provision broadcast services over 3GPP networks and
subsequent ingestion of service content for distribution using eMBMS. The xMB API defines a set of resources and the
related procedures for the creation and management of broadcast services and sessions are described in subclause 5.2.
The corresponding JSON schema for the representation of the resources and operations defined by the xMB API is
provided in its complete form in Annex B. The syntax follows the rules defined by the OpenAPI specification [22].
5.1.1 Supported Methods
The xMB API follows the RESTful design principles. All operations SHALL be performed using HTTP 1.1
(IETF RFC 7231 [6]) over TLS (3GPP TS 33.246[24]).
Table 5.1.1-1 gives a summary of the supported HTTP methods and their applicability on a per resource basis.
ETSI
3GPP TS 29.116 version 15.2.0 Release 15 11 ETSI TS 129 116 V15.2.0 (2020-01)
Table 5.1.1-1: Summary of supported HTTP methods of xMB API
HTTP Method CRUD Resource PATH
POST Create Service
/xmb/v1.0/services
Session
/xmb/v1.0/services/{service-res-
id}/sessions
GET Read Service /xmb/v1.0/services/{service-res-
id}/sessions/{session-res-id}
Session
/xmb/v1.0/services/{service-res-
id}/sessions/{session-res-id}
Report /xmb/v1.0/reports?query
or
/xmb/v1.0/reports/{report-res-id}
Notification /xmb/v1.0/notifications?query
or
/xmb/v1.0/notifications/{notification-
res-id}
PUT Replace Service /xmb/v1.0/services/{service-res-id}
Session /xmb/v1.0/services/{service-res-
id}/sessions/{session-res-id}
PATCH Modify Service /xmb/v1.0/services/{service-res-id}
Session /xmb/v1.0/services/{service-res-
id}/sessions/{session-res-id}
DELETE Delete Service /xmb/v1.0/services/{service-res-id}
Session /xmb/v1.0/services/{service-res-
id}/sessions/{session-res-id}
5.1.2 Error Handling
The xMB API shall use the HTTP status codes to indicate any errors that might occur in the processing of operations on
xMB resources. Unless defined otherwise, the HTTP status codes shall be interpreted as specified in
IETF RFC 7231 [6]. API operations that are not successfully handled shall not leave the resource at an undefined state.
The response should provide sufficient information for a human operator to understand and locate the error.
API operations that do not follow the security procedures defined in section 7 shall be rejected without any impact on
the resources.
Errors may also happen during the content ingestion and shall be notified to the Content Provider in a timely manner
depending on the severity of the error.
5.1.3 xMB Entry Point Discovery
The Content Provider shall be able to discover the entry point to the xMB interface by one of the following methods:
ETSI
3GPP TS 29.116 version 15.2.0 Release 15 12 ETSI TS 129 116 V15.2.0 (2020-01)
a) It is provided with the URL that serves as the entry point for the xMB-C interface;
b) It acquires that entry point URL from DNS resolution of the following Fully Qualified Domain Name (FQDN):
http://mbmsbs.mnc.mcc.pub.3gppnetwork.org,
in which case the Content Provider shall build the following URL for the entry point of the xMB interface:
http://mbmsbs.mnc.mcc.pub.3gppnetwork.org/xmb/v1.0/.
5.2 Resources
5.2.1 Services
The Content Provider shall configure services at the BM-SC using the REST API methods over two resources managed
at the BM-SC.
Table 5.2.1-1 summarizes different resources for provisioning and managing services at the BM-SC.
Table 5.2.1-1: Resources for managing services at BM-SC
Resource Name Resource Type Description
service Instance resource Represents a single service resource. The Content Provider can
provision or modify a single service at the BM-SC by invoking REST
API requests to this service resource at the BM-SC.
services Collection Resource Represents a collection of service resources.

5.2.1.1 Properties
Each service resource described in Table 5.2.1-1 has the set of properties described in Table 5.2.1.1-1. The Content
Provider shall modify one or more of the properties of the service resource using the API operations described in
subclause 5.2.1.2.
Table 5.2.1.1-1 summarizes different service properties of a service resource.
Table 5.2.1.1-1: Properties of service resource
Property Token JSON Value Defaults Property Description A
Type
Child Units Values
Paramete
r
None N/A Identifies the MBMS User Service as
service-id string defined in subclause 11.2.1.1 of
3GPP TS 26.346 [3]
None (operator The service class that service belongs to.
defined (see serviceClass element in
service-class string
default) subclause 11.2.1.2 of
3GPP TS 26.346 [3]).
None Empty list List of language of the service content.
(see serviceLanguage element in
service-languages array
subclause 11.2.1.1 of
3GPP TS 26.346 [3]).
None Empty list List of Service Names. (see name
service-names array element in subclause 11.2.1.1 of
3GPP TS 26.346 [3])
ETSI
3GPP TS 29.116 version 15.2.0 Release 15 13 ETSI TS 129 116 V15.2.0 (2020-01)
boolean None False When set to 'true', the Content Provider
receive-only-
indicates that the service is a Receive
mode
Only Mode service.
None SACH Enumeration of Service Announcement
Mode.
Additional service announcement modes
may be added in the future.
- "SACH": BM-SC performs the
service announcement for the
service-
current service using the SACH
announcement- string
channel (cf. Annex L.2, L3 of
mode
3GPP TS 26.346 [3]).
- "Content Provider": BM-SC
provides the necessary service
access information used by the
Content Provider to create the
service announcement
information.
Enabled Boolean False The Content Provider wishes to collect
consumption reports for the service.
Enabled: Flag to indicate enabling
of consumption-reporting
consumption-
Reporting interval: The interval
reporting- object
for which the BM-SC is aggregate
configuration
the statistics for
Sample percentage: Percentage of
users to collect reports from
Reporting Integer 3600 (in
seconds)
interval
10 (in %)
Sample Integer
percentage
None “”
The Content Provider provides
Notification URL over which it will
push-notification-
receive notifications "pushed" by the
string
url
BM-SC. The Notification procedure is
described in subclause 5.4A.3. of
3GPP TS 26.346 [3]
None All If the Content Provider enables push
push-notification- delivery of notifications, then the
string
configuration Content Provider may provide
notification filters
ETSI
3GPP TS 29.116 version 15.2.0 Release 15 14 ETSI TS 129 116 V15.2.0 (2020-01)
This parameter contains a comma
separated list of Classes it wishes to
receive among the following options:
Critical, Warning, Information,
Service, Session, or All to get all types
of notification.
The notification message shall be sent
immediately to the Content Provider
upon its availability.
NOTE: Properties marked with a supported feature are applicable as described in subclause 9.

The service instance resource with the properties defined above can be shown using the following JSON schema:
"service": {
"type": "object",
"description": "Service Description",
"properties": {
"service-id": {
"type": "string",
"description": "Refer to Table 5.2.1.1-1 for detailed description"
},
"service-class": {
"description": "Service class",
"type": "string"
},
"service-languages": {
"type": "array",
"description": "List of service languages",
"items" : {
type" : "string"
}
},
"service-names": {
"type": "array",
"description": "List of service names",
"items" : {
"type" : "string"
}
},
"receive-only-mode":{
ETSI
3GPP TS 29.116 version 15.2.0 Release 15 15 ETSI TS 129 116 V15.2.0 (2020-01)
"description":"Refer to Table 5.2.2.1-1 for detailed description",
"type":"boolean"
},
"service-announcement-mode": {
"description": "Refer to Table 5.2.1.1-1 for detailed description",
"type": "string"
},
"consumption-reporting-configuration": {
"type": "object",
"description": "Refer to Table 5.2.1.1-1 for detailed description",
"properties": {
"reporting-interval": {
"type": "number",
"description": "The interval for which the BM-SC has to aggregate the
statistics for"
},
"sample-percentage": {
"type": "number",
"description": "Percentage of users to collect reports from"
},
"start-time": {
"type": "string",
"description": "Start time of consumption report collection"
},
"end-time": {
"type": "string",
"description": "End time of consumption report collection"
}
}
},
"push-notification-url" : {
"type" : "string",
"description" : "The Content Provider supplied Notification URL over which it will receive
notifications "pushed" by the BM-SC. The Notification procedure is described in sublause 5.4A.4.6."
},
"push-notification-configuration" : {
ETSI
3GPP TS 29.116 version 15.2.0 Release 15 16 ETSI TS 129 116 V15.2.0 (2020-01)
"type" : "string",
"description" : "If the Content Provider enables push delivery of notifications, then the Content
Provider may provide notification filters. This parameter contains a comma separated list of Classes it
wishes to receive among the following options: Critical, Warning, Information, Service, Session, or All to
get all types of notification. The notification message shall be sent immediately to the Content Provider as
soon as it’s available."
}
}
},
5.2.1.2 API Operations
5.2.1.2.1 Introduction
Services can be created, updated, or deleted at the BM-SC by the Content Provider, or the properties of a previously
created service at the BM-SC may be obtained by the Content Provider, by invoking HTTP methods on the "service"
instance resource or the “services” collection resource.
5.2.1.2.2 Service Creation
POST /xmb/v1.0/services
To create a service, the Content Provider shall use the HTTP POST method on the "services" collection resource as
follows
...