Cisco Unified TAPI Developers Guide for Cisco Unified Communications Manager Release 7.0(1)
Cisco Device-Specific Extensions
Downloads: This chapterpdf (PDF - 465.0KB) The complete bookPDF (PDF - 8.21MB) | Feedback

Cisco Device-Specific Extensions

Table Of Contents

Cisco Device-Specific Extensions

Cisco Line Device Specific Extensions

LINEDEVCAPS

Detail

Parameters

LINECALLINFO

Details

Parameters

LINEDEVSTATUS

Detail

Parameters

CCiscoLineDevSpecific

Header File

Class Detail

Functions

Parameter

Subclasses

Enumeration

Message Waiting

Class Detail

Parameters

Message Waiting Dirn

Class Detail

Parameters

Audio Stream Control

Class Detail

Parameters

Set Status Messages

Class Detail

Parameters

Swap-Hold/SetupTransfer

Class Details

Parameters

Redirect Reset Original Called ID

Description

Class Details

Parameters

Port Registration per Call

Class Details

Parameters

Setting RTP Parameters for Call

Class Details

Parameters

Redirect Set Original Called ID

Class Details

Parameters

Join

Class Details

Parameters

Set User SRTP Algorithm IDs

Class Detail

Supported Algorithm Constants

Parameters

Explicit Acquire

Class Details

Parameters

Explicit De-Acquire

Class Details

Parameters

Redirect FAC CMC

Class Detail

Parameters

Blind Transfer FAC CMC

Class Detail

Parameters

CTI Port Third Party Monitor

Class Detail

Parameters

Send Line Open

Class Detail

Set Intercom SpeedDial

Class Detail

Parameters

Intercom Talk Back

Class Detail

Redirect with Feature Priority

Detail

Parameters

Start Call Monitoring

Class Detail

Parameters

Return Values

Start Call Recording

Class Detail

Parameters

Return Values

StopCall Recording

Class Detail

Parameters

Return Values

Cisco Line Device Feature Extensions

LINEDEVCAPS

LINEDEVSTATUS

CCiscoLineDevSpecificFeature

Header File

Class Detail

Functions

Parameter

Subclasses

Do-Not-Disturb

Class Detail

Parameters

Do-Not-Disturb Change Notification Event

Message Details

Parameters

Cisco Phone Device-Specific Extensions

CCiscoPhoneDevSpecific

Header File

Class Detail

Functions

Parameter

Subclasses

Enumeration

CCiscoPhoneDevSpecificDataPassThrough

Class Detail

Parameters

CCiscoPhoneDevSpecificAcquire

Class Details

Parameters

CCiscoPhoneDevSpecificDeacquire

Class Details

Parameters

CCiscoPhoneDevSpecificGetRTPSnapshot

Class Details

Parameters

Messages

Start Transmission Events

Start Reception Events

Stop Transmission Events

Stop Reception Events

Existing Call Events

Open Logical Channel Events

LINECALLINFO_DEVSPECIFICDATA Events

Call Tone Changed Events


Cisco Device-Specific Extensions


This chapter describes the Cisco device-specific TAPI extensions. CiscoLineDevSpecific and the CCiscoPhoneDevSpecific class represent the parent class. This chapter describes how to invoke the Cisco device-specific TAPI extensions with the lineDevSpecific function. It also describes a set of classes that you can use when you call phoneDevSpecific. It contains the following sections:

Cisco Line Device Specific Extensions

Cisco Line Device Feature Extensions

Cisco Phone Device-Specific Extensions

Messages

Cisco Line Device Specific Extensions

Table 6-1 lists the subclasses of Cisco Line Device-Specific Extensions. This section contains all of the extensions in the table and descriptions of the following:

LINEDEVCAPS

LINECALLINFO

LINEDEVSTATUS

Table 6-1 Cisco Line Device-Specific Extensions 

Cisco Functions
Synopsis

CCiscoLineDevSpecific

The CCiscoLineDevSpecific class specifies the parent class to the following classes.

Message Waiting

The CCiscoLineDevSpecificMsgWaiting class turns the message waiting lamp on or off for the line that the hLine parameter specifies.

Message Waiting Dirn

The CCiscoLineDevSpecificMsgWaiting class turns the message waiting lamp on or off for the line that a parameter specifies and remains independent of the hLine parameter.

Audio Stream Control

The CCiscoLineDevSpecificUserControlRTPStream class controls the audio stream for a line.

Set Status Messages

The CCiscoLineDevSpecificSetStatusMsgs class controls the reporting of certain line device specific messages for a line. The application receives LINE_DEVSPECIFIC messages to signal when to stop and start streaming RTP audio.

Swap-Hold/SetupTransfer

Cisco Unified TSP 4.0 and higher do not support this function.
The CCiscoLineDevSpecificSwapHoldSetupTransfer class performs a setupTransfer between a call that is in CONNECTED state and a call that is in ONHOLD state. This function will change the state of the connected call to ONHOLDPENDTRANSFER state and the ONHOLD call to CONNECTED state. This action will then allow a completeTransfer to be performed on the two calls.

Redirect Reset Original Called ID

The CCiscoLineDevSpecificRedirectResetOrigCalled class gets used to redirects a call to another party while resetting the original called ID of the call to the destination of the redirect.

Port Registration per Call

The CciscoLineDevSpecificPortRegistrationPerCall class gets used to register a CTI port or route point for the Dynamic Port Registration feature, which allows applications to specify the IP address and UDP port number on a call-by-call basis.

Setting RTP Parameters for Call

The CciscoLineDevSpecificSetRTPParamsForCall class sets the IP address and UDP port number for the specified call.

Redirect Set Original Called ID

Use the CciscoLineDevSpecificSetOrigCalled class to redirect a call to another party while setting the original called ID of the call to any other party.

Join

Use the CciscoLineDevSpecificJoin class to join two or more calls into one conference call.

Set User SRTP Algorithm IDs

Use the CciscoLineDevSpecificUserSetSRTPAlgorithmID class to allow application to set SRTP algorithm IDs. You should use this class after lineopen and before CCiscoLineDevSpecificSetRTPParamsForCall or CCiscoLineDevSpecificUserControlRTPStream

Explicit Acquire

Use the CciscoLineDevSpecificAcquire class to explicitly acquire any CTI Controllable device in the Cisco Unified Communications Manager system, which needs to be opened in Super Provider mode.

Explicit De-Acquire

Use the CciscoLineDevSpecificDeacquire class to explicitly de-acquire any CTI controllable device in the Cisco Unified Communications Manager system.

Redirect FAC CMC

Use the CCiscoLineDevSpecificRedirectFACCMC class to redirect a call to another party while including a FAC, CMC, or both.

Blind Transfer FAC CMC

Use the CCiscoLineDevSpecificBlindTransferFACCMC class to blind transfer a call to another party while including a FAC, CMC, or both.

CTI Port Third Party Monitor

Use the CCiscoLineDevSpecificCTIPortThirdPartyMonitor class to open a CTI port in third-party mode.

Send Line Open

Use the CciscoLineDevSpecificSendLineOpen class to trigger actual line open from TSP side. Use this for delayed open mechanism.

Start Call Monitoring

Use CCiscoLineDevSpecificStartCallMonitoringReq to allow applications to send a start monitoring request for the active call on a line.

Start Call Recording

Use CCiscoLineDevSpecificStartCallRecordingReq to allow applications to send a recording request for the active call on that line.

StopCall Recording

Use CCiscoLineDevSpecificStopCallRecordingReq to allow applications to stop recording a call on that line.

Set Intercom SpeedDial

Use the CciscoLineDevSpecificSetIntercomSpeedDial class to allow application to set or reset SpeedDial/Label on an intercom line.

Intercom Talk Back

Use the CCiscoLineDevSpecificTalkBack class to allow application to initiate talk back on a incoming Intercom call on a Intercom line.

Redirect with Feature Priority

Use the CciscoLineRedirectWithFeaturePriority class to enable anapplication to redirect calls with specified priority.


LINEDEVCAPS

Cisco TSP implements several line device-specific extensions and uses the DevSpecific (dwDevSpecificSize and dwDevSpecificOffset) variably sized area of the LINEDEVCAPS data structure for those extensions. The the Cisco_LineDevCaps_Ext structure in the CiscoLineDevSpecificMsg.h header file defines the DevSpecific area layout. Cisco TSP organizes the data in that structure based on the extension version in which the data was introduced:

//   LINEDEVCAPS Dev Specific extention   //
typedef struct Cisco_LineDevCaps_Ext
{
    Cisco_LineDevCaps_Ext00030000  ext30;
    Cisco_LineDevCaps_Ext00060000  ext60;
    Cisco_LineDevCaps_Ext00070000  ext70;
    Cisco_LineDevCaps_Ext00080000  ext80;
} CISCO_LINEDEVCAPS_EXT;

For a specific line device, the extension area will include a portion of this structure starting from the begining and up to the extension version that an application negotiated.

The individual extension version substructure definitions follow:

//    LINEDEVCAPS 00030000  extention    //
typedef struct Cisco_LineDevCaps_Ext00030000
{
    DWORD dwLineTypeFlags;
} CISCO_LINEDEVCAPS_EXT00030000; 
//    LINEDEVCAPS 00060000  extention    //
typedef struct Cisco_LineDevCaps_Ext00060000
{
	DWORD dwLocale;
} CISCO_LINEDEVCAPS_EXT00060000;
//    LINEDEVCAPS 00070000  extention    //
typedef struct Cisco_LineDevCaps_Ext00070000
{
    DWORD dwPartitionOffset; 
    DWORD dwPartitionSize; 
} CISCO_LINEDEVCAPS_EXT00070000;
//    LINEDEVCAPS  00080000  extention    //
typedef struct Cisco_LineDevCaps_Ext00080000
{
    DWORD                   dwLineDevCaps_DevSpecificFlags;        // 
LINEFEATURE_DEVSPECIFIC 
    DWORD                   dwLineDevCaps_DevSpecificFeatureFlags; // 
LINEFEATURE_DEVSPECIFICFEAT
    RECORD_TYPE_INFO        recordTypeInfo;
    INTERCOM_SPEEDDIAL_INFO intercomSpeedDialInfo;
} CISCO_LINEDEVCAPS_EXT00080000;

See the CiscoLineDevSpecificMsg.h header file for additional information on the DevSpecific structure layout and data.

Detail

A

typedef struct LineDevCaps_DevSpecificData
{
    DWORD m_DevSpecificFlags;
}LINEDEVCAPS_DEV_SPECIFIC_DATA;

Note Be aware that this extension is only available if extension version 3.0 (0x00030000) or higher is negotiated.


B

typedef  struct LocaleInfo
{
	DWORD Locale; //This will have the locale info of the device
	DWORD PartitionOffset;
DWORD PartitionSize; //This will have the partition info of the line.
} LOCALE_INFO;

Note Be aware that the Locale info is only available along with LINEDEVCAPS_DEV_SPECIFIC_DATA if extension version 6.0 (0x00060000) or higher is negotiated.


C

typedef  struct PartitionInfo
{
	DWORD PartitionOffset;
DWORD PartitionSize; //This will have the partition info of the line.
} PARTITION_INFO;

Note Be aware that both the Locale and Partition Info is available along with LINEDEVCAPS_DEV_SPECIFIC_DATA if extension version 6.1 (0x00060001) or higher is negotiated.


Parameters

DWORD m_DevSpecificFlags

A bit array that identifies device specific properties for the line. The bits definition follows:

LINEDEVCAPSDEVSPECIFIC_PARKDN (0x00000001)—Indicates whether this line is a Call Park DN.


Note Be aware that this extension is only available if extension version 3.0 (0x00030000) or higher is negotiated.


DWORD Locale

This identifies the locale information for the device. The typical values could be

enum
{
ENGLISH_UNITED_STATES	= 1,
FRENCH_FRANCE	= 2,
GERMAN_GERMANY	= 3,
RUSSIAN_RUSSIAN_FEDERATION	= 5,
SPANISH_SPAIN	= 6,
ITALIAN_ITALY	= 7,
DUTCH_NETHERLANDS	= 8,
NORWEGIAN_NORWAY	= 9,
PORGUGUESE_PORTUGAL	= 10,
SWEDISH_SWEDEN	= 11,
DANISH_DENMARK	= 12,
JAPANESE_JAPAN	= 13,
HUNGARAIN_HUNGARY	= 14,
POLISH_POLAND	= 15,
GREEK_GREECE	= 16,
CHINESE_TAIWAN 	= 19,
CHINESE_CHINA	= 20,
KOREAN_KOREA_REPUBLIC	= 21,
FINNISH_FINLAND	= 22,
PORTUGUESE_BRAZIL	= 23,
CHINESE_HONG_KONG	= 24,
SLOVAK_SLOVAKIA	= 25,
CZECH_CZECH_REPUBLIC	= 26,
BULGARIAN_BULGARIA	= 27,
CROATIAN_CROATIA	= 28,
SLOVENIAN_SLOVENIA	= 29,
ROMANIAN_ROMANIA	= 30,
CATALAN_SPAIN	= 32,
ENGLISH_UNITED_KINGDOM	= 33,
ARABIC_UNITED_ARAB_EMIRATES	= 35,
ARABIC_OMAN	= 36,
ARABIC_SAUDI_ARABIA	= 37,
ARABIC_KUWAIT	= 38,
HEBREW_ISRAEL	= 39,
SERBIAN_REPUBLIC_OF_SERBIA	= 40,
SERBIAN_REPUBLIC_OF_MONTENEGRO	= 41,
THAI_THAILAND	= 42,
ARABIC_ALGERIA	= 47,
ARABIC_BAHRAIN	= 48,
ARABIC_EGYPT	= 49,
ARABIC_IRAQ	= 50,
ARABIC_JORDAN	= 51,
ARABIC_LEBANON	= 52,
ARABIC_MOROCCO	= 53,
ARABIC_QATAR	= 54,
ARABIC_TUNISIA	= 55,
}

