接口概述

更新时间：2023-09-27 GMT+08:00

查看PDF

云客服系统对外开放的接口主要分为如下几类，您可以参照表1了解几个主要的接口类别和基本功能。

须知：

部分接口包含分布式锁，用于保证在并发场景下，同一段时间只能处理一个座席的修改/新增请求，防止原子性和一致性被破坏。接口调用时触发分布式锁，接口调用完成（不论失败还是成功）后分布式锁自动释放，接口可以二次调用。

表1 接口概览
接口类别	描述
呼叫中心配置接口	包含座席管理、技能队列管理、号码管理、IVR管理相关接口。可以通过这类接口创建座席和技能队列，查询座席、技能队列、接入码和IVR流程相关信息，上传IVR语音文件等。
座席工作台接口	包含座席控制、座席双呼（移动APP场景下使用）、订阅语音识别结果接口、App个人设置（移动APP场景下使用）。可以通过这类接口实现座席签入签出和呼叫控制，查询呼叫数据，座席双呼，以及向呼叫中心CTI平台发起语音识别结果订阅。使用座席工作台的相关接口，您还需要考虑话机的相关使用，具体请参见《开发指南》。
电销外呼接口	即CC-iSales（电销外呼）的接口。可以通过这类接口实现新增外呼活动、添加外呼号码与查询外呼结果等业务。
机器人管理接口	即OIAP（智能助手平台）的接口。可以通过这类接口实现查询领域、对话、管理问答与管理问答组等业务。
网页客户端接入接口	即网页客户端接入的接口。可以通过这类接口实现用户发送在线消息，发送与接收文件，发起点击通话等业务。
质检/监控/统计类接口	包含实时质检、查询实时数据、历史数据、和配置类数据的接口。可以通过这类接口实现质检员对座席进行插入、侦听、拦截等实时质检操作，查询租间的座席、技能队列等不同维度的实时监控指标和历史监控指标等。须知：在监控、统计类接口中，如果出现如下结构的描述，是为了兼容历史版本。当前版本返回结果码使用resultCode替代result，接口返回数据使用 resultDesc替代resultDatas。 result：查询结果。数据类型为String，取值如下： 0：成功非0：失败 resultDatas：查询成功后，返回结果信息的JSON对象数组。
录音/话单类接口	包含录音回放、录音下载、视频下载、话单下载相关接口。可以通过这类接口实现座席签入后给座席播放录音、座席侧下载音视频文件、第三方下载话单和下载以及播放录音等。
语音通知接口	包含查询语音通知的录音文件、创建语音通知接口。可以通过这类接口可以发起语音通知，向指定客户播放指定语音文件。
OMA接口	包含客户信息查询接口与查询订购信息接口等。可以通过这类接口实现软件云调用查询相关信息，当前仅试用。
DataProcess接口	查询呼叫结果数据接口。
其他类接口参考	包含认证Token信息接口与一键试用接口等。

下一篇：相关术语

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

接口概述

意见反馈

文档内容是否对您有帮助？

文档反馈