WILCOM CCLAIx V控件开发说明书.docx

1、WILCOM CCLAIx V控件开发说明书上海井星科技有限公司Wilcom CCLAIx控件开发使用说明书版本 2.0.002010-9-8目 录1 概述 51.1 目标 51.2 符号说明 52 开发流程 62.1 控件简介 62.2 控件安装 62.3 开发流程 62.4 开发注意事项 73 标准开发接口 83.1 接口简介 83.2 标准开发接口函数 8 InitConnection 8 InitControlServer 8 OpenWritePath 9 CloseWritePath 9 SendMonitorDevice 9 SendSetAgentState 10 SendSe

2、tAgentStateEx 10 SendStopMonitorDevice 11 SendAnswerCall 11 SendHangupCall 11 SendHoldCall 12 SendRetrieveCall 12 SendMakeCall 12 SendTransferCall 13 SendPickupCall 13 SendAlternateCall 14 SendConsultationCall 14 SendConferenceCall 15 SendReconnectCall 15 SendDisconnectCall 15 SendDivertCall 16 Send

3、ChangePassword 16 SendQueryQueueInfo 17 SendSingleStepConference 17 SendQueryGroupInfoV2 17 SendHeartBeatV2 18 SendQueryTrunkGroupInfoV2 18 SendQueryReasonCodeInfoV2 18 SendMakePredictiveCall 193.3 标准控件事件接口 19 OnIncomingCallEvt 19 OnCallConnectEvt 20 OnCallDisconnectEvt 20 OnSeizedEvt 20 OnAlertingE

4、vt 21 OnCallFailureEvt 21 OnAgentStateChangeEvt 21 OnOriginatedCallEvt 22 OnHoldCallEvt 22 OnConferenceCallEvt 23 OnConferenceCallEvtV3 23 OnTransferCallEvt 24 OnTransferCallEvtV3 24 OnRetrieveCallEvt 25 OnPickupCallEvt 25 OnCCLinkChangeEvt 26 OnCCLinkSwitchEvt 26 OnCCLinkUnavailableEvt 27 OnMonitor

5、DeviceRespond 27 OnQueryQueueInfoRespond 27 OnQueryGroupInfoV2Respond 28 OnHeartBeatV2Respond 28 OnQueryTrunkGroupInfoV2Respond 29 OnQueryReasonCodeInfoV2Respond 29 OnMakePredictiveCallRespond 29 OnSetAgentStateRespond 30 OnSetAgentStateRespond 30 OnStopMonitorDeviceRespond 30 OnStopMonitorAllDevice

6、Respond 30 OnHangupCallRespond 31 OnHoldCallRespond 31 OnRetrieveCallRespond 31 OnMakeCallRespond 32 OnTransferCallRespond 32 OnPickupCallRespond 32 OnAlternateCallRespond 33 OnConsultationCallRespond 33 OnConferenceCallRespond 33 OnMakePredictiveCallRespond 33 OnDisconnectCallRespond 34 OnDirvertCa

7、llRespond 34 OnChangePasswordRespond 34 OnQueryQueueInfoRespond 35 OnQueryQueueInfoEXRespond 35 OnQueryGroupInfoV2Respond 35 OnMonitorAllDeviceRespond 36 OnRequestFailureRespond 36 OnQueryAgentStateV2Respond 37 OnQueryGroupAgentListV2Respond 37 OnHeartBeatV2Respond 38 OnQueryTrunkGroupInfoV2Respond

8、38 OnQueryReasonCodeInfoV2Respond 38 OnQueryVDNListEvt 39 OnQueryUCIDV2Respond 393.4 CCLink返回异常码说明 394 开发例程 434.1 例程简介 434.2 开发示例 43 初始化操作处理 43 座席登录操作处理 44 座席登录事件处理 44 电话来电振铃事件处理 45 电话保持操作处理 46 电话会议操作处理 465 初始化流程处理 475.1 初始化流程处理说明 476 FAQ 477 技术支持 491 概述Wilcom CCLAIx控件是在WILCOM CTI系统中连接服务端和客户端的工具，利用该