LINECALLINFO

Cisco TSP implements several line device-specific extensions and uses the DevSpecific (dwDevSpecificSize and dwDevSpecificOffset) variably sized area of the LINECALLINFO data structure for those extensions. The Cisco_LineCallInfo_Ext structure in the CiscoLineDevSpecificMsg.h header file defines DevSpecific area layout. Cisco TSP organizes the data in that structure based on the extension version in which the data was introduced:

//   LINECALLINFO Dev Specific extention   //
typedef struct Cisco_LineCallInfo_Ext
{
    Cisco_LineCallInfo_Ext00060000  ext60;
    Cisco_LineCallInfo_Ext00070000  ext70;
    Cisco_LineCallInfo_Ext00080000  ext80;
} CISCO_LINECALLINFO_EXT;

For a specific line device, the extension area will include a portion of this structure starting from the begining and up to the extension version that an application negotiated.

The individual extension version substructure definitions follow:

//    LINECALLINFO 00060000  extention    //
typedef struct Cisco_LineCallInfo_Ext00060000
{
    TSP_UNICODE_PARTY_NAMES  unicodePartyNames;
} CISCO_LINECALLINFO_EXT00060000; 
//    LINECALLINFO 00070000  extention    //
typedef struct Cisco_LineCallInfo_Ext00070000
{
    DWORD SRTPKeyInfoStructureOffset;   // offset from base of LINECALLINFO
    DWORD SRTPKeyInfoStructureSize;     // includes variable length data total size
    DWORD SRTPKeyInfoStructureElementCount;  
    DWORD SRTPKeyInfoStructureElementFixedSize;
    DWORD DSCPInformationOffset;        // offset from base of LINECALLINFO
    DWORD DSCPInformationSize;          // fixed size of the DSCPInformation structure
    DWORD DSCPInformationElementCount; 
    DWORD DSCPInformationElementFixedSize;	
    DWORD CallPartitionInfoOffset;      // offset from base of LINECALLINFO
    DWORD CallPartitionInfoSize;        // fixed size of the CallPartitionInformation 
structure
    DWORD CallPartitionInfoElementCount; 
    DWORD CallPartitionInfoElementFixedSize;
    DWORD ExtendedCallInfoOffset;       //  ===> ExtendedCallInfo { }
    DWORD ExtendedCallInfoSize;         //
    DWORD ExtendedCallInfoElementCount; //
    DWORD ExtendedCallInfoElementSize;  //
} CISCO_LINECALLINFO_EXT00070000;
//    LINEDEVCAPS  00080000  extention    //
typedef struct Cisco_LineDevCaps_Ext00080000
{
    DWORD                   dwLineDevCaps_DevSpecificFlags;        // 
LINEFEATURE_DEVSPECIFIC 
    DWORD                   dwLineDevCaps_DevSpecificFeatureFlags; // 
LINEFEATURE_DEVSPECIFICFEAT
    RECORD_TYPE_INFO        recordTypeInfo;
    INTERCOM_SPEEDDIAL_INFO intercomSpeedDialInfo;
} CISCO_LINEDEVCAPS_EXT00080000;
//    LINECALLINFO 00080001  extension    //
//    ---------------------------------
typedef struct Cisco_LineCallInfo_Ext00080001
{
    DWORD CPNInfoOffset;         //array of structure of CPNInfo structure
    DWORD CPNInfoSize;
    DWORD CPNInfoElementCount;
    DWORD CPNInfoElementFixedSize;
};

See the CiscoLineDevSpecificMsg.h header file for additional information on the DevSpecific structure layout and data.

Details

The TSP_Unicode_Party_names structure and SRTP info structure describe the device-specific extensions that have been made to the LINECALLINFO structure by the Cisco Unified TSP. DSCPValueForAudioCalls will contain the DSCP value that CTI sent in the StartTransmissionEvent.

ExtendedCallInfo structure will have extra call information. For Cisco Unified Communications Manager Release 7.0(1), the ExtendedCallReason field belongs to the ExtendedCallInfo structure.

CallAttributeInfo will contain the information about attributeType (Monitoring, Monitored, Recorder,securityStatus) and PartyInfo (Dn,Partition,DeviceName)

CCMCallID will contain CCM Call identifier value.

CallingPartyIPAddress will contain the IP address of the calling party if it is supported by the calling party device.

CallSecurityStatus structure will contain the overall security status of the call for two-party call as well as conference call.

DWORD TapiCallerPartyUnicodeNameOffset;
DWORD TapiCallerPartyUnicodeNameSize;
DWORD	TapiCallerPartyLocale;

DWORD TapiCalledPartyUnicodeNameOffset;
DWORD TapiCalledPartyUnicodeNameSize;
DWORD	TapiCalledPartyLocale;

DWORD TapiConnectedPartyUnicodeNameOffset;
DWORD TapiConnectedPartyUnicodeNameSize;
DWORD	TapiConnectedPartyLocale;

DWORD TapiRedirectionPartyUnicodeNameOffset;
DWORD TapiRedirectionPartyUnicodeNameSize;
DWORD	TapiRedirectionPartyLocale;

DWORD TapiRedirectingPartyUnicodeNameOffset;
DWORD TapiRedirectingPartyUnicodeNameSize;
DWORD	TapiRedirectingPartyLocale;

DWORD SRTPKeyInfoStructureOffset; 	// offset from base of LINECALLINFO
DWORD SRTPKeyInfoStructureSize;	// includes variable length data total size
DWORD SRTPKeyInfoStructureElementCount;  
DWORD SRTPKeyInfoStructureElementFixedSize;
DWORD DSCPValueInformationOffset;
DWORD DSCPValueInformationSize;
DWORD DSCPValueInformationElementCount;
DWORD DSCPValueInformationElementFixedSize;
DWORD PartitionInformationOffset; // offset from base of LINECALLINFO
DWORD PartitionInformationSize;  // includes variable length data total size
DWORD PartitionInformationElementCount;  
DWORD PartitionInformationElementFixedSize;
DWORD ExtendedCallInfoOffset;
DWORD ExtendedCallInfoSize;
DWORD ExtendedCallInfoElementCount;
DWORD ExtendedCallInfoElementSize;
DWORD CallAttrtibuteInfoOffset;
DWORD CallAttrtibuteInfoSize;
DWORD CallAttrtibuteInfoElementCount;
DWORD CallAttrtibuteInfoElementSize;
DWORD CallingPartyIPAddress;
DWORD CCMCallIDInfoOffset;
DWORD CCMCallIDInfoSize;
DWORD CCMCallIDInfoElementCount;
DWORD CCMCallIDInfoElementFixedSize;
DWORD CallSecurityStatusOffset;
DWORD CallSecurityStatusSize;
DWORD CallSecurityStatusElementCount;
DWORD CallSecurityStatusElementFixedSize;

typedef struct SRTPKeyInfoStructure
{
	SRTPKeyInformation TransmissionSRTPInfo;
	SRTPKeyInformation ReceptionSRTPInfo;
} SRTPKeyInfoStructure;

typedef struct SRTPKeyInformation
{
	DWORD	IsSRTPDataAvailable;
	DWORD	SecureMediaIndicator;	// CiscoSecurityIndicator
	DWORD	MasterKeyOffset;
	DWORD	MasterKeySize;
	DWORD	MasterSaltOffset;
	DWORD	MasterSaltSize;
	DWORD	AlgorithmID;			// CiscoSRTPAlgorithmIDs
	DWORD	IsMKIPresent;
	DWORD	KeyDerivationRate;
} SRTPKeyInformation;

enum CiscoSRTPAlgorithmIDs
{
	SRTP_NO_ENCRYPTION=0, 
	SRTP_AES_128_COUNTER=1 
};

enum CiscoSecurityIndicator
{
    SRTP_MEDIA_ENCRYPT_KEYS_AVAILABLE,
    SRTP_MEDIA_ENCRYPT_USER_NOT_AUTH,
    SRTP_MEDIA_ENCRYPT_KEYS_UNAVAILABLE,
    SRTP_MEDIA_NOT_ENCRYPTED
};

If isSRTPInfoavailable is set to false, applications should ignore the rest of the information from SRTPKeyInformation.

If MasterKeySize or MasterSlatSize is set to 0, applications should ignore the corresponding MasterKeyOffset or MasterSaltOffset.

typedef struct DSCPValueInformation
{
DWORD DSCPValueForAudioCalls;
}

typedef struct  PartitionInformation
{
DWORD CallerIDPartitionOffset;
DWORD CallerIDPartitionSize;
DWORD CalledIDPartitionOffset;
DWORD CalledIDPartitionSize;
DWORD ConnecetedIDPartitionOffset;
DWORD ConnecetedIDPartitionSize; 
DWORD RedirectionIDPartitionOffset;
DWORD RedirectionIDPartitionSize;
DWORD RedirectingIDPartitionOffset;
DWORD RedirectingIDPartitionSize;
} PartitionInformation;


Struct ExtendedCallInfo
{
DWORD ExtendedCallReason ;
DWORD CallerIDURLOffset;		// CallPartySipURLInfo
DWORD CallerIDURISize;
DWORD CalledIDURLOffset;		// CallPartySipURLInfo
DWORD CalledIDURISize;
DWORD ConnectedIDURIOffset;		// CallPartySipURLInfo
DWORD ConnectedIDURISize;
DWORD RedirectionIDURIOffset;		// CallPartySipURLInfo
DWORD RedirectionIDURISize;
DWORD RedirectingIDURIOffset;		// CallPartySipURLInfo
DWORD RedirectingIDURISize;
}

Struct CallPartySipURLInfo 
{
DWORD	dwUserOffset;  //sip user string
DWORD	dwUserSize;
DWORD	dwHostOffset; //host name string
DWORD	dwHostSize;
DWORD	dwPort;		// integer port number
DWORD	dwTransportType; 	// SIP_TRANS_TYPE
DWORD	dwURLType;		// SIP_URL_TYPE
}

enum {
        CTI_SIP_TRANSPORT_TCP=1,
        CTI_SIP_TRANSPORT_UDP,
        CTI_SIP_TRANSPORT_TLS
} SIP_TRANS_TYPE;

enum {
    CTI_NO_URL = 0,
    CTI_SIP_URL,
    CTI_TEL_URL 
} SIP_URL_TYPE;

typedef struct CallAttributeInfo
{
	DWORD CallAttributeType,
	DWORD PartyDNOffset,
	DWORD PartyDNSize,
	DWORD PartyPartitionOffset,
	DWORD PartyPartitionSize,
	DWORD DeviceNameOffset,
	DWORD DeviceNameSize,
}
typedef struct CCMCallHandleInformation
{
	DWORD CCMCallID;
}

enum CallAttributeType
{
 CallAttribute_Regular                    = 0,
 CallAttribute_SilentMonitorCall,  
 CallAttribute_SilentMonitorCall_Target,
 CallAttribute_RecordedCall
} ;

typedef struct CallSecurityStausInfo
{
	DWORD CallSecurityStaus
} CallSecurityStausInfo

enum OverallCallSecurityStatusValue
{  
   OverallCallSecurityStatus_Unknown
   OverallCallSecurityStatus_Nonsecure=0,
   OverallCallSecurityStatus_Secure
};
typedef struct CPNInfo
{
	DWORD CallerPartyNumberType;			//refer to CiscoNumberType
	DWORD CalledPartyNumberType;
	DWORD ConnectedIdNumberType;
	DWORD RedirectingPartyNumberType;
	DWORD RedirectionPartyNumberType;
            DWORD ModifiedCallingPartySize;
	DWORD ModifiedCallingPartyOffset;
	DWORD ModifiedCalledPartySize;
	DWORD ModifiedCalledPartyOffset;
	DWORD ModifiedConnectedIdSize;
	DWORD ModifiedConnectedIdOffset;
	DWORD ModifiedRedirectingPartySize;
	DWORD ModifiedRedirectingPartyOffset;
	DWORD ModifiedRedirectionPartySize;
	DWORD ModifiedRedirectionPartyOffset;
	DWORD GlobalizedCallingPartySize;
	DWORD GlobalizedCallingPartyOffset;
} CPNInfo;

enum CiscoNumberType {
    NumberType_Unknown  = 0,          // UNKNOWN_NUMBER
    NumberType_International  = 1,    // INTERNATIONAL_NUMBER
    NumberType_National  = 2,         // NATIONAL_NUMBER
    NumberType_NetSpecificNum  = 3,   // NET_SPECIFIC_NUMBER
    NumberType_Subscriber  = 4,       // SUBSCRIBER_NUMBER
    NumberType_Abbreviated  = 6       // ABBREVIATED_NUMBER
};

Parameters

Parameter
Value

TapiCallerPartyUnicodeNameOffset
TapiCallerPartyUnicodeNameSize

The size, in bytes, of the variably sized field that contains the Unicode Caller party identifier name informatio, and the offset, in bytes, from the beginning of the LINECALLINFO data structure

TapiCallerPartyLocale

The Unicode Caller party identifier name Locale information

TapiCalledPartyUnicodeNameOffset
TapiCalledPartyUnicodeNameSize

The size, in bytes, of the variably sized field that contains the Unicode Called party identifier name information and the offset, in bytes, from the beginning of the LINECALLINFO data structure

TapiCalledPartyLocale

The Unicode Called party identifier name locale information

TapiConnectedPartyUnicodeNameOffset
TapiConnectedPartyUnicodeNameSize

The size, in bytes, of the variably sized field that contains the Unicode Connected party identifier name information and the offset, in bytes, from the beginning of the LINECALLINFO data structure

TapiConnectedPartyLocale

The Unicode Connected party identifier name locale information

TapiRedirectionPartyUnicodeNameOffset
TapiRedirectionPartyUnicodeNameSize

