32291-hb0
32291-hb0
32291-hb0
0 (2024-09)
Technical Specification
3rd Generation Partnership Project;
Technical Specification Group Services and System Aspects;
Telecommunication management;
Charging management;
5G system, charging service;
Stage 3
(Release 17)
The present document has been developed within the 3rd Generation Partnership Project (3GPP TM) and may be further elaborated for the purposes of 3GPP..
The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented.
This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this
Specification.
Specifications and Reports for implementation of the 3GPP TM system should be obtained via the 3GPP Organizational Partners' Publications Offices.
Release 17 3 3GPP TS 32.291 V17.11.0 (2024-09)
Keywords
charging, service based interface
3GPP
Postal address
Internet
http://www.3gpp.org
Copyright Notification
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
UMTS™ is a Trade Mark of ETSI registered for the benefit of its members
3GPP™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
LTE™ is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners
GSM® and the GSM logo are registered and owned by the GSM Association
3GPP
Release 17 4 3GPP TS 32.291 V17.11.0 (2024-09)
Contents
Foreword.............................................................................................................................................................9
1 Scope.......................................................................................................................................................10
2 References...............................................................................................................................................10
3 Definitions, symbols and abbreviations..................................................................................................12
3.1 Definitions.........................................................................................................................................................12
3.2 Symbols.............................................................................................................................................................13
3.3 Abbreviations.....................................................................................................................................................13
4 Overview.................................................................................................................................................13
4.1 Service architecture...........................................................................................................................................13
4.2 Network functions.............................................................................................................................................14
4.2.1 Charging Function (CHF)............................................................................................................................14
4.2.2 NF Service Consumers................................................................................................................................14
5 Services offered by the CHF...................................................................................................................14
5.1 Introduction.......................................................................................................................................................14
5.2 Nchf_ConvergedCharging service....................................................................................................................15
5.2.1 Service description.......................................................................................................................................15
5.2.2 Service operations........................................................................................................................................15
5.2.2.1 Introduction............................................................................................................................................15
5.2.2.2 Nchf_ConvergedCharging_Create Operation........................................................................................16
5.2.2.3 Nchf_ConvergedCharging_Update Operation.......................................................................................17
5.2.2.4 Nchf_ConvergedCharging_Release Operation......................................................................................17
5.2.2.5 Nchf_ConvergedCharging_Notify Operation........................................................................................18
5.3 Nchf_OfflineOnlyCharging service..................................................................................................................19
5.3.1 Service description.......................................................................................................................................19
5.3.2 Service Operations.......................................................................................................................................19
5.3.2.1 Introduction............................................................................................................................................19
5.3.2.2 Nchf_OfflineOnlyCharging_Create Operation......................................................................................19
5.3.2.3 Nchf_OfflineOnlyCharging_Update Operation.....................................................................................20
5.3.2.4 Nchf_OfflineOnlyCharging_Release Operation....................................................................................20
6 API definitions........................................................................................................................................21
6.1 Nchf_ ConvergedCharging Service API...........................................................................................................21
6.1.1 Introduction..................................................................................................................................................21
6.1.2 Usage of HTTP............................................................................................................................................21
6.1.2.1 General...................................................................................................................................................21
6.1.2.2 HTTP standard headers..........................................................................................................................21
6.1.2.2.1 General..............................................................................................................................................21
6.1.2.2.2 Content type......................................................................................................................................22
6.1.2.3 HTTP custom headers............................................................................................................................22
6.1.2.3.1 General..............................................................................................................................................22
6.1.3 Resources.....................................................................................................................................................22
6.1.3.1 Overview................................................................................................................................................22
6.1.3.2 Resource: Charging Data.......................................................................................................................23
6.1.3.2.1 Description........................................................................................................................................23
6.1.3.2.2 Resource Definition..........................................................................................................................23
6.1.3.2.3 Resource Standard Methods.............................................................................................................23
6.1.3.2.3.1 POST...........................................................................................................................................23
6.1.3.2.4 Resource Custom Operations...........................................................................................................25
6.1.3.3 Resource: Individual Charging Data......................................................................................................25
6.1.3.3.1 Description........................................................................................................................................25
6.1.3.3.2 Resource Definition..........................................................................................................................25
6.1.3.3.3 Resource Standard Methods.............................................................................................................25
6.1.3.3.4 Resource Custom Operations...........................................................................................................25
6.1.3.3.4.1 Overview.....................................................................................................................................25
3GPP
Release 17 5 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 6 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 7 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 8 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 9 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 10 3GPP TS 32.291 V17.11.0 (2024-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:
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.
3GPP
Release 17 11 3GPP TS 32.291 V17.11.0 (2024-09)
1 Scope
The present document specifies the protocol that is used for service based interface. The API definitions and data type
definitions are aligned with the common charging architecture specified in TS 32.240 [1]. The present document is
related to other 3GPP charging TSs as follows:
- The service, operations and procedures of 5G charging for service based interface is specified in TS 32.290 [58].
The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition
of the 5G System are specified in 3GPP TS 29.500 [299] and 3GPP TS 29.501 [300].
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 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.
3GPP
Release 17 12 3GPP TS 32.291 V17.11.0 (2024-09)
[59] - [69] Void.[70] 3GPP TS 28.201: "Charging management; Network slice performance and analytics
charging in the 5G System (5GS); Stage 2".
[71] 3GPP TS 28.202: "Charging management; Network slice management charging in the 5G System
(5GS); Stage 2".
[102] 3GPP TS 24.605: "Conference (CONF) using IP Multimedia (IM) Core Network (CN) subsystem;
Protocol specification".
[103] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS) "
[254] 3GPP TS 28.541: "Management and orchestration; 5G Network Resource Model (NRM); Stage 2
and stage 3".
[256] 3GPP TS 28.554: "Management and orchestration;5G end to end Key Performance Indicators
(KPI)".
[257] 3GPP TS 28.623: "Telecommunication management; Generic Network Resource Model (NRM)
Integration Reference Point (IRP); Solution Set (SS) definitions".
[258] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP; Stage 3".
[259] 3GPP TS 29.078: "Customised Applications for Mobile network Enhanced Logic (CAMEL);
CAMEL Application Part (CAP) specification".".
[260] 3GPP TS 29.228: "IP Multimedia (IM) Subsystem Cx and Dx interface; signalling flows and
message contents".
[299] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3".
[300] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3".
[301] 3GPP TS 29.594: "5G System; Spending Limit Control Service; Stage 3".
[302] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3".
3GPP
Release 17 13 3GPP TS 32.291 V17.11.0 (2024-09)
[303] 3GPP TS 24.501: "Non-Access-Stratum (NAS) Protocol for 5G System (5GS); Stage 3".
[306] 3GPP TS 29.520: "5G System; Network Data Analytics Services;Stage 3".
[307] 3GPP TS 38.331: "NR; Radio Resource Control (RRC); Protocol specification".
[308] 3GPP TS 24.334: " Proximity-services (ProSe) User Equipment (UE) to ProSe function protocol
aspects; Stage 3".
[309] 3GPP TS 29.558: "Enabling Edge Applications; Application Programming Interface (API)
specification; stage 3".
[371] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3".
[400] Void.
[401] IETF RFC 7540: "Hypertext Transfer Protocol Version 2 (HTTP/2) ".
[402] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format ".
[404] IETF RFC 3986: "Uniform Resource Identifiers (URI): Generic Syntax".
[405] IETF RFC 7315: "Private Extensions to the Session Initiation Protocol (SIP) for the 3rd Generation
Partnership Projects (3GPP)".
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 [100].
3GPP
Release 17 14 3GPP TS 32.291 V17.11.0 (2024-09)
3.2 Symbols
For the purposes of the present document, the following symbols apply:
3.3 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].
AF Application Function
AMF Access and Mobility Management Function
ATSSS Access Traffic Steering, Switching, Splitting
CHF Charging Function
CEF Charging Enablement Function
CTF Charging Trigger Function
GPSI Generic Public Subscription Identifier
GUAMI Globally Unique AMF Identifier
I-SMF Intermediate SMF
MnS Management Service
NF Network Function
PEI Permanent Equipment Identifier
QBC QoS flow Based Charging
QFI QoS Flow Identifier
SMSF Short Message Service Function
SMF Session Management Function
SSC Session and Service Continuity
SUPI Subscription Permanent Identifier
4 Overview
3GPP
Release 17 15 3GPP TS 32.291 V17.11.0 (2024-09)
Figure 4.1.1: Reference Architecture for the Nchf_ConvergedCharging Service; SBI representation
- Quota;
- Re-authorisation triggers;
- Notification when Charging Domain determines rating conditions is affected or when CHF determines to
terminate the charging service;
- CDRs generation.
5.1 Introduction
The following services are provided by the CHF.
3GPP
Release 17 16 3GPP TS 32.291 V17.11.0 (2024-09)
- Create resource at service establishment or no existing ChargingData resource, and may allocate quotas based on
the request from NF consumer;
- During the service consumption lifecycle, update resource upon receiving the quota usage or service usage report
under a number of circumstances and allocate subsequent quotas based on the request from NF consumer;
- Release upon service termination, Unit Count Inactivity Timer expiry or error response; and
- Notify NF Service Consumer of the re-authorisation triggers when CHF determines rating conditions is affected,
or the abort triggers when CHF determines to terminate the charging service.
5.2.2.1 Introduction
The service operations defined for Nchf_ ConvergedCharging are shown in table 5.2.2.1-1.
3GPP
Release 17 17 3GPP TS 32.291 V17.11.0 (2024-09)
The following procedures using the Nchf_ConvergedCharging_Create service operation are supported:
3GPP
Release 17 18 3GPP TS 32.291 V17.11.0 (2024-09)
1. NF (CTF) sends a Nchf_ConvergedCharging_Create request to the CHF to create resource for charging.
Requested quota and notification URI for Nchf_ConvergedCharging_Notify service operation are included in the
request body.
2a. At successful operation, "201 Created" response is returned. In the "201 Created" response, the CHF includes a
Location header field and the allocated quota in the body. The Location header field shall contain the URI of the
created resource. The NF (CTF) shall use the URI received in the Location header in subsequent requests to the
CHF for the same PDU session.
2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.3.1-3 shall be returned. For a
4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one
of the application error listed in Table 6.1.7.3-1.
The following procedures using the Nchf_ConvergedCharging_Update service operation are supported:
- the granted service units for one rating group are spent
- charging events occur, which might affect the rating of the current service
1. NF (CTF) sends a Nchf_ConvergedCharging_Update request to the CHF. The {ChargingDataRef } in the URI
identifies the "Charging Data" to be updated. The requested service unit and previous used service unit is
included in the request body.
2a. At successful operation, "200 OK" response is returned. The CHF includes the granted service unit in the "200
OK" response.
2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.4.2.2-2 shall be returned. For a
4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one
of the application error listed in Table 6.1.7.3-1.
The following procedures using the Nchf_ConvergedCharging_Release service operation are supported:
3GPP
Release 17 19 3GPP TS 32.291 V17.11.0 (2024-09)
1. NF(CTF) sends a Nchf_ConvergedCharging_Release request to the CHF. The {ChargingDataRef } in the URI
identifies the "Charging Data" to be updated and then released. The final used service unit is included in the
request body.
2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.4.3.2-2 shall be returned. For a
4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one
of the application error listed in Table 6.1.7.3-1.
The following procedures using the Nchf_ConvergedCharging_Notify service operation are supported:
1. The CHF sends a Nchf_ConvergedCharging_Notify request to the NF (CTF). The {notifyUri} identifies the
notification URI which is sent in the Nchf_ConvergedCharging_Create and can be sent in
Nchf_ConvergedCharging_Update request. The notification type is included in the request body.
3GPP
Release 17 20 3GPP TS 32.291 V17.11.0 (2024-09)
2b. On failure , one of the HTTP status code listed in Table 6.1.5.2.3.1-2 shall be returned. For a 4xx/5xx response,
the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application
error listed in Table 6.1.7.3-1.
After successful operation, when the NF Service Consumer receives a Charging Notify Request while not waiting for
any Charging Data Response from the CHF, CTF can send a new Charging Data Request.
- During the service consumption lifecycle, update resource based on the request from NF consumer;
5.3.2.1 Introduction
The service operations defined for Nchf_OfflineOnlyCharging are shown in table 5.3.2.1-3.
The following procedures using the Nchf_OfflineOnlyCharging_Create service operation are supported:
3GPP
Release 17 21 3GPP TS 32.291 V17.11.0 (2024-09)
1. NF (CTF) sends a Nchf_OfflineOnlyCharging_Create request to the CHF to create resource for starting charging.
2a. At successful operation, "201 Created" response is returned. In the "201 Created" response, the CHF includes a
Location header field in the body. The Location header field shall contain the URI of the created resource. The
NF (CTF) shall use the URI received in the Location header in subsequent requests to the CHF for the same
PDU session.
2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.2.3.1-3 shall be returned. For a
4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one
of the application error listed in Table 6.2.7.3-1.
The following procedures using the Nchf_OfflineOnlyCharging_Update service operation are supported:
2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.3.4.2.2-2 shall be returned. For a
4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one
of the application error listed in Table 6.2.7.3-1.
The following procedures using the Nchf_OfflineOnlyCharging_Release service operation are supported.
3GPP
Release 17 22 3GPP TS 32.291 V17.11.0 (2024-09)
2b. On failure or redirection, one of the HTTP status code listed in Table 6.2.3.3.4.3.2-2 shall be returned. For a
4xx/5xx response, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one
of the application error listed in Table 6.2.7.3-1.
6 API definitions
The request URI used in each HTTP request from the NF service consumer towards the CHF shall have the structure
defined in subclause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
{apiRoot}/{apiName}/{apiVersion}/{apiSpecificResourceUriPart}
6.1.2.1 General
HTTP/2 as described in IETF RFC 7540 [401] shall be used as specified in subclause 5.2 of 3GPP TS 29.500 [299].
6.1.2.2.1 General
See subclause 5.2.2 of 3GPP TS 29.500 [299] for the usage of HTTP standard headers.
3GPP
Release 17 23 3GPP TS 32.291 V17.11.0 (2024-09)
6.1.2.3.1 General
HTTP custom headers specified in clause 5.2.3.2 of 3GPP TS 29.500 [299] shall be supported, and Optional HTTP
custom headers specified in clause 5.2.3.3 of TS 29.500[299] may be supported
6.1.3 Resources
6.1.3.1 Overview
Charging Data Ref is a unique identifier for a charging data resource in a PLMN. It’s created in CHF when CHF
receives a Nchf_ ConvergedCharging_Create request and provided to NF (CTF) in the Location header field in the
Nchf_ ConvergedCharging_Create response. The NF (CTF) shall use the Charging Data Ref received in subsequent
requests to the CHF for the same charging data resource.
Table 6.1.3.1-1 provides an overview of the resources and applicable HTTP methods.
3GPP
Release 17 24 3GPP TS 32.291 V17.11.0 (2024-09)
6.1.3.2.1 Description
Charging Data resource represents a collection of the different charging data resources created by the CHF for
converged charging as defined in 3GPP TS 32.290 [58].
This resource shall support the resource URI variables defined in table 6.1.3.2.2-1.
Name Definition
apiRoot See subclause 6.1.1
6.1.3.2.3.1 POST
This method shall support the URI query parameters specified in table 6.1.3.2.3.1-1.
Table 6.1.3.2.3.1-1: URI query parameters supported by the POST method on this resource
This method shall support the request data structures specified in table 6.1.3.2.3.1-2 and the response data structures and
response codes specified in table 6.1.3.2.3.1-3.
Table 6.1.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
3GPP
Release 17 25 3GPP TS 32.291 V17.11.0 (2024-09)
Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body on this resource
Table 6.1.3.2.3.1-4: Headers supported by the 201 Response Code on this resource
Table 6.1.3.2.3.1-5: Headers supported by the 307 Response Code on this resource
3GPP
Release 17 26 3GPP TS 32.291 V17.11.0 (2024-09)
Table 6.1.3.2.3.1-6: Headers supported by the 308 Response Code on this resource
6.1.3.3.1 Description
Individual Charging Data resource represents a Charging data resource created in the CHF.
This resource shall support the resource URI variables defined in table 6.1.3.3.2-1.
Name Definition
apiRoot See subclause 6.1.1
ChargingDataRef Charging data resource reference assigned by the CHF during the Nchf_
ConvergedCharging_Create operation,
6.1.3.3.4.1 Overview
Mapped
Custom operation URI HTTP Description
method
{apiRoot}/ POST Update an existing Charging Data resource.
nchf-convergedcharging/{apiVersion}/
chargingdata/{ChargingDataRef }/update
{apiRoot}/ POST Update and release an existing Charging Data
nchf-convergedcharging/{apiVersion}/ resource.
chargingdata /{ChargingDataRef}/release
6.1.3.3.4.2.1 Description
3GPP
Release 17 27 3GPP TS 32.291 V17.11.0 (2024-09)
This operation shall support the request data structures specified in table 6.1.3.3.4.2.2-1 and the response data structures
and response codes specified in table 6.1.3.3.4.2.2-2.
Table 6.1.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource
Table 6.1.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource
3GPP
Release 17 28 3GPP TS 32.291 V17.11.0 (2024-09)
Table 6.1.3.3.4.2.2-3: Headers supported by the 307 Response Code on this resource
Table 6.1.3.3.4.2.2-4: Headers supported by the 308 Response Code on this resource
6.1.3.3.4.3.1 Description
This operation shall support the request data structures specified in table 6.1.3.3.4.3.2-1 and the response data structures
and response codes specified in table 6.1.3.3.4.3.2-2.
Table 6.1.3.3.4.3.2-1: Data structures supported by the POST Request Body on this resource
3GPP
Release 17 29 3GPP TS 32.291 V17.11.0 (2024-09)
Table 6.1.3.3.4.3.2-2: Data structures supported by the POST Response Body on this resource
Table 6.1.3.3.4.3.2-3: Headers supported by the 307 Response Code on this resource
Table 6.1.3.3.4.3.2-4: Headers supported by the 308 Response Code on this resource
6.1.5 Notifications
6.1.5.1 General
Notifications shall comply to subclause 6.2 of 3GPP TS 29.500 [299] and subclause 4.6.2.3 of 3GPP TS 29.501 [300].
3GPP
Release 17 30 3GPP TS 32.291 V17.11.0 (2024-09)
6.1.5.2.1 Description
The Notification is used by the CHF to notify NF consumers , which implements the Nchf_
ConvergedCharging_Notify operation defined in 3GPP TS 32.290 [58].
Name Definition
notifyUri String formatted as URI with the Notification URI is provided by the SMF during the creation
and can be provided in update of the Charging Data resource and within the ChargingData
type, as defined in subclause 6.1.6.
6.1.5.2.3.1 POST
This method shall support the request data structures specified in table 6.1.5.2.3.1-1 and the response data structures and
response codes specified in table 6.1.5.2.3.1-2.
Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body on this resource
Table 6.1.5.2.3.1-2: Data structures supported by the POST Response Body on this resource
3GPP
Release 17 31 3GPP TS 32.291 V17.11.0 (2024-09)
Table 6.1.5.2.3.1-3: Headers supported by the 307 Response Code on this resource
Table 6.1.5.2.3.1-4: Headers supported by the 308 Response Code on this resource
6.1.6.1 General
This subclause specifies the application data model supported by the API.
The Nchf_ConvergedCharging Service API allows the NF consumer to consume the converged charging service from
the CHF as defined in 3GPP TS 32.290 [58].
Table 6.1.6.1-1 specifies the data types defined for the ConvergedCharging service based interface protocol.
Table 6.1.6.1-2 specifies data types re-used by the Nchf_ConvergedCharging service based interface protocol from
other specifications, including a reference to their respective specifications and when needed, a short description of their
use within the Nchf_ConvergedCharging service based interface.
3GPP
Release 17 32 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 33 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 34 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 35 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 36 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 37 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 38 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 39 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 40 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 41 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 42 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 43 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 44 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 45 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 46 3GPP TS 32.291 V17.11.0 (2024-09)
6.1.6.2.1.15 Void
This clause is additional attributes of the type ChargingDataRequest defined in clause 6.1.6.2.1.1 for 5G data
connectivity charging described in 3GPP TS 32.255[30].
3GPP
Release 17 47 3GPP TS 32.291 V17.11.0 (2024-09)
This clause is additional attributes of the type ChargingDataResponse defined in clause 6.1.6.2.1.2 for 5G data
connectivity charging described in 3GPP TS 32.255[30].
This clause is additional attributes of the type MultipleUnitUsage defined in clause 6.1.6.2.1.5 for 5G data connectivity
charging described in 3GPP TS 32.255[30].
This clause is additional attributes of the type MultipleUnitInformationdefined in clause 6.1.6.2.1.8 for 5G data
connectivity charging described in 3GPP TS 32.255[30].
This clause is additional portion of the type UsedUnitContainer defined in clause 6.1.6.2.1.10 for 5G data connectivity
charging described in 3GPP TS 32.255[30].
3GPP
Release 17 48 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 49 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 50 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 51 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 52 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 53 3GPP TS 32.291 V17.11.0 (2024-09)
type.
cpCIoTOptimisati boolean OC 0..1 This field holds the indicator 5GSCIoT
onIndicator whether control plane
optimization CIoT for 5GS is
used during the PDU session, if
this feature is enabled.
The default value is false.
5GSControl boolean OC 0..1 This field holds the indicator 5GSCIoT
PlaneOnlyIndicat whether the control plane only
or is used, i.e., the PDU data only
transfers to control plane in
case of control plane CIoT
optimization. The default value
is false.
smallDataRateCo boolean OC 0..1 This field holds the indicator 5GSCIoT
ntrolIndicator whether the small data rate
control for 5GS CIoT is used
during the PDU session. The
default value is false.
5GLANTypeServi 5GLANTypeService OC 0..1 5G LAN Type service 5GLAN
ce information, if present, the 5G
LAN Type service is used.
3GPP
Release 17 54 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 55 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 56 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 57 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 58 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 59 3GPP TS 32.291 V17.11.0 (2024-09)
This clause is additional attributes of the type ChargingDataRequest defined in clause 6.1.6.2.3.1 for SMS charging
described in 3GPP TS 32.274[28].
3GPP
Release 17 60 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 61 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 62 3GPP TS 32.291 V17.11.0 (2024-09)
SM transaction, if
unsuccessful.
This field is only for offline
charging.
submissionTime DateTime OC 0..1 the timestamp of when the
submitted SM arrived at the
originating SMS Node
sMpriority SMPriority OC 0..1 any priority information
associated with an SM
messageReferen string OM 0..1 the identity used to identify an
ce SM in the SMS node
associated with entity that
submitted it
messageSize Uint32 OM 0..1 the total number of short
messages when this SM is
part of concatenated short
message
messageClass MessageClass OM 0..1 implementation dependent
the value selected for a
specific transaction.
deliveryReportRe DeliveryReportRequ OC 0..1 indicates whether a delivery
quested ested report is requested by the SM
originator
3GPP
Release 17 63 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 64 3GPP TS 32.291 V17.11.0 (2024-09)
This clause specifies additional attributes of the type ChargingDataRequest defined in clause 6.1.6.2.1.1 for 5G
connection and mobility described in 3GPP TS 32.256 [31].
3GPP
Release 17 65 3GPP TS 32.291 V17.11.0 (2024-09)
This clause specifies additional attributes of the type ChargingDataResponse defined in clause 6.1.6.2.1.2 for 5G
connection and mobility described in 3GPP TS 32.256 [31].
3GPP
Release 17 66 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 67 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 68 3GPP TS 32.291 V17.11.0 (2024-09)
This clause is additional attributes of the type ChargingDataRequest defined in clause 6.1.6.2.1.1 for Exposure Function
Northbound API charging described in 3GPP TS 32.254[14].
This clause specifies additional attributes of the type ChargingDataResponse defined in clause 6.1.6.2.1.2 for Exposure
Function Northbound API charging described in 3GPP TS 32.254[14].
3GPP
Release 17 69 3GPP TS 32.291 V17.11.0 (2024-09)
This clause specifies additional attributes of the type ChargingDataRequest defined in clause 6.1.6.2.1.1 for Network
Slice Management (NSM) charging described in 3GPP TS 28.202 [71].
Table 6.1.6.2.6.1-1: Network Slice Management (NSM) charging specified attribute of type
ChargingDataRequest
This clause specifies additional attributes of the type ChargingDataResponse defined in clause 6.1.6.2.1.2 Network
Slice Management (NSM) charging described in 3GPP TS 28.202 [71].
3GPP
Release 17 70 3GPP TS 32.291 V17.11.0 (2024-09)
Table 6.1.6.2.6.2-1: Network Slice Management (NSM) charging specified attribute of type
ChargingDataResponse
3GPP
Release 17 71 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 72 3GPP TS 32.291 V17.11.0 (2024-09)
This clause is additional attributes of the type ChargingDataRequest defined in clause 6.1.6.2.7.1 for NS performance
and analytics charging described in 3GPP TS 28.201[201].
This clause is additional attributes of the type ChargingDataResponse defined in clause 6.1.6.2.7.2 for NS performance
and analytics charging described in 3GPP TS 28.201[201].
This clause is additional portion of the type UsedUnitContainer defined in clause 6.1.6.2.1.10 for NS performance and
analytics charging described in 3GPP TS 28.201[201].
3GPP
Release 17 73 3GPP TS 32.291 V17.11.0 (2024-09)
This clause is additional attributes of the type ChargingDataRequest defined in clause 6.1.6.2.1.1 for IMS charging
described in 3GPP TS 32.260 [32].
This clause is additional attributes of the type ChargingDataResponse defined in clause 6.1.6.2.1.2 for IMS charging
described in 3GPP TS 32.260 [32].
3GPP
Release 17 74 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 75 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 76 3GPP TS 32.291 V17.11.0 (2024-09)
ID under registration.
3GPP
Release 17 77 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 78 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 79 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 80 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 81 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 82 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 83 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 84 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 85 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 86 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 87 3GPP TS 32.291 V17.11.0 (2024-09)
6.1.6.2.8.16 Void
3GPP
Release 17 88 3GPP TS 32.291 V17.11.0 (2024-09)
This clause is additional attributes of the type MultipleUnitInformation defined in clause 6.1.6.2.1.8 for announcement
described in 3GPP TS 32.281 [34].
3GPP
Release 17 89 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 90 3GPP TS 32.291 V17.11.0 (2024-09)
This clause is additional attributes of the type ChargingDataRequest defined in clause 6.4.1.2.1 for MMTel charging
described in 3GPP TS 32.275 [33].
This clause is additional attributes of the type ChargingDataResponse defined in clause 6.4.1.2.2 for MMTel charging
described in 3GPP TS 32.275 [33].
3GPP
Release 17 91 3GPP TS 32.291 V17.11.0 (2024-09)
This clause is additional attributes of the type ChargingDataRequest defined in clause 6.5.2.2 for 5G ProSe charging
described in TS 32.277[35].
3GPP
Release 17 92 3GPP TS 32.291 V17.11.0 (2024-09)
This clause is additional attributes of the type ChargingDataResponse defined in clause 6.5.2.2 for 5G ProSe charging
described in TS 32.277[35].
This clause is additional portion of the type PC5ContainerInformation defined in clause 6.5.2.2 for 5G ProSe charging
described in TS 32.277[35].
3GPP
Release 17 93 3GPP TS 32.291 V17.11.0 (2024-09)
This clause is additional portion of the type RadioParameterSetInfo defined in clause 6.5.2.2 for 5G ProSe charging
described in TS 32.277[35].
This clause is additional portion of the type TransmitterInfo defined in clause 6.5.2.2 for 5G ProSe charging described
in TS 32.277[35].
3GPP
Release 17 94 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 95 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 96 3GPP TS 32.291 V17.11.0 (2024-09)
This clause is additional portion of the type PFIContainerInformation defined in clause 6.5.2.2 for 5G ProSe charging
described in TS 32.277[35].
3GPP
Release 17 97 3GPP TS 32.291 V17.11.0 (2024-09)
This clause is additional attributes of the type ChargingDataRequest defined in clause 6.1.6.2.1.1 for edge computing
domain charging described in TS 32.257 [36].
3GPP
Release 17 98 3GPP TS 32.291 V17.11.0 (2024-09)
Editor’s note: all attribute names and data types are FFS dependent TS 24.558 [311] and TS 29.558 [309] release.
This clause specifies additional attributes of the type ChargingDataResponse defined in clause 6.1.6.2.1.2 for edge
computing domain charging described in TS 32.257 [36].
3GPP
Release 17 99 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 100 3GPP TS 32.291 V17.11.0 (2024-09)
6.1.6.3.1 Introduction
This subclause defines simple data types and enumerations that can be referenced from data structures defined in the
previous subclauses.
3GPP
Release 17 101 3GPP TS 32.291 V17.11.0 (2024-09)
Pattern: '^[A-Fa-f0-9]+$'
E164 string This field is encoded as a TBCD-string,
see TS 29.002 [261].
Pattern: '^[A-Fa-f0-9]+$'
3GPP
Release 17 102 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 103 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 104 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 105 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 106 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 107 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 108 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 109 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 110 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 111 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 112 3GPP TS 32.291 V17.11.0 (2024-09)
6.1.6.3.17 Void
3GPP
Release 17 113 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 114 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 115 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 116 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 117 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 118 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 119 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 120 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 121 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 122 3GPP TS 32.291 V17.11.0 (2024-09)
6.1.6.4 Data types describing alternative data types or combinations of data types
None.
6.1.7.1 General
HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [299].
3GPP
Release 17 123 3GPP TS 32.291 V17.11.0 (2024-09)
For the Nchf_ConvergedCharging API, HTTP error responses shall be supported as specified in clause 4.8 of
3GPP TS 29.501 [2]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [299] shall
be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP
method in table 5.2.7.1-1 of 3GPP TS 29.500 [299]. In addition, the requirements in the following clauses shall apply.
3GPP
Release 17 124 3GPP TS 32.291 V17.11.0 (2024-09)
6.1.9.1 General
The functionalities specified for Service Based Architecture in clause 6 of TS 29.500 [299], may be supported. Any
deviation from or special usage of the specified functionalities are described in this clause.
The only JSON data types that can be extended, by defining additional members, are JSON objects; simple data types
(and arrays of items of simple data types) cannot be extended in this way. The charging vendor-specific extensions use
the extensibility mechanism defined in clause 6.6 of TS 29.500 [299].
3GPP
Release 17 125 3GPP TS 32.291 V17.11.0 (2024-09)
The request URI used in each HTTP request from the NF service consumer towards the CHF shall have the structure
defined in clause 4.4.1 of 3GPP TS 29.501 [5], i.e.:
{apiRoot}/{apiName}/{apiVersion}/{apiSpecificResourceUriPart}
3GPP
Release 17 126 3GPP TS 32.291 V17.11.0 (2024-09)
6.2.3 Resources
6.2.3.1 Overview
Offline Only Charging Data Ref is a unique identifier for an offline only charging data resource in a PLMN. It’s created
in CHF when CHF receives a Nchf_ OfflineOnlyCharging_Create request and provided to NF (CTF) in the Location
header field in the Nchf_ OfflineOnlyCharging_Create response. The NF (CTF) shall use the Offline Only Charging
Data Ref received in subsequent requests to the CHF for the same charging data resource.
Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods.
6.2.3.2.1 Description
Offline Only Charging Data resource represents a collection of the different offline only charging data resources created
by the CHF for offline only charging as defined in 3GPP TS 32.290 [58].
3GPP
Release 17 127 3GPP TS 32.291 V17.11.0 (2024-09)
This resource shall support the resource URI variables defined in table 6.2.3.2.2-1.
Name Definition
apiRoot See clause 6.2.1
6.2.3.2.3.1 POST
This method shall support the URI query parameters specified in table 6.2.3.2.3.1-1.
Table 6.2.3.2.3.1-1: URI query parameters supported by the POST method on this resource
This method shall support the request data structures specified in table 6.2.3.2.3.1-2 and the response data structures and
response codes specified in table 6.2.3.2.3.1-3.
Table 6.2.3.2.3.1-2: Data structures supported by the POST Request Body on this resource
3GPP
Release 17 128 3GPP TS 32.291 V17.11.0 (2024-09)
Table 6.2.3.2.3.1-3: Data structures supported by the POST Response Body on this resource
M 1 405 (NOTE 2)
Method
Not
Allowed
M 1 408 (NOTE 2)
Request
Timeout
M 1 500 (NOTE 2)
Internal
Server
Error
M 1 503 (NOTE 2)
Service
Unavailabl
e
M 1 508 (NOTE 2)
Gateway
Timeout
NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of
3GPP TS 29.500 [299] for the POST method also apply.
NOTE 2: Failure cases are described in clause 6.2.7.
6.2.3.3.1 Description
Individual Offline Only Charging Data resource represents an offline only charging data resource created in the CHF.
3GPP
Release 17 129 3GPP TS 32.291 V17.11.0 (2024-09)
This resource shall support the resource URI variables defined in table 6.2.3.3.2-1.
Name Definition
apiRoot See clause 6.2.1
OfflineChargingDataRe Offline only charging data resource reference assigned by the CHF during the Nchf_
f OfflineOnlyCharging_Create operation,
6.2.3.3.4.1 Overview
Mapped
Custom operation URI HTTP Description
method
{apiRoot}/ POST Update an existing Offline Only Charging Data
nchf-offlineonlyncharging/v1/ resource.
offlinechargingdata/{OfflineChargingDataRef
}/update
{apiRoot}/ POST Update and release an existing Offline Only
nchf-offlinecharging/v1/ Charging Data resource.
offlinechargingdata
/{OfflineChargingDataRef}/release
6.2.3.3.4.2.1 Description
This operation shall support the request data structures specified in table 6.2.3.3.4.2.2-1 and the response data structures
and response codes specified in table 6.2.3.3.4.2.2-2.
Table 6.2.3.3.4.2.2-1: Data structures supported by the POST Request Body on this resource
3GPP
Release 17 130 3GPP TS 32.291 V17.11.0 (2024-09)
Table 6.2.3.3.4.2.2-2: Data structures supported by the POST Response Body on this resource
M 1 405 (NOTE 2)
Method
Not
Allowed
M 1 408 (NOTE 2)
Request
Timeout
M 1 500 (NOTE 2)
Internal
Server
Error
M 1 503 (NOTE 2)
Service
Unavailabl
e
M 1 508 (NOTE 2)
Gateway
Timeout
NOTE 1: In addition, the HTTP status codes which are specified as mandatory in table 5.2.7.1-1 of
3GPP TS 29.500 [299] for the POST method also apply.
NOTE 2: Failure cases are described in clause 6.2.7.
6.2.3.3.4.3.1 Description
This operation shall support the request data structures specified in table 6.2.3.3.4.3.2-1 and the response data structures
and response codes specified in table 6.2.3.3.4.3.2-2.
3GPP
Release 17 131 3GPP TS 32.291 V17.11.0 (2024-09)
Table 6.2.3.3.4.3.2-1: Data structures supported by the POST Request Body on this resource
Table 6.2.3.3.4.3.2-2: Data structures supported by the POST Response Body on this resource
Data type P
Cardinality Response Description
codes
n/a M 1 204 No Successful case: The Offline Only Charging Data resource
Content matching the OfflineChargingDataRef is modified and then
released.
ChargingDataRespons M 1 404 Not (NOTE 2)
e Found
NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500
[299] also apply.
6.2.5.1 General
This clause specifies the application data model supported by the API.
The Nchf_OfflineOnlyCharging Service API allows the NF consumer to consume the offline only charging service
from the CHF as defined in 3GPP TS 32.290 [58].
Table 6.2.5.1-1 specifies the data types defined for the OfflineOlnyCharging service based interface protocol.
The data types specified in Table 6.1.6.1-2 of this document are applied and re-used by the Nchf_OfflineOnlyCharging
service based interface protocol.
3GPP
Release 17 132 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 133 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 134 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 135 3GPP TS 32.291 V17.11.0 (2024-09)
The additional attributes of the type ChargingDataRequest defined in clause 6.2.5.2.1.1 for 5G data connectivity
charging see table 6.1.6.2.2.1-1.
The additional attributes of the type ChargingDataResponse defined in clause 6.2.5.2.1.2 for 5G data connectivity
charging see table 6.1.6.2.2.2-1.
The additional attributes of the type MultipleUnitUsage defined in clause 6.2.5.2.1.3 for 5G data connectivity charging
see table 6.1.6.2.2.3-1.
The additional attributes of the type UsedUnitContainer defined in clause 6.2.5.2.1.4 for 5G data connectivity charging
see table 6.1.6.2.2.5-1.
The additional attributes of the Type PDUSessionChargingInformation for 5G data connectivity charging see table
6.1.6.2.2.6-1.
The additional attributes of the Type UserInformation for 5G data connectivity charging see table 6.1.6.2.2.7-1.
The additional attributes of the Type PDUSessionInformation for 5G data connectivity charging see table 6.1.6.2.2.8-1.
The additional attributes of the Type PDUContainerInformation for 5G data connectivity charging see table 6.1.6.2.2.9-
1.
The additional attributes of the Type NetworkSlicingInfo for 5G data connectivity charging see table 6.1.6.2.2.10-1.
The additional attributes of the Type PDUAddress for 5G data connectivity charging see table 6.1.6.2.2.11-1.
The additional attributes of the Type ServingNetworkFunctionID for 5G data connectivity charging see table
6.1.6.2.2.12-1.
The additional attributes of the Type RoamingQBCInformation for 5G data connectivity charging see table 6.1.6.2.2.13-
1.
3GPP
Release 17 136 3GPP TS 32.291 V17.11.0 (2024-09)
The additional attributes of the Type MultipleQFIcontainer for 5G data connectivity charging see table 6.1.6.2.2.14-1.
The additional attributes of the Type RoamingChargingProfile for 5G data connectivity charging see table 6.1.6.2.2.15-
1.
The additional attributes of the Type QFIContainerInformation for 5G data connectivity charging see table 6.1.6.2.2.16-
1.
The additional attributes of the Type RANSecondaryRATUsageReport for 5G data connectivity charging see table
6.1.6.2.2.17-1.
The additional attributes of the Type QosFlowsUsageReport for 5G data connectivity charging see table 6.1.6.2.2.18-1.
6.2.5.3.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the
previous clauses.
3GPP
Release 17 137 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 138 3GPP TS 32.291 V17.11.0 (2024-09)
6.2.5.3.10 Void
6.2.6.1 General
HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [299].
For the Nchf_OfflineOnlyCharging API, HTTP error responses shall be supported as specified in clause 4.8 of
3GPP TS 29.501 [2]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [299] shall
be supported for an HTTP method if the corresponding HTTP status codes are specified as mandatory for that HTTP
method in table 5.2.7.1-1 of 3GPP TS 29.500 [299]. In addition, the requirements in the following clauses shall apply.
3GPP
Release 17 139 3GPP TS 32.291 V17.11.0 (2024-09)
7.0 General
This clause aims to describe the mapping between the Service Charging Information element, Resource Attribute and
CDR field for 5G charging.
Table 7.1-1 and 7.2-1 describes the mapping of the Information Element, Resource Attribute and CDR field of CHF-
CDR for 5G charging.
3GPP
Release 17 140 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 141 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 142 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 143 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 144 3GPP TS 32.291 V17.11.0 (2024-09)
ChargingDataRequest
3GPP
Release 17 145 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 146 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 147 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 148 3GPP TS 32.291 V17.11.0 (2024-09)
rATType
Report Time Report Time /roamingQBCInformation/multipleQFIcontainer/
qFIContainerInformation/reportTime
Serving Network Function ID Serving Network Function ID /roamingQBCInformation/
multipleQFIcontainer/qFIContainerInformation/
servingNetworkFunctionID
3GPP PS Data Off Status 3GPP PS Data Off Status /roamingQBCInformation/
multipleQFIcontainer/qFIContainerInformation/
3gppPSDataOffStatus
EPS bearer Charging Id EPS bearer Charging Id /roamingQBCInformation/
multipleQFIcontainer/
qFIContainerInformation/3gppChargingId
Diagnostics Diagnostics /roamingQBCInformation/
multipleQFIcontainer/qFIContainerInformation/
diagnostics
Enhanced Diagnostics Enhanced Diagnostics /roamingQBCInformation/
multipleQFIcontainer/qFIContainerInformation/
enhancedDiagnostics
UPF ID UPF ID /roamingQBCInformation/uPFID
UPF ID -
/multipleUnitInformation/uPFID
PDU Session Charging Information - /pDUSessionChargingInformation
3GPP
Release 17 149 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 150 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 151 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 152 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 153 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 154 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 155 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 156 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 157 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 158 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 159 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 160 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 161 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 162 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 163 3GPP TS 32.291 V17.11.0 (2024-09)
timeOfLastUsage
3GPP
Release 17 164 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 165 3GPP TS 32.291 V17.11.0 (2024-09)
ChargingDataResponse
8 Security
Security aspects for service based interface shall be supported as specified in subclause 13 of 3GPP TS 33.501 [390].
As indicated in 3GPP TS 33.501 [390] and 3GPP TS 29.500 [299], the access to the Nchf_ ConvergedCharging API
and to the Nchf_OfflineOnlyCharging API may be authorized by means of the OAuth2 protocol (see
IETF RFC 6749 [403]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF
(see 3GPP TS 29.510 [305]) plays the role of the authorization server.
3GPP
Release 17 166 3GPP TS 32.291 V17.11.0 (2024-09)
If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nchf_
ConvergedCharging API and by the Nchf_OfflineOnlyCharging API, shall obtain a "token" from the authorization
server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [305], clause 5.4.2.2.
NOTE: When multiple NRFs are deployed in a network, the NRF used as authorization server is the same NRF
that the NF Service Consumer used for discovering the Nchf_ ConvergedCharging service. The same
principle applies for Nchf_OfflineOnlyCharging API.
The Nchf_ ConvergedCharging API defines a single scope "nchf-convergedcharging" for the entire service, and it does
not define any additional scopes at resource and operation level.
The Nchf_OfflineOnlyCharging API defines a single scope "nchf-offlineonlycharging" for the entire service, and it
does not define any additional scopes at resource and operation level.
Annex A (normative):
OpenAPI specification
A.1 General
The present Annex contains two OpenAPIs [500] specification of HTTP messages and content bodies used by the
Nchf_ConvergedCharging API and Nchf_OfflineOnlyCharging API.
This Annex takes precedence when being discrepant to other parts of the specification with respect to the encoding of
information elements and methods within the API(s).
NOTE 1: The semantics and procedures, as well as conditions, e.g. for the applicability and allowed combinations
of attributes or values, not expressed in the OpenAPI definitions but defined in other parts of the
specification also apply.
Informative copies of the OpenAPI specification files contained in this document are available on a repository (see
3GPP TS 29.501 [300] clause 5.3.1 and 3GPP TR 21.900 [101] clause 5B)).
3GPP
Release 17 167 3GPP TS 32.291 V17.11.0 (2024-09)
$ref: '#/components/schemas/ChargingDataRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/ChargingDataResponse'
'400':
description: Bad request
content:
application/problem+json:
schema:
oneOf:
- $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
- $ref: '#/components/schemas/ChargingDataResponse'
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'403':
description: Forbidden
content:
application/problem+json:
schema:
oneOf:
- $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
- $ref: '#/components/schemas/ChargingDataResponse'
'404':
description: Not Found
content:
application/problem+json:
schema:
oneOf:
- $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
- $ref: '#/components/schemas/ChargingDataResponse'
'405':
$ref: 'TS29571_CommonData.yaml#/components/responses/405'
'408':
$ref: 'TS29571_CommonData.yaml#/components/responses/408'
'410':
$ref: 'TS29571_CommonData.yaml#/components/responses/410'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
callbacks:
chargingNotification:
'{$request.body#/notifyUri}':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChargingNotifyRequest'
responses:
'200':
description: OK.
content:
application/ json:
schema:
$ref: '#/components/schemas/ChargingNotifyResponse'
'204':
description: 'No Content, Notification was succesfull'
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'400':
3GPP
Release 17 168 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 169 3GPP TS 32.291 V17.11.0 (2024-09)
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChargingDataRequest'
parameters:
- name: ChargingDataRef
in: path
description: a unique identifier for a charging data resource in a PLMN
required: true
schema:
type: string
responses:
'204':
description: No Content.
'307':
$ref: 'TS29571_CommonData.yaml#/components/responses/307'
'308':
$ref: 'TS29571_CommonData.yaml#/components/responses/308'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'404':
description: Not Found
content:
application/problem+json:
schema:
oneOf:
- $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
- $ref: '#/components/schemas/ChargingDataResponse'
'410':
$ref: 'TS29571_CommonData.yaml#/components/responses/410'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
nchf-convergedcharging: Access to the Nchf_ConvergedCharging API
schemas:
ChargingDataRequest:
type: object
properties:
subscriberIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
tenantIdentifier:
type: string
chargingId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId'
mnSConsumerIdentifier:
type: string
nfConsumerIdentification:
$ref: '#/components/schemas/NFIdentification'
invocationTimeStamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
invocationSequenceNumber:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
retransmissionIndicator:
type: boolean
oneTimeEvent:
type: boolean
oneTimeEventType:
$ref: '#/components/schemas/oneTimeEventType'
notifyUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
3GPP
Release 17 170 3GPP TS 32.291 V17.11.0 (2024-09)
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
serviceSpecificationInfo:
type: string
multipleUnitUsage:
type: array
items:
$ref: '#/components/schemas/MultipleUnitUsage'
minItems: 0
triggers:
type: array
items:
$ref: '#/components/schemas/Trigger'
minItems: 0
easid:
type: string
ednid:
type: string
eASProviderIdentifier:
type: string
aMFId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AmfId'
pDUSessionChargingInformation:
$ref: '#/components/schemas/PDUSessionChargingInformation'
roamingQBCInformation:
$ref: '#/components/schemas/RoamingQBCInformation'
sMSChargingInformation:
$ref: '#/components/schemas/SMSChargingInformation'
nEFChargingInformation:
$ref: '#/components/schemas/NEFChargingInformation'
registrationChargingInformation:
$ref: '#/components/schemas/RegistrationChargingInformation'
n2ConnectionChargingInformation:
$ref: '#/components/schemas/N2ConnectionChargingInformation'
locationReportingChargingInformation:
$ref: '#/components/schemas/LocationReportingChargingInformation'
nSPAChargingInformation:
$ref: '#/components/schemas/NSPAChargingInformation'
nSMChargingInformation:
$ref: '#/components/schemas/NSMChargingInformation'
mMTelChargingInformation:
$ref: '#/components/schemas/MMTelChargingInformation'
iMSChargingInformation:
$ref: '#/components/schemas/IMSChargingInformation'
edgeInfrastructureUsageChargingInformation:
$ref: '#/components/schemas/EdgeInfrastructureUsageChargingInformation'
eASDeploymentChargingInformation:
$ref: '#/components/schemas/EASDeploymentChargingInformation'
directEdgeEnablingServiceChargingInformation:
$ref: '#/components/schemas/NEFChargingInformation'
exposedEdgeEnablingServiceChargingInformation:
$ref: '#/components/schemas/NEFChargingInformation'
proSeChargingInformation:
$ref: '#/components/schemas/ProseChargingInformation'
required:
- nfConsumerIdentification
- invocationTimeStamp
- invocationSequenceNumber
ChargingDataResponse:
type: object
properties:
invocationTimeStamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
invocationSequenceNumber:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
invocationResult:
$ref: '#/components/schemas/InvocationResult'
sessionFailover:
$ref: '#/components/schemas/SessionFailover'
supportedFeatures:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
multipleUnitInformation:
type: array
items:
$ref: '#/components/schemas/MultipleUnitInformation'
minItems: 0
triggers:
type: array
3GPP
Release 17 171 3GPP TS 32.291 V17.11.0 (2024-09)
items:
$ref: '#/components/schemas/Trigger'
minItems: 0
pDUSessionChargingInformation:
$ref: '#/components/schemas/PDUSessionChargingInformation'
roamingQBCInformation:
$ref: '#/components/schemas/RoamingQBCInformation'
locationReportingChargingInformation:
$ref: '#/components/schemas/LocationReportingChargingInformation'
required:
- invocationTimeStamp
- invocationSequenceNumber
ChargingNotifyRequest:
type: object
properties:
notificationType:
$ref: '#/components/schemas/NotificationType'
reauthorizationDetails:
type: array
items:
$ref: '#/components/schemas/ReauthorizationDetails'
minItems: 0
required:
- notificationType
ChargingNotifyResponse:
type: object
properties:
invocationResult:
$ref: '#/components/schemas/InvocationResult'
NFIdentification:
type: object
properties:
nFName:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
nFIPv4Address:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
nFIPv6Address:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
nFPLMNID:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
nodeFunctionality:
$ref: '#/components/schemas/NodeFunctionality'
nFFqdn:
type: string
required:
- nodeFunctionality
MultipleUnitUsage:
type: object
properties:
ratingGroup:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatingGroup'
requestedUnit:
$ref: '#/components/schemas/RequestedUnit'
usedUnitContainer:
type: array
items:
$ref: '#/components/schemas/UsedUnitContainer'
minItems: 0
uPFID:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
multihomedPDUAddress:
$ref: '#/components/schemas/PDUAddress'
required:
- ratingGroup
InvocationResult:
type: object
properties:
error:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
failureHandling:
$ref: '#/components/schemas/FailureHandling'
Trigger:
type: object
properties:
triggerType:
$ref: '#/components/schemas/TriggerType'
triggerCategory:
$ref: '#/components/schemas/TriggerCategory'
3GPP
Release 17 172 3GPP TS 32.291 V17.11.0 (2024-09)
timeLimit:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
volumeLimit:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
volumeLimit64:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
eventLimit:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
maxNumberOfccc:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
tariffTimeChange:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
required:
- triggerCategory
MultipleUnitInformation:
type: object
properties:
resultCode:
$ref: '#/components/schemas/ResultCode'
ratingGroup:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatingGroup'
grantedUnit:
$ref: '#/components/schemas/GrantedUnit'
triggers:
type: array
items:
$ref: '#/components/schemas/Trigger'
minItems: 0
validityTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
quotaHoldingTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
finalUnitIndication:
$ref: '#/components/schemas/FinalUnitIndication'
timeQuotaThreshold:
type: integer
volumeQuotaThreshold:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
unitQuotaThreshold:
type: integer
uPFID:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
announcementInformation:
$ref: '#/components/schemas/AnnouncementInformation'
required:
- ratingGroup
RequestedUnit:
type: object
properties:
time:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
totalVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
uplinkVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
downlinkVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
serviceSpecificUnits:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
UsedUnitContainer:
type: object
properties:
serviceId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceId'
quotaManagementIndicator:
$ref: '#/components/schemas/QuotaManagementIndicator'
triggers:
type: array
items:
$ref: '#/components/schemas/Trigger'
minItems: 0
triggerTimestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
time:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
totalVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
uplinkVolume:
3GPP
Release 17 173 3GPP TS 32.291 V17.11.0 (2024-09)
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
downlinkVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
serviceSpecificUnits:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
eventTimeStamps:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
minItems: 0
localSequenceNumber:
type: integer
pDUContainerInformation:
$ref: '#/components/schemas/PDUContainerInformation'
nSPAContainerInformation:
$ref: '#/components/schemas/NSPAContainerInformation'
pC5ContainerInformation:
$ref: '#/components/schemas/PC5ContainerInformation'
required:
- localSequenceNumber
GrantedUnit:
type: object
properties:
tariffTimeChange:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
time:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
totalVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
uplinkVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
downlinkVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
serviceSpecificUnits:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
FinalUnitIndication:
type: object
properties:
finalUnitAction:
$ref: '#/components/schemas/FinalUnitAction'
restrictionFilterRule:
$ref: '#/components/schemas/IPFilterRule'
restrictionFilterRuleList:
type: array
items:
$ref: '#/components/schemas/IPFilterRule'
minItems: 1
filterId:
type: string
filterIdList:
type: array
items:
type: string
minItems: 1
redirectServer:
$ref: '#/components/schemas/RedirectServer'
required:
- finalUnitAction
RedirectServer:
type: object
properties:
redirectAddressType:
$ref: '#/components/schemas/RedirectAddressType'
redirectServerAddress:
type: string
required:
- redirectAddressType
- redirectServerAddress
ReauthorizationDetails:
type: object
properties:
serviceId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceId'
ratingGroup:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatingGroup'
quotaManagementIndicator:
$ref: '#/components/schemas/QuotaManagementIndicator'
3GPP
Release 17 174 3GPP TS 32.291 V17.11.0 (2024-09)
PDUSessionChargingInformation:
type: object
properties:
chargingId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId'
sMFchargingId:
type: string
homeProvidedChargingId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId'
sMFHomeProvidedChargingId:
type: string
userInformation:
$ref: '#/components/schemas/UserInformation'
userLocationinfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
mAPDUNon3GPPUserLocationInfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
non3GPPUserLocationTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
mAPDUNon3GPPUserLocationTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
presenceReportingAreaInformation:
type: object
additionalProperties:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo'
minProperties: 0
uetimeZone:
$ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
pduSessionInformation:
$ref: '#/components/schemas/PDUSessionInformation'
unitCountInactivityTimer:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
rANSecondaryRATUsageReport:
$ref: '#/components/schemas/RANSecondaryRATUsageReport'
UserInformation:
type: object
properties:
servedGPSI:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
servedPEI:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Pei'
unauthenticatedFlag:
type: boolean
roamerInOut:
$ref: '#/components/schemas/RoamerInOut'
PDUSessionInformation:
type: object
properties:
networkSlicingInfo:
$ref: '#/components/schemas/NetworkSlicingInfo'
pduSessionID:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
pduType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType'
sscMode:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode'
hPlmnId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
servingNetworkFunctionID:
$ref: '#/components/schemas/ServingNetworkFunctionID'
ratType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
mAPDUNon3GPPRATType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
dnnId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
dnnSelectionMode:
$ref: '#/components/schemas/dnnSelectionMode'
chargingCharacteristics:
type: string
pattern: '^[0-9a-fA-F]{1,4}$'
chargingCharacteristicsSelectionMode:
$ref: '#/components/schemas/ChargingCharacteristicsSelectionMode'
startTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
stopTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
3gppPSDataOffStatus:
3GPP
Release 17 175 3GPP TS 32.291 V17.11.0 (2024-09)
$ref: '#/components/schemas/3GPPPSDataOffStatus'
sessionStopIndicator:
type: boolean
pduAddress:
$ref: '#/components/schemas/PDUAddress'
diagnostics:
$ref: '#/components/schemas/Diagnostics'
authorizedQoSInformation:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AuthorizedDefaultQos'
subscribedQoSInformation:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SubscribedDefaultQos'
authorizedSessionAMBR:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr'
subscribedSessionAMBR:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr'
servingCNPlmnId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
mAPDUSessionInformation:
$ref: '#/components/schemas/MAPDUSessionInformation'
enhancedDiagnostics:
$ref: '#/components/schemas/EnhancedDiagnostics5G'
redundantTransmissionType:
$ref: '#/components/schemas/RedundantTransmissionType'
pDUSessionPairID:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
cpCIoTOptimisationIndicator:
type: boolean
5GSControlPlaneOnlyIndicator:
type: boolean
smallDataRateControlIndicator:
type: boolean
5GLANTypeService:
$ref: '#/components/schemas/5GLANTypeService'
required:
- pduSessionID
- dnnId
PDUContainerInformation:
type: object
properties:
timeofFirstUsage:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
timeofLastUsage:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
qoSInformation:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosData'
qoSCharacteristics:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosCharacteristics'
afChargingIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId'
afChargingIdString:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationChargingId'
userLocationInformation:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
uetimeZone:
$ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
rATType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
servingNodeID:
type: array
items:
$ref: '#/components/schemas/ServingNetworkFunctionID'
minItems: 0
presenceReportingAreaInformation:
type: object
additionalProperties:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo'
minProperties: 0
3gppPSDataOffStatus:
$ref: '#/components/schemas/3GPPPSDataOffStatus'
sponsorIdentity:
type: string
applicationserviceProviderIdentity:
type: string
chargingRuleBaseName:
type: string
mAPDUSteeringFunctionality:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteeringFunctionality'
mAPDUSteeringMode:
3GPP
Release 17 176 3GPP TS 32.291 V17.11.0 (2024-09)
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteeringMode'
trafficForwardingWay:
$ref: '#/components/schemas/TrafficForwardingWay'
qosMonitoringReport:
type: array
items:
$ref: '#/components/schemas/QosMonitoringReport'
minItems: 0
NSPAContainerInformation:
type: object
properties:
latency:
type: integer
# Included for backwards compatibility, shall not be used
uplinkLatency:
type: integer
downlinkLatency:
type: integer
throughput:
$ref: '#/components/schemas/Throughput'
# Included for backwards compatibility, shall not be used
uplinkThroughput:
$ref: '#/components/schemas/Throughput'
downlinkThroughput:
$ref: '#/components/schemas/Throughput'
maximumPacketLossRate:
# Included for backwards compatibility, shall not be used
type: string
maximumPacketLossRateUL:
type: integer
maximumPacketLossRateDL:
type: integer
serviceExperienceStatisticsData:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/ServiceExperienceInfo'
theNumberOfPDUSessions:
type: integer
theNumberOfRegisteredSubscribers:
type: integer
loadLevel:
$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NsiLoadLevelInfo'
NSPAChargingInformation:
type: object
properties:
singleNSSAI:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
required:
- singleNSSAI
NetworkSlicingInfo:
type: object
properties:
sNSSAI:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
required:
- sNSSAI
PDUAddress:
type: object
properties:
pduIPv4Address:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
pduIPv6AddresswithPrefix:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
pduAddressprefixlength:
type: integer
iPv4dynamicAddressFlag:
type: boolean
iPv6dynamicPrefixFlag:
type: boolean
addIpv6AddrPrefixes:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
addIpv6AddrPrefixList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix'
ServingNetworkFunctionID:
type: object
properties:
servingNetworkFunctionInformation:
$ref: '#/components/schemas/NFIdentification'
3GPP
Release 17 177 3GPP TS 32.291 V17.11.0 (2024-09)
aMFId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AmfId'
required:
- servingNetworkFunctionInformation
RoamingQBCInformation:
type: object
properties:
multipleQFIcontainer:
type: array
items:
$ref: '#/components/schemas/MultipleQFIcontainer'
minItems: 0
uPFID:
# Included for backwards compatibility and
# can be included based on operators requirement
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
roamingChargingProfile:
$ref: '#/components/schemas/RoamingChargingProfile'
MultipleQFIcontainer:
type: object
properties:
triggers:
type: array
items:
$ref: '#/components/schemas/Trigger'
minItems: 0
triggerTimestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
time:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
totalVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
uplinkVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
downlinkVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
localSequenceNumber:
type: integer
qFIContainerInformation:
$ref: '#/components/schemas/QFIContainerInformation'
required:
- localSequenceNumber
QFIContainerInformation:
type: object
properties:
qFI:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi'
reportTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
timeofFirstUsage:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
timeofLastUsage:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
qoSInformation:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosData'
qoSCharacteristics:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosCharacteristics'
userLocationInformation:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
uetimeZone:
$ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
presenceReportingAreaInformation:
type: object
additionalProperties:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo'
minProperties: 0
rATType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
servingNetworkFunctionID:
type: array
items:
$ref: '#/components/schemas/ServingNetworkFunctionID'
minItems: 0
3gppPSDataOffStatus:
$ref: '#/components/schemas/3GPPPSDataOffStatus'
3gppChargingId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId'
diagnostics:
3GPP
Release 17 178 3GPP TS 32.291 V17.11.0 (2024-09)
$ref: '#/components/schemas/Diagnostics'
enhancedDiagnostics:
type: array
items:
type: string
required:
- reportTime
RoamingChargingProfile:
type: object
properties:
triggers:
type: array
items:
$ref: '#/components/schemas/Trigger'
minItems: 0
partialRecordMethod:
$ref: '#/components/schemas/PartialRecordMethod'
SMSChargingInformation:
type: object
properties:
originatorInfo:
$ref: '#/components/schemas/OriginatorInfo'
recipientInfo:
type: array
items:
$ref: '#/components/schemas/RecipientInfo'
minItems: 0
userEquipmentInfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Pei'
roamerInOut:
$ref: '#/components/schemas/RoamerInOut'
userLocationinfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
uetimeZone:
$ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
rATType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
sMSCAddress:
type: string
sMDataCodingScheme:
type: integer
sMMessageType:
$ref: '#/components/schemas/SMMessageType'
sMReplyPathRequested:
$ref: '#/components/schemas/ReplyPathRequested'
sMUserDataHeader:
type: string
sMStatus:
type: string
pattern: '^[0-7]?[0-9a-fA-F]$'
sMDischargeTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
numberofMessagesSent:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
sMServiceType:
$ref: '#/components/schemas/SMServiceType'
sMSequenceNumber:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
sMSresult:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
submissionTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
sMPriority:
$ref: '#/components/schemas/SMPriority'
messageReference:
type: string
messageSize:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
messageClass:
$ref: '#/components/schemas/MessageClass'
deliveryReportRequested:
$ref: '#/components/schemas/DeliveryReportRequested'
OriginatorInfo:
type: object
properties:
originatorSUPI:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
originatorGPSI:
3GPP
Release 17 179 3GPP TS 32.291 V17.11.0 (2024-09)
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
originatorOtherAddress:
$ref: '#/components/schemas/SMAddressInfo'
originatorReceivedAddress:
$ref: '#/components/schemas/SMAddressInfo'
originatorSCCPAddress:
type: string
sMOriginatorInterface:
$ref: '#/components/schemas/SMInterface'
sMOriginatorProtocolId:
type: string
RecipientInfo:
type: object
properties:
recipientSUPI:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
recipientGPSI:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
recipientOtherAddress:
$ref: '#/components/schemas/SMAddressInfo'
recipientReceivedAddress:
$ref: '#/components/schemas/SMAddressInfo'
recipientSCCPAddress:
type: string
sMDestinationInterface:
$ref: '#/components/schemas/SMInterface'
sMrecipientProtocolId:
type: string
SMAddressInfo:
type: object
properties:
sMaddressType:
$ref: '#/components/schemas/SMAddressType'
sMaddressData:
type: string
sMaddressDomain:
$ref: '#/components/schemas/SMAddressDomain'
RecipientAddress:
type: object
properties:
recipientAddressInfo:
$ref: '#/components/schemas/SMAddressInfo'
sMaddresseeType:
$ref: '#/components/schemas/SMAddresseeType'
MessageClass:
type: object
properties:
classIdentifier:
$ref: '#/components/schemas/ClassIdentifier'
tokenText:
type: string
SMAddressDomain:
type: object
properties:
domainName:
type: string
3GPPIMSIMCCMNC:
type: string
SMInterface:
type: object
properties:
interfaceId:
type: string
interfaceText:
type: string
interfacePort:
type: string
interfaceType:
$ref: '#/components/schemas/InterfaceType'
RANSecondaryRATUsageReport:
type: object
properties:
rANSecondaryRATType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
qosFlowsUsageReports:
type: array
items:
$ref: '#/components/schemas/QosFlowsUsageReport'
3GPP
Release 17 180 3GPP TS 32.291 V17.11.0 (2024-09)
Diagnostics:
type: integer
IPFilterRule:
type: string
QosFlowsUsageReport:
type: object
properties:
qFI:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi'
startTimestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
endTimestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
uplinkVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
downlinkVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
5GLANTypeService:
type: object
properties:
internalGroupIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId'
NEFChargingInformation:
type: object
properties:
externalIndividualIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
externalIndividualIdList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
minItems: 1
externalGroupIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ExternalGroupId'
groupIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId'
aPIDirection:
$ref: '#/components/schemas/APIDirection'
aPITargetNetworkFunction:
$ref: '#/components/schemas/NFIdentification'
aPIResultCode:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
aPIName:
type: string
aPIReference:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
aPIContent:
type: string
required:
- aPIName
RegistrationChargingInformation:
type: object
properties:
registrationMessagetype:
$ref: '#/components/schemas/RegistrationMessageType'
userInformation:
$ref: '#/components/schemas/UserInformation'
userLocationinfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
pSCellInformation:
$ref: '#/components/schemas/PSCellInformation'
uetimeZone:
$ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
rATType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
5GMMCapability:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes'
mICOModeIndication:
$ref: '#/components/schemas/MICOModeIndication'
smsIndication:
$ref: '#/components/schemas/SmsIndication'
taiList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Tai'
minItems: 0
serviceAreaRestriction:
type: array
3GPP
Release 17 181 3GPP TS 32.291 V17.11.0 (2024-09)
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction'
minItems: 0
requestedNSSAI:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems: 0
allowedNSSAI:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems: 0
rejectedNSSAI:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems: 0
nSSAIMapList:
type: array
items:
$ref: '#/components/schemas/NSSAIMap'
minItems: 0
amfUeNgapId:
type: integer
ranUeNgapId:
type: integer
ranNodeId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId'
required:
- registrationMessagetype
PSCellInformation:
type: object
properties:
nrcgi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi'
ecgi:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi'
NSSAIMap:
type: object
properties:
servingSnssai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
homeSnssai:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
required:
- servingSnssai
- homeSnssai
N2ConnectionChargingInformation:
type: object
properties:
n2ConnectionMessageType:
$ref: '#/components/schemas/N2ConnectionMessageType'
userInformation:
$ref: '#/components/schemas/UserInformation'
userLocationinfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
pSCellInformation:
$ref: '#/components/schemas/PSCellInformation'
uetimeZone:
$ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
rATType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
amfUeNgapId:
type: integer
ranUeNgapId:
type: integer
ranNodeId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/GlobalRanNodeId'
restrictedRatList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
minItems: 0
forbiddenAreaList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Area'
3GPP
Release 17 182 3GPP TS 32.291 V17.11.0 (2024-09)
minItems: 0
serviceAreaRestriction:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceAreaRestriction'
minItems: 0
restrictedCnList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/CoreNetworkType'
minItems: 0
allowedNSSAI:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems: 0
rrcEstCause:
type: string
pattern: '^[0-9a-fA-F]+$'
required:
- n2ConnectionMessageType
LocationReportingChargingInformation:
type: object
properties:
locationReportingMessageType:
$ref: '#/components/schemas/LocationReportingMessageType'
userInformation:
$ref: '#/components/schemas/UserInformation'
userLocationinfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
pSCellInformation:
$ref: '#/components/schemas/PSCellInformation'
uetimeZone:
$ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
rATType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
presenceReportingAreaInformation:
type: object
additionalProperties:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo'
minProperties: 0
required:
- locationReportingMessageType
N2ConnectionMessageType:
type: integer
LocationReportingMessageType:
type: integer
NSMChargingInformation:
type: object
properties:
managementOperation:
$ref: '#/components/schemas/ManagementOperation'
idNetworkSliceInstance:
type: string
listOfserviceProfileChargingInformation:
type: array
items:
$ref: '#/components/schemas/ServiceProfileChargingInformation'
minItems: 0
managementOperationStatus:
$ref: '#/components/schemas/ManagementOperationStatus'
managementOperationalState:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState'
managementAdministrativeState:
$ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState'
required:
- managementOperation
ServiceProfileChargingInformation:
type: object
properties:
serviceProfileIdentifier:
type: string
sNSSAIList:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
minItems: 0
sST:
3GPP
Release 17 183 3GPP TS 32.291 V17.11.0 (2024-09)
$ref: 'TS28541_NrNrm.yaml#/components/schemas/Sst'
latency:
type: integer
availability:
type: number
resourceSharingLevel:
$ref: 'TS28541_SliceNrm.yaml#/components/schemas/SharingLevel'
jitter:
type: integer
reliability:
type: string
maxNumberofUEs:
type: integer
coverageArea:
type: string
# To be introduced once the reference to SliceNrm.yaml is resolved
# uEMobilityLevel:
# $ref: 'TS28541_SliceNrm.yaml#/components/schemas/MobilityLevel'
# delayToleranceIndicator:
# $ref: 'TS28541_SliceNrm.yaml#/components/schemas/Support'
dLThptPerSlice:
$ref: '#/components/schemas/Throughput'
dLThptPerUE:
$ref: '#/components/schemas/Throughput'
uLThptPerSlice:
$ref: '#/components/schemas/Throughput'
uLThptPerUE:
$ref: '#/components/schemas/Throughput'
maxNumberofPDUsessions:
type: integer
kPIMonitoringList:
type: string
supportedAccessTechnology:
type: integer
# To be introduced once the reference to SliceNrm.yaml is resolved
# v2XCommunicationModeIndicator:
# $ref: 'TS28541_SliceNrm.yaml#/components/schemas/Support'
addServiceProfileInfo:
type: string
Throughput:
type: object
properties:
guaranteedThpt:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
maximumThpt:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
MAPDUSessionInformation:
type: object
properties:
mAPDUSessionIndicator:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/MaPduIndication'
aTSSSCapability:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AtsssCapability'
EnhancedDiagnostics5G:
$ref: '#/components/schemas/RanNasCauseList'
RanNasCauseList:
type: array
items:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RanNasRelCause'
QosMonitoringReport:
description: Contains reporting information on QoS monitoring.
type: object
properties:
ulDelays:
type: array
items:
type: integer
minItems: 0
dlDelays:
type: array
items:
type: integer
minItems: 0
rtDelays:
type: array
items:
type: integer
minItems: 0
3GPP
Release 17 184 3GPP TS 32.291 V17.11.0 (2024-09)
AnnouncementInformation:
type: object
properties:
announcementIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
announcementReference:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
variableParts:
type: array
items:
$ref: '#/components/schemas/VariablePart'
minItems: 0
timeToPlay:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
quotaConsumptionIndicator:
$ref: '#/components/schemas/QuotaConsumptionIndicator'
announcementPriority:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
playToParty:
$ref: '#/components/schemas/PlayToParty'
announcementPrivacyIndicator:
$ref: '#/components/schemas/AnnouncementPrivacyIndicator'
Language:
$ref: '#/components/schemas/Language'
VariablePart:
type: object
properties:
variablePartType:
$ref: '#/components/schemas/VariablePartType'
variablePartValue:
type: array
items:
type: string
minItems: 1
variablePartOrder:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
required:
- variablePartType
- variablePartValue
Language:
type: string
MMTelChargingInformation:
type: object
properties:
supplementaryServices:
type: array
items:
$ref: '#/components/schemas/SupplementaryService'
minItems: 1
SupplementaryService:
type: object
properties:
supplementaryServiceType:
$ref: '#/components/schemas/SupplementaryServiceType'
supplementaryServiceMode:
$ref: '#/components/schemas/SupplementaryServiceMode'
numberOfDiversions:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
associatedPartyAddress:
type: string
conferenceId:
type: string
participantActionType:
$ref: '#/components/schemas/ParticipantActionType'
changeTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
numberOfParticipants:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
cUGInformation:
$ref: '#/components/schemas/OctetString'
IMSChargingInformation:
type: object
properties:
eventType:
$ref: '#/components/schemas/SIPEventType'
iMSNodeFunctionality:
$ref: '#/components/schemas/IMSNodeFunctionality'
roleOfNode:
3GPP
Release 17 185 3GPP TS 32.291 V17.11.0 (2024-09)
$ref: '#/components/schemas/RoleOfIMSNode'
userInformation:
$ref: '#/components/schemas/UserInformation'
userLocationInfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
ueTimeZone:
$ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
3gppPSDataOffStatus:
$ref: '#/components/schemas/3GPPPSDataOffStatus'
isupCause:
$ref: '#/components/schemas/ISUPCause'
controlPlaneAddress:
$ref: '#/components/schemas/IMSAddress'
vlrNumber:
$ref: '#/components/schemas/E164'
mscAddress:
$ref: '#/components/schemas/E164'
userSessionID:
type: string
outgoingSessionID:
type: string
sessionPriority:
$ref: '#/components/schemas/IMSSessionPriority'
callingPartyAddresses:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
minItems: 1
calledPartyAddress:
type: string
numberPortabilityRoutinginformation:
type: string
carrierSelectRoutingInformation:
type: string
alternateChargedPartyAddress:
type: string
requestedPartyAddress:
type: array
items:
type: string
minItems: 1
calledAssertedIdentities:
type: array
items:
type: string
minItems: 1
calledIdentityChanges:
type: array
items:
$ref: '#/components/schemas/CalledIdentityChange'
minItems: 1
associatedURI:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
minItems: 1
timeStamps:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
applicationServerInformation:
type: array
items:
type: string
minItems: 1
interOperatorIdentifier:
type: array
items:
$ref: '#/components/schemas/InterOperatorIdentifier'
minItems: 1
imsChargingIdentifier:
type: string
relatedICID:
type: string
relatedICIDGenerationNode:
type: string
transitIOIList:
type: array
items:
type: string
3GPP
Release 17 186 3GPP TS 32.291 V17.11.0 (2024-09)
minItems: 1
earlyMediaDescription:
type: array
items:
$ref: '#/components/schemas/EarlyMediaDescription'
minItems: 1
sdpSessionDescription:
type: array
items:
type: string
minItems: 1
sdpMediaComponent:
type: array
items:
$ref: '#/components/schemas/SDPMediaComponent'
minItems: 1
servedPartyIPAddress:
$ref: '#/components/schemas/IMSAddress'
serverCapabilities:
$ref: '#/components/schemas/ServerCapabilities'
trunkGroupID:
$ref: '#/components/schemas/TrunkGroupID'
bearerService:
type: string
imsServiceId:
type: string
messageBodies:
type: array
items:
$ref: '#/components/schemas/MessageBody'
minItems: 1
accessNetworkInformation:
type: array
items:
type: string
minItems: 1
additionalAccessNetworkInformation:
type: string
cellularNetworkInformation:
type: string
accessTransferInformation:
type: array
items:
$ref: '#/components/schemas/AccessTransferInformation'
minItems: 1
accessNetworkInfoChange:
type: array
items:
$ref: '#/components/schemas/AccessNetworkInfoChange'
minItems: 1
imsCommunicationServiceID:
type: string
imsApplicationReferenceID:
type: string
causeCode:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
reasonHeader:
type: array
items:
type: string
minItems: 1
initialIMSChargingIdentifier:
type: string
nniInformation:
type: array
items:
$ref: '#/components/schemas/NNIInformation'
minItems: 1
fromAddress:
type: string
imsEmergencyIndication:
type: boolean
imsVisitedNetworkIdentifier:
type: string
sipRouteHeaderReceived:
type: string
sipRouteHeaderTransmitted:
type: string
3GPP
Release 17 187 3GPP TS 32.291 V17.11.0 (2024-09)
tadIdentifier:
$ref: '#/components/schemas/TADIdentifier'
feIdentifierList:
type: string
EdgeInfrastructureUsageChargingInformation:
type: object
properties:
meanVirtualCPUUsage:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
meanVirtualMemoryUsage:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
meanVirtualDiskUsage:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Float'
measuredInBytes:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
measuredOutBytes:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
durationStartTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
durationEndTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
EASDeploymentChargingInformation:
type: object
properties:
eEASDeploymentRequirements:
$ref: '#/components/schemas/EASRequirements'
lCMEventType:
$ref: '#/components/schemas/ManagementOperation'
lCMStartTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
lCMEndTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
PC5ContainerInformation:
type: object
properties:
coverageInfoList:
type: array
items:
$ref: '#/components/schemas/CoverageInfo'
radioParameterSetInfoList:
type: array
items:
$ref: '#/components/schemas/RadioParameterSetInfo'
transmitterInfoList:
type: array
items:
$ref: '#/components/schemas/TransmitterInfo'
minItems: 0
timeOfFirstTransmission:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
timeOfFirstReception:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
CoverageInfo:
type: object
properties:
coverageStatus:
type: boolean
changeTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
locationInfo:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
minItems: 0
RadioParameterSetInfo:
type: object
properties:
radioParameterSetValues:
type: array
items:
$ref: '#/components/schemas/OctetString'
minItems: 0
changeTimestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
TransmitterInfo:
type: object
3GPP
Release 17 188 3GPP TS 32.291 V17.11.0 (2024-09)
properties:
proseSourceIPAddress:
$ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'
proseSourceL2Id:
type: string
ProseChargingInformation:
type: object
properties:
announcingPlmnID:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
announcingUeHplmnIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
announcingUeVplmnIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
monitoringUeHplmnIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
monitoringUeVplmnIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
discovererUeHplmnIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
discovererUeVplmnIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
discovereeUeHplmnIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
discovereeUeVplmnIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
monitoredPlmnIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
proseApplicationID:
type: string
ApplicationId:
type: string
applicationSpecificDataList:
type: array
items:
type: string
minItems: 0
proseFunctionality:
$ref: '#/components/schemas/ProseFunctionality'
proseEventType:
$ref: '#/components/schemas/ProseEventType'
directDiscoveryModel:
$ref: '#/components/schemas/DirectDiscoveryModel'
validityPeriod:
type: integer
roleOfUE:
$ref: '#/components/schemas/RoleOfUE'
proseRequestTimestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
pC3ProtocolCause:
type: integer
monitoringUEIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
requestedPLMNIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
timeWindow:
type: integer
rangeClass:
$ref: '#/components/schemas/RangeClass'
proximityAlertIndication:
type: boolean
proximityAlertTimestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
proximityCancellationTimestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
relayIPAddress:
$ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'
proseUEToNetworkRelayUEID :
type: string
proseDestinationLayer2ID:
type: string
pFIContainerInformation:
type: array
items:
$ref: '#/components/schemas/PFIContainerInformation'
minItems: 0
transmissionDataContainer:
type: array
3GPP
Release 17 189 3GPP TS 32.291 V17.11.0 (2024-09)
items:
$ref: '#/components/schemas/PC5DataContainer'
minItems: 0
receptionDataContainer:
type: array
items:
$ref: '#/components/schemas/PC5DataContainer'
minItems: 0
required:
- aPIName
PFIContainerInformation:
type: object
properties:
pFI:
type: string
reportTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
timeofFirstUsage:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
timeofLastUsage:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
qoSInformation:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosData'
qoSCharacteristics:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosCharacteristics'
userLocationInformation:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
uetimeZone:
$ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
presenceReportingAreaInformation:
type: object
additionalProperties:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo'
minProperties: 0
PC5DataContainer:
type: object
properties:
localSequenceNumber:
type: string
changeTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
coverageStatus:
type: boolean
userLocationInformation:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
dataVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
changeCondition:
type: string
radioResourcesId:
$ref: '#/components/schemas/RadioResourcesId'
radioFrequency:
type: string
pC5RadioTechnology:
type: string
OctetString:
type: string
pattern: '^[0-9a-fA-F]+$'
E164:
type: string
pattern: '^[0-9a-fA-F]+$'
IMSAddress:
type: object
properties:
ipv4Addr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
ipv6Addr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
e164:
$ref: '#/components/schemas/E164'
anyOf:
- required: [ ipv4Addr ]
- required: [ ipv6Addr ]
- required: [ e164 ]
ServingNodeAddress:
3GPP
Release 17 190 3GPP TS 32.291 V17.11.0 (2024-09)
type: object
properties:
ipv4Addr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
ipv6Addr:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
anyOf:
- required: [ ipv4Addr ]
- required: [ ipv6Addr ]
SIPEventType:
type: object
properties:
sIPMethod:
type: string
eventHeader:
type: string
expiresHeader:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
ISUPCause:
type: object
properties:
iSUPCauseLocation:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
iSUPCauseValue:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
iSUPCauseDiagnostics:
$ref: '#/components/schemas/OctetString'
CalledIdentityChange:
type: object
properties:
calledIdentity:
type: string
changeTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
InterOperatorIdentifier:
type: object
properties:
originatingIOI:
type: string
terminatingIOI:
type: string
EarlyMediaDescription:
type: object
properties:
sDPTimeStamps:
$ref: '#/components/schemas/SDPTimeStamps'
sDPMediaComponent:
type: array
items:
$ref: '#/components/schemas/SDPMediaComponent'
minItems: 0
sDPSessionDescription:
type: array
items:
type: string
minItems: 0
SDPTimeStamps:
type: object
properties:
sDPOfferTimestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
sDPAnswerTimestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
SDPMediaComponent:
type: object
properties:
sDPMediaName:
type: string
SDPMediaDescription:
type: array
items:
type: string
minItems: 0
localGWInsertedIndication:
type: boolean
ipRealmDefaultIndication:
type: boolean
transcoderInsertedIndication:
3GPP
Release 17 191 3GPP TS 32.291 V17.11.0 (2024-09)
type: boolean
mediaInitiatorFlag:
$ref: '#/components/schemas/MediaInitiatorFlag'
mediaInitiatorParty:
type: string
threeGPPChargingId:
$ref: '#/components/schemas/OctetString'
accessNetworkChargingIdentifierValue:
$ref: '#/components/schemas/OctetString'
sDPType:
$ref: '#/components/schemas/SDPType'
ServerCapabilities:
type: object
properties:
mandatoryCapability:
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
minItems: 0
optionalCapability :
type: array
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
minItems: 0
serverName:
type: array
items:
type: string
minItems: 0
TrunkGroupID:
type: object
properties:
incomingTrunkGroupID:
type: string
outgoingTrunkGroupID:
type: string
MessageBody:
type: object
properties:
contentType:
type: string
contentLength:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
contentDisposition:
type: string
originator:
$ref: '#/components/schemas/OriginatorPartyType'
required:
- contentType
- contentLength
AccessTransferInformation:
type: object
properties:
accessTransferType:
$ref: '#/components/schemas/AccessTransferType'
accessNetworkInformation:
type: array
items:
$ref: '#/components/schemas/OctetString'
minItems: 0
cellularNetworkInformation:
$ref: '#/components/schemas/OctetString'
interUETransfer:
$ref: '#/components/schemas/UETransferType'
userEquipmentInfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Pei'
instanceId:
type: string
relatedIMSChargingIdentifier:
type: string
relatedIMSChargingIdentifierNode:
$ref: '#/components/schemas/IMSAddress'
changeTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
AccessNetworkInfoChange:
type: object
properties:
accessNetworkInformation:
3GPP
Release 17 192 3GPP TS 32.291 V17.11.0 (2024-09)
type: array
items:
$ref: '#/components/schemas/OctetString'
minItems: 0
cellularNetworkInformation:
$ref: '#/components/schemas/OctetString'
changeTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
NNIInformation:
type: object
properties:
sessionDirection:
$ref: '#/components/schemas/NNISessionDirection'
nNIType:
$ref: '#/components/schemas/NNIType'
relationshipMode:
$ref: '#/components/schemas/NNIRelationshipMode'
neighbourNodeAddress:
$ref: '#/components/schemas/IMSAddress'
EASRequirements:
type: object
properties:
requiredEASservingLocation:
$ref: 'TS28538_EdgeNrm.yaml#/components/schemas/ServingLocation'
softwareImageInfo:
$ref: 'TS28538_EdgeNrm.yaml#/components/schemas/SoftwareImageInfo'
affinityAntiAffinity:
$ref: 'TS28538_EdgeNrm.yaml#/components/schemas/AffinityAntiAffinity'
serviceContinuity:
type: boolean
virtualResource:
$ref: 'TS28538_EdgeNrm.yaml#/components/schemas/VirtualResource'
NotificationType:
anyOf:
- type: string
enum:
- REAUTHORIZATION
- ABORT_CHARGING
- type: string
NodeFunctionality:
anyOf:
- type: string
enum:
- AMF
- SMF
- SMS # Included for backwards compatibility, shall not be used
- SMSF
- PGW_C_SMF
- NEFF # Included for backwards compatibility, shall not be used
- SGW
- I_SMF
- ePDG
- CEF
- NEF
- MnS_Producer
- SGSN
- V_SMF
- 5G_DDNMF
- IMS_Node
- EES
- PCF
- UDM
- UPF
- type: string
ChargingCharacteristicsSelectionMode:
anyOf:
- type: string
enum:
- HOME_DEFAULT
- ROAMING_DEFAULT
- VISITING_DEFAULT
- type: string
TriggerType:
anyOf:
- type: string
enum:
- QUOTA_THRESHOLD
- QHT
3GPP
Release 17 193 3GPP TS 32.291 V17.11.0 (2024-09)
- FINAL
- QUOTA_EXHAUSTED
- VALIDITY_TIME
- OTHER_QUOTA_TYPE
- FORCED_REAUTHORISATION
- UNUSED_QUOTA_TIMER # Included for backwards compatibility, shall not be used
- UNIT_COUNT_INACTIVITY_TIMER
- ABNORMAL_RELEASE
- QOS_CHANGE
- VOLUME_LIMIT
- TIME_LIMIT
- EVENT_LIMIT
- PLMN_CHANGE
- USER_LOCATION_CHANGE
- RAT_CHANGE
- SESSION_AMBR_CHANGE
- UE_TIMEZONE_CHANGE
- TARIFF_TIME_CHANGE
- MAX_NUMBER_OF_CHANGES_IN_CHARGING_CONDITIONS
- MANAGEMENT_INTERVENTION
- CHANGE_OF_UE_PRESENCE_IN_PRESENCE_REPORTING_AREA
- CHANGE_OF_3GPP_PS_DATA_OFF_STATUS
- SERVING_NODE_CHANGE
- REMOVAL_OF_UPF
- ADDITION_OF_UPF
- INSERTION_OF_ISMF
- REMOVAL_OF_ISMF
- CHANGE_OF_ISMF
- START_OF_SERVICE_DATA_FLOW
- ECGI_CHANGE
- TAI_CHANGE
- HANDOVER_CANCEL
- HANDOVER_START
- HANDOVER_COMPLETE
- GFBR_GUARANTEED_STATUS_CHANGE
- ADDITION_OF_ACCESS
- REMOVAL_OF_ACCESS
- START_OF_SDF_ADDITIONAL_ACCESS
- REDUNDANT_TRANSMISSION_CHANGE
- CGI_SAI_CHANGE
- RAI_CHANGE
- VSMF_CHANGE
- type: string
FinalUnitAction:
anyOf:
- type: string
enum:
- TERMINATE
- REDIRECT
- RESTRICT_ACCESS
- type: string
RedirectAddressType:
anyOf:
- type: string
enum:
- IPV4
- IPV6
- URL
- URI
- type: string
TriggerCategory:
anyOf:
- type: string
enum:
- IMMEDIATE_REPORT
- DEFERRED_REPORT
- type: string
QuotaManagementIndicator:
anyOf:
- type: string
enum:
- ONLINE_CHARGING
- OFFLINE_CHARGING
- QUOTA_MANAGEMENT_SUSPENDED
- type: string
FailureHandling:
anyOf:
- type: string
3GPP
Release 17 194 3GPP TS 32.291 V17.11.0 (2024-09)
enum:
- TERMINATE
- CONTINUE
- RETRY_AND_TERMINATE
- type: string
SessionFailover:
anyOf:
- type: string
enum:
- FAILOVER_NOT_SUPPORTED
- FAILOVER_SUPPORTED
- type: string
3GPPPSDataOffStatus:
anyOf:
- type: string
enum:
- ACTIVE
- INACTIVE
- type: string
ResultCode:
anyOf:
- type: string
enum:
- SUCCESS
- END_USER_SERVICE_DENIED
- QUOTA_MANAGEMENT_NOT_APPLICABLE
- QUOTA_LIMIT_REACHED
- END_USER_SERVICE_REJECTED
- USER_UNKNOWN #Included for backwards compatibility, shall not be used
- RATING_FAILED
- QUOTA_MANAGEMENT
- type: string
PartialRecordMethod:
anyOf:
- type: string
enum:
- DEFAULT
- INDIVIDUAL
- type: string
RoamerInOut:
anyOf:
- type: string
enum:
- IN_BOUND
- OUT_BOUND
- type: string
SMMessageType:
anyOf:
- type: string
enum:
- SUBMISSION
- DELIVERY_REPORT
- SM_SERVICE_REQUEST
- DELIVERY
- type: string
SMPriority:
anyOf:
- type: string
enum:
- LOW
- NORMAL
- HIGH
- type: string
DeliveryReportRequested:
anyOf:
- type: string
enum:
- YES
- NO
- type: string
InterfaceType:
anyOf:
- type: string
enum:
- UNKNOWN
- MOBILE_ORIGINATING
- MOBILE_TERMINATING
- APPLICATION_ORIGINATING
3GPP
Release 17 195 3GPP TS 32.291 V17.11.0 (2024-09)
- APPLICATION_TERMINATING
- type: string
ClassIdentifier:
anyOf:
- type: string
enum:
- PERSONAL
- ADVERTISEMENT
- INFORMATIONAL
- AUTO
- type: string
SMAddressType:
anyOf:
- type: string
enum:
- EMAIL_ADDRESS
- MSISDN
- IPV4_ADDRESS
- IPV6_ADDRESS
- NUMERIC_SHORTCODE
- ALPHANUMERIC_SHORTCODE
- OTHER
- IMSI
- type: string
SMAddresseeType:
anyOf:
- type: string
enum:
- TO
- CC
- BCC
- type: string
SMServiceType:
anyOf:
- type: string
enum:
- VAS4SMS_SHORT_MESSAGE_CONTENT_PROCESSING
- VAS4SMS_SHORT_MESSAGE_FORWARDING
- VAS4SMS_SHORT_MESSAGE_FORWARDING_MULTIPLE_SUBSCRIPTIONS
- VAS4SMS_SHORT_MESSAGE_FILTERING
- VAS4SMS_SHORT_MESSAGE_RECEIPT
- VAS4SMS_SHORT_MESSAGE_NETWORK_STORAGE
- VAS4SMS_SHORT_MESSAGE_TO_MULTIPLE_DESTINATIONS
- VAS4SMS_SHORT_MESSAGE_VIRTUAL_PRIVATE_NETWORK(VPN)
- VAS4SMS_SHORT_MESSAGE_AUTO_REPLY
- VAS4SMS_SHORT_MESSAGE_PERSONAL_SIGNATURE
- VAS4SMS_SHORT_MESSAGE_DEFERRED_DELIVERY
- type: string
ReplyPathRequested:
anyOf:
- type: string
enum:
- NO_REPLY_PATH_SET
- REPLY_PATH_SET
- type: string
oneTimeEventType:
anyOf:
- type: string
enum:
- IEC
- PEC
- type: string
dnnSelectionMode:
anyOf:
- type: string
enum:
- VERIFIED
- UE_DNN_NOT_VERIFIED
- NW_DNN_NOT_VERIFIED
- type: string
APIDirection:
anyOf:
- type: string
enum:
- INVOCATION
- NOTIFICATION
- type: string
RegistrationMessageType:
3GPP
Release 17 196 3GPP TS 32.291 V17.11.0 (2024-09)
anyOf:
- type: string
enum:
- INITIAL
- MOBILITY
- PERIODIC
- EMERGENCY
- DEREGISTRATION
- type: string
MICOModeIndication:
anyOf:
- type: string
enum:
- MICO_MODE
- NO_MICO_MODE
- type: string
SmsIndication:
anyOf:
- type: string
enum:
- SMS_SUPPORTED
- SMS_NOT_SUPPORTED
- type: string
ManagementOperation:
anyOf:
- type: string
enum:
- CreateMOI #Included for backwards compatibility, shall not be used
- ModifyMOIAttributes #Included for backwards compatibility, shall not be used
- DeleteMOI #Included for backwards compatibility, shall not be used
- CREATE_MOI
- MODIFY_MOI_ATTR
- DELETE_MOI
- NOTIFY_MOI_CREATION
- NOTIFY_MOI_ATTR_CHANGE
- NOTIFY_MOI_DELETION
- type: string
ManagementOperationStatus:
anyOf:
- type: string
enum:
- OPERATION_SUCCEEDED
- OPERATION_FAILED
- type: string
RedundantTransmissionType:
anyOf:
- type: string
enum:
- NON_TRANSMISSION
- END_TO_END_USER_PLANE_PATHS
- N3_N9
- TRANSPORT_LAYER
- type: string
VariablePartType:
anyOf:
- type: string
enum:
- INTEGER
- NUMBER
- TIME
- DATE
- CURRENCY
- type: string
QuotaConsumptionIndicator:
anyOf:
- type: string
enum:
- QUOTA_NOT_USED
- QUOTA_IS_USED
- type: string
PlayToParty:
anyOf:
- type: string
enum:
- SERVED
- REMOTE
- type: string
AnnouncementPrivacyIndicator:
3GPP
Release 17 197 3GPP TS 32.291 V17.11.0 (2024-09)
anyOf:
- type: string
enum:
- NOT_PRIVATE
- PRIVATE
- type: string
SupplementaryServiceType:
anyOf:
- type: string
enum:
- OIP
- OIR
- TIP
- TIR
- HOLD
- CB
- CDIV
- CW
- MWI
- CONF
- FA
- CCBS
- CCNR
- MCID
- CAT
- CUG
- PNM
- CRS
- ECT
- type: string
SupplementaryServiceMode:
anyOf:
- type: string
enum:
- CFU
- CFB
- CFNR
- CFNL
- CD
- CFNRC
- ICB
- OCB
- ACR
- BLIND_TRANFER
- CONSULTATIVE_TRANFER
- type: string
ParticipantActionType:
anyOf:
- type: string
enum:
- CREATE
- JOIN
- INVITE_INTO
- QUIT
- type: string
TrafficForwardingWay:
anyOf:
- type: string
enum:
- N6
- N19
- LOCAL_SWITCH
- type: string
IMSNodeFunctionality:
anyOf:
- type: string
enum:
# The applicable IMS Nodes are MRFC, IMS-GWF (connected to S-CSCF using ISC) and SIP AS.
- S_CSCF
- P_CSCF
- I_CSCF
- MRFC
- MGCF
- BGCF
- AS
- IBCF
- S-GW
- P-GW
3GPP
Release 17 198 3GPP TS 32.291 V17.11.0 (2024-09)
- HSGW
- E-CSCF
- MME
- TRF
- TF
- ATCF
- PROXY
- EPDG
- TDF
- TWAG
- SCEF
- IWK_SCEF
- IMS_GWF
- type: string
RoleOfIMSNode:
anyOf:
- type: string
enum:
- ORIGINATING
- TERMINATING
- FORWARDING
- type: string
IMSSessionPriority:
anyOf:
- type: string
enum:
- PRIORITY_0
- PRIORITY_1
- PRIORITY_2
- PRIORITY_3
- PRIORITY_4
- type: string
MediaInitiatorFlag:
anyOf:
- type: string
enum:
- CALLED_PARTY
- CALLING_PARTY
- UNKNOWN
- type: string
SDPType:
anyOf:
- type: string
enum:
- OFFER
- ANSWER
- type: string
OriginatorPartyType:
anyOf:
- type: string
enum:
- CALLING
- CALLED
- type: string
AccessTransferType:
anyOf:
- type: string
enum:
- PS_TO_CS
- CS_TO_PS
- PS_TO_PS
- CS_TO_CS
- type: string
UETransferType:
anyOf:
- type: string
enum:
- INTRA_UE
- INTER_UE
- type: string
NNISessionDirection:
anyOf:
- type: string
enum:
- INBOUND
- OUTBOUND
- type: string
NNIType:
3GPP
Release 17 199 3GPP TS 32.291 V17.11.0 (2024-09)
anyOf:
- type: string
enum:
- NON_ROAMING
- ROAMING_NO_LOOPBACK
- ROAMING_LOOPBACK
- type: string
NNIRelationshipMode:
anyOf:
- type: string
enum:
- TRUSTED
- NON_TRUSTED
- type: string
TADIdentifier:
anyOf:
- type: string
enum:
- CS
- PS
- type: string
ProseFunctionality:
anyOf:
- type: string
enum:
- DIRECT_DISCOVERY
- DIRECT_COMMUNICATION
- type: string
ProseEventType:
anyOf:
- type: string
enum:
- ANNOUNCING
- MONITORING
- MATCH_REPORT
- type: string
DirectDiscoveryModel:
anyOf:
- type: string
enum:
- MODEL_A
- MODEL_B
- type: string
RoleOfUE:
anyOf:
- type: string
enum:
- ANNOUNCING_UE
- MONITORING_UE
- REQUESTOR_UE
- REQUESTED_UE
- type: string
RangeClass:
anyOf:
- type: string
enum:
- RESERVED
- 50_METER
- 100_METER
- 200_METER
- 500_METER
- 1000_METER
- UNUSED
- type: string
RadioResourcesId:
anyOf:
- type: string
enum:
- OPERATOR_PROVIDED
- CONFIGURED
- type: string
3GPP
Release 17 200 3GPP TS 32.291 V17.11.0 (2024-09)
title: Nchf_OfflineOnlyCharging
version: 1.0.2
description: |
OfflineOnlyCharging Service
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 32.291 V17.0.0: Telecommunication management; Charging management;
5G system, charging service; Stage 3.
url: 'http://www.3gpp.org/ftp/Specs/archive/32_series/32.291/'
servers:
- url: '{apiRoot}/nchf-offlineonlycharging/v1'
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in subclause 4.4 of 3GPP TS 29.501.
security:
- {}
- oAuth2ClientCredentials:
- nchf-offlineonlycharging
paths:
/offlinechargingdata:
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChargingDataRequest'
responses:
'201':
description: Created
content:
application/json:
schema:
$ref: '#/components/schemas/ChargingDataResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'410':
$ref: 'TS29571_CommonData.yaml#/components/responses/410'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
'/offlinechargingdata/{OfflineChargingDataRef}/update':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChargingDataRequest'
parameters:
3GPP
Release 17 201 3GPP TS 32.291 V17.11.0 (2024-09)
- name: OfflineChargingDataRef
in: path
description: a unique identifier for a charging data resource in a PLMN
required: true
schema:
type: string
responses:
'200':
description: OK. Updated Charging Data resource is returned
content:
application/json:
schema:
$ref: '#/components/schemas/ChargingDataResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
'404':
description: Not Found
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'410':
$ref: 'TS29571_CommonData.yaml#/components/responses/410'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'500':
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
'/offlinechargingdata/{OfflineChargingDataRef}/release':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChargingDataRequest'
parameters:
- name: OfflineChargingDataRef
in: path
description: a unique identifier for a charging data resource in a PLMN
required: true
schema:
type: string
responses:
'204':
description: No Content.
'404':
description: Not Found
content:
application/json:
schema:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
'401':
$ref: 'TS29571_CommonData.yaml#/components/responses/401'
'410':
$ref: 'TS29571_CommonData.yaml#/components/responses/410'
'411':
$ref: 'TS29571_CommonData.yaml#/components/responses/411'
'413':
$ref: 'TS29571_CommonData.yaml#/components/responses/413'
'500':
3GPP
Release 17 202 3GPP TS 32.291 V17.11.0 (2024-09)
$ref: 'TS29571_CommonData.yaml#/components/responses/500'
'503':
$ref: 'TS29571_CommonData.yaml#/components/responses/503'
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
nchf-offlineonlycharging: Access to the Nchf_OfflineOnlyCharging API
schemas:
ChargingDataRequest:
type: object
properties:
subscriberIdentifier:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
nfConsumerIdentification:
$ref: '#/components/schemas/NFIdentification'
invocationTimeStamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
invocationSequenceNumber:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
retransmissionIndicator:
type: boolean
serviceSpecificationInfo:
type: string
multipleUnitUsage:
type: array
items:
$ref: '#/components/schemas/MultipleUnitUsage'
minItems: 0
triggers:
type: array
items:
$ref: '#/components/schemas/Trigger'
minItems: 0
pDUSessionChargingInformation:
$ref: '#/components/schemas/PDUSessionChargingInformation'
roamingQBCInformation:
$ref: '#/components/schemas/RoamingQBCInformation'
required:
- nfConsumerIdentification
- invocationTimeStamp
- invocationSequenceNumber
ChargingDataResponse:
type: object
properties:
invocationTimeStamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
invocationSequenceNumber:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
invocationResult:
$ref: '#/components/schemas/InvocationResult'
sessionFailover:
$ref: '#/components/schemas/SessionFailover'
triggers:
type: array
items:
$ref: '#/components/schemas/Trigger'
minItems: 0
pDUSessionChargingInformation:
$ref: '#/components/schemas/PDUSessionChargingInformation'
roamingQBCInformation:
$ref: '#/components/schemas/RoamingQBCInformation'
required:
- invocationTimeStamp
- invocationSequenceNumber
NFIdentification:
type: object
properties:
nFName:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
nFIPv4Address:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
3GPP
Release 17 203 3GPP TS 32.291 V17.11.0 (2024-09)
nFIPv6Address:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
nFPLMNID:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
nodeFunctionality:
$ref: '#/components/schemas/NodeFunctionality'
nFFqdn:
type: string
required:
- nodeFunctionality
MultipleUnitUsage:
type: object
properties:
ratingGroup:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatingGroup'
usedUnitContainer:
type: array
items:
$ref: '#/components/schemas/UsedUnitContainer'
minItems: 0
uPFID:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
multihomedPDUAddress:
$ref: '#/components/schemas/PDUAddress'
required:
- ratingGroup
InvocationResult:
type: object
properties:
error:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails'
failureHandling:
$ref: '#/components/schemas/FailureHandling'
Trigger:
type: object
properties:
triggerType:
$ref: '#/components/schemas/TriggerType'
triggerCategory:
$ref: '#/components/schemas/TriggerCategory'
timeLimit:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
volumeLimit:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
volumeLimit64:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
eventLimit:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
maxNumberOfccc:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
required:
- triggerType
- triggerCategory
UsedUnitContainer:
type: object
properties:
serviceId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceId'
triggers:
type: array
items:
$ref: '#/components/schemas/Trigger'
minItems: 0
triggerTimestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
time:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
totalVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
uplinkVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
downlinkVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
serviceSpecificUnits:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
eventTimeStamps:
type: array
3GPP
Release 17 204 3GPP TS 32.291 V17.11.0 (2024-09)
items:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
minItems: 0
localSequenceNumber:
type: integer
pDUContainerInformation:
$ref: '#/components/schemas/PDUContainerInformation'
required:
- localSequenceNumber
PDUSessionChargingInformation:
type: object
properties:
chargingId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId'
sMFChargingId:
type: string
userInformation:
$ref: '#/components/schemas/UserInformation'
userLocationinfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
mAPDUNon3GPPUserLocationInfo:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
userLocationTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
presenceReportingAreaInformation:
type: object
additionalProperties:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo'
minProperties: 0
uetimeZone:
$ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
pduSessionInformation:
$ref: '#/components/schemas/PDUSessionInformation'
unitCountInactivityTimer:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec'
rANSecondaryRATUsageReport:
$ref: '#/components/schemas/RANSecondaryRATUsageReport'
required:
- pduSessionInformation
UserInformation:
type: object
properties:
servedGPSI:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
servedPEI:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Pei'
unauthenticatedFlag:
type: boolean
roamerInOut:
$ref: '#/components/schemas/RoamerInOut'
PDUSessionInformation:
type: object
properties:
networkSlicingInfo:
$ref: '#/components/schemas/NetworkSlicingInfo'
pduSessionID:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId'
pduType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType'
sscMode:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SscMode'
hPlmnId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
servingNetworkFunctionID:
$ref: '#/components/schemas/ServingNetworkFunctionID'
ratType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
mAPDUNon3GPPRATType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
dnnId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
chargingCharacteristics:
type: string
chargingCharacteristicsSelectionMode:
$ref: '#/components/schemas/ChargingCharacteristicsSelectionMode'
startTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
stopTime:
3GPP
Release 17 205 3GPP TS 32.291 V17.11.0 (2024-09)
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
3gppPSDataOffStatus:
$ref: '#/components/schemas/3GPPPSDataOffStatus'
sessionStopIndicator:
type: boolean
pduAddress:
$ref: '#/components/schemas/PDUAddress'
diagnostics:
$ref: '#/components/schemas/Diagnostics'
authorizedQoSInformation:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AuthorizedDefaultQos'
subscribedQoSInformation:
$ref: 'TS29571_CommonData.yaml#/components/schemas/SubscribedDefaultQos'
authorizedSessionAMBR:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr'
subscribedSessionAMBR:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr'
servingCNPlmnId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId'
mAPDUSessionInformation:
$ref: '#/components/schemas/MAPDUSessionInformation'
enhancedDiagnostics:
$ref: '#/components/schemas/EnhancedDiagnostics5G'
required:
- pduSessionID
- dnnId
PDUContainerInformation:
type: object
properties:
timeofFirstUsage:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
timeofLastUsage:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
qoSInformation:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosData'
qoSCharacteristics:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosCharacteristics'
aFCorrelationInformation:
type: string
userLocationInformation:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
uetimeZone:
$ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
rATType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
servingNodeID:
type: array
items:
$ref: '#/components/schemas/ServingNetworkFunctionID'
minItems: 0
presenceReportingAreaInformation:
type: object
additionalProperties:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo'
minProperties: 0
3gppPSDataOffStatus:
$ref: '#/components/schemas/3GPPPSDataOffStatus'
sponsorIdentity:
type: string
applicationserviceProviderIdentity:
type: string
chargingRuleBaseName:
type: string
mAPDUSteeringFunctionality:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteeringFunctionality'
mAPDUSteeringMode:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteeringMode'
NetworkSlicingInfo:
type: object
properties:
sNSSAI:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
required:
- sNSSAI
PDUAddress:
type: object
properties:
pduIPv4Address:
3GPP
Release 17 206 3GPP TS 32.291 V17.11.0 (2024-09)
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr'
pduIPv6AddresswithPrefix:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr'
pduAddressprefixlength:
type: integer
iPv4dynamicAddressFlag:
type: boolean
iPv6dynamicPrefixFlag:
type: boolean
ServingNetworkFunctionID:
type: object
properties:
servingNetworkFunctionInformation:
$ref: '#/components/schemas/NFIdentification'
aMFId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AmfId'
required:
- servingNetworkFunctionInformation
RoamingQBCInformation:
type: object
properties:
multipleQFIcontainer:
type: array
items:
$ref: '#/components/schemas/MultipleQFIcontainer'
minItems: 0
uPFID:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
roamingChargingProfile:
$ref: '#/components/schemas/RoamingChargingProfile'
MultipleQFIcontainer:
type: object
properties:
triggers:
type: array
items:
$ref: '#/components/schemas/Trigger'
minItems: 0
triggerTimestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
time:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
totalVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
uplinkVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
localSequenceNumber:
type: integer
qFIContainerInformation:
$ref: '#/components/schemas/QFIContainerInformation'
required:
- localSequenceNumber
QFIContainerInformation:
type: object
properties:
qFI:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi'
timeofFirstUsage:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
timeofLastUsage:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
qoSInformation:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosData'
qoSCharacteristics:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/QosCharacteristics'
userLocationInformation:
$ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation'
uetimeZone:
$ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone'
presenceReportingAreaInformation:
type: object
additionalProperties:
$ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo'
minProperties: 0
rATType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
servingNetworkFunctionID:
type: array
3GPP
Release 17 207 3GPP TS 32.291 V17.11.0 (2024-09)
items:
$ref: '#/components/schemas/ServingNetworkFunctionID'
minItems: 0
3gppPSDataOffStatus:
$ref: '#/components/schemas/3GPPPSDataOffStatus'
RoamingChargingProfile:
type: object
properties:
triggers:
type: array
items:
$ref: '#/components/schemas/Trigger'
minItems: 0
partialRecordMethod:
$ref: '#/components/schemas/PartialRecordMethod'
RANSecondaryRATUsageReport:
type: object
properties:
rANSecondaryRATType:
$ref: 'TS29571_CommonData.yaml#/components/schemas/RatType'
qosFlowsUsageReports:
type: array
items:
$ref: '#/components/schemas/QosFlowsUsageReport'
Diagnostics:
type: integer
IPFilterRule:
type: string
QosFlowsUsageReport:
type: object
properties:
qFI:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Qfi'
startTimestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
endTimestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
uplinkVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
downlinkVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
MAPDUSessionInformation:
type: object
properties:
mAPDUSessionIndicator:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/MaPduIndication'
aTSSSCapability:
$ref: 'TS29571_CommonData.yaml#/components/schemas/AtsssCapability'
EnhancedDiagnostics5G:
$ref: '#/components/schemas/RanNasCauseList'
RanNasCauseList:
type: array
items:
$ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RanNasRelCause'
NodeFunctionality:
anyOf:
- type: string
enum:
- SMF
- SMSF # Included for backwards compatibility, shall not be used
- I-SMF
- type: string
ChargingCharacteristicsSelectionMode:
anyOf:
- type: string
enum:
- HOME_DEFAULT
- ROAMING_DEFAULT
- VISITING_DEFAULT
- type: string
TriggerType:
anyOf:
- type: string
enum:
- FINAL
- ABNORMAL_RELEASE
- QOS_CHANGE
- VOLUME_LIMIT
3GPP
Release 17 208 3GPP TS 32.291 V17.11.0 (2024-09)
- TIME_LIMIT
- EVENT_LIMIT
- PLMN_CHANGE
- USER_LOCATION_CHANGE
- RAT_CHANGE
- SESSION_AMBR_CHANGE
- UE_TIMEZONE_CHANGE
- TARIFF_TIME_CHANGE
- MAX_NUMBER_OF_CHANGES_IN_CHARGING_CONDITIONS
- MANAGEMENT_INTERVENTION
- CHANGE_OF_UE_PRESENCE_IN_PRESENCE_REPORTING_AREA
- CHANGE_OF_3GPP_PS_DATA_OFF_STATUS
- SERVING_NODE_CHANGE
- REMOVAL_OF_UPF
- ADDITION_OF_UPF
- INSERTION_OF_ISMF
- REMOVAL_OF_ISMF
- CHANGE_OF_ISMF
- START_OF_SERVICE_DATA_FLOW
- GFBR_GUARANTEED_STATUS_CHANGE
- HANDOVER_CANCEL
- HANDOVER_START
- HANDOVER_COMPLETE
- ADDITION_OF_ACCESS
- REMOVAL_OF_ACCESS
- START_OF_SDF_ADDITIONAL_ACCESS
- type: string
TriggerCategory:
anyOf:
- type: string
enum:
- IMMEDIATE_REPORT
- DEFERRED_REPORT
- type: string
FailureHandling:
anyOf:
- type: string
enum:
- TERMINATE
- CONTINUE
- RETRY_AND_TERMINATE
- type: string
SessionFailover:
anyOf:
- type: string
enum:
- FAILOVER_NOT_SUPPORTED
- FAILOVER_SUPPORTED
- type: string
3GPPPSDataOffStatus:
anyOf:
- type: string
enum:
- ACTIVE
- INACTIVE
- type: string
ResultCode:
anyOf:
- type: string
enum:
- SUCCESS
- END_USER_SERVICE_DENIED
- type: string
PartialRecordMethod:
anyOf:
- type: string
enum:
- DEFAULT
- INDIVIDUAL
- type: string
RoamerInOut:
anyOf:
- type: string
enum:
- IN_BOUND
- OUT_BOUND
- type: string
3GPP
Release 17 209 3GPP TS 32.291 V17.11.0 (2024-09)
3GPP
Release 17 210 3GPP TS 32.291 V17.11.0 (2024-09)
Change history
Date Meeting TDoc CR Rev Cat Subject/Comment New
version
2018-09 SA#81 Upgrade to change control version 15.0.0
2018-12 SA#82 SP-181157 0001 1 F Correction on the Reference and Resource name 15.1.0
2018-12 SA#82 SP-181059 0009 1 F Remove of underscore in the API name 15.1.0
2018-12 SA#82 SP-181059 0010 1 F Correction of data type for subscriber identifier 15.1.0
2018-12 SA#82 SP-181059 0011 - F Correction of response code in flow for Notify 15.1.0
2018-12 SA#82 SP-181059 0013 1 F Correction of overlapping results between Invocation result and 15.1.0
Result code
2018-12 SA#82 SP-181059 0014 1 F Correction of Invocation result at http ok 15.1.0
2018-12 SA#82 SP-181059 0015 1 F Correction of Rating Group Id and Service Id to Uint32 15.1.0
2018-12 SA#82 SP-181059 0016 1 F Correction of name for Multiple Unit Information 15.1.0
2018-12 SA#82 SP-181059 0018 1 F Correction of name for Multiple Unit Information 15.1.0
2018-12 SA#82 SP-181059 0019 1 F Correction of missing http status code 15.1.0
2018-12 SA#82 SP-181057 0021 1 B Introduction Data Volume Reporting for Option 4&7 15.1.0
2018-12 SA#82 SP-181052 0027 1 B Introduce Binding for SMS charging 15.1.0
2018-12 SA#82 SP-181052 0028 1 B Introduce OpenAPI extension for SMS charging 15.1.0
2018-12 SA#82 SP-181059 0030 - F Correction of Serving Network Function ID definition 15.1.0
2019-03 SA#83 SP-190116 0031 1 F Correction of create operation description for event 15.2.0
2019-03 SA#83 SP-190115 0032 1 F Correction of data type associated to volume 15.2.0
2019-03 SA#83 SP-190214 0033 3 F Correction on reference for common data types 15.2.0
3GPP
Release 17 211 3GPP TS 32.291 V17.11.0 (2024-09)
2019-03 SA#83 SP-190116 0038 1 F Correction of API versioning and externalDocs field 15.2.0
2019-03 SA#83 SP-190116 0045 1 F Correction of Multiple Unit Information in ChargingDataResponse 15.2.0
2019-06 SA#84 SP-190384 0057 - F Add the reference for SMS charging 15.3.0
2019-06 SA#84 SP-190384 0065 - F Correction of used unit container attributes 15.3.0
2019-06 SA#84 SP-190383 0067 - F Correction of trigger type for start of service data flow 15.3.0
2019-06 SA#84 SP-190383 0068 1 F Correction of trigger type unit count inactivity timer 15.3.0
2019-06 SA#84 SP-190383 0070 1 F Correction of missing http status codes 15.3.0
2019-06 SA#84 SP-190381 0056 1 B Definition of data model for interworking with EPC 16.0.0
2019-06 SA#84 SP-190382 0059 1 B Add Offline only charging service API name 16.0.0
2019-06 SA#84 SP-190382 0060 1 B Add Offline only charging service API resource definition 16.0.0
2019-06 SA#84 SP-190382 0061 1 B Add Offline only charging service API data model 16.0.0
2019-06 SA#84 SP-190382 0062 1 B Add Offline only charging service API error handling 16.0.0
2019-06 SA#84 SP-190382 0071 - B Add Offline only charging service operations 16.0.0
2019-09 SA#85 SP-190757 0074 1 B Definition of data model for interworking with EPC 16.1.0
2019-09 SA#85 SP-190758 0075 1 B Correct Offline only charging service API resource definition 16.1.0
2019-09 SA#85 SP-190758 0076 1 B Add Offline only charging service API data model 16.1.0
2019-09 SA#85 SP-190758 0077 1 B Add Simple data types and enumerations for offline only charging 16.1.0
service API data model
3GPP
Release 17 212 3GPP TS 32.291 V17.11.0 (2024-09)
2019-09 SA#85 SP-190758 0078 1 B Add Bindings of common CDR field for Offline only charging 16.1.0
service API
2019-09 SA#85 SP-190758 0079 1 B Add Offline only charging open API schema 16.1.0
2019-09 SA#85 SP-190854 0080 2 B Update Open API for interworking 16.1.0
2019-09 SA#85 SP-190762 0086 1 A Correction of Report Time in QFI Container Information 16.1.0
2019-09 SA#85 SP-190762 0110 - A Correct the QoS change trigger 16.1.0
2019-09 SA#85 SP-190762 0111 1 A Add the selection mode in PDU session information 16.1.0
2019-09 SA#85 SP-190840 0117 1 A Bindings for 5G data connectivity correction 16.1.0
2019-09 SA#85 SP-190840 0118 1 A Correction of data structure of response body 16.1.0
2019-09 SA#85 SP-190840 0119 - A Correction of serving Network Function identifier 16.1.0
2019-09 SA#85 Correction of history table and adding correct version of CR 0080 16.1.1
(MCC)
2019-12 SA#86 SP-191162 0144 1 A Add the Service Specification Information 16.2.0
2019-12 SA#86 SP-191161 0147 3 A Clarify the QoS change trigger 16.2.0
2019-12 SA#86 SP-191153 0153 2 B Introduce AMF in Nchf Converged Charging 16.2.0
2019-12 SA#86 SP-191159 0154 1 F Add Retransmission IE for alignment with TS 32.290 16.2.0
2019-12 SA#86 SP-191161 0156 1 A Correction InvocationResult description and binding 16.2.0
2019-12 SA#86 SP-191154 0159 1 B Adding Exposure Function Northbound API Specified Data Type 16.2.0
2019-12 SA#86 SP-191153 0164 - B Introduce OpenAPI for AMF charging 16.2.0
3GPP
Release 17 213 3GPP TS 32.291 V17.11.0 (2024-09)
2019-12 SA#86 SP-191167 0179 1 B Adding I-SMF related trigger type 16.2.0
2019-12 SA#86 SP-191167 0180 1 B Add I-SMF as a new serving network function 16.2.0
2019-12 SA#86 SP-191154 0186 1 B Addition of binding for exposure function northbound API 16.2.0
2019-12 SA#86 SP-191154 0187 1 B Addition of attributes in yaml for exposure function northbound API 16.2.0
2019-12 SA#86 SP-191161 0191 1 A Correction of binding for 5G data connectivity 16.2.0
2019-12 SA#86 SP-191153 0193 1 B Introduction of Binding for AMF Charging 16.2.0
2020-03 SA#87E SP-200248 0208 1 F Correct the style for TriggerType in OpenAPI 16.3.0
2020-07 SA#88E SP-200484 0217 1 F Missing event limit in trigger type 16.4.0
2020-07 SA#88E SP-200484 0219 - F Missing downlink volume in QFI container 16.4.0
2020-07 SA#88E SP-200484 0220 - F Correction of content problem, callback and version 16.4.0
2020-07 SA#88E SP-200522 0221 2 F Add the Retransmission Indicator in Open API 16.4.0
2020-07 SA#88E SP-200484 0224 1 B Add the reference about the storage of OPENAPI in FORGE 16.4.0
2020-07 SA#88E SP-200505 0226 1 B Add description on identifier for 5G RG and FN RG 16.4.0
2020-07 SA#88E SP-200485 0231 - B Introduce TS 29.500 and TS 29.501 full applicability 16.4.0
2020-07 SA#88E SP-200485 0233 1 F Correct the Charging Data Response for NEF charging 16.4.0
2020-07 SA#88E SP-200485 0237 1 F Correct offline only charging service API due to maintainance 16.4.0
2020-07 SA#88E Addressing two implementation errors in the annex Nchf_ 16.4.2
OfflineOnlyCharging API
2020-09 SA#89e SP-200740 0245 1 F Clarify Charging information 5GC interworking with EPC 16.5.0
2020-09 SA#89e SP-200813 0246 - F Corrections in names and cardinality for attributes 16.5.0
2020-09 SA#89e SP-200813 0247 1 F Authorization of CHF services access by OAuth 2.0 16.5.0
3GPP
Release 17 214 3GPP TS 32.291 V17.11.0 (2024-09)
2020-09 SA#89e SP-200742 0251 - F Charging characteristics not consistently defined 16.5.0
2020-09 SA#89e SP-200813 0252 1 F Correction of missing AF Charging Id in string format 16.5.0
2020-09 SA#89e SP-200813 0254 - F Correction to tariffTimeChange with UTC time 16.5.0
2020-09 SA#89e SP-200743 0261 1 B Add the NSPA charging attribute for convergedcharging service 16.5.0
2020-09 SA#89e SP-200813 0263 1 F Update cardinality for event time stamps 16.5.0
2020-09 SA#89e SP-200742 0265 1 A Correction on Converged Charging and Requested Unit handling 16.5.0
2020-12 SA#90e SP-201051 0272 - F Add Multi-homed PDU Address in CHF-CDR for IPv6 multi-homing 16.6.0
2020-12 SA#90e SP-201051 0277 1 F Add the enhanced Diagnostics for 5G Charging 16.6.0
2020-12 SA#90e SP-201051 0280 - F Correct the bindings for 5G data connectivity 16.6.0
2020-12 SA#90e SP-201051 0282 1 F Correction on missing NEF and PGW-C+SMF as NF consumers 16.6.0
2020-12 SA#90e SP-201049 0285 1 A Correcting charging id availability for all NF 16.6.0
2020-12 SA#90e SP-201051 0288 - F Correcting binding of event time stamp in SMS 16.6.0
2020-12 SA#90e SP-201051 0289 - F Correction of roamer in out from SMSF 16.6.0
2020-12 SA#90e SP-201088 0301 - F Correction of not quota management tariff time trigger 16.6.0
2021-03 SA#91e SP-210166 0306 1 F Missing eventLimit in trigger and OpenAPI 16.7.0
2021-03 SA#91e SP-210159 0312 1 F Correction on different identities for NEF charging 16.7.0
2021-03 SA#91e SP-210163 0314 - F Correction on missing attributes for AMF Charging 16.7.0
2021-03 SA#91e SP-210158 0315 1 F Add the Bindings for NSM Charging 16.7.0
3GPP
Release 17 215 3GPP TS 32.291 V17.11.0 (2024-09)
2021-06 SA#92e SP-210418 0320 1 F Correct the Nchf_ OfflineOnlyCharging API resource 16.8.0
definition
2021-06 SA#92e SP-210418 0321 - F Correct the Nchf_ ConvergedCharging API resource definition 16.8.0
2021-06 SA#92e SP-210398 0323 1 F Correction on Presence Reporting Areas(s) subscription in AMF 16.8.0
2021-06 SA#92e SP-210400 0325 1 F Correction on PDU address using DHCPv6 for connected RG to 16.8.0
5GC
2021-06 SA#92e SP-210413 0328 1 F Correcting feature handling for ETSUN 16.8.0
2021-09 SA#93e SP-210886 0335 1 F Clarify the Presence Reporting Area information 16.9.0
2021-09 SA#93e SP-210886 0336 - F Correction on the Used Unit container in the 16.9.0
QFIContainerInformation
2021-09 SA#93e SP-210886 0337 1 F Clarify the User Location information 16.9.0
2021-09 SA#93e SP-210888 0332 1 B Nchf interface enhancements to support of GERAN and UTRAN 17.0.0
2021-09 SA#93e SP-210863 0341 - B Addition of new URLLC information element 17.0.0
2021-12 SA#94e SP-211482 0344 1 B Addition of IMS charging information data types 17.1.0
2021-12 SA#94e SP-211482 0345 - B Addition of IMS charging information enumerations 17.1.0
2021-12 SA#94e SP-211482 0346 1 B Addition of IMS charging information general types 17.1.0
2021-12 SA#94e SP-211485 0353 3 A Alignment of the charging data request and response 17.1.0
2021-12 SA#94e SP-211481 0354 3 F Addition of QoS Monitoring to Assist URLLC Service 17.1.0
2021-12 SA#94e SP-211482 0356 1 B Addition of IMS converged charging announcement 17.1.0
2021-12 SA#94e SP-211482 0357 1 B Addition of MMTel converged charging information 17.1.0
2022-03 SA#95e SP-220164 0360 1 B Additional charging information for the 5G LAN Communication 17.2.0
2022-03 SA#95e SP-220162 0365 - F Addition of the Supported Feature for URLLC 17.2.0
2022-03 SA#95e SP-220159 0368 1 B Add charging information of 5GS CIoT 17.2.0
2022-03 SA#95e SP-220167 0375 1 B Addition of IMS converged charging yaml 17.2.0
2022-03 SA#95e SP-220167 0376 1 B Addition of MMTel converged charging yaml 17.2.0
2022-03 SA#95e SP-220167 0377 1 B Addition of IMS converged charging announcement yaml 17.2.0
3GPP
Release 17 216 3GPP TS 32.291 V17.11.0 (2024-09)
2022-06 SA#96 SP-220565 0385 1 A Correction on the identifiers for NEF API Charging information 17.3.0
2022-06 SA#96 SP-220564 0386 - F Correcting IMS triggering for PLMN change 17.3.0
2022-06 SA#96 SP-220520 0393 - F Correcting IMS called identity as array 17.3.0
2022-06 SA#96 SP-220518 0398 1 F Correction on the Qos Monitoring Report 17.3.0
2022-06 SA#96 SP-220522 0402 1 B Introduce OpenAPI for 5G Prose charging 17.3.0
2022-06 SA#96 SP-220522 0403 1 B Introduce Binding for 5G Prose charging 17.3.0
2022-06 SA#96 SP-220522 0404 1 B Introduce Data Type for 5G ProSe 17.3.0
2022-06 SA#96 SP-220519 0405 1 B Update Nchf_ConvergedCharging service API for Edge Computing 17.3.0
2022-09 SA#97e SP-220869 0408 1 F Adding missing NodeFunctionality value for IMS 17.4.0
2022-09 SA#97e SP-220869 0409 1 F Alignment between IMSNodeFunctionality description and YAML 17.4.0
2022-09 SA#97e SP-220853 0413 1 A Correction of IPv6 prefixes in PDU address 17.4.0
2022-09 SA#97e SP-220850 0415 1 F Correcting missing user location mapping to ASN.1 17.4.0
2022-09 SA#97e SP-220850 0416 1 F Correcting missing CIoT indicators in yaml 17.4.0
2022-09 SA#97e SP-220850 0423 1 F Correction on the Charging Identifier Uniqueness 17.4.0
2022-09 SA#97e SP-220868 0426 - F Correction on the mapping between EC and NEF 17.4.0
2022-09 SA#97e SP-220868 0427 - F Add the EAS ID for EC charging 17.4.0
2022-12 SA#98e SP-221193 0431 1 F SIP Request/Answer with different Timestamps 17.5.0
2022-12 SA#98e SP-221168 0432 1 F Add SMF Charging Id in Offline Charging 17.5.0
2022-12 SA#98e SP-221171 0436 1 A Case Mismatch for Management Operation 17.5.0
2022-12 SA#98e SP-221168 0437 1 F Add Missing Consumers in Converged Charging 17.5.0
3GPP
Release 17 217 3GPP TS 32.291 V17.11.0 (2024-09)
2023-03 SA#99 SP-230197 0456 1 F Correction on the YAML for Edge Charging 17.6.0
2023-06 SA#100 SP-230652 0466 1 F Add LCM Event Type in EAS Deployment Charging Info 17.7.0
2023-09 SA#101 SP-230951 0468 2 F Update EAS Infrastructure Usage Charging Information 17.8.0
2023-09 SA#101 SP-230945 0483 1 F Correction on API Target Network Function information 17.8.0
2023-09 SA#101 SP-230945 0491 1 F Correct the NSPAContaiberInformation for NSPA 17.8.0
2023-12 SA#102 SP-231491 0509 1 F Rel-17 CR 32.291 QBC Charging Session Continuity Identification 17.9.0
at V-SMF Change
2023-12 SA#102 SP-231491 0513 - F Resolve References to nrm yaml 17.9.0
2023-12 SA#102 SP-231488 0517 1 A Rel-17 CR 32.291 Correction of NEF identifiers as a list 17.9.0
3GPP