Feedback
Table Of Contents
Cisco Device-Specific Extensions
Cisco Line Device Specific Extensions
LINEDEVCAPS Device Specific Extensions
LINECALLINFO Device Specific Extensions
LINEDEVSTATUS Device Specific Extensions
Redirect Reset Original Called ID
Setting RTP Parameters for Call
Redirect Set Original Called ID
Cisco Line Device Feature Extensions
LINEDEVCAPS Device Specific Feature Extensions
LINEDEVSTATUS Device Specific Feature Extensions
Do-Not-Disturb Change Notification Event
Cisco Phone Device-Specific Extensions
CCiscoPhoneDevSpecificDataPassThrough
CCiscoPhoneDevSpecificDeacquire
CCiscoPhoneDevSpecificGetRTPSnapshot
LINECALLINFO_DEVSPECIFICDATA Events
Redirect Set Original Called (TxToVM)
Make a Call Through Translation Pattern
Blind Transfer Through Translation Pattern
Forced Authorization and Client Matter Code Scenarios
Manual Call to a Destination that Requires a FAC
Manual Call to a Destination that Requires both FAC and CMC
lineMakeCall to a Destination that Requires a FAC
lineMakeCall to a Destination that Requires Both FAC and CMC
Timeout Waiting for FAC or Invalid FAC entered
In-Dialog Refer - Referrer in Cisco Unified Communications Manager Cluster
In-Dialog Refer Where ReferToTarget Redirects the Call in Offering State
In-Dialog Refer Where Refer Fails / Refer to Target is Busy
Invite with Replace for Confirmed Dialog
Refer with Replace for All in Cluster
Refer with Replace for All in Cluster, Replace Dialog Belongs to Another Station
Media Terminate by Application (open secure CTI port or RP)
Media Terminate by TSP Wave Driver (open secure CTI port)
Application Invoking Speeddial
Secure Conferencing Feature Scenarios
Conference with all parties as Secure
Hold/Resume in Secure Conference
Monitoring & Recording Feature Scenarios
Application-Controlled Recording
Conference Enhancement Use Cases
Non-Controller adding a party to a conference
Chaining two ad-hoc conferences using Join
Cisco Device-Specific Extensions
This chapter describes the Cisco device-specific TAPI extensions. It 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.
Cisco Line Device Specific Extensions
CiscoLineDevSpecific, the CCiscoPhoneDevSpecific class, represents the parent class.
Table 4-1 lists the subclasses of Cisco Line Device Specific Extensions.
Structures
This section describes device-specific extensions that have been made to the TAPI structures that the Cisco Unified TSP supports.
LINEDEVCAPS Device Specific Extensions
Description
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_DEVSPECIFICDWORD dwLineDevCaps_DevSpecificFeatureFlags; // LINEFEATURE_DEVSPECIFICFEATRECORD_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 deviceDWORD PartitionOffset;DWORD PartitionSize; //This will have the partition info of the line.} LOCALE_INFO;
Note
C
typedef struct PartitionInfo{DWORD PartitionOffset;DWORD PartitionSize; //This will have the partition info of the line.} PARTITION_INFO;
Note
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
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 Device Specific Extensions
Description
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 LINECALLINFODWORD SRTPKeyInfoStructureSize; // includes variable length data total sizeDWORD SRTPKeyInfoStructureElementCount;DWORD SRTPKeyInfoStructureElementFixedSize;DWORD DSCPInformationOffset; // offset from base of LINECALLINFODWORD DSCPInformationSize; // fixed size of the DSCPInformation structureDWORD DSCPInformationElementCount;DWORD DSCPInformationElementFixedSize;DWORD CallPartitionInfoOffset; // offset from base of LINECALLINFODWORD CallPartitionInfoSize; // fixed size of the CallPartitionInformation structureDWORD CallPartitionInfoElementCount;DWORD CallPartitionInfoElementFixedSize;DWORD ExtendedCallInfoOffset; // ===> ExtendedCallInfo { }DWORD ExtendedCallInfoSize; //DWORD ExtendedCallInfoElementCount; //DWORD ExtendedCallInfoElementSize; //} CISCO_LINECALLINFO_EXT00070000;// LINECALLINFO 00080000 extention //// ---------------------------------typedef struct Cisco_LineCallInfo_Ext00080000{DWORD CallSecurityStatusOffset;DWORD CallSecurityStatusSize;DWORD CallSecurityStatusElementCount;DWORD CallSecurityStatusElementFixedSize;DWORD CCMCallIDInfoOffset;DWORD CCMCallIDInfoSize;DWORD CCMCallIDInfoElementCount;DWORD CCMCallIDInfoElementFixedSize;DWORD CallAttrtibuteInfoOffset;DWORD CallAttrtibuteInfoSize;DWORD CallAttrtibuteInfoElementCount;DWORD CallAttrtibuteInfoElementFixedSize;DWORD TSPIntercomSideInfo;DWORD CallingPartyIpAddr;} CISCO_LINECALLINFO_EXT00080000;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 this release, 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 LINECALLINFODWORD SRTPKeyInfoStructureSize; // includes variable length data total sizeDWORD SRTPKeyInfoStructureElementCount;DWORD SRTPKeyInfoStructureElementFixedSize;DWORD DSCPValueInformationOffset;DWORD DSCPValueInformationSize;DWORD DSCPValueInformationElementCount;DWORD DSCPValueInformationElementFixedSize;DWORD PartitionInformationOffset; // offset from base of LINECALLINFODWORD PartitionInformationSize; // includes variable length data total sizeDWORD 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; // CiscoSecurityIndicatorDWORD MasterKeyOffset;DWORD MasterKeySize;DWORD MasterSaltOffset;DWORD MasterSaltSize;DWORD AlgorithmID; // CiscoSRTPAlgorithmIDsDWORD 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; // CallPartySipURLInfoDWORD CallerIDURISize;DWORD CalledIDURLOffset; // CallPartySipURLInfoDWORD CalledIDURISize;DWORD ConnectedIDURIOffset; // CallPartySipURLInfoDWORD ConnectedIDURISize;DWORD RedirectionIDURIOffset; // CallPartySipURLInfoDWORD RedirectionIDURISize;DWORD RedirectingIDURIOffset; // CallPartySipURLInfoDWORD RedirectingIDURISize;}Struct CallPartySipURLInfo{DWORD dwUserOffset; //sip user stringDWORD dwUserSize;DWORD dwHostOffset; //host name stringDWORD dwHostSize;DWORD dwPort; // integer port numberDWORD dwTransportType; // SIP_TRANS_TYPEDWORD 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} CallSecurityStausInfoenum OverallCallSecurityStatus{OverallCallSecurityStatus_Unknown = 0,OverallCallSecurityStatus_NotAuthenticated ,OverallCallSecurityStatus_Authenticated,OverallCallSecurityStatus_Encrypted};Parameters
Note
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 changeddwParam2 = SLDST_SRTP_INFO | SLDST_QOS_INFO |SLDST_PARTITION_INFO | SLDST_EXTENDED_CALL_INFO | SLDST_CALL_ATTRIBUTE_INFO|SLDST_CCM_CALLID| SLDST_CALL_SECURITY_STATUSdwParam3 = ...dwParam3 will be security indicator if dwParam2 has bit set for SLDST_SRTP_INFO}SLDST_SRTP_INFO = 0x00000001SLDST_QOS_INFO = 0x00000002SLDST_PARTITION_INFO = 0x00000004SLDST_EXTENDED_CALL_INFO = 0x00000008SLDST_CALL_ATTRIBUTE_INFO = 0x00000010SLDST_CCM_CALLID = 0x00000020SLDST_CALL_SECURITY_STATUS=0x00000040LINEDEVSTATUS Device Specific Extensions
Description
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 encodingNotApplicableEncoding = 1, // Encoding not applicable to this deviceAsciiEncoding = 2, // ASCII encodingUcs2UnicodeEncoding = 3 // UCS-2 Unicode encoding}
Note
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
CCiscoLineDevSpecific
CCiscoLineDevSpecific|+-- CCiscoLineDevSpecificMsgWaiting|+-- CCiscoLineDevSpecificMsgWaitingDirn|+-- CCiscoLineDevSpecificUserControlRTPStream|+--CciscoLineDevSpecificSetStatusMsgs|+--CCiscoLineDevSpecificRedirectResetOrigCalled|+--CCiscoLineDevSpecificPortRegistrationPerCall|+--CciscoLineDevSpecificSetRTPParamsForCall|+--CCiscoLineDevSpecificRedirectSetOrigCalled|+--CCiscoLineDevSpecificJoin|+--CciscoLineDevSpecificUserSetSRTPAlgorithmID|+--CCiscoLineDevSpecificAcquire|+--CciscoLineDevSpecificDeacquire|+-- CciscoLineDevSpecificSendLineOpen|+-- CciscoLineSetIntercomSpeeddial|+-- CciscoLineIntercomTalkback|+-- CCiscoLineDevSpecificStartCallMonitoring|+-- CCiscoLineDevSpecificStartCallRecording|+-- CCiscoLineDevSpecificStopCallRecordingDescription
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.
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 BeyondSLDST_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
CCiscoLineDevSpecific|+-- CCiscoLineDevSpecificMsgWaitingDescription
The CCiscoLineDevSpecificMsgWaiting class turns the message waiting lamp on or off for the line that the hLine parameter specifies.
Note
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
Message Waiting Dirn
CCiscoLineDevSpecific|+-- CCiscoLineDevSpecificMsgWaitingDirnDescription
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
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
char m_Dirn[25]
The directory number for which the message waiting lamp should be set.
Audio Stream Control
CCiscoLineDevSpecific|+-- CCiscoLineDevSpecificUserControlRTPStreamDescription
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.
Procedure
Step 1
Step 2
Step 3
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 IPDWORD m_ReceivePort; // UDP audio reception portDWORD 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.3KbpsMedia_G723BRate_6_4 = 2 //6.4Kbps} Media_G723BitRate;Set Status Messages
CCiscoLineDevSpecific|+-- CCiscoLineDevSpecificSetStatusMsgsDescription
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:
•
•
Note
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 0x00000008Swap-Hold/SetupTransfer
Note
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|+-- CCiscoLineDevSpecificSwapHoldSetupTransferDescription
The CCiscoLineDevSpecificSwapHoldSetupTransfer class performs a setupTransfer between a call that is in CONNECTED state and a call that in ONHOLD state. This function will change the state of the connected call to ONHOLDPENDTRANSFER state and the ONHOLD call to CONNECTED state. This will then allow a completeTransfer to be performed on the two calls.
Note
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|+-- CCiscoLineDevSpecificRedirectResetOrigCalledDescription
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
Class Details
class CCiscoLineDevSpecificRedirectResetOrigCalled: public CCiscoLineDevSpecific{public:CCiscoLineDevSpecificRedirectResetOrigCalled: CCiscoLineDevSpecific(SLDST_REDIRECT_RESET_ORIG_CALLED) {}virtual ~CCiscoLineDevSpecificRedirectResetOrigCalled{}char m_DestDirn[25]; //redirect destination addressvirtual 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
CCiscoLineDevSpecific|+-- CCiscoLineDevSpecificPortRegistrationPerCallDescription
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.
Procedure
Step 1
Step 2
Step 3
Note
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.3KbpsMedia_G723BRate_6_4 = 2 //6.4Kbps} Media_G723BitRate;Setting RTP Parameters for Call
CCiscoLineDevSpecific|+-- CCiscoLineDevSpecificSetRTPParamsForCallDescription
The CCiscoLineDevSpecificSetRTPParamsForCall class sets the RTP parameters for a specific call.
Note
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 pointerDWORD m_RecieveIP; // UDP audio reception IPDWORD 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
CCiscoLineDevSpecific|+-- CCiscoLineDevSpecificRedirectSetOrigCalledDescription
The CCiscoLineDevSpecificRedirectSetOrigCalled class redirects a call to another party while setting the original called ID of the call to any other party.
Note
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 pointervirtual 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
CCiscoLineDevSpecific|+-- CCiscoLineDevSpecificJoinDescription
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
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
CCiscoLineDevSpecific|+-- CciscoLineDevSpecificUserSetSRTPAlgorithmIDDescription
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
Procedure
Step 1
Step 2
Step 3
Step 4
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_IDSDWORD 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 buffervirtual 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
Explicit Acquire
CCiscoLineDevSpecific|+--CCiscoLineDevSpecificAcquireDescription
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
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
CCiscoLineDevSpecific|+--CCiscoLineDevSpecificDeacquireDescription
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
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
CCiscoLineDevSpecific | +--CCiscoLineDevSpecificRedirectFACCMCDescription
The CCiscoLineDevSpecificRedirectFACCMC class is used to redirect a call to another party that requires a FAC, CMC, or both.
Note
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 pointervirtual 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
CCiscoLineDevSpecific|+--CCiscoLineDevSpecificBlindTransferFACCMCDescription
The CCiscoLineDevSpecificBlindTransferFACCMC class is used to blind transfer a call to another party that requires a FAC, CMC, or both.
Note
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 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 pointervirtual 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
CCiscoLineDevSpecific|+-- CCiscoLineDevSpecificCTIPortThirdPartyMonitorDescription
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.
Procedure
Step 1
Step 2
Step 3
Note
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
CCiscoLineDevSpecific|+-- CciscoLineDevSpecificSendLineOpenDescription
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.
Procedure
Step 1
Step 2
Step 3
Step 4
Note
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
CCiscoLineDevSpecific|+-- CciscoLineSetIntercomSpeeddialDescription
Use the CciscoLineSetIntercomSpeeddial class to allow application to set or reset SpeedDial/Label on an intercom line.
Note
Procedure
Step 1
Step 2
Step 3
Step 4
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 Valuechar 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
CCiscoLineDevSpecific|+-- CCiscoLineDevSpecificTalkBackDescription
Use the CCiscoLineDevSpecificTalkBack class to allow application to initiate talk back on a incoming Intercom call on a Intercom line.
Note
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};Start Call Monitoring
CCiscoLineDevSpecific|+-- CCiscoLineDevSpecificStartCallMonitoringDescription
Use CCiscoLineDevSpecificStartCallMonitoring to allow application to send a start monitoring request for the active call on a line.
Note
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 pointervirtual 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 usedMonitorMode_Active = 3 // Not used} MonitorMode;This release only supports Silent Monitoring mode, 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} PlayToneDirectionReturn 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_INVALIDStart Call Recording
CCiscoLineDevSpecific|+-- CCiscoLineDevSpecificStartCallRecordingDescription
Use CCiscoLineDevSpecificStartCallRecording to allow applications to send a recording request for the active call on that line.
Note
Class Detail
class CCiscoLineDevSpecificStartCallRecording: public CCiscoLineDevSpecific{public:CCiscoLineDevSpecificStartCallRecording () : CCiscoLineDevSpecific(SLDST_START_CALL_RECORDING) {}virtual ~ CCiscoLineDevSpecificStartCallRecording () {}DWORD m_ToneDirection;// subtract out the virtual function table pointervirtual 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} PlayToneDirectionReturn Values
- LINERR_OPERATIONFAILED- LINEERR_OPERATIONUNAVAIL- LINEERR_INVALCALLHANDLE- LINEERR_BIB_RESOURCE_UNAVAIL- LINERR_PENDING_REQUEST- LINERR_OPERATION_ALREADY_INPROGRESSStopCall Recording
CCiscoLineDevSpecific|+-- CCiscoLineDevSpecificStopCallRecordingDescription
Use CCiscoLineDevSpecificStopCallRecording to allow application to stop recording a call on that line.
Note
Class Detail
class CCiscoLineDevSpecificStopCallRecording: public CCiscoLineDevSpecific{public:CCiscoLineDevSpecificStopCallRecording () : CCiscoLineDevSpecific(SLDST_STOP_CALL_RECORDING) {}virtual ~ CCiscoLineDevSpecificStopCallRecording () {}// subtract out the virtual function table pointervirtual 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_REQUESTCisco 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.
TAPI Structure Extensions
This section describes line device feature-specific extensions to the TAPI structures that Cisco TSP supports.
LINEDEVCAPS Device Specific Feature Extensions
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 flagstypedef struct CiscoLineDevCaps_DevSpecificFlags{DWORD m_LineDevCaps_DevSpecificFlags; // LINEFEATURE_DEVSPECIFICDWORD m_LineDevCaps_DevSpecificFeatureFlags; // LINEFEATURE_DEVSPECIFICFEAT} CISCOLINEDEVCAPS_DEVSPECIFICFLAGS;// Bit assignments#define LINEDEVCAPS_DEVSPECIFICFEATURE_DONOTDISTURB 0x00000001 // Ext 00080000LINEDEVSTATUS Device Specific Feature Extensions
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
// 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
CCiscoLineDevSpecificFeatureDescription
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.
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
CCiscoLineDevSpecificFeature|+-- CCiscoLineDevSpecificFeature_DoNotDisturbDescription
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
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.
Description
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_DEVSPECIFICFEATUREdwDevice = (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 4-2 lists the subclasses of CiscoPhoneDevSpecific.
CCiscoPhoneDevSpecific
CCiscoPhoneDevSpecific|+-- CCiscoPhoneDevSpecificDataPassThroughDescription
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.
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
CCiscoPhoneDevSpecific|+-- CCiscoPhoneDevSpecificDataPassThroughXSI 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.
Description
The CCiscoPhoneDevSpecificDataPassThrough class is used to send the device specific data to CTI controlled IP Phone devices.
Note
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_SIZETCHAR m_DeviceData[MAX_DEVICE_DATA_PASSTHROUGH_SIZE] ;// subtract out the virtual funciton table pointer sizevirtual 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
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
CCiscoPhoneDevSpecific|+-- CCiscoPhoneDevSpecificAcquireDescription
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
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
CCiscoPhoneDevSpecific|+-- CCiscoPhoneDevSpecificDeacquireDescription
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
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
CCiscoPhoneDevSpecific|+-- CCiscoPhoneDevSpecificGetRTPSnapshotDescription
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
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.
Description
An application receives nonstandard TAPI messages in the following LINE_DEVSPECIFIC messages:
•
•
•
•
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.
•
•
•
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:
•
•
•
At extension version 2.0 (0x00020000), start transmission has the following format:
•
•
•
•
•
•
•
•
•
•
At extension version 4.0 (0x00040000), start transmission has the following format:
•
•
–
–
–
–
–
–
–
•
•
Start Reception Events
SLDSMT_START_RECEPTION
When a message is received, the RTP stream reception should commence.
•
•
•
When a message is received, the RTP stream reception should commence.
At extension version 1, the parameters have the following format:
•
•
•
At extension version 2 start reception has the following format:
•
•
•
•
•
•
•
•
At extension version 4.0 (0x00040000), start reception has the following format:
•
•
–
–
–
–
–
•
•
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:
•
At extension version 4.0 (0x00040000), stop transmission has the following format:
•
•
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:
•
At extension version 4.0 (0x00040000), stop reception has the following format:
•
•
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:
•
•
•
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
The following is the format of the parameters:
•
•
•
•
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
Call security status, CallAttributeInfo and CCM CallID is available only if extension version 0x00080000 or higher is negotiated.The format of the parameters is:
•
•
SLDSMT_LINECALLINFO_DEVSPECIFICDATA\•
SLDST_SRTP_INFO | SLDST_QOS_INFO | SLDST_PARTITION_INFO | SLDST_EXTENDED_CALL_INFO|SLDST_CALL_SECURITY_STATUS|SLDST_CALL_ATTRIBUTE_INFO |SLDST_CCM_CALLIDThe bit mask values are:
SLDST_SRTP_INFO = 0x00000001SLDST_QOS_INFO = 0x00000002SLDST_PARTITION_INFO = 0x00000004SLDST_EXTENDED_CALL_INFO = 0x00000008SLDST_CALL_ATTRIBUTE_INFO = 0x00000010SLDST_CCM_CALLID = 0x00000020|SLDST_CALL_SECURITY_STATUS=0x00000040For 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.
•
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
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
The format of the parameters is as follows:
•
•
•
•
–
–
Note
Message Sequence Charts
This section illustrates a subset of the call scenarios supported by the Cisco Unified TSP. The event order is not guaranteed in all cases and can vary depending on the scenario and the event.
The following is a list of abbreviations used in the CTI events shown in each scenario.
•
•
•
•
•
•
Manual Outbound Call
Precondition
Party A is idle.
1. Party A goes offhook
NewCallEven
CH=C1,
GCH=G1,
Calling=A,
Called=NP,
OrigCalled=NP,
LR=NP,
State=Dialtone,
Origin=OutBound,
Reason=DirectLINE_APPNEWCALL
hDevice=A
dwCallbackInstance=0
dwParam1=0
dwParam2=hCall-1
dwParam3=OWNERLINECALLINFO (hCall-1)
hLine=A
dwCallID=T1
dwOrigin=OUTBOUND
dwReason=DIRECT
dwCallerID=A
dwCalledID=NP
dwConnectedID=NP
dwRedirectionID=NP
dwRedirectionID=NPCallStateChangedEvent,
CH=C1,
State=Dialtone,
Cause=CauseNoError,
Reason=Direct,
Calling=A,
Called=NP,
OrigCalled=NP,
LR=NPLINE_CALLSTATE
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=DIALTONE
dwParam2=UNAVAIL
dwParam3=0No change
2. Party A dials Party B
CallStateChangedEvent,
CH=C1,
State=Dialing,
Cause=CauseNoError,
Reason=Direct,
Calling=A,
Called=NP,
OrigCalled=NP,
LR=NPLINE_CALLSTATE
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=DIALING
dwParam2=0
dwParam3=0No change
3. Party B accepts call
CallStateChangedEvent,
CH=C1,
State=Proceeding,
Cause=CauseNoError,
Reason=Direct,
Calling=A,
Called=B,
OrigCalled=B,
LR=NPLINE_CALLSTATE
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=PROCEEDING
dwParam2=0
dwParam3=0LINE_CALLINFO
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=CALLEDID
dwParam2=0
dwParam3=0LINECALLINFO (hCall-1)
hLine=A
dwCallID=T1
dwOrigin=OUTBOUND
dwReason=DIRECT
dwCallerID=A
dwCalledID=B
dwConnectedID=NP
dwRedirectionID=NP
dwRedirectionID=NPCallStateChangedEvent,
CH=C1,
State=Ringback,
Cause=CauseNoError,
Reason=Direct,
Calling=A,
Called=B,
OrigCalled=B,
LR=NPLINE_CALLSTATE
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=RINGBACK
dwParam2=0
dwParam3=0No change
4. Party B answers call
CallStateChangedEvent,
CH=C1,
State=Connected,
Cause=CauseNoError,
Reason=Direct,
Calling=A,
Called=B,
OrigCalled=B,
LR=NPLINE_CALLSTATE
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=CONNECTED
dwParam2=ACTIVE
dwParam3=0LINE_CALLINFO
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=CONNECTEDID
dwParam2=0
dwParam3=0LINECALLINFO (hCall-1)
hLine=A
dwCallID=T1
dwOrigin=OUTBOUND
dwReason=DIRECT
dwCallerID=A
dwCalledID=B
dwConnectedID=B
dwRedirectionID=NP
dwRedirectionID=NPCallStartReceptionEvent, DH=A, CH=C1
LINE_DEVSPECIFIC1
hDevice=hCall-1
dwCallBackInstance=0
dwParam1=StartReception
dwParam2=IP Address
dwParam3=PortNo change
CallStartTransmissionEvent, DH=A, CH=C1
LINE_DEVSPECIFIC2
hDevice=hCall-1
dwCallBackInstance=0
dwParam1=StartTransmission
dwParam2=IP Address
dwParam3=PortNo change
1 LINE_DEVSPECIFIC events are sent only if the application has requested them using lineDevSpecific()
2 LINE_DEVSPECIFIC events are sent only if the application has requested them using lineDevSpecific()
Blind Transfer
Precondition
A calls B. B answers. A and B are connected.
Redirect Set Original Called (TxToVM)
Precondition
A calls B. B answers. A and B are connected.
Shared Line Scenarios
Initiate a New Call Manually
Party A and Party A' are shared line appearances.
Party A and Party A' are idle.
Presentation Indication
Make a Call Through Translation Pattern
In the Translation pattern admin pages, both the callerID/Name and ConnectedID/Name are set to "Restricted".
Party A goes offhook
NewCallEvent,
CH=C1, GCH=G1,
Calling=A, Called=NP, OrigCalled=NP, LR=NP, State=Dialtone, Origin=OutBound, Reason=DirectLINE_APPNEWCALL
hDevice=A
dwCallbackInstance=0
dwParam1=0
dwParam2=hCall-1
dwParam3=OWNERLINECALLINFO (hCall-1)
hLine=A
dwCallID=T1
dwOrigin=OUTBOUND
dwReason=DIRECT
dwCallerID=A
dwCalledID=NP
dwConnectedID=NP
dwRedirectionID=NP
dwRedirectionID=NPCallStateChangedEvent, CH=C1, State=Dialtone, Cause=CauseNoError, Reason=Direct, Calling=A, Called=NP, OrigCalled=NP, LR=NP
LINE_CALLSTATE
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=DIALTONE
dwParam2=UNAVAIL
dwParam3=0No change
Party A dials Party B through Translation pattern
CallStateChangedEvent, CH=C1, State=Dialing, Cause=CauseNoError, Reason=Direct, Calling=A, Called=NP, OrigCalled=NP, LR=NP
LINE_CALLSTATE
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=DIALING
dwParam2=0
dwParam3=0No change
Party B accepts the call
CallStateChangedEvent, CH=C1, State=Proceeding, Cause=CauseNoError, Reason=Direct, Calling=A, CallingPartyPI=Allowed, Called=B, CalledPartyPI= Restricted, OrigCalled=B, OrigCalledPI=restricted, LR=NP
LINE_CALLSTATE
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=
PROCEEDING
dwParam2=0
dwParam3=0LINE_CALLINFO
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=CALLEDID
dwParam2=0
dwParam3=0LINECALLINFO (hCall-1)
hLine=A
dwCallID=T1
dwOrigin=OUTBOUND
dwReason=DIRECT
dwCallerID=A dwCallerIDName=A's Name
dwCalledID=B
dwCalledIDName=B's name dwConnectedID=NP
dwConnectedIDName=NP
dwRedirectionID=NP dwRedirectionIDName=NP
dwRedirectionID=NP dwRedirectionIDName=NPParty B accepts the call
(continued)CallStateChangedEvent, CH=C1, State=Ringback, Cause=CauseNoError, Reason=Direct, Calling=A, CallingPI = Allowed, Called=B, CalledPI = Restricted, OrigCalled=B, OrigCalledPI = Restricted, LR=NP
LINE_CALLSTATE
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=RINGBACK
dwParam2=0
dwParam3=0LINECALLINFO (hCall-1)
hLine=A
dwOrigin=OUTBOUND
dwReason=DIRECT
dwCallerID=A
dwCalledID=B
dwConnectedIDFlags = LINECALLPARTYID_
BLOCKED dwConnectedID=NP
dwRedirectionID=NP
dwRedirectionIDFlags = LINECALLPARTYID_
BLOCKED dwRedirectionID=NPParty B answers the call
CallStateChangedEvent, CH=C1, State=Connected, Cause=CauseNoError, Reason=Direct, Calling=A, CallingPI = Allowed, Called=B, CalledPI = Restricted, OrigCalled=B, OrigCalledPI = Restricted, LR=NP
LINE_CALLSTATE
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=CONNECTED
dwParam2=ACTIVE
dwParam3=0LINE_CALLINFO
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=CONNECTEDID
dwParam2=0
dwParam3=0LINECALLINFO (hCall-1)
hLine=A
dwCallID=T1
dwOrigin=OUTBOUND
dwReason=DIRECT
dwCallerID=A dwCallerIDName=A's Name
dwCalledID=B dwCalledIDName=B's Name
dwConnectedID=A, dwConnectedIDName=
A's Name,
dwRedirectingID=NP
dwRedirectingIDName=NP
dwRedirectionIDFlags = LINECALLPARTYID_
BLOCKED dwRedirectionID=NP dwRedirectionIDName=NPCallStartReceptionEvent, DH=A, CH=C1
LINE_DEVSPECIFIC1
hDevice=hCall-1
dwCallBackInstance=0
dwParam1=
StartReception
dwParam2=IP Address
dwParam3=PortNo change
CallStartTransmissionEvent, DH=A, CH=C1
LINE_DEVSPECIFIC1
hDevice=hCall-1
dwCallBackInstance=0
dwParam1=
StartTransmission
dwParam2=IP Address
dwParam3=PortNo change
1 LINE_DEVSPECIFIC events are only sent if the application has requested for them using lineDevSpecific().
Blind Transfer Through Translation Pattern
A calls via translation pattern B.
B answers.
A and B are connected.
Forced Authorization and Client Matter Code Scenarios
Manual Call to a Destination that Requires a FAC
Preconditions
Party A is Idle. Party B requires an FAC.
Note that the scenario is similar if Party B requires a CMC instead of an FAC.
Manual Call to a Destination that Requires both FAC and CMC
Preconditions
Party A is Idle. Party B requires an FAC and a CMC.
lineMakeCall to a Destination that Requires a FAC
Preconditions
Party A is Idle. Party B requires an FAC. Note that the scenario is similar if Party requires a CMC instead of an FAC
lineMakeCall to a Destination that Requires Both FAC and CMC
Preconditions
Party A is Idle. Party B requires both a FAC and a CMC.
Timeout Waiting for FAC or Invalid FAC entered
Preconditions
Party A is Idle. Party B requires a FAC.
Note that the scenario is similar if Party B required a CMC instead of a FAC.
Party A does a lineMakeCall() to Party B.
NewCallEvent,
CH=C1,
GCH=G1,
Calling=A,
Called=NP,
OrigCalled=NP,
LR=NP,
State=Dialtone,
Origin=OutBound,
Reason=DirectLINE_CALLINFO
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=ORIGIN
dwParam2=0
dwParam3=0LINE_CALLINFO
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=
REASON, CALLERID
dwParam2=0
dwParam3=0LINECALLINFO (hCall-1)
hLine=A
dwCallID=T1
dwOrigin=OUTBOUND
dwReason=DIRECT
dwCallerID=A
dwCalledID=NP
dwConnectedID=NP
dwRedirectionID=NP
dwRedirectionID=NPCallStateChangedEvent, CH=C1,
State=Dialing,
Cause=CauseNoError,
Reason=Direct,
Calling=A,
Called=NP,
OrigCalled=NP,
LR=NPLINE_CALLSTATE
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=DIALING
dwParam2=0
dwParam3=0No change
CallToneChangedEvent, CH=C1,
Tone=ZipZip,
Feature=FACCMC,
FACRequired=True,
CMCRequired=FalseLINE_DEVSPECIFIC
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=SLDSMT_CALL_TONE_CHANGED
dwParam2=CTONE_ZIPZIP
dwParam3=
CZIPZIP_FACREQUIREDNo change
T302 timer times out waiting for digits or Party A does a lineDial() with an invalid FAC.
CallStateChangedEvent, CH=C1, State=Disconnected,
Cause=
CtiNoRouteToDDestination,
Reason=FACCMC,
Calling=A, Called=NP,
OrigCalled=NP, LR=NPLINE_CALLSTATE
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=DISCONNECTED
dwParam2=DISCONNECT
MODE_FACCMC1
dwParam3=0No change
CallStateChangedEvent, CH=C1, State=Idle, Cause=CtiCauseNoError, Reason=Direct, Calling=A, Called=NP, OrigCalled=NP, LR=NP
LINE_CALLSTATE
hDevice=hCall-1
dwCallbackInstance=0
dwParam1=IDLE
dwParam2=0
dwParam3=0No change
Refer / Replaces Scenarios
In-Dialog Refer - Referrer in Cisco Unified Communications Manager Cluster
In-Dialog Refer Where ReferToTarget Redirects the Call in Offering State
In-Dialog Refer Where Refer Fails / Refer to Target is Busy
Out-of-Dialog Refer
Invite with Replace for Confirmed Dialog
Preconditions
A, B, and C are inside Cisco Unified Communications Manager. There is a confirmed dialog between A and B.
C initiates Invite to A with replace B's dialog id
Refer with Replace for All in Cluster
Preconditions
There is a confirmed dialog between A and B and A and C.
A initiates Refer to C with replace B's dialog id.
Refer with Replace for All in Cluster, Replace Dialog Belongs to Another Station
Preconditions
A is Referrer, D is Referee, and C is Refer-to-Target.
There is a confirmed dialog between A(d1) and B & C(d2) and D.
A initiates Refer to D on (d1) with Replaces (d2).
3XX scenario
Preconditions
Application is monitoring B.
SRTP Scenario
Media Terminate by Application (open secure CTI port or RP)
•
•
•
•
•
•
•
•
•
Media Terminate by TSP Wave Driver (open secure CTI port)
•
•
•
•
•
•
•
•
•
Intercom Feature Scenarios
This is the configuration used for all the use cases below.
1.
2.
3.
4.
5.
6.
7.
Assumption: Application initialized and CTI provided the details on speeddial and lines with intercom line on all the devices. Behavior should be same for SCCP and SIP phones.
Application Invoking Speeddial
Agent Invokes Talkback
Change the SpeedDial
Secure Conferencing Feature Scenarios
Conference with all parties as Secure
Preconditions: The conference bridge has security profile. MOH is not configured. A, B, and C are registered as Encrypted.
Hold/Resume in Secure Conference
Preconditions: conference bridge has security profile. MOH is configured. A, B, and C are secure phones and are in conference with overall call security status as secure.
Monitoring & Recording Feature Scenarios
Monitoring a Call
Precondition: A(agent) & B(customer) are connected. BIB on A is set to on.
Automatic recording
Precondition: recording type on A (agent Phone) is configured as `Automatic'. D is configured as a Recorder Device.
Application-Controlled Recording
Precondition: A (C1) and B (C2) are connected. Recording Type on A is configured as `Application Based'. D is configured as a Recorder Device.
Conference Enhancement Use Cases
Non-Controller adding a party to a conference
Setup: A,B, C in a conference created by A.
Chaining two ad-hoc conferences using Join
