API docs by Redocly

Nsmf_PDUSession (1.3.2)

Download OpenAPI specification:

SMF PDU Session Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

3GPP TS 29.502 V18.10.0; 5G System; Session Management Services; Stage 3

SM contexts collection

Create SM Context

Authorizations:
NoneoAuth2ClientCredentials
Request Body schema: multipart/related
required

representation of the SM context to be created in the SMF

object (SmContextCreateData)

Data within Create SM Context Request

binaryDataN1SmMessage
string <binary>
binaryDataN2SmInformation
string <binary>
binaryDataN2SmInformationExt1
string <binary>

Responses

Callbacks

Response samples

Content type
{
  • "hSmfUri": "string",
  • "smfUri": "string",
  • "pduSessionId": 255,
  • "sNssai": {
    },
  • "additionalSnssai": {
    },
  • "upCnxState": "ACTIVATED",
  • "n2SmInfo": {
    },
  • "n2SmInfoType": "PDU_RES_SETUP_REQ",
  • "allocatedEbiList": [
    ],
  • "hoState": "NONE",
  • "gpsi": "string",
  • "smfServiceInstanceId": "string",
  • "recoveryTime": "2019-08-24T14:15:22Z",
  • "supportedFeatures": "string",
  • "selectedSmfId": "f3ac1967-fd31-4624-b3e9-1fb6917abbb2",
  • "selectedOldSmfId": "6eb48d41-515c-4edc-8db3-6c151ffedda2",
  • "interPlmnApiRoot": "string",
  • "udmGroupId": "string",
  • "pcfGroupId": "string",
  • "pduSessionPrio": 0
}

Callback payload samples

