S6t AVPs
S6t (application id: 16777345)
The S6t interface is a key element in the 3GPP architecture for managing Machine-Type Communication (MTC) devices, particularly in the context of the Internet of Things (IoT). S6t interface enables communication between the Service Capability Exposure Function (SCEF) and the Home Subscriber Server (HSS). The primary purpose of the S6t interface is to facilitate the configuration, monitoring, and management of MTC devices by allowing the SCEF to interact with the HSS.
The S6t interface plays a crucial role in scenarios where devices need to be managed remotely without human intervention. It supports various functions such as the configuration of monitoring events, management of communication patterns, and the retrieval of subscription data.
S6t architecture ensures that the SCEF can interact with the HSS to perform several key functions:
- Configuration and Deletion of Monitoring Events: The SCEF uses the S6t interface to configure specific monitoring events for individual UEs or groups of UEs. These events could include changes in device status, such as connectivity or location.
- Configuration and Query of Communication Patterns: The SCEF can manage how and when devices communicate with the network by configuring communication patterns through the S6t interface.
- Translation of Identifiers: The S6t interface supports the translation of external group identifiers into IMSI Group IDs, facilitating the management of device groups based on their identifiers.
- Authorization and Notification for Non-IP Data Delivery (NIDD): The interface allows the SCEF to authorize UEs for NIDD services, ensuring that devices can send and receive data without needing a direct IP connection.
S6t interface workflow:
Configuration of Monitoring Events:
- The SCEF sends a request to the HSS to set up monitoring events for specific UEs or groups of UEs. These events could trigger actions when certain conditions are met, such as a device moving into a new location or a change in connectivity status.
- The HSS processes the request and stores the necessary monitoring configurations.
Reporting of Monitoring Events:
- Once a configured event occurs, the HSS generates a report and sends it back to the SCEF via the S6t interface. This enables real-time monitoring and management of MTC devices.
Management of Communication Patterns:
- The SCEF configures or queries communication patterns through the S6t interface, determining how devices communicate with the network (e.g., setting specific time windows for data transmission).
Translation of Identifiers:
- The SCEF may need to translate an external group identifier into an IMSI Group ID for management purposes. The S6t interface facilitates this translation, allowing the SCEF to effectively manage groups of devices.
Authorization for NIDD:
- For devices using NIDD, the SCEF authorizes their communication through the S6t interface. The HSS confirms the authorization and updates its records accordingly.
For complete technical specification of S6t interface in Diameter protocol please refer to: [3GPP TS 29.336]
package com.mobius.software.telco.protocols.diameter.primitives.s6t
Name |
AVP Code |
Data Type |
Vendor |
Accuracy |
3137 |
Enumerated |
3GPP |
Used to specify the requested location accuracy level for User Equipment (UE) positioning. It defines how precisely the network should determine the UE’s location, based on different granularity levels of mobile network areas. Enumerated Values: 0: CGI-ECGI: Cell Global Identity (CGI) for 2G/3G or Evolved Cell Global Identity (ECGI) for LTE. Provides location accuracy at the cell level. 1: eNB: Identifies the specific eNodeB serving the UE, offering higher accuracy than CGI/ECGI. 2: LA-TA-RA: Location Area (LA), Tracking Area (TA), or Routing Area (RA) level accuracy, which groups multiple cells together. 3: PRA: Public Land Mobile Network (PLMN) Registration Area accuracy, used for broad network-level tracking. 4: PLMN-ID: Indicates that only the Public Land Mobile Network (PLMN) information should be used, providing the lowest granularity of location accuracy. |
|||
Additional-Identifiers |
3173 |
Grouped |
3GPP |
Used to provide additional external group identifiers associated with a subscriber or UE. It enables the inclusion of multiple external identifiers that may be used for group-based network services, authorization, and policy enforcement. The AVP structure is defined as follows: External-Identifier (Optional, Multiple): A unique identifier representing a subscriber group or individual UE in external systems. |
|||
AESE-Communication-Pattern |
3113 |
Grouped |
3GPP |
Used to convey Application Enablement Service Exposure (AESE) communication pattern information from the Service Capability Exposure Function (SCEF) to the Home Subscriber Server (HSS). The AVP structure is defined as follows: SCEF-Reference-ID (Optional): Numeric identifier for the communication pattern. Used if the Extended Reference IDs feature is not supported. SCEF-Reference-ID-Ext (Optional): Extended numeric identifier (larger ID space). Used when Extended Reference IDs are supported by both HSS and SCEF. SCEF-ID (Mandatory): Identifier of the SCEF node that owns the communication pattern. SCEF-Reference-ID-for-Deletion (Optional, Multiple): List of existing communication patterns to be deleted, referenced by legacy IDs. SCEF-Reference-ID-for-Deletion-Ext (Optional, Multiple): List of extended reference IDs to be deleted, used when Extended Reference IDs are supported. Communication-Pattern-Set (Optional, Multiple): Set(s) defining actual communication rules, such as permitted time intervals, message counts, etc. MTC-Provider-Info (Optional): Information about the MTC service provider managing the communication session. Additional AVPs (Optional, Multiple): May be included for vendor-specific extensions or future enhancements. At least one reference ID (either in SCEF-Reference-ID or in SCEF-Reference-ID-Ext) or a reference ID for deletion (either in SCEF-Reference-ID-for-Deletion or in SCEF-Reference-ID-for-Deletion-Ext) shall be present. When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used instead of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively. |
|||
AESE-Communication-Pattern-Config-Status |
3120 |
Grouped |
3GPP |
Reports the outcome of the AESE communication pattern handling from the Home Subscriber Server (HSS). It reports whether the requested communication pattern has been successfully applied, rejected, or modified based on system constraints or errors. The AVP structure is defined as follows: SCEF-Reference-ID (Mandatory, Single): Identifies the communication pattern request being processed. SCEF-Reference-ID-Ext (Optional, Single): Extended version of the SCEF-Reference-ID, supporting larger identifier values. SCEF-ID (Optional, Single): Identifies the SCEF entity responsible for handling the communication pattern. AESE-Error-Report (Optional, Single): Contains details if an error occurred while processing the communication pattern. When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-Ext AVP shall be used instead of SCEF-Reference-ID; in such case, the required AVP "SCEF-Reference-ID" shall be included in the grouped AVP by the sender, but its content shall be discarded by the receiver. |
|||
AESE-Error-Report |
3121 |
Grouped |
3GPP |
Provides detailed information about any errors encountered during the processing of a Communication-Pattern-Set request. It is included in response messages where an AESE-Communication-Pattern operation has failed partially or completely. The AVP structure is defined as follows: Service-Result (Optional, Single): Specifies the outcome status of the requested communication pattern modification. If present, it provides a reason code that explains why the request failed or was only partially applied. |
|||
Allowed-PLMN-List |
3158 |
Grouped |
3GPP |
Contains a list of visited PLMNs (Public Land Mobile Networks) where Enhanced Coverage is permitted. The AVP structure is defined as follows: Visited-PLMN-Id (Optional, Multiple): Lists the PLMN IDs (MCC+MNC) that are allowed for Enhanced Coverage. Absence of Visited-PLMN-Id AVPs indicates that Enhanced Coverage is restricted in all serving PLMNs. |
|||
APN-Validity-Time |
3169 |
Grouped |
3GPP |
Defines the validity period for a granted NIDD (Non-IP Data Delivery) authorization associated with an Access Point Name (APN). The AVP structure is defined as follows: Granted-Validity-Time (Mandatory, Single): Specifies the expiration time for the granted NIDD authorization. If expired, the user must request a new authorization. If present, it defines how long the APN remains valid for NIDD access. Service-Selection (Optional, Single): Identifies the specific APN for which the validity time applies. Absence of Service-Selection AVP indicates that the Granted-Validity-Time applies to all granted NIDD Authorizations for the user. In this case only one APN-Validity-Time AVP shall be present within the NIDD-Authorization-Update AVP. |
|||
Association-Type |
3138 |
Enumerated |
3GPP |
Specifies the type of event related to changes in the IMEI(SV)-IMSI association. This AVP is used to define which changes trigger an event notification. Enumerated Values: 0: IMEI-CHANGE: The event is reported only if the IMEI and IMSI association has changed. If only the Software Version (SV) changes, no event is triggered. 1: IMEISV-CHANGE: The event is reported if IMEI, SV, or both change. This includes cases where only the SV is updated. |
|||
Battery-Indicator |
3185 |
Unsigned32 (Bitmask) |
3GPP |
Contains a bitmask representing the battery characteristics of a User Equipment (UE). Bitmask Definition: 0: NO_BATTERY: Set: UE is not battery-powered. Must clear bits 1 and 2 if set. 1: BATTERY_REPLACEABLE_INDICATION: Set: Battery is replaceable. Not set: Battery is non-replaceable. 2: BATTERY_RECHARGEABLE_INDICATION: Set: Battery is rechargeable. Not set: Battery is non-rechargeable. Notes: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. If bit 0 is set, bit 1 and bit 2 shall be cleared. |
|||
CIA-Flags |
3164 |
Unsigned32 (Bitmask) |
3GPP |
Reports status flags related to Configuration Information Acknowledgement (CIA) procedures, specifically for Group Monitoring configurations in 3GPP Machine-Type Communication (MTC) environments. Bitmask Definition: 0: Group-Configuration-In-Progress: When set, it indicates that the HSS is processing one or more Group Monitoring configurations, and status updates will be sent via the RIR (Reporting Information Request) command. Note: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. |
|||
CIR-Flags |
3145 |
Unsigned32 (Bitmask) |
3GPP |
Used in the Context Information Request (CIR) procedure between the Service Capability Exposure Function (SCEF) and the Home Subscriber Server (HSS) over the S6t interface. Bitmask Definition: 0: Delete all Monitoring Events: When set, instructs the HSS to delete all monitoring events associated with the subscriber. 1: Enhanced Coverage Query: When set, requests the current Enhanced-Coverage-Restriction status/settings from the HSS. 2: IMSI Group ID Retrieval: When set, requests retrieval of the IMSI Group Identifier corresponding to the provided External Group ID. 3: Delete all Communication Pattern: When set, instructs the HSS to delete all stored communication patterns for the subscriber. 4: Delete all Network Parameter Configurations: When set, instructs the HSS to delete all Suggested Network Configuration entries for the subscriber. Note: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. |
|||
Communication-Duration-Time |
3116 |
Unsigned32 |
3GPP |
Specifies the duration (in seconds) of a periodic communication session initiated by a device, such as a UE involved in Machine-Type Communication (MTC) or Internet of Things (IoT) services. |
|||
Communication-Pattern-Set |
3114 |
Grouped |
3GPP |
Used to define a configurable set of rules that determine how a User Equipment (UE) or Machine-Type Communication (MTC) device is allowed to initiate communication with the network. The AVP structure is defined as follows: Periodic-Communication-Indicator (Optional): Indicates whether communication is periodic or event-driven. Communication-Duration-Time (Optional): Duration (in seconds) that the UE is allowed to communicate after being granted access. Only relevant when periodic communication is indicated. Periodic-Time (Optional): Time interval (in seconds) between two successive communication opportunities for the UE. Scheduled-Communication-Time (Optional, Multiple): Defines specific time windows when communication is permitted. Stationary-Indication (Optional): Indicates whether the device is stationary or mobile. Reference-ID-Validity-Time (Optional): Expiration time of the pattern definition. If absent, the communication pattern does not expire. Traffic-Profile (Optional): Describes expected traffic characteristics (e.g., light, medium, heavy). Can be used for QoS and resource planning. Battery-Indicator (Optional): Bitmask describing the battery properties of the UE (e.g., battery-powered, replaceable, rechargeable). Additional AVPs (Optional, Multiple): Reserved for future use or vendor-specific extensions. Communication-Duration-Time and Periodic-Time shall be only provided when the Periodic-Communication-Indicator is set to PERIODICALLY. If the Reference-ID-Validity-Time AVP is absent, it indicates that there is no expiration time defined for the Communication-Pattern-Set. |
|||
Enhanced-Coverage-Restriction |
3155 |
Grouped |
3GPP |
Used to define network-level restrictions or permissions for Enhanced Coverage features such as EC-GSM-IoT, LTE Cat-M1, or NB-IoT. The AVP structure is defined as follows: Restricted-PLMN-List (Optional): A list of serving PLMNs where Enhanced Coverage is restricted for the UE. When present, the device should not use Enhanced Coverage features in any PLMN in this list. Allowed-PLMN-List (Optional): A list of serving PLMNs where Enhanced Coverage is explicitly allowed for the UE. Additional AVPs (Optional, Multiple): Reserved for future use or vendor-specific information. |
|||
Enhanced-Coverage-Restriction-Data |
3156 |
Grouped |
3GPP |
Used to report or provision the current Enhanced Coverage restriction settings along with the identifier of the visited PLMN, if applicable. The AVP structure is defined as follows: Enhanced-Coverage-Restriction (Mandatory): A nested grouped AVP that defines either the PLMNs where Enhanced Coverage is restricted or where it is explicitly allowed. Visited-PLMN-Id (Optional): Identifies the currently visited PLMN of the UE. Additional AVPs (Optional, Multiple): May include vendor-specific extensions or future enhancements. |
|||
EPS-Location-Information |
1496 |
Grouped |
3GPP |
Used to encapsulate location-related information for a User Equipment (UE) registered in the Evolved Packet System (EPS). It provides a comprehensive representation of the UE's current access location, including either MME or SGSN based mobility management context, depending on the UE’s current serving node. The AVP structure is defined as follows: MME-Location-Information (Optional): Contains location data when the UE is served by an MME (for E-UTRAN access). SGSN-Location-Information (Optional): Contains location data when the UE is served by an SGSN (for UTRAN/GERAN access). Additional AVPs (Optional, Multiple): May include vendor-specific location elements or future standard extensions. |
|||
Event-Handling |
3149 |
Enumerated (Unsigned32) |
3GPP |
Specifies the type of event control operation requested for a previously established Monitoring Event Configuration or Communication Pattern. Enumerated Values: 0: SUSPEND: Temporarily suspend the configured event handling or communication pattern. 1: RESUME: Resume a previously suspended event or communication configuration. 2: CANCEL: Fully cancel the event monitoring or communication configuration and remove it. |
|||
Exclude-Identifiers |
3188 |
Grouped |
3GPP |
Used in the context of subscriber group operations to specify individual user identifiers that should be excluded from a bulk operation. The AVP structure is defined as follows: External-Identifier (Optional, Multiple): One or more External Identifiers (e.g., extid@operator.com) corresponding to users who should be excluded from the operation. MSISDN (Optional, Multiple): One or more MSISDNs (E.164 formatted) that identify subscribers to be excluded from the group action. Additional AVPs (Optional, Multiple): May be used for vendor-specific or future extensions. |
|||
Granted-Validity-Time |
3160 |
Time |
3GPP |
Specifies the expiration point of a granted Non-IP Data Delivery (NIDD) Authorization. This AVP indicates the absolute time after which the HSS deletes the stored NIDD authorization and the SCEF must treat the authorization as implicitly revoked. If the AVP carries a timestamp in the past, it explicitly signals that the NIDD authorization has already been revoked. |
|||
Group-Report |
3165 |
Grouped |
3GPP |
Used to convey monitoring or configuration report results for a group of subscribers. It is generated by the Home Subscriber Server (HSS) and sent to the Service Capability Exposure Function (SCEF) in response to Monitoring-Event-Configuration or Suggested-Network-Configuration requests for a group of devices. The AVP structure is defined as follows: SCEF-Reference-ID (Mandatory): A reference identifier used by the SCEF to correlate the group configuration or request. When extended reference ID support is used, this AVP is still included but its value is ignored. SCEF-Reference-ID-Ext (Optional): Extended reference identifier used when the "Extended Reference IDs" feature is supported. Takes precedence over the regular SCEF-Reference-ID. SCEF-ID (Optional): Identifier of the SCEF instance that originally sent the group monitoring or configuration request. Group-Report-Item (Optional, Multiple): A list of individual Group-Report-Item AVPs, each providing detailed results for a specific UE or subset of the group. Additional AVPs (Optional, Multiple): Reserved for vendor-specific extensions or future standard enhancements. |
|||
Group-Reporting-Guard-Timer |
3163 |
Unsigned32 |
3GPP |
Specifies a time interval in seconds after which the Home Subscriber Server (HSS) must send aggregated status indications or event reports for User Equipment (UEs) that are part of a group-based monitoring or configuration session. |
|||
Group-Report-Item |
3166 |
Grouped |
3GPP |
Used to report per-subscriber results within a group-based monitoring or configuration operation. Each instance of Group-Report-Item represents the outcome of Monitoring-Event-Configuration or Suggested-Network-Configuration actions for a specific user, identified by the User-Identifier AVP. The AVP structure is defined as follows: User-Identifier (Mandatory): Identifies the specific subscriber (e.g., by IMSI, MSISDN, External-Identifier). Visited-PLMN-Id (Optional): Indicates the Public Land Mobile Network (PLMN) where the UE is currently located. Roaming-Information (Optional): Indicates whether the UE is currently roaming and under what condition (e.g., not roaming, roaming allowed, etc.). IMEI-Change (Optional): Reports whether the device's IMEI has changed since last recorded. Reachability-Information (Optional): Describes whether the UE is currently reachable or not. Maximum-UE-Availability-Time (Optional): Specifies the maximum time the UE is expected to remain available for communication. EPS-Location-Information (Optional): Provides location-related information relevant to EPS (e.g., cell ID, tracking area). Monitoring-Type (Optional): Indicates which type of monitoring (e.g., location, availability, roaming) was triggered for this report. Service-Report (Optional, Multiple): A list of reports for monitored services (e.g., PDN connectivity, location triggers, etc.). S6t-HSS-Cause (Optional): Encodes cause values set by the HSS in response to the group request. Idle-Status-Indication (Optional): Indicates the idle state of the UE (e.g., connected, idle, unknown). Reporting-Time-Stamp (Optional): Denotes the time at which the report was generated. Updated-Network-Configuration (Optional): Contains network configuration parameters updated for the UE. SCEF-Reference-ID-for-Deletion / SCEF-Reference-ID-for-Deletion-Ext (Optional, Multiple): Identifiers indicating which references are to be deleted, with extended support if enabled. Event-Handling (Optional): Instructs how to treat future events for this UE (e.g., suspend, resume, cancel). Loss-Of-Connectivity-Reason (Optional): If reported, specifies the reason for loss of connectivity (e.g., power off, coverage loss). PDN-Connectivity-Status-Report (Optional, Multiple): Status reports related to Packet Data Network (PDN) connectivity. When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-for-Deletion-Ext AVP shall be used instead of SCEF-Reference-ID-for-Deletion. |
|||
Group-User-Identifier |
3177 |
Grouped |
3GPP |
Used to identify an individual subscriber belonging to a group. It provides one or more identifiers for the user, such as IMSI (User-Name), MSISDN, or External-Identifier. The AVP structure is defined as follows: User-Name (Optional): Represents the IMSI of the user, encoded as a UTF8String. Used when identifying the subscriber by their IMSI (International Mobile Subscriber Identity). MSISDN (Optional): Represents the telephone number of the user in E.164 format, encoded as a TBCD string. External-Identifier (Optional): An identifier used in scenarios where an external ID-based addressing scheme is in use (e.g., IoT/M2M deployments where IMSI or MSISDN may not be known or applicable). Additional AVPs (Optional, Multiple): Reserved for vendor-specific or future extensions. |
|||
IMEI-Change |
3141 |
Unsigned32 (Bitmask) |
3GPP |
Used to indicate whether a change has occurred in the International Mobile Equipment Identity (IMEI) or the IMEI Software Version (IMEISV) of a user device. Only one bit must be set at a time to avoid ambiguity. Bitmask Definitions: Bit 0: IMEI: When set, this bit indicates that the IMEI has changed, regardless of whether the IMEISV has changed. Bit 1: IMEISV: When set, this bit indicates that the IMEI Software Version has changed, while the IMEI itself remains the same. Notes: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. Bits 0 and 1 shall not be set simultaneously. When a change of IMEI(SV) is reported, the new IMEI(SV) values may be reported to the SCEF in the Terminal-Information AVP inside the Monitoring-Event-Report AVP (see 3GPP [TS 29.336] clause 8.4.3). |
|||
Include-Identifiers |
3189 |
Grouped |
3GPP |
Used to specify a list of subscriber identifiers, such as External Identifiers or MSISDNs, that should be included in a Diameter operation. The AVP structure is defined as follows: External-Identifier (Optional, Multiple): A list of externally defined user identifiers, often used in MTC/IoT environments. These identifiers are application-friendly strings, such as URNs or custom-assigned IDs, that uniquely represent a user or device in an operator's domain. MSISDN (Optional, Multiple): A list of telephone numbers assigned to mobile subscribers, formatted in E.164 and encoded using TBCD. Used when traditional telecom numbering is in effect. Additional AVPs (Optional, Multiple): Reserved for future extensions or vendor-specific attributes. |
|||
Location-Information-Configuration |
3135 |
Grouped |
3GPP |
Used to configure the parameters for location reporting in monitoring events, particularly for MTC (Machine-Type Communication) and IoT scenarios supported via the S6t interface. The AVP structure is defined as follows: MONTE-Location-Type (Optional): Indicates the type of location information to be reported, such as cell ID-based, GPS-based, or network-based. The enumeration reflects values defined for Monitoring of Events (MONTE) in 3GPP specifications. It defines the preferred positioning method. Accuracy (Optional): Specifies the desired accuracy level of the reported location. This value is an enumeration indicating the granularity of location data, ranging from coarse (e.g., cell-level) to fine (e.g., GPS-level), depending on the device and network capabilities. Periodic-Time (Optional): Indicates the minimum time interval, in seconds, between consecutive location reports. If included, it enables periodic location reporting from the monitored device or entity. If omitted, only event-triggered reporting is expected. Additional AVPs (Optional, Multiple): Reserved for additional or future AVPs related to location reporting extensions. If present, Periodic-Time contains the minimum periodic location reporting time. |
|||
Loss-Of-Connectivity-Reason |
3162 |
Enumerated |
3GPP |
Identifies the reason why a loss of connectivity event is being reported by the network for a given subscriber, typically in the context of machine-type communications or monitoring configurations managed through the S6t interface. Enumerated Values: UE_DETACHED_MME (0): The UE has been detached by the Mobility Management Entity (MME), terminating the connection from the EPS network side. UE_DETACHED_SGSN (1): The UE has been detached by the Serving GPRS Support Node (SGSN), terminating the connection from the legacy GPRS network side. MAX_DETECTION_TIME_EXPIRED_MME (2): The maximum time configured to detect the UE’s availability has expired in the MME without successful detection. MAX_DETECTION_TIME_EXPIRED_SGSN (3): The SGSN did not detect the UE within the maximum detection time, leading to a timeout. UE_PURGED_MME (4): The UE's context or subscription information was purged from the MME, indicating complete session loss. UE_PURGED_SGSN (5): The UE's context was purged from the SGSN, resulting in loss of communication from the 2G/3G side. |
|||
Maximum-Detection-Time |
3131 |
Unsigned32 |
3GPP |
Specifies the maximum duration (in seconds) that the network is allowed to wait without receiving any communication from a UE before determining that the UE is unreachable. Used by the Home Subscriber Server (HSS) to configure the Subscribed Periodic RAU (Routing Area Update) / TAU (Tracking Area Update) timer, which is enforced by the serving node (e.g., MME or SGSN). |
|||
Maximum-Latency |
3133 |
Unsigned32 |
3GPP |
Specifies the maximum tolerable delay, in seconds, for the delivery of downlink data to the User Equipment (UE). It is used to set the subscribed periodic RAU/TAU timer by the HSS. |
|||
Maximum-Number-of-Reports |
3128 |
Unsigned32 |
3GPP |
Contains the number of reports to be generated and sent to the SCEF. This AVP shall not be present when Monitoring-Type AVP is set to AVAILABILITY_AFTER_DDN_FAILURE (6). This AVP shall not be greater than one if: Monitoring-Type is UE_REACHABILITY (1) and Reachability-Type is "Reachability for SMS" or Monitoring-Type is LOCATION_REPORTING (2) and MONTE-Location-Type is LAST_KNOWN_LOCATION (1). |
|||
Maximum-Response-Time |
3134 |
Unsigned32 |
3GPP |
Specifies the maximum duration in seconds that the User Equipment (UE) is expected to remain reachable for downlink communication. This AVP is used by the HSS (Home Subscriber Server) to configure the Active Time parameter of the UE, which determines how long the UE remains in a responsive state after a trigger event (e.g., paging). |
|||
MME-Location-Information |
1600 |
Grouped |
3GPP |
Provides location-related information relevant to the Mobility Management Entity (MME) for a particular user. This AVP enables location-aware services and supports mobility, authentication, and monitoring procedures by supplying cell and area identifiers, access details, and related metadata. The AVP structure is defined as follows: E-UTRAN-Cell-Global-Identity (Optional): Contains the globally unique identifier for the serving E-UTRAN cell, including MCC, MNC, and cell identity. Tracking-Area-Identity (Optional): Identifies the Tracking Area where the UE is located, composed of the PLMN and Tracking Area Code (TAC). Current-Location-Retrieved (Optional): Indicates whether the current location was just retrieved (CURRENTLY_RETRIEVED) or is based on previously stored data (NOT_CURRENTLY_RETRIEVED). Age-Of-Location-Information (Optional): Time in seconds indicating how long ago the location information was retrieved. User-CSG-Information (Optional): Provides details about Closed Subscriber Group (CSG) membership and access control. eNodeB-ID (Optional): Identifies the eNodeB currently serving the user, typically used in monitoring contexts. Extended-eNodeB-ID (Optional): Enhanced identifier for the eNodeB, used when extended identification is required. |
|||
Monitoring-Duration |
3130 |
Time |
3GPP |
Defines the absolute expiration timestamp for a monitoring event request. This AVP specifies the exact point in time (based on the NTP epoch) at which the monitoring setup is no longer valid and should be considered expired by the receiving entity (typically the HSS). |
|||
Monitoring-Event-Config-Status |
3142 |
Grouped |
3GPP |
Used to report the result of processing a monitoring event configuration request. It contains the outcome details related to a previously issued monitoring action (e.g., UE reachability, location change, etc.) by a Service Capability Exposure Function (SCEF). The AVP structure is defined as follows: Service-Report (Optional, Multiple): Contains the outcome of the monitoring request for individual services. SCEF-Reference-ID (Mandatory): A unique identifier correlating the response to a specific monitoring request issued by the SCEF. When the Extended Reference IDs feature is supported, this value must still be present but will be ignored if SCEF-Reference-ID-Ext is used. SCEF-Reference-ID-Ext (Optional): Extended 64-bit identifier used when the "Extended Reference IDs" feature is enabled. SCEF-ID (Optional): Identifies the SCEF that originated the monitoring configuration. When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-Ext AVP shall be used instead of SCEF-Reference-ID; in such case, the required AVP "SCEF-Reference-ID" shall be included in the grouped AVP by the sender, but its content shall be discarded by the receiver. |
|||
Monitoring-Event-Configuration |
3122 |
Grouped |
3GPP |
Used by the SCEF to request the monitoring of specific events related to a subscriber (UE). It defines what to monitor (e.g., UE reachability, location change), how long to monitor, and under what conditions the configuration should expire. The AVP structure is defined as follows: SCEF-Reference-ID (Optional): Uniquely identifies the monitoring request from the SCEF. Required when creating a new monitoring event. SCEF-Reference-ID-Ext (Optional): Extended 64-bit reference ID, used when the “Extended Reference IDs” feature is supported. SCEF-ID (Mandatory): Identifies the SCEF that originated the request. Monitoring-Type (Mandatory for creation; ignored for deletion): Indicates the type of monitoring requested (e.g., UE Reachability, Location Reporting). SCEF-Reference-ID-for-Deletion (Optional, Multiple allowed): Used to delete existing monitoring events. SCEF-Reference-ID-for-Deletion-Ext (Optional, Multiple allowed): Used to delete existing monitoring events using extended reference IDs. Maximum-Number-of-Reports (Optional): Indicates the maximum number of reports to be sent before expiration. Monitoring-Duration (Optional): Absolute expiration time for the monitoring event. Charged-Party (Optional): Identifies the party to be charged for the monitoring. Maximum-Detection-Time (Optional): Max seconds without UE communication before declaring it unreachable. UE-Reachability-Configuration (Optional): Contains additional settings for UE reachability monitoring. Location-Information-Configuration (Optional): Specifies how location data should be reported (type, accuracy, frequency). Association-Type (Optional): Specifies association to a user or a group. DL-Buffering-Suggested-Packet-Count (Optional): Suggests how many packets should be buffered during downlink delay. PLMN-ID-Requested (Optional): Indicates whether the PLMN-ID should be reported with the event. MTC-Provider-Info (Optional): Contains info related to the MTC service provider. PDN-Connectivity-Status-Configuration (Optional): Configuration for PDN (Packet Data Network) status monitoring. Exclude-Identifiers (Optional): When group monitoring is active, specifies which UEs to exclude from the monitoring. Include-Identifiers (Optional): When group monitoring is active, specifies which UEs to include. Behaviour: At least one of the SCEF-Reference-ID or SCEF-Reference–ID-for-Deletion shall be present. The Maximum-Number-of-Reports AVP, if present, shall contain the maximum number of event reports to be generated by the HSS, MME, or SGSN until the monitoring event configuration is considered to expire. The Monitoring-Duration AVP, if present, shall contain the absolute time at which the monitoring event configuration is considered to expire. If both Maximum-Number-of-Reports and Monitoring-Duration AVPs are present, the monitoring event configuration shall be considered to expire as soon as one of the conditions is met. If both Maximum-Number-of-Reports and Monitoring-Duration AVPs are absent, the monitoring event configuration shall be considered as a one-time monitoring request (same behaviour as setting Maximum-Number-of-Reports to 1). Monitoring-Type shall only be taken into account in combination with SCEF-Reference-ID; Monitoring-Type AVP shall be ignored for deletion of an event (in combination with SCEF-Reference-ID-for-Deletion). The details of how to handle expiration of Monitoring events is described in 3GPP [TS 23.682]. When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used instead of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively. When the "Dynamic-Group-Event-Monitoring" feature is supported by the HSS and SCEF, the Exclude-Identifiers AVP may be included to cancel the event monitoring for the listed UEs in a group for which there is a configured Monitoring Event, or the Include-Identifiers AVP may be included to create the event monitoring for the listed UEs in a group for which there is a configured Monitoring Event. |
|||
Monitoring-Event-Report |
3123 |
Grouped |
3GPP |
Used by the HSS or a network element to report monitoring event results back to the SCEF in response to previously configured Monitoring-Event-Configuration requests. The AVP structure is defined as follows: SCEF-Reference-ID (Mandatory): Identifies the monitoring request that triggered this report. SCEF-Reference-ID-Ext (Optional): Extended ID used when the “Extended Reference IDs” feature is supported. SCEF-ID (Optional): Identifies the SCEF receiving the report. SCEF-Reference-ID-for-Deletion (Optional, Multiple allowed): Indicates IDs for monitoring configurations to be removed after this report. SCEF-Reference-ID-for-Deletion-Ext (Optional, Multiple allowed): Extended deletion references if the extended ID feature is supported. Visited-PLMN-Id (Optional): Identifies the Public Land Mobile Network the UE is currently attached to. Roaming-Information (Optional): Indicates if the UE is roaming, and possibly in which type of network. IMEI-Change (Optional): Bitmask indicating whether the IMEI or IMEISV has changed. Terminal-Information (Optional): Contains detailed information about the UE’s terminal (e.g., IMEI, software version, etc.). Reachability-Information (Optional): Indicates the reachability status of the UE (e.g., for data, SMS). Reachability-Cause (Optional): Enumerated reason explaining why the UE became reachable (e.g., power-on, network attach). Maximum-UE-Availability-Time (Optional): Specifies the time window during which the UE is expected to remain reachable. EPS-Location-Information (Optional): Includes details about the user's location in the EPS network (e.g., cell, TA, eNodeB). Monitoring-Type (Optional): Specifies the type of monitoring that triggered this report. Event-Handling (Optional): Enumerated AVP indicating if the event should be suspended, resumed, or canceled. Service-Report (Optional, Multiple allowed): Contains additional service-specific data related to the event. Loss-Of-Connectivity-Reason (Optional): Enumerated AVP indicating why the UE lost network connectivity. Idle-Status-Indication (Optional): Indicates idle state information of the UE. PDN-Connectivity-Status-Report (Optional, Multiple allowed): Contains information related to PDN connectivity status changes. When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used insted of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively; in such case, the required AVP "SCEF-Reference-ID" shall be included in the grouped AVP by the sender, but its content shall be discarded by the receiver. |
|||
Monitoring-Event-Report-Status |
3171 |
Grouped |
3GPP |
Used by the SCEF to acknowledge receipt and processing status of a specific Monitoring-Event-Report that was previously sent by the HSS or other network element. The AVP structure is defined as follows: SCEF-Reference-ID (Mandatory): Identifies the monitoring event report being acknowledged. SCEF-Reference-ID-Ext (Optional): Extended reference ID used when the “Extended Reference IDs” feature is supported. If present, the SCEF-Reference-ID is still included but ignored by the receiver. SCEF-ID (Mandatory): Identifies the SCEF instance acknowledging the event report. Result-Code (Optional): Standard Diameter result code indicating the outcome of processing. Experimental-Result-Code (Optional): Used when proprietary or vendor-specific error codes are returned. Must be interpreted together with Vendor-Id. Additional AVPs (Optional): Allows for extensibility with other AVPs as needed in future specifications. When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-Ext AVP shall be used instead of SCEF-Reference-ID; in such case, the required AVP "SCEF-Reference-ID" shall be included in the grouped AVP by the sender, but its content shall be discarded by the receiver. |
|||
Monitoring-Type |
3127 |
Enumerated |
3GPP |
Indicates the type of monitoring event that is being configured or reported. It defines what aspect of UE (User Equipment) or network behavior should be observed by the HSS or SCEF. Enumerated Values: 0: LOSS_OF_CONNECTIVITY: Triggers when a UE is deemed unreachable or has lost connectivity. 1: UE_REACHABILITY: Triggers when the UE becomes reachable again. May be specific to services such as SMS or data. 2: LOCATION_REPORTING: Reports the UE’s geographical or network location information. 3: CHANGE_OF_IMSI_IMEI(SV)_ASSOCIATION: Triggers when a change is detected in the association between IMSI and IMEI(SV). 4: ROAMING_STATUS: Notifies when the roaming status of the UE changes (e.g., starts or ends roaming). 5: COMMUNICATION_FAILURE: Reports failures in communication such as failed attach, TAU/RAU, or bearer establishment. 6: AVAILABILITY_AFTER_DDN_FAILURE: Indicates UE availability after a failed downlink delivery attempt (e.g., due to non-reachability). 7: NUMBER_OF_UES_PRESENT_IN_A_GEOGRAPHICAL_AREA: Counts the number of UEs in a specified area, useful for group-based monitoring and congestion control. 8: UE_REACHABILITY_AND_IDLE_STATUS_INDICATION: Provides both UE reachability status and idle state indication (e.g., connected/idle). 9: AVAILABILITY_AFTER_DDN_FAILURE_AND_IDLE_STATUS_INDICATION: Combination of availability after failed DDN and idle mode awareness. 10: PDN_CONNECTIVITY_STATUS: Reports changes in the PDN connectivity status of the UE (e.g., attach/detach from data networks). |
|||
MONTE-Location-Type |
3136 |
Enumerated |
3GPP |
Specifies the type of location information to be reported for the user as part of monitoring services (e.g. for IoT or MTC). This AVP is used within the Location-Information-Configuration AVP and determines whether real-time or last known location data is expected from the network. Enumerated Values: 0: CURRENT_LOCATION: The system must attempt to retrieve the current location of the UE. 1: LAST_KNOWN_LOCATION: The system may report the most recently stored location of the UE. (Default if AVP is not present). |
|||
MTC-Provider-ID |
3179 |
UTF8String |
3GPP |
Used to uniquely identify a Machine-Type Communication (MTC) Service Provider or MTC Application in the network. |
|||
MTC-Provider-Info |
3178 |
Grouped |
3GPP |
Used to contain information related to an MTC (Machine-Type Communication) Service Provider or MTC Application. The AVP structure is defined as follows: MTC-Provider-ID (Optional): Contains the unique identifier of the MTC provider or application. Additional AVPs (Optional, Multiple): Reserved for additional or future extensions. |
|||
NIA-Flags |
3176 |
Bitmask (Unsigned32) |
3GPP |
Used to notify the Home Subscriber Server (HSS) when the Group-User-Identifier List is incomplete, meaning additional segments of the list will follow in subsequent NIR commands. Bitmask Definition: 0: INCOMPLETE_GROUP_USER_IDENTIFIER_LIST: This bit is set when the HSS indicates that the sent Group-User-Identifier List is incomplete, meaning more segments will be provided in subsequent NIR commands. Note: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. |
|||
NIDD-Authorization-Request |
3150 |
Grouped |
3GPP |
Used for requesting authorization of Non-IP Data Delivery (NIDD) via the Service Capability Exposure Function (SCEF). The AVP structure is defined as follows: Service-Selection (Optional): Specifies the Access Point Name (APN) or service identifier for which NIDD authorization is being requested. If absent, the request applies to all APNs associated with the user. Requested-Validity-Time (Optional): Defines the requested duration for the NIDD authorization. Additional AVPs (Optional, Multiple): Reserved for additional or future extensions. |
|||
NIDD-Authorization-Response |
3151 |
Grouped |
3GPP |
Used to deliver authorization details in response to an NIDD-Authorization-Request. The AVP structure is defined as follows: MSISDN (Optional): Contains the Mobile Station International Subscriber Directory Number (MSISDN) of the user. User-Name (Optional): When present, this AVP shall contain the IMSI (International Mobile Subscriber Identity). External-Identifier (Optional): Used to identify the subscriber using an external reference rather than MSISDN or IMSI. Granted-Validity-Time (Optional): Specifies the time duration for which the NIDD authorization is valid. Additional AVPs (Optional, Multiple): Reserved for additional or future extensions. |
|||
NIDD-Authorization-Update |
3161 |
Grouped |
3GPP |
Used to manage updates or revocations of Non-IP Data Delivery (NIDD) authorizations. The AVP structure is defined as follows: APN-Validity-Time (Optional, Multiple occurrences): Specifies the validity period for Authorized APNs in NIDD communication. Additional AVPs (Optional, Multiple): Reserved for additional or future extensions. |
|||
NIR-Flags |
3174 |
Bitmask (Unsigned32) |
3GPP |
Used to convey additional flags related to the Network Information Retrieval (NIR) process. Bitmask Definition: 0: Incomplete Group-User-Identifier-List: Set when the SCEF (Service Capability Exposure Function) indicates that additional segments of the Group User Identifier List will be sent in subsequent NIR commands. Not set when the list is complete. Note: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. |
|||
Node-Type |
3153 |
Enumerated |
3GPP |
Used to indicate the type of network node sending the information. Enumerated Values: 0: HSS: Home Subscriber Server (HSS) – Centralized database for subscriber management. 1: MME: Mobility Management Entity (MME) – Handles signaling and mobility management for LTE networks. 2: SGSN: Serving GPRS Support Node (SGSN) – Manages mobility and session control in 2G/3G networks. |
|||
PDN-Connectivity-Status-Configuration |
3180 |
Grouped |
3GPP |
Indicates the APN(s) for which the PDN Connectivity Status is to be monitored. If the Service-Selection AVP is included, then the monitoring applies to that specific APN; if the Service-Selection is absent, the monitoring request applies to all APNs. The AVP structure is defined as follows: Service-Selection (Optional): The APN for which PDN Connectivity Status should be monitored. If absent, monitoring applies to all APNs. |
|||
PDN-Connectivity-Status-Report |
3181 |
Grouped |
3GPP |
Reports the status and parameters related to the connectivity of a Packet Data Network (PDN) connection for a UE. It is used when monitoring the PDN_CONNECTIVITY_STATUS event type (Monitoring-Type = 10), indicating whether requested APNs are active and, if so, their characteristics. If this AVP is absent in a Monitoring-Event-Report, it indicates that none of the requested APNs are active. However, it must always be present in RIR (Reporting-Information-Request) commands when Monitoring-Type = 10. The AVP structure is defined as follows: Service-Selection (Mandatory): Identifies the APN or service. PDN-Connectivity-Status-Type (Mandatory): Indicates the type of PDN connectivity status (e.g., Active, Suspended). PDN-Type (Optional): Specifies the type of IP connectivity: IPv4, IPv6, or IPv4v6. Present only for IP-based connections. Non-IP-PDN-Type-Indicator (Optional): Present and set to TRUE if this is a Non-IP PDN connection. Non-IP-Data-Delivery-Mechanism (Optional): Required if Non-IP-PDN-Type-Indicator is present. Indicates delivery via SGi or SCEF. Served-Party-IP-Address (Optional, 0-2 occurrences): IP addresses (IPv4 or IPv6) assigned to the UE. IPv6 prefix must have the lower 64 bits set to 0 if only a prefix is given. Absence of PDN-Connectivity-Status-Report in Monitoring-Event-Report AVP including Monitoring-Type AVP with value PDN_CONNECTIVITY_STATUS (10) in responses (immediate report) shall indicate that none of the requested APNs are active. The AVP shall always be present in RIR command if Monitoring-Event-Report AVP includes Monitoring-Type AVP with value PDN_CONNECTIVITY_STATUS (10). The PDN-Type AVP is defined in 3GPP [TS 29.272] and it shall be present when the PDN Connection is an IP connection, and it may contain the value IPv4, IPv6 or IPv4v6. The value IPv4_OR_IPv6 shall not be used for this event reporting. If PDN-Type AVP is present, then the Non-IP-PDN-Type-Indicator and Non-IP-Data-Delivery-Mechanism AVPs shall be absent. The Non-IP-PDN-Type-Indicator AVP is defined in 3GPP [TS 29.272] and it indicates whether the PDN Connection is of type "Non-IP". If this AVP is present, it shall be set to TRUE and the PDN-Type AVP shall be absent. The Non-IP-Data-Delivery-Mechanism AVP is defined in 3GPP [TS 29.272] and it shall be present if the Non-IP-PDN-Type-Indicator AVP is present and set to TRUE. It shall indicate whether the Non-IP data delivery is done via Point-To-Point tunnelling over the SGi interface, or via the SCEF. Notes: In 3GPP TS 23.682, clause 5.6.3.9, the reporting of the data delivery mechanism is described in terms of a parameter called "3GPP Interface Indication"; however, the conveyance of such information inside the PDN-Connectivity-Status-Report AVP is done in the present specification in terms of the same set of AVPs used for the definition of the subscription data in 3GPP [TS 29.272]. The correspondence of the values of the parameter "3GPP Interface Indication" is as follows:
The Served-Party-IP-Address AVP may be present 0, 1 or 2 times, and contain the IP address(es) used by the UE (if available) and, if present, they shall contain either of:
For the IPv6 prefix, the lower 64 bits of the address shall be set to zero. |
|||
PDN-Connectivity-Status-Type |
3182 |
Enumerated |
3GPP |
Specifies the status of a Packet Data Network (PDN) connection associated with the monitored Access Point Name (APN). Enumerated Values: 0: CREATED: Indicates that a new PDN Connection has been successfully established. 1: DELETED: Indicates that the existing PDN Connection has been removed or torn down. |
|||
Periodic-Communication-Indicator |
3115 |
Enumerated |
3GPP |
Specifies whether communication between the User Equipment (UE) and the network should occur at regular intervals or only when triggered. Enumerated Values: 0: PERIODICALLY: Indicates that communication is expected to occur at fixed, regular intervals. 1: ON_DEMAND: Indicates that communication will occur only when explicitly requested or triggered. |
|||
Periodic-time |
3117 |
Unsigned32 |
3GPP |
Defines the time interval, in seconds, for periodic communication between the User Equipment (UE) and the network. This AVP is applicable when the Periodic-Communication-Indicator AVP is set to PERIODICALLY (0) and should be omitted when communication is ON_DEMAND (1). |
|||
PLMN-ID-Requested |
3172 |
Enumerated |
3GPP |
Indicates whether the PLMN-ID (Public Land Mobile Network Identifier) should be included in the event report when monitoring the ROAMING_STATUS event type. Enumerated Values: 0: TRUE: The PLMN-ID shall be returned in the event report. 1: FALSE: The PLMN-ID shall not be returned in the event report. The default value, when this AVP is not included, is TRUE (0). |
|||
Reachability-Information |
3140 |
Enumerated |
3GPP |
Specifies the current reachability status of the subscriber. It is used to indicate whether the UE (User Equipment) is reachable for specific types of communication. Enumerated Values: 0: REACHABLE_FOR_SMS: Indicates that the subscriber is reachable for SMS (Short Message Service) delivery. 1: REACHABLE_FOR_DATA: Indicates that the subscriber is reachable for data communication (e.g., packet-switched services). |
|||
Reachability-Type |
3132 |
Bitmask (Unsigned32) |
3GPP |
Defines the type of reachability monitoring to be configured for a UE (User Equipment). It uses a bitmask to indicate whether monitoring should target SMS reachability or data reachability. Only one bit should be set at a time. If this AVP is absent, the default behavior is to monitor Reachability for SMS. Bitmask Values: 0: REACHABILITY_FOR_SMS: Indicates that the monitoring for reachability for SMS of the UE is active. 1: REACHABILITY_FOR_DATA: Indicates that the monitoring for reachability for data of the UE is active. Notes: Bits not defined in this table must be cleared by the sender and ignored by the receiver. Bits 0 and 1 must not be set simultaneously. |
|||
Reference-ID-Validity-Time |
3148 |
Time |
3GPP |
Contains the point of time when the CP sets associated to an SCEF-Reference-ID (in combination with an SCEF-ID) becoming invalid and shall be deleted. |
|||
Reporting-Time-Stamp |
3175 |
Time |
3GPP |
Contains the point of time when the report was generated. |
|||
Requested-Validity-Time |
3159 |
Time |
3GPP |
Contains the point of time after which the SCEF is willing to consider a granted NIDD authorization as being implicitly revoked. |
|||
Restricted-PLMN-List |
3157 |
Grouped |
3GPP |
Defines a list of serving PLMNs (Public Land Mobile Networks) where Enhanced Coverage is restricted. Absence of Visited-PLMN-Id AVPs indicates that Enhanced Coverage is allowed in all serving PLMNs. The AVP structure is defined as follows: Visited-PLMN-Id (Optional, Multiple allowed): Contains the encoded PLMN ID (MCC+MNC) |
|||
RIR-Flags |
3167 |
Unsigned32 (Bitmask) |
3GPP |
Provides status indicators used by the HSS in RIR (Reporting-Information-Request) messages on the S6t interface. Bitmask Definition: 0: Group-Configuration-In-Progress: Indicates that the HSS is currently processing the group monitoring configuration and will send further status or reports using additional RIR commands. 1: All-Monitoring-Events-Cancelled: Indicates that all configured monitoring events have been cancelled, e.g., due to subscription removal. 2: Change-Of-Authorized-Monitoring-Events: Indicates a change in SCEF authorization for one or more monitoring events. 3: All-Communication-Pattern-Cancelled: Indicates that all existing communication patterns have been cancelled, e.g., due to subscription removal. 4: All-Suggested-Network-Configuration-Cancelled: Indicates that all suggested network parameter configurations have been cancelled. Note: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. |
|||
Roaming-Information |
3139 |
Enumerated |
3GPP |
Indicates the roaming status of the subscriber's UE (User Equipment). It is used by the HSS or network elements to inform the SCEF (Service Capability Exposure Function) whether the subscriber is currently roaming or not roaming. Enumerated Values: 0: SUBSCRIBER_ROAMING: The subscriber is currently in roaming status. 1: SUBSCRIBER_NOT_ROAMING: The subscriber is not roaming; they are within their home network. |
|||
S6t-HSS-Cause |
3154 |
Unsigned32 (Bitmask) |
3GPP |
Used to indicate specific conditions or failure causes identified by the HSS (Home Subscriber Server) when handling monitoring or configuration operations over the S6t interface. Bitmask Definitions: 0: Absent Subscriber: Indicates that the UE is not reachable because the HSS has no serving node registered or the subscriber has been purged. Configuration could not be forwarded. 1: Group Event Monitoring Partially Cancel: Indicates that a group-based event monitoring configuration has been partially canceled for this UE. Note: Bits not defined in this table must be cleared by the sender and ignored by the receiver. |
|||
SCEF-ID |
3125 |
DiameterIdentity |
3GPP |
Contains the identity of the SCEF which has originated the service request towards the HSS, i.e. when sent within a Monitoring-Event-Configuration AVP in S6t-CIR, SCEF-ID AVP and Origin-Host AVP shall have the same value. |
|||
SCEF-Reference-ID |
3124 |
Unsigned32 |
3GPP |
Contains the identifier provided by the SCEF. |
|||
SCEF-Reference-ID-Ext |
3124 |
Unsigned64 |
3GPP |
Contain a 64-bit identifier provided by the SCEF, which shall be used instead of the 32-bit identifier SCEF-Reference-ID, when supported by both SCEF and HSS. |
|||
SCEF-Reference-ID-for-Deletion |
3126 |
Unsigned32 |
3GPP |
Contains the SCEF-Reference-ID (in combination with the SCEF identified by the SCEF-ID) for the event to be deleted. |
|||
SCEF-Reference-ID-for-Deletion-Ext |
3126 |
Unsigned64 |
3GPP |
Contains a 64-bit identifier provided by the SCEF, which shall be used instead of the 32-bit identifier SCEF-Reference-ID-for-Deletion, when supported by both SCEF and HSS. |
|||
Scheduled-Communication-Time |
3118 |
Grouped |
3GPP |
Defines a specific window or schedule during which communication between the UE and the network is allowed or expected. The AVP structure is defined as follows: Day-Of-Week-Mask (Optional): Indicates which days of the week the schedule applies to. If not present, the schedule applies to every day. Time-Of-Day-Start (Optional): Start time of the communication window, expressed in seconds since midnight. If not provided, it defaults to 00:00 (start of day). Time-Of-Day-End (Optional): End time of the communication window, expressed in seconds since midnight. If not provided, it defaults to 23:59:59 (end of day). Additional AVPs (Optional, Multiple): Reserved for additional or future extensions. If Day-Of-Week-Mask is not provided this shall be interpreted as every day of the week. If Time-Of-Day-Start is not provided, starting time shall be set to start of the day(s) indicated by Day-Of-Week-Mask. If Time-Of-Day-End is not provided, ending time is end of the day(s) indicated by Day-Of-Week-Mask. |
|||
Service-Report |
3152 |
Grouped |
3GPP |
Contains the result of the handling of the Requested action for the Monitoring event, the type of node and the services it supports. The AVP structure is defined as follows: Service-Result (Optional): Describes the result of the service handling (e.g., success, unsupported, failure). Node-Type (Optional): Identifies the type of node (e.g., MME, SGSN, HSS) that processed the monitoring request. Additional AVPs (Optional, Multiple): Reserved for additional or future extensions. |
|||
Service-Result |
3146 |
Grouped |
3GPP |
Specifies the result of processing a requested monitoring action by providing an error or status code. The AVP structure is defined as follows: Vendor-Id (Optional): Identifies the organization defining the result code. Must be set to 10415 if the Service-Result-Code is a 3GPP Experimental-Result-Code. If the result code is from the IETF base protocol, this AVP must be absent or set to 0. Service-Result-Code (Optional): Represents either a standard Diameter base Result-Code or a 3GPP-specific Experimental-Result-Code, depending on the Vendor-Id. |
|||
Service-Result-Code |
3147 |
Unsigned32 |
3GPP |
Contain either the value of an Experimental-Result-Code defined by 3GPP or the value of a Result-Code defined in Diameter base protocol by IETF. |
|||
SGSN-Location-Information |
1601 |
Grouped |
3GPP |
Provides detailed location information relevant to the Serving GPRS Support Node (SGSN) for a user. The AVP structure is defined as follows: Cell-Global-Identity (Optional): Identifies the current cell where the user is located. Service-Area-Identity (Optional): Identifies the service area in which the user is registered. Routing-Area-Identity (Optional): Identifies the routing area in the SGSN coverage where the UE resides. Current-Location-Retrieved (Optional): Indicates whether the location info was freshly retrieved or cached. Age-Of-Location-Information (Optional): Indicates how old (in seconds) the provided location data is. User-CSG-Information (Optional): Contains info about the user’s Closed Subscriber Group configuration. |
|||
Stationary-indication |
3119 |
Enumerated |
3GPP |
Indicates whether the User Equipment (UE) is stationary or mobile. Enumerated Values: 0: STATIONARY_UE: Indicates that the UE is not moving and is expected to remain in the same location. 1: MOBILE_UE: Indicates that the UE is mobile and may change location frequently. |
|||
Suggested-Network-Configuration |
3170 |
Grouped |
3GPP |
Provides configuration parameters proposed by the HSS to the SCEF for optimizing network behavior for a specific UE or group of UEs. These configurations can include values such as RAU/TAU timers, active time, buffering strategies, and MTC provider metadata. The AVP structure is defined as follows: SCEF-Reference-ID (Mandatory): Identifier of the SCEF making the request. Always included but may be discarded when SCEF-Reference-ID-Ext is used. SCEF-Reference-ID-Ext (Optional): Extended identifier replacing SCEF-Reference-ID when supported. SCEF-ID (Mandatory): Identity of the SCEF. Subscribed-Periodic-RAU-TAU-Timer (Optional): Suggested periodic RAU/TAU timer value for the UE, in seconds. Active-Time (Optional): Suggested Active Time (e.g., T3324 value) for the UE. DL-Buffering-Suggested-Packet-Count (Optional): Suggested maximum number of downlink packets to buffer. MTC-Provider-Info (Optional): Additional metadata regarding the MTC provider. SCEF-Reference-ID-for-Deletion (Optional): Reference ID(s) of previously configured network parameters to be deleted. SCEF-Reference-ID-for-Deletion-Ext (Optional): Extended 64-bit identifiers to delete, used in place of the above when supported. If the values of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion are the same, no Network Parameter Configurations AVP(s) shall be present, that is, SCEF-Reference-ID-for-Deletion takes precedence. If the values of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion are not the same, Network Parameter Configurations AVP(s) are related to SCEF-Reference-ID. When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used instead of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively; in such case, the required AVP "SCEF-Reference-ID" shall be included in the grouped AVP by the sender, but its content shall be discarded by the receiver. |
|||
Supported-Monitoring-Events |
3144 |
Bitmask (Unsigned64) |
3GPP |
Indicates which monitoring events are supported by the node (e.g., HSS, MME, SGSN). Bitmask Definitions: 0: UE and UICC / IMSI-IMEI-SV Association: Indicates support for monitoring the association of UE with UICC or new IMSI-IMEI(SV) pairings. 1: UE Reachability: Indicates support for monitoring whether the UE is reachable. 2: Location of the UE: Indicates support for monitoring the current location or changes in location of the UE. 3: Loss of Connectivity: Indicates support for monitoring the loss of UE connectivity. 4: Communication Failure: Indicates support for detecting communication failures. 5: Roaming Status: Indicates support for monitoring whether the UE is roaming or not, and changes in roaming status. 6: Availability after DDN Failure: Indicates support for monitoring the UE's availability following a Downlink Data Notification failure. 7: Idle Status Indication: Indicates support for idle mode status monitoring, often in combination with Availability After DDN Failure and Reachability monitoring. 8: PDN Connectivity Status: Indicates support for monitoring PDN connectivity events (e.g., PDN session creation/deletion). Note: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. Absence of this AVP shall have the same meaning as all bits cleared (i.e. serving node does not support MONTE). If RIR-flags is included in Reporting-Information-Request to indicate a change of authorized monitoring events, each bit in Supported-Monitoring-Events AVP, if cleared, shall indicate the SCEF that associated monitoring event is not authorized. |
|||
Supported-Services |
3143 |
Grouped |
3GPP |
Contains information about the services supported by a node (e.g., HSS, MME, SGSN). It primarily conveys service support details via bitmask sub-AVPs. The AVP structure is defined as follows: Supported-Monitoring-Events (Optional): Indicates which monitoring events are supported by the node. Refer to the Supported-Monitoring-Events AVP for details on each bit. Node-Type (Optional): Indicates the type of node (e.g., HSS, MME, SGSN) providing the information. |
|||
Traffic-Profile |
3183 |
Enumerated |
3GPP |
Indicates the expected pattern of data transmission for a user device. It enables network elements such as the HSS or SCEF to optimize service configuration and monitoring based on the anticipated communication behavior. Enumerated Values: 0: SINGLE_TRANSMISSION_UL: Indicates a single uplink transmission is expected. 1: SINGLE_TRANSMISSION_DL: Indicates a single downlink transmission is expected. 2: DUAL_TRANSMISSION_UL_WITH_SUBSEQUENT_DL: Indicates an uplink transmission followed by a downlink transmission. 3: DUAL_TRANSMISSION_DL_WITH_SUBSEQUENT_UL: Indicates a downlink transmission followed by an uplink transmission. 4: MULTI_TRANSMISSION: Indicates multiple transmissions in either direction are expected. |
|||
Type-Of-External-Identifier |
3168 |
Enumerated |
3GPP |
Specifies the nature of the identity contained in the corresponding External-Identifier AVP. Enumerated Values: 0: EXTERNAL-UE-IDENTIFIER-TYPE: Indicates that the External-Identifier AVP contains the identity of a single user equipment (UE). 1: EXTERNAL-GROUP-IDENTIFIER-TYPE: Indicates that the External-Identifier AVP contains the identity of a group of UEs. |
|||
UE-Reachability-Configuration |
3129 |
Grouped |
3GPP |
Specifies parameters for configuring the monitoring of UE (User Equipment) reachability. It defines how the system should track and handle the availability of a UE, especially in cases where data delivery or communication is expected. The AVP structure is defined as follows: Reachability-Type (Optional): Indicating whether monitoring is configured for SMS (bit 0) or Data (bit 1) reachability. Only one bit should be set at a time. Default is SMS. Maximum-Latency (Optional): Maximum acceptable delay (in seconds) for downlink data transfer. Helps determine the acceptable latency window. Maximum-Response-Time (Optional): Maximum time (in seconds) during which the UE is considered reachable after becoming active. DL-Buffering-Suggested-Packet-Count (Optional):Suggested number of downlink packets to buffer while the UE is being paged. |
|||
Updated-Network-Configuration |
3184 |
Grouped |
3GPP |
Used to report updated network parameter configurations. Its interpretation depends on its context: The AVP structure is defined as follows: SCEF-ID (Mandatory): The identity of the SCEF associated with this configuration. SCEF-Reference-ID (Optional): Identifier for referencing a specific configuration set. SCEF-Reference-ID-Ext (Optional): Extended identifier used if supported. SCEF-Reference-ID-for-Deletion (Optional): Identifiers for configurations to be deleted. SCEF-Reference-ID-for-Deletion-Ext (Optional): Extended identifiers for configurations to be deleted. Subscribed-Periodic-RAU-TAU-Timer (Optional): Time (in seconds) for periodic RAU/TAU procedures configured by the SCEF. Active-Time (Optional): The maximum time the UE remains reachable after a mobile-terminated communication attempt. DL-Buffering-Suggested-Packet-Count (Optional): The number of downlink packets to be buffered for the UE. At least one reference ID (either in SCEF-Reference-ID or in SCEF-Reference-ID-Ext) or a reference ID for deletion (either in SCEF-Reference-ID-for-Deletion or in SCEF-Reference-ID-for-Deletion-Ext) shall be present. When the "Extended Reference IDs" feature is supported by the HSS and SCEF, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used instead of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively. |
|||
User-Identifier |
3102 |
Grouped |
3GPP |
Specifies the identity of a user equipment (UE) using one of the following: IMSI (encapsulated in the User-Name AVP), MSISDN, or External-Identifier (which can represent either an individual UE or a group of UEs). The AVP structure is defined as follows: User-Name (Optional): Contains the IMSI of the UE (when applicable), used to uniquely identify the subscriber. MSISDN (Optional): The MSISDN (phone number) associated with the subscriber. External-Identifier (Optional): A globally unique identifier for an individual UE or a group of UEs (e.g., extid:1234@domain.com). Type-Of-External-Identifier (Optional): Enumerated value that indicates whether the External-Identifier represents an individual UE (value 0) or a group of UEs (value 1). If absent, defaults to individual UE. This AVP shall contain one of the identifiers (IMSI, MSISDN or External-Identifier). The IMSI of the UE shall be included (when applicable) in the User-Name AVP. The External-Identifier AVP may either contain the identity of an individual UE or the identity of a Group of UEs. The Type-Of-External-Identifier is used to indicate which type of identity is carried in the External-Identifier. When the Type-Of-External-Identifier is not present, it means the External-Identifier AVP contains the identity of an individual UE. |
Start innovating with Mobius
What's next? Let's talk!