9、控件可以完成软电话,录音软件,班长监控等客户端程序的基本功能。1.1 目标本文的目的是使读者可以了解控件的安装、接口和事件，阅读本文后能够编写基于Wilcom CTI的简单电话功能软件。1.2 符号说明in 输入参数out 输出参数in/out 该参数在函数调用时，作为输入参数 ；在函数返回时，作为输出参数2 开发流程2.1 控件简介CCLAIx控件是基于Wilcom CTI系统之上的一个通信工具，用户可以调用CCLAIx控件接口，发送请求给CTI服务器，并且通过CCLAIx控件的事件接口获取到服务器的返回和事件通知。CCLAIx控件接口支持C/C+、C#、VBScript、JavaScrip

10、t等语言的调用，但目前不支持java语言。CCLAIx控件与CTI服务器的架构图2.2 控件安装打开 “开始-运行” ，在输入框中输入regsvr32 CCLAIx控件的路径；如果弹出注册成功，那么控件安装就成功了。2.3 开发流程1.用户进行一般性的开发时，则利用CCLAIx控件进行开发时，首先需要调用InitConnection接口建立和CTI服务器之间的连接，然后调用相应的接口与CTI服务器进行通信。2.用户如需使用高可靠功能，则利用CCLAIx控件进行开发时，首先需要调用InitControlServer接口建立和2台CTI服务器之间的连接，CCLAIx根据用户传入的参数将一台CCLi

11、nk作为默认进行命令请求的服务器.当该台CCLink发生异常时,CCLAIx将自动与另外一台CCLink进行命令请求,并进行相关信息的同步.同时向外触发CCLink切换事件及CCLink状态改变事件.当2台CCLink均无法正常工作时,CCLAIx将向外触发CCLink无法使用事件. 如果需要监视某个分机，可以调用SendMonitorDevice接口发送监视某个分机的请求，这样当这个分机有事件 （例如摘机、通话、会议等）产生时，CCLAIx控件会触发相关的事件接口。用户控件开发流程如下： CCLAIx控件开发流程图1 CCLAIx 控件开发流程图2 2.4 开发注意事项一般进行电话控制时，我

12、们通常使用CALLID 标示一通Call，所以需要对CallID 进行保存，以便在对这通电话进行操作时用到。例如：当保持一通电话时，在调用SendHoldCall接口发送保持电话请求时，参数中有要保持电话的CallID。3 标准开发接口3.1 接口简介CCLAIx控件接口分为开发接口和事件接口，开发接口就是让用户通过调用来操作电话和改变座席状态的；而事件接口是当话机或在登录在该话机上座席发生改变时，控件通过事件接口来通知客户端的。3.2 标准开发接口函数 InitConnection函数原形：long InitConnection( long localPort, long remotePor

13、t, BSTR remoteIP);功能： 初始化和CTI服务器的连接；参数说明： localPort ： in 本地端口号 remotePort： in 服务器端口号 remoteIP ： in 服务器IP地址返回值： 0 表示成功 其它失败说明： 无 InitControlServer函数原形：long InitControlServer(LONG localPort,LONG CtiPort, LONG ControPort, BSTR MostlyCtiIP,BSTR ControlIP);功能： 初始化和2台CTI服务器的连接；参数说明： localPort ： in 本地端口号 C

14、tiPort ： in 主CTI服务器端口号 ControlPort ： in 备CTI服务器端口号 MostlyCtiIP ： in 主CTI服务器IP ControlIP ： in 备CTI服务器IP返回值： 0 表示成功 其它失败说明： 该接口占用2个本地端口,一个为用户传入的端口,另外一个为用户传入的端口号+1所获值. OpenWritePath函数原形：void OpenWritePath(void)功能： 开启控件记录日志功能参数说明： 无返回值： 无说明： 可以通过调用该函数开启日志记录功能 CloseWritePath函数原形：void CloseWritePath(void)