Callback
POST: {$request.body#/smContextStatusUri}
Content type
application/json
{
  • "statusInfo": {
    },
  • "smallDataRateStatus": {
    },
  • "apnRateStatus": {
    },
  • "ddnFailureStatus": false,
  • "notifyCorrelationIdsForddnFailure": [
    ],
  • "newIntermediateSmfId": "0ef69086-9b38-428e-ac67-22e330104c1c",
  • "newSmfId": "6a694a81-da78-4c3b-abe0-7f9893fe70c5",
  • "newSmfSetId": "string",
  • "oldSmfId": "8d3c5ecf-aae7-4cc7-9c10-f0f450656be0",
  • "oldSmContextRef": "string",
  • "altAnchorSmfUri": "string",
  • "altAnchorSmfId": "03ff5521-dbe6-45dc-b7aa-6f219da89517",
  • "targetDnaiInfo": {
    },
  • "oldPduSessionRef": "string",
  • "interPlmnApiRoot": "string",
  • "targetDnai": "string"
}

Individual SM context

Retrieve SM Context

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
smContextRef
required
string

SM context reference

Request Body schema: application/json
optional

parameters used to retrieve the SM context

object (MmeCapabilities)

MME capabilities

string or string (SmContextType)

Type of SM Context information. Possible values are

  • EPS_PDN_CONNECTION
  • SM_CONTEXT
  • AF_COORDINATION_INFO
object (PlmnId)

When PlmnId needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc".

notToTransferEbiList
Array of integers (EpsBearerId) non-empty [ items [ 0 .. 15 ] ]
ranUnchangedInd
boolean
Default: false
hrsboSupportInd
boolean
Default: false
storedOffloadIds
Array of strings (OffloadIdentifier) non-empty [ items^[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{8}(-v[0-9]{1... ]

Responses

Request samples

Content type
application/json
{
  • "targetMmeCap": {
    },
  • "smContextType": "EPS_PDN_CONNECTION",
  • "servingNetwork": {
    },
  • "notToTransferEbiList": [
    ],
  • "ranUnchangedInd": false,
  • "hrsboSupportInd": false,
  • "storedOffloadIds": [
    ]
}

Response samples

Content type
application/json
{
  • "ueEpsPdnConnection": "string",
  • "smContext": {
    },
  • "smallDataRateStatus": {
    },
  • "apnRateStatus": {
    },
  • "dlDataWaitingInd": false,
  • "afCoordinationInfo": {
    }
}

Update SM Context

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
smContextRef
required
string

SM context reference

Request Body schema:
required

representation of the updates to apply to the SM context

pei
string (Pei) ^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a...

String representing a Permanent Equipment Identifier that may contain - an IMEI or IMEISV, as specified in clause 6.2 of 3GPP TS 23.003; a MAC address for a 5G-RG or FN-RG via wireline access, with an indication that this address cannot be trusted for regulatory purpose if this address cannot be used as an Equipment Identifier of the FN-RG, as specified in clause 4.7.7 of 3GPP TS23.316. Examples are imei-012345678901234 or imeisv-0123456789012345.

servingNfId
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

object (Guami)

Globally Unique AMF Identifier constructed out of PLMN, Network and AMF identity.

object (PlmnIdNid)

Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.

Array of objects or null (BackupAmfInfo) non-empty
anType
string (AccessType)
Enum: "3GPP_ACCESS" "NON_3GPP_ACCESS"

Indicates whether the access is via 3GPP or via non-3GPP.

additionalAnType
string (AccessType)
Enum: "3GPP_ACCESS" "NON_3GPP_ACCESS"

Indicates whether the access is via 3GPP or via non-3GPP.

anTypeToReactivate
string (AccessType)
Enum: "3GPP_ACCESS" "NON_3GPP_ACCESS"

Indicates whether the access is via 3GPP or via non-3GPP.

anTypeOfN1N2Info
string (AccessType)
Enum: "3GPP_ACCESS" "NON_3GPP_ACCESS"

Indicates whether the access is via 3GPP or via non-3GPP.

string or string (RatType)

Indicates the radio access used.

string or string (PresenceState)

Possible values are: -IN_AREA: Indicates that the UE is inside or enters the presence reporting area. -OUT_OF_AREA: Indicates that the UE is outside or leaves the presence reporting area -UNKNOW: Indicates it is unknown whether the UE is in the presence reporting area or not -INACTIVE: Indicates that the presence reporting area is inactive in the serving node.

object (UserLocation)

At least one of eutraLocation, nrLocation and n3gaLocation shall be present. Several of them may be present.

ueTimeZone
string (TimeZone)

String with format "time-numoffset" optionally appended by "daylightSavingTime", where

  • "time-numoffset" shall represent the time zone adjusted for daylight saving time and be encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339;
  • "daylightSavingTime" shall represent the adjustment that has been made and shall be encoded as "+1" or "+2" for a +1 or +2 hours adjustment.

The example is for 8 hours behind UTC, +1 hour adjustment for Daylight Saving Time.

object (UserLocation)

At least one of eutraLocation, nrLocation and n3gaLocation shall be present. Several of them may be present.

string or string (UpCnxState)

User Plane Connection State. Possible values are

  • ACTIVATED
  • DEACTIVATED
  • ACTIVATING
  • SUSPENDED
string or string (HoState)

Handover state. Possible values are

  • NONE
  • PREPARING
  • PREPARED
  • COMPLETED
  • CANCELLED
toBeSwitched
boolean
Default: false
failedToBeSwitched
boolean
object (RefToBinaryData)

This parameter provides information about the referenced binary body data.

object (RefToBinaryData)

This parameter provides information about the referenced binary body data.

string or string (N2SmInfoType)

N2 SM Information Type. Possible values are

  • PDU_RES_SETUP_REQ
  • PDU_RES_SETUP_RSP
  • PDU_RES_SETUP_FAIL
  • PDU_RES_REL_CMD
  • PDU_RES_REL_RSP
  • PDU_RES_MOD_REQ
  • PDU_RES_MOD_RSP
  • PDU_RES_MOD_FAIL
  • PDU_RES_NTY
  • PDU_RES_NTY_REL
  • PDU_RES_MOD_IND
  • PDU_RES_MOD_CFM
  • PATH_SWITCH_REQ
  • PATH_SWITCH_SETUP_FAIL
  • PATH_SWITCH_REQ_ACK
  • PATH_SWITCH_REQ_FAIL
  • HANDOVER_REQUIRED
  • HANDOVER_CMD
  • HANDOVER_PREP_FAIL
  • HANDOVER_REQ_ACK
  • HANDOVER_RES_ALLOC_FAIL
  • SECONDARY_RAT_USAGE
  • PDU_RES_MOD_IND_FAIL
  • UE_CONTEXT_RESUME_REQ
  • UE_CONTEXT_RESUME_RSP
  • UE_CONTEXT_SUSPEND_REQ
object (NgRanTargetId)

Indicates a NG RAN as target of the handover

targetServingNfId
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

smContextStatusUri
string (Uri)

String providing an URI formatted according to RFC 3986.

dataForwarding
boolean
Default: false
object (TunnelInfo)

Tunnel Information

Array of objects (IndirectDataForwardingTunnelInfo) non-empty
Array of objects (IndirectDataForwardingTunnelInfo) non-empty
object (TunnelInfo)

Tunnel Information

n9InactivityTimer
integer (DurationSec)

indicating a time in seconds.

epsBearerSetup
Array of strings <byte> (EpsBearerContainer) >= 0 items [ items <byte > ]
revokeEbiList
Array of integers (EpsBearerId) non-empty [ items [ 0 .. 15 ] ]
release
boolean
Default: false
string or string (Cause)

Cause information. Possible values are

  • REL_DUE_TO_HO
  • EPS_FALLBACK
  • REL_DUE_TO_UP_SEC
  • DNN_CONGESTION
  • S_NSSAI_CONGESTION
  • REL_DUE_TO_REACTIVATION
  • 5G_AN_NOT_RESPONDING
  • REL_DUE_TO_SLICE_NOT_AVAILABLE
  • REL_DUE_TO_DUPLICATE_SESSION_ID
  • PDU_SESSION_STATUS_MISMATCH
  • HO_FAILURE
  • INSUFFICIENT_UP_RESOURCES
  • PDU_SESSION_HANDED_OVER
  • PDU_SESSION_RESUMED
  • CN_ASSISTED_RAN_PARAMETER_TUNING
  • ISMF_CONTEXT_TRANSFER
  • SMF_CONTEXT_TRANSFER
  • REL_DUE_TO_PS_TO_CS_HO
  • REL_DUE_TO_SUBSCRIPTION_CHANGE
  • HO_CANCEL
  • REL_DUE_TO_SLICE_NOT_AUTHORIZED
  • PDU_SESSION_HAND_OVER_FAILURE
  • DDN_FAILURE_STATUS
  • REL_DUE_TO_CP_ONLY_NOT_APPLICABLE
  • NOT_SUPPORTED_WITH_ISMF
  • CHANGED_ANCHOR_SMF
  • CHANGED_INTERMEDIATE_SMF
  • TARGET_DNAI_NOTIFICATION
  • REL_DUE_TO_VPLMN_QOS_FAILURE
  • REL_DUE_TO_SMF_NOT_SUPPORT_PSETR
  • REL_DUE_TO_SNPN_SNPN_MOBILITY
  • REL_DUE_TO_NO_HR_AGREEMENT
  • REL_DUE_TO_UNSPECIFIED_REASON
  • REL_DUE_TO_MOB_ACCESS_RESTRICTIONS
  • REL_DUE_TO_SLICE_INACTIVITY
  • REL_DUE_TO_NSI_NOT_AVAILABLE
  • REL_DUE_TO_DNN_DENIED
  • REL_DUE_TO_PDUTYPE_DENIED
  • REL_DUE_TO_SSC_DENIED
  • REL_DUE_TO_SUBSCRIPTION_DENIED
  • REL_DUE_TO_DNN_NOT_SUPPORTED
  • REL_DUE_TO_PDUTYPE_NOT_SUPPORTED
  • REL_DUE_TO_SSC_NOT_SUPPORTED
  • REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE
  • REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE_DNN
  • REL_DUE_TO_DNN_CONGESTION
  • REL_DUE_TO_S_NSSAI_CONGESTION
  • REL_DUE_TO_PEER_NOT_RESPONDING
  • REL_DUE_TO_NETWORK_FAILURE
  • REL_DUE_TO_UPF_NOT_RESPONDING
  • REL_DUE_TO_NO_EPS_5GS_CONTINUITY
  • REL_DUE_TO_NOT_SUPPORTED_WITH_ISMF
  • REL_DUE_TO_EXCEEDED_UE_SLICE_DATA_RATE
  • REL_DUE_TO_EXCEEDED_SLICE_DATA_RATE
  • REL_DUE_TO_CONTEXT_NOT_FOUND
  • REL_DUE_TO_MBSR_NOT_AUTHORIZED
  • DEACT_DUE_TO_UE_OUT_OF_SLICE_SUPPORT_AREA
  • REJECT_DUE_TO_N1_SM_ERROR
  • REL_DUE_TO_DUPLICATE_SESSION_EPDG
object (NgApCause)

Represents the NGAP cause.

5gMmCauseValue
integer (Uinteger) >= 0

Unsigned Integer, i.e. only value 0 and integers above 0 are permissible.

object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

object or null (TraceData)

contains Trace control and configuration parameters.

string or string (EpsInterworkingIndication)

EPS Interworking Indication. Possible values are

  • NONE
  • WITH_N26
  • WITHOUT_N26
  • IWK_NON_3GPP
anTypeCanBeChanged
boolean
Default: false
object (RefToBinaryData)

This parameter provides information about the referenced binary body data.

string or string (N2SmInfoType)

N2 SM Information Type. Possible values are

  • PDU_RES_SETUP_REQ
  • PDU_RES_SETUP_RSP
  • PDU_RES_SETUP_FAIL
  • PDU_RES_REL_CMD
  • PDU_RES_REL_RSP
  • PDU_RES_MOD_REQ
  • PDU_RES_MOD_RSP
  • PDU_RES_MOD_FAIL
  • PDU_RES_NTY
  • PDU_RES_NTY_REL
  • PDU_RES_MOD_IND
  • PDU_RES_MOD_CFM
  • PATH_SWITCH_REQ
  • PATH_SWITCH_SETUP_FAIL
  • PATH_SWITCH_REQ_ACK
  • PATH_SWITCH_REQ_FAIL
  • HANDOVER_REQUIRED
  • HANDOVER_CMD
  • HANDOVER_PREP_FAIL
  • HANDOVER_REQ_ACK
  • HANDOVER_RES_ALLOC_FAIL
  • SECONDARY_RAT_USAGE
  • PDU_RES_MOD_IND_FAIL
  • UE_CONTEXT_RESUME_REQ
  • UE_CONTEXT_RESUME_RSP
  • UE_CONTEXT_SUSPEND_REQ
string or string (MaReleaseIndication)

Multi-Access PDU session release Indication. Possible values are

  • REL_MAPDU_OVER_3GPP
  • REL_MAPDU_OVER_N3GPP
maNwUpgradeInd
boolean
Default: false
maRequestInd
boolean
Default: false
n3gPathSwitchExecutionInd
boolean
Value: true
object (ExemptionInd)

Exemption Indication

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

object (MoExpDataCounter)

Contain the MO Exception Data Counter.

extendedNasSmTimerInd
boolean
forwardingFTeid
string <byte> (Bytes)

string with format 'bytes' as defined in OpenAPI

forwardingBearerContexts
Array of strings <byte> (ForwardingBearerContainer) non-empty [ items <byte > ]
object (DdnFailureSubs)

DDN Failure Subscription

skipN2PduSessionResRelInd
boolean
Default: false
secondaryRatUsageDataReportContainer
Array of strings <byte> (SecondaryRatUsageDataReportContainer) non-empty [ items <byte > ]
smPolicyNotifyInd
boolean
Value: true
object or null (PcfUeCallbackInfo)

Contains the PCF for the UE information necessary for the PCF for the PDU session to send SM Policy Association Establishment and Termination events.

string or string (SatelliteBackhaulCategory)

Indicates the satellite backhaul used.

cnBasedMt
boolean
Value: true
geoSatelliteId
string (GeoSatelliteId)

A string carrying the GEO Satellite ID.

object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

nsReplTerminInd
boolean
Value: true
sliceAreaRestrictInd
boolean
object (UeLevelMeasurementsConfiguration)

5GC UE Level Measurements configuration.

Responses

Request samples

Content type
{
  • "pei": "string",
  • "servingNfId": "cdbb088e-1f01-42ba-886e-860ef2e169e6",
  • "guami": {
    },
  • "servingNetwork": {
    },
  • "backupAmfInfo": [
    ],
  • "anType": "3GPP_ACCESS",
  • "additionalAnType": "3GPP_ACCESS",
  • "anTypeToReactivate": "3GPP_ACCESS",
  • "anTypeOfN1N2Info": "3GPP_ACCESS",
  • "ratType": "NR",
  • "presenceInLadn": "IN_AREA",
  • "ueLocation": {
    },
  • "ueTimeZone": "-08:00+1",
  • "addUeLocation": {
    },
  • "upCnxState": "ACTIVATED",
  • "hoState": "NONE",
  • "toBeSwitched": false,
  • "failedToBeSwitched": true,
  • "n1SmMsg": {
    },
  • "n2SmInfo": {
    },
  • "n2SmInfoType": "PDU_RES_SETUP_REQ",
  • "targetId": {
    },
  • "targetServingNfId": "df019fb8-07c2-49f8-b548-1c531adac771",
  • "smContextStatusUri": "string",
  • "dataForwarding": false,
  • "n9ForwardingTunnel": {
    },
  • "n9DlForwardingTnlList": [
    ],
  • "n9UlForwardingTnlList": [
    ],
  • "n9DlForwardingTunnel": {
    },
  • "n9InactivityTimer": 0,
  • "epsBearerSetup": [
    ],
  • "revokeEbiList": [
    ],
  • "release": false,
  • "cause": "REL_DUE_TO_HO",
  • "ngApCause": {
    },
  • "5gMmCauseValue": 0,
  • "sNssai": {
    },
  • "traceData": {
    },
  • "epsInterworkingInd": "NONE",
  • "anTypeCanBeChanged": false,
  • "n2SmInfoExt1": {
    },
  • "n2SmInfoTypeExt1": "PDU_RES_SETUP_REQ",
  • "maReleaseInd": "REL_MAPDU_OVER_3GPP",
  • "maNwUpgradeInd": false,
  • "maRequestInd": false,
  • "n3gPathSwitchExecutionInd": true,
  • "exemptionInd": {
    },
  • "supportedFeatures": "string",
  • "moExpDataCounter": {
    },
  • "extendedNasSmTimerInd": true,
  • "forwardingFTeid": "string",
  • "forwardingBearerContexts": [
    ],
  • "ddnFailureSubs": {
    },
  • "skipN2PduSessionResRelInd": false,
  • "secondaryRatUsageDataReportContainer": [
    ],
  • "smPolicyNotifyInd": true,
  • "pcfUeCallbackInfo": {
    },
  • "satelliteBackhaulCat": "GEO",
  • "cnBasedMt": true,
  • "geoSatelliteId": "string",
  • "altSnssai": {
    },
  • "altHplmnSnssai": {
    },
  • "nsReplTerminInd": true,
  • "sliceAreaRestrictInd": true,
  • "ueLevelMeasConfig": {
    }
}

Response samples

Content type
{
  • "upCnxState": "ACTIVATED",
  • "hoState": "NONE",
  • "releaseEbiList": [
    ],
  • "allocatedEbiList": [
    ],
  • "modifiedEbiList": [
    ],
  • "n1SmMsg": {
    },
  • "n2SmInfo": {
    },
  • "n2SmInfoType": "PDU_RES_SETUP_REQ",
  • "epsBearerSetup": [
    ],
  • "dataForwarding": true,
  • "n3DlForwardingTnlList": [
    ],
  • "n3UlForwardingTnlList": [
    ],
  • "n9UlForwardingTunnel": {
    },
  • "cause": "REL_DUE_TO_HO",
  • "maAcceptedInd": false,
  • "supportedFeatures": "string",
  • "forwardingFTeid": "string",
  • "forwardingBearerContexts": [
    ],
  • "selectedSmfId": "f3ac1967-fd31-4624-b3e9-1fb6917abbb2",
  • "selectedOldSmfId": "6eb48d41-515c-4edc-8db3-6c151ffedda2",
  • "interPlmnApiRoot": "string",
  • "anchorSmfFeatures": {
    },
  • "pduSessionPrio": 0
}

Release SM Context

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
smContextRef
required
string

SM context reference

Request Body schema:
optional

representation of the data to be sent to the SMF when releasing the SM context

string or string (Cause)

Cause information. Possible values are

  • REL_DUE_TO_HO
  • EPS_FALLBACK
  • REL_DUE_TO_UP_SEC
  • DNN_CONGESTION
  • S_NSSAI_CONGESTION
  • REL_DUE_TO_REACTIVATION
  • 5G_AN_NOT_RESPONDING
  • REL_DUE_TO_SLICE_NOT_AVAILABLE
  • REL_DUE_TO_DUPLICATE_SESSION_ID
  • PDU_SESSION_STATUS_MISMATCH
  • HO_FAILURE
  • INSUFFICIENT_UP_RESOURCES
  • PDU_SESSION_HANDED_OVER
  • PDU_SESSION_RESUMED
  • CN_ASSISTED_RAN_PARAMETER_TUNING
  • ISMF_CONTEXT_TRANSFER
  • SMF_CONTEXT_TRANSFER
  • REL_DUE_TO_PS_TO_CS_HO
  • REL_DUE_TO_SUBSCRIPTION_CHANGE
  • HO_CANCEL
  • REL_DUE_TO_SLICE_NOT_AUTHORIZED
  • PDU_SESSION_HAND_OVER_FAILURE
  • DDN_FAILURE_STATUS
  • REL_DUE_TO_CP_ONLY_NOT_APPLICABLE
  • NOT_SUPPORTED_WITH_ISMF
  • CHANGED_ANCHOR_SMF
  • CHANGED_INTERMEDIATE_SMF
  • TARGET_DNAI_NOTIFICATION
  • REL_DUE_TO_VPLMN_QOS_FAILURE
  • REL_DUE_TO_SMF_NOT_SUPPORT_PSETR
  • REL_DUE_TO_SNPN_SNPN_MOBILITY
  • REL_DUE_TO_NO_HR_AGREEMENT
  • REL_DUE_TO_UNSPECIFIED_REASON
  • REL_DUE_TO_MOB_ACCESS_RESTRICTIONS
  • REL_DUE_TO_SLICE_INACTIVITY
  • REL_DUE_TO_NSI_NOT_AVAILABLE
  • REL_DUE_TO_DNN_DENIED
  • REL_DUE_TO_PDUTYPE_DENIED
  • REL_DUE_TO_SSC_DENIED
  • REL_DUE_TO_SUBSCRIPTION_DENIED
  • REL_DUE_TO_DNN_NOT_SUPPORTED
  • REL_DUE_TO_PDUTYPE_NOT_SUPPORTED
  • REL_DUE_TO_SSC_NOT_SUPPORTED
  • REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE
  • REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE_DNN
  • REL_DUE_TO_DNN_CONGESTION
  • REL_DUE_TO_S_NSSAI_CONGESTION
  • REL_DUE_TO_PEER_NOT_RESPONDING
  • REL_DUE_TO_NETWORK_FAILURE
  • REL_DUE_TO_UPF_NOT_RESPONDING
  • REL_DUE_TO_NO_EPS_5GS_CONTINUITY
  • REL_DUE_TO_NOT_SUPPORTED_WITH_ISMF
  • REL_DUE_TO_EXCEEDED_UE_SLICE_DATA_RATE
  • REL_DUE_TO_EXCEEDED_SLICE_DATA_RATE
  • REL_DUE_TO_CONTEXT_NOT_FOUND
  • REL_DUE_TO_MBSR_NOT_AUTHORIZED
  • DEACT_DUE_TO_UE_OUT_OF_SLICE_SUPPORT_AREA
  • REJECT_DUE_TO_N1_SM_ERROR
  • REL_DUE_TO_DUPLICATE_SESSION_EPDG
object (NgApCause)

Represents the NGAP cause.

5gMmCauseValue
integer (Uinteger) >= 0

Unsigned Integer, i.e. only value 0 and integers above 0 are permissible.

object (UserLocation)

At least one of eutraLocation, nrLocation and n3gaLocation shall be present. Several of them may be present.

ueTimeZone
string (TimeZone)

String with format "time-numoffset" optionally appended by "daylightSavingTime", where

  • "time-numoffset" shall represent the time zone adjusted for daylight saving time and be encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339;
  • "daylightSavingTime" shall represent the adjustment that has been made and shall be encoded as "+1" or "+2" for a +1 or +2 hours adjustment.

The example is for 8 hours behind UTC, +1 hour adjustment for Daylight Saving Time.

object (UserLocation)

At least one of eutraLocation, nrLocation and n3gaLocation shall be present. Several of them may be present.

vsmfReleaseOnly
boolean
Default: false
object (RefToBinaryData)

This parameter provides information about the referenced binary body data.

string or string (N2SmInfoType)

N2 SM Information Type. Possible values are

  • PDU_RES_SETUP_REQ
  • PDU_RES_SETUP_RSP
  • PDU_RES_SETUP_FAIL
  • PDU_RES_REL_CMD
  • PDU_RES_REL_RSP
  • PDU_RES_MOD_REQ
  • PDU_RES_MOD_RSP
  • PDU_RES_MOD_FAIL
  • PDU_RES_NTY
  • PDU_RES_NTY_REL
  • PDU_RES_MOD_IND
  • PDU_RES_MOD_CFM
  • PATH_SWITCH_REQ
  • PATH_SWITCH_SETUP_FAIL
  • PATH_SWITCH_REQ_ACK
  • PATH_SWITCH_REQ_FAIL
  • HANDOVER_REQUIRED
  • HANDOVER_CMD
  • HANDOVER_PREP_FAIL
  • HANDOVER_REQ_ACK
  • HANDOVER_RES_ALLOC_FAIL
  • SECONDARY_RAT_USAGE
  • PDU_RES_MOD_IND_FAIL
  • UE_CONTEXT_RESUME_REQ
  • UE_CONTEXT_RESUME_RSP
  • UE_CONTEXT_SUSPEND_REQ
ismfReleaseOnly
boolean
Default: false

Responses

Request samples

Content type
{
  • "cause": "REL_DUE_TO_HO",
  • "ngApCause": {
    },
  • "5gMmCauseValue": 0,
  • "ueLocation": {
    },
  • "ueTimeZone": "-08:00+1",
  • "addUeLocation": {
    },
  • "vsmfReleaseOnly": false,
  • "n2SmInfo": {
    },
  • "n2SmInfoType": "PDU_RES_SETUP_REQ",
  • "ismfReleaseOnly": false
}

Response samples

Content type
application/json
{
  • "smallDataRateStatus": {
    },
  • "apnRateStatus": {
    }
}

Send MO Data

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
smContextRef
required
string

SM context reference

Request Body schema: multipart/related
required

representation of the content of Send MO Data Request

object (SendMoDataReqData)

Data within Send MO Data Request

binaryMoData
string <binary>

Responses

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}

PDU sessions collection

Create

Authorizations:
NoneoAuth2ClientCredentials
Request Body schema:
required

representation of the PDU session to be created in the H-SMF or SMF

One of
supi
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It shall be formatted as follows

  • for an IMSI "imsi-", where shall be formatted according to clause 2.2 of 3GPP TS 23.003 that describes an IMSI.
  • for a network specific identifier "nai-, where shall be formatted according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI.
  • for a GCI "gci-", where shall be formatted according to clause 28.15.2 of 3GPP TS 23.003.
  • for a GLI "gli-", where shall be formatted according to clause 28.16.2 of 3GPP TS 23.003.To enable that the value is used as part of an URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501.
unauthenticatedSupi
boolean
Default: false
pei
string (Pei) ^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a...

String representing a Permanent Equipment Identifier that may contain - an IMEI or IMEISV, as specified in clause 6.2 of 3GPP TS 23.003; a MAC address for a 5G-RG or FN-RG via wireline access, with an indication that this address cannot be trusted for regulatory purpose if this address cannot be used as an Equipment Identifier of the FN-RG, as specified in clause 4.7.7 of 3GPP TS23.316. Examples are imei-012345678901234 or imeisv-0123456789012345.

pduSessionId
integer (PduSessionId) [ 0 .. 255 ]

Unsigned integer identifying a PDU session, within the range 0 to 255, as specified in clause 11.2.3.1b, bits 1 to 8, of 3GPP TS 24.007. If the PDU Session ID is allocated by the Core Network for UEs not supporting N1 mode, reserved range 64 to 95 is used. PDU Session ID within the reserved range is only visible in the Core Network.

dnn
required
string (Dnn)

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; it shall contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. It shall be coded as string in which the labels are separated by dots (e.g. "Label1.Label2.Label3").

selectedDnn
string (Dnn)

String representing a Data Network as defined in clause 9A of 3GPP TS 23.003; it shall contain either a DNN Network Identifier, or a full DNN with both the Network Identifier and Operator Identifier, as specified in 3GPP TS 23.003 clause 9.1.1 and 9.1.2. It shall be coded as string in which the labels are separated by dots (e.g. "Label1.Label2.Label3").

object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

vsmfId
required
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

ismfId
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

required
object (PlmnIdNid)

Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.

string or string (RequestType)

Request Type in Create (SM context) service operation. Possible values are

  • INITIAL_REQUEST
  • EXISTING_PDU_SESSION
  • INITIAL_EMERGENCY_REQUEST
  • EXISTING_EMERGENCY_PDU_SESSION
epsBearerId
Array of integers (EpsBearerId) non-empty [ items [ 0 .. 15 ] ]
pgwS8cFteid
string <byte> (Bytes)

string with format 'bytes' as defined in OpenAPI

vsmfPduSessionUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

ismfPduSessionUri
string (Uri)

String providing an URI formatted according to RFC 3986.

object (TunnelInfo)

Tunnel Information

object (TunnelInfo)

Tunnel Information

object (TunnelInfo)

Tunnel Information

object (TunnelInfo)

Tunnel Information

anType
required
string (AccessType)
Enum: "3GPP_ACCESS" "NON_3GPP_ACCESS"

Indicates whether the access is via 3GPP or via non-3GPP.

additionalAnType
string (AccessType)
Enum: "3GPP_ACCESS" "NON_3GPP_ACCESS"

Indicates whether the access is via 3GPP or via non-3GPP.

string or string (RatType)

Indicates the radio access used.

object (UserLocation)

At least one of eutraLocation, nrLocation and n3gaLocation shall be present. Several of them may be present.

ueTimeZone
string (TimeZone)

String with format "time-numoffset" optionally appended by "daylightSavingTime", where

  • "time-numoffset" shall represent the time zone adjusted for daylight saving time and be encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339;
  • "daylightSavingTime" shall represent the adjustment that has been made and shall be encoded as "+1" or "+2" for a +1 or +2 hours adjustment.

The example is for 8 hours behind UTC, +1 hour adjustment for Daylight Saving Time.

object (UserLocation)

At least one of eutraLocation, nrLocation and n3gaLocation shall be present. Several of them may be present.

gpsi
string (Gpsi) ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$

String identifying a Gpsi shall contain either an External Id or an MSISDN. It shall be formatted as follows -External Identifier= "extid-'extid', where 'extid' shall be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an External Identifier.

object (RefToBinaryData)

This parameter provides information about the referenced binary body data.

object (RefToBinaryData)

This parameter provides information about the referenced binary body data.

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

hPcfId
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

pcfId
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

pcfGroupId
string (NfGroupId)

Identifier of a group of NFs.

pcfSetId
string (NfSetId)

NF Set Identifier (see clause 28.12 of 3GPP TS 23.003), formatted as the following string "set.set.5gc.mnc.mcc", or "set.set.5gc.nid.mnc.mcc" with encoded as defined in clause 5.4.2 ("Mcc" data type definition) encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit shall be inserted at the left side to fill the 3 digits coding of MNC. Pattern: '^[0-9]{3}$' encoded as a value defined in Table 6.1.6.3.3-1 of 3GPP TS 29.510 but with lower case characters encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end with either an alphabetic character or a digit.

hoPreparationIndication
boolean
string or string (DnnSelectionMode)

DNN Selection Mode. Possible values are

  • VERIFIED
  • UE_DNN_NOT_VERIFIED
  • NW_DNN_NOT_VERIFIED
alwaysOnRequested
boolean
Default: false
udmGroupId
string (NfGroupId)

Identifier of a group of NFs.

routingIndicator
string
hNwPubKeyId
integer
string or string (EpsInterworkingIndication)

EPS Interworking Indication. Possible values are

  • NONE
  • WITH_N26
  • WITHOUT_N26
  • IWK_NON_3GPP
vSmfServiceInstanceId
string
iSmfServiceInstanceId
string
recoveryTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

object (RoamingChargingProfile)
chargingId
string^(0|([1-9]{1}[0-9]{0,9}))$
smfChargingId
string (SmfChargingId) ^(0|([1-9]{1}[0-9]{0,9}))\.smf-([0-9a-f]{8}-[...

String based Charging ID

oldPduSessionId
integer (PduSessionId) [ 0 .. 255 ]

Unsigned integer identifying a PDU session, within the range 0 to 255, as specified in clause 11.2.3.1b, bits 1 to 8, of 3GPP TS 24.007. If the PDU Session ID is allocated by the Core Network for UEs not supporting N1 mode, reserved range 64 to 95 is used. PDU Session ID within the reserved range is only visible in the Core Network.

epsBearerCtxStatus
string (EpsBearerContextStatus) ^[A-Fa-f0-9]{4}$

EPS bearer context status

amfNfId
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

object (Guami)

Globally Unique AMF Identifier constructed out of PLMN, Network and AMF identity.

string or string (MaxIntegrityProtectedDataRate)

Maximum Integrity Protected Data Rate. Possible values are

  • 64_KBPS
  • MAX_UE_RATE
string or string (MaxIntegrityProtectedDataRate)

Maximum Integrity Protected Data Rate. Possible values are

  • 64_KBPS
  • MAX_UE_RATE
cpCiotEnabled
boolean
Default: false
cpOnlyInd
boolean
Default: false
invokeNef
boolean
Default: false
maRequestInd
boolean
Default: false
maNwUpgradeInd
boolean
Default: false
dnaiList
Array of strings (Dnai) non-empty
string or string (PresenceState)

Possible values are: -IN_AREA: Indicates that the UE is inside or enters the presence reporting area. -OUT_OF_AREA: Indicates that the UE is outside or leaves the presence reporting area -UNKNOW: Indicates it is unknown whether the UE is in the presence reporting area or not -INACTIVE: Indicates that the presence reporting area is inactive in the serving node.

Array of objects (SecondaryRatUsageInfo) non-empty
object (SmallDataRateStatus)

It indicates theSmall Data Rate Control Status

object (ApnRateStatus)

Contains the APN rate control status e.g. of the AMF.

dlServingPlmnRateCtl
integer >= 10
object (UpSecurityInfo)

User Plane Security Information

object (VplmnQos)

VPLMN QoS

oldSmContextRef
string (Uri)

String providing an URI formatted according to RFC 3986.

object (RedundantPduSessionInformation)

Redundant PDU Session Information

oldPduSessionRef
string (Uri)

String providing an URI formatted according to RFC 3986.

smPolicyNotifyInd
boolean
Default: false
object or null (PcfUeCallbackInfo)

Contains the PCF for the UE information necessary for the PCF for the PDU session to send SM Policy Association Establishment and Termination events.

string or string (SatelliteBackhaulCategory)

Indicates the satellite backhaul used.

upipSupported
boolean
Default: false
string or string (UpCnxState)

User Plane Connection State. Possible values are

  • ACTIVATED
  • DEACTIVATED
  • ACTIVATING
  • SUSPENDED
disasterRoamingInd
boolean
Default: false
object (HrsboInfoFromVplmn)

HR-SBO Information in request message

Array of objects or null (EcsAddrConfigInfo) non-empty
pduSetSupportInd
boolean
Default: false
Array of objects (EcnMarkingCongestionInfoStatus) non-empty

Responses

Callbacks

Request samples

Content type
{
  • "supi": "string",
  • "unauthenticatedSupi": false,
  • "pei": "string",
  • "pduSessionId": 255,
  • "dnn": "string",
  • "selectedDnn": "string",
  • "sNssai": {
    },
  • "altSnssai": {
    },
  • "hplmnSnssai": {
    },
  • "vsmfId": "74865a7f-7204-4a2f-8678-d1ce53fec80e",
  • "ismfId": "038dbe02-9801-4c4d-baa0-32c2503a4944",
  • "servingNetwork": {
    },
  • "requestType": "INITIAL_REQUEST",
  • "epsBearerId": [
    ],
  • "pgwS8cFteid": "string",
  • "vsmfPduSessionUri": "string",
  • "ismfPduSessionUri": "string",
  • "vcnTunnelInfo": {
    },
  • "icnTunnelInfo": {
    },
  • "n9ForwardingTunnelInfo": {
    },
  • "additionalCnTunnelInfo": {
    },
  • "anType": "3GPP_ACCESS",
  • "additionalAnType": "3GPP_ACCESS",
  • "ratType": "NR",
  • "ueLocation": {
    },
  • "ueTimeZone": "-08:00+1",
  • "addUeLocation": {
    },
  • "gpsi": "string",
  • "n1SmInfoFromUe": {
    },
  • "unknownN1SmInfo": {
    },
  • "supportedFeatures": "string",
  • "hPcfId": "fd71b195-7798-4329-9555-9168796ac926",
  • "pcfId": "37aeb506-fedd-4cde-8b21-8857970284a5",
  • "pcfGroupId": "string",
  • "pcfSetId": "string",
  • "hoPreparationIndication": true,
  • "selMode": "VERIFIED",
  • "alwaysOnRequested": false,
  • "udmGroupId": "string",
  • "routingIndicator": "string",
  • "hNwPubKeyId": 0,
  • "epsInterworkingInd": "NONE",
  • "vSmfServiceInstanceId": "string",
  • "iSmfServiceInstanceId": "string",
  • "recoveryTime": "2019-08-24T14:15:22Z",
  • "roamingChargingProfile": {
    },
  • "chargingId": "string",
  • "smfChargingId": "string",
  • "oldPduSessionId": 255,
  • "epsBearerCtxStatus": "string",
  • "amfNfId": "3a982866-cc83-460f-b0e6-b09c81b1a812",
  • "guami": {
    },
  • "maxIntegrityProtectedDataRateUl": "64_KBPS",
  • "maxIntegrityProtectedDataRateDl": "64_KBPS",
  • "cpCiotEnabled": false,
  • "cpOnlyInd": false,
  • "invokeNef": false,
  • "maRequestInd": false,
  • "maNwUpgradeInd": false,
  • "dnaiList": [
    ],
  • "presenceInLadn": "IN_AREA",
  • "secondaryRatUsageInfo": [
    ],
  • "smallDataRateStatus": {
    },
  • "apnRateStatus": {
    },
  • "dlServingPlmnRateCtl": 10,
  • "upSecurityInfo": {
    },
  • "vplmnQos": {
    },
  • "oldSmContextRef": "string",
  • "redundantPduSessionInfo": {
    },
  • "oldPduSessionRef": "string",
  • "smPolicyNotifyInd": false,
  • "pcfUeCallbackInfo": {
    },
  • "satelliteBackhaulCat": "GEO",
  • "upipSupported": false,
  • "upCnxState": "ACTIVATED",
  • "disasterRoamingInd": false,
  • "hrsboInfo": {
    },
  • "ecsAddrConfigInfos": [
    ],
  • "pduSetSupportInd": false,
  • "ecnMarkingCongestionInfoStatus": [
    ]
}

Response samples

Content type
{
  • "pduSessionType": "IPV4",
  • "sscMode": "string",
  • "hcnTunnelInfo": {
    },
  • "cnTunnelInfo": {
    },
  • "additionalCnTunnelInfo": {
    },
  • "sessionAmbr": {
    },
  • "qosFlowsSetupList": [
    ],
  • "hSmfInstanceId": "749a0905-1eeb-4e18-846e-4e180ed8928e",
  • "smfInstanceId": "881bd0af-715f-4bf9-a1cf-de5ece768908",
  • "pduSessionId": 255,
  • "sNssai": {
    },
  • "additionalSnssai": {
    },
  • "enablePauseCharging": false,
  • "ueIpv4Address": "198.51.100.1",
  • "ueIpv6Prefix": "2001:db8:abcd:12::0/64",
  • "n1SmInfoToUe": {
    },
  • "epsPdnCnxInfo": {
    },
  • "epsBearerInfo": [
    ],
  • "supportedFeatures": "string",
  • "maxIntegrityProtectedDataRate": "64_KBPS",
  • "maxIntegrityProtectedDataRateDl": "64_KBPS",
  • "alwaysOnGranted": false,
  • "gpsi": "string",
  • "upSecurity": {
    },
  • "roamingChargingProfile": {
    },
  • "hSmfServiceInstanceId": "string",
  • "smfServiceInstanceId": "string",
  • "recoveryTime": "2019-08-24T14:15:22Z",
  • "dnaiList": [
    ],
  • "ipv6MultiHomingInd": false,
  • "maAcceptedInd": false,
  • "homeProvidedChargingId": "string",
  • "homeProvidedSmfChargingId": "string",
  • "nefExtBufSupportInd": false,
  • "smallDataRateControlEnabled": false,
  • "ueIpv6InterfaceId": "string",
  • "ipv6Index": 0,
  • "dnAaaAddress": {
    },
  • "redundantPduSessionInfo": {
    },
  • "nspuSupportInd": true,
  • "interPlmnApiRoot": "string",
  • "intraPlmnApiRoot": "string",
  • "udmGroupId": "string",
  • "pcfGroupId": "string",
  • "hrsboInfo": {
    },
  • "pendingUpdateInfoList": [
    ]
}

Callback payload samples

Callback
Content type
application/json
{
  • "statusInfo": {
    },
  • "smallDataRateStatus": {
    },
  • "apnRateStatus": {
    },
  • "targetDnaiInfo": {
    },
  • "oldPduSessionRef": "string",
  • "newSmfId": "6a694a81-da78-4c3b-abe0-7f9893fe70c5",
  • "epsPdnCnxInfo": {
    },
  • "interPlmnApiRoot": "string",
  • "intraPlmnApiRoot": "string"
}

Individual PDU session (H-SMF or SMF)

Update (initiated by V-SMF or I-SMF)

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
pduSessionRef
required
string

PDU session reference

Request Body schema:
required

representation of the updates to apply to the PDU session

required
string or string (RequestIndication)

Request Indication in Update (SM context) service operation. Possible values are

  • UE_REQ_PDU_SES_MOD
  • UE_REQ_PDU_SES_REL
  • PDU_SES_MOB
  • NW_REQ_PDU_SES_AUTH
  • NW_REQ_PDU_SES_MOD
  • NW_REQ_PDU_SES_REL
  • EBI_ASSIGNMENT_REQ
  • REL_DUE_TO_5G_AN_REQUEST
pei
string (Pei) ^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a...

String representing a Permanent Equipment Identifier that may contain - an IMEI or IMEISV, as specified in clause 6.2 of 3GPP TS 23.003; a MAC address for a 5G-RG or FN-RG via wireline access, with an indication that this address cannot be trusted for regulatory purpose if this address cannot be used as an Equipment Identifier of the FN-RG, as specified in clause 4.7.7 of 3GPP TS23.316. Examples are imei-012345678901234 or imeisv-0123456789012345.

object (TunnelInfo)

Tunnel Information

object (TunnelInfo)

Tunnel Information

object (TunnelInfo)

Tunnel Information

object (PlmnIdNid)

Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.

anType
string (AccessType)
Enum: "3GPP_ACCESS" "NON_3GPP_ACCESS"

Indicates whether the access is via 3GPP or via non-3GPP.

additionalAnType
string (AccessType)
Enum: "3GPP_ACCESS" "NON_3GPP_ACCESS"

Indicates whether the access is via 3GPP or via non-3GPP.

string or string (RatType)

Indicates the radio access used.

object (UserLocation)

At least one of eutraLocation, nrLocation and n3gaLocation shall be present. Several of them may be present.

ueTimeZone
string (TimeZone)

String with format "time-numoffset" optionally appended by "daylightSavingTime", where

  • "time-numoffset" shall represent the time zone adjusted for daylight saving time and be encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339;
  • "daylightSavingTime" shall represent the adjustment that has been made and shall be encoded as "+1" or "+2" for a +1 or +2 hours adjustment.

The example is for 8 hours behind UTC, +1 hour adjustment for Daylight Saving Time.

object (UserLocation)

At least one of eutraLocation, nrLocation and n3gaLocation shall be present. Several of them may be present.

pauseCharging
boolean
pti
integer (ProcedureTransactionId) [ 0 .. 255 ]

Procedure Transaction Identifier

object (RefToBinaryData)

This parameter provides information about the referenced binary body data.

object (RefToBinaryData)

This parameter provides information about the referenced binary body data.

Array of objects (QosFlowItem) non-empty
qosFlowsVsmfRejectedList
Array of integers (Qfi) non-empty [ items [ 0 .. 63 ] ]
Array of objects (QosFlowNotifyItem) non-empty
Array of objects (PduSessionNotifyItem) non-empty
epsBearerId
Array of integers (EpsBearerId) >= 0 items [ items [ 0 .. 15 ] ]
hoPreparationIndication
boolean
revokeEbiList
Array of integers (EpsBearerId) non-empty [ items [ 0 .. 15 ] ]
string or string (Cause)

Cause information. Possible values are

  • REL_DUE_TO_HO
  • EPS_FALLBACK
  • REL_DUE_TO_UP_SEC
  • DNN_CONGESTION
  • S_NSSAI_CONGESTION
  • REL_DUE_TO_REACTIVATION
  • 5G_AN_NOT_RESPONDING
  • REL_DUE_TO_SLICE_NOT_AVAILABLE
  • REL_DUE_TO_DUPLICATE_SESSION_ID
  • PDU_SESSION_STATUS_MISMATCH
  • HO_FAILURE
  • INSUFFICIENT_UP_RESOURCES
  • PDU_SESSION_HANDED_OVER
  • PDU_SESSION_RESUMED
  • CN_ASSISTED_RAN_PARAMETER_TUNING
  • ISMF_CONTEXT_TRANSFER
  • SMF_CONTEXT_TRANSFER
  • REL_DUE_TO_PS_TO_CS_HO
  • REL_DUE_TO_SUBSCRIPTION_CHANGE
  • HO_CANCEL
  • REL_DUE_TO_SLICE_NOT_AUTHORIZED
  • PDU_SESSION_HAND_OVER_FAILURE
  • DDN_FAILURE_STATUS
  • REL_DUE_TO_CP_ONLY_NOT_APPLICABLE
  • NOT_SUPPORTED_WITH_ISMF
  • CHANGED_ANCHOR_SMF
  • CHANGED_INTERMEDIATE_SMF
  • TARGET_DNAI_NOTIFICATION
  • REL_DUE_TO_VPLMN_QOS_FAILURE
  • REL_DUE_TO_SMF_NOT_SUPPORT_PSETR
  • REL_DUE_TO_SNPN_SNPN_MOBILITY
  • REL_DUE_TO_NO_HR_AGREEMENT
  • REL_DUE_TO_UNSPECIFIED_REASON
  • REL_DUE_TO_MOB_ACCESS_RESTRICTIONS
  • REL_DUE_TO_SLICE_INACTIVITY
  • REL_DUE_TO_NSI_NOT_AVAILABLE
  • REL_DUE_TO_DNN_DENIED
  • REL_DUE_TO_PDUTYPE_DENIED
  • REL_DUE_TO_SSC_DENIED
  • REL_DUE_TO_SUBSCRIPTION_DENIED
  • REL_DUE_TO_DNN_NOT_SUPPORTED
  • REL_DUE_TO_PDUTYPE_NOT_SUPPORTED
  • REL_DUE_TO_SSC_NOT_SUPPORTED
  • REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE
  • REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE_DNN
  • REL_DUE_TO_DNN_CONGESTION
  • REL_DUE_TO_S_NSSAI_CONGESTION
  • REL_DUE_TO_PEER_NOT_RESPONDING
  • REL_DUE_TO_NETWORK_FAILURE
  • REL_DUE_TO_UPF_NOT_RESPONDING
  • REL_DUE_TO_NO_EPS_5GS_CONTINUITY
  • REL_DUE_TO_NOT_SUPPORTED_WITH_ISMF
  • REL_DUE_TO_EXCEEDED_UE_SLICE_DATA_RATE
  • REL_DUE_TO_EXCEEDED_SLICE_DATA_RATE
  • REL_DUE_TO_CONTEXT_NOT_FOUND
  • REL_DUE_TO_MBSR_NOT_AUTHORIZED
  • DEACT_DUE_TO_UE_OUT_OF_SLICE_SUPPORT_AREA
  • REJECT_DUE_TO_N1_SM_ERROR
  • REL_DUE_TO_DUPLICATE_SESSION_EPDG
object (NgApCause)

Represents the NGAP cause.

5gMmCauseValue
integer (Uinteger) >= 0

Unsigned Integer, i.e. only value 0 and integers above 0 are permissible.

alwaysOnRequested
boolean
Default: false
string or string (EpsInterworkingIndication)

EPS Interworking Indication. Possible values are

  • NONE
  • WITH_N26
  • WITHOUT_N26
  • IWK_NON_3GPP
Array of objects (SecondaryRatUsageReport) non-empty
Array of objects (SecondaryRatUsageInfo) non-empty
anTypeCanBeChanged
boolean
Default: false
string or string (MaReleaseIndication)

Multi-Access PDU session release Indication. Possible values are

  • REL_MAPDU_OVER_3GPP
  • REL_MAPDU_OVER_N3GPP
maNwUpgradeInd
boolean
Default: false
maRequestInd
boolean
Default: false
string or string (UnavailableAccessIndication)

Indicates the access type of a MA PDU session that is unavailable. Possible values are

  • 3GA_UNAVAILABLE
  • N3GA_UNAVAILABLE
Array of objects (PsaInformation) non-empty
object (UlclBpInformation)

UL CL or BP Information

object (N4Information)

N4 Information

object (N4Information)

N4 Information

object (N4Information)

N4 Information

string or string (PresenceState)

Possible values are: -IN_AREA: Indicates that the UE is inside or enters the presence reporting area. -OUT_OF_AREA: Indicates that the UE is outside or leaves the presence reporting area -UNKNOW: Indicates it is unknown whether the UE is in the presence reporting area or not -INACTIVE: Indicates that the presence reporting area is inactive in the serving node.

vsmfPduSessionUri
string (Uri)

String providing an URI formatted according to RFC 3986.

vsmfId
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

vSmfServiceInstanceId
string
ismfPduSessionUri
string (Uri)

String providing an URI formatted according to RFC 3986.

ismfId
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

iSmfServiceInstanceId
string
dlServingPlmnRateCtl
integer or null >= 10
dnaiList
Array of strings (Dnai) non-empty
supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

object (RoamingChargingProfile)
object (MoExpDataCounter)

Contain the MO Exception Data Counter.

object (VplmnQos)

VPLMN QoS

object (SecurityResult)

Security Result

object (UpSecurityInfo)

User Plane Security Information

amfNfId
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

object (Guami)

Globally Unique AMF Identifier constructed out of PLMN, Network and AMF identity.

secondaryRatUsageDataReportContainer
Array of strings <byte> (SecondaryRatUsageDataReportContainer) non-empty [ items <byte > ]
smPolicyNotifyInd
boolean
Value: true
object or null (PcfUeCallbackInfo)

Contains the PCF for the UE information necessary for the PCF for the PDU session to send SM Policy Association Establishment and Termination events.

string or string (SatelliteBackhaulCategory)

Indicates the satellite backhaul used.

string or string (MaxIntegrityProtectedDataRate)

Maximum Integrity Protected Data Rate. Possible values are

  • 64_KBPS
  • MAX_UE_RATE
string or string (MaxIntegrityProtectedDataRate)

Maximum Integrity Protected Data Rate. Possible values are

  • 64_KBPS
  • MAX_UE_RATE
string or string (UpCnxState)

User Plane Connection State. Possible values are

  • ACTIVATED
  • DEACTIVATED
  • ACTIVATING
  • SUSPENDED
Array of objects or null (EcsAddrConfigInfo) non-empty
object (HrsboInfoFromVplmn)

HR-SBO Information in request message

object (Snssai)

When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd".

nsReplTerminInd
boolean
Value: true
disasterRoamingInd
boolean
Value: true
pduSetSupportInd
boolean
Array of objects (EcnMarkingCongestionInfoStatus) non-empty

Responses

Request samples

Content type
{
  • "requestIndication": "UE_REQ_PDU_SES_MOD",
  • "pei": "string",
  • "vcnTunnelInfo": {
    },
  • "icnTunnelInfo": {
    },
  • "additionalCnTunnelInfo": {
    },
  • "servingNetwork": {
    },
  • "anType": "3GPP_ACCESS",
  • "additionalAnType": "3GPP_ACCESS",
  • "ratType": "NR",
  • "ueLocation": {
    },
  • "ueTimeZone": "-08:00+1",
  • "addUeLocation": {
    },
  • "pauseCharging": true,
  • "pti": 255,
  • "n1SmInfoFromUe": {
    },
  • "unknownN1SmInfo": {
    },
  • "qosFlowsRelNotifyList": [
    ],
  • "qosFlowsVsmfRejectedList": [
    ],
  • "qosFlowsNotifyList": [
    ],
  • "NotifyList": [
    ],
  • "epsBearerId": [
    ],
  • "hoPreparationIndication": true,
  • "revokeEbiList": [
    ],
  • "cause": "REL_DUE_TO_HO",
  • "ngApCause": {
    },
  • "5gMmCauseValue": 0,
  • "alwaysOnRequested": false,
  • "epsInterworkingInd": "NONE",
  • "secondaryRatUsageReport": [
    ],
  • "secondaryRatUsageInfo": [
    ],
  • "anTypeCanBeChanged": false,
  • "maReleaseInd": "REL_MAPDU_OVER_3GPP",
  • "maNwUpgradeInd": false,
  • "maRequestInd": false,
  • "unavailableAccessInd": "3GA_UNAVAILABLE",
  • "psaInfo": [
    ],
  • "ulclBpInfo": {
    },
  • "n4Info": {
    },
  • "n4InfoExt1": {
    },
  • "n4InfoExt2": {
    },
  • "presenceInLadn": "IN_AREA",
  • "vsmfPduSessionUri": "string",
  • "vsmfId": "74865a7f-7204-4a2f-8678-d1ce53fec80e",
  • "vSmfServiceInstanceId": "string",
  • "ismfPduSessionUri": "string",
  • "ismfId": "038dbe02-9801-4c4d-baa0-32c2503a4944",
  • "iSmfServiceInstanceId": "string",
  • "dlServingPlmnRateCtl": 10,
  • "dnaiList": [
    ],
  • "supportedFeatures": "string",
  • "roamingChargingProfile": {
    },
  • "moExpDataCounter": {
    },
  • "vplmnQos": {
    },
  • "securityResult": {
    },
  • "upSecurityInfo": {
    },
  • "amfNfId": "3a982866-cc83-460f-b0e6-b09c81b1a812",
  • "guami": {
    },
  • "secondaryRatUsageDataReportContainer": [
    ],
  • "smPolicyNotifyInd": true,
  • "pcfUeCallbackInfo": {
    },
  • "satelliteBackhaulCat": "GEO",
  • "maxIntegrityProtectedDataRateUl": "64_KBPS",
  • "maxIntegrityProtectedDataRateDl": "64_KBPS",
  • "upCnxState": "ACTIVATED",
  • "ecsAddrConfigInfos": [
    ],
  • "hrsboInfo": {
    },
  • "altSnssai": {
    },
  • "nsReplTerminInd": true,
  • "disasterRoamingInd": true,
  • "pduSetSupportInd": true,
  • "ecnMarkingCongestionInfoStatus": [
    ]
}

Response samples

Content type
{
  • "n1SmInfoToUe": {
    },
  • "n4Info": {
    },
  • "n4InfoExt1": {
    },
  • "n4InfoExt2": {
    },
  • "dnaiList": [
    ],
  • "supportedFeatures": "string",
  • "roamingChargingProfile": {
    },
  • "homeProvidedChargingId": "string",
  • "homeProvidedSmfChargingId": "string",
  • "upSecurity": {
    },
  • "maxIntegrityProtectedDataRateUl": "64_KBPS",
  • "maxIntegrityProtectedDataRateDl": "64_KBPS",
  • "ipv6MultiHomingInd": false,
  • "qosFlowsSetupList": [
    ],
  • "sessionAmbr": {
    },
  • "epsPdnCnxInfo": {
    },
  • "epsBearerInfo": [
    ],
  • "pti": 255,
  • "interPlmnApiRoot": "string",
  • "intraPlmnApiRoot": "string",
  • "hrsboInfo": {
    }
}

Release

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
pduSessionRef
required
string

PDU session reference

Request Body schema:
optional

data sent to H-SMF or SMF when releasing the PDU session

string or string (Cause)

Cause information. Possible values are

  • REL_DUE_TO_HO
  • EPS_FALLBACK
  • REL_DUE_TO_UP_SEC
  • DNN_CONGESTION
  • S_NSSAI_CONGESTION
  • REL_DUE_TO_REACTIVATION
  • 5G_AN_NOT_RESPONDING
  • REL_DUE_TO_SLICE_NOT_AVAILABLE
  • REL_DUE_TO_DUPLICATE_SESSION_ID
  • PDU_SESSION_STATUS_MISMATCH
  • HO_FAILURE
  • INSUFFICIENT_UP_RESOURCES
  • PDU_SESSION_HANDED_OVER
  • PDU_SESSION_RESUMED
  • CN_ASSISTED_RAN_PARAMETER_TUNING
  • ISMF_CONTEXT_TRANSFER
  • SMF_CONTEXT_TRANSFER
  • REL_DUE_TO_PS_TO_CS_HO
  • REL_DUE_TO_SUBSCRIPTION_CHANGE
  • HO_CANCEL
  • REL_DUE_TO_SLICE_NOT_AUTHORIZED
  • PDU_SESSION_HAND_OVER_FAILURE
  • DDN_FAILURE_STATUS
  • REL_DUE_TO_CP_ONLY_NOT_APPLICABLE
  • NOT_SUPPORTED_WITH_ISMF
  • CHANGED_ANCHOR_SMF
  • CHANGED_INTERMEDIATE_SMF
  • TARGET_DNAI_NOTIFICATION
  • REL_DUE_TO_VPLMN_QOS_FAILURE
  • REL_DUE_TO_SMF_NOT_SUPPORT_PSETR
  • REL_DUE_TO_SNPN_SNPN_MOBILITY
  • REL_DUE_TO_NO_HR_AGREEMENT
  • REL_DUE_TO_UNSPECIFIED_REASON
  • REL_DUE_TO_MOB_ACCESS_RESTRICTIONS
  • REL_DUE_TO_SLICE_INACTIVITY
  • REL_DUE_TO_NSI_NOT_AVAILABLE
  • REL_DUE_TO_DNN_DENIED
  • REL_DUE_TO_PDUTYPE_DENIED
  • REL_DUE_TO_SSC_DENIED
  • REL_DUE_TO_SUBSCRIPTION_DENIED
  • REL_DUE_TO_DNN_NOT_SUPPORTED
  • REL_DUE_TO_PDUTYPE_NOT_SUPPORTED
  • REL_DUE_TO_SSC_NOT_SUPPORTED
  • REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE
  • REL_DUE_TO_INSUFFICIENT_RESOURCES_SLICE_DNN
  • REL_DUE_TO_DNN_CONGESTION
  • REL_DUE_TO_S_NSSAI_CONGESTION
  • REL_DUE_TO_PEER_NOT_RESPONDING
  • REL_DUE_TO_NETWORK_FAILURE
  • REL_DUE_TO_UPF_NOT_RESPONDING
  • REL_DUE_TO_NO_EPS_5GS_CONTINUITY
  • REL_DUE_TO_NOT_SUPPORTED_WITH_ISMF
  • REL_DUE_TO_EXCEEDED_UE_SLICE_DATA_RATE
  • REL_DUE_TO_EXCEEDED_SLICE_DATA_RATE
  • REL_DUE_TO_CONTEXT_NOT_FOUND
  • REL_DUE_TO_MBSR_NOT_AUTHORIZED
  • DEACT_DUE_TO_UE_OUT_OF_SLICE_SUPPORT_AREA
  • REJECT_DUE_TO_N1_SM_ERROR
  • REL_DUE_TO_DUPLICATE_SESSION_EPDG
object (NgApCause)

Represents the NGAP cause.

5gMmCauseValue
integer (Uinteger) >= 0

Unsigned Integer, i.e. only value 0 and integers above 0 are permissible.

object (UserLocation)

At least one of eutraLocation, nrLocation and n3gaLocation shall be present. Several of them may be present.

ueTimeZone
string (TimeZone)

String with format "time-numoffset" optionally appended by "daylightSavingTime", where

  • "time-numoffset" shall represent the time zone adjusted for daylight saving time and be encoded as time-numoffset as defined in clause 5.6 of IETF RFC 3339;
  • "daylightSavingTime" shall represent the adjustment that has been made and shall be encoded as "+1" or "+2" for a +1 or +2 hours adjustment.

The example is for 8 hours behind UTC, +1 hour adjustment for Daylight Saving Time.

object (UserLocation)

At least one of eutraLocation, nrLocation and n3gaLocation shall be present. Several of them may be present.

Array of objects (SecondaryRatUsageReport) non-empty
Array of objects (SecondaryRatUsageInfo) non-empty
object (N4Information)

N4 Information

object (N4Information)

N4 Information

object (N4Information)

N4 Information

Responses

Request samples

Content type
{
  • "cause": "REL_DUE_TO_HO",
  • "ngApCause": {
    },
  • "5gMmCauseValue": 0,
  • "ueLocation": {
    },
  • "ueTimeZone": "-08:00+1",
  • "addUeLocation": {
    },
  • "secondaryRatUsageReport": [
    ],
  • "secondaryRatUsageInfo": [
    ],
  • "n4Info": {
    },
  • "n4InfoExt1": {
    },
  • "n4InfoExt2": {
    }
}

Response samples

Content type
{
  • "smallDataRateStatus": {
    },
  • "apnRateStatus": {
    },
  • "n4Info": {
    },
  • "n4InfoExt1": {
    },
  • "n4InfoExt2": {
    }
}

Retrieve

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
pduSessionRef
required
string

PDU session reference

Request Body schema: application/json
required

representation of the content of the Retrieve Request

smallDataRateStatusReq
boolean
Default: false
string or string (PduSessionContextType)

Type of PDU Session information. Possible values are

  • AF_COORDINATION_INFO

Responses

Request samples

Content type
application/json
{
  • "smallDataRateStatusReq": false,
  • "pduSessionContextType": "AF_COORDINATION_INFO"
}

Response samples

Content type
application/json
{
  • "smallDataRateStatus": {
    },
  • "afCoordinationInfo": {
    }
}

Transfer MO Data

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
pduSessionRef
required
string

PDU session reference

Request Body schema: multipart/related
required

representation of the content of Transfer MO Data Request

object (TransferMoDataReqData)

Data within Transfer MO Data Request

binaryMoData
string <binary>

Responses

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}