The size, in bytes, of the variably sized field that contains the Unicode Redirection party identifier name information and the offset, in bytes, from the beginning of the LINECALLINFO data structure

TapiRedirectionPartyLocale

The Unicode Redirection party identifier name locale information

TapiRedirectingPartyUnicodeNameOffset
TapiRedirectingPartyUnicodeNameSize

The size, in bytes, of the variably sized field that contains the Unicode Redirecting party identifier name information and the offset, in bytes, from the beginning of the LINECALLINFO data structure

TapiRedirectingPartyLocale

The Unicode Redirecting party identifier name locale information

SRTPKeyInfoStructureOffset

Point to SRTPKeyInfoStructure

SRTPKeyInfoStructureSize

Total size of SRTP info

SRTPKeyInfoStructureElementCount

Number of SRTPKeyInfoStructure element

SRTPKeyInfoStructureElementFixedSize

Fixed size of SRTPKeyInfoStructure

SecureMediaIndicator

Indicates whether media is secure and whether application is authorized for key information

MasterKeyOffset
MasterKeySize

The offset and size of SRTP MasterKey information

MasterSaltOffset
MasterSaltSize

The offset and size of SRTP MasterSaltKey information

AlgorithmID

Specifies negotiated SRTP algorithm ID

IsMKIPresent

Indicates whether MKI is present

KeyDerivationRate

Provides the KeyDerivationRate

DSCPValueForAudioCalls

The DSCP value for Audio Calls

CallerIDPartitionOffset
CallerIDPartitionSize

The size, in bytes, of the variably sized field that contains the Caller party identifier partition information and the offset, in bytes, from the beginning of LINECALLINFO data structure

CalledIDPartitionOffset
CalledIDPartitionSize

The size, in bytes, of the variably sized field that contains the Called party identifier partition information and the offset, in bytes, from the beginning of LINECALLINFO data structure

ConnectedIDPartitionOffset
ConnecetedIDPartitionSize

The size, in bytes, of the variably sized field that contains the Connected party identifier partition information and the offset, in bytes, from the beginning of LINECALLINFO data structure

RedirectionIDPartitionOffset
RedirectionIDPartitionSize

The size, in bytes, of the variably sized field that contains the Redirection party identifier partition information, and the offset, in bytes, from the beginning of LINECALLINFO data structure

RedirectingIDPartitionOffset
RedirectingIDPartitionSize

The size, in bytes, of the variably sized field that contains the Redirecting party identifier partition information and the offset, in bytes, from the beginning of LINECALLINFO data structure

ExtendedCallReason

Presents all the last feature-related CTI Call reason code to the application as an extension to the standard reason codes that TAPI supports. This provides the feature-specific information per call. Because SIP phones are supported through CTI, new features can be introduced for SIP phones during releases. Be aware that this field will not be backward compatible and can change as changes or additions are made in the SIP phone support for a feature. Applications should implement some default behavior to handle any unknown reason codes that might be provided through this field.

For Refer, the reason code is CtiCallReason_Refer.

For Replaces, the reason code is CtiCallReason_Replaces.

CallerIDURLOffset
CallerIDURLSize

The size, in bytes, of the variably sized field that contains the Caller party identifier URL information and the offset, in bytes, from the beginning of LINECALLINFO data structure

CalledIDURLOffset
CalledIDURLSize

The size, in bytes, of the variably sized field that contains the Called party identifier URL information and the offset, in bytes, from the beginning of LINECALLINFO data structure

ConnectedIDURLOffset
ConnecetedIDURLSize

The size, in bytes, of the variably sized field that contains the Connected party identifier URL information and the offset, in bytes, from the beginning of LINECALLINFO data structure

RedirectionIDURLOffset
RedirectionIDURLSize

The size, in bytes, of the variably sized field that contains the Redirection party identifier URL information and the offset, in bytes, from the beginning of LINECALLINFO data structure

RedirectingIDURLOffset
RedirectingIDURLSize

The size, in bytes, of the variably sized field that contains the Redirecting party identifier URL information and the offset, in bytes, from the beginning of LINECALLINFO data structure

CallAttributeType

Identifies whether the following info(DN.Partition.DeviceName) is for a regular call, a monitoring call, a monitored call , or a recording call

PartyDNOffset,

PartyDNSize,

The size, in bytes, of the variably sized field that contains the Monitoring/Monitored/Recorder party DN information and the offset, in bytes, from the beginning of the LINECALLINFO data structure

PartyPartitionOffset

PartyPartitionSize

The size, in bytes, of the variably sized field that contains the Monitoring/Monitored/Recorder party partition information and the offset, in bytes, from the beginning of the LINECALLINFO data structure

DeviceNameOffset

DeviceNameSize

The size, in bytes, of the variably sized field that contains the Monitoring/Monitored/Recorder party device name, and the offset, in bytes, from the beginning of the LINECALLINFO data structure

OverallCallSecurityStatus

The security status of the call for two-party calls and conference calls

CCMCallID

The Cisco Unified Communications Manager caller ID for each call leg


To indicate that partition information exists in the LINECALLINFO structure, the system fires a LINECALLINFOSTATE_DEVSPECIFIC event. The bit map indicating the change is defined as the following:

SLDST_NUMBER_TYPE_CHANGED 0x00000080

SLDST_GLOBALIZED_CALLING_PARTY_CHANGED 0x00000100

All available bitmap values of dwParam3 for LINECALLINFOSTATE_DEVSPECIFIC event are:

SLDST_SRTP_INFO 0x00000001

SLDST_QOS_INFO 0x00000002

SLDST_PARTITION_INFO 0x00000004

SLDST_EXTENDED_CALL_INFO 0x00000008

SLDST_CALL_ATTRIBUTE_INFO 0x00000010 //M&R

SLDST_CCM_CALL_ID 0x00000020 //M&R

SLDST_SECURITY_STATUS_INFO 0x00000040 //SecureConf

SLDST_NUMBER_TYPE_CHANGED 0x00000080 //CPN

SLDST_GLOBALIZED_CALLING_PARTY_CHANGED 0x00000100 //CPN

Also, whenever a change occurs in the partition information, the system fires a LINEDEVSPECIFIC event that indicates which exact field in the devSpecific portion of the LINECALLINFO changed as shown below. This event fires only if the application has negotiated 7.0 extension version or higher.

LINEDEVSPECIFIC
{
  hDevice = hcall //call handle for which the info has changed.
  dwParam1 = SLDSMT_LINECALLINFO_DEVSPECIFICDATA //indicates DevSpecific portion's changed
  dwParam2 = SLDST_SRTP_INFO | SLDST_QOS_INFO |SLDST_PARTITION_INFO |  
    SLDST_EXTENDED_CALL_INFO | SLDST_CALL_ATTRIBUTE_INFO|SLDST_CCM_CALLID|  
    SLDST_CALL_SECURITY_STATUS
  dwParam3 = ...
  dwParam3 will be security indicator if dwParam2 has bit set for SLDST_SRTP_INFO
}
SLDST_SRTP_INFO 	= 0x00000001
SLDST_QOS_INFO 	= 0x00000002
SLDST_PARTITION_INFO 	= 0x00000004
SLDST_EXTENDED_CALL_INFO	= 0x00000008
SLDST_CALL_ATTRIBUTE_INFO = 0x00000010
SLDST_CCM_CALLID = 0x00000020
SLDST_CALL_SECURITY_STATUS=0x00000040

LINEDEVSTATUS

Cisco TSP implements several line device-specific extensions and uses the DevSpecific (dwDevSpecificSize and dwDevSpecificOffset) variably sized area of the LINEDEVSTATUS data structure for those extensions. Cisco TSP defines the DevSpecific area layout in the Cisco_LineDevStatus_Ext structure in the CiscoLineDevSpecificMsg.h header file. The data in that structure is organized based on the extension version in which the data was introduced:

//   LINEDEVSTATUS Dev Specific extention   //
typedef struct Cisco_LineDevStatus_Ext
{
    Cisco_LineDevStatus_Ext00060000  ext60;
    Cisco_LineDevStatus_Ext00070000  ext70;
    Cisco_LineDevStatus_Ext00080000  ext80;
} CISCO_LINEDEVSTATUS_EXT;

For a specific line device, the extension area will include a portion of this structure, starting from the begining and up to the extension version that an application negotiated.

Detail

The individual extension version substructure definitions follow:

//    LINEDEVSTATUS 00060000  extention    //
typedef struct Cisco_LineDevStatus_Ext00060000
{
    DWORD dwSupportedEncoding;
} CISCO_LINEDEVSTATUS_EXT00060000; 
//    LINEDEVSTATUS 00070000  extention    //
typedef struct Cisco_LineDevStatus_Ext00070000
{
    char lpszAlternateScript[MAX_ALTERNATE_SCRIPT_SIZE];
    // An empty string means there  is no alternate script configured
    // or the phone does not support alternate scripts
} CISCO_LINEDEVSTATUS_EXT00070000;
//    LINEDEVSTATUS 00080000  extention    //
typedef struct CiscoLineDevStatus_DoNotDisturb
{
    DWORD m_LineDevStatus_DoNotDisturbOption;
    DWORD m_LineDevStatus_DoNotDisturbStatus;
} CISCOLINEDEVSTATUS_DONOTDISTURB;

You can find additional information on the DevSpecific structure layout and data in the CiscoLineDevSpecificMsg.h header file.

The CiscoLineDevStatus_DoNotDisturb structure belongs to the LINEDEVSTATUS_DEV_SPECIFIC_DATA structure and is used to reflect the current state of the Do Not Disturb feature.

Parameters

DWORD dwSupportEncoding

This parameter indicates the Support Encoding for the Unicode Party names being sent in device-specific extension of the LINECALLINFO structure.

The typical values could be

enum {
UnknownEncoding = 0,	// Unknown encoding
NotApplicableEncoding = 1,	// Encoding not applicable to this device
AsciiEncoding = 2,          	// ASCII encoding
Ucs2UnicodeEncoding = 3     // UCS-2 Unicode encoding
}


Note Be aware that the dwSupportedEncoding extension is only available if extension version 0x00060000 or higher is negotiated.


LPCSTR lpszAlternateScript

This parameter specifies the alternate script that the defice supports. An empty string indicates the device does not support or is not configured with an alternate script.

The only supported script in this release is "Kanji" for the Japanese locale.

m_LineDevStatus_DoNotDisturbOption

This field contains DND option that is configured for the device and can be one of the following enum values:

enum CiscoDoNotDisturbOption {
    DoNotDisturbOption_NONE      = 0, 
    DoNotDisturbOption_RINGEROFF = 1,
    DoNotDisturbOption_REJECT    = 2 
};

m_LineDevStatus_ DoNotDisturbStatus field contains current DND status on the device 
and can be one of the following enum values:

enum CiscoDoNotDisturbStatus {
    DoNotDisturbStatus_UNKNOWN  = 0, 
    DoNotDisturbStatus_ENABLED  = 1,
    DoNotDisturbStatus_DISABLED = 2
};

Note Be aware that this extension is only available if extension version 8.0 (0x00080000) or higher is negotiated.


CCiscoLineDevSpecific

This section provides information on how to perform Cisco Unified TAPI specific functions with the CCiscoLineDevSpecific class, which represents the parent class to all the following classes. It comprises a virtual class and is provided here for informational purposes.

CCiscoLineDevSpecific
|
+-- CCiscoLineDevSpecificMsgWaiting
|
+-- CCiscoLineDevSpecificMsgWaitingDirn
|
+-- CCiscoLineDevSpecificUserControlRTPStream
|
+--CciscoLineDevSpecificSetStatusMsgs
|
+--CCiscoLineDevSpecificRedirectResetOrigCalled
|
+--CCiscoLineDevSpecificPortRegistrationPerCall
|
+--CciscoLineDevSpecificSetRTPParamsForCall
|
+--CCiscoLineDevSpecificRedirectSetOrigCalled
|
+--CCiscoLineDevSpecificJoin
|
+--CciscoLineDevSpecificUserSetSRTPAlgorithmID
|
+--CCiscoLineDevSpecificAcquire
|
+--CciscoLineDevSpecificDeacquire
|
+-- CciscoLineDevSpecificSendLineOpen
|
+-- CciscoLineSetIntercomSpeeddial
|
+-- CciscoLineIntercomTalkback
|
+-- CCiscoLineDevSpecificStartCallMonitoring
|
+-- CCiscoLineDevSpecificStartCallRecording
|
+-- CCiscoLineDevSpecificStopCallRecording

Header File

The file CiscoLineDevSpecific.h contains the constant, structure, and class definition for the Cisco line device-specific classes.

Class Detail

class CCiscoLineDevSpecific 
  {
  public:
CCicsoLineDevSpecific(DWORD msgType);
virtual ~CCiscoLineDevSpecific();
    DWORD GetMsgType(void) const {return m_MsgType;}
    void* lpParams() {return &m_MsgType;}
    virtual DWORD dwSize() = 0;
  private:
    DWORD m_MsgType;
  };

Functions

lpParms()

Function can be used to obtain the pointer to the parameter block.

dwSize()

Function will give the size of the parameter block area.

Parameter

m_MsgType

Specifies the type of message.

Subclasses

Each subclass of CCiscoLineDevSpecific has a different value assigned to the parameter m_MsgType. If you are using C instead of C++, this is the first parameter in the structure.

Enumeration

The CiscoLineDevSpecificType enumeration provides valid message identifiers.

enum CiscoLineDevSpecificType  {
SLDST_MSG_WAITING = 1,
SLDST_MSG_WAITING_DIRN,
SLDST_USER_CRTL_OF_RTP_STREAM,
SLDST_SET_STATUS_MESSAGES,
SLDST_NUM_TYPE,
SLDST_SWAP_HOLD_SETUP_TRANSFER, // Not Supported in Cisco TSP 3.4 and Beyond
SLDST_REDIRECT_RESET_ORIG_CALLED, 
SLDST_USER_RECEIVE_RTP_INFO,
SLDST_USER_SET_RTP_INFO,
SLDST_JOIN,
SLDST_USER_SET_SRTP_ALGORITHM_ID,
SLDST_SEND_LINE_OPEN,
};

