Devlink Real-Time Event Stream - Avaya IP Office CTI Link Programmer's Manual

DevLink Real-Time Event Stream

DevLink Real-Time Event Stream
Calls in IP Office are modelled as being a communications line between two end-points, called A and B
respectively. An A end is always present, but a B end may or may not be present, depending on the
state of the call (A and B are typically extensions or trunks, but they may also be connected to the voice
mail system or parked).
Three different types of real-time events are generated by DevLink. These are used to track the call
throughout its lifetime:
•
S events
S events give information on the status of a call. S events are generated when calls are first
created, answered, or the status of a device involved in the call changes.
•
D events
D events are generated when the call is completed or abandoned. They indicate that the call no
longer exists.
•
A events
A events are generated when one end of a call is connected to a line (such as an ISDN, QSig or
VoIP line) and the IP Office decides to swap the A end and the B end of the call. Examples of
when this may happen include;
• When a parked party hangs up,
• When an outgoing call is transferred,
• When a call is un-parked.
The format and information contained in these events are described in more detail below.
Applications request information real-time events by calling the DLRegisterCallDelta2() function after
they have connected to the IP Office system:
LONG PASCAL DLRegisterType2CallDeltas( HANDLE pbxh, CALLLOGEVENT cb );
This registers a function provided by the application, of type CALLLOGEVENT, which will be called by
DevLink whenever a real-time event is generated.
typedef void (CALLBACK * CALLLOGEVENT)(
LONG pbxh,
TEXT * info
);
The two parameters (pbxh and info) are provided to the application. The pbxh parameter is the identifier
that was used in the call to DLOpen() and can be used to identify the system when the application is
connected to multiple IP Office systems.
The second parameter is a string, containing the call record. The call record is a comma-separated
string, with variable width fields. The string will always be less than 1500 bytes in length inclusive of a
terminating NULL character.
DevLink Programmer's Guide
IP Office CTI Link 40DHB0002UKAD Issue 11a (14th June 2005)
Page 11