CallObject.stateChangeHandler Callback Property

Definition

This method is called whenever this object's state changes. If you pass the name of a user-defined function to CallObject.stateChangeHandler, the function will be called whenever the call state changes.

Compatibility

This callback is compatible with scripts for Scripter .NET Client or Interaction Connect.

Syntax

CallObject.stateChangeHandler(StateId, StateString)

Usage

Read       Yes

Write       Yes

Return Values

StateId

StateID is a number that represents the new call state of the object being watched.

Call State	String  Value
Alerting	1
Connected	105
Dialing	103
Disconnected	106
Initializing	100
ManualDialing	102
Offering	101
OnHold	6
Proceeding	104
StationAudio	107

StateString

StateString is a string that describes the call state:

StateString	Description
Initalizing	CIC is formatting the telephone number and looking for a line on which to place the outbound call. This state applies to inbound and outbound calls.
Offering	The call has been placed in a queue, but the call is not alerting. CIC is determining if the called party is available to take the call. This state applies to inbound calls only.
Dialing	CIC is dialing the remote telephone number. This state applies to outbound calls only.
Proceeding	The call is proceeding through the outside telephone network. ‘Proceeding' is used if a CIC client user has enabled Call Analysis. This state applies to outbound calls only.
Connected	Both parties are connected and are able to speak with each other. This state applies to inbound and outbound calls.
On Hold	The call is on hold. This state applies to inbound and outbound calls.
Disconnected	The call is no longer active. This state applies to inbound and outbound calls.
Manual Dialing	A telephone handset has been picked up and a dial tone is being generated. This state applies to outbound calls.
Station Audio	An audio clip is being played to one or more CIC client users.
Alerting	A CIC client user is being notified that he or she has an incoming call. This state applies to inbound calls.

Variables

Function Pointer

A function pointer is the address in memory where a user-defined function is loaded. Function pointers pass the address of a user-defined function to another function declared within an application. In a script, the function pointer is simply the name of the function. For example, if your code contains a function named "foo", the function pointer would also be named "foo".

When defining your custom function, you should declare StateID and StateString as arguments. e.g.: function foo(StateID, StateString).