Version

Sh AVPs

Sh (application id: 16777292)

The Sh interface is a crucial component of the IP Multimedia Subsystem (IMS) architecture. It facilitates communication between the Home Subscriber Server (HSS) and various Application Servers (AS), enabling the exchange of user-related data necessary for service provision. The Sh interface is built on the Diameter protocol, ensuring reliable and secure transmission of subscriber information.

The primary purpose of the Sh interface is to manage and synchronize subscriber-related information between the HSS and AS. This includes the retrieval, updating, and notification of user profile data, which is essential for delivering personalized services in an IMS network. The Sh interface supports a wide range of services by allowing AS to access user-specific data stored in the HSS, such as service entitlements, preferences, and presence information.

Functional Components

  • Home Subscriber Server (HSS): The HSS is the central database that stores user profiles, service data, and subscription information. It is responsible for handling requests from AS for user data and sending notifications when this data changes.
  • Application Server (AS): The AS provides various IMS services to users, such as multimedia applications, messaging, and presence services. The AS communicates with the HSS via the Sh interface to retrieve or update user data and subscribe to notifications about changes in user profiles.

Sh interface workflow: 
Data Handling Procedures:

Data Retrieval: 

  • The AS initiates a request to the HSS to retrieve user-specific data using the Sh-Query command. This data may include user identities, service profiles, and other relevant subscription information.
  • The HSS processes the request and sends the requested data back to the AS in the response message.

Data Update:

  • The AS may update user data stored in the HSS by sending an Sh-Update command. This could include changes to service preferences or user identity data.
  • Upon successful update, the HSS confirms the change by sending an Sh-Update response.

Subscription and Notification Procedures:

Subscription to Notifications:

  • The AS can subscribe to receive notifications about changes in user data by sending an Sh-Subs-Notif request to the HSS. This subscription ensures that the AS is kept informed of any updates in the user’s profile.
  • The HSS acknowledges the subscription and begins monitoring the relevant data.

Notification of Data Changes:

  • When there is a change in the user data to which the AS has subscribed, the HSS sends an Sh-Notif command to the AS, indicating the nature of the update.
  • The AS processes the notification and sends back an Sh-Notif Resp message to confirm receipt.

Service Registration:

User Registration:

  • When a user registers for a service, the AS may need to interact with the HSS to obtain or update user data relevant to the service.
  • The AS sends a Register command to the HSS, which may include data such as user identity or service preferences.
  • The HSS processes the registration and confirms with a 200 OK response.

For complete technical specification of Sh interface in Diameter protocol please refer to: [3GPP TS 29.328]

package com.mobius.software.telco.protocols.diameter.primitives.sh;

Name

AVP Code

Data Type

Vendor

AS-Number

722

OctetString

3GPP

Contains an Address Signal (AS) Number. The content and format of this AVP align with the gmscaddress parameter as specified in 3GPP [TS 29.002]. This AVP is primarily used in signaling scenarios within the Sh interface, which facilitates communication between application servers and Home Subscriber Servers (HSS) in IMS networks.

Call-Reference-Info

720

Grouped

3GPP

Contains information necessary for associating a call reference with an application server (AS). It is primarily used in Sh interface communication between the Home Subscriber Server (HSS) and application servers in IMS (IP Multimedia Subsystem) networks.

The AVP structure is defined as follows:

Call-Reference-Number (Mandatory): A unique identifier for the call session. It is represented as an OctetString and ensures that the call reference remains consistent across Diameter transactions.

AS-Number (Mandatory): An identifier corresponding to the Application Server (AS) involved in handling the session. This field follows the format of the gmscaddress parameter as specified in 3GPP [TS 29.002].

May contain additional optional AVPs as required by specific use cases in IMS deployments.

Call-Reference-Number

721

OctetString

3GPP

Often used as a mandatory component within the Call-Reference-Info AVP, ensuring that call-related transactions can be correctly associated across different network elements.The exact content and format of this AVP is described in 3GPP [TS 29.002].

