CCOD集成培訓(xùn)文檔

AgentDeskTop開發(fā)手冊(cè)培訓(xùn)盧楊

2008年7月1企業(yè)用戶產(chǎn)品線本文檔使用對(duì)象本說明手冊(cè)針對(duì)USE3.9AgentDeskktop中間件開發(fā)編寫。主要面向第三方坐席桌面應(yīng)用集成開發(fā)的軟件工程師使用。本說明手冊(cè)主要針對(duì)相關(guān)坐席應(yīng)用場(chǎng)景、相關(guān)樣例以及提供的開發(fā)接口說明。相關(guān)接口包括Http集成接口、Script集成接口和事件通知接口。

2企業(yè)用戶產(chǎn)品線概述01、Agentdesktop總體運(yùn)行環(huán)境簡(jiǎn)介02、Agentdesktop總體架構(gòu)介紹03、Agentdesktop接口簡(jiǎn)介04、Agentdesktop集成方式05、C/S及B/S架構(gòu)原理總綱3企業(yè)用戶產(chǎn)品線開發(fā)、測(cè)試環(huán)境簡(jiǎn)介Agentdesktop是基于CCOD第三方用戶而開發(fā)的客戶端桌面開發(fā)接口工具。具體運(yùn)行環(huán)境如下描述。MicrosoftWindows2003SP2MicrosoftWindowsXPSP2；無論什么版本操作系統(tǒng)（Windows）均需要部署IIS（InternetInformationServer）服務(wù)。Microsoft.NETFrameWork2.0或以上；MicrosoftInternetExplorer6.0或以上；HttpPort8008（HttpServer缺?。?。Agentdesktop應(yīng)用軟件包4企業(yè)用戶產(chǎn)品線簽入：用戶輸入坐席ID，口令，通過用戶身份校驗(yàn)后進(jìn)入到AgentDesktop系統(tǒng)；登錄：根據(jù)簽入輸入的坐席ID，配置的企業(yè)信息，以及簽入過程中獲取的技能組信息登錄到后臺(tái)呼叫中心平臺(tái)中；登出：從呼叫中心平臺(tái)退出；簽入和登錄之間的關(guān)系描述。簽入為啟動(dòng)AgentDeskTop讀取配置文件獲取企業(yè)消息，等待用戶登錄軟電話系統(tǒng)；登錄為坐席端整體通過Agentdesktop登錄“軟”電話系統(tǒng)，該操作執(zhí)行完成后，坐席端“軟”電話可以正確使用。名詞和縮寫5企業(yè)用戶產(chǎn)品線AgentDeskTop的開發(fā)工具為MicrosoftVisualC#，該組件組成如下所示。01、StartUp.exe----自動(dòng)升級(jí)功能02、AgentDeskTop.exe----框架功能03、SoftPhone.dll----軟電話功能04、WebContainer.dll----Web容器功能05、HttpServer.dllHttp----服務(wù)功能部件組成及功能簡(jiǎn)介6企業(yè)用戶產(chǎn)品線AgentDesktop是呼叫中心坐席應(yīng)用框架，定義了基于HTTP協(xié)議的接口，用以完成和第三方應(yīng)用程序信息交互。集成開發(fā)者需要為AgentDesktop內(nèi)嵌的本地HttpServer配置監(jiān)聽端口，缺省為（8008）。通過HTTP請(qǐng)求和響應(yīng)消息實(shí)現(xiàn)AgentDesktop與第三方應(yīng)用程序的通信，完成坐席狀態(tài)改變、呼叫控制以及坐席狀態(tài)查詢等功能。除上述方法調(diào)用接口外，AgentDesktop還提供了事件通知接口，將坐席的狀態(tài)變遷和呼叫相關(guān)事件傳播給第三方應(yīng)用。為適應(yīng)不同的應(yīng)用集成環(huán)境，AgentDesktop事件接口有兩種形式。（1）、基于Windows窗口消息的事件通知接口（C/S）；（2）、基于注冊(cè)HTTP回調(diào)URL的事件通知接口（C/S和B/S）。第三方用戶可以選擇其中之一，使用消息回調(diào)（URL消息傳遞機(jī)制）機(jī)制實(shí)現(xiàn)接收AgentDesktop的事件處理邏輯。開發(fā)接口簡(jiǎn)介7企業(yè)用戶產(chǎn)品線概述01、Agentdesktop總體運(yùn)行環(huán)境簡(jiǎn)介02、Agentdesktop總體架構(gòu)介紹03、Agentdesktop接口簡(jiǎn)介04、Agentdesktop集成方式05、C/S及B/S架構(gòu)原理總綱8企業(yè)用戶產(chǎn)品線Agentdesktop的組成Agentdesktop由自動(dòng)升級(jí)程序包和應(yīng)用程序包兩部分組成。其中，StartUp.exe為自動(dòng)升級(jí)程序，其功能主要是支持命令行參數(shù)啟動(dòng)；以下為應(yīng)用程序包AgentDeskTop.exe：執(zhí)行框架功能；SoftPhone.dll：軟電話功能；WebContainer.dll：是Web容器功能；HttpServer.dll：Http服務(wù)功能；RecordServices.dll：錄音服務(wù)組件(文件、索引)。9企業(yè)用戶產(chǎn)品線Agentdesktop部署行為10企業(yè)用戶產(chǎn)品線組件和WS服務(wù)部署圖11企業(yè)用戶產(chǎn)品線組件和WS服務(wù)部署圖12企業(yè)用戶產(chǎn)品線網(wǎng)絡(luò)拓?fù)浣Y(jié)構(gòu)及數(shù)據(jù)走向13企業(yè)用戶產(chǎn)品線Agentdesktop基本框架結(jié)構(gòu)14企業(yè)用戶產(chǎn)品線概述01、Agentdesktop總體運(yùn)行環(huán)境簡(jiǎn)介02、Agentdesktop總體架構(gòu)介紹03、Agentdesktop接口簡(jiǎn)介04、Agentdesktop集成方式05、C/S及B/S架構(gòu)原理總綱15企業(yè)用戶產(chǎn)品線集成方式及提供接口功能介紹Agentdesktop提供接口功能描述（HTTP接口集成）登錄接口實(shí)現(xiàn)AgentDesktop登錄到呼叫中心平臺(tái)系統(tǒng)。退出接口實(shí)現(xiàn)AgentDesktop從后臺(tái)呼叫中心平臺(tái)簽出。置閑接口設(shè)置AgentDesktop當(dāng)前狀態(tài)到就緒狀態(tài)。針對(duì)該接口操作后，坐席端可以接受呼叫中心平臺(tái)分配的呼叫。

