CCIC2可嵌入电话工具条接口API

1、 CCIC2 工具条接口API说明：目录概述与接口使用环境4呼入流程（可用方法）7外呼流程（可用方法）7doLogin座席登录8doLogout座席退出10doQueueStatus获取队列数据11doPause置忙12doUnpause置闲13doStatus获取座席状态14doChangeBindTel更改绑定电话15cbLogin登录回调16cbLogout退出回调17cbQueueStatus队列信息回调18cbPause置忙回调22cbUnpause置闲回调23cbStatus座席状态监听函数24cbChangeBindTel绑定电话回调26doLink接听27doRefuse拒接2

2、8doPreviewOutCall外呼29doPreviewOutcallCancel外呼取消30cbRefuse拒接回调31cbPreviewOutCall外呼回调32cbPreviewOutcallCancel外呼取消回调33doSpy监听34doUnspy监听挂断35doThreewayOk监听三方36doUnthreeway监听三方挂断37doPickup抢线38doWhisper耳语39doUnwhisper耳语挂断40doBarge强插41doDisconnects强拆42cbSpy监听回调，返回json对象43cbUnspy监听挂断回调，返回json对象44cbThreewayO

3、k监听三方回调，返回json对象45cbUnthreeway监听三方挂断回调，返回json对象46cbPickup抢线回调，返回json对象47cbWhisper耳语回调，返回json对象48cbUnwhisper耳语挂断回调，返回json对象49cbBarge强插回调，返回json对象50cbDisconnects强拆回调，返回json对象51doUnLink挂断52doHold保持53doUnhold保持接回54doTransfer转移55doInvestigation满意度调查56cbUnLink挂断回调57cbHold保持回调58cbUnhold保持接回回调59cbTransfer转移

4、回调60doConsult咨询61doConsultCancel咨询取消62doUnconsult咨询接回63doConsultTransfer咨询转接64doConsultThreeway咨询三方65cbConsult咨询回调66cbConsultCancel咨询取消回调67cbUnconsult咨询接回回调68cbConsultTransfer咨询转接回调69cbConsultThreeway咨询三方回调70cbThisStatus座席状态监听函数71cbQueue进入离开队列回调78cbKickout被踢下线回调80cbBackendLogout被管理员下线回调81cbUnanswer未

