SoftPhoneCtrl使用说明.doc

SoftphoneCtrl.ocx使用说明属性1， AgentID【数据类型】字符串【属性功能】坐席物理编号【默认值】无（必须有值，并存在）2， ShowConsole【数据类型】布尔型【属性功能】控制此控件在使用时是否要使用默认界面，为真时使用【默认值】true3， TransmitSvrIP【数据类型】字符串【属性功能】交换机IP地址【默认值】4， TransmitSvrPort【数据类型】短整型【属性功能】交换机中TransmitSvr程序端口【默认值】10015， CustomVal1【数据类型】字符串【属性功能】用户自定义参数1，用于和IVR交互（长度不能超过60个字符）【默认值】空6， CustomVal2【数据类型】字符串【属性功能】用户自定义参数2，用于和IVR交互（长度不能超过60个字符）【默认值】空函数1， 初始化【预置条件】【函数原型】long StartAgent()【参数说明】【返回值】非零表示失败，0表示成功。【函数说明】2， 登录【预置条件】StartAgent()【函数原型】long UserLogin(BSTR WorkID, BSTR Passwd)【参数说明】WorkID类型：字符串说明：工号Passwd类型：字符串说明：密码【返回值】非零表示失败，0表示成功。【函数说明】登录注册3， 选择组【预置条件】UserLogin()，事件UserGroup、UserSkillGroup【函数原型】long Login(BSTR WorkId, BSTR Group, BSTR SkillGroup)【参数说明】WorkId类型：字符串说明：工号Group类型：字符串说明：服务组SkillGroup类型：字符串说明：技能组【返回值】非零表示失败，0表示成功。【函数说明】注册所属组4， 退出【预置条件】Login【函数原型】long LogOff()【参数说明】【返回值】非零表示失败，0表示成功。【函数说明】退出系统5， 离席【预置条件】Login【函数原型】long Pause(BSTR strReason)【参数说明】strReason 类型：字符串说明：离开原因取值意义：可以做成类似于MSN的下拉菜单，让用户选择【返回值】非零表示失败，0表示成功。【函数说明】暂时离开系统，可以查询到，不可以接电话6， 恢复【预置条件】Pause【函数原型】long ComeBack()【参数说明】【返回值】非零表示失败，0表示成功。【函数说明】从离开状态恢复到登录后状态7， 提交【预置条件】【函数原型】long Commit()【参数说明】【返回值】非零表示失败，0表示成功。【函数说明】坐席挂电话后，处理完后续事务，恢复到登录后状态8， 挂机【预置条件】【函数原型】long OnHook()【参数说明】【返回值】非零表示失败，0表示成功。【函数说明】坐席强制挂机9， 外拨【预置条件】【函数原型】long DialOut(BSTR strPhone, BSTR strExt)【参数说明】strPhone 类型：字符串说明：外拨电话号码取值意义：不可以为空strExt 类型：字符串说明：外拨电话分机号码取值意义：为空表示没有分机【返回值】非零表示失败，0表示成功。【函数说明】10， 查询【预置条件】【函数原型】long QueryOtherSeat()【参数说明】【返回值】非零表示失败，0表示成功。【函数说明】当需要转接或磋商时需要知道别的坐席是否在线，用此函数查询，结果以事件OnlineAgent返回11， 转接【预置条件】【函数原型】long TransferRequest(BSTR strSeatNum)【参数说明】strSeatNum 类型：字符串说明：需要转接的坐席编号取值意义：不可为空，此坐席状态必须为READY【返回值】非零表示失败，0表示成功。【函数说明】12， 转外线【预置条件】【函数原型】long TransferOut(BSTR strPhone, BSTR strExt)【参数说明】strPhone 类型：字符串说明：外转电话号码取值意义：不可以为空strExt 类型：字符串说明：外转电话分机号码取值意义：为空表示没有分机【返回值】非零表示失败，0表示成功。【函数说明】将来电转接到外线13， 磋商【预置条件】【函数原型】long Consultation(BSTR strSeatNum)【参数说明】strSeatNum 类型：字符串说明：需要磋商的坐席编号取值意义：不可为空，此坐席状态必须为READY【返回值】非零表示失败，0表示成功。【函数说明】将来电挂起，和别的坐席磋商14， 磋商转接【预置条件】【函数原型】long ConsultationTrafer(BSTR strSeatNum)【参数说明】strSeatNum 类型：字符串说明：需要磋商转接的坐席编号取值意义：不可为空【返回值】非零表示失败，0表示成功。【函数说明】当磋商不能解决问题时，需要将电话转接到正在磋商的坐席15， 磋商接回【预置条件】【函数原型】long ConsultationEnd(BSTR strSeatNum)【参数说明】strSeatNum 类型：字符串说明：需要磋商转接的坐席编号取值意义：不可为空【返回值】非零表示失败，0表示成功。【函数说明】16， 磋商三方【预置条件】【函数原型】long ConsultationConf(BSTR strSeatNum)【参数说明】strSeatNum 类型：字符串说明：需要磋商转接的坐席编号取值意义：不可为空【返回值】非零表示失败，0表示成功。【函数说明】磋商三方，目前不可用17， 人工转IVR【预置条件】【函数原型】long TransferIVR()【返回值】非零表示失败，0表示成功。【函数说明】人工转IVR18， 外线磋商【预置条件】【函数原型】long ConsultationOut(BSTR strTel)【参数说明】strTel类型：字符串说明：需要磋商转接的电话号码取值意义：不可为空【返回值】非零表示失败，0表示成功。【函数说明】外线磋商19， 外线磋商转接【预置条件】ConsultationOut(BSTR strTel)【函数原型】long ConsultationTraferOut()【返回值】非零表示失败，0表示成功。【函数说明】外线磋商转接20， 外线磋商接回【预置条件】ConsultationOut(BSTR strTel)【函数原型】long ConsultationEndOut()【返回值】非零表示失败，0表示成功。【函数说明】外线磋商接回21 坐席聊天（发送文本信息）【预置条件】【函数原型】long SendChatMsg(BSTR DestAgent, BSTR strMsg);【参数说明】DestAgent类型：字符串说明：目标坐席分机号取值意义：”所有人”指发送到所有的在线坐席。不可为空strMsg类型：字符串说明：文本内容取值意义： 不可为空【返回值】非零表示失败，0表示成功。【函数说明】坐席间发送文本信息事件1， SPGetCall(BSTR Caller, BSTR Called, BSTR CxID,long MakeCallType, long ContactType)【事件说明】来电时告知来电号码，和被叫等信息【参数说明】Caller 类型：字符串说明：来电号码Called 类型：字符串说明：被叫号码CxID类型：字符串说明：呼叫编号MakeCallType 目前无意义ContactType类型：整形说明：线路类型（目前无意义）2， SPStatusChanged(BSTR State)【事件说明】坐席的状态变化【参数说明】State 类型：字符串说明：状态值取值意义：比如：“来电”、“挂机”等3， Login()【事件说明】使用默认界面编程时，当点击登录按钮，返回这个事件，在这个事件中调用登陆函数4， OnlineAgent(BSTR strWorkID, BSTR strState, BSTR strService, BSTR strGroup, BSTR strSeatNum)【事件说明】当查询其他在线坐席后以此事件返回结果，会触发多次此事件，一次事件对应一个坐席【参数说明】State 类型：字符串说明：状态值取值意义：比如：“来电”、“挂机”等5， AgentState(BSTR strState, BSTR strFuncState)【事件说明】所有接口函数状态变化【参数说明】strState 类型：字符串说明：目前无意义strFuncState 类型：字符串说明：所有接口函数状态掩码，每一位代表一个函数，当为1时表示可用，为0表示不可用，可以用此来对各功能按钮作是否可用的依据，对应关系如下：strFuncState0 = ;/选择组strFuncState1 = ;/退出strFuncState2 = ;/转接strFuncState3 = ;/磋商转接strFuncState4 = ;/磋商接回strFuncState5 = ;/磋商会议strFuncState6 = ;/外拨strFuncState7 = ;/查询其他坐席strFuncState8 = ;/磋商strFuncState9 = ;/转外线strFuncState10 = ;/离席strFuncState11 = ;/恢复strFuncState12 = ;/提交strFuncState13 = ;/挂机strFuncState14 = ;/初始化strFuncState15 = ;/人工转IVRstrFuncState16 = ;/登录strFuncState17 = ;/外线磋商strFuncState18 = ;/外线磋商转接strFuncState19 = ;/外线磋商接回6， SPWrapUp()【事件说明】目前不可用7， CreateOutBoundSucc(BSTR EvtName)【事件说明】目前不可用8， SocketConnect(boolean IsConnect)【事件说明】和交互机之间的socket连接事件，【参数说明】IsConnect类型：布尔说明：为真表示已连接，为假表示连接断开9， UserLoginError(short ErrorType)【事件说明】当调用UserLogin登录后验证用户密码失败时发生，表明登录失败【参数说明】ErrorType类型：短整形说明：为1表示用户名或密码错误，为2表示用户已经登录10， UserGroup(long Count, long index, BSTR strGro