GetCallStatus
Syntax
GetCallStatus(SampleManagementName As String, StationPropertiesXml As String, LastCallStatus As Long, StatusChangeTimeout As Long) As Long
Type
Method
Parameters
SampleManagementName
The name of the sample management DPM object used to access sample management parameters for the project.
StationPropertiesXml
The station properties as XML.
LastCallStatus
The last call status supplied so that the method can block until the status changes.
StatusChangeTimeout
The maximum time in seconds to wait for the status to change. Setting StatusChangeTimeout to 0 effectively returns the current status. When the InAsyncMode setting in the Phone Participants' web.config file is set to false, the StatusChangeTimeout parameter is passed as 0, otherwise the parameter is passed as 30 (seconds). For example:
<add key="InAsyncMode" value="true"/>
Return value
Current status
▪-1 if a call is in progress, which means that the command to dial has been sent to the dialer but the result (connected or terminated) has not yet been returned.
▪0 if a call is connected
▪A dialer call outcome if the call has been terminated. The dialer call outcomes should match the return codes referenced in
Call outcome mapping.
Description
This method is used to detect changes in call status for an extension. By default, the method is polled every second, but it can be changed via the CheckCallConnectionStatusInterval setting in the Phone Participants' web.config file. For example:
<add key="CheckCallConnectionStatusInterval" value="1000"/>
Value is an integer that represents the interval (in milliseconds) between checks on the state of a dialer call connection. The setting only applies to projects that use a dialer. The minimum value 200; the maximum value 5000. The default value is 1000.
See also