Interaction Proxy [DRAFT]
Interaction Proxy (or I-Proxy) is a SIP Server module that provides an interface to SIP Server clients to monitor calls and load balance interaction events on a given SIP Server node.
Configuration
Interaction Proxy listening port is configured in the SIP Server Application > Server Info.
The following configuration options can be configured, as necessary, in the InteractionProxy section of the SIP Server Application:
AttributeExtensions keys
SIP Server supports the following key-value pairs in AttributeExtensions of TPrivateService requests: ClusterId, NodeId, UdataFilter, and SessionId.
ClusterId—The unique identifier of the cluster.
NodeId—The unique identifier of the node within the cluster.
UdataFilter—A key-value list of User Data keys in the following format:
key-<%d> <key value>
where %d is the key’s sequential number starting from 1 and key value is the value of the key in a string format.
If UdataFilter is missing, no filter is used. If the UdataFilter list is empty, the entire User Data is filtered out.
SessionId—The client-generated ID of the client session.
InteractionSnapshot—When set to true (the default), provides clients with active interaction snapshots of the session start/reset. When set to false, no interaction snapshots are sent to clients.
SequenceId—A zero-padded 16-digit sequence number of the last received event in a string format. If SequenceId is specified, I-Proxy re-sends events with the next SequenceId when the session resumes. If it is not specified, I-Proxy sends all cached events when the session resumes.
SIP Server supports the following key-value pairs in AttributeExtensions of EventACK messages:
Important! In the EventACK response to a client registration request, I-Proxy specifies the number of events that are currently stored in cache (events-in-cache) and status of the session (session-status) in AttributeExtensions.
events-in-cache—The number of events that are stored in cache.
session-status—Values: reset, resume. When set to reset, the session is reset; I-Proxy sends an interaction snapshot to a client node. When set to resume, the session is resumed; I-Proxy sends cached events to a client node.
Private Events
EventEndOfSnapshot—On client node registration when session is reset, I-Proxy sends a snapshot for active interactions to a client. I-Proxy sends EventPrivateInfo(MsgID=8210 EventEndOfSnapshot) after a snapshot for the last interaction had been sent to indicate the end of snapshot transmission.