16企業(yè)用戶產(chǎn)品線置忙接口設(shè)置AgentDesktop當(dāng)前狀態(tài)到“忙”狀態(tài)。此操作后，呼叫中心系統(tǒng)不再為該坐席分配呼叫。該操作和“置閑”互為逆操作。系統(tǒng)登錄后默認(rèn)“置忙狀態(tài)”，坐席員需要手工將其修改成“置閑”狀態(tài)。普通坐席在“置忙”狀態(tài)下可以執(zhí)行外呼、內(nèi)呼、轉(zhuǎn)IVR、重置和退出等操作；班長(zhǎng)坐席在“置忙”狀態(tài)下除可執(zhí)行普通坐席同等狀態(tài)下的所有操作之外還可以執(zhí)行監(jiān)聽操作。集成方式及提供接口功能介紹17企業(yè)用戶產(chǎn)品線掛斷接口AgentDesktop在當(dāng)前通話狀態(tài)時(shí)完成掛斷動(dòng)作，即切斷話路操作。咨詢接口當(dāng)坐席與用戶通話時(shí)，對(duì)另一指定目標(biāo)發(fā)起咨詢，并指定咨詢呼叫的類型和咨詢時(shí)使用的主叫號(hào)碼※※功能限制（僅僅提供坐席號(hào)和被叫號(hào)碼）；轉(zhuǎn)移接口咨詢呼叫建立后，完成用戶和咨詢方的通話功能；會(huì)議接口建立會(huì)議操作。該操作置于咨詢之后。該功能主要用于三方會(huì)議功能；集成方式及提供接口功能介紹18企業(yè)用戶產(chǎn)品線呼叫接口該接口提供通過坐席端向外發(fā)起呼叫的功能。監(jiān)聽接口該接口實(shí)現(xiàn)對(duì)指定號(hào)碼（工號(hào)）的話路監(jiān)聽功能。應(yīng)用場(chǎng)景班長(zhǎng)席可以在“置忙”的工作狀態(tài)下，使用監(jiān)聽功能，通過該功能插入到正在通話的坐席的話路中；插入成功后，班長(zhǎng)席為監(jiān)聽狀態(tài)。此時(shí)，普通坐席和客戶聽不到班長(zhǎng)席的聲音，但班長(zhǎng)席可以聽到客戶和普通坐席的聲音；集成方式及提供接口功能介紹19企業(yè)用戶產(chǎn)品線強(qiáng)插接口該接口實(shí)現(xiàn)某一坐席（諸如管理級(jí)別較高的）針對(duì)另一指定號(hào)碼（工號(hào)）強(qiáng)行實(shí)行通話功能。應(yīng)用場(chǎng)景班長(zhǎng)可以對(duì)指定號(hào)碼(工號(hào))的強(qiáng)插；班長(zhǎng)席在“監(jiān)聽”的工作狀態(tài)下可以使用強(qiáng)插功能插入到正在被監(jiān)聽的坐席的話路中。插入成功后，班長(zhǎng)、坐席和客戶形成三方通話。集成方式及提供接口功能介紹20企業(yè)用戶產(chǎn)品線強(qiáng)拆接口實(shí)現(xiàn)對(duì)指定坐席號(hào)碼（工號(hào)）的話路強(qiáng)拆。應(yīng)用場(chǎng)景班長(zhǎng)席在監(jiān)聽狀態(tài)下可以執(zhí)行強(qiáng)拆話路的操作。強(qiáng)拆成功后，客戶、普通坐席以及班長(zhǎng)的話路均被強(qiáng)制拆除。集成方式及提供接口功能介紹21企業(yè)用戶產(chǎn)品線保持接口實(shí)現(xiàn)對(duì)當(dāng)前話路的通話狀態(tài)保持，此時(shí)客戶聽等待音。應(yīng)用場(chǎng)景當(dāng)客戶在交流過程中提出坐席無法解答或者不在權(quán)限范圍內(nèi)的要求時(shí)，坐席員執(zhí)行保持操作，在執(zhí)行咨詢操作前坐席員將客戶話路保持已接入呼叫中心系統(tǒng)狀態(tài)，即客戶可以通過IVR功能收聽播放音。集成方式及提供接口功能介紹22企業(yè)用戶產(chǎn)品線接回接口接回當(dāng)前被保持的話路。應(yīng)用場(chǎng)景為客戶提供保持操作結(jié)束后，坐席員通過該接口功能將客戶話路接回坐席端。重置接口重置當(dāng)前坐席狀態(tài)（該接口提供為坐席端的物理狀態(tài)重新定位功能）。重置后，坐席與服務(wù)器重新建立連接，恢復(fù)為“置忙”狀態(tài)。應(yīng)用場(chǎng)景由于坐席端系統(tǒng)網(wǎng)絡(luò)丟包后造成來電無法激活應(yīng)用系統(tǒng)的情況下，坐席員可以通過該接口將坐席端與呼叫中心系統(tǒng)進(jìn)行同步。同步結(jié)束后，坐席端恢復(fù)為“置忙”狀態(tài)。集成方式及提供接口功能介紹23企業(yè)用戶產(chǎn)品線狀態(tài)查詢接口（不公開）通過調(diào)用該接口可以返回當(dāng)前坐席狀態(tài)。數(shù)據(jù)查詢接口（不公開）通過調(diào)用該接口呼叫中心系統(tǒng)為用戶提供指定坐席的當(dāng)前狀態(tài)下的相關(guān)信息（通話時(shí)長(zhǎng)、置閑時(shí)長(zhǎng)、置忙時(shí)長(zhǎng)和事后整理時(shí)間）。集成方式及提供接口功能介紹24企業(yè)用戶產(chǎn)品線轉(zhuǎn)IVR接口實(shí)現(xiàn)坐席與用戶雙方通話后，通過調(diào)用該接口，呼叫中心系統(tǒng)實(shí)現(xiàn)將用戶與坐席通話話路轉(zhuǎn)成用戶與IVR的操作。應(yīng)用場(chǎng)景用戶撥通坐席進(jìn)行通話過程中，根據(jù)業(yè)務(wù)的實(shí)際流程需要用戶通過IVR交互機(jī)制完成相關(guān)的數(shù)據(jù)驗(yàn)證時(shí)，坐席人員通過該接口提供的功能將用戶話路轉(zhuǎn)接到呼叫中心系統(tǒng)實(shí)現(xiàn)IVR交互操作。集成方式及提供接口功能介紹25企業(yè)用戶產(chǎn)品線Agentdesktop提供事件通知接口基于Windows窗口的事件通知接口（C/S）AgentDesktop發(fā)生事件時(shí)通知C/S客戶應(yīng)用系統(tǒng)，整體實(shí)現(xiàn)過程是通過客戶端C/S客戶系統(tǒng)通過覆蓋方式重寫WindowsForm的WndProc處理過程。即通過“剪貼板”機(jī)制實(shí)現(xiàn)信息的交互（可以理解為窗體調(diào)用）。AgentDesktop發(fā)送端消息為WM_COPYDATA/0x004A（句柄實(shí)例，該句柄為系統(tǒng)動(dòng)態(tài)分配）。當(dāng)坐席狀態(tài)變化時(shí)，AgentDesktop通過向指定的窗口發(fā)送特定消息的方式通知第三方應(yīng)用，并通過窗體發(fā)送相關(guān)的消息數(shù)據(jù)。被集成的客戶C/S應(yīng)用可以通過消息響應(yīng)方法收取通知消息。26企業(yè)用戶產(chǎn)品線配置方式

