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

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

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

CCMCallID contains CCM Call identifier value.

CallingPartyIPAddress contains the IP address of the calling party if the calling party device supports it.

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

DWORD TapiCallerPartyUnicodeNameOffset;
DWORD TapiCallerPartyUnicodeNameSize;
DWORDTapiCallerPartyLocale;

DWORD TapiCalledPartyUnicodeNameOffset;
DWORD TapiCalledPartyUnicodeNameSize;
DWORDTapiCalledPartyLocale;

DWORD TapiConnectedPartyUnicodeNameOffset;
DWORD TapiConnectedPartyUnicodeNameSize;
DWORDTapiConnectedPartyLocale;

DWORD TapiRedirectionPartyUnicodeNameOffset;
DWORD TapiRedirectionPartyUnicodeNameSize;
DWORDTapiRedirectionPartyLocale;

DWORD TapiRedirectingPartyUnicodeNameOffset;
DWORD TapiRedirectingPartyUnicodeNameSize;
DWORDTapiRedirectingPartyLocale;

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;
DWORD IsChaperoneCall;
DWORD UniqueCallRefIDInfoOffset,
DWORD UniqueCallRefIDInfoSize;
DWORD CallAttributeBitMask; 

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

typedef struct SRTPKeyInformation
{
DWORDIsSRTPDataAvailable;
DWORDSecureMediaIndicator;// CiscoSecurityIndicator
DWORDMasterKeyOffset;
DWORDMasterKeySize;
DWORDMasterSaltOffset;
DWORDMasterSaltSize;
DWORDAlgorithmID;// CiscoSRTPAlgorithmIDs
DWORDIsMKIPresent;
DWORDKeyDerivationRate;
} 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, rest of the information from SRTPKeyInformation must be ignored.

If MasterKeySize or MasterSlatSize is set to 0, then corresponding MasterKeyOffset or MasterSaltOffset must be ignored.

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
DWORDdwUserSize;
DWORDdwHostOffset; //host name string
DWORDdwHostSize;
DWORDdwPort;// 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;
DWORD OverallCallSecurityStatus;
}

typedef struct CallAttributeInfo_ExtA0
{
DWORD CallAttributeType;
DWORD PartyDNOffset;
DWORD PartyDNSize;
DWORD PartyPartitionOffset;
DWORD PartyPartitionSize;
DWORD DeviceNameOffset;
DWORD DeviceNameSize;
DWORD OverallCallSecurityStatus;
DWORD TransactionID;//Secure R & M
} CallAttributeInfo_ExtA0;

typedef struct CallAttributeInfo_ExtB0
{
CallAttributeInfo_ExtA0 attr_a0;
DWORD ActiveToneDirection;
} CallAttributeInfo_ExtB0;

typedef struct CCMCallHandleInformation
{
DWORD CCMCallID;
}

enum 
{
    CallAttribute_Regular                    = 0,
    CallAttribute_SilentMonitorCall,  
    CallAttribute_SilentMonitorCall_Target,
    CallAttribute_RecordedCall,
    CallAttribute_WhisperCoachingCall, 
    CallAttribute_WhisperCoachingCall_Target,
    CallAttribute_Recorded_Automatic,
    CallAttribute_Recorded_AppInitiatedSilent,
    CallAttribute_Recorded_UserInitiatedFromApp,
    CallAttribute_Recorded_UserInitiatedFromDevice
} CallAttributeType
typedef struct CallSecurityStausInfo
{
DWORD CallSecurityStaus
} CallSecurityStausInfo
enum OverallCallSecurityStatus
{
OverallCallSecurityStatus_Unknown = 0,
OverallCallSecurityStatus_NotAuthenticated,
OverallCallSecurityStatus_Authenticated,
OverallCallSecurityStatus_Encrypted
};

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
};

typedef struct Cisco_LineCallInfo_Ext000A0000
{
     …
   //HuntList 
    DWORD HuntPilotInfoOffset;//point to HuntPoiltInfo
    DWORD HuntPilotInfoSize;
    DWORD HuntPilotInfoCount;
    DWORD HuntPilotInfoElementFixedSize;
}CISCO_LINECALLINFO_EXT000A0000;

//HuntList
typedef struct HuntPilotInfo
{
DWORD CallingPartyHuntPilotDNOffset;
DWORD CallingPartyHuntPilotDNSize;
DWORD CallingPartyHuntPilotPartitionOffset;
DWORD CallingPartyHuntPilotPartitionSize;
DWORD CalledPartyHuntPilotDNOffset;
DWORD CalledPartyHuntPilotDNSize;
DWORD CalledPartyHuntPilotPartitionOffset;
DWORD CalledPartyHuntPilotPartitionSize;
DWORD ConnectedPartyHuntPilotDNOffset;
DWORD ConnectedPartyHuntPilotDNSize;
DWORD ConnectedPartyHuntPilotPartitionOffset;
DWORD ConnectedPartyHuntPilotPartitionSize;
}HuntPilotInfo;

typedef struct UniqueCallRefIDInfo
{
DWORD UniqueCallRefIDOffset;
DWORD UniqueCallRefIDSize;
} UniqueCallRefIDInfo;

typedef enum
{
TSPCallAttribute_Normal =                   0x00000000,
TSPCallAttribute_IntercomOriginator =       0x00000001,
TSPCallAttribute_IntercomTarget =           0x00000002,
TSPCallAttribute_SilentMonitorCall =        0x00000004,
TSPCallAttribute_SilentMonitorCall_Target = 0x00000008,
TSPCallAttribute_RecordedCall =             0x00000010,
TSPCallAttribute_ChaperoneCall =            0x00000020,
TSPCallAttribute_CallForwardAllSet =        0x00000040,
TSPCallAttribute_CallForwardAllClear =      0x00000080,
TSPCallAttribute_WhisperMonitorCall =       0x00000100,
TSPCallAttribute_WhisperMonitorCall_Target= 0x00000200,
TSPCallAttribute_BIBCall =              0x00000400,
TSPCallAttribute_ServerCall =0x00000800,
TSPCallAttribute_SendMediaToBIB =        0x00001000
} CallAttributeBits

