|
TECHNICAL SPECIFICATION
5G;
5G System;
SMS Services;
Stage 3
(3GPP TS 29.540 version 15.0.0 Release 15)
---------------------- Page: 1 ----------------------
3GPP TS 29.540 version 15.0.0 Release 15 1 ETSI TS 129 540 V15.0.0 (2018-09)
Reference
RTS/TSGC-0429540vf00
Keywords
5G
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:
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 only prevailing document is the
print of the Portable Document Format (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
If you find errors in the present document, please send your comment to one of the following services:
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 2018.
All rights reserved.
TM TM TM
DECT , PLUGTESTS , UMTS and the ETSI logo are trademarks of ETSI registered for the benefit of its Members.
TM TM
3GPP and LTE are trademarks of ETSI registered for the benefit of its Members and
of the 3GPP Organizational Partners.
oneM2M logo is protected for the benefit of its Members.
GSM and the GSM logo are trademarks registered and owned by the GSM Association.
ETSI
---------------------- Page: 2 ----------------------
3GPP TS 29.540 version 15.0.0 Release 15 2 ETSI TS 129 540 V15.0.0 (2018-09)
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.
Foreword
This Technical Specification (TS) has been produced by ETSI 3rd Generation Partnership Project (3GPP).
The present document may refer to technical specifications or reports using their 3GPP identities, UMTS identities or
GSM identities. These should be interpreted as being references to the corresponding ETSI deliverables.
The cross reference between GSM, UMTS, 3GPP and ETSI identities can be found under
.
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
---------------------- Page: 3 ----------------------
3GPP TS 29.540 version 15.0.0 Release 15 3 ETSI TS 129 540 V15.0.0 (2018-09)
Contents
Intellectual Property Rights . 2
Foreword . 2
Modal verbs terminology . 2
Foreword . 5
1 Scope . 6
2 References . 6
3 Definitions and abbreviations . 6
3.1 Definitions . 6
3.2 Abbreviations . 7
4 Overview . 7
5 Services offered by the SMSF . 7
5.1 Introduction . 7
5.2 Nsmsf_SMService Service . 7
5.2.1 Service Description . 7
5.2.2 Service Operations . 8
5.2.2.1 Introduction . 8
5.2.2.2 Activate . 8
5.2.2.2.1 General . 8
5.2.2.2.2 Registration procedure using Activate service operation . 8
5.2.2.3 Deactivate. 9
5.2.2.3.1 General . 9
5.2.2.3.2 De-Registration procedure using Deactivate service operation . 9
5.2.2.4 UplinkSMS. 9
5.2.2.4.1 General . 9
5.2.2.4.2 Procedures of sending SMS payload in uplink direction using UplinkSMS service operation . 10
6 API Definitions . 10
6.1 Nsmsf_SMService Service API . 10
6.1.1 API URI . 10
6.1.2 Usage of HTTP . 10
6.1.2.1 General . 10
6.1.2.2 HTTP standard headers . 10
6.1.2.2.1 General . 10
6.1.2.2.2 Content type . 11
6.1.2.3 HTTP custom headers . 11
6.1.2.3.1 General . 11
6.1.2.4 HTTP multipart messages . 11
6.1.3 Resources . 11
6.1.3.1 Overview . 11
6.1.3.2 Resource: UEContexts . 12
6.1.3.2.1 Description . 12
6.1.3.2.2 Resource Definition . 12
6.1.3.2.3 Resource Standard Methods . 13
6.1.3.3 Resource: UEContext . 13
6.1.3.3.1 Description . 13
6.1.3.3.2 Resource Definition . 13
6.1.3.3.3 Resource Standard Methods . 13
6.1.3.3.3.1 PUT . 13
6.1.3.3.3.2 DELETE . 14
6.1.3.3.4 Resource Custom Operations . 15
6.1.3.3.4.1 Overview . 15
6.1.3.3.4.2 Operation: sendsms . 15
6.1.3.3.4.2.1 Description . 15
6.1.3.3.4.2.2 Operation Definition . 15
ETSI
---------------------- Page: 4 ----------------------
3GPP TS 29.540 version 15.0.0 Release 15 4 ETSI TS 129 540 V15.0.0 (2018-09)
6.1.4 Custom Operations without associated resources . 15
6.1.5 Notifications . 15
6.1.6 Data Model . 16
6.1.6.1 General . 16
6.1.6.2 Structured data types . 16
6.1.6.2.1 Introduction . 16
6.1.6.2.2 Type: UeSmsContextData . 16
6.1.6.2.3 Type: SmsRecordData . 17
6.1.6.2.4 Type: RefToBinaryData . 17
6.1.6.2.5 Type: SmsRecordDeliveryData . 17
6.1.6.3 Simple data types and enumerations . 17
6.1.6.3.1 Introduction . 17
6.1.6.3.2 Simple data types . 17
6.1.6.3.3 Enumeration: SmsDeliveryStatus . 17
6.1.6.4 Binary data . 18
6.1.6.4.1 Introduction . 18
6.1.6.4.2 SMS Payload Information . 18
6.1.7 Error Handling . 18
6.1.7.1 General . 18
6.1.7.2 Protocol Errors . 18
6.1.7.3 Application Errors . 18
6.1.8 Feature negotiation . 18
6.1.9 Security . 19
Annex A (normative): OpenAPI specification . 20
A.1 General . 20
A.2 Nsmsf_SMService API . 20
Annex B (Informative): HTTP Multipart Messages . 25
B.1 Example of HTTP multipart message . 25
B.2 OpenAPI specification of multipart body . 25
Annex C (informative): Change history . 26
History . 27
ETSI
---------------------- Page: 5 ----------------------
3GPP TS 29.540 version 15.0.0 Release 15 5 ETSI TS 129 540 V15.0.0 (2018-09)
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
---------------------- Page: 6 ----------------------
3GPP TS 29.540 version 15.0.0 Release 15 6 ETSI TS 129 540 V15.0.0 (2018-09)
1 Scope
The present document specifies the stage 3 protocol and data model for the Nsmsf Service Based Interface. It provides
stage 3 protocol definitions and message flows, and specifies the API for each service offered by the SMSF.
The 5G System stage 2 architecture and procedures are specified in 3GPP TS 23.501 [2] and 3GPP TS 23.502 [3].
The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition
are specified in 3GPP TS 29.500 [4] and 3GPP TS 29.501 [5].
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.501: "System Architecture for the 5G System; Stage 2".
[3] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2".
[4] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3".
[5] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3".
[6] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3".
[7] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2)".
[8] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format".
[9] IETF RFC 2387: "The MIME Multipart/Related Content-type".
[10] IETF RFC 2045: "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet
Message Bodies".
[11] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS)".
[12] 3GPP TS 24.011: "Point-to-Point (PP) Short Message Service (SMS) support on mobile radio
interface".
[13] 3GPP TS 33.501: "Security architecture and procedures for 5G system".
[14] IETF RFC 6749: "The OAuth 2.0 Authorization Framework".
[15] 3GPP TS 29.510: "Network Function Repository Services; Stage 3".
3 Definitions and abbreviations
3.1 Definitions
For the purposes of the present document, the terms and definitions given in 3GPP TR 21.905 [1] and 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].
ETSI
---------------------- Page: 7 ----------------------
3GPP TS 29.540 version 15.0.0 Release 15 7 ETSI TS 129 540 V15.0.0 (2018-09)
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].
5GC 5G Core Network
AMF Access Management Function
JSON Javascript Object Notation
SMSF SMS Function
4 Overview
Within the 5GC, the SMSF offers services to the AMF via the Nsmsf service based interface (see 3GPP TS 23.501 [2]
and 3GPP TS 23.502 [3]).
Figures 4.1 provides the reference model (in service based interface representation and in reference point
representation), with focus on the SMSF and the scope of the present specification.
Figure 4-1: Reference model – SMSF
The functionalities supported by the SMSF are listed in subclause 6.2.13 of 3GPP TS 23.501 [2].
The services and service operations provided by the Nsmsf interface are listed in subclause 5.2.9 of
3GPP TS 23.502 [3].
5 Services offered by the SMSF
5.1 Introduction
The SMSF supports the following services.
Table 5.1-1: NF Services provided by SMSF
Service Name Description Example
Consumer
Nsmsf_SMService This service allows AMF to authorize SMS and activate AMF
SMS for the served user on SMSF.
5.2 Nsmsf_SMService Service
5.2.1 Service Description
The Nsmsf_SMService service provides the service capability for the NF Service Consumer (e.g. AMF) to authorize
SMS and activate SMS for a service user on SMSF. The following are the key functionalities of this NF service:
- Activation or deactivation of SMS service for a given service user, which results in creating/updating/deleting an
UE Context for SMS in SMSF;
- Send SMS payload in uplink direction to SMSF;
ETSI
---------------------- Page: 8 ----------------------
3GPP TS 29.540 version 15.0.0 Release 15 8 ETSI TS 129 540 V15.0.0 (2018-09)
The Nsmsf_SMService service supports the following service operations.
Table 5.2.1-1: Service operations supported by the Nsmsf_SMService service
Service Operations Description Operation Example
Semantics Consumer(s)
Activate Activate SMS service for a given service user,
Request/Response AMF
which results in creating or updating a UE
Context for SMS in SMSF.
Deactivate Deactivate SMS service for a given service Request/Response AMF
user, which results in deleting a UE Context for
SMS in SMSF.
UplinkSMS Send SMS payload in uplink direction to Request/Response AMF
SMSF;
5.2.2 Service Operations
5.2.2.1 Introduction
This subclause introduces the related procedures using Nsmsf_SMService service operations for supporting SMS
service.
5.2.2.2 Activate
5.2.2.2.1 General
The Activate service operation shall be used by the NF Service Consumer (e.g. AMF) to activate SMS service for a
given service user, which results in creating or updating an individual UE Context for SMS in the SMSF, in the
following procedures:
- Registration Procedure for SMS over NAS (see subclause 4.13.3.1 of 3GPP TS 23.502 [3]);
- Registration Update Procedure for SMS over NAS due to AMF change (see subclause 4.13.3.1 of
3GPP TS 23.502 [3]);
There shall be only one individual UE Context for SMS per service user.
5.2.2.2.2 Registration procedure using Activate service operation
The NF Service Consumer (e.g. AMF) shall activate SMS service for a given service user by using the HTTP PUT
method as shown in Figure 5.2.2.2.2-1.
NF Service
SMSF
Consumer
1. PUT ./ue-contexts/{supi} (UeSmsContextData)
2a. 201 Created
2b. 204 No Content
2c. 4xx/5xx (ProblemDetails)
Figure 5.2.2.2.2-1: Activation of SMS service
1. The NF Service Consumer (e.g. AMF) shall send a PUT request to the resource representing the UE Context for
SMS (i.e. …/ue-contexts/{supi}) in the SMSF to activate SMS service for a given service user. The payload
body of the PUT request shall contain a representation of the individual UE Context resource to be created or
updated.
Depending on whether the target UE Context for SMS has already been created, the SMSF performs 2a or 2b:
ETSI
---------------------- Page: 9 ----------------------
3GPP TS 29.540 version 15.0.0 Release 15 9 ETSI TS 129 540 V15.0.0 (2018-09)
2a. If the target UE Context for SMS is not created in SMSF, the SMSF retrieves subscription data from the UDM,
performs service authorization for the given UE, and create UE Context for SMS for this UE;
If successful, "201 Created" shall be returned, the payload body of the POST response shall contain the
representation of the created resource and the "Location" header shall contain the URI of the created resource.
2b. If the target UE Context for SMS has already been created, the SMSF updates the UE Context for SMS with the
NF Service Consumer (e.g. AMF) provided parameters.
If successful, "204 No Content" shall be returned.
2c. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned.
A ProblemDetails IE shall be included in the payload body of PUT response, with the "cause" attribute of
ProblemDetails set to application error codes specified in table 6.1.7.3-1.
5.2.2.3 Deactivate
5.2.2.3.1 General
The Deactivate service operation shall be used by the NF Service Consumer (e.g. AMF) to deactivate SMS service for a
given service user, which results in deleting an individual UE Context for SMS in the SMSF, in the following
procedures:
- De-Registration Procedure for SMS over NAS (see subclause 4.13.3.2 of 3GPP TS 23.502 [3]);
5.2.2.3.2 De-Registration procedure using Deactivate service operation
The NF Service Consumer (e.g. AMF) shall deactivate SMS service for a given service user by using the HTTP
DELETE method as shown in Figure 5.2.2.3.2-1.
Figure 5.2.2.3.2-1: Deactivation of SMS service
1. The NF Service Consumer (e.g. AMF) shall send a DELETE request to the resource representing the UE Context
for SMS (i.e. …/ue-contexts/{supi}) in the SMSF.
2a. The SMSF deactivates the SMS service for the service user, and deletes the UE context for SMS from the SMSF.
On success, "204 No Content" shall be returned.
2b. On failure, the appropriate HTTP status code (e.g. "403 Forbidden") indicating the error shall be returned.
A ProblemDetails IE shall be included in the payload body of DELETE response, with the "cause" attribute of
ProblemDetails set to application error codes specified in table 6.1.7.3-1.
5.2.2.4 UplinkSMS
5.2.2.4.1 General
The UplinkSMS service operation shall be used by NF Service Consumer (e.g. AMF) to send SMS payload (e.g. SMS
message or Ack) in the uplink direction to SMSF, in the following procedures:
- MO SMS delivery procedure (see subclause 4.13.3.3-4.13.3.5 of 3GPP TS 23.502 [3]);
- MT SMS delivery procedure (see subclause 4.13.3.6-4.13.3.8 of 3GPP TS 23.502 [3]);
ETSI
---------------------- Page: 10 ----------------------
3GPP TS 29.540 version 15.0.0 Release 15 10 ETSI TS 129 540 V15.0.0 (2018-09)
5.2.2.4.2 Procedures of sending SMS payload in uplink direction using UplinkSMS service
operation
The NF Service Consumer (e.g. AMF) shall send SMS payload in uplink direction by using the "sendsms" custom
operation as shown in Figure 5.2.2.4.2-1.
Figure 5.2.2.4.2-1: Send SMS payload in uplink direction
1. The NF Service Consumer (e.g. AMF) shall send a POST request to the resource representing the UEContext
(i.e. …/ue-contexts/{supi}/sendsms) of the SMSF. The payload body of the POST request shall contain the SMS
record to be sent.
2a. On receiving the POST request with SMS payload, the SMSF forwards the SMS payload to SMS-
GMSC/IWMSC/IP-SM-GW/SMS Router. The interaction between SMSF and SMS-GMSC/IWMSC/IP-SM-
GW/SMS Router is out of the scope of this specification.
If successful, "200 OK" shall be re
...