云客服
云客服
- 产品介绍
- 快速入门
-
用户指南
- 云控制台操作指南
-
租户管理员指南
- 认识您的租间
- 配置员工中心
- 启用人工服务
- 配置移动客服
- 配置多媒体渠道
-
机器人管理配置指南
- 快速入门
-
配置智能机器人
- 概述
- 配置一个预约挂号机器人(任务型对话机器人)
- 添加问答型对话机器人
- 其他操作
-
相关参考
- 图元
- 参数
-
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音视频接入
- 用户接入——网页版轻量级客户端集成 (JS)
- 用户接入——网页客户端接入(RESTful)
- 座席集成——座席轻量级接续块集成(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)
- POST /CCSQM/rest/ccisqm/v1/appraisescore/createAppraiseScore
- POST /CCSQM/rest/ccisqm/v1/appraisescore/applyAppraiseScore
- POST /CCSQM/rest/ccisqm/v1/appraisescore/removeAppraiseScore
- POST /CCSQM/rest/ccisqm/v1/appraisescore/queryAppraiseScore
- POST /CCSQM/rest/ccisqm/v1/appraisescore/modifyAppraiseScore
-
句子管理接口 (sentencemanagement)
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/createSentenceCategory
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/moveSentenceToCategory
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/deleteSentence
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/querySentence
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/querySentenceByCategoryId
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/updateSentence
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/updateSentenceCategory
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/deleteSentenceCategory
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/querySentenceCategory
- POST /CCSQM/rest/ccisqm/v1/sentencemanage/createSentence
-
敏感词管理接口 (sensitiveWordManage)
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/deleteSensitiveWord
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/querySensitiveWordList
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/deleteSensitiveCategory
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/updateSensitiveWord
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/querySensitiveCategoryList
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/querySensitiveWordsByCategoryId
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/createSensitiveCategory
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/moveSensitiveWordToCategory
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/createSensitiveWord
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/updateSensitiveCategory
- POST /CCSQM/rest/ccisqm/v1/sensitiveWordManage/querySensitiveWordDetail
- 话术接口 (conversationspecific)
- 句子、敏感词训练接口 (SemanticKeywordTraining)
- 对话逻辑接口 (conversationflow)
- 对话规则接口 (conversationrules)
-
抢插话规则接口 (interposalrules)
- POST /CCSQM/rest/ccisqm/v1/interposal-rules/getInterposalRuleById
- POST /CCSQM/rest/ccisqm/v1/interposal-rules/queryInterposalRules
- POST /CCSQM/rest/ccisqm/v1/interposal-rules/deleteInterposalRule
- POST /CCSQM/rest/ccisqm/v1/interposal-rules/addInterposalRule
- POST /CCSQM/rest/ccisqm/v1/interposal-rules/updateInterposalRule
- 公共参数结构
- 静默规则接口 (silencerule)
- 语速规则接口 (speedrule)
-
质检场景管理接口 (scenariomanage)
- POST /CCSQM/rest/ccisqm/v1/scenariomanage/deleteScenario
- POST /CCSQM/rest/ccisqm/v1/scenariomanage/updateScenarioStatus
- POST /CCSQM/rest/ccisqm/v1/scenariomanage/createScenario
- POST /CCSQM/rest/ccisqm/v1/scenariomanage/queryScenario
- POST /CCSQM/rest/ccisqm/v1/scenariomanage/updateScenario
- POST /CCSQM/rest/ccisqm/v1/scenariomanage/queryAllScenario
- 通话质检接口 (qualitycheckmanage)
-
人工抽检任务接口 (regularQualityTask)
- POST /CCSQM/rest/ccisqm/v1/regularqualitytask/addQualityTask
- POST /CCSQM/rest/ccisqm/v1/regularqualitytask/beginQualityTask
- POST /CCSQM/rest/ccisqm/v1/regularqualitytask/updateQualityTask
- POST /CCSQM/rest/ccisqm/v1/regularqualitytask/deleteQualityTask
- POST /CCSQM/rest/ccisqm/v1/regularqualitytask/queryQualityTask
- POST /CCSQM/rest/ccisqm/v1/regularqualitytask/stopQualityTask
-
质检任务接口 (qualitytask)
- POST /CCSQM/rest/ccisqm/v1/qualitytask/deleteQualityTask
- POST /CCSQM/rest/ccisqm/v1/qualitytask/updateQualityTask
- POST /CCSQM/rest/ccisqm/v1/qualitytask/terminateQualityTask
- POST /CCSQM/rest/ccisqm/v1/qualitytask/takeEffectQualityTask
- POST /CCSQM/rest/ccisqm/v1/qualitytask/queryQualityTask
- POST /CCSQM/rest/ccisqm/v1/qualitytask/appointQualityTask
- POST /CCSQM/rest/ccisqm/v1/qualitytask/createQualityTask
- 质检任务详情接口 (qualitytaskdetail)
-
质检申诉接口 (qualityitem)
- POST /CCSQM/rest/ccisqm/v1/qualityitem/reassginQualityTask
- POST /CCSQM/rest/ccisqm/v1/qualityitem/modifyQualityItemResult
- POST /CCSQM/rest/ccisqm/v1/qualityitem/appealItem
- POST /CCSQM/rest/ccisqm/v1/qualityitem/queryQualityItem
- POST /CCSQM/rest/ccisqm/v1/qualityitem/queryQualityItemDetail
- POST /CCSQM/rest/ccisqm/v1/qualityitem/queryQualityItemResult
- POST /CCSQM/rest/ccisqm/v1/qualityitem/queryQualityHistory
- 第三方录音质检接口 (asrtrans)
-
质检评分接口 (scoresetting)
-
监控/统计
-
实时数据查询类接口
-
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接口参考
- DataProcess接口参考
- 其他类接口参考
- 常见问题
- 通用参考
链接复制成功!
响应消息
一个响应消息通常由三部分组成:状态行、响应报头、响应正文。响应消息格式如 表1所示。
HTTP(s)响应报文 |
|
---|---|
HTTP(s)响应行 |
HTTP-Version Status-Code Reason-Phrase HTTP-Version和Status-Code之间有空格,Status-Code和Reason-Phrase之间有空格。Reason-Phrase后有回车符。 |
响应头 |
Content-Type:application/json;charset=UTF-8 |
... |
|
空行 |
CRLF(回车符) |
消息体(可选) |
业务请求消息(JSON描述) |
状态行
HTTP-Version Status-Code Reason-Phrase CRLF
其中:
- HTTP-Version表示服务器HTTP协议的版本号
- Status-Code表示服务器发回的响应状态代码
- Reason-Phrase表示状态代码的文本描述。
状态代码有三位数字组成,第一个数字定义了响应的类别,且有五种可能取值:
- 1xx:指示信息--表示请求已接收,继续处理
- 2xx:成功--表示请求已被成功接收、理解、接受
- 3xx:重定向--要完成请求必须进行更进一步的操作
- 4xx:客户端错误--请求有语法错误或请求无法实现
- 5xx:服务器端错误--服务器未能实现合法的请求
常见状态代码有:
- 200 OK //客户端请求成功
- 400 Bad Request //客户端请求有语法错误,不能被服务器所理解
- 401 Unauthorized //请求未经授权
- 403 Forbidden //服务器收到请求,但是拒绝提供服务
- 404 Not Found //请求资源不存在
- 500 Internal Host Error //服务器发生不可预期的错误
- 503 Host Unavailable //服务器当前不能处理客户端的请求,一段时间后可能恢复正常
例如,在大部分时候都是返回的成功状态:
HTTP/1.1 200 OK (CRLF)
消息报头
响应的消息报头在大多数情况下含有下面报头:
响应正文
响应正文为JSON格式的文本。具体请查看后续章节各个接口的定义。
父主题: RESTful接口格式