- 最新动态
- 产品介绍
- 快速入门
-
用户指南
- 云控制台操作指南
-
租户管理员指南
- 认识您的租间
- 配置员工中心
- 启用人工服务
- 配置移动客服
- 配置多媒体渠道
-
机器人管理配置指南
- 快速入门
-
配置智能机器人
- 概述
- 配置一个预约挂号机器人(任务型对话机器人)
- 添加问答型对话机器人
- 其他操作
-
相关参考
- 图元
- 参数
-
TUC接口
- /chatbot/rest/tuc/v1/nlp/detectRegularEntity
- /chatbot/rest/tuc/v1/nlp/identify
- /chatbot/rest/tuc/v1/recommendFaq
- /chatbot/rest/tuc/v1/qualityInspection/qiOnline/recognize
- /chatbot/rest/tuc/v1/nlp/feedback
- /chatbot/rest/tuc/v1/nlp/textClassify
- /chatbot/rest/tuc/v1/nlp/detectEntity
- /chatbot/rest/tuc/v1/qualityInspection
- 内置函数
- 常见问题
- 操作员:配置普通IVR
- 配置预置流程
- IVR Journey分析
- 外呼风险监控
- 管理工单配置
- 质检管理
- 管理通知中心
- 管理客户中心
- 配置智能外呼
- 管理问卷
- 管理智能实训
- 配置知识库
- 配置公共资源
- 业务故障放通管理
- 护航浏览
- 社交媒体运营
- 绩效管理
- 客服座席指南
- 质检员指南
- 价格说明
-
开发指南
- 开发概述
- 用户接入——VOIP音视频接入
- 用户接入——网页版客户端集成 (RESTful)
- 用户接入——网页版轻量级客户端集成 (JS)
- 座席集成——座席轻量级接续块集成(JS)
- 座席集成——座席呼叫处理 (RESTful)
-
座席集成——Openeye H5 软电话接口集成
- 修订记录
- OpenEye H5软电话接口概述
- OpenEye软电话安装指导
- 座席侧集成H5软电话开发指导
- 音频呼叫接口
-
音视频呼叫接口扩展
- 音视频呼叫
-
设备管理
- getMediaDevices(获取设备列表)
- setMicIndex(设置麦克风)
- mediaGetMicIndex(查询当前使用的麦克风)
- setSpeakIndex (设置扬声器)
- mediaGetSpeakIndex (查询当前使用的扬声器)
- setMicVol(设置麦克风音量)
- getMicVol(查询麦克风当前音量)
- setSpkVol(设置扬声器音量)
- getSpkVol(查询扬声器当前音量)
- setVideoWindowParam(设置视频窗口位置和宽高)
- setVideoLayoutMode(设置视频窗口画面排列模式)
- setVideoDisplayMode(设置视频窗口画面裁剪模式)
- openCamera(打开摄像头)
- closeCamera(关闭摄像头)
- 屏幕共享
- 截屏
- 录屏
- 错误码列表
- 运营管理——座席工作台集成第三方Web页面
-
API参考
- 接口概述
- 相关术语
- 修改记录
- 接口鉴权方式
-
呼叫中心配置类
-
座席管理
- 单个创建座席业务账号(agentAccount/create)
- 单个删除指定座席业务账号(agentAccount/delete)
- 单个修改座席业务账号信息(agentAccount/update)
- 查询座席业务账号信息(agentAccount/query)
- 绑定座席和技能队列(addSkillsToAgent)
- 解绑座席某技能队列(releaseAgentBySkillId)
- 通过技能队列ID查询座席信息(queryAgentInfoBySkillId)
- 修改座席软电话号码登录密码(updateSipPhonePassword)
- 查询所有座席的软电话信息 (不包含业务账号) (querySysInfo)
- 查询所有座席的软电话信息 (包含业务账号) (queryAgentInfo)
- 查询账号登录结果 (queryAgentLoginParams)
- 根据登录账号查询座席信息 (queryAgentInfoByAccount)
- 按客户号码清理数据 (cleancustpersonaldata)
- 技能队列管理
- 号码管理
- IVR流程管理
-
座席管理
-
座席工作台
- 座席控制
-
座席双呼
- 创建双呼呼叫 (V1.0.0) (createCall)
- 创建双呼呼叫 (V3.0.0) (createCall)
- 查询呼叫历史记录 (queryCallDetailRecord)
- 查询呼叫状态 (queryCallState)
- 获取录音文件地址 (getRecordingAddress)
- 查询分配的软电话号码 (V1.0.0) (queryPhone)
- 查询分配的软电话号码 (V2.0.0) (queryPhone)
- 获取呼叫目的设备信息 (getCalledInfo)
- 创建语音外呼(V1.0.0)(createVoiceNotification)
- 创建语音外呼(V2.0.0)(createVoiceNotification)
- 查询当前会话客户的最近历史接触记录(queryUserContactLimit)
- 查询通话信息(queryCallInfoByCallId)
- ITA双呼结果通知(statusnotify)
- 回调接口
- 订阅语音识别结果接口
- App个人设置
- 附录
- 电销外呼
- 调查问卷
- 知识库管理
- 机器人管理
-
网页客户端接入
- 接口调用流程
- 第三方请求鉴权 (applyToken)
- 查询排队信息 (queryQueueInfo)
- 主动轮询座席侧发送的信息 (poll)
- 保存客户提交的满意度评价结果 (saveSatisfaction)
- 发送消息 (send)
- 客户发送文件 (uploadFileStream)
- 客户接收文件 (downloadFileStream)
- 根据客户输入联想常用语 (queryPhraseByKeyword)
- 检查当前租间是否支持点击通话 (checkClickToCallSupport)
- 创建点击通话 (createClickToCall)
- 获取点击通话事件 (getClickToCallEvents)
- 释放点击通话 (dropClickToCall)
- 创建匿名通话 (createcall)
- 客户提交留言 (doLeaveMessage)
- 提交客户对机器人满意度评价结果 (feedbacksatisfaction)
- 查询历史消息 (queryHistoryChatMessage)
- 丢弃邮件(chat_dropMail)
- 提供whatsapp发送下行消息(sendWhatsappMessage)
- 查询在线交谈工作台当前交谈的消息(getUserInfoBycallId)
- 查询满意度调查配置(getSatisfactionSurveyMode)
-
质检/监控/统计类
- 实时质检:qualitycontrol
-
智能质检
- 质检评分接口 (scoresetting)
- 句子管理接口 (sentencemanagement)
- 敏感词管理接口 (sensitiveWordManage)
- 话术接口 (conversationspecific)
- 句子、敏感词训练接口 (SemanticKeywordTraining)
- 对话逻辑接口 (conversationflow)
- 对话规则接口 (conversationrules)
- 抢插话规则接口 (interposalrules)
- 静默规则接口 (silencerule)
- 语速规则接口 (speedrule)
- 质检场景管理接口 (scenariomanage)
- 通话质检接口 (qualitycheckmanage)
- 人工抽检任务接口 (regularQualityTask)
- 质检任务接口 (qualitytask)
- 质检任务详情接口 (qualitytaskdetail)
- 质检申诉接口 (qualityitem)
- 第三方录音质检接口 (asrtrans)
-
监控/统计
-
实时数据查询类接口
-
VDN维度实时接口
- 查询指定VDN下的系统接入码信息
- 查询指定VDN下的座席休息情况
- 查询指定VDN下的座席电话号码
- 查询指定VDN下的所有座席信息
- 查询指定VDN下的所有座席的当前状态信息
- 查询指定VDN下的所有座席的静态配置信息
- 查询指定VDN下的IVR详细状态信息
- 查询指定VDN下的IVR流程接入码信息
- 查询指定VDN下的各技能队列相关信息
- 查询指定VDN所有休息原因码
- 查询指定接入码编号的呼叫信息
- 查询指定VDN下的呼叫信息
- 查询指定VDN下的呼叫信息(v2)
- 查询指定VDN下的通话轨迹数据
- 查询指定VDN下的所有座席的静态配置信息(CTI3.6版本不支持)
- 查询指定VDN下的所有座席信息(CTI3.6版本不支持)
- 获取VDN实时监控指标
- 技能队列维度实时接口
- 座席维度实时接口
- 呼叫明细维度实时接口
-
VDN维度实时接口
- 历史数据查询类接口
- 配置数据查询类接口
- 质检关系维护接口
- 外呼任务列表查询接口
- 系统指标查询接口
- 健康检查接口
- 附录
-
实时数据查询类接口
- 录音/话单类
- 语音通知
- OMA接口参考
- Case2.0接口参考
- DataProcess接口参考
- 其他类接口参考
- 常见问题
- 文档下载
- 通用参考
展开导读
链接复制成功!
代码使用示例
以协同点击通话(先多媒体文本后点击通话)接口使用代码示例。
操作步骤
- 请求send接口。
this.$axios({ method: 'post', url: APIfabric域名/apiaccess/ccmessaging/send, headers: { 'Content-Type': 'application/json', 'x-app-key': c.appKey, 'Authorization': fabric.token, 'ccmessaging-token': ccmessaging.token }, data: { 'channel': 'WEB', 'content': 'start', 'controlType': 'CONNECT', 'from': userId, 'mediaType': 'TEXT', 'sourceType': 'CUSTOMER', 'to': channelId } })
根据send接口返回的http status为200,且返回消息体resultCode为0,则成功。
此时座席侧在线交谈工作台已可以看到接入的用户。
- 请求checkClickToCallSupport接口
请求之前,请确保以下两点:
- send接口得到接入成功的返回
- 检查浏览器环境支持WebRTC(请结合WebRTC官方文档查看具体如何检查)
检查示例:
if (!navigator.mediaDevices || !navigator.mediaDevices.getUserMedia) { return Promise.reject(new Error('WebRTC is not supported')) } let cam = false let mic = false let spkr = false return navigator.mediaDevices.enumerateDevices().then((deviceInfos) => { deviceInfos.forEach(function (d) { switch (d.kind) { case 'videoinput': cam = true break case 'audioinput': mic = true break case 'audiooutput': spkr = true break } }) // Chrome supports 'audiooutput', Firefox and Safari do not support. if (navigator.webkitGetUserMedia === undefined) { spkr = true } if (!spkr) { return Promise.reject(new Error('Missing a speaker! Please connect one and reload')) } if (!mic) { return Promise.reject(new Error('Missing a microphone! Please connect one and reload')) } return Promise.resolve(cam) })
- 在上述检查均通过后,可开始调用checkClickToCallSupport接口。
this.$axios({ method: 'get', url: APIfabric域名/apiaccess/ccmessaging/v1/checkClickToCallSupport?channel=WEB, headers: { 'Content-Type': 'application/json', 'x-app-key': appKey, 'Authorization': fabric.token, 'ccmessaging-token': ccmessaging.token } })
- 返回消息体:
{ "resultCode":"0", "resultDesc": "", "webRTCSupported":true, "clickToCallSupported":true }
如httpStatus为200,且resultCode为0,代表请求成功。
webRTCSupported,代表该租间是否支持webRTC;clickToCallSupported代表该渠道是否支持点击通话。
上述两个变量均为true时,可进行下一步,创建点击通话。
- 请求createClickToCall。
须知:
请确保checkClickToCallSupport返回的webRTCSupported和clickToCallSupported为true,才可调用。
请求参数中的mediaAbility为0,为发起语音通话;为1,为发起视频通话。
this.$axios({ method: 'post', url: APIfabric域名/apiaccess/ccmessaging/v1/createClickToCall, headers: { 'Content-Type': 'application/json', 'x-app-key': appKey, 'Authorization': fabric.token, 'ccmessaging-token': ccmessaging.token }, data: { 'channel': 'WEB', 'mediaAbility': '0' } })
返回消息体:
{ "resultCode":"0", "resultDesc": "" }
如httpStatus 为200,且resultCode为0,代表请求成功。
- 长轮询请求getClickToCallEvents。
在createClickToCall调用成功后,开始调用getClickToCallEvents接口。
说明:
- 请设置该请求的超时时间为一个较长值;调用该接口请求,处理较缓慢,经常在10秒以上;如上述请求中设置的值为60秒。
- 该请求为长轮询请求,在请求success后,根据返回事件状态,继续调用该请求。
this.$axios({ method: 'get', url: APIfabric域名/apiaccess/ccmessaging/v1/getClickToCallEvents?channel=WEB, timeout: 60000, headers: { 'Content-Type': 'application/json', 'x-app-key': appKey, 'Authorization': fabric.token, 'ccmessaging-token': ccmessaging.token } })
返回结果如下:
resultCode为非0时,表示请求失败,请设置重试机制:如客户端请求失败,重试3次后,仍然失败则停止请求重试。
resultCode为0,eventId为:
168101:呼叫建立;168102:呼叫排队;168106:呼叫转移;或者轮询时,可能没有事件,eventId是不携带时的情况,客户端需要保持长轮询。
当呼叫建立时,可从content中获取 webRTC必要参数:
domain为WebRTC Gateway域名;gwAddresses为WebRTC Gateway通信地址和端口;clickToCallCaller为主叫,accessCode为被叫
- 呼叫建立
{ resultCode:"0", resultDesc:"Call connected", "eventId": 168101, "content":{ "domain":"xxx" "gwAddresses":["xx1","xx2"] "accessCode": "179080000537636" "clickToCallCaller":"AnonymousCard" } }
- 呼叫排队
{ resultCode:"0" resultDesc:"Call in queue" "eventId": 168102 }
- 呼叫转移
{ resultCode:"0" resultDesc:"Call transfered" "eventId": 168106 }
- 呼叫释放
{ resultCode:"0" resultDesc:"Call disconnected" "eventId": 168110 "content":{ "causeId": -1 "causeDesc": "xxxx" } }
- 呼叫排队超时
{ resultCode:"0" resultDesc:"Call queue timeout" "eventId": 168103 "content":{ "causeId": -1 "causeDesc": "xxxx" } }
- 呼叫失败
{ resultCode:"0" resultDesc:"Call failed" "eventId": 168105 "content":{ "causeId": -1 "causeDesc": "xxxx" } }
- 没有获取到事件
{ resultCode:"0" resultDesc:"ClickToCall polled without any events" }
- 主动挂断时,调用dropClickToCall接口。
this.$axios({ method: 'post', url: APIfabric域名/apiaccess/ccmessaging/v1/dropClickToCall, headers: { 'Content-Type': 'application/json', 'x-app-key': appKey, 'Authorization': fabric.token, 'ccmessaging-token': ccmessaging.token }, data: { 'channel': 'WEB' } })
返回消息体:
如httpStatus为200,且resultCode为0,代表请求成功;
{ "resultCode":"0", "resultDesc": "" }