- 最新动态
- 产品介绍
- 快速入门
-
用户指南
- 云控制台操作指南
-
租户管理员指南
- 认识您的租间
- 配置员工中心
- 启用人工服务
- 配置移动客服
- 配置多媒体渠道
-
机器人管理配置指南
- 快速入门
-
配置智能机器人
- 概述
- 配置一个预约挂号机器人(任务型对话机器人)
- 添加问答型对话机器人
- 其他操作
-
相关参考
- 图元
- 参数
-
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接口参考
- 其他类接口参考
- 常见问题
- 文档下载
- 通用参考
链接复制成功!
外呼结果回调接口
场景描述
该接口会将外呼结果推送至指定URL。
使用说明
- 前提条件
- 已经申请了开发者账号。
- 外呼活动已经创建,并已添加外呼数据。
- 注意事项
- 接收请求后,需服务端返回200的响应,其他响应均认为推送失败。
- 接收到非200响应后,会立即再次推送。如果仍为非200响应,则认为本次推送失败。
- 使用限制
- 每条呼叫数据最大推送次数为 6 次。
- 推送失败后 10 分钟再次推送。
接口方法
该接口仅支持POST方法。
接口URI
创建外呼活动时,通过callBackUrl指定。
请求说明
无请求头消息。
序号 |
参数名 |
参数类型 |
说明 |
---|---|---|---|
1 |
callResultList |
List |
外呼结果列表,此处仅做说明,实际无此实体对象,response直接返回List。具体参考表2。 |
序号 |
参数名 |
参数类型 |
说明 |
---|---|---|---|
1 |
campaignId |
String |
外呼活动的id |
2 |
sessionId |
String |
标识用户的ID。 |
3 |
called |
String |
被叫号码。 |
4 |
callTimeStr |
String |
呼叫时间,格式为:yyyy-mm-dd hh:mm:ss。 |
5 |
callStatus |
int |
呼叫结果(5: 呼叫失败,6: 呼叫成功)。 |
6 |
failCode |
String |
失败的原因码,请参见表4。 |
7 |
vdnId |
int |
外呼号码所属VDN ID。 |
8 |
callId |
String |
通话记录ID,用于与CTI平台的话单等通话数据关联。 |
9 |
customField |
String |
用户自定义字段。 |
10 |
recordPath |
String |
通话录音文件的存储路径。 该字段仅在使用接续时(SAAS组网),才返回值,其他情况返回为空。 |
响应说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
retCode |
string |
True |
0,成功,其他为失败。 |
2 |
retMsg |
string |
True |
失败原因的描述。 |
触发事件
无
结果码
分类 |
错误原因码 |
错误原因描述 |
---|---|---|
外呼成功 |
00000 |
外呼成功。 |
用户侧拆线 |
00531 |
外呼用户挂机。 |
00537 |
外呼号码被叫忙。 |
|
00538 |
外呼号码为空号或错号。 |
|
00548 |
外呼手机号码关机。 |
|
00549 |
外呼手机号码不在服务区。 |
|
00551 |
用户挂机。 |
|
00601 |
应答前用户挂机。 |
|
00603 |
外呼号码无应答后拆线。 |
|
00604 |
呼叫拒绝。 |
|
00701 |
外呼用户转队列,排队中用户主动挂机。 |
|
平台正常拆线 |
00702 |
外呼用户转队列,排队超时,平台释放呼叫(若配置为排队超时释放)。 |
01040 |
振铃超时,平台释放呼叫。(即在设置的振铃时间内,用户一直没有摘机) |
|
01043 |
平台内部等待外呼结果超时。 |
|
01046 |
占用座席失败(转IVR外呼不涉及)。 |
|
01049 |
外呼检测超时。 |
|
34601 |
外呼任务不存在。 |
|
34605 |
电话号码为空,即外呼获取的被叫号码为空字符串。 |
|
34606 |
试呼失败,即调用呼出接口失败(比较常见的一种情况:当前的并发外呼数达到了最大外呼数;),没有呼出到用户。 |
|
34608 |
呼出后,没有得到呼出结果信息,超时后将该呼叫数据回写。 |
|
系统资源不足,平台侧拆线 |
00602 |
系统资源不足,请联系管理员检查资源配置。 |
00605 |
||
01048 |
||
34606 |
||
系统异常 |
00606 |
请联系管理员排查。 |
34611 |
||
其他 |
报文样例
- 该接口的请求消息体举例如下:
[ { "campaignId": "3", "sessionId": "1202_test013", "called": "60584", "callTimeStr": "2020-08-30 20:00:00", "callStatus": 6, "failCode": "0", "vdnId": 11, "callId": "0023-134864174", "recordPath": "Y:/1/11/20200830/3408/0949218.V3" } ]
- 该接口的响应消息体举例如下:
{ "retCode": "0", "retMsg": "success" }