The Registered SIP Binding object describes a SIP device that has registered with the NE to make SIP calls. It is a child of the Registered SIP Bindings for User object.
The SIP device belongs to either an Individual Line or a Business Group Line subscriber. It may be a SIP phone used by the subscriber (either a hardware device or a software phone), or a Personal Communication Manager program running on the subscriber's PC.
A Registered SIP Binding is created dynamically when a SIP subscriber's phone registers with the NE. The object does not have any modifiable fields, and you cannot create or delete it; it simply provides the subscriber's registration details and status information.
In the EMS System Explorer, the name shown for each Registered SIP Binding is the user's address, in the format 'username@domainname', followed by the contact IP address and port number with which the device registered. If the Registered SIP Binding is involved in one or more active calls, this name is followed by a count of the active calls and the remote directory number for the earliest of these calls.
Parameter
|
Access
|
Description
|
Contact URI
|
Read only
|
The contact URI (user address) supplied by the SIP device when it registered. This is the name that the NE uses to contact the SIP device; it is typically the same as the user name from which the SIP user registered, but may be different if the user is connecting through a firewall.
|
Contact IP address
|
Read only
|
The contact IP address with which the SIP device registered. This is an IPv4 address.
|
Contact IP port
|
Read only
|
The contact IP port number (0 - 65535) with which the SIP device registered.
|
Transport protocol
|
Read only
|
The transport protocol used to send SIP requests to the registered SIP subscriber. Values:
|
Contact expiry time
|
Read only
|
The expiry time (UTC timestamp) of the registration. The SIP phone must re-register before this expiry time to continue communications; if it does not, the NE deletes this Registered SIP Binding when the specified time expires.
|
User agent information
|
Read only
|
An optional text string describing the SIP device (for example the manufacturer's name, model or version number, and/or operating system platform). This is supplied by the SIP device during registration.
|
Media Gateway model
|
Read only
|
The Remote Media Gateway model used by this Registered SIP Binding.
The model may be configured explicitly (or through a Persistent Profile) for the subscriber using this binding. If no model is configured, but there is a Remote Media Gateway Model with a name that is a prefix match for the supplied User agent information, the user agent uses this model; otherwise it uses the Remote Media Gateway Model that is configured as the default for SIP.
|
Message Waiting Indicator status
|
Read only
|
Specifies whether the registered SIP device expects Message Waiting Indicator (MWI) notifications. Values:
- Service not configured for subscriber
The SIP subscriber is not configured to use MWI, so the device will not receive MWI notifications.
- Unsolicited notifications
The SIP device expects to receive MWI as unsolicited notifications (this is configured in the Remote Media Gateway Model).
- Registered for notifications
The SIP device has registered to receive MWI notifications.
- Not registered for notifications
The SIP device has not registered to receive MWI notifications and does not support unsolicited notifications, so the device will not receive MWI notifications.
|
Call Service notification status
|
Read only
|
Specifies whether the registered SIP device expects Call Service notifications. This allows a device such as a Personal Communication Manager to take account of the subscriber's call service status. At present the only service for which notifications are provided is Do Not Disturb. Values:
- Service not configured for subscriber
The subscriber does not use any Call Services that generate notifications, so the device will not receive any Call Service notifications.
- Registered for notifications
The SIP device has indicated in the SIP REGISTER request that it wants to receive Call Service notifications.
- Not subscribed to notifications
The SIP device has not registered to receive Call Service notifications, so it will not receive them.
|
Call List status
|
Read only
|
Specifies whether the registered SIP device is registered for Call List status notifications. Values:
- Not supported
- Registered for notifications
- Not registered for notifications
- Unsolicited notifications
|
Number of event subscriptions
|
Read only
|
This field is not used in the current version of the MetaSwitch NE, but is included for future support.
|
Cause of last call failure
|
Read only
|
The error cause for the most recent failure of a SIP call using this Registered SIP Binding. Possible values:
- No failure
No call failure has occurred since this subscriber registered.
- Call redirected
The call could not be completed because the subscriber's SIP device (or a proxy) reported that the subscriber has moved. This may be caused by a misconfiguration on the subscriber's SIP device or elsewhere in the subscriber's IP network.
- SIP authorization failed
The authorization data supplied by the subscriber's SIP device was incorrect. There may be additional information in the error log identified by the Call failure log correlator field.
- Subscriber Busy
The SIP subscriber was successfully contacted, but is not accepting calls at this time.
- Invalid SIP address
The SIP address specified for this subscriber is not valid. This may be because the subscriber's configuration has been changed in the EMS.
- Unsupported SIP REGISTER query
The NE received a SIP message of a type that it does not support. This may be caused by a misconfiguration on the subscriber's SIP device.
- REGISTER expiry interval too brief
A SIP phone has tried to register with the NE, but suggested an expiry period for the registration that was too short. This may be caused by a misconfiguration on the subscriber's SIP device.
- Invalid or missing SDP body
The NE received a SIP request that contained an incorrect or missing description of the media requirements for the call. This may be caused by a misconfiguration on the subscriber's SIP device.
- Maximum call appearance limit reached
The SIP subscriber has reached the maximum number of simultaneous calls.
- No contact IP address registered
The SIP subscriber has not registered a valid SIP contact IP address, or the expiry time of the registered address has passed. No calls can be made from or to the subscriber until the subscriber has re-registered.
This may be a transient problem. If it persists, the subscriber's SIP device may be switched off or disconnected, or there may be errors in the IP network to which the subscriber's SIP device is connected. There may be additional information in the error log identified by the Call failure log correlator field.
- SIP authorization error
The authentication parameters did not match those supplied on the original challenge. This may be the result of a misconfigured or incompatible SIP device.
- SIP registration in progress
A SIP registration request was rejected because the NE is already processing a registration request for this SIP subscriber. The NE will continue to process the original registration request.
- Media renegotiation failed
The subscriber's SIP device was unable to fulfil a request to renegotiate the media in the call. This may be caused by an incompatible SIP device, or by transient conditions on the subscriber's IP network.
- Subscriber not contactable
The subscriber's SIP device may be switched off or disconnected; there may be errors in the IP network to which the subscriber's SIP device is connected; or the SIP subscriber may have registered an incorrect contact IP address. There may be additional information in the error log identified by the Call failure log correlator field.
- Unspecified
The call failed for a reason other than those above. See the log message identified by Call failure log correlator for additional information about the error.
|
Time of last call failure
|
Read only
|
Timestamp at which the most recent call failure occurred.
|
Call failure log correlator
|
Read only
|
Identifier of the log message for the event that caused the last call failure.
|
Current number of media streams in use
|
Read only
|
Current number of bi-directional RTP media streams (RTP terminations) in use on this Registered SIP Binding.
|
Current number of high bandwidth media streams in use
|
Read only
|
Current number of high bandwidth bi-directional RTP media streams (RTP terminations) in use on this Registered SIP Binding.
|