S events

Last Updated : Aug 27, 2015 |

S events are sent when a call is first created and any part of the call changes state. The format of an S event is: CALL: S <field1>,<field2>, …<field50>.

All the information is provided in the character string. Therefore, numbers are represented in ASCII form. All numbers are integers and do not contain a decimal point. Each string can have a maximum length of 128 characters.

Table 1: S events
Note:

Events marked as reserved might contain information, but their contents and meaning change between IP Office core software releases.

Field

Event name

Type

Description

1

A call ID

String

Call ID for the A end of the call.

2

B calld ID

String

Call ID for the B end of the call.

3

Astate

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

4

Bstate

Number

State of the B end of the call. If there is no B end, this will be 0 (Idle).

5

Aconnected

Number

0 indicates not connected to the switch if receiving a dial tone.

6

A is music

Number

Indicates whether the A end of the call is listening to music on hold.

7

Bconnected

Number

0 indicates not connected to the switch if receiving a dial tone.

8

B is music

Number

Indicates whether the B end of the call is listening to music on hold.

9

Aname

String

Name of the A end of the call. The format of this string is:

  • For extensions: Name (Number)

  • For trunks: Line number

10

Bname

String

Name of the B end of the call. The format of this string is:

  • For extensions: Name (Number)

  • For trunks: Line number

11

Blist

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.

12

Aslot Achannel

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.

13

Bslot Bchannel

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.

14

Called party presentation and type

String

The two numbers in this field are:

  1. An indicator of how the called party details should be presented.

  2. The type of data to be found in the called party number field.

The format of the string is Number.Number. For more information on presentation and type, see Called party presentation and type.

15

Called party number

String

The identifier or number of the called party.

16

Calling party presentation & type

String

The two numbers are:

  1. An indicator of how the calling party details should be presented.

  2. The type of data to be found in the calling party number field.

The format of the string is Number.Number.

17

Calling party number

String

The identifier or number of the calling party.

18

Called sub address

String

The sub address of the called party.

19

Calling sub address

String

The sub address of the calling party.

20

Dialled party type

Number

The type of data to be found in the dialled party number field.

21

Dialled party number

String

The identifier or number of the dialled party.

22

Keypad type

Number

The type of data to be found in the keypad number field.

23

Keypad number

String

The dialled digits.

24

Ring attempt count

Number

The number of times this call has been presented to a target.

25

Cause

Number

The reason the call is in the current state.

26

Voice mail disallow

Number

1 if the call cannot divert to voice mail.

27

Sending complete

Number

1 if overlap dialling is complete.

28

Call type and Transport type

String

The two numbers are:

  1. Call type, for example, speech, video.

  2. Transport type (0=circuit and 2=packet).

The format of the string is Number.Number.

29

Owner hunt group name

String

The name of the hunt group where the call is currently queued.

30

Original hunt group name

String

The name of the hunt group where the call was originally targeted.

31

Original user name

String

The name of the user where the call was originally targeted.

32

Target hunt group name

String

The name of the hunt group where the call has been targeted.

33

Target user name

String

Name of user to which the call is being targeted.

34

Target RAS name

String

The name of the internal port where the call is being targeted.

35

IsInternalCall

Number

1 the call is internal, otherwise 0.

36

Time stamp

String

The time the call was created (internal tick count).

37

Connected time

Number

The time the call was connected.

38

Ring time

Number

The time the call started ringing.

39

Connected duration

Number

The duration the call has been connected or was connected for.

40

Ring duration

Number

The duration the call has been ringing or was ringing for.

41

Locale

String

Locale identifier (same as the locale setting in Manager).

42

ParkslotNumber

String

When the call is parked, the B end is undefined, and this field contains the park slot number.

43

Call waiting

String

1 if the call is a call waiting call.

44

Tag

String

Contains the tag that may be applied through TAPI, voice mail Pro, or SoftConsole.

45

Transferring

Number

Non-zero indicates that the call is being transferred.

46

Service active

Number

Non-zero if the service is active.

47

Service quota used

Number

Non-zero if the service quota is used.

48

Service quota time

Number

The service quota time.

49

Account code

String

The account code of the call.

50

CallID

Number

Unique call ID.

Table 2: List of cause codes

Field

Cause code

Description

0

CMCauseUnknown

-

1

CMCauseUnallocatedNumber

The number is not in the dial plan.

2

CMCauseForceIdle

Force clear down unconditionally.

3

CMCauseUnregister

Indicate the operation is for unregistration procedure.

16

CMCauseNormal

-

17

CMCauseBusy

The call target is busy.

18

CMCauseNoUserResponding

-

21

CMCauseCallRejected

The call has not been permitted (call barring).

31

CMCauseNormalUnspecified

-

34

CMCauseNoChannel

There is no available external line.

38

CMCauseNetworkOOO

Problem with the external network.

88

CMCauseIncompatible

-

113

CMCausePhoneInfo

-

114

CMCauseReminderFree

The call has returned because it was parked against a busy extension that is free now.

115

CMCauseReminderNoAns

The call has returned because it was not answered within the transfer return time-out.

116

CMCauseE911Emergency

-

117

CMCauseParked

-

118

CMCauseUnParked

-

119

CMCausePickup

-

120

CMCauseReminder

A held or parked call is returning due to a hold or park time-out.

121

CMCauseRedirect

The call has been redirected.

122

CMCauseCallBarred

The call was barred.

123

CMCauseForwardToVoicemail

The call has been forwarded to voice mail.

124

CMCauseAnsweredByOther

The call has been answered by someone else.

125

CMCauseNoAccountCode

The call has not been allowed because a valid account code has not been provided.

126

CMCauseTransfer

The call has been transferred.

127

CMCauseConferencingMove

The call has been placed into a conference.

128

CMCauseRestrictedToPartner

-

129

CMCauseHeldCall

-

130

CMRingBackCheck

-

131

CMCauseAppearanceCallSteal

The call was answered on an appearance button on another phone.

132

CMCauseAppearanceBridgeInto

-

133

CMCauseBumpedCall

The call is no longer the primary call. The call is now a waiting call.

134

CMCauseLineAppearanceCall

-

135

CMCauseUnheldCall

-

136

CMCauseReplaceCurrentCall

-

137

CMCauseGlare

-

138

CMCauseR21CompatConfMove

The call has been placed into a conference.