冠和中间件接口文档.doc

Rockway 中间件接口说明文档 杭州冠和科技有限公司2007年10月26日版本历史记录冠和中间件坐席控件文档日期修订人审定人版本2006-01-01陈小红V0.0.12007-11-01姚国军V0.1.1 目录目录3一、属性：51.long AgentState5二、方法：51.坐席登陆52.坐席登出53.坐席示忙54.坐席示闲55.呼叫56.携带数据呼叫57.接听58.拒接59.挂机510.转接611.转接612.会议613.会议614.磋商615.单步转接616.单步会议617.获取错误信息618.保持619.接回620.强插（同步）621.监听622.连接服务器723.退出724.设置全局随路数据725.播放语音（要求由IVR板卡协助）726.停止播放（要求由IVR板卡协助）727获取坐席状态列表728获取指定坐席状态明细7三、事件：81.网络断开82.录音文件通知（紧跟着接通事件触发）83.接通事件84.通话断开事件85.来电事件86.远端震铃97.呼叫发起失败事件98.呼叫保持事件99.呼叫接回事件910.呼叫初始化事件，一般发生主拨时911.网络初始化，一般发生在出局时912.呼叫到达913.呼叫被转接914.会议9一、属性：1. long AgentState坐席状态属性0:未登录，1：登陆就绪，2：示闲，3：示忙，4：话后处理二、方法：所有方法，成功返回0，失败返回非01. 坐席登陆long CTAgentLogIn(LPCTSTR group_id, LPCTSTR password);2. 坐席登出long CTAgentLogOut(LPCTSTR password);3. 坐席示忙long CTAgentShowBusy();4. 坐席示闲long CTAgentShowFree();5. 呼叫long CTMakeCall(LPCTSTR phone_id);6. 携带数据呼叫long CTMakeCallWithData(LPCTSTR phone_id，LPCSTR data);data：应用于自动外呼，在外呼成功之后，将全局的corrleator data设置此值，以便当外呼成功后转接坐席时随路携带此数据,data字符串不超过31位7. 接听long CTAnswerCall();8. 拒接long CTRejectCall();9. 挂机long CTHangup();10. 转接long CTTransfer();11. 转接long CTTransferTo(LPCTSTR phone_id, LPCTSTR data，long timeout_sec);12. 会议long CTConference();13. 会议long CTConferenceTo(LPCTSTR phone_id, LPCTSTR data，long timeout_sec);14. 磋商long CTConsultation(LPCTSTR phone_id, LPCTSTR data);15. 单步转接long CTSingleStepTransfer(LPCTSTR phone_id, LPCTSTR data);16. 单步会议long CTSingleStepConference(LPCTSTR phone_id, LPCTSTR data);17. 获取错误信息BSTR GetLastErrorMsg();18. 保持long CTHoldCall();19. 接回long CTRetrieveCall();20. 强插（同步）long CTIntrude(LPCTSTR phone_id);21. 监听long CTListen(LPCTSTR phone_id);22. 连接服务器long CTConnect(LPCTSTR server_ip, long server_port, LPCTSTR phone_id, LPCTSTR agent_name, LPCTSTR password);23. 退出void CTExit();24. 设置全局随路数据long CTSetCorrelatorData（LPCSTR data）data字符串不超过31位长25. 播放语音（要求由IVR板卡协助）long CTPlay（LPCSTR filename，long type）type=0: 给坐席，type=1,给客户26. 停止播放（要求由IVR板卡协助）long CTStopPlay();27获取坐席状态列表BSTR GetAgentStatusList(LPCTSTR agencyNo)返回结果为一字符串,格式说明AgentCode1,AgentStatus1;AgentCode2,AgentStatus2;AgentCode为座席号AgentStatus为座席状态，座席状态的值为英文，以下是中英文对照表：Login 登录Free空闲Busy忙CallEnd 话后处理Talking 客户通话InTalking 内部通话Wail 振铃28获取指定坐席状态明细BSTR GetAgentStatus(LPCTSTR agencyNo，LPCTSTR agentCode)返回结果为一字符串,格式说明AgentCode1,AgentStatus1AgentCode为座席号AgentStatus为座席状态，座席状态的值为英文，以下是中英文对照表：Login 登录Free空闲Busy忙CallEnd 话后处理Talking 客户通话InTalking 内部通话Wail 振铃三、事件：1. 网络断开OnNetworkBroken()在客户端和cti断开连接时触发。2. 录音文件通知（紧跟着接通事件触发）OnRecordNotify(LPCTSTR record_fname)record_fname：录音文件名称3. 接通事件OnCallConnected(LPCTSTR ani, LPCTSTR dnis, LPCSTR record_fname, int isInternalCall，long callid)ani：主叫号码dnis：被叫号码record_fname: 录音文件名（也可以通过RecordNotify获取文件名）callid：呼叫标识isInternalCall：0为外部呼叫，1为内部呼叫4. 通话断开事件OnCallDisconnected(LPCSTR releaser,long callid)releaser: 通话挂断方callid：呼叫标识5. 来电事件OnCallIncoming(LPCTSTR ani, LPCTSTR dnis, LPCTSTR data, long callid)ani：主叫号码dnis：被叫号码data：随路数据callid：呼叫标识6. 远端震铃OnCallPost(LPCTSTR ani, LPCTSTR dnis, long callid)ani：主叫号码dnis：被叫号码callid：呼叫标识7. 呼叫发起失败事件OnCallFailed(LPCSTR cause,long callid)callid：呼叫标识cause: 错误说明8.呼叫保持事件OnCallHeld(LONG callid);callid：呼叫标识9.呼叫接回事件OnCallRetrieved(LONG callid);callid：呼叫标识10.呼叫初始化事件，一般发生主拨时OnCallOriginated(LONG callid);callid：呼叫标识11.网络初始化，一般发生在出局时OnSe