Cisco TSP exposes the multimedia capability information of a linedevice in the devspecific data of LINEGETCALLINFO when LineGetCallInfo is invoked with Extension version 0x000D0000 or higher.

The calling party and the called party multimedia capability is exposed as a structure DeviceVideoCapInfo in the DevSpecific part. This structure contains three fields:

• deviceVideoCapability,

• telepresenceInfo, and,

• screenCount.

  typedef struct DeviceVideoCapInfo{
      DWORD VideoCapStatus;
      DWORD TelepresenceInfo;
      DWORD ScreenCount;
  } DeviceVideoCapInfo;
  
  

enum CiscoDeviceVideoCapabilityInfo
{
    CiscoDeviceVideoCapability_None =          0x00000000,
    CiscoDeviceVideoCapability_Enabled =       0x00000001,
};

enum CiscoDeviceTelepresenceInfo
{
    CiscoDeviceTelepresence_None =          0x00000000,
    CiscoDeviceTelepresence_Enabled =       0x00000001,
};

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 | SLDST_NUMBER_TYPE_CHANGED | 
SLDST_GLOBALIZED_CALLING_PARTY_CHANGED | SLDST_FAR_END_IP_ADDRESS_CHANGED | 
SLDST_UNIQUE_CALL_REF_ID_INFO | SLDST_DEVICE_VIDEO_CAP_INFO | SLDST_MULTIMEDIA_STREAMS_INFO
dwParam3 = …
  dwParam3 will be security indicator if dwParam2 has bit set for SLDST_SRTP_INFO
}

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    //
//   Status extention 00080000 Data Structure//
typedef struct Cisco_LineDevStatus_Ext00080000
{
CISCOLINEDEVSTATUS_DONOTDISTURB doNotDisturbStatus;
} CISCO_LINEDEVSTATUS_EXT00080000;

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 gets used to reflect the current state of the Do Not Disturb feature.

DWORD dwSupportEncoding

This parameter indicates the Support Encoding for the Unicode Party names that are 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 device 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 comprise 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.

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

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;
  };

lpParms()

You can use function to obtain the pointer to the parameter block.

dwSize()

Function will give the size of the parameter block area.

m_MsgType

Specifies the type of message.

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

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 CiscoTSP 3.4 and Beyond
SLDST_REDIRECT_RESET_ORIG_CALLED,
SLDST_REDIRECT_SET_ORIG_CALLED,
SLDST_USER_RECEIVE_RTP_INFO,
SLDST_USER_SET_RTP_INFO,
SLDST_JOIN,
SLDST_REDIRECT_FAC_CMC,
SLDST_BLIND_TRANSFER_FAC_CMC,
SLDST_CTI_PORT_THIRD_PARTY_MONITOR,
SLDST_ACQUIRE,  
SLDST_DE_ACQUIRE, 
SLDST_USER_SET_SRTP_ALGORITHM_ID, 
SLDST_SEND_LINE_OPEN, 
SLDST_START_CALL_MONITORING, 
SLDST_START_CALL_RECORDING, 
SLDST_STOP_CALL_RECORDING, 
SLDST_LINE_SET_INTERCOM_SPEEDDIAL, 
SLDST_LINE_INTERCOM_TALKBACK, 
SLDST_REDIRECT_WITH_FEATURE_PRIORITY,
SLDST_USER_SET_RTP_INFO_IPv6, 
SLDST_USER_SET_IPv6_ADDRESS_AND_MODE,  
SLDST_SETUP_TRANSFER_WITHOUT_MEDIA, 
SLDST_DIRECT_TRANSFER, 
SLDST_MSG_SUMMARY,
SLDST_MSG_SUMMARY_DIRN,
SLDST_CALLPICKUP_GROUP_REGISTER,  
SLDST_CALLPICKUP_GROUP_UNREGISTER,
SLDST_CALLPICKUP_CALL,
SLDST_PLAY_TONE,
SLDST_START_SEND_MEDIA_TO_BIB,
SLDST_STOP_SEND_MEDIA_TO_BIB,
SLDST_UPDATE_MONITOR_MODE,
SLDST_ENABLE_FEATURE_SUPPORT,
SLDST_ADD_REMOTE_DESTINATION,
SLDST_REMOVE_REMOTE_DESTINATION,
SLDST_UPDATE_REMOTE_DESTINATION,
SLDST_HOLD_EX
SLDST_REDIRECT_EX
};

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

DWORD m_MsgType

Equals SLDST_MSG_WAITING.

DWORD m_BlinkRate

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

Note	Cisco Unified IP Phone 7900 Series supports only PHONELAMPMODE_OFF and PHONELAMPMODE_STEADY

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];
};

DWORD m_MsgType

Specifies SLDST_MSG_WAITING_DIRN.

DWORD m_BlinkRate

As in the CCiscoLineDevSpecificMsgWaiting message.

Note	Cisco Unified IP Phone 7900 Series supports only PHONELAMPMODE_OFF and PHONELAMPMODE_STEADY

char m_Dirn[25]

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

class CCiscoLineDevSpecificSetMsgSummary : public CCiscoLineDevSpecific
{
public:
  CCiscoLineDevSpecificSetMsgSummary() : CCiscoLineDevSpecific(SLDST_MSG_SUMMARY){}
  virtual ~CCiscoLineDevSpecificSetMsgSummary() {}
  virtual DWORD dwSize(void) const {return sizeof(*this)-4;}
  DWORD m_BlinkRate;
  MSG_SUMMARY m_MessageSummary;
};

