Platform SDK: TAPI

Session Information

Session operations require a variety of information. For example, before an application attempts to perform a transfer, it must verify that service providers involved support that operation.

TAPI 2 applications primarily use the lineGetCallInfo function to access session information. Additional functions which manipulate session information are lineGetCallStatus, lineSetCallParams, lineSetCallData, lineSetCallTreatment, lineSetCallPrivilege, lineGetCallStatus, and lineSendUserUserInfo.

TAPI 3 applications use the ITCallInfo interface to access session information.

Information TAPI 2 TAPI 3
Address type for a session lineGetCallInfo, dwAddressType member of LINECALLINFO ITCallInfo::get_CallInfoLong, called with the CIL_CALLERIDADDRESSTYPE, CIL_CALLEDIDADDRESSTYPE, or CIL_CONNECTEDIDADDRESSTYPE member of CALLINFO_LONG.
Application-specific information lineGetCallInfo, dwAppSpecific member of LINECALLINFO

lineSetAppSpecific

ITCallInfo::get_CallInfoLong or ITCallInfo::put_CallInfoLong, called with the CIL_APPSPECIFIC member of CALLINFO_LONG.
Bearer mode lineGetCallInfo, dwBearerMode member of LINECALLINFO

lineSetCallParams

ITCallInfo::get_CallInfoLong or ITCallInfo::put_CallInfoLong, called with the CIL_BEARERMODE member of CALLINFO_LONG.
Call data buffer lineGetCallInfo, dwCallDataSize and dwCallDataOffset members of LINECALLINFO

lineSetCallData

ITCallInfo::GetCallInfoBuffer, called with the CIB_CALLDATABUFFER member of CALLINFO_BUFFER
Call ID lineGetCallInfo, dwCallID member of LINECALLINFO ITCallInfo::get_CallInfoLong, called with the CIL_CALLID member of CALLINFO_LONG.
Called Identification lineGetCallInfo with dwCalledIDSize, dwCalledIDOffset, dwCalledIDNameSize, dwCalledIDNameOffset, and dwCallDataOffset members of LINECALLINFO ITCallInfo::get_CallInfoString or ITCallInfo::put_CallInfoString, called with the CIS_CALLINGPARTYID member of CALLINFO_STRING.
Called party friendly name NA ITCallInfo::get_CallInfoString or ITCallInfo::put_CallInfoString, called with the CIS_CALLEDPARTYFRIENDLYNAME member of CALLINFO_STRING.
Caller Identification lineGetCallInfo with dwCallerIDSize, dwCallerIDOffset, dwCallerIDNameSize, and dwCallerIDNameOffset, members of LINECALLINFO ITCallInfo::get_CallInfoString, called with the CIS_CALLERIDNAME, CIS_CALLERIDNUMBER, CIS_CALLEDIDNAME, or CIS_CALLEDIDNUMBER member of CALLINFO_STRING.
CallHub interface pointer NA ITCallInfo::get_CallHub

ITTAPI::EnumerateCallHubs