Current-Location

707

Enumerated

3GPP

Used in the Sh interface to indicate whether an active location retrieval should be initiated for a subscriber. This AVP is used in requests from an Application Server (AS) to the Home Subscriber Server (HSS) to control location retrieval behavior.

Enumerated Values:

0: DoNotNeedInitiateActiveLocationRetrieval: The request specifies that active location retrieval is not required.

1: InitiateActiveLocationRetrieval: The request specifies that an active location retrieval should be initiated.

Data-Reference

703

Enumerated

3GPP

Used in User Data Request (UDR) and Subscribe-Notifications Request (SNR) operations to specify the type of user data being requested. This AVP is defined in 3GPP TS 29.328 and is used within the Sh interface for retrieving or subscribing to specific user data stored in the Home Subscriber Server (HSS).

Enumerated Values:

0: RepositoryData: Refers to application-specific data stored in the network.

10: IMSPublicIdentity: Requests the user's IMS public identity.

11: IMSUserState: Requests the IMS user state, indicating whether the user is registered.

12: S-CSCFName: Retrieves the name of the assigned Serving Call Session Control Function (S-CSCF).

13: InitialFilterCriteria: Requests Initial Filter Criteria (iFC) relevant to the requesting Application Server (AS).

14: LocationInformation: Requests the user’s location information.

15: UserState: Retrieves the user state (e.g., active, idle).

16: ChargingInformation: Retrieves charging-related information for the user.

17: MSISDN: Requests the user's Mobile Station International Subscriber Directory Number (MSISDN).

18: PSIActivation: Requests Public Service Identity (PSI) activation status.

19: DSAI: Requests Dynamic Service Activation Information (DSAI).

21: ServiceLevelTraceInfo: Retrieves service-level trace information.

22: IPAddressSecureBindingInformation: Requests secure IP address binding information.

23: ServicePriorityLevel: Requests the user's service priority level.

24: SMSRegistrationInfo: Retrieves SMS registration status.

25: UEReachabilityForIP: Requests information on UE reachability for IP-based services.

26: TADSinformation: Retrieves Trusted Application Domain (TADS) information.

27: STN-SR: Requests the Session Transfer Number for Single Radio (STN-SR).

28: UE-SRVCC-Capability: Retrieves UE capability for Single Radio Voice Call Continuity (SRVCC).

29: ExtendedPriority: Requests the Extended Priority status.

30: CSRN: Retrieves the Circuit Switched Routing Number (CSRN).

31: ReferenceLocationInformation: Requests reference location information.

32: IMSI: Retrieves the user's International Mobile Subscriber Identity (IMSI).

33: IMSPrivateUserIdentity: Requests the user's IMS private identity.

34: IMEISV: Retrieves the International Mobile Equipment Identity with Software Version (IMEISV).

35: UE-5G-SRVCC-Capability: Requests UE capability for 5G-SRVCC.

Note: Value 20 is reserved.

DSAI-Tag

711

OctetString

3GPP

Contains the DSAI-Tag identifying the instance of the Dynamic Service Activation Information being accessed for the Public Identity.

Expiry-Time

709

Time

3GPP

Contains the expiry time of subscriptions to notifications in the HSS.

Identity-Set

708

Enumerated

3GPP

Used in the Sh interface to specify the requested set of IMS Public Identities associated with a subscriber. This AVP is primarily used in User Data Request (UDR) operations, where an Application Server (AS) queries the Home Subscriber Server (HSS) for a specific set of identities.

Enumerated Values:

0: ALL_IDENTITIES: Requests all IMS Public Identities associated with the subscriber.

1: REGISTERED_IDENTITIES: Requests only IMS Public Identities that are currently registered.

2: IMPLICIT_IDENTITIES: Requests all implicitly registered identities.

3: ALIAS_IDENTITIES: Requests all alias identities associated with the subscriber.

Local-Time-Zone-Indication

718

Enumerated

3GPP