DWORD m_MsgType

equals SLDST_MSG_SUMMARY.

DWORD m_BlinkRate

is any supported PHONELAMPMODE_constants specified in the phoneSetLamp() function.

MSG_SUMMARY m_MessageSummary

A data structure with the following format:

typedef struct {
DWORD m_voiceCounts;  // indicates if new voice counts are
                      //  provided. True = counts will be displayed
                      //  on supported phones.
DWORD m_totalNewVoiceMsgs; // specifies the total number of new 
                      // voice messages. This number includes all 
                      // the high and normal priority voice 
                      // messages that are new.
DWORD m_totalOldVoiceMsgs; // specifies the total number of old 
                      // voice messages. This number includes all 
                      // high and normal priority voice messages 
                      // that are old.
DWORD m_highPriorityVoiceCounts; // indicates if old voice 
                      // counts are provided. True = counts will be 
                      // displayed on supported phones.
DWORD m_newHighPriorityVoiceMsgs; //specifies the number of new 
                      // high priority voice messages.
DWORD m_oldHighPriorityVoiceMsgs; //specifies the number of old 
                      // high priority voice messages.
DWORD m_faxCounts;    // indicates if new fax counts are 
                      // provided. True = counts will be displayed
                      // on supported phones.
DWORD m_totalNewFaxMsgs; // specifies the total number of new 
                      // fax messages. This number includes all 
                      // the high and normal priority fax 
                      // messages that are new.
DWORD m_totalOldFaxMsgs; // specifies the total number of old 
                      // fax messages. This number includes all 
                      // high and normal priority fax messages 
                      // that are old.
DWORD m_highPriorityFaxCounts; // indicates if old fax counts 
                      //  are provided. True = counts will be
                      //  displayed on supported phones.
DWORD m_newHighPriorityFaxMsgs; // specifies the number of new 
                      // high priority fax messages.
DWORD m_oldHighPriorityFaxMsgs; // specifies the number of old 
                      // high priority fax messages.
       } MSG_SUMMARY;

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

DWORD m_MsgType

equals SLDST_MSG_SUMMARY_DIRN.

DWORD m_BlinkRate

is as in the CCiscoLineDevSpecificSetMsgSummary message.

char m_Dirn[25]

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

MSG_SUMMARY m_MessageSummary

A data structure with the following format:

  typedef struct {
 DWORD m_voiceCounts; // indicates if new voice counts are
                       //  provided. True = counts will be displayed
                       //  on supported phones.
 DWORD m_totalNewVoiceMsgs; // specifies the total number of new
                       // voice messages. This number includes all
                       // the high and normal priority voice
                       // messages that are new.
 DWORD m_totalOldVoiceMsgs; // specifies the total number of old
                       // voice messages. This number includes all
                       // high and normal priority voice messages 
                       // that are old.
 DWORD m_highPriorityVoiceCounts; // indicates if old voice 
                       // counts are provided. True = counts will be 
                       // displayed on supported phones.
 DWORD m_newHighPriorityVoiceMsgs; //specifies the number of new
                       // high priority voice messages.
 DWORD m_oldHighPriorityVoiceMsgs; //specifies the number of old 
                       // high priority voice messages.
 DWORD m_faxCounts; // indicates if new fax counts are
                       //  provided. True = counts will be displayed
                       //  on supported phones.
 DWORD m_totalNewFaxMsgs; // specifies the total number of new 
                       // fax messages. This number includes all 
                       // the high and normal priority fax
                       // messages that are new.
 DWORD m_totalOldFaxMsgs; // specifies the total number of old 
                       // fax messages. This number includes all 
                       // high and normal priority fax messages
                       // that are old.
 DWORD m_highPriorityFaxCounts; // indicates if old fax counts
                       //  are provided. True = counts will be
                       //  displayed on supported phones.
 DWORD m_newHighPriorityFaxMsgs; // specifies the number of new
                       // high priority fax messages.
 DWORD m_oldHighPriorityFaxMsgs; // specifies the number of old 
                       // high priority fax messages.
        } MSG_SUMMARY;

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;}
 };

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 gets set to 20.

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

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

Use the CCiscoLineDevSpecificSetStatusMsgs class to turn on or off the status messages for the line that the hLine parameter specifies. 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 turns 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 turns off the reporting of call tone changed events for that line.

• DEVSPECIFIC_SILENT_MONITORING_TERMINATED—Setting this flag on a line turns on the reporting of Monitoring Session Terminated Event messages for that line. Clearing this flag turns off the reporting of Monitoring Session Terminated Event Messages for that line.

• DEVSPECIFIC_GET_IP_PORT—Setting this flag on a line turns on the reporting of Get IP and Port Notification Event messages for that line. Clearing this flag turns off the reporting of Get IP and Port Notification Event Messages for that line.

• DEVSPECIFIC_HOLD_REVERSION—Setting this flag on a line causes the application to receive a LINE_DEVSPECIFIC(dwParam1 = SLDSMT_HOLD_REVERSION) when a hold reversion happens on a held call. Clearing this flag on a line turns off the reporting of the LINE_DEVSPECIFIC(dwParam1 = SLDSMT_HOLD_REVERSION) event.

• DEVSPECIFIC_IDLE_TRANSFER_REASON—Setting this flag on a line causes the reason to be reported as LINECALLREASON_TRANSFER when calls go to the LINECALLSTATE_IDLE state after a transfer is completed at the transfer controller. Clearing this flag on a line causes the reason to be reported as LINECALLREASON_DIRECT when calls go to the LINECALLSTATE_IDLE state after a transfer is completed at the transfer controller.