Message Waiting

The CCiscoLineDevSpecificMsgWaiting class turns the message waiting lamp on or off for the line that the hLine parameter specifies.


Note This extension does not require an extension version to be negotiated.


CCiscoLineDevSpecific
  |
  +-- CCiscoLineDevSpecificMsgWaiting

Class Detail

class CCiscoLineDevSpecificMsgWaiting : public CCiscoLineDevSpecific
{
 public:
  CCiscoLineDevSpecificMsgWaiting() : CCiscoLineDevSpecific(SLDST_MSG_WAITING){}
  virtual ~CCiscoLineDevSpecificMsgWaiting() {}
  virtual DWORD dwSize(void) const {return sizeof(*this)-4;}
  DWORD m_BlinkRate; 
};

Parameters

DWORD m_MsgType

Equals SLDST_MSG_WAITING.

DWORD m_BlinkRate

Any supported PHONELAMPMODE_ constants that are specified in the phoneSetLamp() function.


Note Only PHONELAMPMODE_OFF and PHONELAMPMODE_STEADY are supported on Cisco 79xx IP Phones.


Message Waiting Dirn

The CCiscoLineDevSpecificMsgWaitingDirn class turns the message waiting lamp on or off for the line that a parameter specifies and is independent of the hLine parameter.


Note This extension does not require an extension version to be negotiated.


CCiscoLineDevSpecific
  |
  +-- CCiscoLineDevSpecificMsgWaitingDirn

Class Detail

class CCiscoLineDevSpecificMsgWaitingDirn : public CCiscoLineDevSpecific
{
 public:
  CCiscoLineDevSpecificMsgWaitingDirn() :  
    CCiscoLineDevSpecific(SLDST_MSG_WAITING_DIRN) {}
  virtual ~CCiscoLineDevSpecificMsgWaitingDirn() {}
  virtual DWORD dwSize(void) const {return sizeof(*this)-4;}
  DWORD m_BlinkRate; 
  char m_Dirn[25];
};

Parameters

DWORD m_MsgType

Equals SLDST_MSG_WAITING_DIRN.

DWORD m_BlinkRate

As in the CCiscoLineDevSpecificMsgWaiting message.


Note Only PHONELAMPMODE_OFF and PHONELAMPMODE_STEADY are supported on Cisco 79xx IP Phones.


char m_Dirn[25]

The directory number for which the message waiting lamp should be set.

Audio Stream Control

The CCiscoLineDevSpecificUserControlRTPStream class controls the audio stream of a line. To use this class, the lineNegotiateExtVersion API must be called before opening the line. When lineNegotiateExtVersion is called, the highest bit must be set on both the dwExtLowVersion and dwExtHighVersion parameters. This causes the call to lineOpen to behave differently. The line does not actually open, but waits for a lineDevSpecific call to complete the open with more information. The CCiscoLineDevSpecificUserControlRTPStream class provides the extra information that is required.

CCiscoLineDevSpecific
  |
  +-- CCiscoLineDevSpecificUserControlRTPStream

Procedure


Step 1 Call lineNegotiateExtVersion for the deviceID of the line that is to be opened (OR 0x80000000 with the dwExtLowVersion and dwExtHighVersion parameters).

Step 2 Call lineOpen for the deviceID of the line that is to be opened.

Step 3 Call lineDevSpecific with a CCiscoLineDevSpecificUserControlRTPStream message in the lpParams parameter.


Class Detail

class CCiscoLineDevSpecificUserControlRTPStream : public CCiscoLineDevSpecific
 {
  public:
  CCiscoLineDevSpecificUserControlRTPStream() :  
    CCiscoLineDevSpecific(SLDST_USER_CRTL_OF_RTP_STREAM),
    m_ReceiveIP(-1), 
    m_ReceivePort(-1), 
    m_NumAffectedDevices(0)
     {
     memset(m_AffectedDeviceID, 0, sizeof(m_AffectedDeviceID));
     }
  virtual ~CCiscoLineDevSpecificUserControlRTPStream() {}
  DWORD m_ReceiveIP;   // UDP audio reception IP
  DWORD m_ReceivePort; // UDP audio reception port
  DWORD m_NumAffectedDevices;
  DWORD m_AffectedDeviceID[10];
  DWORD m_MediaCapCount;
  MEDIA_CAPS m_MediaCaps;
  virtual DWORD dwSize(void) const {return sizeof(*this)-4;}
 };

Parameters

DWORD m_MsgType

Equals SLDST_USER_CRTL_OF_RTP_STREAM

DWORD m_ReceiveIP:

The RTP audio reception IP address in network byte order

DWORD m_ReceivePort:

The RTP audio reception port in network byte order

DWORD m_NumAffectedDevices:

The TSP returns this value. It contains the number of deviceIDs in the m_AffectedDeviceID array that are valid. Any device with multiple directory numbers that are assigned to it will have multiple TAPI lines, one per directory number.

DWORD m_AffectedDeviceID[10]:

The TSP returns this value. It contains the list of deviceIDs for any device that is affected by this call. Do not call lineDevSpecific for any other device in this list.

DWORD m_mediaCapCount

The number of codecs that are supported for this line.

MEDIA_CAPS m_MediaCaps -

A data structure with the following format:

typedef struct {

DWORD MediaPayload;

DWORD MaxFramesPerPacket;

DWORD G723BitRate;

} MEDIA_CAPS[MAX_MEDIA_CAPS_PER_DEVICE];

This data structure defines each codec that is supported on a line. The limit specifies 18. The following description shows each member in the MEDIA_CAPS data structure:

MediaPayload specifies an enumerated integer that contains one of the following values:

enum
    { 
Media_Payload_G711Alaw64k = 2,
Media_Payload_G711Alaw56k = 3, // "restricted"
Media_Payload_G711Ulaw64k = 4,
Media_Payload_G711Ulaw56k = 5, // "restricted"
Media_Payload_G722_64k = 6,
Media_Payload_G722_56k = 7,
Media_Payload_G722_48k = 8,
Media_Payload_G7231 = 9,
Media_Payload_G728 = 10,
Media_Payload_G729 = 11,
Media_Payload_G729AnnexA = 12,
Media_Payload_G729AnnexB = 15,
Media_Payload_G729AnnexAwAnnexB = 16,
Media_Payload_GSM_Full_Rate = 18,
Media_Payload_GSM_Half_Rate = 19,
Media_Payload_GSM_Enhanced_Full_Rate = 20,
Media_Payload_Wide_Band_256k = 25,
Media_Payload_Data64 = 32,
Media_Payload_Data56 = 33,
Media_Payload_GSM = 80,
Media_Payload_G726_32K = 82,
Media_Payload_G726_24K = 83,
Media_Payload_G726_16K = 84,
// Media_Payload_G729_B = 85,
// Media_Payload_G729_B_LOW_COMPLEXITY = 86,
}   Media_PayloadType;

Read MaxFramesPerPacket as MaxPacketSize. It specifies a 16-bit integer that indicates the maximum desired RTP packet size in milliseconds. Typically, this value is set to 20.

G723BitRate specifies a 6-byte field that contains either the G.723.1 information bit rate or is ignored. The following list provides values for the G.723.1 field are values.

enum
    {  
    Media_G723BRate_5_3 = 1, //5.3Kbps
    Media_G723BRate_6_4 = 2  //6.4Kbps
    }   Media_G723BitRate;

Set Status Messages

The CCiscoLineDevSpecificSetStatusMsgs class is used to turn on or off the status messages for the line specified by the hLine parameter. The Cisco Unified TSP supports the following flags:

DEVSPECIFIC_MEDIA_STREAM—Setting this flag on a line turns on the reporting of media streaming messages for that line. Clearing this flag will turn off the reporting of media streaming messages for that line.

DEVSPECIFIC_CALL_TONE_CHANGED—Setting this flag on a line turns on the reporting of call tone changed events for that line. Clearing this flag will turn off the reporting of call tone changed events for that line.


Note This extension only applies if extension version 0x00020001 or higher is negotiated.


CCiscoLineDevSpecific
|
+-- CCiscoLineDevSpecificSetStatusMsgs

Class Detail

class CCiscoLineDevSpecificSetStatusMsgs : public CCiscoLineDevSpecific
{
public:
CCiscoLineDevSpecificSetStatusMsgs() : 
CCiscoLineDevSpecific(SLDST_SET_STATUS_MESSAGES) {}
virtual ~CCiscoLineDevSpecificSetStatusMsgs() {}
DWORD m_DevSpecificStatusMsgsFlag;
virtual DWORD dwSize(void) const {return sizeof(*this)-4;}
};

Parameters

DWORD m_MsgType

Equals SLDST_SET_STATUS_MESSAGES.

DWORD m_DevSpecificStatusMsgsFlag

Identifies which status changes cause a LINE_DEVSPECIFIC message to be sent to the application.

The supported values are as follows:

#define DEVSPECIFIC_MEDIA_STREAM 	0x00000001
#define DEVSPECIFIC_CALL_TONE_CHANGED 	0x00000002
#define CALL_DEVSPECIFIC_RTP_EVENTS 	0x00000003
#define DEVSPECIFIC_IDLE_TRANSFER_REASON		0x00000004
#define DEVSPECIFIC_SPEEDDIAL_CHANGED			0x00000008

Swap-Hold/SetupTransfer


Note This is not supported in Cisco Unified TSP 4.0 and beyond.


The CCiscoLineDevSpecificSwapHoldSetupTransfer class was used to perform a SetupTransfer between a call that is in CONNECTED state and a call that is in the ONHOLD state. This function would change the state of the connected call to ONHOLDPENDTRANSFER state and the ONHOLD call to CONNECTED state. This would then allow a CompleteTransfer to be performed on the two calls. In Cisco Unified TSP 4.0 and beyond, the TSP allows applications to use lineCompleteTransfer() to transfer the calls without having to use the CCiscoLineDevSpecificSwapHoldSetupTransfer function. Therefore, this function returns LINEERR_OPERATIONUNAVAIL in Cisco Unified TSP 4.0 and beyond.


CCiscoLineDevSpecific
|
+-- CCiscoLineDevSpecificSwapHoldSetupTransfer

Note This extension only applies if extension version 0x00020002 or higher is negotiated.


Class Details

class CCiscoLineDevSpecificSwapHoldSetupTransfer : public CCiscoLineDevSpecific
    {
    public:
      CCiscoLineDevSpecificSwapHoldSetupTransfer() : 
CCiscoLineDevSpecific(SLDST_SWAP_HOLD_SETUP_TRANSFER) {}
      virtual ~CCiscoLineDevSpecificSwapHoldSetupTransfer() {}
      DWORD heldCallID;
      virtual DWORD dwSize(void) const {return sizeof(*this)-4;} // subtract out the 
virtual function table pointer
    };

Parameters

DWORD m_MsgType

Equals SLDST_SWAP_HOLD_SETUP_TRANSFER.

DWORD heldCallID

Equals the callid of the held call that is returned in dwCallID of LPLINECALLINFO.

HCALL hCall (in lineDevSpecific parameter list)

Equals the handle of the connected call.

Redirect Reset Original Called ID

CCiscoLineDevSpecific
|
+-- CCiscoLineDevSpecificRedirectResetOrigCalled

Description

The CCiscoLineDevSpecificRedirectResetOrigCalled class redirects a call to another party while resetting the original called ID of the call to the destination of the redirect.


Note This extension only applies if extension version 0x00020003 or higher is negotiated.


Class Details

class CCiscoLineDevSpecificRedirectResetOrigCalled: public CCiscoLineDevSpecific
    {
    public:
      CCiscoLineDevSpecificRedirectResetOrigCalled: 
CCiscoLineDevSpecific(SLDST_REDIRECT_RESET_ORIG_CALLED) {}
      virtual ~CCiscoLineDevSpecificRedirectResetOrigCalled{}
      char m_DestDirn[25]; //redirect destination address
      virtual DWORD dwSize(void) const {return sizeof(*this)-4;} // subtract out the 
virtual function table pointer
    };

Parameters

DWORD m_MsgType

Equals SLDST_REDIRECT_RESET_ORIG_CALLED.

DWORD m_DestDirn

Equals the destination address where the call needs to be redirected.

HCALL hCall (In lineDevSpecific parameter list)

Equals the handle of the connected call.

Port Registration per Call

The CCiscoLineDevSpecificPortRegistrationPerCall class registers the CTI Port for the RTP parameters on a per call basis. With this request, the application receives the new lineDevSpecific event requesting that it needs to set the RTP parameters for the call.

To use this class, the lineNegotiateExtVersion API must be called before opening the line. When calling lineNegotiateExtVersion, the highest bit must be set on both the dwExtLowVersion and dwExtHighVersion parameters.

This causes the call to lineOpen to behave differently. The line is not actually opened, but waits for a lineDevSpecific call to complete the open with more information. The extra information required is provided in the CciscoLineDevSpecificPortRegistrationPerCall class.

CCiscoLineDevSpecific
|
+-- CCiscoLineDevSpecificPortRegistrationPerCall

Procedure


Step 1 Call lineNegotiateExtVersion for the deviceID of the line to be opened (or 0x80000000 with the dwExtLowVersion and dwExtHighVersion parameters)

Step 2 Call lineOpen for the deviceID of the line to be opened.

Step 3 Call lineDevSpecific with a CciscoLineDevSpecificPortRegistrationPerCall message in the lpParams parameter.



Note This extension is only available if the extension version 0x00040000 or higher gets negotiated.


Class Details