Charging information lineGetCallInfo, dwChargingInfoSize and dwChargingInfoOffset members of LINECALLINFO. ITCallInfo::GetCallInfoBuffer, called with the CIB_CHARGINGINFOBUFFER member of CALLINFO_BUFFER
Comment lineGetCallInfo, dwCommentSize and dwCommentOffset members of LINECALLINFO. ITCallInfo::get_CallInfoString or ITCallInfo::put_CallInfoString, called with the CIS_COMMENT member of CALLINFO_STRING.
Compatibility buffer lineGetCallInfo, dwHighLevelCompSize, dwHighLevelCompOffset, dwLowLevelCompSize, or dwLowLevelCompOffset members of LINECALLINFO. ITCallInfo::GetCallInfoBuffer, called with the CIB_HIGHLEVELCOMPATIBILITYBUFFER or CIB_LOWLEVELCOMPATIBILITYBUFFER member of CALLINFO_BUFFER
Completion ID lineGetCallInfo, dwCompletionID member of LINECALLINFO ITCallInfo::get_CallInfoLong, called with the CIL_COMPLETIONID member of CALLINFO_LONG.
Connected Identification lineGetCallInfo, dwConnectedIDSize, dwConnectedIDOffset, dwConnectedIDNameSize, or dwConnectedIDNameOffset member of LINECALLINFO ITCallInfo::get_CallInfoString, called with the CIS_CONNECTEDIDNAME or CIS_CONNECTEDIDNUMBER member of CALLINFO_STRING.
Country code lineGetCallInfo,dwCountryCode member of LINECALLINFO ITCallInfo::get_CallInfoLong or ITCallInfo::put_CallInfoLong, called with the CIL_COUNTRYCODE member of CALLINFO_LONG.
Device-specific buffer lineGetCallInfo, dwDevSpecificSize and dwDevSpecificOffset members of LINECALLINFO ITCallInfo::GetCallInfoBuffer, called with the CIB_DEVSPECIFICBUFFER member of CALLINFO_BUFFER
Displayable address lineGetCallInfo, dwDisplayableAddressSize and dwDisplayableAddressOffset members of LINECALLINFO ITCallInfo::get_CallInfoString or ITCallInfo::put_CallInfoString, called with the CIS_DISPLAYABLEADDRESS member of CALLINFO_STRING.
Media type for a session lineGetCallInfo, dwMediaMode member of LINECALLINFO ITCallInfo::get_CallInfoLong, called with the CIL_MEDIATYPESAVAILABLE member of CALLINFO_LONG.
Origin lineGetCallInfo, dwOrigin member of LINECALLINFO ITCallInfo::get_CallInfoLong, called with the CIL_ORIGIN member of CALLINFO_LONG.
Parameter flags lineGetCallInfo, dwCallParamFlags member of LINECALLINFO

lineSetCallParams

ITCallInfo::get_CallInfoLong or ITCallInfo::put_CallInfoLong, called with the CIL_CALLPARAMSFLAGS member of CALLINFO_LONG.
Privilege lineGetCallStatus,dwCallPrivilege member of LINECALLSTATUS

lineSetCallPrivilege

ITCallInfo::get_Privilege or ITCallInfo::get_CallInfoLong, called with the CIL_NUMBEROFOWNERS or CIL_NUMBEROFMONITORS member of CALLINFO_LONG.
Quality of Service lineSetCallQualityOfService, lineGetCallInfo, dwSendingFlowspecSize, dwSendingFlowspecOffset, dwReceivingFlowspecSize, and dwReceivingFlowspecOffset members of LINECALLPARAMS ITBasicCallControl::SetQOS, ITQOSEvent
Rate lineGetCallInfo, dwRate member of LINECALLINFO

lineSetCallParams

ITCallInfo::get_CallInfoLong or ITCallInfo::put_CallInfoLong, called with the CIL_MAXRATE, CIL_MINRATE, or CIL_RATE member of CALLINFO_LONG.
Reason lineGetCallInfo, dwReason member of LINECALLINFO ITCallInfo::get_CallInfoLong, called with the CIL_REASON member of CALLINFO_LONG.
Redirect Identifcation lineGetCallInfo, dwRedirectionIDSize, dwRedirectionIDOffset, dwRedirectionIDNameSize, dwRedirectionIDNameOffset, dwRedirectingIDSize, dwRedirectingIDOffset, dwRedirectingIDNameSize, or dwRedirectingIDNameOffset member of LINECALLINFO ITCallInfo::get_CallInfoString called with the CIS_REDIRECTIONIDNAME, CIS_REDIRECTIONIDNUMBER, CIS_REDIRECTINGIDNAME, or CIS_REDIRECTINGIDNUMBER member of CALLINFO_STRING.
State lineGetCallStatus,dwCallState member of LINECALLSTATUS. ITCallInfo::get_CallState
Treatment lineGetCallInfo, dwCallTreatment member of LINECALLINFO

lineSetCallTreatment

ITCallInfo::get_CallInfoLong or ITCallInfo::put_CallInfoLong, called with the CIL_CALLTREATMENT member of CALLINFO_LONG.
Trunk lineGetCallInfo, dwTrunk member of LINECALLINFO ITCallInfo::get_CallInfoLong, called with the CIL_TRUNK member of CALLINFO_LONG.
User/user information lineGetCallInfo, dwCallDataSize and dwCallDataOffset members of LINECALLINFO

lineSendUserUserInfo

ITCallInfo::GetCallInfoBuffer, called with the CIB_USERUSERINFO member of CALLINFO_BUFFER and ITCallInfo::ReleaseUserUserInfo.