• DEVSPECIFIC_SPEEDDIAL_CHANGED—Setting this flag on a line causes a LINE_DEVSPECIFIC(dwParam1 = SLDSMT_LINE_PROPERTY_CHANGED, dwParam2 = LPCT_INTERCOM_LINE, and dwParam3 = CiscoIntercomLineChangeResult) to be fired to the application when there is a change in the database or the application overwrites the speed dial setting. Clearing this flag turns off the reporting of the LINE_DEVSPECIFIC(dwParam1 = SLDSMT_LINE_PROPERTY_CHANGED, dwParam2 = LPCT_INTERCOM_LINE, and dwParam3 = CiscoIntercomLineChangeResult) event.

• DEVSPECIFIC_DONOTDISTURB_CHANGED—Setting this flag on a line causes a LINE_DEVSPECIFICFEATURE(dwParam1 = PHONEBUTTONFUNCTION_DONOTDISTURB, dwParam2 = typeOfChange, and dwParam3 = currentValue) to be fired to the application when there is a change in the DND configuration or status. Clearing this flag turns off the reporting of the LINE_DEVSPECIFICFEATURE(dwParam1 = PHONEBUTTONFUNCTION_DONOTDISTURB, dwParam2 = typeOfChange, and dwParam3 = currentValue) event.

• DEVSPECIFIC_DISPLAYABLE_ADDRESS—Setting this flag on a line causes the DisplayableAddress field in LINECALLINFO to be filled with the latest called partyDN/ASCCI name/Unicode name/Partition (separated by ":"). Clearing this flag causes the DisplayableAddress field in LINECALLINFO to be empty.

• DEVSPECIFIC_DEVICE_STATE—Setting this flag gets the accumulative state of all the lines on the device and with the state being fired to the application using the LINE_DEVSPECIFIC(dwParam1 = SLDSMT_DEVICE_STATE, dwParam2 = State) events. Clearing this flag turns off the reporting of the accumulative state of all the lines on the device.

  The DEVSPECIFIC_DEVICE_STATE state is defined as:

  enum lineDeviceState{
      lineDeviceState_UNKNOWN =   0,
      lineDeviceState_ACTIVE =    1,
      lineDeviceState_ALERTING =  2,
      lineDeviceState_HELD =      3,
      lineDeviceState_WHISPER =   4,
      lineDeviceState_IDLE =      5
  };

• DEVSPECIFIC_PARK_MONITORING—Setting this flag on a line causes the Park Monitoring events to be fired to the application. Clearing this flag turns off the reporting of the Park Monitoring events. For more information, see Park Monitoring.

• DEVSPECIFIC_OTHER_DEVICE_STATE_NOTIFY—Setting this flag on a line notifies the application about the non-opened device state changes. Clearing this flag turns off the reporting of the other non-opened device state changes. For more information, see Other-Device State Notification.

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

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;}
};

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 follow:

#define DEVSPECIFIC_MEDIA_STREAM0x00000001#define DEVSPECIFIC_CALL_TONE_CHANGED0x00000002
#define CALL_DEVSPECIFIC_RTP_EVENTS0x00000003
#define DEVSPECIFIC_IDLE_TRANSFER_REASON              0x00000004
#define DEVSPECIFIC_HOLD_REVERSION                    0x00000008
#define DEVSPECIFIC_SPEEDDIAL_CHANGED0x00000010
#define DEVSPECIFIC_DONOTDISTURB_CHANGED0x00000020
#define DEVSPECIFIC_DISPLAYABLE_ADDRESS0x00000040
#define DEVSPECIFIC_PARK_MONITORING0x00000080
#define DEVSPECIFIC_DEVICE_STATE0x00000100
#define DEVSPECIFIC_SILENT_MONITORING_TERMINATED0x00000200
#define DEVSPECIFIC_OTHER_DEVICE_STATE_NOTIFY0x00000400
#define DEVSPECIFIC_GET_IP_PORT0x00000800

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
    };

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.

The CCiscoLineDevSpecificRedirectResetOrigCalled class redirects a call to another party while it resets 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 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
    };

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.

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_CAPSm_MediaCaps;
   virtual DWORD dwSize(void) const {return sizeof(*this)-4;} 
// subtract out the virtual function table pointer
};

DWORD m_MsgType

Equals SLDST_USER_RECEIVE_RTP_INFO

DWORD m_NumAffectedDevices:

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]:

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 applies 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 comprises a 16 bit integer that is specified in milliseconds. It indicates the RTP packet size. Typically, this value gets set to 20.

G723BitRate comprises a six byte field that contains either the G.723.1 information bit rate, or gets ignored. The values for the G.723.1 field comprises values that are enumerated as follows.

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

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
   };

DWORD m_MsgType

Equals SLDST_USER_SET_RTP_INFO

DWORD m_ReceiveIP

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

DWORD m_ReceivePort

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

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) ;
}

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, set this field to the voice mail pilot number of the DN of the line for the voice mail, to which you want to transfer.

char m_SetOriginalCalledTo[25]

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

HCALL hCall (in lineDevSpecific parameter list)

Equals the handle of the connected call.

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
};

DWORD m_MsgType

Equals SLDST_JOIN

DWORD m_CallIDsToJoinCount

The number of callIDs that are 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.

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
};

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

DWORD m_MsgType

Equals SLDST_USER_SET_SRTP_ALGORITHM_ID

DWORD m_SRTPAlgorithmCount

This numbers of algorithm IDs that are 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	Be aware that the dwSize should be recalculated based on size of the structure, m_SRTPAlgorithmCount and m_SRTP_Fixed_Element_Size.

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
};

DWORD m_MsgType

Equals SLDST_ACQUIRE

m_DeviceName[16]

The DeviceName that needs to be explicitly acquired.

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
};

DWORD m_MsgType

Equals SLDST_DEACQUIRE

char m_DeviceName[16]

The DeviceName that needs to be explicitly de-acquired.

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) ;
}

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, 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, it must set this parameter to a NULL string.

HCALL hCall (in lineDevSpecific parameter list)