5、接来电回调82cbAgenda预约回调83cbBreakLine断线重连84deviceStatusLoginStatus过滤当前状态85概述与接口使用环境概述对应v2.0.1版本，也可以适用于超级热线座席版参考demo：CRMDemo.htmltoolbarIframe.html浏览器需要支持WebSocket或安装falsh插件例：火狐、谷歌支持WebSocket，例：IE 6、7、8、9不支持WebSocket，浏览器必须要安装flash插件bs对接概述需要引入js接口文件，根据开户地址改对应url，(注)引入地址顺序不能改变,页面初始化时，需要加上setServerUrl("

6、");方法 引入页示例<script src="<script src="<script src="<script src="<script src="<script src="<script src="cs对接概述需要引入js接口文件，根据开户地址改对应url， (注)引入地址顺序不能改变cs结构需要用iframe引用，toolbarIframe.html为引入页面例：<iframe name="toolbar" id="toolbar

7、" scrolling='no' frameborder="0" src="toolbarIframe.html?type=cs" ></iframe> toolbarIframe.html示例<script src="<script src="<script src="<script src="<script src="<script src="<script src="呼入流程（可用方法）响铃座席

8、：拒接通话座席：挂断、保持、咨询、转移、满意度调查保持座席：挂断、保持接回咨询（目标响铃）座席：挂断、咨询取消咨询（通话）座席：挂断、咨询接回、咨询转接、咨询三方被转移或咨询（通话）座席：挂断外呼流程（可用方法）外呼响铃座席：外呼取消 外呼响铃（座席接听）座席：外呼取消 外呼通话座席：挂断、保持、咨询、转移、满意度调查外呼保持座席：挂断、保持接回外呼咨询（目标响铃）座席：挂断、咨询取消外呼咨询（通话）座席：挂断、咨询接回、咨询转接、咨询三方被转移或咨询（通话）座席：挂断doLogin座席登录概述座席登录，回调函数cbLogin()参数· enterpriseId String 企业I

9、D· hotLine String 热线号码· cno String 座席号· pwd String 座席密码· bindTel String 绑定电话· bindType String 绑定电话类型1:手机或固话2:分机3:软电话· initStatus String · 登录座席初始状态online : 登录置闲pause : 登录置忙 · sipIp String 软电话IP，软电话登录参数· sipPwd String 软电话密码，软电话登录参数示例var object = ;object.hot

10、Line = "4006006001"o = "2000"object.pwd = "123456"object.bindTel = "01041005555"object.bindType = "1"object.initStatus = "online"object.enterpriseId = "3000000"object.sipIp = "127.0.0.1"object.sipPwd = "8008"ex

11、ecuteAction('doLogin', object);doLogout座席退出概述座席退出，回调函数cbLogout()参数type String 退出电话类型0 : 不退出电话，只退出座席1 : 退出电话同时退出座席 示例var object = ;object.type = "1"executeAction('doLogout', object); doQueueStatus获取队列数据概述获取队列数据，回调函数cbQueueStatus()无参数示例executeAction('cbQueueStatus');

12、doPause置忙概述置忙，回调函数cbPause()参数description String 自定义置忙字符串 示例var object = ;object.description = "自定义"executeAction('doPause', object); doUnpause置闲概述置闲，回调函数cbUnpause()无参数示例executeAction('doUnpause'); doStatus获取座席状态概述获取座席状态，回调函数cbStatus()无参数示例executeAction('doStatus');

13、doChangeBindTel更改绑定电话概述更改绑定电话，现支持在线座席普通电话更改，分机和软电话不可以在线更改，回调函数cbChangeBindTel()参数tel String 绑定电话changeBindTelType String 绑定电话类型示例var object = ;object.tel = "01041005555"object.changeBindTelType = '1'executeAction('doChangeBindTel',object); cbLogin登录回调概述登录回调，返回json对象"ty

14、pe":"response","code":"0","msg":"ok","reqType":"login", "sessionId":"812c16f96fa7f4bf34d75e07de4950bb", "hotline":"4006006001","enterpriseId":"3000000","cno&quo

15、t;:"2002", "cname":"牛勐勐","bindTel":"01041005975","bindType":"1" 参数code String 返回代码0 ：登录成功4 ：座席不在任何一个队列29 ：在线座席数超过并发限制23 ：默认自定义置忙状态配置错误 msg String 返回信息 hotline String 热线号码 enterpriseId String 企业号 cno String 座席工号 cname String 座席姓名 b

16、indTel String 绑定电话 bindType String 绑定电话类型 cbLogout退出回调概述退出回调，返回json对象type":"response","code":"0","msg":"ok","reqType":"logout", "enterpriseId":"3000000","cno":"2002" 参数code String 返回代码0

17、 ：成功 msg String 返回信息 enterpriseId String 企业号 cno String 座席工号 cbQueueStatus队列信息回调概述队列信息回调，返回json对象里面包含座席信息和队列电话信息，返回json对象例：当前座席2004登陆返回信息如下： "type":"response","code":"0","msg":"ok","reqType":"queueStatus","queueStat

18、us": "qid":"30000000001","qname":"咨询队列","memberStatus":"loginStatus":"online","deviceStatus":"idle","cid":"30000002000","cname":"罗尧", "power":1,"bindT

19、el":"8005","duration":68259,"callstaken":0,"loginTime":69509,"loginStatus":"online","deviceStatus":"idle","cid":"30000002002","cname":"牛勐勐", "power":1,"bindTel&

20、quot;:"01041005975","duration":0,"callstaken":0,"loginTime":0,"loginStatus":"offline","deviceStatus":"idle","cid":"30000002004","cname":"希特勒","power":1,"queueEntry&q

21、uot;:"position":1,"joinTime":"2012-11-29 14:05:43","waitTime":5,"priority":0,"customerNumber":"01087125968", "uniqueId":"ccic_dev_11-1354169140.0","overflow":null,"startTime":"2012-11-2

22、9 14:05:40", "cdr_customer_vip":"0","call_status":"ringing","queueParams":"queueTimeout":30,"memberTimeout":25,"max":5,"wrapupTime":30, "strategy":"rrmemory","calls":0,"h

23、oldTime":0,"talkTime":0,"completed":0, "abandoned":0,"serviceLevel":10,"serviceLevelPerf":0.0,"weight":1,"qid":"30000000002","qname":"投诉","memberStatus":"loginStatus":"of

24、fline","deviceStatus":"idle","cid":"30000002001","cname":"奥巴马","power":1,"loginStatus":"online","deviceStatus":"idle","cid":"30000002002","cname":"牛勐勐

25、", "power":1,"bindTel":"01041005975","duration":0,"callstaken":0,"loginTime":0,"loginStatus":"offline","deviceStatus":"idle","cid":"30000002005","cname":"关羽&quo

26、t;,"power":0,"queueEntry":,"queueParams":"queueTimeout":600,"memberTimeout":25,"max":5,"wrapupTime":30, "strategy":"rrmemory","calls":0,"holdTime":0,"talkTime":0,"completed&qu

27、ot;:0,"abandoned":0, "serviceLevel":10,"serviceLevelPerf":0.0,"weight":1 队列基本参数 json· queueStatus array · 座席信息，返回当前座席所属队列 · qid String · 队列ID · qname String · 队列名称 · memberStatus array · 座席详细信息 · queueEntry array &#

28、183; 队列排队电话详信息 · queueParams json · 队列配置 队列配置（queueParams）json· queueTimeout String · 队列超时时长 · memberTimeout String · 队列座席超时时长 · max String · 队列中最大等待座席数 · wrapupTime String · 队列整理时间 · strategy String · 队列排队策略 · calls String · 队列当前

29、等待电话数 · holdTime String · 队列中电话接通平均等待时长 · talkTime String · 队列中电话接通平均通话时长 · completed String · 队列中接通电话数 · abandoned String · 队列中放弃电话数 · serviceLevel String · 队列服务水平描述 · serviceLevelPerf String · 队列服务水平 是百分比的值 · weight String · 队列优

30、先级 座席详细参数（queueStatus）array· loginStatus String · 座席登陆状态 · deviceStatus String · 座席设备状态 · cid String · 座席编号，是当前企业号和座席号一起生成 · cname String · 座席名称 · power String · 座席权限0 ： 普通座席 1 ： 班长席 · bindTel String · 绑定电话 · duration String · 当前状

31、态持续时间 · loginTime String · 登陆总时长 · callstaken String · 登陆后接电话数量 队列电话详细参数（queueEntry）attay· position String · 排队位置 · joinTime String · 进入队列时间 · waitTime String · 等待时间 · priority String · 优先级别 · customerNumber String · 电话号码 · u

32、niqueId String · 通话记录ID · overflow String · 溢出次数，如果第一次呼入，值为null · startTime String · 进入系统时间 · cdr_customer_vip String · 客户级别，供前台显示使用，由后台定义 · call_status String · 当前电话状态，排队时无此参数，响铃时有 cbPause置忙回调概述置忙回调，返回json对象"type":"response","cod

33、e":"0","msg":"ok","reqType":"pause" 参数· code String · 返回代码0 ：成功2 ： 连接已中断11 ： 响铃、通话中置忙错误 · msg String · 返回信息 cbUnpause置闲回调概述置闲回调，返回json对象"type":"response","code":"0","msg":&quo

34、t;ok","reqType":"unpause" 参数· code String · 返回代码0 ：成功2 ： 连接已中断11 ： 响铃、通话中置闲错误 · msg String · 返回信息 cbStatus座席状态监听函数概述座席状态监听函数，用于改变队列座席状态，返回json对象此函数是广播事件，在每次座席空闲、置忙、外呼中、响铃、通话、保持、整理时都会收到座席状态信息需要过滤中文状态，请使用deviceStatus.deviceStatusLoginStatus()函数1、空闲：type&quo

35、t;:"event","name":"status","enterpriseId":"3000000","cno":"2002", "deviceStatus":"idle","loginStatus":"online"2、置忙："type":"event","name":"status",&quo

36、t;enterpriseId":"3000000","cno":"2002","loginStatus":"pause", "deviceStatus":"idle","pauseDescription":"小休"3、响铃："type":"event","name":"status","enterpriseId&quo

37、t;:"3000000","cno":"2002","deviceStatus":"ringing", "loginStatus":"online"4、通话："type":"event","name":"status","enterpriseId":"3000000","cno":"2002", &

38、quot;deviceStatus":"busy","loginStatus":"online","busyDescription":"", "customerNumber":"01087125968","customerNumberType":"1","callType":"1"5、保持："type":"event",&quo

39、t;name":"status","enterpriseId":"3000000","cno":"2002","deviceStatus":"busy", "busyDescription":"busyOnhold","loginStatus":"pause"6、整理："type":"event","name"

40、;:"status","enterpriseId":"3000000","cno":"2002","deviceStatus":"idle", "loginStatus":"pause","pauseDescription":"pauseWrapup","wrapupTime":"30"7、外呼中："type":&qu

41、ot;event","name":"status","enterpriseId":"3000000","cno":"2002", "loginStatus":"pause","deviceStatus":"idle","pauseDescription":"pauseOutCalling"8、离线："type":"ev

42、ent","name":"status","enterpriseId":"3000000","cno":"2002", "loginStatus":"offline","deviceStatus":"idle" 参数· customerAreaCode String · 号码归属地 · customerNumberType String · 电话号

43、码类型1 ： 固话2 ： 手机· callType String · 电话类型1 : 呼入2 : 网上4003 : 点击外呼4 : 预览外呼5 : IVR外呼6 : 直接外呼 · cno String · 座席号 · enterpriseId String · 企业号 · customerNumber String · 电话号码 · deviceStatus String · 设备状态1、idle2、ringing3、busy· loginStatus String · 座席

44、状态1、online2、pause· pauseDescription String · 置忙描述 pauseWrapup 整理 pauseOutCalling 外呼 · 通话描述 String · busyOnhold 保持 cbChangeBindTel绑定电话回调概述绑定电话回调，返回json对象"type":"response","code":"0","msg":"ok","reqType":"ch

45、angeBindTel", "enterpriseId":"3000000","cno":"2002","bindTel":"01041005555" 参数· bindTel String · 绑定电话 · code String · 返回代码0 ：成功2 ：连接中断· msg String · 返回信息 · enterpriseId String · 企业号 · cno St

46、ring · 座席工号 doLink接听概述接听，软电话功能，回调函数无无参数示例· executeAction('doLink'); doRefuse拒接概述拒接，电话响铃时可用，回调函数cbRefuse()无参数示例· executeAction('doRefuse'); doPreviewOutCall外呼概述外呼，回调函数cbPreviewOutCall()参数· tel （必填） String · 电话号码· callType （必填） String · 外呼电话类型1 : 呼入2

47、: 网上4003 : 点击外呼4 : 预览外呼5 : IVR外呼6 : 直接外呼 · taskId String · 预览式外呼任务ID· customerCrmId String · crmId· taskInventoryId String · 预览式外呼详细ID示例var object=;object.tel = "01041005555"object.callType = '3'object.taskId = "1"object.customerCrmId="4

48、56"object.taskInventoryId = "75874"executeAction('doPreviewOutCall', object); var object=;object.tel = "01041005555"object.callType = '3'executeAction('doPreviewOutCall', object); doPreviewOutcallCancel外呼取消概述外呼取消，响铃、座席接听时可用，回调函数cbPreviewOutcallCancel(

49、)无参数示例· executeAction('doPreviewOutcallCancel'); cbRefuse拒接回调概述拒接回调，返回json对象"type":"response","code":"0","msg":"ok","reqType":"refuse" 参数· code String · 返回代码0 ：成功2 ：连接中断9 ：拒接错误· msg String

