Skip to content
openapi: 3.0.0
info:
version: '1.2.0-alpha.1'
version: '1.2.0-alpha.2'
title: 'Nipsmgw_SMService Service API'
description: |
IP-SM-GW SMService.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.577 V19.0.0; 5G System; IP Short Message Gateway and SMS Router For
3GPP TS 29.577 V19.2.0; 5G System; IP Short Message Gateway and SMS Router For
Short Message Services; Stage 3
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.577/'
......
openapi: 3.0.0
info:
version: '1.2.0-alpha.1'
version: '1.2.0-alpha.2'
title: 'Nrouter_SMService Service API'
description: |
SMS Router SMService.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.577 V19.0.0; 5G System; IP Short Message Gateway and SMS Router For
3GPP TS 29.577 V19.2.0; 5G System; IP Short Message Gateway and SMS Router For
Short Message Services; Stage 3
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.577/'
......
openapi: 3.0.0
info:
title: 'Nmnpf_NPStatus'
version: '1.2.0-alpha.1'
version: '1.2.0-alpha.2'
description: |
Nmnpf Number Portability Status Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.578 V19.0.0; Mobile Number Portability Services.
description: 3GPP TS 29.578 V19.1.0; Mobile Number Portability Services.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.578/
servers:
- url: '{apiRoot}/nmnpf-npstatus/v1'
......
openapi: 3.0.0
info:
title: 'Niwmsc_SMService'
version: '1.2.0-alpha.1'
version: '1.2.0-alpha.2'
description: |
SMS-IWMSC Short Message Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.579 V19.1.0; 5G System; Interworking MSC For Short Message Services; Stage 3.
3GPP TS 29.579 V19.2.0; 5G System; Interworking MSC For Short Message Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.579/
servers:
......
......@@ -2,7 +2,7 @@ openapi: 3.0.0
info:
title: nmbsf-mbs-ud-ingest
version: 1.2.0-alpha.1
version: 1.2.0-alpha.2
description: |
API for MBS User Data Ingest Session Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -10,7 +10,7 @@ info:
externalDocs:
description: >
3GPP TS 29.580 V19.1.0; 5G System; Multicast/Broadcast Service Function Services.
3GPP TS 29.580 V19.2.0; 5G System; Multicast/Broadcast Service Function Services.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.580/'
servers:
......@@ -23,6 +23,9 @@ servers:
security:
- {}
- oAuth2ClientCredentials: []
#When the Nmbsf_MBSUserDataIngestSession API is consumed by a trusted or internal AF, then the
#"oAuth2ClientCredentials" property shall contain an array of scopes including the API level
#"nmbsf-mbs-ud-ingest" scope as the only scope.
paths:
/sessions:
......@@ -719,10 +722,10 @@ components:
tokenUrl: '{tokenUrl}'
scopes: {}
description: >
When the Nmbsf_MBSUserDataIngestSession is consumed by a trusted or internal AF, then
'nmbsf-mbs-ud-ingest' shall be used as the scope (i.e. with the 'scopes' property) and
'{nrfApiRoot}/oauth2/token' shall be used as the URI to retrieve the token
(i.e. 'tokenUri').
When the Nmbsf_MBSUserDataIngestSession API is consumed by a trusted or internal AF, then
'nmbsf-mbs-ud-ingest' shall be used as the scope value (i.e. within the "scopes" property)
and '{nrfApiRoot}/oauth2/token' shall be used as the URI to retrieve the token within the
"tokenUrl" property (i.e., instead of 'tokenUri').
#
# STRUCTURED DATA TYPES
......
......@@ -2,15 +2,15 @@ openapi: 3.0.0
info:
title: nmbsf-mbs-us
version: 1.1.0
version: 1.2.0-alpha.1
description: |
API for MBS User Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.580 V18.5.0; 5G System; Multicast/Broadcast Service Function Services.
3GPP TS 29.580 V19.2.0; 5G System; Multicast/Broadcast Service Function Services.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.580/'
servers:
......@@ -23,6 +23,9 @@ servers:
security:
- {}
- oAuth2ClientCredentials: []
#When the Nmbsf_MBSUserService API is consumed by a trusted or internal AF, then the
#"oAuth2ClientCredentials" property shall contain an array of scopes including the API level
#"nmbsf-mbs-us" scope as the only scope.
paths:
......@@ -324,10 +327,10 @@ components:
tokenUrl: '{tokenUri}'
scopes: {}
description: >
When the Nmbsf_MBSUserService is consumed by a trusted or internal AF, then
'nmbsf-mbs-us' shall be used as the scope (i.e. within the 'scopes' property) and
'{nrfApiRoot}/oauth2/token' shall be used as the URI to retrieve the token
(i.e. 'tokenUri').
When the Nmbsf_MBSUserService API is consumed by a trusted or internal AF, then
'nmbsf-mbs-us' shall be used as the scope (i.e. within the "scopes" property) and
'{nrfApiRoot}/oauth2/token' shall be used as the URI to retrieve the token within the
"tokenUrl" property (i.e., instead of 'tokenUri').
#
# STRUCTURED DATA TYPES
......
......@@ -2,14 +2,14 @@ openapi: 3.0.0
info:
title: Nmbstf-distsession
version: 1.1.0
version: 1.2.0-alpha.1
description: |
MBSTF Distribution Session Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.581 V18.5.0; 5G System; MBSDistribution Service.
description: 3GPP TS 29.581 V19.0.0; 5G System; MBSDistribution Service.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.581/
servers:
......@@ -548,11 +548,19 @@ components:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
objDistributionBaseUrl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
objRepairExpBaseUrl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
objRepairIngestBaseUrl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
required:
- objDistributionOperatingMode
- objAcquisitionMethod
not:
required: [ objAcquisitionIdsPull, objAcquisitionIdPush ]
allOf:
- oneOf:
- required: [ objAcquisitionIdsPull ]
- required: [ objAcquisitionIdPush ]
- not:
required: [ objRepairExpBaseUrl, objRepairIngestBaseUrl ]
PktDistributionData:
description: Info for Packet Distribution Method
......
......@@ -2,15 +2,15 @@ openapi: 3.0.0
info:
title: Nslpkmf_Discovery API
version: '1.1.0-alpha.1'
version: '1.1.0-alpha.2'
description: |
Nslpkmf_Discovery Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.586 V19.0.0; 5G System; SideLink Positioning Key Management Services; Stage 3.
3GPP TS 29.586 V19.1.0; 5G System; SideLink Positioning Key Management Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.586/
servers:
......
......@@ -2,15 +2,15 @@ openapi: 3.0.0
info:
title: Nslpkmf_SLPKMFKeyRequest
version: '1.0.0'
version: '1.1.0-alpha.1'
description: |
SLPKMF KeyRequest Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.586 V18.1.0; 5G System; SideLink Positioning Key Management Services; Stage 3.
3GPP TS 29.586 V19.1.0; 5G System; SideLink Positioning Key Management Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.586/
servers:
......
openapi: 3.0.0
info:
title: Nnef_DNAIMapping
version: 1.1.0-alpha.1
version: 1.1.0-alpha.2
description: |
NEF DNAI Mapping Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.591 V19.2.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
3GPP TS 29.591 V19.3.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/
servers:
- url: '{apiRoot}/nnef-dnai-mapping/v1'
......
......@@ -2,7 +2,7 @@ openapi: 3.0.0
info:
title: Nnef_EASDeployment
version: 1.2.0-alpha.2
version: 1.2.0-alpha.3
description: |
NEF EAS Deployment service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -10,7 +10,7 @@ info:
externalDocs:
description: >
3GPP TS 29.591 V19.2.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
3GPP TS 29.591 V19.3.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/
servers:
......
......@@ -2,15 +2,15 @@ openapi: 3.0.0
info:
title: Nnef_ECSAddressConfigurationInformation
version: 1.0.1
version: 1.1.0-alpha.1
description: |
NEF ECS Address Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.591 V18.7.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
3GPP TS 29.591 V19.3.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/
servers:
......
......@@ -2,7 +2,7 @@ openapi: 3.0.0
info:
title: Nnef_EventExposure
version: 1.4.0-alpha.2
version: 1.4.0-alpha.3
description: |
NEF Event Exposure Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -10,7 +10,7 @@ info:
externalDocs:
description: >
3GPP TS 29.591 V19.2.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
3GPP TS 29.591 V19.3.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/
servers:
......
......@@ -2,7 +2,7 @@ openapi: 3.0.0
info:
title: Nnef_TrafficInfluenceData
version: 1.1.0-alpha.1
version: 1.1.0-alpha.2
description: |
NEF Traffic Influence Data Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
......@@ -10,7 +10,7 @@ info:
externalDocs:
description: >
3GPP TS 29.591 V19.2.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
3GPP TS 29.591 V19.3.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/
servers:
......
openapi: 3.0.0
info:
title: Nnef_UEId
version: 1.1.1-alpha.1
version: 1.1.1-alpha.2
description: |
NEF Traffic Correlation Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.591 V19.1.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
3GPP TS 29.591 V19.3.0; 5G System; Network Exposure Function Southbound Services; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.591/
servers:
- url: '{apiRoot}/nnef-ueid/v1'
......
openapi: 3.0.0
info:
version: 1.3.0
version: 1.4.0-alpha.1
title: Nchf_SpendingLimitControl
description: |
Nchf Spending Limit Control Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.594 V18.4.0; 5G System; Spending Limit Control Service.
description: 3GPP TS 29.594 V19.1.0; 5G System; Spending Limit Control Service.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.594/'
servers:
......
openapi: 3.0.0
info:
title: Nudsf_DataRepository
version: 1.3.0-alpha.1
version: 1.3.0-alpha.2
description: |
Nudsf Data Repository Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.598 UDSF Services, V19.1.0.
description: 3GPP TS 29.598 UDSF Services, V19.2.0.
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.598/'
servers:
......@@ -169,7 +169,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/RecordIdList'
$ref: '#/components/schemas/RecordDeleteResponse'
'204':
description: Successful case.
'400':
......@@ -2325,6 +2325,22 @@ components:
required:
- recordIdList
FailedRecordIdList:
description: List of Record IDs that failed to be deleted
type: object
properties:
failedRecordIdList:
type: array
items:
type: string
minItems: 1
RecordDeleteResponse:
description: Response to record deletion
allOf:
- $ref: '#/components/schemas/RecordIdList'
- $ref: '#/components/schemas/FailedRecordIdList'
Block:
description: A Block can be of any type
example: >-
......
......@@ -2,14 +2,14 @@ openapi: 3.0.0
info:
title: Nucmf_UECapabilityManagement
version: 1.2.0
version: 1.3.0-alpha.1
description: |
Nucmf_UECapabilityManagement Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.673 V18.4.0; 5G System; UE Radio Capability Management Services
description: 3GPP TS 29.673 V19.0.0; 5G System; UE Radio Capability Management Services
url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.673/'
servers:
......
openapi: 3.0.0
info:
title: Nucmf_Provisioning
version: 1.2.0
version: 1.3.0-alpha.1
description: |
UCMF_Provisioning Service.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.675 V18.4.0; User Equipment (UE) radio capability provisioning service; Stage 3.
3GPP TS 29.675 V19.0.0; User Equipment (UE) radio capability provisioning service; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.675/
servers:
- url: '{apiRoot}/nucmf-provisioning/v1'
......
openapi: 3.0.0
info:
title: Nchf_ConvergedCharging
version: 3.3.0-alpha.2
version: 3.3.0-alpha.3
description: |
ConvergedCharging Service © 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 32.291 V19.2.0: Telecommunication management; Charging management;
3GPP TS 32.291 V19.3.0: Telecommunication management; Charging management;
5G system, charging service; Stage 3.
url: 'http://www.3gpp.org/ftp/Specs/archive/32_series/32.291/'
servers:
......@@ -380,6 +380,8 @@ components:
$ref: '#/components/schemas/NSSAAChargingInformation'
rangingSLChargingInformation:
$ref: '#/components/schemas/RangingSLChargingInformation'
lCSInformation:
$ref: '#/components/schemas/LCSInformation'
required:
- nfConsumerIdentification
- invocationTimeStamp
......@@ -1779,6 +1781,20 @@ components:
$ref: '#/components/schemas/TADIdentifier'
feIdentifierList:
type: string
imsDCAppInfo:
$ref: '#/components/schemas/IMSDCAppInfo'
satelliteIdList:
type: array
items:
$ref: '#/components/schemas/SatelliteId'
minItems: 1
IMSDCAppInfo:
type: object
properties:
applicationId:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId'
httpUrl:
$ref: 'TS29571_CommonData.yaml#/components/schemas/ReplaceHttpUrl'
EdgeInfrastructureUsageChargingInformation:
type: object
properties:
......@@ -2058,6 +2074,13 @@ components:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
proximityCancellationTimestamp:
$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
hopCount:
type: integer
intermediateRelayInformationContainer:
type: array
items:
$ref: '#/components/schemas/IntermediateRelayInformationContainer'
minItems: 0
relayIPAddress:
$ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'
proseUEToNetworkRelayUEID :
......@@ -2135,6 +2158,19 @@ components:
$ref: '#/components/schemas/LocationType'
locationEstimate:
$ref: '#/components/schemas/LocationEstimate'
LCSInformation:
type: object
properties:
lCSClientID:
type: string
locationType:
$ref: '#/components/schemas/LocationType'
locationEstimate:
$ref: '#/components/schemas/LocationEstimate'
positioningData:
type: string
targetUEID:
$ref: 'TS29571_CommonData.yaml#/components/schemas/Supi'
LocationEstimate:
type: object
properties:
......@@ -2144,6 +2180,13 @@ components:
$ref: '#/components/schemas/OctetString'
verticalAccuracy:
$ref: '#/components/schemas/OctetString'
IntermediateRelayInformationContainer:
type: object
properties:
intermediateRelayIPAddress:
$ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr'
proseUEToNetworkIntermediateRelayUEID:
type: string
PFIContainerInformation:
type: object
properties:
......@@ -2388,6 +2431,8 @@ components:
$ref: '#/components/schemas/NNIRelationshipMode'
neighbourNodeAddress:
$ref: '#/components/schemas/IMSAddress'
SatelliteId:
type: string
EASRequirements:
type: object
properties:
......@@ -2545,6 +2590,8 @@ components:
- MB_SMF
- CHF
- GMLC
- AIOTF
- CCF
- type: string
ChargingCharacteristicsSelectionMode:
anyOf:
......@@ -2975,7 +3022,7 @@ components:
anyOf:
- type: string
enum:
# The applicable IMS Nodes are MRFC, IMS-GWF (connected to S-CSCF using ISC) and SIP AS.
# The applicable IMS Nodes are MRFC, IMS-GWF (connected to S-CSCF using ISC), SIP AS and DCSF.
- S_CSCF
- P_CSCF
- I_CSCF
......@@ -2999,6 +3046,7 @@ components:
- SCEF
- IWK_SCEF
- IMS_GWF
- DCSF
- type: string
RoleOfIMSNode:
anyOf:
......