Equals the handle of the call to be redirected.

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) ;
}

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, 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, it must set this parameter to a NULL string.

HCALL hCall (in lineDevSpecific parameter list)

Equals the handle of the call that is to be blind transferred.

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
};

DWORD m_MsgType

equals SLDST_CTI_PORT_THIRD_PARTY_MONITOR

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
};

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
};

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.

class CciscoLineIntercomTalkback: public CCiscoLineDevSpecific{
  public:
    CCciscoLineIntercomTalkback () : 
    CCiscoLineDevSpecific(SLDST_INTERCOM_TALKBACK) {} 

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

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
};

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.

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;} 
} ;

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 represents the only mode that is supported in which the supervisor cannot talk to the agent.

DWORD PlayToneDirection

This parameter specifies whether a tone should play 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

-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

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

virtual ~CCiscoLineDevSpecificStartCallRecording () {}

DWORD m_ToneDirection;
DWORD m_InvocationType;

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

DWORD m_MsgType

Equals SLDST_START_RECORDING

DWORD m_ToneDirection

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

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

DWORD m_InvocationType

This parameter specifies whether the recording status is displayed on the phone (user-controlled recording) or not displayed (silent recording).

enum RecordingInvocationType    {
    RecordingInvocationType_SilentRecording = 1, 
    RecordingInvocationType_UserControlledRecording = 2    
    }

-LINERR_OPERATIONFAILED-LINEERR_OPERATIONUNAVAIL
-LINEERR_INVALCALLHANDLE
-LINEERR_BIB_RESOURCE_UNAVAIL
-LINERR_PENDING_REQUEST 
-LINERR_OPERATION_ALREADY_INPROGRESS
-LINEERR_RECORDING_INVOCATION_TYPE_NOT_MATCHING
-LINEERR_RECORDING_CONFIG_NOT_MATCHING

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

   virtual ~CCiscoLineDevSpecificStopCallRecording () {}

   DWORD m_InvocationType;

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

} ;

DWORD m_MsgType

Equals SLDST_STOP_RECORDING

DWORD m_InvocationType

This parameter specifies whether the recording status is displayed on the phone (user-controlled recording) or not displayed (silent recording).

enum RecordingInvocationType
    {
    RecordingInvocationType_SilentRecording = 1, 
    RecordingInvocationType_UserControlledRecording = 2    
    }

-LINERR_OPERATIONFAILED-LINEERR_OPERATIONUNAVAIL
-LINEERR_INVALCALLHANDLE
-LINERR_PENDING_REQUEST 
-LINEERR_RECORDING_INVOCATION_TYPE_NOT_MATCHING
-LINEERR_NO_RECORDING_SESSION
-LINEERR_RECORDING_SESSION_INACTIVE

class CciscoLineDevSpecificSetIPv6AddressAndMode: public CCiscoLineDevSpecific
{
public:
    CciscoLineDevSpecificSetIPv6AddressAndMode() :
        CCiscoLineDevSpecific(SLDST_USER_SET_IPv6_ADDRESS_AND_MODE),
           m_ReceivePort(-1), m_IPAddressMode( (IpAddressingMode) 1)
    {
    }
    virtual ~ CciscoLineDevSpecificSetIPv6AddressAndMode()
    {
    }
    char m_ReceiveIPv6Address[16];
    DWORD m_ReceivePort;
    IpAddressingMode m_IPAddressMode;
    virtual DWORD dwSize(void) const
    {
        return sizeof(*this) -4;
    } // subtract out the virtual function table pointer
};

DWORDm_MsgType

Equals SLDST_USER_SET_IPv6_ADDRESS

Charm_ReceiveIPv6Address[16]

User has to specify the IPv6 address to register the CTI Port with

DWORDm_ReceivePort

This specifies the port number for the user to register the CTI Port.

Intm_IPAddressMode

This specifies the Addressing mode with which user wants the CTI Port/RP registered.

class CciscoLineDevSpecificSetRTPParamsForCallIPv6: public CCiscoLineDevSpecific
{
public:
   CciscoLineDevSpecificSetRTPParamsForCallIPv6 () :  
   CCiscoLineDevSpecific(SLDST_USER_SET_RTP_INFO_IPv6) {}
   virtual ~ CciscoLineDevSpecificSetRTPParamsForCallIPv6 () {}
   virtual DWORD dwSize(void) const {return sizeof(*this)-4;}
 // subtract out the virtual function table pointer
   char m_RecieveIPv6[16];   // UDP audio reception IPv6
   DWORD m_RecievePort // UDP audio reception port
  };

DWORD m_MsgType

Equals SLDST_USER_SET_RTP_INFO_IPv6

DWORD m_ReceiveIPv6

This is the RTP audio reception IPv6 address to set for the call

DWORD m_RecievePort

This is the RTP audio reception port to set for the call.

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

DWORD m_MsgType

equals SLDST_DIRECT_TRANSFER

DWORD m_CallIDsToTransfer

Consult dwCallID to be transferred

HCALL hCall (in LineDevSpecific parameter list)

Equals the handle of the call that is being transferred.

class CciscoLineDevSpecificRegisterCallPickupGroupForNotification: 
  public CCiscoLineDevSpecific
{
    public:
        CciscoLineDevSpecificRegisterCallPickupGroupForNotification (): 
CCiscoLineDevSpecific (SLDST_CALLPICKUP_GROUP_REGISTER) {}
   virtual ~ CciscoLineDevSpecificRegisterCallPickupGroupForNotification () {}
   char callPickupGroupDN[MAX_DIRN];
   char callPickupGroupPartition[MAX_PARTITION];
        virtual DWORD dwSize(void) const {return sizeof(*this)-4;} 
        // subtract out the virtual function table pointer
};

DWORD m_MsgType

equals SLDST_CALLPICKUP_GROUP_REGISTER

