- 最新动态
- 产品介绍
- 快速入门
-
用户指南
- 云控制台操作指南
-
租户管理员指南
- 认识您的租间
- 配置员工中心
- 启用人工服务
- 配置移动客服
- 配置多媒体渠道
-
机器人管理配置指南
- 快速入门
-
配置智能机器人
- 概述
- 配置一个预约挂号机器人(任务型对话机器人)
- 添加问答型对话机器人
- 其他操作
-
相关参考
- 图元
- 参数
-
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接口参考
- 其他类接口参考
- 常见问题
- 文档下载
- 通用参考
链接复制成功!
主动轮询座席侧发送的信息 (poll)
场景描述
主动轮询座席侧发送给用户侧的消息。
如果使用该接口未查到消息,请确认是否使用了send接口建立连接(connect)。
在会话期间,如果不调用这个接口,超过会话默认时间(CCUCS后台配置的),会话会被自动释放掉。
接口方法
GET
接口URI
https://域名/apiaccess/ccmessaging/poll,例如域名是service.besclouds.com
请求说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
receiverId |
string |
True |
接收者Id,即applyToken里面的userId。 |
2 |
channel |
string |
True |
接收者渠道类型,缺省值为WEB,且必须为WEB。 |
3 |
isNeedRead |
string |
False |
是否需要READ座席已读用户消息的提示消息,true为需要,其余或者为空不需要该消息 |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
ccmessaging-token |
string |
True |
|
2 |
x-app-key |
string |
True |
appKey字段,用户标识,在API Fabric上配置 |
3 |
Authorization |
string |
True |
鉴权字段,内容格式为:Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) |
响应说明
- 响应状态码: 200
表3 pollRsp参数结构 序号
名称
参数类型
说明
1.1
resultDesc
string
返回结果描述
成功时返回“query user messages success”,失败时无返回。
1.2
downlinkMessages
发送给用户的消息数组
1.3
resultCode
string
客户端接收消息结果码,0表示成功,非0表示失败
表4 downLIinkMsgArr参数结构 序号
名称
参数类型
说明
1.1
channel
string
消息渠道类型,当前固定为WEB,表示WEB渠道接入。
1.2
content
string
发送给客户下行消息内容,最多500个字符。
根据mediaType不同,content有不同的格式。
如果是多媒体库文件,为多媒体库文件ID;
如果是本地文件,为obskey。
1.3
from
string
消息发送方的id,一般为AICC侧渠道的“配置ID”。
1.4
mediaType
string
消息媒体类型,如文本类型(TEXT)、图片(IMAGE)、视频(VIDEO)、语音(AUDIO)、位置(LOCATE)、文档(DOCUMENT)
1.5
senderNickname
string
座席侧或机器人开启时配置的昵称。如果是系统消息,则返回“系统”(中文租间)或“system”(英文租间)。
1.6
sourceType
string
消息发送方来源,如人工座席(AGENT)、机器人(ROBOT)、系统(SYSTEM)
1.7
timestamp
string
消息发送时间戳
1.8
to
string
消息接收方id,通常为企业侧客户端发送的userId。
1.9
simQuestions
string
相似问内容
1.10
isOfflineStatus
boolean
用于客户端判断下一步是否可以发送消息。
1.11
messageCode
string
消息唯一编码,用来识别撤销或删除动作操作的消息
1.12
interIdx
string
交互次数,直接取上一次ODFS返回的inter_idx值即可
1.13
contentType
string
如果是多媒体库文件,返回值为null;
如果是本地文件,为"1"。
1.14
mediaFileType
string
多媒体文件类型。支持jpg,png,bpm,mp3,aac,mp4,txt,csv,richtext,doc,docx,pdf,zip。
1.15
controlType
string
如聊天(CHAT),断开连接(DISCONNECT),READ(已读)
- 响应状态码: 400
错误的请求:请检查请求路径及参数。
- 响应状态码: 401
未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。
- 响应状态码: 404
请求的内容未找到:请检查请求的路径。
- 响应状态码: 500
业务失败:请依次确认您请求中各参数的取值。
错误码
无。
报文样例
- 场景描述:主动轮询座席侧发送给用户侧的消息
URL:Domain Address/apiaccess/ccmessaging/poll?receiverId=XXXXXXXXXXXXXXXXXXXXXXXX&channel=WEB
请求头:
ccmessaging-token: XXXXXXXXX
响应参数:
{ "resultCode": "0", "resultDesc": "query user messages success.", "downlinkMessages": [{ "from": "1011577355744904195", "channel": "WEB", "to": "session_fixed_user_fixed", "controlType": "CHAT", "mediaType": "TEXT", "content": "欢迎欢迎,热列欢迎", "simQuestions": null, "senderNickname": "test", "senderAvatar": "1", "timestamp": 1619590480756, "sourceType": "ROBOT", "callId": null, "robotGender": "MALE" }, { "from": "1011577355744904195", "channel": "WEB", "to": "session_fixed_user_fixed", "controlType": "CHAT", "mediaType": "TEXT", "content": "转人工", "simQuestions": null, "senderNickname": "test", "senderAvatar": "1", "timestamp": 1619590482098, "sourceType": "ROBOT", "callId": null, "robotGender": "MALE" }, { "from": "1011577355744904195", "channel": "WEB", "to": "session_fixed_user_fixed", "controlType": "CHAT", "mediaType": "TEXT", "content": "已接通座席。", "simQuestions": null, "senderNickname": "系统", "senderAvatar": null, "timestamp": 1619590484115, "sourceType": "SYSTEM", "callId": null, "robotGender": null }] } 多媒体库文件场景下: { "downlinkMessages": [ { "callId": null, "simQuestions": null, "senderNickname": "agent", "handlerType": null, "isOfflineStatus": null, "channel": "WEB", "senderAvatar": "", "robotGender": null, "mediaType": "IMAGE", "associationContentId": null, "content": "1179725658739559425", "receiveTime": null, "controlType": "CHAT", "sourceType": "AGENT", "queueFlag": null, "messageCode": "1e1f2bf7-fd6e-4471-a45d-2b43d1eb6272", "from": "202201077401331370", "to": "1642643982282972758", "mediaFileType": "png", "contentType": null, "interIdx": null, "timestamp": 1648102235191 } ], "resultCode": "0", "resultDesc": "query user messages success." } 发送本地文件场景下: { "downlinkMessages": [ { "callId": null, "simQuestions": null, "senderNickname": "agent", "handlerType": null, "isOfflineStatus": null, "channel": "WEB", "senderAvatar": "", "robotGender": null, "mediaType": "IMAGE", "associationContentId": null, "content": "878e7d9a-8e2f-4893-8b54-352f8ecbf86c", "receiveTime": null, "controlType": "CHAT", "sourceType": "AGENT", "queueFlag": null, "messageCode": "9374d9c4-b8ee-4035-aab9-ad5ceddbb856", "from": "202201077401331370", "to": "1642643982282972758", "mediaFileType": "png", "contentType": "1", "interIdx": null, "timestamp": 1648102054235 } ], "resultCode": "0", "resultDesc": "query user messages success." }