API docs by Redocly

Nsmf_EventExposure (1.3.2)

Download OpenAPI specification:

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

3GPP TS 29.508 V18.9.0; 5G System; Session Management Event Exposure Service.

Subscriptions (Collection)

Create an individual subscription for event notifications from the SMF

Authorizations:
NoneoAuth2ClientCredentials
Request Body schema: application/json
required
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.
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.

anyUeInd
boolean

Any UE indication. This IE shall be present if the event subscription is applicable to any UE. Default value "false" is used, if not present.

groupId
string (GroupId) ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0...

String identifying a group of devices network internal globally unique ID which identifies a set of IMSIs, as specified in clause 19.9 of 3GPP TS 23.003.

pduSeId
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
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".

dnai
string (Dnai)

DNAI (Data network access identifier), see clause 5.6.7 of 3GPP TS 23.501.

ssId
string

SSID that the PDU session is related to.

bssId
string

BSSID that the PDU session is related to.

upfId
string

UPF identity.

nfId
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.

subId
string <SubId> (SubId)

Identifies an Individual SMF Notification Subscription. To enable that the value is used as part of a URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501. In an OpenAPI schema, the format shall be designated as "SubId".

notifId
required
string

Notification Correlation ID assigned by the NF service consumer.

notifUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

altNotifIpv4Addrs
Array of strings (Ipv4Addr) non-empty [ items^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|2... ]

Alternate or backup IPv4 address(es) where to send Notifications.