AgentDeskTop發(fā)生事件時(shí)通知C/S客戶應(yīng)用，通知方式，消息通知，客戶端C/S客戶應(yīng)用通過覆蓋方式重寫WindowsForm的WndProc處理過程。AgentDeskTop中配置對(duì)應(yīng)的C/S的窗口標(biāo)題。在圖1-1的界面上選中“HttpServer”,勾選上“啟用通知機(jī)制”，填寫用戶窗體。Agentdesktop提供事件通知接口27企業(yè)用戶產(chǎn)品線概述01、Agentdesktop總體運(yùn)行環(huán)境簡(jiǎn)介02、Agentdesktop總體架構(gòu)介紹03、Agentdesktop接口簡(jiǎn)介04、接口開發(fā)說明05、C/S及B/S架構(gòu)原理總綱28企業(yè)用戶產(chǎn)品線登錄接口接口：Http://IP:Port/Agent/Login說明：實(shí)現(xiàn)AgentDesktop登錄到后臺(tái)呼叫中心平臺(tái)系統(tǒng)功能；IP:HttpServer使用的IP地址（一般為本機(jī)地址，諸如）；Port：HttpServer使用的端口；Agent：座席操作分支；Login：操作命令，使用已經(jīng)簽入AgentDesktop系統(tǒng)的用戶信息登錄到后臺(tái)呼叫中心平臺(tái)中（即坐席端消息）；返回結(jié)果：<ResultCode="返回值"Msg="信息說明"/>返回值說明：0:成功其他：失敗接口調(diào)用方法（接口說明）29企業(yè)用戶產(chǎn)品線退出接口接口：Http://IP:Port/Agent/Logout說明：實(shí)現(xiàn)AgentDesktop從后臺(tái)呼叫中心平臺(tái)簽出。IP:HttpServer使用的IP地址（一般為本機(jī)地址，諸如）；Port：HttpServer使用的端口；Agent：坐席操作分支；Logout：操作命令，將已經(jīng)登錄后臺(tái)呼叫中心平臺(tái)的用戶退出后臺(tái)呼叫中心平臺(tái)，使坐席處于待簽入狀態(tài)。返回結(jié)果：<ResultCode="返回值"Msg="信息說明"/>返回值說明：0:成功其他：失敗接口調(diào)用方法（接口說明）30企業(yè)用戶產(chǎn)品線置閑接口接口：Http://IP:Port/State/Ready說明：設(shè)置AgentDesktop當(dāng)前狀態(tài)到就緒狀態(tài)；坐席可以接受呼叫中心服務(wù)分配的呼叫。IP:HttpServer使用的IP地址；Port：HttpServer使用的端口；State：狀態(tài)操作分支；Ready：操作命令，置閑；返回結(jié)果：<ResultCode="返回值"Msg="信息說明"/>返回值：0:成功其他：失敗接口調(diào)用方法（接口說明）31企業(yè)用戶產(chǎn)品線置忙接口接口：Http://IP:Port/State/NotReady?Reson=XXXXXX（擴(kuò)展參數(shù)）說明：設(shè)置AgentDesktop當(dāng)前狀態(tài)為“忙”狀態(tài)；IP:HttpServer使用的IP地址；Port：HttpServer使用的端口；State：狀態(tài)操作分支；NotReady：操作命令,置忙；Reson=XXXXXX：置忙原因(未實(shí)現(xiàn))；返回結(jié)果：<ResultCode="返回值"Msg="信息說明"/>返回值：0:成功其他：失敗接口調(diào)用方法（接口說明）32企業(yè)用戶產(chǎn)品線應(yīng)答接口接口：Http://IP:Port/CallControl/Answer說明當(dāng)坐席電話振鈴時(shí)，坐席向Agentdesktop發(fā)起請(qǐng)求，應(yīng)答呼叫。IP:HttpServer使用的IP地址；Port：HttpServer使用的端口；CallControl：呼叫控制操作分支；Answer：操作命令,應(yīng)答；返回結(jié)果：<ResultCode="返回值"Msg="信息說明"/>返回值：0:成功其他：失敗接口調(diào)用方法（接口說明）33企業(yè)用戶產(chǎn)品線掛斷接口接口：Http://IP:Port/CallControl/Hangup說明坐席向AgentDesktop發(fā)出申請(qǐng)，將在當(dāng)前通話執(zhí)行掛斷操作；IP:HttpServer使用的IP地址；Port：HttpServer使用的端口；CallControl：呼叫控制操作分支；Hangup：操作命令,掛斷；返回結(jié)果：<ResultCode="返回值"Msg="信息說明"/>返回值：0:成功其他：失敗接口調(diào)用方法（接口說明）34企業(yè)用戶產(chǎn)品線咨詢接口接口Http://IP:Port/CallControl/Consult?TargetDN=XXXXXX&ConsultType=XXXXXX說明當(dāng)坐席與一方通話時(shí)，對(duì)指定目標(biāo)發(fā)起咨詢，并指定咨詢呼叫的類型和咨詢時(shí)使用的統(tǒng)一主叫號(hào)碼；IP:HttpServer使用的IP地址；Port：HttpServer使用的端口；CallControl：呼叫控制操作分支；Consult：操作命令,對(duì)指定號(hào)碼進(jìn)行咨詢；TargetDN=XXXXXX:目標(biāo)號(hào)碼；ConsultType=XXXXXX:咨詢類型；接口調(diào)用方法（接口說明）35企業(yè)用戶產(chǎn)品線接口調(diào)用方法（接口說明）ConsultType說明編碼類型說明備注0呼叫中心ConsultType_DestOther非座席：TargetDN對(duì)應(yīng)參數(shù)輸入電話號(hào)碼1呼叫中心ConsultType_DestAgent座席：TargetDN對(duì)應(yīng)參數(shù)輸入AgentID返回結(jié)果：<ResultCode="返回值"Msg="信息說明"/>返回值：0:成功其他：失敗36企業(yè)用戶產(chǎn)品線轉(zhuǎn)移接口接口：Http://IP:Port/CallControl/Transfer說明咨詢呼叫建立后，完成呼叫轉(zhuǎn)移操作；IP:HttpServer使用的IP地址；Port：HttpServer使用的端口；CallControl：呼叫控制操作分支；Transfer：操作命令,轉(zhuǎn)移；返回結(jié)果：<ResultCode="返回值"Msg="信息說明"/>返回值：0:成功其他：失敗接口調(diào)用方法（接口說明）37企業(yè)用戶產(chǎn)品線會(huì)議接口接口：Http://IP:Port/CallControl/Conference說明：咨詢呼叫建立后，完成會(huì)議操作；IP:HttpServer使用的IP地址；Port：HttpServer使用的端口；CallControl：呼叫控制操作分支；Conference：操作命令,會(huì)議；返回結(jié)果：<ResultCode="返回值"Msg="信息說明"/>返回值：0:成功其他：失敗接口調(diào)用方法（接口說明）38企業(yè)用戶產(chǎn)品線呼叫接口接口：Http://IP:Port/CallControl/MakCall?TargetDN=XXXXXX&MakeCallType=XXXXXX&ShowANI=XXXXXX說明發(fā)起呼叫；IP:HttpServer使用的IP地址；Port：HttpServer使用的端口；CallControl：呼叫控制操作分支；MakCall：操作命令,對(duì)指定號(hào)碼進(jìn)行外呼；TargetDN=XXXXXX:目標(biāo)號(hào)碼；MakeCallType=XXXXXX：呼叫類型；接口調(diào)用方法（接口說明）39企業(yè)用戶產(chǎn)品線接口調(diào)用方法（接口說明）MakeCallType說明編碼類型說明備注0呼叫中心CallType_Service服務(wù)端發(fā)起呼叫，目前分為外呼，內(nèi)呼1呼叫中心CallType_Terminal客戶端發(fā)起呼叫，目前不支持這樣做2呼叫中心CallType_OutBound外呼：TargetDN對(duì)應(yīng)參數(shù)輸入電話號(hào)碼3呼叫中心CallType_InBound內(nèi)呼：TargetDN對(duì)應(yīng)參數(shù)輸入AgentID4呼叫中心CallType_RouterToIVR轉(zhuǎn)IVR參數(shù)是KEY：VALUEMakeCall返回結(jié)果：<ResultCode="返回值"Msg="信息說明"/>返回值：0:成功其他：失敗40企業(yè)用戶產(chǎn)品線監(jiān)聽接口接口：Http://IP:Port/CallControl/SilentMonitor?AgentID=XXXXXX說明實(shí)現(xiàn)對(duì)指定號(hào)碼（工號(hào)）的監(jiān)聽；班長(zhǎng)席可以在“置忙”的工作狀態(tài)下使用監(jiān)聽的高級(jí)功能插入到正在雙方通話的坐席的話路中；插入成功后，班長(zhǎng)席為監(jiān)聽通話狀態(tài)。普通坐席軟電話上仍然顯示雙方通話狀態(tài)（內(nèi)部邏輯為被監(jiān)聽通話狀態(tài)）。此時(shí)，普通坐席和客戶聽不到班長(zhǎng)席的聲音，但班長(zhǎng)席可以聽到客戶和普通坐席的聲音。接口調(diào)用方法（接口說明）41企業(yè)用戶產(chǎn)品線IP:HttpServer使用的IP地址；Port：HttpServer使用的端口；CallControl：呼叫控制操作分支；SilentMonitor：操作命令,對(duì)指定號(hào)碼進(jìn)行監(jiān)聽；AgentID=XXXXXX:坐席工號(hào)；返回結(jié)果：<ResultCode="返回值"Msg="信息說明"/>描述：0:成功其他：失敗接口調(diào)用方法（接口說明）42企業(yè)用戶產(chǎn)品線強(qiáng)插接口接口：Http://IP:Port/CallControl/Intrude?AgentID=XXXXXX說明：班長(zhǎng)可以對(duì)指定號(hào)碼（工號(hào)）的強(qiáng)插；班長(zhǎng)席在“監(jiān)聽”的工作狀態(tài)下可以使用強(qiáng)插的高級(jí)功能插入到正在被監(jiān)聽的坐席的話路中；插入成功后，班長(zhǎng)席為強(qiáng)插通話狀態(tài)，普通坐席為被強(qiáng)插狀態(tài)。此時(shí)，客戶、普通坐席和班長(zhǎng)席三方均可以正常通話。IP:HttpServer使用的IP地址；Port：HttpServer使用的端口；CallControl：呼叫控制操作分支；Intrude：操作命令,對(duì)指定工號(hào)進(jìn)行強(qiáng)插；AgentID=XXXXXX:坐席工號(hào)；接口調(diào)用方法（接口說明）43企業(yè)用戶產(chǎn)品線返回結(jié)果：<ResultCode="返回值"Msg="信息說明"/>返回值：0:成功其他：失敗接口調(diào)用方法（接口說明）44企業(yè)用戶產(chǎn)品線強(qiáng)拆接口接口：Http://IP:Port/CallControl/DropAll?AgentID=XXXXXX說明：實(shí)現(xiàn)對(duì)指定號(hào)碼（工號(hào)