15、功能： 关闭控件记录日志功能参数说明： 无返回值： 无说明： 在开启日志记录功能后,通过调用该函数来关闭日志记录功能 SendMonitorDevice函数原形：void SendMonitorDevice( BSTR deviceID, char monitorMode);功能： 监视分机；参数说明： DeviceID ：in 要监视的分机号码 monitorMode：in 监视类型 一般为: 1返回值： 无说明：无 SendSetAgentState函数原形：void SendSetAgentState( BSTR deviceID, BSTR agentID, BSTR agentPWD

16、, BSTR agentGroup, char agentMode);功能： 修改座席状态，实现登录、话后处理、暂停、退出、工作等座席的状态改变参数说明： deviceID ：in 分机号码 agentID ：in 座席号码 agentPWD ：in 座席密码 agentGroup：in 座席的组号 agentMode ：in 座席状态返回值： 无 说明： agentMode 0 表示 登录 48 1 表示 退出 49 2 表示 暂停 50 3 表示 工作 51 4 表示 话后处理 52 SendSetAgentStateEx函数原形：void SendSetAgentStateEx( BST

17、R deviceID, BSTR agentID, BSTR agentPWD, BSTR agentGroup, char agentMode, char ReasonCode);功能： 修改座席状态，实现登录、话后处理、暂停、退出、工作等座席的状态改变；相比SendSetAgentState接口添加了ReasonCode参数。该参数为用户座席状态变为暂停时传递的原因码(暂停原因码).参数说明： deviceID ：in 分机号码 agentID ：in 座席号码 agentPWD ：in 座席密码 agentGroup：in 座席的组号 agentMode ：in 座席状态 ReasonC

18、ode：in 原因码返回值： 无说明： 无 SendStopMonitorDevice函数原形：void SendStopMonitorDevice(BSTR deviceID);功能： 停止监视分机；参数说明： DeviceID :in 分机号码返回值： 无说明： 无 SendAnswerCall函数原形：void SendAnswerCall( BSTR deviceID, BSTR callID);功能： 发送应答电话；参数说明： deviceID ：in 分机号码 callID : in 电话标示ID返回值： 无说明： 无 SendHangupCall函数原形：void SendHan

19、gupCall( BSTR deviceID, BSTR callID);功能： 发送挂断电话；参数说明： deviceID ：in 分机号码 callID : in 电话标示ID返回值： 无说明： 无 SendHoldCall函数原形：void SendHoldCall( BSTR deviceID, BSTR callID);功能： 发送保持电话；参数说明： deviceID ：in 分机号码 callID : in 电话标示ID返回值： 无说明： 无 SendRetrieveCall函数原形：void SendRetrieveCall( BSTR deviceID, BSTR callI

20、D);功能： 发送取消保持电话；参数说明： deviceID ：in 分机号码 callID : in 电话标示ID返回值： 无说明： 无 SendMakeCall函数原形：void SendMakeCall( BSTR callingDeviceID, BSTR calledDeviceID, char CallType, BSTR UUI);功能： 发送外拨电话；参数说明： callingDeviceID ：in 主叫号码 calledDeviceID ：in 被叫号码 CallType ：in 呼叫类型 一般是1 UUI ：in 一般为空返回值： 无说明： 电话外拨时，注意如果使用的是模

21、拟话机 那么在发送外拨请求后5s内，要将话机摘机，不然外拨会失败。 SendTransferCall函数原形：void SendTransferCall( BSTR heldDeviceID, BSTR heldCallID, BSTR activeDeviceID, BSTR activeCallID);功能： 发送电话转移请求；参数说明： heldDeviceID ：in 处于电话保持的分机号码 heldCallID ：in 处于电话保持的CallID activeDeviceID ：in 处于当前通话的分机号码 activeCallID ：in 当前通话的CallID返回值： 无说明：