class CCiscoLineDevSpecificPortRegistrationPerCall: public CCiscoLineDevSpecific
{
public:
	CCiscoLineDevSpecificPortRegistrationPerCall () : 
	CCiscoLineDevSpecific(SLDST_USER_RECEIVE_RTP_INFO), 
	m_RecieveIP(-1), m_RecievePort(-1), m_NumAffectedDevices(0)
	{
	memset((char*)m_AffectedDeviceID, 0, sizeof(m_AffectedDeviceID));
	}

	virtual ~ CCiscoLineDevSpecificPortRegistrationPerCall () {}
	DWORD m_NumAffectedDevices;
	DWORD m_AffectedDeviceID[10];
	DWORD m_MediaCapCount;
	MEDIA_CAPS	m_MediaCaps;
	virtual DWORD dwSize(void) const {return sizeof(*this)-4;}  
// 	subtract out the virtual function table pointer
	};

Parameters

DWORD m_MsgType

Equals SLDST_USER_RECEIVE_RTP_INFO

DWORD m_NumAffectedDevices:

This value is returned by the TSP. It contains the number of deviceIDs in the m_AffectedDeviceID array which are valid. Any device with multiple directory numbers assigned to it will have multiple TAPI lines, one per directory number.

DWORD m_AffectedDeviceID[10]:

This value is returned by the TSP. It contains the list of deviceIDs for any device affected by this call. Do not call lineDevSpecific for any other device in this list.

DWORD m_mediaCapCount

The number of codecs supported for this line.

MEDIA_CAPS m_MediaCaps -

A data structure with the following format:


typedef struct {
DWORD MediaPayload;
DWORD MaxFramesPerPacket;
DWORD G723BitRate;
} MEDIA_CAPS[MAX_MEDIA_CAPS_PER_DEVICE];

This data structure defines each codec supported on a line. The limit is 18. The following is a description for each member in the MEDIA_CAPS data structure:

MediaPayload is an enumerated integer that contains one of the following values.

enum
{
Media_Payload_G711Alaw64k = 2,
Media_Payload_G711Alaw56k = 3, // "restricted"
Media_Payload_G711Ulaw64k = 4,
Media_Payload_G711Ulaw56k = 5, // "restricted"
Media_Payload_G722_64k = 6,
Media_Payload_G722_56k = 7,
Media_Payload_G722_48k = 8,
Media_Payload_G7231 = 9,
Media_Payload_G728 = 10,
Media_Payload_G729 = 11,
Media_Payload_G729AnnexA = 12,
Media_Payload_G729AnnexB = 15,
Media_Payload_G729AnnexAwAnnexB = 16,
Media_Payload_GSM_Full_Rate = 18,
Media_Payload_GSM_Half_Rate = 19,
Media_Payload_GSM_Enhanced_Full_Rate = 20,
Media_Payload_Wide_Band_256k = 25,
Media_Payload_Data64 = 32,
Media_Payload_Data56 = 33,
Media_Payload_GSM = 80,
Media_Payload_G726_32K = 82,
Media_Payload_G726_24K = 83,
Media_Payload_G726_16K = 84,
// Media_Payload_G729_B = 85,
// Media_Payload_G729_B_LOW_COMPLEXITY = 86,
} Media_PayloadType;

MaxFramesPerPacket should read as MaxPacketSize and is a 16 bit integer specified in milliseconds. It indicates the RTP packet size. Typically, this value is set to 20.

G723BitRate is a six byte field which contains either the G.723.1 information bit rate or is ignored. The values for the G.723.1 field are values enumerated as follows.


enum
{
Media_G723BRate_5_3 = 1, //5.3Kbps
Media_G723BRate_6_4 = 2 //6.4Kbps
} Media_G723BitRate;

Setting RTP Parameters for Call

The CCiscoLineDevSpecificSetRTPParamsForCall class sets the RTP parameters for a specific call.


Note This extension only applies if extension version 0x00040000 or higher gets negotiated.


CCiscoLineDevSpecific
|
+-- CCiscoLineDevSpecificSetRTPParamsForCall

Class Details

class CciscoLineDevSpecificSetRTPParamsForCall: public CCiscoLineDevSpecific
{
public:
	CciscoLineDevSpecificSetRTPParamsForCall () :  
CCiscoLineDevSpecific(SLDST_USER_SET_RTP_INFO) {}
	virtual ~ CciscoLineDevSpecificSetRTPParamsForCall () {}
	virtual DWORD dwSize(void) const {return sizeof(*this)-4;}  
	// subtract out the virtual function table pointer
	DWORD m_RecieveIP;   // UDP audio reception IP
	DWORD m_RecievePort; // UDP audio reception port
  	};

Parameters

DWORD m_MsgType

Equals SLDST_USER_SET_RTP_INFO

DWORD m_ReceiveIP

This is the RTP audio reception IP address in the network byte order to set for the call.

DWORD m_ReceivePort

This is the RTP audio reception port in the network byte order to set for the call.

Redirect Set Original Called ID

The CCiscoLineDevSpecificRedirectSetOrigCalled class redirects a call to another party while setting the original called ID of the call to any other party.


Note This extension only applies if extension version 0x00040000 or higher gets negotiated.


CCiscoLineDevSpecific
|
+-- CCiscoLineDevSpecificRedirectSetOrigCalled

Class Details

class CCiscoLineDevSpecificRedirectSetOrigCalled: public CCiscoLineDevSpecific
{
public:
    CCiscoLineDevSpecificRedirectSetOrigCalled () : 
CCiscoLineDevSpecific(SLDST_REDIRECT_SET_ORIG_CALLED) {}
    virtual ~ CCiscoLineDevSpecificRedirectSetOrigCalled () {}
    char m_DestDirn[25]; 
    char m_SetOriginalCalledTo[25];
    // subtract virtual function table pointer
    virtual DWORD dwSize(void) const {return (sizeof (*this) - 4) ;
}

Parameters

DWORD m_MsgType

Equals SLDST_REDIRECT_SET_ORIG_CALLED

char m_DestDirn[25]

Indicates the destination of the redirect. If this request is being used to transfer to voice mail, then set this field to the voice mail pilot number of the DN of the line whose voice mail you want to transfer to.

char m_SetOriginalCalledTo[25]

Indicates the DN to which the OriginalCalledParty needs to be set to. If this request is being used to transfer to voice mail, then set this field to the DN of the line whose voice mail you want to transfer to.

HCALL hCall (in lineDevSpecific parameter list)

Equals the handle of the connected call.

Join

The CCiscoLineDevSpecificJoin class joins two or more calls into one conference call. Each of the calls being joined can either be in the ONHOLD or the CONNECTED call state.

The Cisco Unified Communications Manager may succeed in joining some of the calls specified in the Join request, but not all. In this case, the Join request will succeed and the Cisco Unified Communications Manager attempts to join as many calls as possible.


Note This extension only applies if extension version 0x00040000 or higher gets negotiated.


CCiscoLineDevSpecific
|
+-- CCiscoLineDevSpecificJoin

Class Details

class CCiscoLineDevSpecificJoin : public CCiscoLineDevSpecific
{
    public:
        CCiscoLineDevSpecificJoin () : CCiscoLineDevSpecific(SLDST_JOIN) {}
        virtual ~ CCiscoLineDevSpecificJoin () {}
        DWORD m_CallIDsToJoinCount;
        CALLIDS_TO_JOIN m_CallIDsToJoin;
        virtual DWORD dwSize(void) const {return sizeof(*this)-4;} 
        // subtract out the virtual function table pointer
};

Parameters

DWORD m_MsgType

equals SLDST_JOIN

DWORD m_CallIDsToJoinCount

The number of callIDs contained in the m_CallIDsToJoin parameter.

CALLIDS_TO_JOIN m_CallIDsToJoin

A data structure that contains an array of dwCallIDs to join with the following format:

typedef struct {
    DWORD   CallID; // dwCallID to Join
} CALLIDS_TO_JOIN[MAX_CALLIDS_TO_JOIN];

where MAX_CALLIDS_TO_JOIN is defined as:


const DWORD MAX_CALLIDS_TO_JOIN = 14;

HCALL hCall (in LineDevSpecific parameter list)

equals the handle of the call that is being joined with callIDsToJoin to create the conference.

Set User SRTP Algorithm IDs

The CciscoLineDevSpecificUserSetSRTPAlgorithmID class is used to allow applications to set SRTP algorithm IDs. To use this class, the lineNegotiateExtVersion API must be called before opening the line. When calling lineNegotiateExtVersion the highest bit or second highest bit must be set on both the dwExtLowVersion and dwExtHighVersion parameters. This causes the call to lineOpen to behave differently. The line is not actually opened, but waits for a lineDevSpecific call to complete the open with more information. The extra information required is provided in the CciscoLineDevSpecificUserSetSRTPAlgorithmID class.


Note This extension is only available if extension version 0x80070000, 0x4007000 or higher is negotiated.


CCiscoLineDevSpecific
|
+-- CciscoLineDevSpecificUserSetSRTPAlgorithmID

Procedure


Step 1 Call lineNegotiateExtVersion for the deviceID of the line to be opened. (0x80070000 or 0x4007000 with the dwExtLowVersion and dwExtHighVersion parameters)

Step 2 Call lineOpen for the deviceID of the line to be opened.

Step 3 Call lineDevSpecific with a CciscoLineDevSpecificUserSetSRTPAlgorithmID message in the lpParams parameter to specify SRTP algorithm ids.

Step 4 Call lineDevSpecific with either CciscoLineDevSpecificPortRegistrationPerCall or CCiscoLineDevSpecificUserControlRTPStream message in the lpParams parameter.


Class Detail

class CciscoLineDevSpecificUserSetSRTPAlgorithmID: public CCiscoLineDevSpecific
{
  public:
    CciscoLineDevSpecificUserSetSRTPAlgorithmID () : 
    CCiscoLineDevSpecific(SLDST_USER_SET_SRTP_ALGORITHM_ID), 
    m_SRTPAlgorithmCount(0),
	m_SRTP_Fixed_Element_Size(4)
	{
	}

