S Events - Avaya IP Office CTI Link Programmer's Manual

Printed Documentation

S events

S events are sent whenever a call is first created, and whenever any part of the call changes state.
The format of an S event is as follows:
CALL: S <field1>,<field2>, ...<field50>
All of the information is provided in the character string. Thus, numbers are represented in ASCII form.
All numbers are integers, and do not contain a decimal point. Each string field has a maximum of 128
characters in length.
The field definitions are documented in the following table. Please note that fields marked as <reserved>
may contain information, but their contents and meaning will change between releases of the IP Office
core software.
Field Name
1 A call id
2 B calld id
3 Astate
4 Bstate
5 Aconnected
6 A is music
7 Bconnected
8 B is music
9 Aname
10 Bname
11 Blist
12 Aslot
Achannel
13 Bslot
Bchannel
14 Called party
presentation &
DevLink Programmer's Guide
IP Office CTI Link
Type Description
String Call id for the A end of the call
String Call id for the B end of the call
Number State of the A end of the call. Valid numbers are:
• 0 Idle
• 1 Ringing
• 2 Connected
• 3 Disconnected
• 4 Suspending
• 5 Suspended
• 6 Resuming
• 7 Dialling
• 8 Dialled
• 9 Local Dial
• 10 Queued
• 11 Parked
• 12 Held
• 13 Redialling
Number State of the B end of the call – see above for values. If there is
no B end, this will be 0 (Idle)
Number 0 indicates not connected to the switch (e.g. If receiving dialtone)
Number Indicates whether the A end of the call is listening to music on
hold
Number As in field 5 above, but for the B end
Number Indicates whether the B end of the call is listening to music on
hold
String Name of the A end of the call. The format of this string is:
For extensions: Name (Number)
For trunks: Line number
String As in field 9 above. If there is no B end, this will be empty.
String List of possible targets for the call. Targets are separated by
semicolons, and if there are more than four, the list is terminated
after 4 elements with an ellipsis.
String Aslot is the slot number of the A side of the call and is the identify
of the TDM trunk.
Achannel is the channel number within the Aslot.
The format of the string is "Number.Number".
String Bslot is the slot number of the B side of the call and is the identify
of the TDM trunk.
Bchannel is the channel number within the Bslot.
The format of the string is "Number.Number".
String This field contains two numbers: 1) an indicator of how the called
party details should be presented, and 2) the type of data to be
40DHB0002UKAD Issue 11a (14th June 2005)
Page 12