50、83; 返回信息 cbPreviewOutCall外呼回调概述外呼回调，返回json对象"type":"response","code":"0","msg":"ok","reqType":"previewOutCall" 参数· code String · 返回代码0 ：成功6 ：外呼失败，参数错误13 ：外呼失败，外呼号码格式错误20 ：外呼失败，呼叫范围受限25 ：外呼失败，此号码为黑名单26 ：外呼失败，座席没

51、有外呼权限，请联系管理员27 ：外呼失败，余额不足28 ：外呼失败，没有路由 · msg String · 返回信息 cbPreviewOutcallCancel外呼取消回调概述外呼取消回调，返回json对象"type":"response","code":"0","msg":"ok","reqType":"previewOutcallCancel" 参数· code String · 返回代码0

52、 ：成功5 ：没有正确拿到此座席外呼的channel· msg String · 返回信息 doSpy监听概述监听，目标座席通话时可用，发起方能听见目标座席和客户谈话，发起方说话客户和目标座席听不见，回调函数cbSpy()参数· spyObject String · 监听方座席工号· objectType String · 监听类型，固定值 1· spiedCno String · 目标座席工号示例var object=;object.spyObject = "2001"object.objec

53、tType = '1'object.spiedCno = "2002"executeAction('doSpy', object); doUnspy监听挂断概述监听挂断，监听成功后可用，回调函数cbUnspy()参数· spyObject String · 目标座席工号示例var object=;object.spyObject = "2001"executeAction('doUnspy', object); doThreewayOk监听三方概述监听三方，目标座席通话时可用，发起方将和