altNotifIpv6Addrs
Array of strings (Ipv6Addr) non-empty [ items^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((... ]

Alternate or backup IPv6 address(es) where to send Notifications.

altNotifFqdns
Array of strings (Fqdn) non-empty [ items [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?... ]

Alternate or backup FQDN(s) where to send Notifications.

required
Array of objects (EventSubscription) non-empty

Subscribed events

Array of objects (EventNotification) non-empty
ImmeRep
boolean
string or string (NotificationMethod)

Represents the notification methods that can be subscribed.
Possible values are:

  • PERIODIC
  • ONE_TIME
  • ON_EVENT_DETECTION
maxReportNbr
integer (Uinteger) >= 0

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

expiry
string <date-time> (schemas-DateTime)

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

repPeriod
integer (DurationSec)

indicating a time in seconds.

object (Guami)

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

string or string (ServiceName)

Service names known to NRF

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.

sampRatio
integer (SamplingRatio) [ 1 .. 100 ]

Unsigned integer indicating Sampling Ratio (see clauses 4.15.1 of 3GPP TS 23.502), expressed in percent.

Array of strings or strings (PartitioningCriteria) non-empty

Criteria for partitioning the UEs before applying the sampling ratio.

grpRepTime
integer (DurationSec)

indicating a time in seconds.

string or string (NotificationFlag)

Possible values are:

  • ACTIVATE: The event notification is activated.
  • DEACTIVATE: The event notification is deactivated and shall be muted. The available event(s) shall be stored.
  • RETRIEVAL: The event notification shall be sent to the NF service consumer(s), after that, is muted again.
object (MutingExceptionInstructions)

Indicates to an Event producer NF instructions for the subscription and stored events when an exception (e.g. full buffer) occurs at the Event producer NF while the event is muted.

object (MutingNotificationsSettings)

Indicates the Event producer NF settings to the Event consumer NF

defQosSupp
boolean

Indicates whether the NF service consumer requests to receive QoS Flow performance information for the QoS Flow associated with the default QoS rule if there are no measurements available for the provided Application Identifier included in the appIds attribute.

qosMonPending
boolean

Indicates that the reporting will be activated when the measurements are enabled by a PCC rule. It shall always be set to true when present. It may only be provided in the response.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "supi": "string",
  • "gpsi": "string",
  • "anyUeInd": true,
  • "groupId": "string",
  • "pduSeId": 255,
  • "dnn": "string",
  • "snssai": {
    },
  • "dnai": "string",
  • "ssId": "string",
  • "bssId": "string",
  • "upfId": "string",
  • "nfId": "7c5b7ce3-5afd-4cea-83ab-84f87a407e62",
  • "subId": "string",
  • "notifId": "string",
  • "notifUri": "string",
  • "altNotifIpv4Addrs": [
    ],
  • "altNotifIpv6Addrs": [
    ],
  • "altNotifFqdns": [
    ],
  • "eventSubs": [
    ],
  • "eventNotifs": [
    ],
  • "ImmeRep": true,
  • "notifMethod": "PERIODIC",
  • "maxReportNbr": 0,
  • "expiry": "2019-08-24T14:15:22Z",
  • "repPeriod": 0,
  • "guami": {
    },
  • "serviveName": "nnrf-nfm",
  • "supportedFeatures": "string",
  • "sampRatio": 1,
  • "partitionCriteria": [
    ],
  • "grpRepTime": 0,
  • "notifFlag": "ACTIVATE",
  • "notifFlagInstruct": {
    },
  • "mutingSetting": {
    },
  • "defQosSupp": true,
  • "qosMonPending": true
}

Response samples

Content type
application/json
{
  • "supi": "string",
  • "gpsi": "string",
  • "anyUeInd": true,
  • "groupId": "string",
  • "pduSeId": 255,
  • "dnn": "string",
  • "snssai": {
    },
  • "dnai": "string",
  • "ssId": "string",
  • "bssId": "string",
  • "upfId": "string",
  • "nfId": "7c5b7ce3-5afd-4cea-83ab-84f87a407e62",
  • "subId": "string",
  • "notifId": "string",
  • "notifUri": "string",
  • "altNotifIpv4Addrs": [
    ],
  • "altNotifIpv6Addrs": [
    ],
  • "altNotifFqdns": [
    ],
  • "eventSubs": [
    ],
  • "eventNotifs": [
    ],
  • "ImmeRep": true,
  • "notifMethod": "PERIODIC",
  • "maxReportNbr": 0,
  • "expiry": "2019-08-24T14:15:22Z",
  • "repPeriod": 0,
  • "guami": {
    },
  • "serviveName": "nnrf-nfm",
  • "supportedFeatures": "string",
  • "sampRatio": 1,
  • "partitionCriteria": [
    ],
  • "grpRepTime": 0,
  • "notifFlag": "ACTIVATE",
  • "notifFlagInstruct": {
    },
  • "mutingSetting": {
    },
  • "defQosSupp": true,
  • "qosMonPending": true
}

Callback payload samples

Callback
POST: {$request.body#/notifUri}
Content type
application/json
{
  • "notifId": "string",
  • "eventNotifs": [
    ],
  • "ackUri": "string"
}

IndividualSubscription (Document)

Read an individual subscription for event notifications from the SMF

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
subId
required
string

Event Subscription ID

Responses

Response samples

Content type
application/json
{
  • "supi": "string",
  • "gpsi": "string",
  • "anyUeInd": true,
  • "groupId": "string",
  • "pduSeId": 255,
  • "dnn": "string",
  • "snssai": {
    },
  • "dnai": "string",
  • "ssId": "string",
  • "bssId": "string",
  • "upfId": "string",
  • "nfId": "7c5b7ce3-5afd-4cea-83ab-84f87a407e62",
  • "subId": "string",
  • "notifId": "string",
  • "notifUri": "string",
  • "altNotifIpv4Addrs": [
    ],
  • "altNotifIpv6Addrs": [
    ],
  • "altNotifFqdns": [
    ],
  • "eventSubs": [
    ],
  • "eventNotifs": [
    ],
  • "ImmeRep": true,
  • "notifMethod": "PERIODIC",
  • "maxReportNbr": 0,
  • "expiry": "2019-08-24T14:15:22Z",
  • "repPeriod": 0,
  • "guami": {
    },
  • "serviveName": "nnrf-nfm",
  • "supportedFeatures": "string",
  • "sampRatio": 1,
  • "partitionCriteria": [
    ],
  • "grpRepTime": 0,
  • "notifFlag": "ACTIVATE",
  • "notifFlagInstruct": {
    },
  • "mutingSetting": {
    },
  • "defQosSupp": true,
  • "qosMonPending": true
}

Replace an individual subscription for event notifications from the SMF

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
subId
required
string

Event Subscription ID

Request Body schema: application/json
required
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.
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.

anyUeInd
boolean

Any UE indication. This IE shall be present if the event subscription is applicable to any UE. Default value "false" is used, if not present.

groupId
string (GroupId) ^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0...

String identifying a group of devices network internal globally unique ID which identifies a set of IMSIs, as specified in clause 19.9 of 3GPP TS 23.003.

pduSeId
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
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".

dnai
string (Dnai)

DNAI (Data network access identifier), see clause 5.6.7 of 3GPP TS 23.501.

ssId
string

SSID that the PDU session is related to.

bssId
string

BSSID that the PDU session is related to.

upfId
string

UPF identity.

nfId
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.

subId
string <SubId> (SubId)

Identifies an Individual SMF Notification Subscription. To enable that the value is used as part of a URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501. In an OpenAPI schema, the format shall be designated as "SubId".

notifId
required
string

Notification Correlation ID assigned by the NF service consumer.

notifUri
required
string (Uri)

String providing an URI formatted according to RFC 3986.

altNotifIpv4Addrs
Array of strings (Ipv4Addr) non-empty [ items^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|2... ]

Alternate or backup IPv4 address(es) where to send Notifications.

altNotifIpv6Addrs
Array of strings (Ipv6Addr) non-empty [ items^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::((... ]

Alternate or backup IPv6 address(es) where to send Notifications.

altNotifFqdns
Array of strings (Fqdn) non-empty [ items [ 4 .. 253 ] characters ^([0-9A-Za-z]([-0-9A-Za-z]{0,61}[0-9A-Za-z])?... ]

Alternate or backup FQDN(s) where to send Notifications.

required
Array of objects (EventSubscription) non-empty

Subscribed events

Array of objects (EventNotification) non-empty
ImmeRep
boolean
string or string (NotificationMethod)

Represents the notification methods that can be subscribed.
Possible values are:

  • PERIODIC
  • ONE_TIME
  • ON_EVENT_DETECTION
maxReportNbr
integer (Uinteger) >= 0

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

expiry
string <date-time> (schemas-DateTime)

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

repPeriod
integer (DurationSec)

indicating a time in seconds.

object (Guami)

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

string or string (ServiceName)

Service names known to NRF

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.

sampRatio
integer (SamplingRatio) [ 1 .. 100 ]

Unsigned integer indicating Sampling Ratio (see clauses 4.15.1 of 3GPP TS 23.502), expressed in percent.

Array of strings or strings (PartitioningCriteria) non-empty

Criteria for partitioning the UEs before applying the sampling ratio.

grpRepTime
integer (DurationSec)

indicating a time in seconds.

string or string (NotificationFlag)

Possible values are:

  • ACTIVATE: The event notification is activated.
  • DEACTIVATE: The event notification is deactivated and shall be muted. The available event(s) shall be stored.
  • RETRIEVAL: The event notification shall be sent to the NF service consumer(s), after that, is muted again.
object (MutingExceptionInstructions)

Indicates to an Event producer NF instructions for the subscription and stored events when an exception (e.g. full buffer) occurs at the Event producer NF while the event is muted.

object (MutingNotificationsSettings)

Indicates the Event producer NF settings to the Event consumer NF

defQosSupp
boolean

Indicates whether the NF service consumer requests to receive QoS Flow performance information for the QoS Flow associated with the default QoS rule if there are no measurements available for the provided Application Identifier included in the appIds attribute.

qosMonPending
boolean

Indicates that the reporting will be activated when the measurements are enabled by a PCC rule. It shall always be set to true when present. It may only be provided in the response.

Responses

Request samples

Content type
application/json
{
  • "supi": "string",
  • "gpsi": "string",
  • "anyUeInd": true,
  • "groupId": "string",
  • "pduSeId": 255,
  • "dnn": "string",
  • "snssai": {
    },
  • "dnai": "string",
  • "ssId": "string",
  • "bssId": "string",
  • "upfId": "string",
  • "nfId": "7c5b7ce3-5afd-4cea-83ab-84f87a407e62",
  • "subId": "string",
  • "notifId": "string",
  • "notifUri": "string",
  • "altNotifIpv4Addrs": [
    ],
  • "altNotifIpv6Addrs": [
    ],
  • "altNotifFqdns": [
    ],
  • "eventSubs": [
    ],
  • "eventNotifs": [
    ],
  • "ImmeRep": true,
  • "notifMethod": "PERIODIC",
  • "maxReportNbr": 0,
  • "expiry": "2019-08-24T14:15:22Z",
  • "repPeriod": 0,
  • "guami": {
    },
  • "serviveName": "nnrf-nfm",
  • "supportedFeatures": "string",
  • "sampRatio": 1,
  • "partitionCriteria": [
    ],
  • "grpRepTime": 0,
  • "notifFlag": "ACTIVATE",
  • "notifFlagInstruct": {
    },
  • "mutingSetting": {
    },
  • "defQosSupp": true,
  • "qosMonPending": true
}

Response samples

Content type
application/json
{
  • "supi": "string",
  • "gpsi": "string",
  • "anyUeInd": true,
  • "groupId": "string",
  • "pduSeId": 255,
  • "dnn": "string",
  • "snssai": {
    },
  • "dnai": "string",
  • "ssId": "string",
  • "bssId": "string",
  • "upfId": "string",
  • "nfId": "7c5b7ce3-5afd-4cea-83ab-84f87a407e62",
  • "subId": "string",
  • "notifId": "string",
  • "notifUri": "string",
  • "altNotifIpv4Addrs": [
    ],
  • "altNotifIpv6Addrs": [
    ],
  • "altNotifFqdns": [
    ],
  • "eventSubs": [
    ],
  • "eventNotifs": [
    ],
  • "ImmeRep": true,
  • "notifMethod": "PERIODIC",
  • "maxReportNbr": 0,
  • "expiry": "2019-08-24T14:15:22Z",
  • "repPeriod": 0,
  • "guami": {
    },
  • "serviveName": "nnrf-nfm",
  • "supportedFeatures": "string",
  • "sampRatio": 1,
  • "partitionCriteria": [
    ],
  • "grpRepTime": 0,
  • "notifFlag": "ACTIVATE",
  • "notifFlagInstruct": {
    },
  • "mutingSetting": {
    },
  • "defQosSupp": true,
  • "qosMonPending": true
}

Delete an individual subscription for event notifications from the SMF

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
subId
required
string

Event Subscription ID

Responses

Response samples

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