    virtual ~ CciscoLineDevSpecificUserSetSRTPAlgorithmID () {}
      DWORD m_SRTPAlgorithmCount;	     //Maximum is MAX_CISCO_SRTP_ALGORITHM_IDS
	DWORD m_SRTP_Fixed_Element_Size;//Should be size of DWORD, it should be always 4.
      DWORD m_SRTPAlgorithm_Offset;   //offset from beginning of the message buffer
    virtual DWORD dwSize(void) const {return sizeof(*this)-4;} // subtract out the virtual 
function table pointer
};

Supported Algorithm Constants

enum CiscoSRTPAlgorithmIDs
{
	SRTP_NO_ENCRYPTION=0, 
	SRTP_AES_128_COUNTER=1 
};

Parameters

DWORD m_MsgType

Equals SLDST_USER_SET_SRTP_ALGORITHM_ID

DWORD m_SRTPAlgorithmCount

This numbers of algorithm Ids specified in this message.

DWORD m_SRTP_Fixed_Element_Size

Should be size of DWORD, it should be always 4.

DWORD m_SRTPAlgorithm_Offset

Offset from the beginning of the message buffer. This is offset where you start put algorithm id array.


Note dwSize should be recalculated based on size of the structure, m_SRTPAlgorithmCount and m_SRTP_Fixed_Element_Size.


Explicit Acquire

The CCiscoLineDevSpecificAcquire class is used to explicitly acquire any CTI controllable device.

If a Superprovider application needs to open any CTI Controllable device on the Cisco Unified Communications Manager system. The application should explicitly acquire that device using the above interface. After successful response, it can open the device as usual.


Note This extension is only available if extension version 0x00070000 or higher is negotiated.


CCiscoLineDevSpecific
|
+--CCiscoLineDevSpecificAcquire

Class Details

class CCiscoLineDevSpecificAcquire : public CCiscoLineDevSpecific
{
    public:
        CCiscoLineDevSpecificAcquire () : CCiscoLineDevSpecific(SLDST_ACQUIRE) {}
        virtual ~ CCiscoLineDevSpecificAcquire () {}
        char m_DeviceName[16];
        virtual DWORD dwSize(void) const {return sizeof(*this)-4;} 
        // subtract out the virtual function table pointer
};

Parameters

DWORD m_MsgType

Equals SLDST_ACQUIRE

char m_DeviceName[16]

The DeviceName that needs to be explicitly acquired.

Explicit De-Acquire

The CCiscoLineDevSpecificDeacquire class is used to explicitly de-acquire the explicitly acquired device.

If a Superprovider application has explicitly acquired any CTI Controllable device on the Cisco Unified Communications Manager system, then the application should explicitly De-acquire that device using the above interface.


Note This extension is only available if extension version 0x00070000 or higher is negotiated.


CCiscoLineDevSpecific
|
+--CCiscoLineDevSpecificDeacquire

Class Details

class CCiscoLineDevSpecificDeacquire : public CCiscoLineDevSpecific
{
    public:
CCiscoLineDevSpecificDeacquire () : CCiscoLineDevSpecific(SLDST_ACQUIRE) {}
        virtual ~ CCiscoLineDevSpecificDeacquire () {}
        char m_DeviceName[16];
        virtual DWORD dwSize(void) const {return sizeof(*this)-4;} 
        // subtract out the virtual function table pointer
};

Parameters

DWORD m_MsgType

Equals SLDST_DEACQUIRE

char m_DeviceName[16]

The DeviceName that needs to be explicitly de-acquired.

Redirect FAC CMC

The CCiscoLineDevSpecificRedirectFACCMC class is used to redirect a call to another party that requires a FAC, CMC, or both.


Note This extension is only available if extension version 0x00050000 or higher is negotiated.


CCiscoLineDevSpecific 
| 
+--CCiscoLineDevSpecificRedirectFACCMC

If the FAC is invalid, then the TSP will return a new device specific error code LINEERR_INVALIDFAC. If the CMC is invalid, then the TSP will return a new device specific error code LINEERR_INVALIDCMC.

Class Detail

class CCiscoLineDevSpecificRedirectFACCMC: public CCiscoLineDevSpecific
{
public:
    	CCiscoLineDevSpecificRedirectFACCMC () : CCiscoLineDevSpecific(SLDST_REDIRECT_FAC_CMC) 
{}
    	virtual ~ CCiscoLineDevSpecificRedirectFACCMC () {}
	char m_DestDirn[49];
	char m_FAC[17];
	char m_CMC[17];
    	// subtract virtual function table pointer
    	virtual DWORD dwSize(void) const {return (sizeof (*this) - 4) ;
}

Parameters

DWORD m_MsgType

Equals SLDST_REDIRECT_FAC_CMC

char m_DestDirn[49]

Indicates the destination of the redirect.

char m_FAC[17]

Indicates the FAC digits. If the application does not want to pass any FAC digits, then it must set this parameter to a NULL string.

char m_CMC[17]

Indicates the CMC digits. If the application does not want to pass any CMC digits, then it must set this parameter to a NULL string.

HCALL hCall (in lineDevSpecific parameter list)

Equals the handle of the call to be redirected.

Blind Transfer FAC CMC

The CCiscoLineDevSpecificBlindTransferFACCMC class is used to blind transfer a call to another party that requires a FAC, CMC, or both. If the FAC is invalid, then the TSP will return a new device specific error code LINEERR_INVALIDFAC. If the CMC is invalid, then the TSP will return a new device specific error code LINEERR_INVALIDCMC.


Note This extension is only available if extension version 0x00050000 or higher is negotiated.


CCiscoLineDevSpecific
|
+--CCiscoLineDevSpecificBlindTransferFACCMC

Class Detail

class CCiscoLineDevSpecificBlindTransferFACCMC: public CCiscoLineDevSpecific
{
public:
    	CCiscoLineDevSpecificBlindTransferFACCMC () : 
CCiscoLineDevSpecific(SLDST_BLIND_TRANSFER_FAC_CMC) {}
    	virtual ~ CCiscoLineDevSpecificBlindTransferFACCMC () {}
	char m_DestDirn[49];
	char m_FAC[17];
	char m_CMC[17];
    	// subtract virtual function table pointer
    	virtual DWORD dwSize(void) const {return (sizeof (*this) - 4) ;
}

Parameters

DWORD m_MsgType

Equals SLDST_BLIND_TRANSFER_FAC_CMC

char m_DestDirn[49]

Indicates the destination of the blind transfer.

char m_FAC[17]

Indicates the FAC digits. If the application does not want to pass any FAC digits, then it must set this parameter to a NULL string.

char m_CMC[17]

Indicates the CMC digits. If the application does not want to pass any CMC digits, then it must set this parameter to a NULL string.

HCALL hCall (in lineDevSpecific parameter list)

Equals the handle of the call to be blind transferred.

CTI Port Third Party Monitor

The CCiscoLineDevSpecificCTIPortThirdPartyMonitor class is used for opening CTI ports in third party mode.

To use this class, the lineNegotiateExtVersion API must be called before opening the line. When calling lineNegotiateExtVersion the highest bit must be set on both the dwExtLowVersion and dwExtHighVersion parameters. This causes the call to lineOpen to behave differently. The line is not actually opened, but waits for a lineDevSpecific call to complete the open with more information. The extra information required is provided in the CCiscoLineDevSpecificCTIPortThirdPartyMonitor class.

CCiscoLineDevSpecific
|
+-- CCiscoLineDevSpecificCTIPortThirdPartyMonitor

Procedure


Step 1 Call lineNegotiateExtVersion for the deviceID of the line to be opened. (OR 0x80000000 with the dwExtLowVersion and dwExtHighVersion parameters)

Step 2 Call lineOpen for the deviceID of the line to be opened.

Step 3 Call lineDevSpecific with a CCiscoLineDevSpecificCTIPortThirdPartyMonitor message in the lpParams parameter.



Note This extension is only available if extension version 0x00050000 or higher is negotiated.


Class Detail

class CCiscoLineDevSpecificCTIPortThirdPartyMonitor: public CCiscoLineDevSpecific
{
public:
	CCiscoLineDevSpecificCTIPortThirdPartyMonitor () : 
	CCiscoLineDevSpecific(SLDST_CTI_PORT_THIRD_PARTY_MONITOR) {}
	virtual ~ CCiscoLineDevSpecificCTIPortThirdPartyMonitor () {}
	virtual DWORD dwSize(void) const {return sizeof(*this)-4;} //  
	subtract out the virtual function table pointer
};

Parameters

DWORD m_MsgType

equals SLDST_CTI_PORT_THIRD_PARTY_MONITOR

Send Line Open

The CciscoLineDevSpecificSendLineOpen class is used for general delayed open purpose. To use this class, the lineNegotiateExtVersion API must be called before opening the line. When calling lineNegotiateExtVersion the second highest bit must be set on both the dwExtLowVersion and dwExtHighVersion parameters. This causes the call to lineOpen to behave differently. The line is not actually opened, but waits for a lineDevSpecific call to complete the open with more information. The extra information required is provided in the CciscoLineDevSpecificUserSetSRTPAlgorithmID class.

CCiscoLineDevSpecific
|
+-- CciscoLineDevSpecificSendLineOpen

Procedure


Step 1 Call lineNegotiateExtVersion for the deviceID of the line to be opened. (0x40070000 with the dwExtLowVersion and dwExtHighVersion parameters)

Step 2 Call lineOpen for the deviceID of the line to be opened.

Step 3 Call other lineDevSpecific, like CciscoLineDevSpecificUserSetSRTPAlgorithmID message in the lpParams parameter to specify SRTP algorithm ids.

Step 4 Call lineDevSpecific with either CciscoLineDevSpecificSendLineOpen to trigger the lineopen from TSP side.



Note This extension is only available if extension version 0x40070000 or higher is negotiated.


Class Detail

class CciscoLineDevSpecificSendLineOpen: public CCiscoLineDevSpecific
  {
  public:
    CciscoLineDevSpecificSendLineOpen () : 
	CCiscoLineDevSpecific(SLDST_SEND_LINE_OPEN) {} 

    virtual ~ CciscoLineDevSpecificSendLineOpen () {}
    virtual DWORD dwSize(void) const {return sizeof(*this)-4;} // subtract out the virtual 
function table pointer
};

Set Intercom SpeedDial

Use the CciscoLineSetIntercomSpeeddial class to allow application to set or reset SpeedDial/Label on an intercom line.


Note Be aware that this extension is only available if extension version 0x00080000 or higher is negotiated


CCiscoLineDevSpecific
|
+-- CciscoLineSetIntercomSpeeddial

Procedure


Step 1 Call lineNegotiateExtVersion for the deviceID of the line to be opened (0x00080000 or higher).

Step 2 Call lineOpen for the deviceID of the line to be opened.

Step 3 Wait for line in service.

Step 4 Call CciscoLineSetIntercomSpeeddial to set or reset speed dial setting on the intercom line.


Class Detail

class CciscoLineSetIntercomSpeeddial: public CCiscoLineDevSpecific
  {
  public:
    CciscoLineSetIntercomSpeeddial () : 
	CCiscoLineDevSpecific(SLDST_LINE_SET_INTERCOM_SPEEDDIAL) {} 

    virtual ~ CciscoLineSetIntercomSpeeddial () {}
    DWORD SetOption;        //0=clear app value, 1= set App Value
    char Intercom_DN[MAX_DIRN];
    char Intercom_Ascii_Label[MAX_DIRN];
    wchar_t Intercom_Unicode_Label[MAX_DIRN];
    virtual DWORD dwSize(void) const {return sizeof(*this)-4;} // subtract out the virtual 
function table pointer
};

Parameters

DWORD m_MsgType

Equals SLDST_USER_SET_INTERCOM_SPEEDDIAL

DWORD SetOption

Use this parameter to indicate whether the application wants to set a new intercom speed dial value or clear the previous value. 0 = clear, 1 = set.

Char Intercom_DN [MAX_DIRN]

A DN array that indicates the intercom target

Char Intercom_Ascii_Label[MAX_DIRN]

Indicates the ASCII value of the intercom line label

Wchar_tIntercom_Unicode_Label[MAX_DIRN]

Indicates the Unicode value of the intercom line label

MAX_DIRN is defined as 25.

Intercom Talk Back

Use the CCiscoLineDevSpecificTalkBack class to allow application to initiate talk back on a incoming Intercom call on a Intercom line.


Note Be aware that this extension is only available if extension version 0x00080000 or higher is negotiated.


CCiscoLineDevSpecific
|
+-- CCiscoLineDevSpecificTalkBack

Class Detail

class CCiscoLineDevSpecificTalkBack: public CCiscoLineDevSpecific
{
  public:
    CCiscoLineDevSpecificTalkBack () : 
    CCiscoLineDevSpecific(SLDST_INTERCOM_TALKBACK) {} 

    virtual ~ CCiscoLineDevSpecificTalkBack () {}
    virtual DWORD dwSize(void) const {return sizeof(*this)-4;} // subtract out the virtual 
function table pointer
};

Redirect with Feature Priority

CciscoLineRedirectWithFeaturePriority enables an application to redirect calls with specified feature priorities. The following is the structure of CciscoLineDevSpecific:

CCiscoLineDevSpecific
|
+-- CciscoLineRedirectWithFeaturePriority

Note Be aware that this extension is only available if the extension version 0x00080001 or higher is negotiated.


Detail

class CciscoLineRedirectWithFeaturePriority: public CCiscoLineDevSpecific
  {
  public:
    CciscoLineRedirectWithFeaturePriority() : 
	CCiscoLineDevSpecific(SLDST_REDIRECT_WITH_FEATURE_PRIORITY) {} 

    virtual ~ CciscoLineRedirectWithFeaturePriority () {}
	CiscoDoNotDisturbFeaturePriority FeaturePriority;
	char m_DestDirn[25];
    virtual DWORD dwSize(void) const {return sizeof(*this)-4;} // subtract out the virtual 
function table pointer
};

Parameters

DWORD m_MsgType

Equals SLDST_REDIRECT_WITH_FEATURE_PRIORITY

enum CiscoDoNotDisturbFeaturePriority {CallPriority_NORMAL = 1, CallPriority_URGENT = 2, CallPriority_EMERGENCY = 3};

This identifies the priorities.

char m_DestDirn[25];

This is redirect destination.

Start Call Monitoring

Use CCiscoLineDevSpecificStartCallMonitoring to allow application to send a start monitoring request for the active call on a line.


Note Be aware that this extension is only available if extension version 0x00080000 or higher is negotiated.


CCiscoLineDevSpecific
|
+-- CCiscoLineDevSpecificStartCallMonitoring

Class Detail

class CCiscoLineDevSpecificStartCallMonitoring: public CCiscoLineDevSpecific
{
public:
    CCiscoLineDevSpecificStartCallMonitoring () : 
CCiscoLineDevSpecific(SLDST_START_CALL_MONITORING) {}
    virtual ~    CCiscoLineDevSpecificStartCallMonitoring () {}
    DWORD m_PermanentLineID ; 
  DWORD m_MonitorMode;
   DWORD m_ToneDirection; 
   // subtract out the virtual function table pointer
   virtual DWORD dwSize(void) const {return sizeof(*this)-4;} 
} ;

Parameters

DWORD m_MsgType

Equals SLDST_START_MONITORING

DWORD m_ PermanentLineID

The permanent lineID of the line whose active call has to be monitored.

DWORD MonitorMode

This can have the following enum value:

	enum
             {
        	MonitorMode_None  = 0,
        	MonitorMode_Silent  = 1,
         	MonitorMode_Whisper = 2,    //  Not used 
             MonitorMode_Active  = 3    //  Not used 
    	} MonitorMode;


Note Silent Monitoring mode is the only mode supported in which the supervisor cannot talk to the agent.


DWORD PlayToneDirection

This parameter specifies whether a tone should be played at the agent or customer phone when monitoring starts. It can have following enum values:

enum 
    {
     PlayToneDirection_LocalOnly = 0,    
     PlayToneDirection_RemoteOnly,
     PlayToneDirection_BothLocalAndRemote,
     PlayToneDirection_NoLocalOrRemote
    } PlayToneDirection

Return Values

-	LINERR_OPERATIONFAILED
-	LINEERR_OPERATIONUNAVAIL
-	LINEERR_RESOURCEUNAVAIL
-	LINEERR_BIB_RESOURCE_UNAVAIL
-	LINERR_PENDING_REQUEST 
-	LINEERR_OPERATION_ALREADY_INPROGRESS
-	LINEERR_ALREADY_IN_REQUESTED_STATE
-	LINEERR_PRIMARY_CALL_INVALID
-	LINEERR_PRIMARY_CALL_STATE_INVALID

Start Call Recording

Use CCiscoLineDevSpecificStartCallRecording to allow applications to send a recording request for the active call on that line.


Note Be aware that this extension is only available if extension version 0x00080000 or higher is negotiated


CCiscoLineDevSpecific
|
+-- CCiscoLineDevSpecificStartCallRecording

Class Detail

class CCiscoLineDevSpecificStartCallRecording: public CCiscoLineDevSpecific
{
public:
CCiscoLineDevSpecificStartCallRecording () : 
CCiscoLineDevSpecific(SLDST_START_CALL_RECORDING) {}
	virtual ~    CCiscoLineDevSpecificStartCallRecording () {}

