3GPP TS 32.291
3GPP TS 32.291
3GPP TS 32.291
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 15 2 3GPP TS 32.291 V15.45.0 (2019-0912)
Keywords
charging, service based interface
3GPP
Postal address
Internet
http://www.3gpp.org
Copyright Notification
© 2019, 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 15 3 3GPP TS 32.291 V15.45.0 (2019-0912)
Contents
Foreword...................................................................................................................................................6
1 Scope..............................................................................................................................................7
2 References.......................................................................................................................................7
3 Definitions, symbols and abbreviations..........................................................................................8
3.1 Definitions...................................................................................................................................................8
3.2 Symbols.......................................................................................................................................................8
3.3 Abbreviations..............................................................................................................................................8
4 Overview........................................................................................................................................9
4.1 Service architecture.....................................................................................................................................9
4.2 Network functions.......................................................................................................................................9
4.2.1 Charging Function (CHF)......................................................................................................................9
4.2.2 NF Service Consumers..........................................................................................................................9
5 Services offered by the CHF.........................................................................................................10
5.1 Introduction...............................................................................................................................................10
5.2 Nchf_ConvergedCharging service............................................................................................................10
5.2.1 Service description..............................................................................................................................10
5.2.2 Service operations...............................................................................................................................10
5.2.2.1 Introduction....................................................................................................................................10
5.2.2.2 Nchf_ConvergedCharging_Create Operation................................................................................11
5.2.2.3 Nchf_ConvergedCharging_Update Operation..............................................................................12
5.2.2.4 Nchf_ConvergedCharging_Release Operation..............................................................................12
5.2.2.5 Nchf_ConvergedCharging_Notify Operation................................................................................13
6 API definitions..............................................................................................................................14
6.1 Nchf_ ConvergedCharging Service API...................................................................................................14
6.1.1 Introduction.........................................................................................................................................14
6.1.2 Usage of HTTP....................................................................................................................................14
6.1.2.1 General...........................................................................................................................................14
6.1.2.2 HTTP standard headers..................................................................................................................14
6.1.2.2.1 General.....................................................................................................................................14
6.1.2.2.2 Content type.............................................................................................................................14
6.1.2.3 HTTP custom headers....................................................................................................................14
6.1.2.3.1 General.....................................................................................................................................14
6.1.3 Resources.............................................................................................................................................15
6.1.3.1 Overview........................................................................................................................................15
6.1.3.2 Resource: Charging Data...............................................................................................................16
6.1.3.2.1 Description...............................................................................................................................16
6.1.3.2.2 Resource Definition.................................................................................................................16
6.1.3.2.3 Resource Standard Methods.....................................................................................................16
6.1.3.2.3.1 POST..................................................................................................................................16
6.1.3.2.4 Resource Custom Operations...................................................................................................17
6.1.3.3 Resource: Individual Charging Data..............................................................................................17
6.1.3.3.1 Description...............................................................................................................................17
6.1.3.3.2 Resource Definition.................................................................................................................17
6.1.3.3.3 Resource Standard Methods.....................................................................................................18
6.1.3.3.4 Resource Custom Operations...................................................................................................18
6.1.3.3.4.1 Overview............................................................................................................................18
6.1.3.3.4.2 Operation: update...............................................................................................................18
6.1.3.3.4.2.1 Description....................................................................................................................18
6.1.3.3.4.2.2 Operation Definition.....................................................................................................18
6.1.3.3.4.3 Operation: release...............................................................................................................19
6.1.3.3.4.3.1 Description....................................................................................................................19
6.1.3.3.4.3.2 Operation Definition.....................................................................................................19
6.1.4 Custom Operations without associated resources...............................................................................20
3GPP
Release 15 4 3GPP TS 32.291 V15.45.0 (2019-0912)
6.1.5 Notifications........................................................................................................................................20
6.1.5.1 General...........................................................................................................................................20
6.1.5.2 Event Notification..........................................................................................................................20
6.1.5.2.1 Description...............................................................................................................................20
6.1.5.2.2 Target URI...............................................................................................................................20
6.1.5.2.3 Standard Methods.....................................................................................................................20
6.1.5.2.3.1 POST..................................................................................................................................20
6.1.6 Data Model..........................................................................................................................................21
6.1.6.1 General...........................................................................................................................................21
6.1.6.2 Structured data types......................................................................................................................24
6.1.6.2.1 Common Data Type.................................................................................................................24
6.1.6.2.1.1 Type ChargingDataRequest................................................................................................24
6.1.6.2.1.2 Type ChargingDataResponse.............................................................................................25
6.1.6.2.1.3 Type ChargingNotifyRequest.............................................................................................25
6.1.6.2.1.4 Type NFIdentification........................................................................................................26
6.1.6.2.1.5 Type MultipleUnitUsage....................................................................................................27
6.1.6.2.1.6 Type InvocationResult........................................................................................................27
6.1.6.2.1.7 Type Trigger.......................................................................................................................28
6.1.6.2.1.8 Type MultipleUnitInformation...........................................................................................29
6.1.6.2.1.9 Type RequestedUnit...........................................................................................................29
6.1.6.2.1.10 Type UsedUnitContainer....................................................................................................30
6.1.6.2.1.11 Type GrantedUnit...............................................................................................................31
6.1.6.2.1.12 Type FinalUnitIndication...................................................................................................31
6.1.6.2.1.13 Type RedirectServer...........................................................................................................31
6.1.6.2.1.14 Type ReauthorizationDetails..............................................................................................32
6.1.6.2.1.15 Void....................................................................................................................................32
6.1.6.2.1.16 Type ChargingNotifyResponse..........................................................................................32
6.1.6.2.2 5G Data Connectivity Specified Data Type.............................................................................32
6.1.6.2.2.1 Type ChargingDataRequest................................................................................................32
6.1.6.2.2.2 Type ChargingDataResponse.............................................................................................32
6.1.6.2.2.3 Type MultipleUnitUsage....................................................................................................33
6.1.6.2.2.4 Type MultipleUnitInformation...........................................................................................33
6.1.6.2.2.5 Type UsedUnitContainer....................................................................................................33
6.1.6.2.2.6 Type PDUSessionChargingInformation.............................................................................34
6.1.6.2.2.7 Type UserInformation........................................................................................................35
6.1.6.2.2.8 Type PDUSessionInformation............................................................................................36
6.1.6.2.2.9 Type PDUContainerInformation........................................................................................37
6.1.6.2.2.10 Type NetworkSlicingInfo...................................................................................................37
6.1.6.2.2.11 Type PDUAddress..............................................................................................................38
6.1.6.2.2.12 Type ServingNetworkFunctionID......................................................................................38
6.1.6.2.2.13 Type RoamingQBCInformation.........................................................................................38
6.1.6.2.2.14 Type MultipleQFIcontainer................................................................................................39
6.1.6.2.2.15 Type RoamingChargingProfile..........................................................................................39
6.1.6.2.2.16 Type QFIContainerInformation..........................................................................................40
6.1.6.2.2.17 Type RANSecondaryRATUsageReport.............................................................................40
6.1.6.2.2.18 Type QosFlowsUsageReport..............................................................................................41
6.1.6.2.3 SMS Specified Data Type........................................................................................................41
6.1.6.2.3.1 Type ChargingDataRequest................................................................................................41
6.1.6.2.3.2 Type SMSChargingInformation.........................................................................................42
6.1.6.2.3.3 Type OriginatorInfo............................................................................................................43
6.1.6.2.3.4 Type RecipientInfo.............................................................................................................44
6.1.6.2.3.5 Type SMAddressInfo.........................................................................................................44
6.1.6.2.3.6 Type RecipientAddress......................................................................................................44
6.1.6.2.3.7 Type MessageClass............................................................................................................45
6.1.6.2.3.8 Type SMAddressDomain...................................................................................................45
6.1.6.2.3.9 Type SMInterface...............................................................................................................45
6.1.6.3 Simple data types and enumerations..............................................................................................45
6.1.6.3.1 Introduction..............................................................................................................................45
6.1.6.3.2 Simple data types.....................................................................................................................45
6.1.6.3.3 Enumeration: NotificationType...............................................................................................46
6.1.6.3.4 Enumeration: NodeFunctionality.............................................................................................46
3GPP
Release 15 5 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 6 3GPP TS 32.291 V15.45.0 (2019-0912)
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 15 7 3GPP TS 32.291 V15.45.0 (2019-0912)
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].
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.
[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 15 8 3GPP TS 32.291 V15.45.0 (2019-0912)
[371] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3".
[400] Void.
[402] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format ".
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].
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
CHF Charging Function
CTF Charging Trigger Function
GPSI Generic Public Subscription Identifier
GUAMI Globally Unique AMF Identifier
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
3GPP
Release 15 9 3GPP TS 32.291 V15.45.0 (2019-0912)
4 Overview
The ConvergedCharging Service (Nchf_ ConvergedCharging) is part of the Nchf service-based interface exhibited by
the Charging Function (CHF) , with SMF and SMSF as the NF Service Consumer.
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.
3GPP
Release 15 10 3GPP TS 32.291 V15.45.0 (2019-0912)
5.1 Introduction
The following services are provided by the CHF.
- 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 15 11 3GPP TS 32.291 V15.45.0 (2019-0912)
The following procedures using the Nchf_ConvergedCharging_Create service operation are supported:
3GPP
Release 15 12 3GPP TS 32.291 V15.45.0 (2019-0912)
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 15 13 3GPP TS 32.291 V15.45.0 (2019-0912)
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 request. The notification type is included
in the request body.
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.
3GPP
Release 15 14 3GPP TS 32.291 V15.45.0 (2019-0912)
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.
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.
6.1.2.3.1 General
HTTP custom header fields shall be supported as specified in subclause 5.2.3.2 of 3GPP TS 29.500 [299].
3GPP
Release 15 15 3GPP TS 32.291 V15.45.0 (2019-0912)
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.
3GPP
Release 15 16 3GPP TS 32.291 V15.45.0 (2019-0912)
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 15 17 3GPP TS 32.291 V15.45.0 (2019-0912)
Table 6.1.3.2.3.1-3: Data structures supported by the POST Response Body 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,
3GPP
Release 15 18 3GPP TS 32.291 V15.45.0 (2019-0912)
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
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
3GPP
Release 15 19 3GPP TS 32.291 V15.45.0 (2019-0912)
Table 6.1.3.3.4.2.2-2: Data structures supported by the POST Response Body 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 15 20 3GPP TS 32.291 V15.45.0 (2019-0912)
Table 6.1.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 204 No Successful case: The Charging Data resource matching the
Content ChargingDataRef is modified and then released.
ChargingDataRespons M 1 404 Not (NOTE 2)
e Found
n/a 410 Gone (NOTE 2)
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
[4] also apply.
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].
6.1.5.2.1 Description
The Notification is used by the CHF to notify NF consumers of the subscribed events is occurs , 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 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
3GPP
Release 15 21 3GPP TS 32.291 V15.45.0 (2019-0912)
Table 6.1.5.2.3.1-2: Data structures supported by the POST Response Body 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 15 22 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 23 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 24 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 25 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 26 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 27 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 28 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 29 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 30 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 31 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 32 3GPP TS 32.291 V15.45.0 (2019-0912)
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].
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].
3GPP
Release 15 33 3GPP TS 32.291 V15.45.0 (2019-0912)
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 15 34 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 35 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 36 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 37 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 38 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 39 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 40 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 41 3GPP TS 32.291 V15.45.0 (2019-0912)
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 15 42 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 43 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 44 3GPP TS 32.291 V15.45.0 (2019-0912)
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 15 45 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 46 3GPP TS 32.291 V15.45.0 (2019-0912)
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 15 47 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 48 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 49 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 50 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 51 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 52 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 53 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 54 3GPP TS 32.291 V15.45.0 (2019-0912)
6.1.6.3.17 Void
3GPP
Release 15 55 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 56 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 57 3GPP TS 32.291 V15.45.0 (2019-0912)
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 subclause 5.2.4 of 3GPP TS 29.500 [4].
For the Nchf_ConvergedCharging API, HTTP error responses shall be supported as specified in subclause 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 [4] 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 [4]. In addition, the requirements in the following subclauses shall apply.
3GPP
Release 15 58 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 59 3GPP TS 32.291 V15.45.0 (2019-0912)
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 15 60 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 61 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 62 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 63 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 64 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 65 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 66 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 67 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 68 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 69 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 70 3GPP TS 32.291 V15.45.0 (2019-0912)
8 Security
Security aspects for service based interface shall be supported as specified in subclause 13 of 3GPP TS 33.501 [390].
Annex A (normative):
OpenAPI specification
A.1 General
The present Annex contains an OpenAPI [500] specification of HTTP messages and content bodies used by the
Nchf_ConvergedCharging 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 3GPP Technical Specification are available on
the public 3GPP file server in the following locations (see clause 5B of the 3GPP TR 21.900 [7] for further
information):
- https://www.3gpp.org/ftp/Specs/archive/OpenAPI/<Release>/, and
- https://www.3gpp.org/ftp/Specs/<Plenary>/<Release>/OpenAPI/.
3GPP
Release 15 71 3GPP TS 32.291 V15.45.0 (2019-0912)
$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'
callbacks:
myNotification:
'{$request.body#/notifyUri}':
post:
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ChargingNotifyRequest'
responses:
'204':
description: 'No Content, Notification was succesfull'
'400':
description: Bad request
content:
application/json:
schema:
$ref: >-
TS29571_CommonData.yaml#/components/schemas/ProblemDetails
default:
$ref: 'TS29571_CommonData.yaml#/components/responses/default'
'/chargingdata/{ChargingDataRef}/update':
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:
'200':
description: OK. Updated Charging Data resource is returned
content:
application/json:
schema:
$ref: '#/components/schemas/ChargingDataResponse'
'400':
3GPP
Release 15 72 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 73 3GPP TS 32.291 V15.45.0 (2019-0912)
invocationTimeStamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
invocationSequenceNumber:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
oneTimeEvent:
type: boolean
oneTimeEventType:
$ref: '#/components/schemas/oneTimeEventType'
notifyUri:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
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'
sMSChargingInformation:
$ref: '#/components/schemas/SMSChargingInformation'
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'
multipleUnitInformation:
type: array
items:
$ref: '#/components/schemas/MultipleUnitInformation'
minItems: 0
triggers:
type: array
items:
$ref: '#/components/schemas/Trigger'
minItems: 0
pDUSessionChargingInformation:
$ref: '#/components/schemas/PDUSessionChargingInformation'
roamingQBCInformation:
$ref: '#/components/schemas/RoamingQBCInformation'
required:
- nfConsumerIdentification
- 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:
3GPP
Release 15 74 3GPP TS 32.291 V15.45.0 (2019-0912)
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'
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'
maxNumberOfccc:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32'
required:
- triggerType
- 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:
3GPP
Release 15 75 3GPP TS 32.291 V15.45.0 (2019-0912)
type: integer
volumeQuotaThreshold:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
unitQuotaThreshold:
type: integer
uPFID:
$ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
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:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
downlinkVolume:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
serviceSpecificUnits:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64'
eventTimeStamps:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
localSequenceNumber:
type: integer
pDUContainerInformation:
$ref: '#/components/schemas/PDUContainerInformation'
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'
filterId:
type: string
3GPP
Release 15 76 3GPP TS 32.291 V15.45.0 (2019-0912)
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'
PDUSessionChargingInformation:
type: object
properties:
chargingId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId'
userInformation:
$ref: '#/components/schemas/UserInformation'
userLocationinfo:
$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'
dnnId:
3GPP
Release 15 77 3GPP TS 32.291 V15.45.0 (2019-0912)
$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn'
dnnSelectionMode:
$ref: '#/components/schemas/dnnSelectionMode'
chargingCharacteristics:
type: string
chargingCharacteristicsSelectionMode:
$ref: '#/components/schemas/ChargingCharacteristicsSelectionMode'
startTime:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
stopTime:
$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'
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'
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
NetworkSlicingInfo:
type: object
properties:
sNSSAI:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai'
required:
- sNSSAI
PDUAddress:
type: object
properties:
pduIPv4Address:
3GPP
Release 15 78 3GPP TS 32.291 V15.45.0 (2019-0912)
$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'
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'
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:
3GPP
Release 15 79 3GPP TS 32.291 V15.45.0 (2019-0912)
type: array
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'
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'
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
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:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
originatorOtherAddress:
$ref: '#/components/schemas/SMAddressInfo'
originatorReceivedAddress:
3GPP
Release 15 80 3GPP TS 32.291 V15.45.0 (2019-0912)
$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'
Diagnostics:
type: integer
IPFilterRule:
type: string
3GPP
Release 15 81 3GPP TS 32.291 V15.45.0 (2019-0912)
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'
NotificationType:
anyOf:
- type: string
enum:
- REAUTHORIZATION
- ABORT_CHARGING
- type: string
NodeFunctionality:
anyOf:
- type: string
enum:
- SMF
- SMSF
- type: string
ChargingCharacteristicsSelectionMode:
anyOf:
- type: string
enum:
- HOME_DEFAULT
- ROAMING_DEFAULT
- VISITING_DEFAULT
- type: string
TriggerType:
anyOf:
- type: string
enum:
- QUOTA_THRESHOLD
- QHT
- 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
- 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
- START_OF_SERVICE_DATA_FLOW
- GFBR_GUARANTEED_STATUS_CHANGE
- type: string
FinalUnitAction:
anyOf:
- type: string
enum:
- TERMINATE
- REDIRECT
- RESTRICT_ACCESS
- type: string
RedirectAddressType:
anyOf:
3GPP
Release 15 82 3GPP TS 32.291 V15.45.0 (2019-0912)
- type: string
enum:
- IPV4
- IPV6
- URL
- type: string
TriggerCategory:
anyOf:
- type: string
enum:
- IMMEDIATE_REPORT
- DEFERRED_REPORT
- type: string
QuotaManagementIndicator:
anyOf:
- type: string
enum:
- ONLINE_CHARGING
- OFFLINE_CHARGING
- 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
- QUOTA_MANAGEMENT_NOT_APPLICABLE
- QUOTA_LIMIT_REACHED
- END_USER_SERVICE_REJECTED
- USER_UNKNOWN
- RATING_FAILED
- 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
- type: string
SMPriority:
anyOf:
3GPP
Release 15 83 3GPP TS 32.291 V15.45.0 (2019-0912)
- 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
- 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:
3GPP
Release 15 84 3GPP TS 32.291 V15.45.0 (2019-0912)
- type: string
enum:
- IEC
- PEC
- type: string
dnnSelectionMode:
anyOf:
- type: string
enum:
- VERIFIED
- UE_DNN_NOT_VERIFIED
- NW_DNN_NOT_VERIFIED
- type: string
3GPP
Release 15 85 3GPP TS 32.291 V15.45.0 (2019-0912)
3GPP
Release 15 86 3GPP TS 32.291 V15.45.0 (2019-0912)
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 15 87 3GPP TS 32.291 V15.45.0 (2019-0912)
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-09 SA#85 SP-190762 0085 1 F Correction of Report Time in QFI Container Information 15.4.0
2019-09 SA#85 SP-190762 0098 - F Correct the QoS change trigger 15.4.0
2019-09 SA#85 SP-190762 0099 1 F Add the selection mode in PDU session information 15.4.0
3GPP
Release 15 88 3GPP TS 32.291 V15.45.0 (2019-0912)
2019-09 SA#85 SP-190840 0105 1 F Bindings for 5G data connectivity correction 15.4.0
2019-09 SA#85 SP-190840 0106 1 F Correction of data structure of response body 15.4.0
2019-09 SA#85 SP-190840 0107 - F Correction of serving Network Function identifier 15.4.0
2019-12 SA#86 SP-191160 0128 1 F Add the Service Specification Information 15.5.0
2019-12 SA#86 SP-191160 0131 3 F Clarify the QoS change trigger 15.5.0
2019-12 SA#86 SP-191161 0155 1 F Correction InvocationResult description and binding 15.5.0
2019-12 SA#86 SP-191161 0190 1 F Correction of binding for 5G data connectivity 15.5.0
3GPP