AmanyOCX开发指南.doc

Amany OCX 应用开发指南应用开发指南 Version 1.0 上上 海海 声声 通通 信信 息息 科科 技技 有有 限限 公公 司司 2019 年 4 月 6 日 Amany OCX 开发指南 第 1 页 共 41 页 目目 录录 1控件简述控件简述.6 2文档约定文档约定.6 3运行模式运行模式.6 4方法列表方法列表.7 4.1QUERYFUNCTION.7 4.1.1输入参数7 4.1.2返回值7 4.1.3示例或原型7 4.1.4说明7 4.2CONNECT8 4.2.1输入参数8 4.2.2返回值8 4.2.3示例或原型8 4.2.4说明9 4.3DISCONNECT.9 4.3.1输入参数9 4.3.2返回值9 4.3.3示例或原型9 4.3.4说明9 4.4LOGIN.10 4.4.1输入参数10 4.4.2返回值10 4.4.3示例或原型10 4.4.4说明11 4.5LOGOUT11 4.5.1输入参数11 4.5.2返回值11 4.5.3示例或原型11 4.5.4说明11 4.6GETAGENTID.12 4.6.1输入参数12 4.6.2返回值12 4.6.3示例或原型12 4.6.4说明12 4.7GETDEVICEID12 4.7.1输入参数12 4.7.2返回值12 4.7.3示例或原型13 4.7.4说明13 4.8GETSTATUS13 4.8.1输入参数13 4.8.2返回值13 4.8.3示例或原型13 4.8.4说明13 4.9CHANGEAGENTSTATUS14 Amany OCX 开发指南 第 2 页 共 41 页 4.9.1输入参数14 4.9.2返回值14 4.9.3示例或原型14 4.9.4说明14 4.10CHANGEAGENTPASSWORD15 4.10.1输入参数15 4.10.2返回值15 4.10.3示例或原型15 4.10.4说明15 4.11SENDTXTMESSAGE.16 4.11.1输入参数16 4.11.2返回值16 4.11.3示例或原型16 4.11.4说明16 4.12GETLEAVECAUSES.17 4.12.1输入参数17 4.12.2返回值17 4.12.3示例或原型17 4.12.4说明17 4.13HANGUP.18 4.13.1输入参数18 4.13.2返回值18 4.13.3示例或原型18 4.13.4说明18 4.14ANSWERCALL18 4.14.1输入参数18 4.14.2返回值19 4.14.3示例或原型19 4.14.4说明19 4.15MAKECALL19 4.15.1输入参数19 4.15.2返回值19 4.15.3示例或原型20 4.15.4说明20 4.16TRANSFERCALL20 4.16.1输入参数20 4.16.2返回值20 4.16.3示例或原型20 4.16.4说明21 4.17CONFERENCECALL.21 4.17.1输入参数21 4.17.2返回值21 4.17.3示例或原型21 4.17.4说明22 4.18CANCEL22 4.18.1输入参数22 4.18.2返回值22 4.18.3示例或原型22 4.18.4说明22 4.19STARTMONITOR.23 4.19.1输入参数23 Amany OCX 开发指南 第 3 页 共 41 页 4.19.2返回值23 4.19.3示例或原型23 4.19.4说明23 4.20STOPMONITOR24 4.20.1输入参数24 4.20.2返回值24 4.20.3示例或原型24 4.20.4说明24 4.21ISMONITOR.25 4.21.1输入参数25 4.21.2返回值25 4.21.3示例或原型25 4.21.4说明25 4.22KICKOUT25 4.22.1输入参数25 4.22.2返回值26 4.22.3示例或原型26 4.22.4说明26 4.23INTRUDE.26 4.23.1输入参数26 4.23.2返回值26 4.23.3示例或原型27 4.23.4说明27 4.24GETLASTERROR.27 4.24.1输入参数27 4.24.2返回值27 4.24.3示例或原型27 4.24.4说明28 5事件列表事件列表.28 5.1LOGGEDOUT.28 5.1.1参数表28 5.1.2触发原因28 5.1.3作用28 5.2UNKNOWNEVENT.28 5.2.1参数表28 5.2.2触发原因29 5.2.3作用29 5.3AGENTSTATUSCNGED.29 5.3.1参数表29 5.3.2触发原因29 5.3.3作用29 5.4INBOUNDCALL29 5.4.1参数表29 5.4.2触发原因30 5.4.3作用30 5.5ANSWERED.30 5.5.1参数表30 5.5.2触发原因30 5.5.3作用30 5.6CALLIDLE.31 Amany OCX 开发指南 第 4 页 共 41 页 5.6.1参数表31 5.6.2触发原因31 5.6.3作用31 5.7DIALTONE31 5.7.1参数表31 5.7.2触发原因31 5.7.3作用31 5.8CONFERENCED32 5.8.1参数表32 5.8.2触发原因32 5.8.3作用32 5.9AGENTSTATUS.32 5.9.1参数表32 5.9.2触发原因32 5.9.3作用33 5.10TEXTMESSAGE.33 5.10.1参数表33 5.10.2触发原因33 5.10.3作用33 5.11TRANSFERED33 5.11.1参数表33 5.11.2触发原因33 5.11.3作用34 5.12MINBOUNDCALL34 5.12.1参数表34 5.12.2触发原因34 5.12.3作用34 5.13MANSWERED34 5.13.1参数表34 5.13.2触发原因35 5.13.3作用35 5.14MCALLIDLE.35 5.14.1参数表35 5.14.2触发原因35 5.14.3作用35 5.15MDIALTONE.35 5.15.1参数表35 5.15.2触发原因36 5.15.3作用36 5.16MCONFERENCED36 5.16.1参数表36 5.16.2触发原因36 5.16.3作用36 5.17MTRANSFERED.36 5.17.1参数表36 5.17.2触发原因37 5.17.3作用37 5.18MTEXTMESSAGE37 5.18.1参数表37 5.18.2触发原因37 5.18.3作用37 Amany OCX 开发指南 第 5 页 共 41 页 5.19CONNECTIONBROKEN37 5.19.1参数表37 5.19.2触发原因38 5.19.3作用38 5.20CONNECTIONREADY.38 5.20.1参数表38 5.20.2触发原因38 5.20.3作用38 5.21AGENTSTATISTICS38 5.21.1参数表38 5.21.2触发原因39 5.21.3作用39 5.22DESTBUSY39 5.22.1参数表39 5.22.2触发原因39 5.22.3作用39 5.23DESTINVALID.39 5.23.1参数表39 5.23.2触发原因39 5.23.3作用40 6FOR DELPHI DEVELOPER40 Amany OCX 开发指南 第 6 页 共 41 页 1控件简述控件简述 Amany OCX 是 VoiceComm AmanyCTI 服务进行呼叫中心应用开发的座席端控件，方便第 三方开发人员开发自己的相关软件。 控件首先要注册才能使用。注册控件前，请先将 AmanyCTIX.ocx 以及相关的所有 dll 文件 拷贝到某个目录下，相关的库文件如下表所示。 文件名文件名描述描述 AmanyCTIX.ocx控件本身控件本身 SocketClient.dllAPI 入口入口 SocketCommon.dllAmany 异步客户端异步客户端 VSBase.dllVoiceComm 基础库基础库 VSPDU.dllVoiceComm 基础库基础库 VSSocket.dllVoiceComm 基础库基础库 向 windows 注册本控件使用如下语法: regsvr32 %控件存放的完整路径%AmanyCTIX.ocx 2文档约定文档约定 凡是在本文档中没有描述的方法和事件，但是在某些发布版本中可以见到，属于将被取缔 的内容，请不要使用 所有的字串值，都用单引号 ()括起来表示 3运行模式运行模式 为了减少网络流量和不必要的服务器开销，本控件封装了一套状态机制，所有的功能都对 调用时机做了控制，不是任何时间都可用。所以，请在调用任何功能之前，先调用 QueryFunction 方法确认该功能当前可用 Amany OCX 开发指南 第 7 页 共 41 页 4方法列表方法列表 共提供了 24 个方法 方法主要涵盖了座席管理，话务功能和班长席职能 3 个方面 4.1QueryFunction 4.1.1 输入参数输入参数 名称类型描述 FunctionIDlong功能编号 说明： 功能编号 FunctionID 的具体分配 如下表： 目前 FunctionID 不支持聚合参数值 4.1.2 返回值返回值 long 类型 1 表示方法可用 0 表示方法不可用 4.1.3 示例或原型示例或原型 Vc+示例： BOOL CDemoAgentXDlg:QueryFunction(long aFunctionID) return m_ m_xAmanyClient.QueryFunction(aFunctionID) ; 4.1.4 说明说明 该方法用来在调用功能之前检查功能的可用状态 Amany OCX 开发指南 第 8 页 共 41 页 4.2Connect 4.2.1 输入参数输入参数 名称类型描述 IPBSTR需要连接的服务器地址 Portlong服务器监听的端口号 说明: IP 可以是 IP 地址，机器名和域名 4.2.2 返回值返回值 BOOLEAN 类型 TRUE 表示连接成功 FALSE 表示连接失败 4.2.3 示例或原型示例或原型 Vc+示例： BOOL CDemoAgentXDlg:ConnectTo(LPCSTR IP,LPCSTR PORT) CString x; x.Format(“Trying to connect to %s on the port:%s.“,IP,PORT); ShowMSG(LPCSTR(x); if(m_xAmanyClient.Connect(IP,atoi(PORT) ShowMSG(“Connection has been established.“,DEMODLG_MSG_INFO); m_ControlTab.PostMessage(WM_REFRESHSTATUS,-1,0); else ShowMSG(“Failed to make connection.“,DEMODLG_MSG_ERROR); m_ControlTab.PostMessage(WM_REFRESHSTATUS,TAB_STATUS_ORIGINAL,0); return TRUE; Amany OCX 开发指南 第 9 页 共 41 页 4.2.4 说明说明 该方法用来建立同 CTI 服务器的连接 处理方式为同步 在 Disconnect 以前如果连接丢失,在网络可用之后会自动重新连接 4.3Disconnect 4.3.1 输入参数输入参数 无 4.3.2 返回值返回值 BOOLEAN 类型 TRUE 表示断开连接和资源回收成功 FALSE 表示处理失败 4.3.3 示例或原型示例或原型 Vc+示例： BOOL CDemoAgentXDlg:Disconnect() m_xAmanyClient.Disconnect(); ShowMSG(“Disconnected in grace from the server.“,DEMODLG_MSG_INFO); m_ControlTab.PostMessage(WM_REFRESHSTATUS,TAB_STATUS_ORIGINAL,0); return TRUE; 4.3.4 说明说明 该方法用来断开同 CTI 服务器的连接 处理方式为同步 在 Disconnect 以前如果连接丢失,在网络可用之后会自动重新连接 Amany OCX 开发指南 第 10 页 共 41 页 4.4Login 4.4.1 输入参数输入参数 名称类型描述 AgentIDBSTR需要登陆的 AgentID agentGroupIDBSTR需要登陆的组号 deviceAddressBSTR需要使用的设备号 PasswordBSTR登陆密码 说明： AgentGroupID 如果是空串，就是登陆所有可以使用的组 4.4.2 返回值返回值 BOOLEAN 类型 登陆成功，返回 TRUE 否则，返回 FALSE 4.4.3 示例或原型示例或原型 Vc+示例： BOOL CDemoAgentXDlg:Login ( const char* agentID, const char*agentGroupID, const char*deviceAddress, const char*password ) if(m_xAmanyClient.Login(agentID,agentGroupID,deviceAddress,password) SetStatus(AGENT_LOGIN); else CString reason = m_xAmanyClient.GetLastError(); ShowMSG(DEMODLG_MSG_ERROR,“Login failed.%s“,(LPCSTR)reason); m_ControlTab.PostMessage(WM_REFRESHSTATUS,-1,0); return TRUE; Amany OCX 开发指南 第 11 页 共 41 页 4.4.4 说明说明 座席使用该方法登陆到 CTI 服务器 处理方式为同步 如果登陆失败,请立即使用 GetLastError 获取错误描述 4.5Logout 4.5.1 输入参数输入参数 无 4.5.2 返回值返回值 BOOLEAN 类型 注销成功，返回 TRUE 否则，返回 FALSE 4.5.3 示例或原型示例或原型 Vc+示例： BOOL CDemoAgentXDlg:Logout() if(m_xAmanyClient.Logout() ShowMSG(“Agent has successfully logged OUT“); SetStatus(AGENT_LOGOUT); else ShowMSG(“Error occured when trying to log out.“,DEMODLG_MSG_ERROR); return TRUE; 4.5.4 说明说明 座席使用该方法在 CTI 服务器上注销 处理方式为同步,但是仍然会收到 LoggedOut 消息 Amany OCX 开发指南 第 12 页 共 41 页 4.6GetAgentID 4.6.1 输入参数输入参数 无 4.6.2 返回值返回值 BSTR 类型 含义就是当前登陆的 AgentID 4.6.3 示例或原型示例或原型 Vc+示例： CString CDemoAgentXDlg:GetAgentID() return m_xAmanyClient.GetAgentID(); 4.6.4 说明说明 获取当前登陆的 AgentID 处理方式为同步 4.7GetDeviceID 4.7.1 输入参数输入参数 无 4.7.2 返回值返回值 BSTR 类型 其内容就是当前登陆的电话号码 Amany OCX 开发指南 第 13 页 共 41 页 4.7.3 示例或原型示例或原型 Vc+示例： CString CDemoAgentXDlg:GetDeviceD() return m_xAmanyClient.GetDeviceID(); 4.7.4 说明说明 用来获取当前登陆的电话号码 处理方式同步 4.8GetStatus 4.8.1 输入参数输入参数 无 4.8.2 返回值返回值 short 类型 表示当前控件的工作状态： 4.8.3 示例或原型示例或原型 Vc+示例： short CDemoAgentXDlg:GetXStatus() return m_xAmanyClient.GetStatus(); 4.8.4 说明说明 该方法用来获取空间当前的工作状态 处理方式为同步 控件的状态机制不需要上层应用程序有更多干涉，这个的功能仅仅在做调试等特殊需求时 Amany OCX 开发指南 第 14 页 共 41 页 使用 4.9ChangeAgentStatus 4.9.1 输入参数输入参数 名称类型描述 stateShort目标状态标识 descriptionBSTR状态改变的原因描述 说明: state 值域，请参照 pdu.h 中的 AgentStateEnum 枚举定义 description 的长度不能超过 20 字节 4.9.2 返回值返回值 BOOLEAN 类型 表明请求发送是否成功 4.9.3 示例或原型示例或原型 Vc+示例： BOOL CDemoAgentXDlg:ChangeStatus ( unsigned char state , char * description ) m_xAmanyClient.ChangeAgentStatus(state,description); ShowMSG(“Trying to change the cuurent status,wait for response.“); return TRUE; 4.9.4 说明说明 当 Agent 需要切换状态时,调用这个方法 处理方式为异步,成功后将收到 AgentStatusCNGed 消息 Amany OCX 开发指南 第 15 页 共 41 页 4.10 ChangeAgentPassword 4.10.1输入参数输入参数 名称类型描述 oldPasswordBSTR旧密码 newPasswordBSTR新密码 说明: newPassword 不能低于 4 个字节 oldPassword 和 newPassword 最长 8 个字节 4.10.2返回值返回值 BOOLEAN 类型 密码修改成功，返回 TRUE 修改失败，返回 FAISE 4.10.3示例或原型示例或原型 Vc+示例： BOOL CDemoAgentXDlg:ChangePassword ( const char*oldpwd, const char* newpwd ) if(m_xAmanyClient.ChangeAgentPassword(oldpwd,newpwd) ShowMSG(“Password changed successfully!“,DEMODLG_MSG_WARNING); else ShowMSG(“Failed to change password!“,DEMODLG_MSG_ERROR); return TRUE; 4.10.4说明说明 座席使用该方法修改登陆到服务器的密码 处理方式为同步 如果修改失败,请立即使用 GetLastError 获取错误描述 Amany OCX 开发指南 第 16 页 共 41 页 4.11 SendTXTMessage 4.11.1输入参数输入参数 名称类型描述 addressBSTR接收消息的设备号 messageBSTR消息内容 说明: message 长度不能超过 512 字节，否则会被截断 4.11.2返回值返回值 BOOLEAN 类型 表明请求发送是否成功 4.11.3示例或原型示例或原型 Vc+示例： BOOL CAmanyCTIX:SendTXTMessage(LPCTSTR address, LPCTSTR message) BOOL result; static BYTE parms = VTS_BSTR VTS_BSTR; InvokeHelper(0x11, DISPATCH_METHOD, VT_BOOL, (void*) return result; 4.11.4说明说明 座席使用该方法向其他作息发送消息 处理方式为异步 服务器不保证该消息能成功发送到目的地，所以发送之前请保证目的地在服务器监控之下 并且已经有座席在线 Amany OCX 开发指南 第 17 页 共 41 页 4.12 GetLeaveCauses 4.12.1输入参数输入参数 名称类型描述 buflong存放数据的缓冲区的内存地址 bufbytelenlong缓冲区可以写入的最大字节数 countlong*内存地址，用来存放实际写入的原因项目个数 说明: 服务器最大传 100 个项目，所以 Bufbytelen 建议放到最大，9000 字节。 4.12.2返回值返回值 BOOLEAN 类型 正确提取到数据，返回 TRUE 否则，返回 FALSE 4.12.3示例或原型示例或原型 Vc+示例： BOOL CAmanyCTIX:GetLeaveCauses(long buf, long bufbytelen, long* count) BOOL result; static BYTE parms = VTS_I4 VTS_I4 VTS_PI4; InvokeHelper(0x16, DISPATCH_METHOD, VT_BOOL, (void*) return result; 4.12.4说明说明 用来从服务器获取预定义的座席离开原因 该方法处理方式为同步 Amany OCX 开发指南 第 18 页 共 41 页 4.13 HangUp 4.13.1输入参数输入参数 无 4.13.2返回值返回值 BOOLEAN 类型 表明请求发送是否成功 4.13.3示例或原型示例或原型 Vc+示例： BOOL CAmanyCTIX:HangUp() BOOL result; InvokeHelper(0x1, DISPATCH_METHOD, VT_BOOL, (void*) return result; 4.13.4说明说明 该方法用来挂断电话 处理方式为异步,成功之后将收到 CallIdle 消息 可以在接听时用它挂断电话 也可以在拨号进行时用它取消呼叫 4.14 AnswerCall 4.14.1输入参数输入参数 无 Amany OCX 开发指南 第 19 页 共 41 页 4.14.2返回值返回值 BOOLEAN 类型 表明请求发送是否成功 4.14.3示例或原型示例或原型 Vc+示例： BOOL CDemoAgentDlg:AnswerCall() :AmanyAnswerCall(LPSTR(LPCSTR(m_szAgentID),m_nCurCallID); ShowMSG(“Answer Call data sended successfully.“); return TRUE; 4.14.4说明说明 该方法用来在收到 InboundCall 消息之后接听电话 处理方式为异步,成功之后将收到 Answered 消息 在没有收到 InboundCall 消息之前请不要进行此操作 4.15 MakeCall 4.15.1输入参数输入参数 名称类型描述 destBSTR被呼叫的设备号 dataBSTR随线数据 说明: data 长度不能超过 512 字节 4.15.2返回值返回值 BOOLEAN 类型 表明请求发送是否成功 Amany OCX 开发指南 第 20 页 共 41 页 4.15.3示例或原型示例或原型 Vc+示例： BOOL CDemoAgentDlg:MakeCall(char * dest,char * data) :AmanyMakeCall(LPSTR(LPSTR(LPCSTR(m_szAgentID),m_nCurCallID,dest,data); CString msg; msg.Format(“Make call to %s ,wait for reponse.“,dest); ShowMSG(LPCSTR(msg); return TRUE; 4.15.4说明说明 需要拨打电话的时候,调用该方法 处理方式为异步,对方接通电话后,将会收到 Answered 消息 否则,在此之前,都可以调用 HungUp 取消本次呼叫 4.16 TransferCall 4.16.1输入参数输入参数 名称类型描述 destBSTR转移目的地的设备号 dataBSTR随线数据 说明: data 长度不能超过 512 字节 4.16.2返回值返回值 BOOLEAN 类型 表明请求发送是否成功 4.16.3示例或原型示例或原型 Vc+示例： BOOL CDemoAgentDlg:TransferCall(char * dest,char * data) Amany OCX 开发指南 第 21 页 共 41 页 :AmanyTransferCall(LPSTR(LPSTR(LPCSTR(m_szAgentID),m_nCurCallID,dest,data,0); CString msg; msg.Format(“Transfer call to %s ,wait for reponse.“,dest); ShowMSG(LPCSTR(msg); return TRUE; 4.16.4说明说明 需要呼叫转移的时候调用此方法 处理方式为异步,第三方接通电话后,将会收到 Transfered 消息，紧接着还有一个 CallIdle 消 息，表明本地线路处于空闲状态 否则,在此之前,都可以调用 Cancel 取消本次转移 4.17 ConferenceCall 4.17.1输入参数输入参数 名称类型描述 destBSTR转移目的地的设备号 dataBSTR随线数据 说明: data 长度不能超过 512 字节 4.17.2返回值返回值 BOOLEAN 类型 表明请求发送是否成功 4.17.3示例或原型示例或原型 Vc+示例： BOOL CDemoAgentDlg:ConferenceCall(char * dest,char * data) :AmanyConferenceCall(LPSTR(LPSTR(LPCSTR(m_szAgentID),m_nCurCallID,dest,data); CString msg; msg.Format(“Make conference call to %s ,wait for reponse.“,dest); Amany OCX 开发指南 第 22 页 共 41 页 ShowMSG(LPCSTR(msg); return TRUE; 4.17.4说明说明 需要做三方会议的时候调用此方法 处理方式为异步,第三方接通电话后,将会收到 Conferenced 消息，表明本地线路已经进入 3 方会议 否则,在此之前,都可以调用 Cancel 取消本次会议请求 4.18 Cancel 4.18.1输入参数输入参数 无 4.18.2返回值返回值 BOOLEAN 类型 表明请求发送是否成功 4.18.3示例或原型示例或原型 Vc+示例： BOOL CDemoAgentDlg:Cancel() :AmanyCancel(LPSTR(LPSTR(LPCSTR(m_szAgentID),m_nCurCallID,ID_TRANSFERCAL L,0); ShowMSG(“Trying to Cancel last operation“,DEMODLG_MSG_WARNING); return TRUE; 4.18.4说明说明 该操作处理方式为异步 用来取消最近一次调用的 TransferCall 或 ConferenceCall 操作 Amany OCX 开发指南 第 23 页 共 41 页 要使调用生效，调用时机请选择在调用了 TransferCall 或 ConferenceCall，而还没有收到相 应的 Transferred 和 Conferenced 消息之前 4.19 StartMonitor 4.19.1输入参数输入参数 无 4.19.2返回值返回值 BOOLEAN 类型 表明请求发送是否成功 4.19.3示例或原型示例或原型 Vc+示例： BOOL CDemoAgentXDlg:StartMonitor(const char *address) CString laddress = (address = NULL ? “ALL“ : address); m_xAmanyClient.StartMonitor(); ShowMSG(DEMODLG_MSG_WARNING,“Monitor %s Started.“,LPCSTR(laddress); m_ControlTab.PostMessage(WM_REFRESHSTATUS,-1,0); return TRUE; 4.19.4说明说明 用来向班长席提供线路和座席的监控职能 处理方式为异步，成功后将会收到一系列以 M 为前缀的消息 该功能只面向班长席，请限制使用，将涉及较大的网络流量和服务器开销 Amany OCX 开发指南 第 24 页 共 41 页 4.20 StopMonitor 4.20.1输入参数输入参数 无 4.20.2返回值返回值 BOOLEAN 类型 表明请求发送是否成功 4.20.3示例或原型示例或原型 Vc+示例： BOOL CDemoAgentXDlg:StopMonitor(const char *address) m_xAmanyClient.StopMonitor(); CString laddress = (address = NULL ? “ALL“ : address); m_xAmanyClient.StopMonitor(); ShowMSG(DEMODLG_MSG_WARNING,“Monitor %s Stopped.“,LPCSTR(laddress); m_ControlTab.PostMessage(WM_REFRESHSTATUS,-1,0); return TRUE; 4.20.4说明说明 班长席用来停止监控职能 处理方式为异步，成功后将不再收到监控消息 请限制使用 Amany OCX 开发指南 第 25 页 共 41 页 4.21 IsMonitor 4.21.1输入参数输入参数 无 4.21.2返回值返回值 BOOLEAN 类型 如果登陆的是班长席，返回 TRUE 否则返回 FALSE 4.21.3示例或原型示例或原型 Vc+示例： BOOL CAmanyCTIX:IsMonitor() BOOL result; InvokeHelper(0x14, DISPATCH_METHOD, VT_BOOL, (void*) return result; 4.21.4说明说明 用来获取是否是班长席的信息， 为返回有效值，请在座席登陆成功之后使用 处理方式为同步 4.22 KickOut 4.22.1输入参数输入参数 名称类型描述 AgentIDBSTR需要被取消登陆的座席号 Amany OCX 开发指南 第 26 页 共 41 页 4.22.2返回值返回值 BOOLEAN 类型 如果注销成功，返回 TRUE 否则，返回 FALSE 4.22.3示例或原型示例或原型 Vc+示例： BOOL CDemoAgentXDlg:Kickout(LPCSTR agentID) if(m_xAmanyClient.KickOut(agentID) ShowMSG(DEMODLG_MSG_WARNING,“Agent %s was kicked out successfully.“,agentID); else ShowMSG(DEMODLG_MSG_ERROR,“Error occured when trying to kick out %s.“,agentID); return TRUE; 4.22.4说明说明 班长席在必要的时候用来强制注销座席 处理方式同步 仅仅提供给班长席，请限制使用 4.23 Intrude 4.23.1输入参数输入参数 名称类型描述 AgentIDBSTR需要被强插的座席号 4.23.2返回值返回值 BOOLEAN 类型 Amany OCX 开发指南 第 27 页 共 41 页 表明请求发送是否成功 4.23.3示例或原型示例或原型 Vc+示例： BOOL CDemoAgentXDlg:Intrude(LPCSTR agentID) m_xAmanyClient.Intrude(agentID); ShowMSG(DEMODLG_MSG_WARNING,“Trying to Intrude the call of Agent %s“,agentID); return TRUE; 4.23.4说明说明 仅提供给班长席执行强插职能时调用 处理方式为异步,调用成功后,将会收到 InboundCall 消息,接听后将进入 3 方会议状态 4.24 GetLastError 4.24.1输入参数输入参数 无 4.24.2返回值返回值 BSTR 类型 在 VC 下导出得到的是 CString 类型 4.24.3示例或原型示例或原型 Vc+示例： CString CAmanyCTIX:GetLastError() CString result; InvokeHelper(0x18, DISPATCH_METHOD, VT_BSTR, (void*) return result; Amany OCX 开发指南 第 28 页 共 41 页 4.24.4说明说明 该方法用来获取上次操作所发生错误的描述 需要紧接着错误发生之后调用 5事件列表事件列表 共提供了 21 个事件 注意不要在本控件提供的事件中做太长时间的处理 建议将时间转入自己的消息机制后马上将控制权还给本控件 5.1LoggedOut 5.1.1 参数表参数表 无 5.1.2 触发原因触发原因 当 agent 在被班长席强制注销之后，会收到这个消息 Logout 虽然已经做同步处理，但是仍然会收到这个消息 5.1.3 作用作用 客户端可以利用这个消息回收资源，刷新界面 5.2UnknownEvent 5.2.1 参数表参数表 名称类型描述 eventIDlong未处理的消息编号 说明: Amany OCX 开发指南 第 29 页 共 41 页 eventID 具体数值的含义,请参见 PDU.H 中的定义 5.2.2 触发原因触发原因 当控件收到来自服务器的未知或者无关消息时,将触发该消息,通知应用程序 5.2.3 作用作用 一般情况下,控件不关心的消息,应用程序也可以不用理会,所以对应用程序而言该消息可以 忽略 主要在调试服务器的时候使用 5.3AgentStatusCNGed 5.3.1 参数表参数表 名称类型描述 agentStatuslong当前的座席状态 说明: agentStatus 具体值的含义请参照 PDU.H 5.3.2 触发原因触发原因 调用 ChangeAgentStatus 成功后,服务器会向客户端发送该消息确认状态改变 5.3.3 作用作用 应用程序可以利用这个机会刷新状态,进行必要的访问控制 5.4InboundCall 5.4.1 参数表参数表 名称类型描述 currentCallingPartyBSTR当前的主叫号码 Amany OCX 开发指南 第 30 页 共 41 页 currentCalledPartyBSTR当前的被叫号码 originalCallingPartyBSTR原始的主叫号码 originalCalledPartyBSTR原始的被叫号码 applicationDataBSTR随路数据 callTypelong呼叫类型标识 说明: originalCallingParty 在呼叫转移和三方会话中就是第一方的电话号码 同理, originalCalledParty 就是第二方的电话号码 5.4.2 触发原因触发原因 当应用程序登陆的电话号码被拨入时,将会收到该消息 当作为第三方被转移或是会议时,会收到该消息 当班长席调用 Intrude 时,会收到该消息 5.4.3 作用作用 应用程序利用这个机会刷新界面,准备接听或者挂断 5.5Answered 5.5.1 参数表参数表 名称类型描述 operationNumber longCTI 生成的每个呼叫的唯一 ID 号码，可用作业 务流水号 5.5.2 触发原因触发原因 座席调用 AnswerCall 如果成功,将会收到这个消息,表示线路和服务器都已经准备完毕,可以 进行通话 三方会话时,一方结束通话,另外两方都将收到这个消息,表明不同的呼叫 5.5.3 作用作用 应用程序利用此消息可以判断 AnswerCall 的处理结果,并刷新状态 Amany OCX 开发指南 第 31 页 共 41 页 5.6CallIdle 5.6.1 参数表参数表 无 5.6.2 触发原因触发原因 座席登录的电话号码线路空闲时,都会收到这个消息 5.6.3 作用作用 应用程序利用这个机会刷新状态 5.7DialTone 5.7.1 参数表参数表 无 5.7.2 触发原因触发原因 座席登录的电话线路准备拨号时会收到该消息 这通常出现在手动拿起电话的情况下,使用 MakeCall 是不会得到这个消息的 5.7.3 作用作用 应用程序利用这个机会调整状态 Amany OCX 开发指南 第 32 页 共 41 页 5.8Conferenced 5.8.1 参数表参数表 无 5.8.2 触发原因触发原因 成功调用 ConferenceCall 之后,调用此功能的座席将收到这个消息,此时线路和服务器都准 备妥当,三方可以开始通话 5.8.3 作用作用 应用程序利用这个机会做状态刷新 5.9AgentStatus 5.9.1 参数表参数表 名称类型描述 agentNameBSTR修改状态的 Agent 名 agentIDBSTR修改状态的 Agent ID deviceAddressBSTR此 Agent 登陆的电话号码 loginTimeBSTR此 Agent 的首次登陆时间 statusshort此 Agent 的当前状态标识 causeBSTR此 Agent 如果离开，它使用的原因 说明: status 值的具体含义 参见 PDU.H 5.9.2 触发原因触发原因 任何时候 Agent 状态改变，所有在线的 Agent 都能够收到这个消息 ChangeAgentStatus 调用成功后，将收到这个消息 工作忙闲的切换，也有该消息的触发 Amany OCX 开发指南 第 33 页 共 41 页 5.9.3 作用作用 应用程序利用这个机会刷新界面或状态 5.10 TextMessage 5.10.1参数表参数表 名称类型描述 agentIDBSTR发送消息的 AgentID addressBSTR接受消息的电话号码 tmessageBSTR消息内容 说明: tmessage 不会超过 512 个字节 5.10.2触发原因触发原因 当其他 Agent 向本地发送消息时，会收到该消息 当班长席实施监控职能时，会收到该消息 5.10.3作用作用 为应用程序提供座席间的消息互发功能 5.11 Transfered 5.11.1参数表参数表 无 5.11.2触发原因触发原因 TransferCall 的请求服务器处理成功，调用端将收到该消息 Amany OCX 开发指南 第 34 页 共 41 页 5.11.3作用作用 应用程序可以用这个机会，刷新状态 5.12 MInboundCall 5.12.1参数表参数表 名称类型描述 devAddressBSTR产生消息的电话号码 currentCallingPartyBSTR当前的主叫号码 currentCalledPartyBSTR当前的被叫号码 originalCallingPartyBSTR原始的主叫号码 originalCalledPartyBSTR原始的被叫号码 applicationDataBSTR随路数据 callTypelong呼叫类型标识 说明: origin