Used in the Sh interface to specify whether local time zone information (including time zone offset and daylight saving time) of the visited network where the User Equipment (UE) is attached should be retrieved. 

Enumerated Values:

0: ONLY_LOCAL_TIME_ZONE_REQUESTED: Requests only the local time zone information of the visited network.

1: LOCAL_TIME_ZONE_WITH_LOCATION_INFO_REQUESTED: Requests both local time zone information and location details of the visited network.

If present it indicates that the Local Time Zone information (time zone and daylight saving time) of the visited network where the UE is attached is requested with or without other location information.

MSISDN

701

OctetString

3GPP

Contains an MSISDN, in international number format as described in [ITU-T Rec E.164], encoded as a TBCD-string, i.e. digits from 0 through 9 are encoded 0000 to 1001; 1111 is used as a filler when there is an odd number of digits; bits 8 to 5 of octet n encode digit 2n; bits 4 to 1 of octet n encode digit 2(n-1)+1.

One-Time-Notification

712

Enumerated

3GPP

Used in the Sh interface to specify whether the sender requests to be notified only once regarding a particular event. This AVP is applicable exclusively to UE reachability for IP-based services (Data-Reference value 25) and is used in Subscribe-Notifications Request (SNR) messages between an Application Server (AS) and the Home Subscriber Server (HSS).

Enumerated Values:

0: ONE_TIME_NOTIFICATION_REQUESTED: Indicates that the sender requests a single notification when the requested event occurs (e.g., when the User Equipment (UE) becomes reachable for IP-based services).

Pre-Paging-Supported

717

Enumerated

3GPP

Used in the Sh interface to indicate whether the sender supports pre-paging functionality. Pre-paging is a mechanism that allows the network to optimize paging procedures for mobile-terminated services by determining UE reachability in advance.

If this AVP is not present in a Diameter command, the default behavior is assumed to be PREPAGING_NOT_SUPPORTED (0).

Enumerated Values:

0: PREPAGING_NOT_SUPPORTED: Indicates that the sender does not support pre-paging.

1: PREPAGING_SUPPORTED: Indicates that the sender supports pre-paging.

Repository-Data-ID

715

Grouped

3GPP

Used in the Sh interface to manage repository data related to service profiles in the Home Subscriber Server (HSS). This AVP is used when storing, retrieving, or updating repository data associated with a specific service in IMS (IP Multimedia Subsystem).

This AVP contains identifiers that link a specific instance of repository data to a service, ensuring consistency and version control of stored service data.

The AVP structure is defined as follows:

Service-Indication (Mandatory): Identifies the particular service to which the repository data belongs. 

Sequence-Number (Required): Represents a versioning mechanism for repository data.

It ensures that data consistency is maintained by tracking updates using a monotonically increasing sequence number.

May contain additional AVPs as required by specific service implementations.

Requested-Domain

706

Enumerated

3GPP

Used in the Sh interface to specify the access domain for which certain user data (such as user state) is requested. This AVP is typically used in User Data Request (UDR) and Subscribe-Notifications Request (SNR) operations between an Application Server (AS) and the Home Subscriber Server (HSS).

Enumerated Values:

0: CS-Domain: The requested data applies to the Circuit-Switched (CS) domain, used for traditional telephony services over legacy networks.

1: PS-Domain: The requested data applies to the Packet-Switched (PS) domain, used for IP-based services over IMS and mobile broadband networks.

Requested-Nodes

713

Unsigned32 (Bitmask)

3GPP

Used in the Sh interface to specify which network nodes should provide the requested data. This AVP allows an Application Server (AS) to indicate specific network elements whose information is needed when interacting with the Home Subscriber Server (HSS).

Bitmask Definition:

Bit 0: MME: Indicates that the requested data applies to the Mobility Management Entity (MME), which is responsible for managing mobility and signaling in LTE networks.

Bit 1: SGSN: Indicates that the requested data applies to the Serving GPRS Support Node (SGSN), which manages session and mobility control in 2G/3G networks.

