ETSI TS 129 540 V15.9.0 (2021-04)
5G; 5G System; SMS Services; Stage 3 (3GPP TS 29.540 version 15.9.0 Release 15)
5G; 5G System; SMS Services; Stage 3 (3GPP TS 29.540 version 15.9.0 Release 15)
RTS/TSGC-0429540vf90
General Information
Standards Content (Sample)
TECHNICAL SPECIFICATION
5G;
5G System;
SMS Services;
Stage 3
(3GPP TS 29.540 version 15.9.0 Release 15)
3GPP TS 29.540 version 15.9.0 Release 15 1 ETSI TS 129 540 V15.9.0 (2021-04)
Reference
RTS/TSGC-0429540vf90
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 - APE 7112B
Association à but non lucratif enregistrée à la
Sous-Préfecture de Grasse (06) N° w061004871
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
Notice of disclaimer & limitation of liability
The information provided in the present deliverable is directed solely to professionals who have the appropriate degree of
experience to understand and interpret its content in accordance with generally accepted engineering or
other professional standard and applicable regulations.
No recommendation as to products and services or vendors is made or should be implied.
No representation or warranty is made that this deliverable is technically accurate or sufficient or conforms to any law
and/or governmental rule and/or regulation and further, no representation or warranty is made of merchantability or fitness
for any particular purpose or against infringement of intellectual property rights.
In no event shall ETSI be held liable for loss of profits or any other incidental or consequential damages.
Any software contained in this deliverable is provided "AS IS" with no warranties, express or implied, including but not
limited to, the warranties of merchantability, fitness for a particular purpose and non-infringement of intellectual property
rights and ETSI shall not be held liable in any event for any damages whatsoever (including, without limitation, damages
for loss of profits, business interruption, loss of information, or any other pecuniary loss) arising out of or related to the use
of or inability to use the software.
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 2021.
All rights reserved.
ETSI
3GPP TS 29.540 version 15.9.0 Release 15 2 ETSI TS 129 540 V15.9.0 (2021-04)
Intellectual Property Rights
Essential patents
IPRs essential or potentially essential to normative deliverables may have been declared to ETSI. The declarations
pertaining to these essential IPRs, if any, are 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 Directives including the ETSI IPR Policy, no investigation regarding the essentiality of IPRs,
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.
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.
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.540 version 15.9.0 Release 15 3 ETSI TS 129 540 V15.9.0 (2021-04)
Contents
Intellectual Property Rights . 2
Legal Notice . 2
Modal verbs terminology . 2
Foreword . 5
1 Scope . 6
2 References . 6
3 Definitions and abbreviations . 7
3.1 Definitions . 7
3.2 Abbreviations . 7
4 Overview . 7
5 Services offered by the SMSF . 7
5.1 Introduction . 7
5.2 Nsmsf_SMService Service . 8
5.2.1 Service Description . 8
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 to remove SMS service authorization from SMSF . 9
5.2.2.3.3 De-Registration procedure to remove SMS service authorization from SMSF for one of the
registered Access Type . 10
5.2.2.4 UplinkSMS. 11
5.2.2.4.1 General . 11
5.2.2.4.2 Procedures of sending SMS payload in uplink direction using UplinkSMS service operation . 11
6 API Definitions . 11
6.1 Nsmsf_SMService Service API . 11
6.1.1 API URI . 11
6.1.2 Usage of HTTP . 12
6.1.2.1 General . 12
6.1.2.2 HTTP standard headers . 12
6.1.2.2.1 General . 12
6.1.2.2.2 Content type . 12
6.1.2.2.3 ETag . 12
6.1.2.2.4 If-Match . 13
6.1.2.3 HTTP custom headers . 13
6.1.2.3.1 General . 13
6.1.2.4 HTTP multipart messages . 13
6.1.3 Resources . 13
6.1.3.1 Overview . 13
6.1.3.2 Resource: UEContexts . 15
6.1.3.2.1 Description . 15
6.1.3.2.2 Resource Definition . 15
6.1.3.2.3 Resource Standard Methods . 15
6.1.3.3 Resource: UEContext . 15
6.1.3.3.1 Description . 15
6.1.3.3.2 Resource Definition . 15
6.1.3.3.3 Resource Standard Methods . 16
6.1.3.3.3.1 PUT . 16
6.1.3.3.3.2 DELETE . 17
ETSI
3GPP TS 29.540 version 15.9.0 Release 15 4 ETSI TS 129 540 V15.9.0 (2021-04)
6.1.3.3.4 Resource Custom Operations . 17
6.1.3.3.4.1 Overview . 17
6.1.3.3.4.2 Operation: sendsms . 18
6.1.3.3.4.2.1 Description . 18
6.1.3.3.4.2.2 Operation Definition . 18
6.1.4 Custom Operations without associated resources . 18
6.1.5 Notifications . 18
6.1.6 Data Model . 18
6.1.6.1 General . 18
6.1.6.2 Structured data types . 19
6.1.6.2.1 Introduction . 19
6.1.6.2.2 Type: UeSmsContextData . 20
6.1.6.2.3 Type: SmsRecordData . 21
6.1.6.2.4 Void . 21
6.1.6.2.5 Type: SmsRecordDeliveryData . 21
6.1.6.3 Simple data types and enumerations . 21
6.1.6.3.1 Introduction . 21
6.1.6.3.2 Simple data types . 21
6.1.6.3.3 Enumeration: SmsDeliveryStatus . 22
6.1.6.4 Binary data . 22
6.1.6.4.1 Introduction . 22
6.1.6.4.2 SMS Payload Information . 22
6.1.7 Error Handling . 22
6.1.7.1 General . 22
6.1.7.2 Protocol Errors . 22
6.1.7.3 Application Errors . 22
6.1.8 Feature negotiation . 23
6.1.9 Security . 23
Annex A (normative): OpenAPI specification . 24
A.1 General . 24
A.2 Nsmsf_SMService API . 24
Annex B (Informative): HTTP Multipart Messages . 29
B.1 Example of HTTP multipart message . 29
B.2 Void . 29
B.3 Example HTTP multipart message with SMS binary data . 29
Annex C (informative): Change history . 30
History . 31
ETSI
3GPP TS 29.540 version 15.9.0 Release 15 5 ETSI TS 129 540 V15.9.0 (2021-04)
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.540 version 15.9.0 Release 15 6 ETSI TS 129 540 V15.9.0 (2021-04)
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".
[16] 3GPP TR 21.900: "Technical Specification Group working methods".
[17] IETF RFC 7807: "Problem Details for HTTP APIs".
[18] IETF RFC 7232: "Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests".
ETSI
3GPP TS 29.540 version 15.9.0 Release 15 7 ETSI TS 129 540 V15.9.0 (2021-04)
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].
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 clause 6.2.13 of 3GPP TS 23.501 [2].
The services and service operations provided by the Nsmsf interface are listed in clause 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.
ETSI
3GPP TS 29.540 version 15.9.0 Release 15 8 ETSI TS 129 540 V15.9.0 (2021-04)
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;
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 or updating 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 clause 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 clause 4.13.3.1 of 3GPP TS 23.502 [3]);
- Registration Update Procedure for SMS over NAS due to AMF change (see clause 4.13.3.1 of
3GPP TS 23.502 [3]);
- Registration Update Procedure for SMS over NAS to add authorization for SMS over a new additional Access
Type;
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.
ETSI
3GPP TS 29.540 version 15.9.0 Release 15 9 ETSI TS 129 540 V15.9.0 (2021-04)
NF Service
SMSF
Consumer
1. PUT ./ue-contexts/{supi} (UeSmsContextData)
2a. 201 Created
2b. 2c. 204 No Content
2d. 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:
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 PUT 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. If the target UE Context for SMS has already been created and the NF Service Consumer (e.g. AMF) provided
parameters contains 2 access types (i.e. an additional Access Type), the SMSF registers itself in UDM for the
new Access Type for the given UE, performs service authorization for the given UE for the new Access Type
and updates the UE context for SMS for this UE with the new additional Access Type.
If successful, "204 No Content" shall be returned.
2d. 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 or updating an individual UE Context for SMS in the SMSF, in the
following procedures:
- De-Registration Procedure to remove SMS service authorization from SMSF for SMS over NAS (see clause
4.13.3.2 of 3GPP TS 23.502 [3]);
- De-Registration procedure to remove SMS service authorization from SMSF for one of the registered Access
Type (see clause 4.13.3.2 of 3GPP TS 23.502 [3]);
5.2.2.3.2 De-Registration procedure to remove SMS service authorization from SMSF
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.
ETSI
3GPP TS 29.540 version 15.9.0 Release 15 10 ETSI TS 129 540 V15.9.0 (2021-04)
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.3.3 De-Registration procedure to remove SMS service authorization from SMSF for
one of the registered Access Type
When the UE has SMS service activated on both of the Access Types and the NF Service Consumer (e.g. AMF) wants
to deactivate SMS service for the given UE for one of the affected Access Type, the NF Service Consumer (e.g. AMF)
shall use HTTP PUT method as shown in Figure 5.2.2.3.3-1.
NF Service
SMSF
Consumer
1. PUT ./ue-contexts/{supi} (UeSmsContextData)
2a. 204 No Content
2b. 4xx/5xx (ProblemDetails)
Figure 5.2.2.3.3-1: Removal of SMS service authorization over one of the access types
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. The payload body of the PUT request shall contain a
representation of the individual UE Context resource to be updated. Only one Access Type that is allowed for
SMS service shall be included in the PUT request payload body.
2a. Since the target UE Context for SMS was already created at the SMSF with both 3GPP and non-3GPP Access
Types for the same NF Service Consumer (e.g. AMF) and the NF Service Consumer provided parameters
contains only one Access Type, the SMSF deregisters itself in the UDM for the affected Access Type (i.e. the
access type not included in the PUT request) for the given UE and updates the UE context for SMS by removing
the affected Access Type.
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 PUT response, with the "cause" attribute of
ProblemDetails set to application error codes specified in table 6.1.7.3-1.
ETSI
3GPP TS 29.540 version 15.9.0 Release 15 11 ETSI TS 129 540 V15.9.0 (2021-04)
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 clause 4.13.3.3-4.13.3.5 of 3GPP TS 23.502 [3]);
- MT SMS delivery procedure (see clause 4.13.3.6-4.13.3.8 of 3GPP TS 23.502 [3]);
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 success, "200 OK" shall be returned with "SmsRecordDeliveryData" object in the response body.
The SMSF may immediately respond to the NF service consumer, after successful inspection of the SMS
payload, and set the "deliveryStatus" attribute to "SMS_DELIVERY_SMSF_ACCEPTED"; the SMSF may also
attempt to forward the SMS payload to SMS-GMSC/IWMSC/IP-SM-GW/SMS Router, and indicate the status of
SMS record delivery attempt in the response body.
NOTE: The interaction between SMSF and SMS-GMSC/IWMSC/IP-SM-GW/SMS Router is out of the scope of
this specification.
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 POST response, with the "cause" attribute of
ProblemDetails set to application error codes specified in table 6.1.7.3-1.
6 API Definitions
6.1 Nsmsf_SMService Service API
6.1.1 API URI
The Nsmsf_SMService shall use the Nsmsf_SMService API.
The request URI used in HTTP request from the NF service consumer towards the NF service producer shall have the
structure defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
ETSI
3GPP TS 29.540 version 15.9.0 Release 15 12 ETSI TS 129 540 V15.9.0 (2021-04)
{apiRoot}///
with the following components:
- The {apiRoot} shall be set as described in 3GPP TS 29.501 [5].
- The shall be "nsmsf-sms".
- The shall be "v2".
- The shall be set as described in clause 6.1.3.
6.1.2 Usage of HTTP
6.1.2.1 General
HTTP/2, as defined in IETF RFC 7540 [7], shall be used as specified in clause 5 of 3GPP TS 29.500 [4].
6.1.2.2 HTTP standard headers
6.1.2.2.1 General
The usage of HTTP standard headers is specified in clause 5.2.2 of 3GPP TS 29.500 [4].
6.1.2.2.2 Content type
The following content types shall be supported:
- the JSON format (IETF RFC 8259 [8]). The use of the JSON format shall be signalled by the content type
"application/json". See also clause 5.4 of 3GPP TS 29.500 [4].
- the Problem Details JSON Object (IETF RFC 7807 [17]). The use of the Problem Details JSON object in a
HTTP response body shall be signalled by the content type "application/problem+json".
Multipart messages shall also be supported (see clause 6.1.2.4) using the content type "multipart/related", comprising:
- one JSON body part with the "application/json" content type; and
- one binary body part with 3gpp vendor specific content subtypes.
The 3gpp vendor specific content subtypes defined in Table 6.1.2.2.2-1 shall be supported.
Table 6.1.2.2.2-1: 3GPP vendor specific content subtypes
content subtype Description
vnd.3gpp.sms Binary encoded payload, encoding SMS payload, as specified in
3GPP TS 23.040 [11] and 3GPP TS 24.011 [12].
NOTE: Using 3GPP vendor content subtypes allows to describe the nature of the opaque payload
(e.g. SMS payload) without having to rely on metadata in the JSON payload.
See clause 6.1.2.4 for the binary payloads supported in the binary body part of multipart messages.
6.1.2.2.3 ETag
As described in IETF RFC 7232 [18] clause 2.32, an "ETag" (entity-tag) header should be included in HTTP responses
except for non-cacheable resources to allow an NF Service Consumer performing a conditional request with "If-Match"
header. If it is included, it shall contain a server-generated strong validator, that allows further matching of this value
(included in subsequent client requests) with a given resource representation stored in the server or in a cache.
ETSI
3GPP TS 29.540 version 15.9.0 Release 15 13 ETSI TS 129 540 V15.9.0 (2021-04)
6.1.2.2.4 If-Match
As described in IETF RFC 7232 [18] clause 3.1, an NF Service Consumer may issue conditional DELETE request
towards SMSF by including an "If- Match" header in HTTP requests containing an entity tags received in previous
response for the same resource.
6.1.2.3 HTTP custom headers
6.1.2.3.1 General
In this release of this specification, no custom headers specific to the Nsmsf_SMService service are defined. For 3GPP
specific HTTP custom headers used across all service based interfaces, see clause 5.2.3 of 3GPP TS 29.500 [4].
6.1.2.4 HTTP multipart messages
HTTP multipart messages shall be supported, to transfer opaque SMS payload (e.g. SMS message, CP Ack, etc.), in the
following service operations (and HTTP messages):
- UplinkSMS service operation;
HTTP multipart messages shall include one JSON body part and one binary body part comprising content of SMS
payload content (see clause 6.1.6.4).
The JSON body part shall be the "root" body part of the multipart message. It shall be encoded as the first body part of
the multipart message. The "Start" parameter does not need to be included.
The multipart message shall include a "type" parameter (see IETF RFC 2387 [9]) specifying the media type of the root
body part, i.e. "application/json".
NOTE: The "root" body part (or "root" object) is the first body part the application processes when receiving a
multipart/related message, see IETF RFC 2387 [9]. The default root is the first body within the
multipart/related message. The "Start" parameter indicates the root body part, e.g. when this is not the
first body part in the message.
A binary body part shall include a Content-ID header (see IETF RFC 2045 [10]), and the JSON body part shall make a
reference to the binary body part using the Content-ID header field.
Examples of multipart/related messages can be found in Annex B.
6.1.3 Resources
6.1.3.1 Overview
The figure 6.1.3.1-1 describes the resource URI structure of the Nsmsf-sms API.
ETSI
3GPP TS 29.540 version 15.9.0 Release 15 14 ETSI TS 129 540 V15.9.0 (2021-04)
Figure 6.1.3.1-1: Resource URI structure of the nsmsf-sms API
Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods.
Table 6.1.3.1-1: Resources and methods overview
HTTP
method
Resource name Resource URI or Description
custom
operation
UEContexts N/A No HTTP method has been defined
{apiRoot}/nsmsf-sms//ue-
(Store) for this resource.
contexts
UEContext {apiRoot}/nsmsf-sms//ue- PUT It is used for the Activate service
(Document) contexts/{supi} operation, for the purpose of:
- Activate SMS service for a given
UE, which results in creating an
individual UE Context resource in
SMSF.
- Update SMS service parameters
for a given UE, which results in
updating an existing individual UE
Context resource in SMSF.
- Deactivate SMS service for a given
UE for one of the two registered
Access Types, which results in
updating an existing individual UE
context resource in SMSF.
DELETE It is used for the Deactivate service
operation, for the purpose of:
- Deactivate SMS service for a given
UE, which results in deleting an
existing individual UE Context
resource in SMSF.
{apiRoot}/nsmsf-sms//ue- sendsms It is used for the UplinkSMS service
contexts/{supi}/sendsms (POST) operation, to allow NF Service
Consumer to send SMS payload in
uplink direction.
ETSI
3GPP TS 29.540 version 15.9.0 Release 15 15 ETSI TS 129 540 V15.9.0 (2021-04)
6.1.3.2 Resource: UEContexts
6.1.3.2.1 Description
This resource represents the collection of UE Context for SMS in SMSF.
This resource is modelled with the Store resource archetype (see clause C.2 of 3GPP TS 29.501 [5]).
No HTTP method has been defined for this resource.
6.1.3.2.2 Resource Definition
Resource URI: {apiRoot}/nsmsf-sms//ue-contexts
This resource shall support the resource URI variables defined in table 6.1.3.2.2-1.
Table 6.1.3.2.2-1: Resource URI variables for this resource
Name Definition
apiRoot See clause 6.1.1
6.1.3.2.3 Resource Standard Methods
No HTTP method has been defined for the UE Context collection resource.
6.1.3.3 Resource: UEContext
6.1.3.3.1 Description
This resource represents an individual UE Context for SMS in SMSF.
This resource is modelled with the Document resource archetype (see clause C.2 of 3GPP TS 29.501 [5]).
A PUT method to this resource can be invoked by the NF Service Consumer (e.g. AMF) to:
- activate SMS service for a given UE, which results in creating new individual UE Context for SMS in SMSF,
during the Registration procedure for SMS over NAS (see 3GPP TS 23.502 [3] clause 4.13.3.1);
- update SMS service parameters for a given UE, which results in updating individual UE Context for SMS in
SMSF, during the Registration Update procedure due to AMF change (see 3GPP TS 23.502 [3] clause 4.13.3.1).
- update SMS service parameters for a given UE, which results in updating individual UE Context for SMS in
SMSF, to add a new Access Type for SMS over NAS.
- Deactivate SMS service for a given UE for one of the two registered Access Types, which results in updating an
existing individual UE context resource in SMSF to remove the affected Access Type for SMS over NAS.
A DELETE method to this resource can be invoked by the NF Service Consumer (e.g. AMF) to:
- deactivate SMS service for a given UE, which results in deleting existing individual UE Context for SMS in
SMSF, during the De-Registration procedure form SMS over NAS (see 3GPP TS 23.502 [3] clause 4.13.3.2).
6.1.3.3.2 Resource Definition
Resource URI: {apiRoot}/nsmsf-sms//ue-contexts/{supi}
This resource shall support the resource URI variables defined in table 6.1.3.3.2-1.
ETSI
3GPP TS 29.540 version 15.9.0 Release 15 16 ETSI TS 129 540 V15.9.0 (2021-04)
Table 6.1.3.2.2-1: Resource URI variables for this resource
Name Definition
apiRoot See clause 6.1.1
supi Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
6.1.3.3.3 Resource Standard Methods
6.1.3.3.3.1 PUT
This method creates an individual resource
...








Questions, Comments and Discussion
Ask us and Technical Secretary will try to provide an answer. You can facilitate discussion about the standard in here.
Loading comments...