Char CallPickupGroupDN []

-DN of the pickup Group

Char CallPickupGroupPartition []

-Partition of the PickupGroup

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

DWORD m_MsgType

equals SLDST_CALLPICKUP_GROUP_UNREGISTER

class CciscoLineDevSpecificCallPickupRequest:
 public CCiscoLineDevSpecific{
    public:
        CciscoLineDevSpecificCallPickupRequest (): 
   CCiscoLineDevSpecific (SLDST_CALLPICKUP_CALL) {}
        virtual ~ CciscoLineDevSpecificCallPickupRequest () {}
        DWORD PickupType;
        char PickupGroupDN[MAX_DIRN];
        virtual DWORD dwSize(void) const {return sizeof(*this)-4;} 
        // subtract out the virtual function table pointer
};

DWORD m_MsgType

equals SLDST_CALLPICKUP_CALL

Char PickupGroupDN []

-DN of the pickup Group/DN;will be required for GroupCallPickUp and DirectedCallPickUp

DWORD PickupType

-indicates the type of pickup (CtiCallPickUp, CtiGroupCallPickUp, , CtiOtherPickup, DirectedCallPickup)

enum CallPickupType{
        CallPickup_Simple = 0,
        CallPickup_Group  = 1,
        CallPickup_Other  = 2,
        CallPickup_Direct = 3
};

The CCiscoLineDevSpecificStartSendMediaToBIBRequest class allows the application to initiate agent greeting to the customer call.

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

TAPI line handle and TAPI call handle are required for this request.

class CCiscoLineDevSpecificStartSendMediaToBIBRequest:
 public CCiscoLineDevSpecific{
    public:
        CCiscoLineDevSpecificStartSendMediaToBIBRequest (): CCiscoLineDevSpecific (SLDST_START_SEND_MEDIA_TO_BIB) {}
        virtual ~ CCiscoLineDevSpecificStartSendMediaToBIBRequest () {}
      char m_IVRDN [49];
      char m_CGPNTOIVR [49];
        virtual DWORD dwSize(void) const {return sizeof(*this)-4;} 
        // subtract out the virtual function table pointer

DWORD m_MsgType

equals SLDST_START_SEND_MEDIA_TO_BIB

char m_IVRDN [49]

IVR port DN where Agent Greeting will be played from

char m_CGPNTOIVR [49]

The CallingPartyDN passed to IVR. The application can use this field to pass DN as CallingPartyDN for the agent greeting call.

The CCiscoLineDevSpecificStopSendMediaToBIBRequest class allows the application to stop the agent greeting that is playing on the agent-to-customer call.

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

TAPI line handle and TAPI call handle are required for this request.

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

DWORD m_MsgType

equals SLDST_START_SEND_MEDIA_TO_BIB

The CCiscoLineDevSpecificPlaytone class is used to play the tone (Zip Tone) to the direction specified in the request.

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

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

DWORD m_Tone -Indicates the Tone type

equals CTONE_ZIP

DWORD m_ToneDirection -Indicates the direction of the tone to be played;

equals Tonedirection (Local/Remote)

The CciscoLineDevSpecificEnableFeatureSupport class allows application to enhance or update feature support.

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

class CciscoLineDevSpecificEnableFeatureSupport:
 public CCiscoLineDevSpecific{
  public:
    CciscoLineDevSpecificEnableFeatureSupport() :
        CCiscoLineDevSpecific(SLDST_ENABLE_FEATURE_SUPPORT)
    {
    }

    virtual ~ CciscoLineDevSpecificEnableFeatureSupport()
    {
    }
    DWORD m_Feature;
    DWORD m_Feature_Capability;
//Should have Value supported for Feature specified in m_Feature 
    virtual DWORD dwSize(void) const
    {
        return sizeof(*this) -4;
    } // subtract out the virtual function table pointer

DWORD m_MsgType

equals SLDST_ENABLE_FEATURE_SUPPORT

DWORD m_Feature

Feature value for which the capability needs to be changed and should have a value from the following Enum:

enum TspFeatureSupport
{
    Feature_unknown =    0,
    Feature_EarlyOffer =  1
};

DWORD m_Feature_Capability

The Capability information that needs to be changed/updated for the feature. This information changes depending on the feature.

Early Offer (Get Port) Support:

m_Feature should be Feature_EarlyOffer(1) and

m_Feature_Capability should have a value from following Enum:

enum TspFeatureOption{
    Feature_Disable =  0,
    Feature_Enable = 1
};

Sample Code:

Here is a sample code that illustrates how applications must use this devspecific type, and fill the Class Object to enable/disable the Early Offer feature support.

void main(){
… … … ….
CciscoLineDevSpecificEnableFeatureSupport featureObject;
featureObject.m_MsgType = SLDST_ENABLE_FEATURE_SUPPORT;
featureObject.m_Feature = Feature_EarlyOffer(1);
featureObject. m_Feature_Capability = Feature_Enable(1)/ Feature_Disable(0);

int result = TSPI_lineDevSpecific(dwRequestID,hdLine, 
dwAddressID, NULL, &featureObject, 
sizeof(CciscoLineDevSpecificEnableFeatureSupport));
… … … ….
… … … ….
}
New CiscoLineDevStateOutOfServiceReason_EMLogin and 
CiscoLineDevStateOutOfServiceReason_EMLogout values in the 
CiscoLineDevStateOtherReason enumeration type in CiscoLineDevSpecificMsg.h:

enum CiscoLineDevStateOutOfServiceReason
{
    CiscoLineDevStateOutOfServiceReason_Unknown = 0x00000000,
    CiscoLineDevStateOutOfServiceReason_CallManagerFailure = 0x00000001,
    CiscoLineDevStateOutOfServiceReason_ReHomeToHigherPriorityCM = 0x00000002,
    CiscoLineDevStateOutOfServiceReason_NoCallManagerAvailable = 0x00000003,
    CiscoLineDevStateOutOfServiceReason_DeviceFailure = 0x00000004,
    CiscoLineDevStateOutOfServiceReason_DeviceUnregistered = 0x00000005,
    CiscoLineDevStateOutOfServiceReason_EnergyWisePowerSavePlus = 0x00000006,
    CiscoLineDevStateOutOfServiceReason_EMLogin = 0x00000007,
    CiscoLineDevStateOutOfServiceReason_EMLogout =       0x00000008,
    CiscoLineDevStateOutOfServiceReason_CtiLinkFailure = 0x00000101
};  
New CiscoLineDevStateCloseReason enumeration type in CiscoLineDevSpecificMsg.h:
enum CiscoLineDevStateCloseReason
{
    CiscoLineDevStateCloseReason_Unknown = 0,
    CiscoLineDevStateCloseReason_EMLogin = 1,
    CiscoLineDevStateCloseReason_EMLogout = 2
};  

New CiscoLineDevStateOtherReason enumeration type in CiscoLineDevSpecificMsg.h:
enum CiscoLineDevStateOtherReason
{
CiscoLineDevStateOtherReason_Unknown = 0,
CiscoLineDevStateOtherReason_OtherLineInactive = 1,
CiscoLineDevStateOtherReason_OtherLineActive = 2,
CiscoLineDevStateOtherReason_OtherLineCapsChange = 3
};

New LINEERR_DEVICE_INACTIVE error is returned if an operation is invoked 
on a line device in “inactive” state.

The CciscoLineDevSpecificMonitoringUpdateMode class allows the application to toggle between the silent monitoring and whisper coaching modes, and vice versa.

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

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

DWORD m_MsgType

equals SLDST_UPDATE_MONITOR_MODE

DWORD m_MonitorMode

Monitoring mode to toggle to

DWORD m_ActiveToneDirection

Direction of the tone to be played

class CciscoLineDevSpecificHoldEx: public CCiscoLineDevSpecific
{
public:
    CciscoLineDevSpecificHoldEx() :
        CCiscoLineDevSpecific(SLDST_HOLD_EX) {}
    virtual ~ CciscoLineDevSpecificHoldEx() {}
    char    m_MediaContentId [MAX_CISCO_TSP_MEDIA_CONTENT_ID_SIZE];
    DWORD   m_MediaContentIdLength;
    virtual DWORD dwSize(void) const {return sizeof(*this) - sizeof(void*);}
};

char m_MediaContentId [MAX_CISCO_TSP_MEDIA_CONTENT_ID_SIZE]

String that represents media content identifier (mediaContentID). Only known to UCM (uploaded to UCM) media content can be played.

DWORD m_MediaContentIdLength

Actual length of the string in the m_MediaContentId field.

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 ;
}

lpParms()

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

dwSize()

Function that will give the size of the parameter block area

m_MsgType

Specifies the type of message.

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

The CiscoPhoneDevSpecificType enumeration includes valid message identifiers.

enum CiscoPhoneDevSpecificType
{
    CPDST_DEVICE_DATA_PASSTHROUGH_REQUEST = 1,
    CPDST_SET_DEVICE_STATUS_MESSAGES,
    CPDST_SET_DEVICE_UNICODE_DISPLAY,
    CPDST_ACQUIRE,
    CPDST_DE_ACQUIRE,
    CPDST_REQUEST_DEVICE_SNAPSHOT_INFO
};

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) ;} 
}