22、无 SendPickupCall函数原形：void SendPickupCall( BSTR deviceID, BSTR calledDeviceID);功能： 发送电话代接请求；参数说明： deviceID ：in 要代接的分机号码 calledDeviceID ：in 被代接的分机号码返回值： 无说明： 无 SendAlternateCall函数原形：void SendAlternateCall( BSTR heldDeviceID, BSTR heldCallID, BSTR activeDeviceID, BSTR activeCallID);功能： 发送电话切换请求；参数说明： h

23、eldDeviceID ：in 处于电话保持的分机号码 heldCallID ：in 处于电话保持的CallID activeDeviceID ：in 处于当前通话的分机号码 activeCallID ：in 当前通话的CallID返回值： 无说明： 无 SendConsultationCall函数原形：void SendConsultationCall( BSTR deviceID, BSTR callID, BSTR calledDeviceID, char CallType, BSTR UUI);功能： 发送电话磋商请求；参数说明： deviceID ：in 分机号码 callID ：i

24、n 当前呼叫的CallID calledDeviceID ：in 要磋商的分机号码 CallType ：in 呼叫类型 一般是1 UUI ：in 一般为空返回值： 无说明： 无 SendConferenceCall函数原形：void SendConferenceCall( BSTR heldDeviceID, BSTR heldCallID, BSTR activeDeviceID, BSTR activeCallID);功能： 发送电话会议请求；参数说明： heldDeviceID ：in 处于电话保持的分机号码 heldCallID ：in 处于电话保持的CallID activeDevi

25、ceID ：in 处于当前通话的分机号码 activeCallID ：in 当前通话的CallID返回值： 无说明： 无 SendReconnectCall函数原形：void SendReconnectCall( BSTR heldDeviceID, BSTR heldCallID, BSTR activeDeviceID, BSTR activeCallID);功能： 发送电话重连请求；参数说明： heldDeviceID ：in 处于电话保持的分机号码 heldCallID ：in 处于电话保持的CallID activeDeviceID ：in 处于当前通话的分机号码 activeCal

26、lID ：in 当前通话的CallID返回值： 无说明： 无 SendDisconnectCall函数原形：void SendDisconnectCall( BSTR deviceID, BSTR disconnectedDeviceID);功能： 发送电话挂断请求；参数说明： deviceID ：in 分机号码 disconnectedDeviceID ：in 要挂断电话的分机号码返回值： 无说明： 无 SendDivertCall函数原形：void SendDivertCall( BSTR callingDeviceID, BSTR calledDeviceID, char CallTyp

27、e, BSTR UUI);功能： 发送电话前转请求；参数说明： callingDeviceID ：in 分机号码 calledDeviceID ：in 要前转的分机号码 CallType ：in 呼叫类型 一般是1 UUI ：in 一般是空返回值： 无说明： 无 SendChangePassword函数原形：void SendChangePassword( BSTR agentID, BSTR oldPassword, BSTR newPassword);功能： 发送修改座席登录密码请求；参数说明： agentID ：in 要修改密码的座席号码 oldPassword ：in 座席的原密码 n

28、ewPassword ：in 座席的新密码返回值： 无说明： 无 SendQueryQueueInfo函数原形：void SendQueryQueueInfo( BSTR deviceID, BSTR agentID);功能： 发送查询排队信息；参数说明： deviceID 要查询排队信息的分机号码 agentID 座席号码返回值： 无说明： 无 SendSingleStepConference函数原形：void SendSingleStepConference( BSTR callID, BSTR deviceID, BSTR joinDeviceID, char joinType);功能： 发送电话单步会议请求；参数说明： callID ：in 可以为空 deviceID ：in 正在通话的分机号码 joinDeviceID ：in 要加入通话的分机号码 joinTyp