54、客户、目标座席一起进入通话，互相可以听说，回调函数cbThreewayOk()参数· threewayedCno String · 目标座席工号· objectType String · 监听类型，固定值 1· threewayedObject String · 发起者座席工号示例var object=;object.threewayedCno = "2001"object.objectType = '1'object.threewayedObject = "2000"execu

55、teAction('doThreewayOk', object); doUnthreeway监听三方挂断概述监听三方挂断，监听三方成功后可用，回调函数cbUnthreeway()参数· threewayedCno String · 目标座席工号示例var object=;object.threewayedCno = "2001"executeAction('doUnthreeway', object); doPickup抢线概述抢线，目标座席响铃时可用，抢线后目标座席和发起方一起响铃，回调函数cbPickup()参数

56、83; pickupCno String · 目标座席工号示例var object=;object.pickupCno = "2001"executeAction('doPickup', object); doWhisper耳语概述耳语，目标座席通话时可用，目标座席能听见发起者说话，客户方听不见，回调函数cbWhisper()参数· whisperedCno String · 目标座席工号· objectType String · 监听类型，固定值 1· whisperObject String &

57、#183; 耳语方座席工号示例var object=;object.whisperedCno = "2001"object.objectType = '1'object.whisperObject = "2000"executeAction('doWhisper', object); doUnwhisper耳语挂断概述耳语挂断，耳语成功后可用，回调函数cbUnwhisper()参数· whisperObject String · 目标座席工号示例var object=;object.whisperObj