DWORD m_MsgType

Equals CPDST_DEVICE_DATA_PASSTHROUGH_REQUEST.

DWORD m_DeviceData

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

Note	Be aware that MAX_DEVICE_DATA_PASSTHROUGH_SIZE = 2000.

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

class CCiscoPhoneDevSpecificSetStatusMsgs:public CCiscoPhoneDevSpecific{
   public:
    CCiscoPhoneDevSpecificSetStatusMsgs() : 
    CCiscoPhoneDevSpecific (CPDST_SET_DEVICE_STATUS_MESSAGES) {;}
    virtual ~CCiscoPhoneDevSpecificSetStatusMsgs() {;}
    DWORD m_DevSpecificStatusMsgFlags ; // PHONE_DEVSPECIFIC
  // subtract virtual function table pointer
    virtual DWORD dwSize(void) const {return (sizeof (*this) -4) ; }
} ;

DWORD m_MsgType

equals CPDST_SET_DEVICE_STATUS_MESSAGES.

DWORD m_DevSpecificStatusMsgFlags

Bit map of PHONE_DEVSPECIFIC event flag

const DWORD DEVSPECIFIC_DEVICE_DATA_PASSTHROUGH_EVENT = 0x00000001;

const DWORD DEVSPECIFIC_DEVICE_SOFTKEY_PRESSED_EVENT = 0x00000002;

const DWORD DEVSPECIFIC_DEVICE_STATE_EVENT = 0x00000004;

const DWORD DEVSPECIFIC_DEVICE_PROPERTY_CHANGED_EVENT = 0x00000008;

{
public:
    CCiscoPhoneDevSpecificSetUnicodeDisplay() : 
    CCiscoPhoneDevSpecific (CPDST_SET_DEVICE_UNICODE_DISPLAY) {;}
       virtual ~CCiscoPhoneDevSpecificSetUnicodeDisplay() {;}
    DWORD dwRow;
          DWORD dwColumn;
          DWORD dwSizeOfUnicodeStr;
          wchar_t UnicodeDisplay[MAX_UNICODE_DISPLAY_STRING];
  // subtract virtual function table pointer
    virtual DWORD dwSize(void) const {return (sizeof (*this) -4) ; }
} ;

DWORD m_MsgType

Equals CPDST_SET_DEVICE_UNICODE_DISPLAY.

DWORD m_dwRow