Bit 2: 3GPP-AAASERVER-TWAN: Indicates that the requested data applies to the 3GPP AAA Server for Trusted WLAN (TWAN), which is responsible for authentication, authorization, and accounting for non-3GPP access networks.

Bit 3: AMF: Indicates that the requested data applies to the Access and Mobility Management Function (AMF) in 5G Core (5GC), which is responsible for managing UE registration, connection, and mobility.

Send-Data-Indication

710

Enumerated

3GPP

Used in the Sh interface to indicate whether the sender requests the User-Data to be included in the response. This AVP is typically used in User Data Request (UDR) operations between an Application Server (AS) and the Home Subscriber Server (HSS) when retrieving user-related information.

Enumerated Values:

0: USER_DATA_NOT_REQUESTED: Indicates that user data retrieval is not requested, meaning the request does not require a response containing user data.

1: USER_DATA_REQUESTED: Indicates that user data retrieval is requested, meaning the HSS should return the User-Data AVP in the response.

Sequence-Number

716

Unsigned32

3GPP

Contains a number associated to a repository data.

Service-Indication

704

OctetString

3GPP

Contains the Service Indication that identifies a service or a set of services in an AS and the related repository data in the HSS. Standardized values of Service-Indication identifying a standardized service or set of services in the AS and standardized format of the related repository data are defined in 3GPP [TS 29.364].

Serving-Node-Indication

714

Enumerated

3GPP

Used in the Sh interface to specify that the sender requires only the Serving Node Addresses/Identities (e.g., MME name, VLR number) and does not need any additional location information, such as Global Cell ID or Tracking Area ID.

Enumerated Values:

0: ONLY_SERVING_NODES_REQUIRED: Indicates that the sender requests only serving node addresses/identities, excluding other location-related details.

Subs-Req-Type

705

Enumerated

3GPP

Used in the Sh interface to specify the type of subscription-to-notifications request sent by an Application Server (AS) to the Home Subscriber Server (HSS). This AVP determines whether the AS is subscribing to or unsubscribing from notifications related to changes in subscriber data.

Enumerated Values:

0: Subscribe: Indicates that the AS is subscribing to notifications for changes in subscriber data.

1: Unsubscribe: Indicates that the AS is unsubscribing from notifications, meaning it no longer wishes to receive updates for changes in subscriber data.

UDR-Flags

719

Unsigned32 (Bitmask)

3GPP

Used in the Sh interface to specify additional flags related to User Data Request (UDR) operations. Each bit in the UDR-Flags AVP has a defined meaning as per 3GPP TS 29.328.

Bitmask Values:

Bit 0: Location-Information-EPS-Supported: Indicates that the request includes EPS (Evolved Packet System) location information.

Bit 1: RAT-Type-Requested: Indicates that the request includes Radio Access Technology (RAT) type information.

Note: Bits not defined in this table shall be cleared by the sender of the request and discarded by the receiver of the request. 

User-Data

702

OctetString

3GPP

Contains the user data requested in the UDR/UDA, SNR/SNA and PNR/PNA operations and the data to be modified in the PUR/PUA operation. The exact content and format of this AVP is described in 3GPP [TS 29.328] Annex C as Sh-Data.

User-Identity

700

Grouped

3GPP

Used in the Sh interface to specify a user's identity within the IMS network. This AVP provides multiple identification options, allowing it to contain either a Public-Identity, MSISDN, or an External-Identifier.

The AVP structure is defined as follows:

Public-Identity (Optional): Contains an IMS Public Identity associated with the user.

Typically formatted as a SIP URI (e.g., sip:user@domain.com) or TEL URI.

MSISDN (Optional): Contains the Mobile Station International Subscriber Directory Number (MSISDN).

External-Identifier (Optional): Contains an external identity used for non-SIP-based services.

Other AVPs may be included as required by specific implementations.


 

Start innovating with Mobius

What's next? Let's talk!

Mobius Software

As a company you'll get:

  • Get started quickly

  • Support any business model

  • Join millions of businesses

Questions? websupport@mobius.com