58、ect = "2001"executeAction('doUnwhisper', object); doBarge强插概述强插，强行把目标座席挂断，发起方和客户通话，回调函数cbBarge()参数· bargedCno String · 目标座席工号· objectType String · 监听类型，固定值 1· bargeObject String · 强插方座席工号示例var object=;object.bargedCno = "2001"object.objectTyp

59、e = '1'object.bargeObject = "2000"executeAction('doBarge', object); doDisconnects强拆概述强拆，终止目标座席和客户通话，回调函数cbDisconnects()参数· disconnectedCno String · 目标座席工号示例var object=;object.disconnectedCno = "2001"executeAction('doDisconnects', object); cbSpy监听

60、回调，返回json对象概述监听回调，返回json对象"type":"response","code":"0","msg":"ok","reqType":"spy" 参数· code String · 返回代码0 ：成功2 ： 连接已中断5 ： 座席不在通话11 ：状态错误12 ：没有此座席21 : 座席已被监控22 ：班长不能监控正在做监控的其他班长座席 · msg String · 返回信息描述

61、 cbUnspy监听挂断回调，返回json对象概述监听挂断回调，返回json对象"type":"response","code":"0","msg":"ok","reqType":"unspy" 参数· code String · 返回代码0 ：成功2 ： 连接已中断5 ： 座席不在通话12 ：状态错误 · msg String · 返回信息描述 cbThreewayOk监听三方回调，返回json

