TAPI - Obtaining information about a call¶
lineGetCallInfo() |
Obtain fixed information about a specified call |
SYNTAX
lineGetCallInfo(DeviceID)
This function enables an application to obtain fixed information about the specified call. The DeviceID is an integer containing the number of the line device to be queried, counting from 1 up to the total number of devices.
The tapiGetValue() function returns the value or values required, using the following form:
tapiGetValue(TAPI_VAR_CALL_INFO, value)
The function should be called once for each value required.
The values that may be returned are:
TAPI_FLD_LINE_DEVICE_ID |
Upon successful completion, returns an integer containing the device identifier of the line device with which this call is associated. |
TAPI_FLD_BEARER_MODE |
Upon successful completion, returns an integer containing the current bearer mode of the call. |
TAPI_FLD_RATE |
Upon successful completion, returns an integer containing the rate of the call’s data stream in bps (bits per second). |
TAPI_FLD_MEDIA_MODE |
Upon successful completion, returns an integer containing the media type of the information stream currently on the call. This is the media type as determined by the owner of the call. |
TAPI_FLD_NUM_OWNERS |
Upon successful completion, returns an integer containing the number of application modules with different call handles that have owner privilege for the call. |
TAPI_FLD_NUM_MONITORS |
Upon successful completion, returns an integer containing the number of application modules with different call handles that have monitor privilege for the call. |
TAPI_FLD_COUNTRY_CODE |
Upon successful completion, returns an integer containing the country code of the destination party. Zero if unknown. |
TAPI_FLD_CALLER_ID_FLAGS |
Upon successful completion, returns an integer containing the validity and content of the identifier information for the calling or originating party. |
TAPI_FLD_CALLER_ID |
Upon successful completion, returns a string containing the caller party ID number information. |
TAPI_FLD_CALLER_ID_NAME |
Upon successful completion, returns a string containing the caller party ID name information. |
TAPI_FLD_CALLED_ID_FLAGS |
Upon successful completion, returns an integer containing the validity and content of the called-party ID information. |
TAPI_FLD_CALLED_ID |
Upon successful completion, returns a string containing the called-party ID number information. |
TAPI_FLD_CALLED_ID_NAME |
Upon successful completion, returns a string containing the called-party ID name information. |
TAPI_FLD_APP_NAME |
Upon successful completion, returns a string containing the user-friendly application name of the application that first originated, accepted, or answered the call. |
EXAMPLE
!temp tmpCallerID,,a128[MAX_DEV]
tmp.RC = lineGetCallInfo(DevID)
tmp.CallerID = tapiGetValue(TAPI_VAR_CALL_INFO, TAPI_FLD_CALLER_ID)
RELATED TOPICS |