- 最新动态
- 产品介绍
- 快速入门
-
用户指南
- 云控制台操作指南
-
租户管理员指南
- 认识您的租间
- 配置员工中心
- 启用人工服务
- 配置移动客服
- 配置多媒体渠道
-
机器人管理配置指南
- 快速入门
-
配置智能机器人
- 概述
- 配置一个预约挂号机器人(任务型对话机器人)
- 添加问答型对话机器人
- 其他操作
-
相关参考
- 图元
- 参数
-
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接口参考
- 其他类接口参考
- 常见问题
- 文档下载
- 通用参考
链接复制成功!
生成座席操作详单索引
场景描述
调用该API,则会根据条件生成座席操作详单的索引文件。文件生成后,文件名称(agentOprInfoFileName)会通过回调的方式发送到callBackURL携带的回调地址上。
回调callBackURL需要鉴权,详见C2 监控/系统外呼/话单/知识库类接口鉴权方式。
使用说明
- 前提条件
- 开发者环境已经构建,座席正常签入并进行相关操作,开发者有独立服务器并且已经绑定回调地址(callBackURL)。
- 企业帐号(accountId:租间ID)、座席ID(agentId),可自由组合生成座席操作详单索引文件。如果均没有传入,则生成指定时间段内该appId下相应的数据记录。
- 已通过鉴权(Authorization)、获取接入地址。
- 请检查CC-FS配置文件“/home/ccfsapp/webapps/ccfsapp/WEB-INF/classes/config/servicecloud.base.properties”的“aicc.ssl.trustAll”是否配置为false,请配置为false,然后参考下面步骤放置证书。
- 以运维用户登录CC-FS的服务器,切换到root用户下。
su - root
- 将CC-FS生成索引文件通知回调地址加载的第三方证书上传至AICC的truststore.jks证书的同一目录中,目录为:“$HOME/conf”,具体目录请以实际环境为准。
- 修改上传的第三放证书的属组。
chown ccfsapp:ccfsapp XXX.jks
- 执行下面的命令将第三方证书导入到truststore.jks中。
keytool -import -alias xxx -file XXX.jks -keystore truststore.jks
请依据界面提示输入truststore.jks证书密码。
- 在环境上删除XXX.jks证书。
- 重启CC-FS。
进入“/home/ccfsapp/bin”目录,执行如下命令。
./shutdown.sh;./startup.sh
- 以运维用户登录CC-FS的服务器,切换到root用户下。
- 使用限制
开发者只能访问该帐号下的数据信息,开发者帐号(appId)和企业帐号(accountId)必须对应。
开发者账号包含在认证字符串中,详见C2 监控/系统外呼/话单/知识库类接口鉴权方式。
接口方法
POST
接口URI
https://ip:port/CCFS/resource/ccfs/queryAgentOprInfoData
其中,ip为CC-FS安装的服务器IP地址,port为CC-FS的HTTPS端口号。
如果经过NSLB路由,ip为NSLB的服务器IP地址,port为CC-FS服务在NSLB映射的HTTPS端口号。
请求说明
序号 |
名称 |
参数类型 |
是否必选 |
默认值 |
说明 |
---|---|---|---|---|---|
1 |
Content-Type |
String |
True |
无 |
固定填 application/json; charset=UTF-8。 |
2 |
Authorization |
String |
True |
无 |
生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 |
序号 |
名称 |
参数类型 |
是否必选 |
默认值 |
说明 |
---|---|---|---|---|---|
1 |
version |
String(1-32) |
True |
2.0 |
协议版本。当前固定值为2.0。 |
序号 |
名称 |
参数类型 |
是否必选 |
默认值 |
说明 |
---|---|---|---|---|---|
1 |
beginTime |
String |
True |
无 |
座席相关操作的起始时间,为租间所在时区的时间,起始时间和截止时间需要做范围限制,最大为3天内。格式为:yyyy-MM-dd HH:mm:ss。 |
2 |
endTime |
String |
True |
无 |
座席相关操作的截止时间,为租间所在时区的时间,起始时间和截止时间需要做范围限制,最大为3天内。格式为:yyyy-MM-dd HH:mm:ss。 |
3 |
accountId |
String(1-20) |
False |
无 |
企业帐号(租间ID)。 |
4 |
agentId |
String(1-20) |
False |
无 |
座席ID(座席工号)。 |
5 |
callBackURL |
String |
True |
无 |
回调地址。平台生成数据记录文件后将fileName返回到该地址。 |
响应说明
调用本接口获得响应分为两部分:
(1)调用本接口立即得到响应
该响应消息参数说明详见表4。
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
1 |
resultCode |
String |
请求返回的结果码,
|
2 |
resultDesc |
String |
请求结果描述。 |
3 |
resultData |
Object |
请求响应数据,resultData参数说明详见表6-响应消息resultData参数说明。 |
4 |
response |
Object |
请求结果对象,参数说明详见表6 不推荐使用,为兼容老版本保留字段。 |
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
4.1 |
version |
String(1-32) |
协议版本,如2.0。 |
4.2 |
resultCode |
String(1-32) |
请求返回的结果码,详见错误码参考。 |
4.3 |
resultMsg |
String |
请求结果描述。 |
(2)平台生成数据记录文件后回调第三方的响应。
该响应由request,msgBody两部分组成。msgBody参数说明详见表7-回调返回消息请求Body中msgBody参数说明。
request包含响应版本号version(默认2.0)。
msgBody由responseId(座席操作详单文件名组成部分),fileName(待下载座席操作详单zip名称),accountId(租间ID)组成。
序号 |
名称 |
参数类型 |
说明 |
---|---|---|---|
1 |
responseId |
String |
调用本接口成功后,生成的唯一标识,是文件名称的组成部分。 |
2 |
fileName |
String |
话单和录音索引文件名称。格式:yyyyMMdd_{responseId}.zip。 例如:调用本接口的日期为2018-07-02,获取到的responseId为9239cb50a8384bb0ab503441bf089446,则该参数值为20180702_9239cb50a8384bb0ab503441bf089446.zip。 |
3 |
accountId |
String |
企业帐号(租间ID),请求参数中带的企业账号,用来将文件名和企业进行关联,如果请求参数中未填accountId,则不会返回该值。 |
若回调没有成功(ccfs没有收到回调地址的成功响应,或没有响应体),ccfs会重试,间隔10分钟重试一次,直到成功或者超过重试次数。
报文样例
- 请求头
POST /CCFS/resource/ccfs/queryAgentOprInfoData HTTP/1.1 Authorization: auth-v2/ak/2018-07-02T02:42:49Z/content-length;content-type;host /7a8fb9d620e******************5c5df0cce3c6a253 Accept: */* Host: 10.154.198.164 Content-Type: application/json;charset=UTF-8 Content-Length: 297
- 请求参数
{ "request": { "version": "2.0" }, "msgBody": { "beginTime": "2018-06-29 10:42:49", "endTime": "2018-07-02 10:42:49", "accountId": "", "agentId": "", "callBackURL": "https://10.57.118.171:8000" } }
- 响应头
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Date: Mon, 02 Jul 2018 02:43:03 GMT
- 响应参数
{ "response": { "version": "2.0", "resultCode": "0", "resultMsg": "success" }, "resultData": { "responseId": "9239cb50a8384bb0ab503441bf089446" }, "resultCode": "0", "resultDesc": "success" }
- 呼叫中心向回调地址返回的消息示例
POST / HTTP/1.1 Accept: */* Content-Type: application/json;charset=UTF-8 Authorization: auth-v2/ak/2018-07-02T02:43:03Z/content-length;content-type;host /c5bd683******************ef5747bd572c28 Host: 10.57.118.171 Content-Length: 208
消息参数
{ "request": { "version": "2.0" }, "msgBody": { "responseId": "9239cb50a8384bb0ab503441bf089446", "agentOprInfoFileName": "20180702_9239cb50a8384bb0ab503441bf089446.zip" } }