62、对象概述监听三方回调，返回json对象"type":"response","code":"0","msg":"ok","reqType":"threeway" 参数· code String · 返回代码0 ：成功2 ： 连接已中断5 ： 座席不在通话11 ：状态错误12 ：没有此座席21 : 座席已被监控22 ：班长不能监控正在做监控的其他班长座席 · msg String · 返回信息描述 c

63、bUnthreeway监听三方挂断回调，返回json对象概述监听三方挂断回调，返回json对象"type":"response","code":"0","msg":"ok","reqType":"unthreeway" 参数· code String · 返回代码0 ：成功2 ： 连接已中断5 ： 座席不在通话12 ：状态错误座席 · msg String · 返回信息描述 cbPickup抢线回

64、调，返回json对象概述抢线回调，返回json对象"type":"response","code":"0","msg":"ok","reqType":"pickUp" 参数· code String · 返回代码0 ：成功2 ： 连接已中断8 ： 抢线失败· msg String · 返回信息描述 cbWhisper耳语回调，返回json对象概述耳语回调，返回json对象"type&qu

65、ot;:"response","code":"0","msg":"ok","reqType":"whisper" 参数· code String · 返回代码0 ：成功2 ： 连接已中断5 ： 座席不在通话11 ：状态错误12 ：没有此座席21 : 座席已被监控22 ：班长不能监控正在做监控的其他班长座席 · msg String · 返回信息描述 cbUnwhisper耳语挂断回调，返回json对象概述耳语挂断回调

66、，返回json对象"type":"response","code":"0","msg":"ok","reqType":"unwhisper" 参数· code String · 返回代码0 ：成功2 ： 连接已中断5 ： 座席不在通话12 ：状态错误座席 · msg String · 返回信息描述 cbBarge强插回调，返回json对象概述强插回调，返回json对象"type"

67、;:"response","code":"0","msg":"ok","reqType":"barge" 参数· code String · 返回代码0 ：成功2 ： 连接已中断5 ： 座席不在通话11 ：状态错误12 ：没有此座席21 : 座席已被监控22 ：班长不能监控正在做监控的其他班长座席 · msg String · 返回信息描述 cbDisconnects强拆回调，返回json对象概述强拆回调，返回jso

68、n对象"type":"response","code":"0","msg":"ok","reqType":"disconnect" 参数· code String · 返回代码0 ：成功2 ： 连接已中断5 ： 座席不在通话11 ：状态错误12 ：没有此座席21 : 座席已被监控22 ：班长不能监控正在做监控的其他班长座席 · msg String · 返回信息描述 doUnLink挂断概述挂断，

69、通话时可用，回调函数cbUnLink()无参数示例· executeAction('doUnLink'); ·doHold保持概述保持，通话时可用，回调函数cbHold()无参数示例· executeAction('doHold'); doUnhold保持接回概述保持接回，保持成功后可用，回调函数cbUnhold()无参数示例· executeAction('doUnhold'); doTransfer转移概述转移，通话时可用，转移后座席挂断回调函数cbTransfer()参数· transfer

70、Object String · 转移目标值 · objectType String · 转移类型0 : 普通电话1 : 座席号2 : 分机3 : IVR 需要从IVR接口调出IVR节点 示例var object = ;object.transferObject = "2001"object.objectType = "1"executeAction('doTransfer', object); doInvestigation满意度调查概述满意度调查，通话时可用，点击后座席挂断，客户方会听到满意度调出语音，回调