Row number on the phone display where the Unicode string must be displayed

DWORD m_dwColumn

Column number on the phone display where the Unicode string must be displayed

DWORD m_dwSizeOfUnicodeStr

Size of the Unicode string

wchar_t UnicodeDisplay[MAX_UNICODE_DISPLAY_STRING];

Unicode display string, with maximum size of MAX_UNICODE_DISPLAY_STRING

MAX_UNICODE_DISPLAY_STRING = 100

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
};

DWORD m_MsgType

Equals CPDST_ACQUIRE

char m_DeviceName[16]

The DeviceName that needs to be explicitly acquired.

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
};

DWORD m_MsgType

Equals CPDST_DEACQUIRE

char m_DeviceName[16]

The DeviceName that needs to be explicitly de-acquired.

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
};

DWORD m_MsgType

Equals CPDST_DEACQUIRE

char m_DeviceName[16]

The DeviceName that needs to be explicitly de-acquired.

class CCiscoPhoneDevSpecificSetHuntGroupLoginStatus: public CCiscoPhoneDevSpecific
{
public:
	CCiscoPhoneDevSpecificSetHuntGroupLoginStatus () :
CCiscoPhoneDevSpecific(CPDST_REQUEST_DEVICE_HUNTGROUP_LOGIN_STATUS)
	{
	}
	virtual ~CCiscoPhoneDevSpecificSetHuntGroupLoginStatus()
	{
		;
	}
	CiscoDeviceHuntGroupLoginStatus  m_HuntGroupLoginStatus;
	virtual DWORD dwSize(void) const
	{
		return (sizeof(*this) - sizeof(void*));
	}
};

{
|
+- CPDST_REQUEST_DEVICE_HUNTGROUP_LOGIN_STATUS
}

CiscoDeviceHuntGroupLoginStatus m_HuntGroupLoginStatus is an enumeration.

enum CiscoDeviceHuntGroupLoginStatus
{
	CiscoDeviceHuntGroupLoginStatus_NotApplicable = 0,  
	CiscoDeviceHuntGroupLoginStatus_Login = 1,    
	CiscoDeviceHuntGroupLoginStatus_Logout = 2
};

where:

• CiscoDeviceHuntGroupLoginStatus_NotApplicable is for devices which do not support Hunt Groups.

• CiscoDeviceHuntGroupLoginStatus_Login is to set the Hunt Group Login Status to Login.

• CiscoDeviceHuntGroupLoginStatus_Logout is to set the Hunt Group Login Status to Logout

DWORD m_RedirectBitMask

This bit mask field indicates which fields in CciscoLineRedirectEx class are valid and used by applications.

enum RedirectInfoBitMask
{
RedirectInfo_None = 0x00000000,
RedirectInfoSetOriginalCalledTo = 0x00000001,
RedirectInfo_FAC= 0x00000002,  
RedirectInfo_CMC= 0x00000004,
RedirectInfo_RedirectDeviceName = 0x00000008,
                        RedirectInfo_CallingSearchSpace = 0x00000010,                
                        RedirectInfo_ApplicationXMLData = 0x00000020
};

CiscoCallingSearchSpace m_callingSearchSpace:

typedef enum  
{
    CiscoCallingSearchSpace_Default = 0, 
    CiscoCallingSearchSpace_CallingParty = 1, 
    CiscoCallingSearchSpace_RedirectingParty = 2
} CiscoCallingSearchSpace;     

where CiscoCallingSearchSpace_Default is to use CSS of party being redirected, CiscoCallingSearchSpace_CallingParty is to use CSS of party being redirected i.e calling party after redirect CiscoCallingSearchSpace_RedirectingParty is to use CSS of redirecting party.

CiscoDoNotDisturbFeaturePriority FeaturePriority;

Feature priority is introduced and defined in the enum type for making calls or redirecting existing calls.

{
    CallPriority_NORMAL = 1
    CallPriority_URGENT = 2
    CallPriority_EMERGENCY = 3
 };
    

char m_DestDirn[MAX_DESTINATION_DIRECTORY_NUMBER];

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

char m_SetOriginalCalledTo[MAX_DEVICE_SIZE];

Indicates the DN to which the OriginalCalledParty needs to be set.

char m_FAC[MAX_FAC_CMC_DIGITS];

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

char m_CMC[MAX_FAC_CMC_DIGITS];

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

char m_RedirectDeviceName[MAX_DEVICE_SIZE];

Indicates the name of the device for which call needs to be redirected to.

DWORD m_ApplicationXMLDataSize;

Indicates the size of the xml data that application sends to the call manager.

TCHAR m_ApplicationXMLData[MAX_XML_DATA_SIZE];

Indicates the content of the xml data.

Applications are allowed to send the xml data within the range of 0 to 10000 characters.

CiscoCallingSearchSpace m_callingSearchSpace;

Indicates the calling search space which applications can set to the css of calling party or that of redirecting party, while doing a redirect.

#define MAX_DEVICE_SIZE 49

#define MAX_DESTINATION_DIRECTORY_NUMBER 49

#define MAX_XML_DATA_SIZE 10000

PHONE_STATE

dwParam1 - PHONE_STATE

dwParam2 - PHONESTATE_CAPSCHANGE (0x00040000)

dwParam3 - CiscoPhoneCapsDevSpecificStatus - PHONECAPS_DEVSPECIFIC_HUNTGROUP_LOGIN_STATUS(0x00000001)

dwParam4 - updated value of HuntGroup Login Status of the device

enum CiscoPhoneCapsDevSpecificStatus   
{
    PHONECAPS_DEVSPECIFIC_HUNTGROUP_LOGIN_STATUS = 0x00000001  
};

where PHONECAPS_DEVSPECIFIC_HUNTGROUP_LOGIN_STATUS will notify the application about the successful change in the HuntGroup Login status of the device.