This Web service method returns the registry states for the user.
The user state can be registered, unregistered, pending while being authenticated, or unregistered. A service call session control function (S-CSCF) name is allocated to trigger services for unregistered users. The return value is an integer that contains the IMS User State of the public identifier being referenced. The possible values are explained in the following table:
Integer Value | User State |
---|---|
0 | NOT_REGISTERED |
1 | REGISTERED |
2 | REGISTERED_UNREG_SERVICES |
3 | AUTHENTICATION_PENDING |
myIMSUserStateName = service.getIMSUserState( "aaa://host.example.com;protocol=diameter;-117302099;1", "sipintel10.city.company.com", "realmA.mycompany.com", "sips:carol@ws1234.domain2.com");
Parameter Name | Type | Description |
---|---|---|
sessionId | String | Identifies a specific session. All messages pertaining to a specific session must include only one Session-Id AVP and the same value must be used throughout the life of a session. The Session ID must be globally and eternally unique, as it is meant to uniquely identify a user session without reference to any other information. This may be needed to correlate historical authentication information with accounting information. Example: aaa://host.example.com;protocol=diameter;-117302099;1 |
destinationHost | String | The fully qualified domain name of the HSS that the Sh subscriber profile Web service will send this request to. This input parameter is optional. Examples include: sipintel15.city.example.com or diameter.example.com |
destinationRealm | String | The realm that this subscriber belongs to. The destination realm is a required parameter and must be a fully qualified domain name. The value specified must match the specific realmName property that is defined in one of the routex properties in the Diameter_Sh.properties file. If the value does not match any of the specific routes, and a DEFAULT route entry is defined, the DEFAULT route will be used. |
publicUserIdentity | String | A subscriber is allocated one or more public
user identities, which are created by the home operator. A public user identity
is either a SIP URL (as defined in RFC 3261) or a TEL URI (as defined in RFC
3966) and helps route a SIP request. Example:
|