	DWORD m_ToneDirection;    
	// subtract out the virtual function table pointer
	virtual DWORD dwSize(void) const {return sizeof(*this)-4;} 
} ;

Parameters

DWORD m_MsgType

Equals SLDST_START_RECORDING

DWORD PlayToneDirection

This parameter specifies whether a tone should play at the agent or customer phone when recording starts. It can have following enum values:

enum 
    {
     PlayToneDirection_NoLocalOrRemote = 0, 
     PlayToneDirection_LocalOnly,    
     PlayToneDirection_RemoteOnly,
     PlayToneDirection_BothLocalAndRemote
    } PlayToneDirection

Return Values

-	LINERR_OPERATIONFAILED
-	LINEERR_OPERATIONUNAVAIL
-	LINEERR_INVALCALLHANDLE
-	LINEERR_BIB_RESOURCE_UNAVAIL
-	LINERR_PENDING_REQUEST 
-	LINERR_OPERATION_ALREADY_INPROGRESS

StopCall Recording

Use CCiscoLineDevSpecificStopCallRecording to allow application to stop recording a call on that line.


Note Be aware that this extension is only available if extension version 0x00080000 or higher is negotiated


CCiscoLineDevSpecific
|
+-- CCiscoLineDevSpecificStopCallRecording

Class Detail

class CCiscoLineDevSpecificStopCallRecording: public CCiscoLineDevSpecific
{
public:
CCiscoLineDevSpecificStopCallRecording () : 
CCiscoLineDevSpecific(SLDST_STOP_CALL_RECORDING) {}
	virtual ~    CCiscoLineDevSpecificStopCallRecording () {}

