- 最新动态
- 产品介绍
- 快速入门
-
用户指南
- 云控制台操作指南
-
租户管理员指南
- 认识您的租间
- 配置员工中心
- 启用人工服务
- 配置移动客服
- 配置多媒体渠道
-
机器人管理配置指南
- 快速入门
-
配置智能机器人
- 概述
- 配置一个预约挂号机器人(任务型对话机器人)
- 添加问答型对话机器人
- 其他操作
-
相关参考
- 图元
- 参数
-
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接口参考
- 其他类接口参考
- 常见问题
- 文档下载
- 通用参考
链接复制成功!
添加业务接口
根据配置场景中的分析,您需要添加多个业务接口,均是通过缓存变量的方式使用业务接口,未调用真实接口。若在实际场景中您需要调用真实接口,此处介绍调用真实接口的配置方法。
此处的业务接口编排能力较弱,因此在实际应用中,此处调用的接口应由专门的接口适配团队提供,用来屏蔽不同系统之间的接口定义差异。
例如我们需要通过一个接口调用获得两个参数的值,但是在实际业务系统中这两个参数分别来自两个接口,需要有专门的团队做一下接口编排,包装成一个新接口供此处调用。
前提条件
请联系系统管理员将您需要调用的第三方接口的IP或域名添加到白名单中。
操作步骤
- 租户管理员选择“配置中心>机器人管理>流程配置”,进入流程配置页面。
- 选择“资源管理 > 业务接口”。单击“添加”。
- 您可以两种方式进行接口添加:自动生成消息体,手动输入消息体,下面分别介绍两种方式的操作步骤,请选择一种方式添加接口即可。
- 自动生成消息体方式添加接口。
- 在“自动生成消息体”页签,设置您即将调用的接口基本信息,包括接口名称、请求方法、请求URL等信息。
- 当请求方法选择TUC时,单击请求URL的输入框,可根据实际情况选择如下URL,具体接口入参出参详情请参见TUC接口。
表1 请求方法为TUC时的请求URL URL
描述
/chatbot/rest/tuc/v1/nlp/detectRegularEntity
工单流程中用到的规则实体的检测。
/chatbot/rest/tuc/v1/nlp/identify
语种接口。
/chatbot/rest/tuc/v1/recommendFaq
FAQ推荐接口。
/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
智能实训接口
须知:
请注意,HTTP协议不是安全的网络协议,如确定使用,可能存在安全风险。推荐使用HTTPS协议。
- 是否签名:请依据第三方接口是否做了签名校验来决定是否开启,若选择开启签名,请找第三方提供共享密钥。
说明:
- 请注意,不开启签名校验存在安全风险,建议选择需要签名。
- 若开启签名,第三方提供的共享密钥定期修改后,请同步修改页面此处的共享密钥。
- 当请求方法选择TUC时,单击请求URL的输入框,可根据实际情况选择如下URL,具体接口入参出参详情请参见TUC接口。
- (可选)若接口有查询参数请添加查询参数,查询参数即接口请求url后拼接?路径参数1=参数值&路径参数2=参数值。
- 添加接口入参。在“入参”页签,单击“添加”增加入参变量。一般该接口的入参与第三方系统接口规格中的入参保持一致。
须知:
如果您要求的入参信息包含个人数据,例如客户的身份证号等信息,此处需要将“是否加密”设置成“
”,以确保数据安全。
- 添加接口出参。在“出参”页签,单击添加增加出参,接口的出参与第三方系统接口规格中的出参保持一致。
须知:
如果您要求的出参信息包含个人数据,例如客户的身份证号等信息,此处需要将“是否加密”设置成“
”,以确保数据安全。
参数路径的配置,如下图,若要取整个返回结果,则配置为$。若要取某个字段,则用$开头,用.来分割各个层级,这个层级一定要和返回结果结构一致,否则会解析失败或取不到想要的字段。
图1 出参配置样例 - (可选)添加接口消息头。在“消息头”页签,添加接口所需的鉴权信息,如果没有可不配置,以第三方系统的规格为准。
须知:
如果您要求的接口消息头信息包含个人数据,例如客户的身份证号等信息,此处需要将“是否加密”设置成“YES”,以确保数据安全。
- 在“消息体”页签,将查看到自动生成的消息体,您可将生成的消息复制到调测工具中,查看是否能调用成功。
- 单击“确定”,完成接口添加。
- 在“自动生成消息体”页签,设置您即将调用的接口基本信息,包括接口名称、请求方法、请求URL等信息。
- 手动输入消息体方式添加接口。
- 选择“手动生成消息体”页签。设置您即将调用的接口基本信息,包括接口名称、请求方法、请求URL。具体参数解释请参见4.a。
- (可选)若接口有查询参数请添加查询参数,查询参数即接口请求url后拼接?路径参数1=参数值&路径参数2=参数值。
- 添加接口出参。在“出参”页签,单击添加增加出参,接口的出参与第三方系统接口规格中的出参保持一致。
须知:
如果您要求的出参信息包含个人数据,例如客户的身份证号等信息,此处需要将“是否加密”设置成“
”,以确保数据安全。
参数路径的配置,如下图,若要取整个返回结果,则配置为$。若要取某个字段,则用$开头,用.来分割各个层级,这个层级一定要和返回结果结构一致,否则会解析失败或取不到想要的字段。
图2 出参配置样例 - (可选)添加接口消息头。在“消息头”页签,添加接口所需的鉴权信息,如果没有可不配置,以第三方系统的规格为准。
须知:
如果您要求的接口消息头信息包含个人数据,例如客户的身份证号等信息,此处需要将“是否加密”设置成“YES”,以确保数据安全。
- 添加消息体,进入“消息体”页签中直接输入请求消息体,例如:
{ "callId": "${businessReqId}", "provId": "202205130514", "busiType": "0", "params": { "tenantId": "${tenantId}" } }
对于手动输入消息体,入参不可以手动添加,而是通过对消息体内容的解析自动生成的入参,如上面示例将会产生两个入参businessReqId、tenantId。入参businessReqId、tenantId可以是后续流程中调用该接口时需要传递的变量。
- 单击“确定”,完成接口添加。