	// subtract out the virtual function table pointer
	virtual DWORD dwSize(void) const {return sizeof(*this)-4;} 
} ;

Parameters

DWORD m_MsgType

Equals SLDST_STOP_RECORDING

Return Values

-	LINERR_OPERATIONFAILED
-	LINEERR_OPERATIONUNAVAIL
-	LINEERR_INVALCALLHANDLE
-	LINERR_PENDING_REQUEST 

Cisco Line Device Feature Extensions

CCiscoLineDevSpecificFeature is the parent class. Currently, it has only one subclass: CCiscoLineDevSpecificFeature_DoNotDisturb, which allows applications to enable and disable the Do-Not-Disturb feature on a device.

This section describes line device feature-specific extensions to the TAPI structures that Cisco TSP supports and it contains the following:

LINEDEVCAPS

LINEDEVSTATUS

CCiscoLineDevSpecificFeature

Do-Not-Disturb

Do-Not-Disturb Change Notification Event

LINEDEVCAPS

The CiscoLineDevCaps_DevSpecificFlags structure contains line device capability extension flags that describe the Cisco line device specific extensions for device capabilities. The m_LineDevCaps_DevSpecificFeatureFlags field in that structure reflects extended device feature capabilities. Currently, Cisco TSP uses only the LINEDEVCAPS_DEVSPECIFICFEATURE_DONOTDISTURB (0x00000001) bit in that field.

//   Line device capability extention flags
typedef struct CiscoLineDevCaps_DevSpecificFlags
{
    DWORD m_LineDevCaps_DevSpecificFlags;           // LINEFEATURE_DEVSPECIFIC 
    DWORD m_LineDevCaps_DevSpecificFeatureFlags;    // LINEFEATURE_DEVSPECIFICFEAT
} CISCOLINEDEVCAPS_DEVSPECIFICFLAGS;

// Bit assignments
#define LINEDEVCAPS_DEVSPECIFICFEATURE_DONOTDISTURB   0x00000001  // Ext 00080000

LINEDEVSTATUS

The LINEDEVSTATUS_DEV_SPECIFIC_DATA structure contains data for all device-specific extensions that have been added to the TAPI LINEDEVSTATUS structure by the Cisco TSP. The CiscoLineDevStatus_DoNotDisturb structure belongs to the LINEDEVSTATUS_DEV_SPECIFIC_DATA structure and reflects the current state of the Do-Not-Disturb feature.


Note Be aware that this extension is only available if extension version 8.0 (0x00080000) or higher is negotiated.


//    LINEDEVSTATUS 00080000  extention    //
//    ---------------------------------
typedef struct CiscoLineDevStatus_DoNotDisturb
{
    DWORD m_LineDevStatus_DoNotDisturbOption;
    DWORD m_LineDevStatus_DoNotDisturbStatus;
} CISCOLINEDEVSTATUS_DONOTDISTURB;

The m_LineDevStatus_DoNotDisturbOption field contains DND option that is configured for the device and can be one of the following enum values:

enum CiscoDoNotDisturbOption {
    DoNotDisturbOption_NONE      = 0, 
    DoNotDisturbOption_RINGEROFF = 1,
    DoNotDisturbOption_REJECT    = 2 
};

The m_LineDevStatus_ DoNotDisturbStatus field contains current DND status on the device and can be one of the following enum values:

enum CiscoDoNotDisturbStatus {
    DoNotDisturbStatus_UNKNOWN  = 0, 
    DoNotDisturbStatus_ENABLED  = 1,
    DoNotDisturbStatus_DISABLED = 2
};

CCiscoLineDevSpecificFeature

This section provides information on how to invoke Cisco-specific TAPI extensions with the CCiscoLineDevSpecificFeature class, which is the parent class to all the following classes. This virtual class is provided here for informational purposes.

CCiscoLineDevSpecificFeature

Header File

The file CiscoLineDevSpecific.h contains the corresponding constant, structure and class definitions for the Cisco lineDevSpecificFeature extension classes.

Class Detail

class CCiscoLineDevSpecificFeature
{
public:
  CCicsoLineDevSpecificFeature(const DWORD msgType): m_MsgType(msgType) {;}
  virtual ~ CCicsoLineDevSpecificFeature() {;}
  DWORD GetMsgType(void) const {return m_MsgType;}
  void* lpParams(void) const {return (void*)&m_MsgType;}
  virtual DWORD dwSize(void) const = 0;
private:
  DWORD m_MsgType;
};

Functions

lpParms()

function can be used to obtain a pointer to the parameter block

dwSize()

function returns size of the parameter block area

Parameter

m_MsgType

Specifies the type of a message. The parameter value uniquely identifies the feature to invoke on the device. The PHONEBUTTONFUNCTION_ TAPI_Constants definition lists the valid feature identifiers. Currently the only recognized value is PHONEBUTTONFUNCTION_DONOTDISTURB (0x0000001A).

Each subclass of CCiscoLineDevSpecificFeature has a unique value assigned to the m_MsgType parameter.

Subclasses

Each subclass of CCiscoLineDevSpecificFeature carries a unique value that is assigned to the m_MsgType parameter. If you are using C instead of C++, this is the first parameter in the structure.

Do-Not-Disturb

Use the CCiscoLineDevSpecificFeature_DoNotDisturb class in conjunction with the request to enable or disable the DND feature on a device.

The Do-Not-Disturb feature gives phone users the ability to go into a Do Not Disturb (DND) state on the phone when they are away from their phones or simply do not want to answer the incoming calls. A phone softkey, DND, allows users to enable or disable this feature.

CCiscoLineDevSpecificFeature
|
+-- CCiscoLineDevSpecificFeature_DoNotDisturb

Class Detail

class CCiscoLineDevSpecificFeature_DoNotDisturb : public CCiscoLineDevSpecificFeature
{
public:
  CCiscoLineDevSpecificFeature_DoNotDisturb()
: CCiscoLineDevSpecificFeature(PHONEBUTTONFUNCTION_DONOTDISTURB),
	 m_Operation((CiscoDoNotDisturbOperation)0) {}
virtual ~CCiscoLineDevSpecificFeature_DoNotDisturb() {}
virtual DWORD dwSize(void) const {return sizeof(*this)-4;}

CiscoDoNotDisturbOperation  m_Operation;
};

Parameters

DWORD m_MsgType

Equals PHONEBUTTONFUNCTION_DONOTDISTURB.

CiscoDoNotDisturbOperation m_Operation

Specifies a requested operation and can be one of the following enum values:

enum CiscoDoNotDisturbOperation {
    DoNotDisturbOperation_ENABLE    = 1,
    DoNotDisturbOperation_DISABLE   = 2
};

Do-Not-Disturb Change Notification Event

Cisco TSP notifies applications via the LINE_DEVSPECIFICFEATURE message about changes in the DND configuration or status. To receive change notifications, an application needs to enable the DEVSPECIFIC_DONOTDISTURB_CHANGED message flag with a lineDevSpecific SLDST_SET_STATUS_MESSAGES request.

The LINE_DEVSPECIFICFEATURE message notifies the application about device-specific events that occur on a line device. In the case of a Do-Not-Disturb Change Notification, the message includes information about the type of change that occurred on a device and the resulting feature status or configured option.

Message Details

LINE_DEVSPECIFICFEATURE
dwDevice = (DWORD) hLine;
dwCallbackInstance = (DWORD) hCallback;
dwParam1 = (DWORD) PHONEBUTTONFUNCTION_DONOTDISTURB;
dwParam2 = (DWORD) typeOfChange;
dwParam3 = (DWORD) currentValue;

enum CiscoDoNotDisturbOption {
    DoNotDisturbOption_NONE      = 0, 
    DoNotDisturbOption_RINGEROFF = 1,
    DoNotDisturbOption_REJECT    = 2 
};

enum CiscoDoNotDisturbStatus {
    DoNotDisturbStatus_UNKNOWN  = 0, 
    DoNotDisturbStatus_ENABLED  = 1,
    DoNotDisturbStatus_DISABLED = 2
};

enum CiscoDoNotDisturbNotification {
    DoNotDisturb_STATUS_CHANGED  = 1,
    DoNotDisturb_OPTION_CHANGED  = 2
};

Parameters

dwDevice

A handle to a line device

dwCallbackInstance

The callback instance supplied when opening the line

dwParam1

Always equal to PHONEBUTTONFUNCTION_DONOTDISTURB for the Do-Not-Disturb change notification

dwParam2

Indicate type of change and can have one of the following enum values:

enum CiscoDoNotDisturbNotification {
    DoNotDisturb_STATUS_CHANGED  = 1,
    DoNotDisturb_OPTION_CHANGED  = 2
};

dwParam3

If the dwParm2 indicates status change with the value DoNotDisturb_STATUS_CHANGED, this parameter can have one of the following enum values:

enum CiscoDoNotDisturbStatus {
    DoNotDisturbStatus_UNKNOWN  = 0, 
    DoNotDisturbStatus_ENABLED  = 1,
    DoNotDisturbStatus_DISABLED = 2
};

If the dwParm2 indicates option change with the value DoNotDisturb_OPTION_CHANGED, this parameter can have one of the following enum values:

enum CiscoDoNotDisturbOption {
    DoNotDisturbOption_NONE      = 0, 
    DoNotDisturbOption_RINGEROFF = 1,
    DoNotDisturbOption_REJECT    = 2 
};

Cisco Phone Device-Specific Extensions

Table 6-2 lists the subclasses of CiscoPhoneDevSpecific.

Table 6-2 Cisco Phone Device-Specific TAPI functions 

Cisco Functions
Synopsis

CCiscoPhoneDevSpecific

The CCiscoPhoneDevSpecific class is the parent class to the following classes.

CCiscoPhoneDevSpecificDataPassThrough

Allows application to send the Device Specific XSI data through CTI.

CCiscoPhoneDevSpecificAcquire

Allows application to acquire any CTI-controllable device that can be opened later in superprovider mode.

CCiscoPhoneDevSpecificDeacquire

Allows application to deacquire a CTI-controllable device that was explicitly acquired.

CCiscoPhoneDevSpecificGetRTPSnapshot

Allows application to request secure RTP indicator for calls on the device.


CCiscoPhoneDevSpecific

This section provides information on how to perform Cisco TAPI specific functions with the CCiscoPhoneDevSpecific class, which is the parent class to all the following classes. This virtual class is provided here for informational purposes.

CCiscoPhoneDevSpecific
|
+-- CCiscoPhoneDevSpecificDataPassThrough

Header File

The file CiscoLineDevSpecific.h contains the constant, structure, and class definition for the Cisco phone device-specific classes.

Class Detail

class CCiscoPhoneDevSpecific
{
	public :
		CCiscoPhoneDevSpecific(DWORD msgType):m_MsgType(msgType) {;}
		virtual ~CCiscoPhoneDevSpecific() {;}
		DWORD GetMsgType (void) const { return m_MsgType;}
		void *lpParams(void) const {return (void*)&m_MsgType;}
		virtual DWORD dwSize(void) const = 0;
	private :
		DWORD m_MsgType ;
}

Functions

lpParms()

function can be used to obtain the pointer to the parameter block

dwSize()

function will give the size of the parameter block area

Parameter

m_MsgType

specifies the type of message.

Subclasses

Each subclass of CCiscoPhoneDevSpecific has a different value assigned to the parameter m_MsgType. If you are using C instead of C++, this is the first parameter in the structure.

Enumeration

Valid message identifiers are found in the CiscoPhoneDevSpecificType enumeration.


enum CiscoLineDevSpecificType {
CPDST_DEVICE_DATA_PASSTHROUGH_REQUEST = 1
};

CCiscoPhoneDevSpecificDataPassThrough

XSI enabled IP phones allow applications to directly communicate with the phone and access XSI features (e.g. manipulate display, get user input, play tone, etc.). In order to allow TAPI applications access to some of these XSI capabilities without having to setup and maintain an independent connection directly to the phone, TAPI will provide the ability to send device data through the CTI interface. This feature is exposed as a Cisco Unified TSP device specific extension.

PhoneDevSpecificDataPassthrough request is only supported for the IP phone devices. Application has to open a TAPI phone device with minimum extension version 0x00030000 to make use of this feature.

The CCiscoPhoneDevSpecificDataPassThrough class is used to send the device specific data to CTI controlled IP Phone devices.


Note This extension requires applications to negotiate extension version as 0x00030000.


CCiscoPhoneDevSpecific
|
+-- CCiscoPhoneDevSpecificDataPassThrough

Class Detail

class CCiscoPhoneDevSpecificDataPassThrough : public CCiscoPhoneDevSpecific
{
public:
	CCiscoPhoneDevSpecificDataPassThrough () : 
    CCiscoPhoneDevSpecific(CPDST_DEVICE_DATA_PASSTHROUGH_REQUEST) 
	{
	  memset((char*)m_DeviceData, 0, sizeof(m_DeviceData)) ;
	}
	virtual ~CCiscoPhoneDevSpecificDataPassThrough() {;}
	// data size determined by MAX_DEVICE_DATA_PASSTHROUGH_SIZE
	TCHAR m_DeviceData[MAX_DEVICE_DATA_PASSTHROUGH_SIZE] ;
	// subtract out the virtual funciton table pointer size
	virtual DWORD dwSize (void) const {return (sizeof (*this)-4) ;} 
}

Parameters

DWORD m_MsgType

equals CPDST_DEVICE_DATA_PASSTHROUGH_REQUEST.

DWORD m_DeviceData

This is the character buffer that contains the XML data to be sent to phone device


Note MAX_DEVICE_DATA_PASSTHROUGH_SIZE = 2000


A phone can pass data to an application and it can be retrieved by using PhoneGetStatus (PHONESTATUS:devSpecificData). See PHONESTATUS description for further details.

CCiscoPhoneDevSpecificAcquire

The CCiscoPhoneDevSpecificAcquire class is used to explicitly acquire any CTI controllable device.

If a Superprovider application needs to open any CTI Controllable device on the Cisco Unified Communications Manager system. The application should explicitly acquire that device using the above interface. After successful response, it can open the device as usual.


Note This extension is only available if extension version 0x00070000 or higher is negotiated.


CCiscoPhoneDevSpecific
|
+-- CCiscoPhoneDevSpecificAcquire

Class Details

class CCiscoPhoneDevSpecific Acquire : public CCiscoPhoneDevSpecific
{
    public:
CCiscoPhoneDevSpecificAcquire () : CCiscoPhoneDevSpecific (CPDST_ACQUIRE) {}
        virtual ~ CCiscoPhoneDevSpecificAcquire () {}
        char m_DeviceName[16];
        virtual DWORD dwSize(void) const {return sizeof(*this)-4;} 
        // subtract out the virtual function table pointer
};

Parameters

DWORD m_MsgType

equals CPDST_ACQUIRE

char m_DeviceName[16]

The DeviceName that needs to be explicitly acquired.

CCiscoPhoneDevSpecificDeacquire

The CCiscoPhoneDevSpecificDeacquire class is used to explicitly de-acquire an explicitly acquired device.

If a SuperProvider application has explicitly acquired any CTI Controllable device on the Communications Manager system, then the application should explicitly de-acquire that device using this interface.


Note This extension is only available if extension version 0x00070000 or higher is negotiated.


CCiscoPhoneDevSpecific
|
+-- CCiscoPhoneDevSpecificDeacquire

Class Details

class CCiscoPhoneDevSpecificDeacquire : public CCiscoPhoneDevSpecific
{
    public:
CCiscoPhoneDevSpecificDeacquire () : CCiscoPhoneDevSpecific (CPDST_ACQUIRE) {}
        virtual ~ CCiscoPhoneDevSpecificDeacquire () {}
        char m_DeviceName[16];
        virtual DWORD dwSize(void) const {return sizeof(*this)-4;} 
        // subtract out the virtual function table pointer
};

Parameters

DWORD m_MsgType

equals CPDST_DEACQUIRE

char m_DeviceName[16]

The DeviceName that needs to be explicitly de-acquired.

CCiscoPhoneDevSpecificGetRTPSnapshot

The CCiscoPhoneDevSpecificGetRTPSnapshot class is used to request Call RTP snapshot event from the device. There will be LineCallDevSpecific event for each call on the device.


Note This extension is only available if extension version 0x00070000 or higher is negotiated.


CCiscoPhoneDevSpecific
|
+-- CCiscoPhoneDevSpecificGetRTPSnapshot

Class Details

class CCiscoPhoneDevSpecificGetRTPSnapshot: public CCiscoPhoneDevSpecific
{
    public:
CCiscoPhoneDevSpecificGetRTPSnapshot () : CCiscoPhoneDevSpecific 
(CPDST_REQUEST_RTP_SNAPSHOT_INFO) {}
        virtual ~ CCiscoPhoneDevSpecificGetRTPSnapshot () {}
        char m_DeviceName[16];
        virtual DWORD dwSize(void) const {return sizeof(*this)-4;} 
        // subtract out the virtual function table pointer
};

Parameters

DWORD m_MsgType

equals CPDST_DEACQUIRE

char m_DeviceName[16]

The DeviceName that needs to be explicitly de-acquired.

Messages

This section describes the line device specific messages that the Cisco Unified TSP supports. An application receives nonstandard TAPI messages in the following LINE_DEVSPECIFIC messages:

A message to signal when to stop and start streaming RTP audio.

A message that contains the call handle of active calls when the application starts up.

A message indicating to set the RTP parameters based on the data of the message.

A message indicating secure media status.

The message type is an enumerated integer with the following values:

enum CiscoLineDevSpecificMsgType
{
	SLDSMT_START_TRANSMISION = 1,
	SLDSMT_STOP_TRANSMISION,
	SLDSMT_START_RECEPTION,
	SLDSMT_STOP_RECEPTION,
	SLDSMT_LINE_EXISTING_CALL,
	SLDSMT_OPEN_LOGICAL_CHANNEL,
	SLDSMT_CALL_TONE_CHANGED,
	SLDSMT_LINECALLINFO_DEVSPECIFICDATA,
	SLDSMT_NUM_TYPE,
	SLDSMT_LINE_PROPERTY_CHANGED,
	SLDSMT_MONITORING_STARTED,
	SLDSMT_MONITORING_ENDED,
	SLDSMT_RECORDING_STARTED,
	SLDSMT_RECORDING_ENDED
};

Start Transmission Events

SLDSMT_START_TRANSMISION

When a message is received, the RTP stream transmission should commence.

dwParam2 specifies the network byte order IP address of the remote machine to which the RTP stream should be directed.

dwParam3, specifies the high-order word that is the network byte order IP port of the remote machine to which the RTP stream should be directed.

dwParam3, specifies the low-order word that is the packet size in milliseconds to use.

The application receives these messages to signal when to start streaming RTP audio. At extension version 1.0 (0x00010000), the parameters have the following format:

dwParam1 contains the message type.

dwParam2 contains the IP address of the remote machine.

dwParam3 contains the network byte order IP port of the remote machine to which the RTP stream should be directed in the high-order word and the packet size in milliseconds in the low-order word.

At extension version 2.0 (0x00020000), start transmission has the following format:

dwParam1:from highest order bit to lowest

First two bits blank

Precedence value 3 bits

Maximum frames per packet 8 bits

G723 bit rate 2 bits

Silence suppression value 1 bit

Compression type 8 bits

Message type 8 bits

dwParam2 contains the IP address of the remote machine

dwParam3 contains the network byte order IP port of the remote machine to which the RTP stream should be directed in the high-order word and the packet size in milliseconds in the low-order word.

At extension version 4.0 (0x00040000), start transmission has the following format:

hCall - The call of the Start Transmission event

dwParam1:from highest order bit to lowest

First two bits blank

Precedence value 3 bits

Maximum frames per packet 8 bits

G723 bit rate 2 bits

Silence suppression value 1 bit

Compression type 8 bits

Message type 8 bits

dwParam2 contains the IP address of the remote machine

dwParam3 contains the network byte order IP port of the remote machine to which the RTP stream should be directed in the high-order word and the packet size in milliseconds in the low-order word.

Start Reception Events

SLDSMT_START_RECEPTION

When a message is received, the RTP stream reception should commence.

dwParam2 specifies the network byte order IP address of the local machine to use.

dwParam3, specifies the high-order word that is the network byte order IP port to use.

dwParam3, specifies the low-order high-order word that is the packet size in milliseconds to use.

When a message is received, the RTP stream reception should commence.

At extension version 1, the parameters have the following format:

dwParam1 contains the message type.

dwParam2 contains the IP address of the remote machine.

dwParam3 contains the network byte order IP port of the remote machine to which the RTP stream should be directed in the high-order word and the packet size in milliseconds in the low-order word.

At extension version 2 start reception has the following format:

dwParam1:from highest order bit to lowest

First 13 bits blank

G723 bit rate 2 bits

Silence suppression value 1 bit

Compression type 8 bits

Message type 8 bits

dwParam2 contains the IP address of the remote machine

dwParam3 contains the network byte order IP port of the remote machine to which the RTP stream should be directed in the high-order word and the packet size in milliseconds in the low-order word.

At extension version 4.0 (0x00040000), start reception has the following format:

hCall - The call of the Start Reception event

dwParam1:from highest order bit to lowest

First 13 bits blank

G723 bit rate 2 bits

Silence suppression value 1 bit

Compression type 8 bits

Message type 8 bits

dwParam2 contains the IP address of the remote machine

dwParam3 contains the network byte order IP port of the remote machine to which the RTP stream should be directed in the high-order word and the packet size in milliseconds in the low-order word.

Stop Transmission Events

SLDSMT_STOP_TRANSMISION

When a message is received, transmission of the streaming should be stopped.

At extension version 1.0 (0x00010000), stop transmission has the following format:

dwParam1 - Message type

At extension version 4.0 (0x00040000), stop transmission has the following format:

hCall - The call the Stop Transmission event is for

dwParam1 - Message type

Stop Reception Events

SLDSMT_STOP_RECEPTION

When a message is received, reception of the streaming should be stopped.

At extension version 1.0 (0x00010000), stop reception has the following format:

dwParam1 - message type

At extension version 4.0 (0x00040000), stop reception has the following format:

hCall - The call the Stop Reception event is for

dwParam1 - Message type

Existing Call Events

SLDSMT_LINE_EXISTING_CALL

These events inform the application of existing calls in the PBX when it starts up. The format of the parameters is as follows:

dwParam1 - Message type

dwParam2 - Call object

dwParam3 - TAPI call handle

Open Logical Channel Events

SLDSMT_OPEN_LOGICAL_CHANNEL

When a call has media established at a CTI Port or Route Point that is registered for Dynamic Port Registration, this message is received indicating that an IP address and UDP port number needs to be set for the call.


Note This extension is only available if extension version 0x00040000 or higher gets negotiated.


The following is the format of the parameters:

hCall - The call the Open Logical Channel event is for

dwParam1 - Message type

dwParam2 - Compression Type

dwParam3 - Packet size in milliseconds

LINECALLINFO_DEVSPECIFICDATA Events

SLDSMT_LINECALLINFO_DEVSPECIFICDATA

This message indicates DEVSPECIFICDATA information change in the DEVSPECIFIC portion of the LINECALLINFO structure for SRTP, QoS, Partition support, call security status, CallAttributeInfo, and CCM CallID.


Note SRTP, QoS , Partition support is available only if extension version 0x00070000 or higher is negotiated.

Call security status, CallAttributeInfo and CCM CallID is available only if extension version 0x00080000 or higher is negotiated.


The format of the parameters is:

hCall - The call handle

dwParam1 - Message type

SLDSMT_LINECALLINFO_DEVSPECIFICDATA\

dwParam2 - This is a bitMask Indicator field for SRTP, QoS and Partition.

SLDST_SRTP_INFO | SLDST_QOS_INFO | SLDST_PARTITION_INFO | 
SLDST_EXTENDED_CALL_INFO|SLDST_CALL_SECURITY_STATUS|SLDST_CALL_ATTRIBUTE_INFO 
|SLDST_CCM_CALLID

The bit mask values are:

SLDST_SRTP_INFO = 0x00000001
SLDST_QOS_INFO = 0x00000002
SLDST_PARTITION_INFO = 0x00000004
SLDST_EXTENDED_CALL_INFO = 0x00000008
SLDST_CALL_ATTRIBUTE_INFO = 0x00000010
SLDST_CCM_CALLID                     = 0x00000020
|SLDST_CALL_SECURITY_STATUS=0x00000040

For example, if there are changes in SRTP and QoS but not in Partition, then both the SLDST_SRTP_INFO and SLDST_QOS_INFO bits will be set. The value for dwParam2 = SLDST_SRTP_INFO | SLDST_QOS_INFO = 0x00000011.

dwParam3

If there is a change in the SRTP Information, then this field would contain the CiscoSecurityIndicator.

enum CiscoSecurityIndicator
{
    SRTP_MEDIA_ENCRYPT_KEYS_AVAILABLE,
    SRTP_MEDIA_ENCRYPT_USER_NOT_AUTH,
    SRTP_MEDIA_ENCRYPT_KEYS_UNAVAILABLE,
    SRTP_MEDIA_NOT_ENCRYPTED
};

Note dwParam3 is used when dwParam2 has the SRTP bit mask set.


Call Tone Changed Events

SLDSMT_CALL_TONE_CHANGED

When a tone change occurs on a call, this message is received indicating the tone and the feature that caused the tone change.


Note This extension is only available if extension version 0x00050000 or higher is negotiated. In the Cisco Unified TSP 4.1 release and beyond, this event will only be sent for Call Tone Changed Events where the tone is CTONE_ZIPZIP and the tone is being generated as a result of the FAC/CMC feature.


The format of the parameters is as follows:

hCall—The call that the Call Tone Changed event is for

dwParam—Message type

dwParam2—CTONE_ZIPZIP, 0x31 (Zip Zip tone)

dwParam3—If dwParam2 is CTONE_ZIPZIP, this parameter contains a bitmask with the following possible values:

CZIPZIP_FACREQUIRED—If this bit is set, it indicates that a FAC is required.

CZIPZIP_CMCREQUIRED—If this bit is set, it indicates that a CMC is required.


Note For a DN that requires both codes, the first event is always for the FAC and CMC code. The application has the option to send both codes separated by # in the same request. The second event generation is optional based on what the application sends in the first request.