蚁巢

使用手册

蚁巢5.0.5使用手册

更新日志

版本 5.0.6.3

  1. 更新日期:2023年07月20日,
  2. [调整]批量获取话单接口的返回通话时长的格式:时分秒调整为秒 如 00:00:10 调整为 10

版本 5.0.6.3

  1. 更新日期:2023年06月30日,新增AI任务外呼相关接口
  2. [新增]获取AI话术接口
  3. [新增]获取AI意图筛选接口
  4. [新增]获取AI线路接口
  5. [新增]获取AI转接选项接口
  6. [新增]获取AI语音包接口
  7. [新增]获取AI任务最大并发数接口
  8. [新增]获取AI任务列表接口
  9. [新增]获取AI任务话术变量接口
  10. [新增]创建AI任务接口
  11. [新增]AI任务追加号码数据接口
  12. [新增]AI任务开启/暂停接口
  13. [新增]获取AI任务详情接口
  14. [新增]AI挂机回调推送接口
  15. [新增]获取AI对话详情接口

版本 5.0.6.3

  1. 更新日期:2022年2月10日
  2. [修复]队列号首个字符填写数字时出现的不能编辑的情况
  3. [修复]调整报表里的logo连接wei-fu.cn
  4. [修复]toLoginPage函数检查用户操作超时操作后出现大量重复请求的情况
  5. [新增]中继列表增加公司名称查询
  6. [修复]修复中继注册状态没有正确显示的错误
  7. [新增]中继注册状态加入注册连接延时显示
  8. [加强]分机编辑提交后增加提示遮罩信息,解决用户重复提交的情况
  9. [修复]自动任务的统计图表中分机排名计算错误的情况
  10. [修复]建立入局成功后配置界面没有关闭
  11. [修复]批量延期操作后提示内容里显示sql语句
  12. [修复]通话保持图标显示错误

版本 5.0.6.2

  1. 更新日期:2021年9月17日
  2. [新增]客户公共池功能
  3. [新增]客户资料导入字段记忆上次选中功能
  4. [新增]客户资料加入操作日志
  5. [修复]坐席统计报表数据不准确的情况
  6. [新增]弹屏页面增加客户资料的修改记录
  7. [加强]第三方弹屏地址增加着重颜色提示
  8. [加强]客户资料导入去掉单引号,双引号,转移,提取,删除记录
  9. [新增]公司列表可跳转到对应的公司系统内
  10. [新增]页面右上角增当前登陆的公司名称
  11. [修复]页面字体调整为12px
  12. [修复]解决通话记录导出乱码的问题

版本5.0.6

  1. 更新日期:2021年1月9日
  2. [新增]用户未操作的时长达到30分钟后将退出登陆
  3. [修复]点击呼叫后没有更新时间的情况
  4. [修复]服务重启功能模块
  5. [新增]增加一些安全措施,如用户并发、登陆日志、密码强度、默认用户名的常量化等
  6. [修复]外呼任务详情导出异常的错误
  7. [修复]导出客户资料中下拉类型字段无数据的情况
  8. [修复]登陆后的首页输入的错误信息。
  9. [加强]推送增加用户信息
  10. [新增]时段报表增加图表和数据表
  11. [修复]来电挂机后禁止重新来电分配接听的情况
  12. [新增]第三方弹屏页面地址
  13. [修复]通话转移无通话记录的情况
  14. [修复]保存转移设置的记录出现多条记录的情况
  15. [加强]接口获取任务任务增加返回任务数量
  16. [新增]客户跟进记录增加号码点击呼叫功能
  17. [修复]接口通话记录录音文件在某些情况下不能下载的情况
  18. [修复]接口getTaskPhonesList.php分页错误情况
  19. [修复]接口getTaskAdd.php增加返回tech,name, channelid, outcid参数
  20. [修复]通话记录主叫在某些情况下不显示的情况

版本5.0.5

  1. 更新日期:2020年06月17日
  2. [新增]超级管理员部分增加监控asterisk和mysql运行状态设置。
  3. [新增]坐席设置里坐席账号增加有效期。
  4. [新增]报表统计新增时段报表、示忙示闲报表、呼入呼出报表。
  5. [新增]新增来电监控模块,包括来电统计和实时来电监控。
  6. [加强]系统设置新增黑名单库、呼叫轮询、转移设置、话后设置、评价设置。

引言

蚁巢5.0.5为多用户版本,同时支持云端和本地部署,公司配置可分为基础版和高级版两种。基础版的公司配置具有全部PBX的配置功能,是专为对接蚂蚁客服系统而准备的;而高级版的公司配置则是在基础版的基础上,加入了CRM管理、组织机构、项目任务、报表管理等传统呼叫中心功能。

蚁巢5.0.5里管理员角色分为超级管理员和公司管理员两种,超级管理员管理各个公司信息,给每个公司分配相应的分机及中继;而基础版的公司管理员则管理所有PBX配置功能,高级版的公司管理员除了管理所有PBX配置功能外,还管理公司的CRM、组织机构、项目任务、报表管理等信息,公司相应角色的用户按照公司管理员分配的权限使用即可。

超级管理员

超级管理员登录

超级管理员在呼叫中心系统下,配置好相应的分机及中继信息后,通过相应地址访问多用户系统:http://xxx.xxx.xxx.xxx/cloudcc/center.html ,省略部分为服务器的IP地址,如下图所示:

在以上页面输入超级管理员的用户名、密码和验证码进行登录,默认超级管理员用户名:superadmin。

登录成功后,进入首页,首页显示公司总数、分机总数、待审核系统语音数、待审核等待语音数,如下图所示:

个人中心

个人中心

账号信息

在账号信息页面可修改超级管理员的登录密码,如下图所示:

分机管理

分机管理

分机信息

用户可在此页面管理所有公司的分机信息,在已授权分机数量范围内,通过单个【添加】或【批量添加】的方式添加所需分机,通过【编辑】可修改当前分机密码,亦可按照公司名称、分机号码以及分机状态进行相应的查询。如下图所示:

注:如果需要某分机呼出显示特定外线号码或通过该外线号码可以呼入到该分机,则可添加【分机DID】,前提是该线路支持多个DID号码。

中继管理

中继管理

中继管理

用户可在此页面管理所有公司的中继信息,在已授权中继数量范围内,【添加】可用中继信息,在中继数量较多时,可根据中继名称和主叫号码进行查询,如下图所示:

注:如果线路支持多个DID号码,可先在中继主叫和外呼主叫设置一个号码,fromuser不要绑定号码,然后在分机设置相应的DID号码,该分机就可以按照设置的DID号码进行呼入呼出。

公司管理

公司管理

公司管理

管理各个公司的信息,给各个公司分配相应数量的分机和中继,根据需求选择相应的版本类型,查看各个公司分机的状态。如下图所示:

【添加】:新建公司账号和名称,给公司管理员账号设定初始密码,限定公司可用的最大并发数、项目上限、队列数量、ivr数量以及版本类型,设置调用密钥以提供蚂蚁客服系统对接使用,分配分机和中继,也可以对接到VOS,查看每日消费金额以及余额。如下图所示:

【修改】:修改公司的账号、名称、管理员密码以及调用密钥,调整最大并发、项目上限、队列数量、ivr数量等信息,给该公司添加新的分机和中继,也可以修改VOS余额是否显示以及账号。如下图所示:

系统语音审核

公司提交的系统语音(即欢迎语)需经过超级管理员审核通过才能使用,如下图所示:

审核通过的系统语音即可在公司的项目管理、IVR语音以及队列欢迎语里选择使用,审核未通过的系统语音则不会在公司项目管理、ivr语音以及队列欢迎语的欢迎语列表里显示,点击【】按钮可查看审核不通过的原因,也可以根据铃音名称和公司名称查询系统语音。

等待语音审核

公司提交的等待语音(即队列背景音)需经过超级管理员审核通过才能使用,如下图所示:

审核通过的等待语音即可在公司的项目管理和队列的等待语音列表里选择使用,审核未通过的等待语音则不会在公司项目管理和队列的等待语音列表里显示,点击【】按钮可查看审核不通过的原因,也可以根据铃音名称和公司名称查询等待语音。

高级设置

高级设置

智能控制

智能控制是用于设置每天号码最多被拨打次数,开启/关闭系统双通道录音,开启/关闭判断挂机原因,开启/关闭系统质检服务,开启/关闭系统语音转文字,开启/关闭自动外呼自动接听提示“来电”。如下图所示:

1、号码最多被拨打次数:每天能呼叫同一个号码多少次,超出后会有相应语音提示。 2、系统双通道录音:开启后,每一通通话都会生成三条录音,一条是完整的双方通话录音,一条是客户说话的录音,一条是坐席说话的录音。 3、判断挂机原因:开启后会自动识别呼出失败的具体原因,具体原因可以在通话记录里查看。 4、系统质检服务:开启系统质检服务。 5、系统语音转文字:开启后可以将系统录音自动转换成文字。 6、自动外呼自动接听提示“来电”:在自动外呼场景下,软电话设置了自动接听,当有通话进来时,自动提示“来电”。

网络设置

网络设置包含两部分设置:一是信令设置,二是网络设置。信令设置主要用于调整端口、媒体超时时间、通话最大时长,网络设置则是用于调整公网IP、内网IP和子网掩码的。如下图所示:

弹屏设置

弹屏设置则是用于设置弹屏推送地址的,填写服务器的外网IP,如果是域名访问则填写域名。如下图所示:

预警提醒

设置监控asterisk和mysql运行状态的检测间隔以及运行异常时通知邮件发送到的邮箱。

系统工具

系统工具

服务重启

服务重启提供了三种服务的重启、服务器的重启和关闭、数据库修复等功能,三种服务分别为WEB服务、数据库服务、PBX服务,数据库修复还提供了修复日志的下载。如下图所示:

授权重置

授权重置是在系统需要重新授权或增加授权分机数时使用,如无必要,不要操作此菜单。

系统信息

系统信息则记录了系统的版本信息,并对服务器的磁盘使用率、CPU平均负载和内存使用率进行了实时监控。如下图所示:

公司管理员

基础版

基础版的公司管理员可管理所有PBX配置功能,为对接的蚂蚁客服系统提供全面的PBX配置。

在登录页面输入公司账号、管理员账号、密码和验证码进行登录,公司账号如:ceshi,管理员首次登录使用默认账号:admin,如下图所示:

登录成功后,进入首页信息界面,包括:(坐席)账户到期时间、今日新增客户数、今日新增业务记录、我的任务数量、今日时段通话量等信息。如下图所示:

黑名单库

黑名单库

每个公司可以在这里导入自己的黑名单,支持多种类型限制:限制呼入、限制呼出、限制呼入呼出。

单个添加

点击【添加】按钮,输入黑名单号码,选择限制类型“限制呼入”,如果输入的号码不在黑名单列表里,则添加成功,该号码不允许呼入系统;如果输入的号码已存在黑名单列表里,则提示“该号码已存在”。

批量导入

点击【批量导入】按钮,弹出批量导入窗口,点击【下载模板】,下载好csv模板,在模板里录入需要导入的黑名单号码,保存好模板,点击csv导入的选择文件,选择已经录入黑名单号码的模板,选择限制类型“限制呼入呼出”,不勾选去重类型,点击【确定】,黑名单号码导入成功,导入号码不去重。如果需要去重,可以选择文件内去重和数据库去重。

呼叫轮询

呼叫轮询

呼叫轮询是对某个号码做的呼出规则,当启用轮询时,系统检测对应线路的呼叫次数达到次数后将使用其它的线路。

转移设置

转移设置

当坐席无法在工位上接听来电时,可以设置转移到手机上接听,转移设置分为:无条件转移、无应答转移、遇忙转移三种。 无条件转移:客户来电直接转移到设置的手机上接听。 无应答转移:客户来电时,坐席分机无应答后,自动转移到设置的手机上接听。 遇忙转移:客户来电时,坐席分机处于示忙状态,自动转移到设置的手机上接听。

强制示闲:通话结束后,分机自动示闲。 强制示忙:通话结束后,分机自动示忙。

示忙分类

示忙分类

管理员可以自定义示忙分类,坐席可以根据自己需要选择示忙分类进行示忙,坐席示忙后可以在示忙示闲报表查看示忙次数及时长。

话后设置

话后设置

启用话后功能,通话结束后,系统自动给分机示忙30秒(话后时长可自定义设定,针对整个公司生效),给坐席一个话后整理资料的时间;30秒后自动示闲,继续接听来电。此设置针对整个公司所有坐席分机生效。

系统语音

系统语音

系统语音是为项目管理、队列欢迎语以及IVR设置的欢迎语提供录音文件,需注意的是导入的录音文件必须为WAV格式(pcm编码,8000Hz采样频率,16bit采样宽度),添加后需经过超级管理员审核通过方可使用。如下图所示:

审核通过的系统语音即可在项目管理、队列欢迎语以及IVR设置的欢迎语列表里选择使用,审核未通过的系统语音则不会在项目管理、队列欢迎语以及IVR设置的欢迎语列表里显示,点击【】按钮可查看审核不通过的原因,也可以根据语音名称进行查询。

1、TTS语音

TTS语音提供了多个声音的文字转语音服务,支持调整音量和语速,并支持下载。如果要试听效果,可以往内容里输入文字内容,调整音量和语速,然后点击【试听】即可。

2、保留号码设置

在呼入到IVR语音导航场景下,转队列两次都无人接听,可以让客户输入号码做登记,此处是设置登记客户号码所要播报的录音。

评价设置

评价设置

设为满意度评价语音

在评价设置里点击【设为满意度】按钮,可以选择任意审核通过的系统语音作为满意度评价语音。

满意度按键设置

可以为满意度评价(即服务质检)的按键自定义命名,配合自定义满意度评价语音使用。

等待语音

等待语音

等待语音是为队列背景音提供录音文件,同样需注意的是导入的录音文件必须为WAV格式(pcm编码,8000Hz采样频率,16bit采样宽度),添加后需经过超级管理员审核通过方可使用。如下图所示:

审核通过的等待语音即可在项目管理和队列的等待语音列表里选择使用,审核未通过的等待语音则不会在项目管理和队列的等待语音列表里显示,点击【】按钮可查看审核不通过的原因,也可以根据语音名称进行查询。

入局设置

入局设置

入局设置是为呼入或者自动外呼配置入局规则,如下图所示:

点击【添加入局】按钮,可设置入局名称、主叫匹配、DID号码以及入局目的,入局名称请使用英文或数字(其他PBX配置的名称规则与此一样),DID号码即为中继的主叫号码,拨打此号码即可进行呼入,入局目的有六种方式供自由选择,如下图所示:

点击入局后的【编辑】按钮,可修改主叫匹配、DID号码以及入局目的,如下图所示:

出局设置

出局设置

出局设置是为呼出(手拨呼出、点击拨号、任务点击外呼)配置出局规则,如下图所示:

点击【添加】按钮,设置出局名称、出局路由规则以及匹配的中继线路,如下图所示:

点击出局后的【编辑】按钮,可修改出局路由规则以及匹配的中继线路,如下图所示:

点击出局后的【上移】或【下移】按钮,可调整出局的优先级,优先级从上至下逐步降低。

队列设置

队列设置

此处可根据需要配置相应的队列信息,包括:队列号码、队列名称、欢迎音乐、等待音乐、振铃策略、静态坐席、等待及振铃时长、IVR语音、队列溢出等,如下图所示:

注:队列的添加有数量限制,如需增加数量,可让超级管理员在公司管理处增加。

【添加】:在添加窗口设置基本的队列信息(队列号码、队列名称、振铃策略、静态坐席、等待及振铃时长)即可成功添加队列。

【编辑】:可修改除队列号码以外的所有队列信息。

IVR设置

IVR设置

此处为IVR语音导航的设置,如下图所示:

注:IVR的添加有数量限制,如需增加数量,可让超级管理员在公司管理处增加。

【添加】:添加IVR语音导航时,只需设置IVR名称、欢迎音乐和按键功能即可添加成功,如下图所示:

【编辑】:可修改所有IVR语音导航的信息,如下图所示:

时间小组&时间条件

时间小组

根据公司的需要,在此处可设置相应的时间小组,为时间条件的设置做准备,如下图所示:

【添加】:时间小组可添加的范围有时分、星期、月份、年份,如下图所示:

【编辑】:可修改、删除、增加时间小组的详细配置,如下图所示:

时间条件

时间小组配置完成后,可在此处添加所需的时间条件,如下图所示:

【添加】:根据需要配置时间匹配和不匹配时执行的条件,系统提供了六种可执行的条件,如下图所示:

【编辑】:可修改时间条件的信息,如下图所示:

来电匹配&回调地址&修改密码

来电匹配

蚁巢提供了两种来电匹配方式,一是匹配客户资料,二是匹配7天内最新的来去电记录。

回调地址

在调用我们的接口时,需要用到挂机回调和接听回调,可以在这里设置挂机回调地址和接听回调地址。

修改密码

此菜单提供给当前登录用户密码修改功能,如下图所示:

高级版

在配置坐席前,需要先把部门结构和角色权限配置好。

在【组织机构】菜单下点击【部门管理】,根据公司需求添加相应的公司部门,如下图所示:

注:顶级部门为最高级部门,不属于任一公司,顶级部门下属部门为该公司的最高级部门。

在【组织机构】菜单下点击【角色管理】,根据各公司的需求配置公司里各种角色的权限,公司默认已配置角色有四个:部门经理、管理员、主管、坐席,如下图所示:

公司所需部门和角色权限配置完成后,即可进行坐席添加等后续操作。

点击【坐席管理】菜单下的【坐席设置】,给每个分机配置坐席账号,包括:坐席号(即分机号)、用户名、所属部门、等级和用户角色等信息,也可以根据需要选择开启或关闭弹屏示忙,每个坐席账号创建后有一个月的使用期限,到期后可以主动申请延期,或者有管理员给坐席人员延期。如下图所示:

此外,还可根据姓名、移动电话、部门以及固定电话进行相关查询。

坐席设置完成后,可在【分机查看】菜单下查看分机的注册地址、端口以及每个分机信息,包括分机号和密码,亦可通过【编辑】去修改分机密码,如下图所示:

点击【坐席管理】菜单下的【坐席监控】,查看各个坐席的状态、持续时间以及各个坐席状态的数量统计,也可以点击【】按钮监听分机的通话,如下图所示:

外呼管理
项目界面

项目界面

根据需要预先配置好项目界面,包括:项目界面名称和项目字段信息,如下图所示:

以上两图分别为添加和重命名菜单界面。

1、查看字段

查看该项目界面里设置的字段信息,可进行字段信息的添加、编辑以及删除操作,如下图所示:

注:1.进行项目界面字段删除时,之前保存的该字段信息也会对应删除。

2.项目界面禁用后,则不再显示在弹屏页面中。

项目界面配置完成后,即可在项目管理中添加新的项目。

项目管理&项目成员

项目管理

每个项目需配置项目名称、呼出号码、项目界面、项目成员四项基本项目要素,如需进行自动外呼,则还需添加欢迎语、队列背景音、并发数等信息(欢迎语和队列背景音需在系统设置菜单的系统语音库和等待语音库里添加),如下图所示:

项目成员

查看每个项目里的项目成员,如下图所示:

任务列表

任务列表

根据项目需要创建外呼任务,可创建两种类型任务:点击外呼任务和自动外呼任务,自动外呼任务又可分为标准和智能两种,客户根据需要灵活创建对应任务进行外呼,如下图所示:

添加任务时,选择所属项目,输入任务名称,选择相应的任务类型,下载导入模板,然后在下载的模板里录入手机号码,保存完成后,再选择已录入号码的模板文件,点击保存按钮,即可成功创建任务。

自动外呼任务直接点击【】按钮,即可执行该任务,外呼线路即为所属项目的线路,呼出分机则为该项目的成员分机。

自动外呼任务执行时,点击【】按钮,可以监控这个任务号码的呼叫情况以及队列里分机的接听情况;当多个任务执行时,点击【】按钮,就可以监控所有自动外呼任务号码的呼叫情况以及队列里分机的接听情况,如下图所示:

自动外呼任务呼叫完成后,可以点击【】按钮,针对待回访和呼叫失败的号码进行失败重呼。

自动外呼执行后可点击【】按钮,监控该任务的执行情况。

每个任务的【】按钮,可查看该任务下所有号码的呼叫情况,播放或下载呼叫成功号码的录音,勾选几条或直接导出所有的号码呼叫记录,亦可根据电话号码和拨打时间进行查询,如下图:

每个任务的【】按钮,查看该任务的呼叫百分比、分机接听量排名、分机接听时长排名三个统计图表,如下图所示:

点击【】按钮,可对该任务进行追加号码。

而在点击外呼任务里,需要对任务里的号码进行分配【】,分配给所属项目成员进行点击外呼,项目成员可在【我的任务】列表里查看所分配的号码,分配时,可通过勾选、输入分配数量或号码全部分配等方式进行分配,如下图所示:

注:如果选择多个坐席,或者填写分配数量,默认随机平均分配。

我的任务

我的任务

我的任务列表里显示分配给当前坐席的点击外呼任务号码,点击未呼叫状态号码进行外呼。成功通话后,该号码呼叫状态变为呼叫成功,并在列表中显示呼叫时间和通话时长;未成功通话,则该号码状态变为呼叫失败,并在列表中显示呼叫时间,如下图所示:

质检管理&标记客户

质检管理

用户可查看每个项目的质检总数,点击【查看】按钮,可查看给项目所有的质检结果,如下图所示:

标记客户

查看在通话过程中按*83标记的客户信息,可在列表中点击标记的手机号码进行外呼,支持录音的播放和下载,亦可按手机号码进行查询,如果不需要了,还可以进行删除。如下图所示:

客户管理
客户资料&业务记录

客户资料

客户资料来源有三种方式:1.直接点击【添加】按钮进行添加 2.弹屏保存 3.批量导入。用户可对客户资料详情进行查看、编辑、删除等操作,亦可根据公司名称、手机号码、联系人进行查询,如下图所示:

1.添加:点击【添加】按钮,录入相应的客户信息,点击保存即可。

2.转移公共池:支持勾选转移、转移查询结果、全部转移三种方式,转移后,所选的客户资料则显示在公共池里。

3.查看:点击【查看】按钮,查看详细的客户资料信息,包括客户详情、项目详情、历史业务记录以及通话记录,支持在详情里添加业务记录,支持修改客户信息。如下图所示:

4.编辑:点击【编辑】按钮,修改已保存的客户资料信息,点击保存即可。

5.批量导入:点击【批量导入】按钮,下载客户资料导入模板,在模板里录入大量的客户资料,保存后选择已录入客户资料的模板文件,点击确定即可批量导入客户资料。

6.导出:勾选一条或多条客户资料,即导出所勾选的客户资料;如不勾选,直接导出所有查询后的客户资料。

7.批量删除:如果要删除多条客户资料,可以勾选后批量删除,也可以查询出需要删除的客户资料,直接点【批量删除】按钮,删除时会有登录密码验证,以防误删。

业务记录

查看所有客户的业务记录,支持导出。

公共池

公共池

坐席可以在公共池里提取自己需要的客户资料,可以单个提取,也可以勾选批量提取,提取后客户资料直接在坐席的客户资料列表里显示。公共池的资料同样支持导出和删除。如下图所示:

报表统计

通话记录

该统计表记录的是用户所有的通话记录,可听取通话录音,可通过勾选方式或直接点击导出按钮导出通话记录和录音,亦可根据相应条件对通话记录进行查询。呼叫结果记录的是呼出时的失败原因。如下图所示:

时段报表

图形化显示当天每个时段(以小时为单位)的通话量,列表显示每个坐席当天每个时段(以小时为单位)的通话量,支持按本日、昨日、自定义某一天、分机号进行查询,支持导出每个坐席的时段列表数据。

未接来电

未接来电记录了所有呼入未接听的号码记录,坐席可以在这里点击拨号回访。保留号码则是客户呼入IVR转队列时,两次无人接听后则提示客户输入号码登记的号码。如下图所示:

示忙示闲报表

示忙示闲报表统计了每个坐席点击每一个小休示忙的次数以及时长,支持按本日、七日、本月、自定义时间范围、分机号查询。

呼入呼出报表

呼入呼出报表是统计每个坐席呼入呼出的总数、接通数、最大通时、最小通时,支持按本日、本月、自定义时间范围查询。

坐席话务报表

该报表是统计每个坐席每天的话务情况,包括分机号、呼叫总数、通话时长、平均时长、外呼数量、点击外呼数量、分机互打、呼入、呼出、外呼成功数、外呼成功率、呼入成功数、呼入接通率、呼出成功数、呼出成功率,可按分机号和日期的查询,如下图所示:

坐席接听数排名

该报表是以柱状图的形式显示每个坐席每天的呼叫总数,按从多到少的顺序排列;下方列表则是记录每个坐席分机的接听数量,支持导出excel表格。如下图所示:

可查询多天的排名,亦可点击【】下载相应格式的图形报表。

坐席接听时长排名

该报表是以柱状图的形式显示每个坐席每天的呼叫总时长,按从多到少的顺序排列,如下图所示:

可查询多天的排名,亦可点击【】下载相应格式的图形报表。

来电监控

来电统计

来电统计是统计当天呼入到系统里的总数、队列接听数、IVR接听数、分机接听数、分机未接听数,同时以列表和柱状图形式展示,支持按本日、本月、自定义时间范围查询。

来电监控

实时监控来电信息,包含来电号码、来电时间、呼入线路、导航语音、用户按键、队列接听、分机、响铃时间、接听时间,支持大屏监控。

公告管理

公告列表

此模块是提供给每个公司以及部门的管理员发布公告之用,根据适用对象,公告可分为两类,一类是针对整个公司全体成员的公告,另一类则是针对部门的所有坐席人员的公告,如下图所示:

公告发布后,坐席人员可在公告列表里查看新发布的公告,查看后则状态变为已读。

系统设置

客户资料-字段设置

此处为客户资料设置相应的字段信息,固定的11个字段只提供列表显示/隐藏、弹屏显示/隐藏和查询显示/隐藏的状态以及排序的修改,用户可添加自定义字段信息,如下图所示:

业务记录-字段设置

此处为业务记录设置相应的字段信息,系统的4个字段只提供列表显示/隐藏、弹屏显示/隐藏和查询显示/隐藏的状态以及排序的修改,用户可添加自定义字段信息,如下图所示:

特色按键

特色按键

*81  如果坐席人员需要休息或下班时,摘机按键【*81】,话机示忙,该话机则不会再接到呼入电话。

*80  如果坐席人员需要取消示忙,摘机按键【*80】即可。

*83  如果当前通话的客户有意向时,坐席人员可在通话过程中按键【*83】进行标记,标记成功后可在标记客户列表中查看。

*0 如果坐席人员已有分配到的任务号码,摘机按键【*0】,即可拨打我的任务里的第一个未呼叫号码。

*5 坐席人员摘机按键【*5】,即可进入等待队列,进入后:

(1)*0或0 坐席人员可按键【*0】或【0】,拨打我的任务里第一个未呼叫号码;

(2)*7或7 如果当前通话的客户有意向时,坐席人员可通过按键【*7】或【7】,标记当前客户;

(3)*8或8 通话结束后,坐席人员可通过按键【*8】或【8】,播放当前通话的号码;

(4)*9或9 挂断当前通话。

"##+分机号"通话中按健,把当前呼叫转移到其它分机号上

顶部工具栏

(1)快速拨号:分机注册后,在快速拨号栏里输入手机号码,点击【快速拨号】按钮可以快速呼出。

(2)挂机:通话中,点击【挂机】按钮即可挂断当前通话。

(3)示忙/示闲:分机注册后,可以点击【示忙】按钮,进行示忙/示闲操作,示忙后将不再接听呼入通话。

(4)通话保持:通话过程中,点击【通话保持】按钮,进行通话保持,分机挂断,客户会听到等待音乐,再次点击该按钮可以恢复通话。

(5)通话转移:通话过程中,点击【通话转移】按钮,弹出“通话转移”窗口,选择要转移到的坐席,点击【确认】即可将通话转移给所选坐席,所选坐席人员分机振铃后接起即可通话。

(6)服务质检:在通话即将结束时,点击【服务质检】按钮,分机就会挂断,客户会听到邀请评价语音,客户按要求按键进行评价,评价后可以在通话记录查看客户的评价。

操作视频

坐席快速入门

  • 坐席快速入门
# **一、使用场景**

1、工具条输入号码呼叫

2、点呼(点击号码后面的拨号按钮,一健发起呼叫)

3、接听自动外呼电话(开启自动外呼任务后,系统自动呼叫客户,客户接通后转接坐席接听)

4、接听客户来电

二、设备要求

1、电脑配置:

-8G 内存以上、4 核 CPU

-分辨率 1920x1200 及其以上,不能低于 1280x800

2、软件配置:

浏览器:Chrome 浏览器最新版

耳机:带⽿麦的降噪耳机(若使用SIP话机则无需准备耳机)

三、使用流程

四、操作步骤

1、坐席登录呼叫中心系统

操作步骤:

浏览器输入登录地址——确定后进入登录页面——输入公司账号、用户名、密码——登录

登录后页面如下图:

2、坐席登录话务系统

操作步骤:

2.1、点击左边菜单栏“坐席管理”——分机列表——查看分机注册信息(一般开户时会直接提供,坐席也可自行在分机列表查看,若无法查看,则是管理员未给权限)

2.2、安装SIP软电话(如使用SIP话机则跳过该步骤)

第一步:下载eyebeam软件

http://doc.wei-fu.cn/DL/eyebeam.rar

第二步:软件安装

双击 eyeBeam1.5 软件安装包,进行安装。

点击“下一步”

选择“我同意”,点击“下一步”

指定安装路径,通常采用默认的安装目录即可,点击“下一步 ”

创建桌面图标,通常要选择;

创建快速加载图标,通常不选择;

Windows启动时加载程序是指数字电话软终端是否随Windows启动而自动启动,通常不选择;

按照上图选择,点击“下一步”即可

程序开始安装

加载eyeBeam是指立即登录软电话eyeBeam,请选择。

如上图,点击“完成”, 完成安装。

第三步:软件运行

通过 Windows 的 “ 开始 — 〉程序 — 〉对应的程序文件夹( eyeBeam 1.5 ),或点击系统桌面的图标 ,运行 eyeBeam。

输入序列号:电话界面上点击鼠标右键,选择 “ 关于 ” 点击 “ 使用许可”  按钮输入正确的软件许可序列号。

  • 序列号(下面3个任选一个)

FU9E8UQKSFUNY73B2TH4CZB97NFTL4LM5TVR2PGE-6N7MYGH6EKU7WKJKKTNSNSQD FU9E8UQKSFUNY73B2TH4CZB9WNSCYJAUN9S6WH53-92Y39SJJ5C4Z2BXPUYWP2AS4 FU9E8UQKSFUNY73B2TH4CZB9AJ754RX6JTJM45AX-RQTMRQSYNCY48LPDBT247YHP

第四步:软件配置

账号设定:电话界面上点击鼠标右键,选择 “ SIP 帐号设定 ” 进行用户帐号的配置,如图所示:

新建账号:选择 “ 增加 ” 可新建用户帐号, eyeBeam 可根据需要配置多个帐户,每一个帐户填入以下正确信息:

显示名:分机号

用户名:分机号

口令:分机密码

鉴权用户名:分机号

域名:分机的注册地址和端口,中间的冒号必须是英文状态下输入的。

域代理和拨号计划不需要做任何改动,默认即可。

配置完成后,直接点击【确定】按钮,关闭账号配置窗口。

然后点击账号列表右下方的【关闭】按钮,进行分机注册。

账号注册

账号注册成功后,软电话界面会显示“就绪,您的用户名是xxx”,此时就可以开始打电话了。

软电话注册完毕后,显示状态如下图。呼叫中心的话务按钮被点亮,且软电话显示“就绪”。显示此状态时为坐席已在线,可正常外呼或接听。

3、插好耳麦设备

4、正常呼叫

4.1工具条输入号码呼叫

4.2点呼

我的任务模板点呼

SIP话机注册指南

视频演示(以方位话机为例):

如何创建预览式外呼任务

  • 如何创建预览式外呼任务

如何创建自动外呼任务

  • 如何创建自动外呼任务

如何查看通话记录

  • 如何查看通话记录

如何添加客户资料

  • 如何添加客户资料

如何分配客户资料

  • 如何分配客户资料

如何将客户资料转移到公海

  • 如何将客户资料转移到公海

如果从公共池提取客户

  • 如果从公共池提取客户

如何自定义客户字段

  • 如何自定义客户字段

如何查看短信发送记录

  • 如何查看短信发送记录

如何查看分机或修改注册状态

  • 如何查看分机或修改注册状态

如何监控坐席

  • 如何监控坐席

如何进行话后处理时间设置

  • 如何进行话后处理时间设置

如何设置呼叫转移

  • 如何设置呼叫转移

如何进行呼入设置

  • 如何进行呼入设置

如何设置角色系统使用权限

  • 如何设置角色系统使用权限

如何创建部门信息

  • 如何创建部门信息

如何配置挂机短信

  • 如何配置挂机短信

如何添加黑名单

  • 如何添加黑名单

如何进行弹屏的设置

  • 如何进行弹屏的设置

如何修改登录密码

  • 如何修改登录密码

我的任务功能介绍

  • 我的任务功能介绍

项目界面应用功能

  • 项目界面应用功能

项目模板应用功能

  • 项目模板应用功能

网页电话

  • 网页电话

工具下载

批量下载录音工具

1、工具下载地址:http://doc.wei-fu.cn/os/WeiFuNetDown5.0.zip

2、此工具主要适用于蚁巢版本,用于大批量下来录音到本地电脑进行保存。

3、在使用工具前,需要按照要求开放指定数据库的查询权限,请联系我们系统管理员进行开放。

4、数据库查询权限开放后,解压下载好的工具包,点击打开WeiFuNetDown5.0.exe,打开后界面如下:

5、在服务器地址输入对应的蚁巢服务器ip地址,端口默认80,填写公司账号和公司管理员admin的密码,选定查询的时间范围和时长范围,也可以直接输入主叫或被叫,然后点击【查询】按钮,就可以将符合条件的通话记录全部查询出来。如下图所示:

6、查询出结果后,可以直接点击【下载】按钮,就可以将查询出来的所有通话记录的录音下载下来,文件就存放在解压文件夹里的down里。

eyebeam使用手册

  • eyebeam软电话注册分机

第一步:下载eyebeam软件

http://doc.wei-fu.cn/DL/eyebeam.rar

第二步:软件安装

双击 eyeBeam1.5 软件安装包,进行安装。

点击“下一步”

选择“我同意”,点击“下一步”

指定安装路径,通常采用默认的安装目录即可,点击“下一步 ”

创建桌面图标,通常要选择;

创建快速加载图标,通常不选择;

Windows启动时加载程序是指数字电话软终端是否随Windows启动而自动启动,通常不选择;

按照上图选择,点击“下一步”即可

程序开始安装

加载eyeBeam是指立即登录软电话eyeBeam,请选择。

如上图,点击“完成”, 完成安装。

第三步:软件运行

通过 Windows 的 “ 开始 — 〉程序 — 〉对应的程序文件夹( eyeBeam 1.5 ),或点击系统桌面的图标 ,运行 eyeBeam。

输入序列号

在电话界面上点击鼠标右键,选择 “ 关于 ” 点击 “ 使用许可”  按钮输入正确的软件许可序列号。

  • 注册码(下面3个任选一个)

FU9E8UQKSFUNY73B2TH4CZB97NFTL4LM5TVR2PGE-6N7MYGH6EKU7WKJKKTNSNSQD FU9E8UQKSFUNY73B2TH4CZB9WNSCYJAUN9S6WH53-92Y39SJJ5C4Z2BXPUYWP2AS4 FU9E8UQKSFUNY73B2TH4CZB9AJ754RX6JTJM45AX-RQTMRQSYNCY48LPDBT247YHP

第四步:软件配置

账号设定

在电话界面上点击鼠标右键,选择 “ SIP 帐号设定 ” 进行用户帐号的配置,如图所示:

新建账号

选择 “ 增加 ” 可新建用户帐号, eyeBeam 可根据需要配置多个帐户,每一个帐户填入以下正确信息:

显示名:分机号

用户名:分机号

口令:分机密码

鉴权用户名:分机号

域名:分机的注册地址和端口,中间的冒号必须是英文状态下输入的。

域代理和拨号计划不需要做任何改动,默认即可。

配置完成后,直接点击【确定】按钮,关闭账号配置窗口。

然后点击账号列表右下方的【关闭】按钮,进行分机注册。

账号注册

账号注册成功后,软电话界面会显示“就绪,您的用户名是xxx”,此时就可以开始打电话了。

MicroSIP

第一步:下载MicroSIP软件

下载MicroSIP软件:http://doc.wei-fu.cn/os/MicroSIP-3.20.7.exe

第二步:软件安装

双击下载好的exe文件安装包进行安装

选择“中文(简体)”版,然后点“ok”

点击“下一步”

点击“我接受”

点击“下一步”

安装目录可以自定义,也可以选择默认的目录(建议选择默认的目录),然后点击“下一步”

点击“安装”

点击“完成”,打开MicroSIP软电话

第三步:软件配置

点击右上角的倒三角符号,弹出菜单项,选择“添加账号”

弹出添加账号窗口,按照下图中对应信息进行配置:

账号名:分机号

SIP服务器:分机注册地址

用户名:分机号

域名:分机注册地址

登录名:分机号

密码:分机密码

显示名称:分机号

其余项默认即可

配置好信息后,直接点击【保存】,分机开始注册,注册成功后,会在右下角位置显示在线状态,此时就可以开始打电话了。

DND:免打扰

AA:自动应答,开启后,自动接听来电。

注意:在设置里面将呼叫等待功能关闭,否则会两个电话同时进同一个分机

eSpace SoftPhone

  • eSpace SoftPhone软电话注册分机

第一步 下载eSpace SoftPhone安装包

http://doc.wei-fu.cn/DL/eSpaceSoftPhoneSetup.exe

第二步 软件安装

安装包下载下来后,双击下载好的exe文件安装包进行安装

选择简体中文,点击OK

点击“下一步”

点击“我接受”

安装目录可以自定义,也可以选择默认的目录(建议选择默认的目录),然后点击“安装”

安装完成后,可以选择是否在电脑开机时自动启动软电话,然后点击“下一步”

点击“完成”,自动运行软电话

第三步 软电话配置

账号:输入呼叫中心系统的分机号

密码:输入呼叫中心系统的分机密码

勾选自动登录:下次打开软电话时自动注册配置的这个呼叫中心系统分机

然后,打开高级设置,点击“设置”按钮,配置分机的注册地址和端口

配置完地址和端口,点击“确定”,然后隐藏高级设置,点击“登录”按钮,进行分机注册

分机注册成功后,自动跳转至呼叫界面,左下方会提示“您已登录eSpace SoftPhone”,顶部展示注册的分机号以及分机状态。

其他工具

1、putty:http://doc.wei-fu.cn/tools/putty.msi

2、Wireshark-win32-3.6.0.exe:http://doc.wei-fu.cn/tools/Wireshark-win32-3.6.0.exe

x-lite使用手册

第一步:下载x-lite软件:http://doc.wei-fu.cn/DL/X-Lite_5.8.3_102651.exe

第二步:安装x-lite软件。点击打开安装包,到如下界面时,勾选“I accept the terms in the license agreement”,然后点击“Accept”同意安装。

安装路径如下图,全部默认即可。直接点Next

如下图:点Install

点Finish完成安装

双击桌面图标运行X-Lite软件

点击Softphone菜单,打开Account Settings分机信息设置窗口,设置分机信息

Account name:分机号

User ID:分机号

Domain:分机的注册地址和端口,中间的冒号必须是英文状态下输入的。

Password:分机密码

Display name:分机号

Authorization name:分机号

点击OK开始注册分机,如状态为“Available”则注册成功,就可以开始打电话了。

SIP-ANT-PHONE

第一步:下载SIP-ANT-PHONE软电话

下载SIP-ANT-PHONE软电话:http://doc.wei-fu.cn/DL/VIKI-ANT-SIP-1228.zip

第二步:解压软电话压缩包

打开SIP-ANT-PHONE-924.zip压缩包,选中文件夹,解压到默认当前目录下或者选择自定义的目录进行解压。

解压出来后,可以看到软件包里的文件

双击打开VIKI-ANT-SIP.exe,就可以打开软电话的登录界面。

如遇到电脑未安装.NET Framework,则会出现如下提示:

1、需要先安装.NET Framework软件,软件下载地址如下:

http://doc.wei-fu.cn/DL/NET-Framework.exe

2、再安装微软C++运行库 http://doc.wei-fu.cn/os/MicrosoftVC++.zip

第三步:填写登录信息进行登录

打开登录界面,输入蚁巢系统登录地址、公司账号、坐席的用户名和密码,点击登录即可。

登录后,坐席账户下绑定的分机号就会自动注册上,界面上的分机注册状态就是“200-注册成功”。

注册成功后,就可以开始接打电话了。

自动接听:自动应答,开启后,自动接听来电。

示忙:免打扰,与eyebeam一致。

静音:拨打界面上按键静音。

Mac - Telephone软电话配置说明

Telephone是macOS 环境下的一款很方便的 SIP通讯软件,填写上 SIP 注册信息就可以使用Mac在任何有网络的地方进行电话通讯,可以发送语音信号,可以进行呼叫转移。

下载地址:https://apps.apple.com/cn/app/telephone/id406825478?mt=12

1、软件界面和状态显示

下载安装Telephone的首次使用,需要添加账户以配置 SIP 登录信息。注册成功后注册状态会显示为绿色的「Available」。

2、SIP账户配置

咨询呼叫中心的管理人员,获取 SIP 服务器的配置信息,关键信息包括:SIP 服务器、分机号、 分机密码。

为了提高辨识度,通常用户名、分机号、显示名称建议保持一致。

账户添加可以在向导页完成,也可以在 Accounts 中点击 + 号添加,添加完成后记得勾选启 用。

配置完 SIP 服务器记得勾选「Use this account」启用账户,随后就能正常的呼入和呼出。 其他配置保持默认即可。

3、常见问题

首次使用会提示 App 需要访问网络,需要放行,或者在「偏好设置-安全性与隐私」中添加 Telephone,允许其传入连接。

确认配置正确但是一致无法注册成功?

从微信中复制出的密码和地址可能包含不必要的其他格式符号,建议粘贴到纯文本编辑器中重新复制粘贴到软件中。

注册错误的信息如何修改?

可以在 Accounts 账户配置界面去掉「Use this account」的勾选后进行修改,或者点击 – 减号重新添加。

AXB客户端Android使用手册

1、下载app客户端

安卓版本

使用手机浏览器打开下载链接:http://doc.wei-fu.cn/DL/zhiyingxiao.apk

点击【下载】,下载完成后,点击【继续安装】

安装完成后,点击【打开】

app打开后,输入服务器地址(蚁巢的IP+webapp/)

点击【确认】后,app会请求允许电话权限,选择【允许】

接着输入登录账号和密码,点击【登录】

2、完整操作文档下载

http://doc.wei-fu.cn/DL/AXB操作手册V1.0.0.pdf

AXB客户端IOS使用手册

苹果版本

苹果手机在App Store直接搜索“智营销”,获取安装;

安装完成后,打开“智营销”APP,获取权限选择“好”;

修改默认服务器地址,注意不要有空格;

输入用户名和密码,注意大小写和空格;

点击登录,进入主页。

2、AXB外呼

登录成功后,在【我的任务】里点击【拨号】按钮

等待接听,被叫接听后即可通话

通话结束后,可以添加通话标签并备注内容

3、通话记录及录音

通话结束后,点击话单,可以查看通话记录,在线播放及下载录音。

4、完整操作文档下载

http://doc.wei-fu.cn/DL/AXB操作手册V1.0.0.pdf

向日葵远程工具

向日葵下载地址:

https://okzvmao1x.qnssl.com/xiangrikui.exe

常用FAQ

百度下载4.1M、电话呼叫明显--停顿:

百度下载3.1M、电话呼叫明显--停顿:

百度下载124K、电话呼叫明显--好转:

通话卡顿

网络带宽异常影响:

## 百度下载4.1M、电话呼叫明显--停顿:

百度下载3.1M、电话呼叫明显--停顿:

百度下载124K、电话呼叫明显--好转:

部署服务器及网络

服务器及带宽配置推荐

编号 坐席 CPU 内存 硬盘 带宽
1 1-60 2 4 500G 5M
2 60-120 4 8 500G 10M
3 120-300 8 16 1T 25M
4 300-500 16 32 2T 45M
5 500-800 32 64 2T 80M
系统快捷按键说明

*81 摘机按健,当前分机示忙

*80 摘机按健,当前分机示闲

*82 摘机按健,播放呼入到当前分机的最后一个主叫

*83 通话中按健,把对方号码标记到数据库标识表中

*86 摘机按健,播放之前用星83标记的最后一条号码

*87 摘机按健,播放之前用星83标记的最后倒数第二条号码

*88 摘机按健,播放之前用星83标记的最后倒数第三条号码

*841+转移号码 摘机按健,把当前分机设置无条件转移

*842+转移号码 摘机按健,把当前分机设置无应答转移

*843+转移号码 摘机按健,把当前分机设置遇忙转移

*851 摘机按健,把当前分机取消无条件转移

*852 摘机按健,把当前分机取消无应答转移

*853 摘机按健,把当前分机取消遇忙转移

通话中按健##+分机号,把当前呼叫转移到其它分机号上

*8 摘机按健,抢接同队列其他分机电话

得伯乐卡机设置

常见问题FAQ

1、用软电话注册分机时,出现“注册错误:403 - Forbidden”。

可以判断为软电话填写的分机号错误或者分机密码错误,一般会因为手动输入错误、分机密码的大小写不一致、或者复制密码时多了空格造成的,请重新核对填写的分机号、分机密码和系统里给出的一致。

2、用软电话注册分机时,出现“注册错误:408 - Request Timeout”

这是分机注册超时,造成原因有以下几种:

(1)域名里填写的分机注册端口与系统不一致;

(2)域名里填写的冒号是中文状态下输入的;

(3)电脑本地网络环境异常,例如:防火墙拦截IP或udp的6871端口,网络延迟等;

解决方法:

(1)填写的分机注册端口需和系统保持一致,蚁巢版本端口为6871,企呼版V9.0.4版本端口为6871,企航版本端口为5060;

(2)域名里填写的分隔冒号必须是英文状态下输入;

(3)根据电脑所处的本地网络环境进行具体分析。

3、用eyebeam软电话注册分机,软电话上的状态是注册成功了的,但系统里却显示未注册状态。

解决方法:

检查软电话上填写注册信息的界面,域代理这一栏,是否已勾上“向域注册并接受拨入的呼叫”,以及外向通路选择对方域。

4、新部署的蚁巢系统,如果出现呼叫双方听不到对方声音,或者分机互打都没有声音的情况

登录superadmin管理员账号,在【高级设置】>>>【网络设置】里面,配置上当前服务器的公网IP、内网IP以及子网掩码。

配置上了公网IP、内网IP以及子网掩码后,呼叫还是听不到对方声音,则需要判断服务器udp端口是否开放:

如果是云服务器,默认会有安全组策略,需要开放udp端口10000~20000;

如果是机房里的实体服务器,同样需要在所处网络环境里开放udp端口10000~20000。

做完以上设置,呼叫还是听不到对方声音,就得检查线路问题了。

5、如何开启/关闭自动报工号功能

(1)企呼版本,登录admin管理员账号,在【数据配置】>>>【系统设置】里进行开启或关闭,注意,这里的配置需要进行服务器重启才能生效。

(2)企航版本,需用ssh工具连接服务器,修改/etc/asterisk/cdr_mysql_idea.conf配置,修改autoservice自动报工号参数,0为关闭,1为开启,修改完成后,重启软交换。命令如下:

vim /etc/asterisk/cdr_mysql_idea.conf

service asterisk restart

(2)蚁巢标准版本,修改方法与企航版本一致。

(3)蚁巢语音版本,修改位置在superadmin账户下,高级设置>>>高级参数里进行开启和关闭。

6、坐席登录运营版蚁巢,在快速拨号里输入号码,点击提示“呼叫失败”

请检查是否已经用软电话或sip话机注册分机,检查分机状态是否为空闲状态。

7、坐席登录运营版蚁巢,外呼时听到提示“坐席未绑定号码”

请使用公司管理员账号admin,到坐席管理>>>坐席设置里,在号码那一列,选择绑定线路号码。绑定线路号码后如果还是打不通,就跟线路资源问题有关了。

8、在呼入场景或自动外呼场景,坐席分机状态为空闲,却没有电话送到这个空闲坐席上

有以下几个原因会导致这种情况:

(1)坐席分机状态空闲,实际asterisk软交换底层为示忙状态。

处理办法:坐席用软电话摘机拨打*80强制示闲一下,或者由admin管理员在坐席管理>>>分机列表操作强制示闲一下。

(2)分机设置了无条件转移。

处理办法:由admin管理员在系统设置>>>转移设置把这个分机的无条件转移取消。

(3)队列的状态为示忙状态,这种页面无法查到状态。

处理办法:由admin管理员在坐席管理>>>分机列表操作强制示闲一下。

(4)坐席使用的软电话或sip话机开了DND(免打扰)功能,免打扰是软电话和sip话机的功能,所以系统里看到的分机状态依然空闲。

处理办法:关闭软电话或sip话机上的DND免打扰功能。

9、坐席登录运营版蚁巢,接打电话没有来电弹屏

(1)检查坐席所使用的的浏览器是否为谷歌浏览器,如果不是,请安装谷歌浏览器进行使用;

(2)使用谷歌浏览器仍然看不到来电弹屏,请检查浏览器地址栏的最右边是否有拦截提示,如果有,打开拦截提示,允许弹出窗口。

10、当使用microsip软电话时,注册分机出现服务器不可用

处理办法:打开软电话的编辑账号界面,找到透传选项,将其改为UDP即可

11、当使用microsip软电话时,出现多个通话进到同一个分机,如何处理?

处理办法:打开microsip软电话的设置页面,把呼叫等待的勾去掉,关闭呼叫等待功能。

12、通话记录及录音为什么不是挂机后立马显示?

答:通话记录及录音会在最长3分钟内显示出来,因为需要进行报表统计,所以设计了3分钟间隔刷新出来通话记录及录音,避免系统资源消耗过多导致卡顿。

13、运营版蚁巢跑自动外呼任务时,可以切到别的线路上跑吗?

答:可以的。运营版蚁巢在执行自动外呼任务时,需要选择对应的号码组才能执行的,支持选择多个号码组(多条线路)一起跑;所以,如果你目前在跑的任务线路有问题,可以将任务先暂停,然后重新执行,重新选择其他可用线路的号码组就可以了。

14、O口网关对接蚁巢系统,系统上的中继该如何配置?

答:登录蚁巢的superadmin账号,在中继管理里面添加新中继,配置好中继中继账号及密码(对应的是O口网关的端口组或端口配置的账号和密码),中继主叫、外呼主叫保持和中继账号一致就可以,注册地址用dynamic,网关的端口一般默认5060,如果有修改,则改为对应对口。具体请参考下图:

15、运营版蚁巢登录错误次数过多,导致账号锁定,如何处理?

答:登录错误次数过多导致账号锁定的,需要等待5分钟后再进行登录,或者联系管理员修改密码。

16、设置无条件转移时,无法转移到设定的手机号上

处理办法:从以下几点进行检查 (1)确保线路有足够的通道,因为转移时,呼入占一个通道,呼出占一个通道,一共两个通道;

(2)确保线路能够一直打通设定的转移手机号,如果打不通,也是转移不过去的;

(3)确保分机已经用软电话或sip话机注册上了,如果没注册,也是不会转移的。

17、坐席在系统里点击拨号后,软电话或sip话机没有响铃

处理办法:从以下几点进行检查 (1)检查分机是否用软电话或sip话机注册上;

(2)如果系统里分机状态是注册上的,无法调用,有可能是因为网络原因已经掉线了,状态还没有更新过来,可以通过更改软电话和sip话机的分机注册时间,将注册时间改为120秒或90秒;

(3)同一个分机在两处注册,两处注册的分机也是无法调用的,需要将其中一个注册取消,然后自己这边重新注册。

18、运营版蚁巢出现页面点击示忙/示闲,或接口调用示忙/示闲无法成功问题

答:(1)通过superadmin账户登录,在系统工具>>>服务重启里面,点击重启PBX服务。(注意重启时,现有的通话会中断)

(2)如果是自行管理的服务器,ssh连接上服务器,通过netstat命令查看5038端口是否为asterisk进程端口,如果不是,则重启asterisk服务。命令如下:

netstat -anlp | grep 5038 检查5038端口

service asterisk restart 重启asterisk服务

19、呼入时,呼入线路号码为075587654321,听到播报075587654321的声音,通话没有转入坐席分机,自动挂断了。

答:这是入局路由没有设置好,在系统设置>>>入局设置里面,设置入局DID号码为075587654321的入局路由,入局目的可以自定义选择:分机、队列、ivr语音导航、时间条件、结束呼叫都可以。

20、坐席登录运营版蚁巢,有电话呼入时,页面分机状态显示振铃中,坐席的软电话却没有响铃,不能接到电话。

答:这种情况是分机在两处注册造成的,解决办法有两种:

(1)找到另外一处注册这个分机的软电话,将其取消注册,然后自己的分机重新注册下;

(2)修改分机注册密码,重新注册下。

21、坐席的页面分机状态一直处于通话中状态,实际坐席没有通话,无法进行点击拨号。

答:(1)坐席通过点击顶部工具栏的挂机按钮,将其通话通道挂断;

(2)当点击了挂机按钮后,仍然无法转为空闲状态,则联系技术,通过后台将其通道挂断。

asterisk -rx "core show channels concise" |grep 8024 8024为坐席分机号

asterisk -rx "hangup request SIP/202201135969-000195e1" SIP/202201135969-000195e1为查出来的通道

22、运营版蚁巢对接E1网关或者O口网关时,呼叫送不到网关上面。

答:(1)通过superadmin账户登录,在线路管理>>>中继管理里面,找到对应的中继,看它的注册状态是否为已注册;如果是未注册状态,则网关与系统没有对接上,需要检查网关和中继的对应配置。

(2)如果页面上看不到中继的状态,则需要联系技术,从后台查看网关的中继注册状态,具体命令如下:

asterisk -rx "sip show peers"

23、入局路由设置入局目的为队列时,其中一个分机接不到任何电话。

答:(1)通过系统设置>>>队列设置,找到对应的队列,查看队列选择的坐席里面有没有这个分机,如果没有,则选上这个分机重新保存队列配置;

(2)如果分机在队列里,页面状态也是空闲的,通过摘机拨打*80,强制示闲一下,看是否能接到呼入电话;

(3)确认分机有没有设置呼叫转移,转移的号码能否打通。

24、坐席联系过这个手机号,能否在客户回拨时,回到联系过的这个坐席的分机上?

答:可以,在系统设置>>>来电匹配里,开启匹配通话记录,匹配7天内的通话记录。

25、运营版蚁巢是否可以设置话后状态?

答:可以,有两种方式:

(1)通过系统设置>>>话后设置里,开启话后,设定话后时间,则该公司所有坐席都根据设定的时间进行话后示忙,到了时间以后自动取消话后状态;

(2)通过坐席管理>>>坐席设置里,开启弹屏示忙,坐席有来去电弹屏时,自动示忙,关闭弹屏时,自动示闲。

26、队列的欢迎语和ivr导航语音是在哪里上传?有什么格式要求?

答:队列欢迎语和ivr导航语音都是在系统设置>>>系统语音里上传,录音上传后,需要superadmin审核通过后才可以使用。

格式要求:文件如果为wav格式,录音文件的格式必须是PCM编码,单声道,16Bit采样宽度,8000Hz采样率。

27、怎么设置可以让坐席成为组长,可以查看其他坐席的客户资料和通话记录?

答:在坐席管理>>>坐席设置里,选中需要成为组长的账号,编辑该账号的用户等级,使其成为高级就可以了。

标准接口
接口描述

简要描述:

采用 HTTP 的GET方式进行数据传输。在使用接口时,以如下形式 进行调用,返回数据格式为 json字符串,如果需要支持返回跨域请在参数后面加入 callback=xxxxx

请求域名:

  • http://呼叫中心系统IP/

接口说明:

  • 接口采用 http get 模式,请求和响应数据均为 utf-8 编码的 json 格式
  • 响应内容为 json 字符串
  • 请求示例:
http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=keepCalling&exten=801&userName=xxx&passWord=xx xx

userName 参数是云呼配置中的公司账号名

passWord 参数通过获取密钥接口生成。

点击呼叫同步接听

点击呼叫异步接听

获取密钥

获取密钥

该接口生成的密钥用于给各接口中的passWord参数使用。

★★★★★★★★ 联系superadmin获得★★★★★★★★★★★★★★

调用接口 http:// xxx.xxx.xxx.xxx/webAPI/pe.php,生成接口密钥。

调用实例:

http:// xxx.xxx.xxx.xxx/webAPI/pe.php?pass=xxxx&key=xxx
参数 类型 说明
pass string superadmin设置的公司admin账号的密码,需进行 url 编码
key string superadmin设置的公司调用密钥,需进行 url 编码

返回信息:

参数 说明
-1 提交的密码或密钥为空

其它内容查看具体返回值

分机示忙

分机示忙

  • 设置分机示忙标识,若试图呼叫该分机则系统提示分机示忙。

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string setBuys 调用方法
agent string 分机号 需要示忙的分机号

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=setBuys&agent=801&userName=xxx&passWord=xxx

返回信息

参数名 类型 参数值
status boolean true false
msg string 1、示忙失败 2、示忙成
分机示闲

分机示闲

  • 设置分机示闲标识,呼叫该分机恢复正常

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string setIdle 调用方法
agent string 分机号 需要示忙的分机号

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=setIdle&agent=801&userName=xxx&passWord=xxx

返回信息

参数名 类型 参数值
status boolean true false
msg string 1、示忙失败 2、示忙成
来电弹屏

来电弹屏

  • 来电弹屏接口、采用主动查询的方式获取、建议3 秒钟查询1 次

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string popEvent 调用方法
agent string 分机号 需要获取该分机的来电号码记录

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=popEvent&agent=801&userName=xxx&passWord=xxx

返回信息

{
    "status": true,
    "msg": {
        "calla": "810",
        "callb": "18123676919",
        "uid": "1566799335.7853",
        "status": "callout"
    }
}
参数名 类型 参数值
status boolean true false
msg string json字符串
calla string 主叫
callb string 被叫
uid string 通话唯一标识
status string callout 呼出 callin 呼入

根据上返回的信息,我们可构建出自己业务所需要的弹屏页面,如下图: 弹屏界面

通话录音

通话录音

  • 获取当天的录音

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string getRecording 调用方法
uid string 通话唯一标识  

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=getRecording&uid=1566780325.6&userName=xxx&passWord=xxx

返回信息

{
    "status": true,
    "msg": "840-15395530233-20190826-084525-1566780325.6.mp3"
}
参数名 类型 参数值
status boolean true false
msg string 录音名称
强制挂机

强制挂机

  • 将该分机所处通话强行挂断,双方均无提示。若分机不在通话中则操作失败。

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string hangUp 调用方法
agent string 分机 需要挂机的分机号

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=hangUp&agent=801&userName=xxx&passWord=xxx

返回信息

{
    "status": false,
    "msg": "挂机失败"
}
参数名 类型 参数值
status boolean true false
msg string 挂机信息
呼叫转移

呼叫转移

  • 将转出分机号所处通话的另一方转移到转入分机号。转出分机当前通话的另一方播放等待音乐,转出分机提示转接中, 系统对转入分机振铃,转入分机接通后与转出分机当前通话的另一方开始通话,转出分机被挂断。若操作失败或转入 分机未及时接起系统来电则转出分机恢复通话

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string transferCall 调用方法
extenTo string 分机 正在通话的分机
extenFrom string 分机 转移到的分机,必须是空闲状态

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=transferCall&extenTo=801&extenFrom=802&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": "转移成功"
}
参数名 类型 参数值
status boolean true false
msg string

1、转移成功

2、转移失败

3、通道不存在

4、连接 PBX 失败

通话保持

通话保持

  • 该接口将一段通话保持、如 13421829060 呼入工号801,801调用该接口则 13421829060 可以听到一段系统录音、点击恢通话后从新建立通话.
  • 本接口成功后返回的 actionId 节点内容是恢复通话的参数

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string keepCalling 调用方法
exten string 分机 正在通话的分机

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=keepCalling&extenTo=801&extenFrom=802&userName=xxx&passWord=xxxx

返回信息

{
    "status": false,
    "msg": "保持失败"
}
参数名 类型 参数值
status boolean true false
msg string 成功时返回actionId通道号,用于恢复通话
失败时返回

1、保持失败

2、工号不可用

3、连接 PBX 失败

恢复通话

恢复通话

  • 将保持通话的话务状态恢复、恢复通话后从双方重新建立通话

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string restoreCalling 调用方法
agent string 分机 需要恢复通话的分机号
exten string 通道号 使用保持通话时返回的通道号

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=restoreCalling&agent=801&exten=SIP/9070-00000013&userName=xxx&passWord=xxxx

返回信息

{
    "status": false,
    "msg": "通道不存在"
}
参数名 类型 参数值
status boolean true false
msg string 成功时将会恢复通话
失败时返回

1、通道不存在

2、连接 PBX 失败

通话质检

通话质检

  • 通话接口功能类似于 10086 的满意度调查、当客户呼入 801 后调用该接口、则 801 与客户通话结束后、会向客户播放一段 IVR 提示质检

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string callQuality 调用方法
exten string 分机号 正在通话的分机

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=callQuality&exten=801&userName=xxx&passWord=xxxx

返回信息

{
    "status": false,
    "msg": "通道不存在"
}
参数名 类型 参数值
status boolean true false
msg string 成功时对方将会收听到质检语音
失败时返回

1、通道不存在

2、连接 PBX 失败

分机监听

分机监听

  • 系统呼叫监听分机号,接起后可听到被监听分机号所在通话内容。要求被监听分机必须处在通话中。

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string listenCall 调用方法
extenTo string 分机号 正在通话的分机
extenFrom string 分机号 空闲的分机,用于监听使用

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=listenCall&extenTo=801&exten=802&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": "监听成功"
}
参数名 类型 参数值
status boolean true false
msg string

1、监听成功

2、通道不存在

3、连接 PBX 失败

通话强插

通话强插

  • 该功能可以让调用者强行插入一个正在进行的通话中。如 801 和 802 在通话,当 803 强行插入 802 的时候、802 可以和 803 通话、也可以和 801 通话、但是 801 不能和 803 通话

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string forceInsert 调用方法
extenTo string 分机号 正在通话的分机
extenFrom string 分机号 空闲的分机

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=forceInsert&extenTo=801&extenFrom=802&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": "强插成功"
}
参数名 类型 参数值
status boolean true false
msg string

1、强插成功

2、通道不存在

3、连接 PBX 失败

通话强踢

通话强踢

  • 将正在通话的双方断开。

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string kickOff 调用方法
exten string 分机号 正在通话的分机

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=kickOff&exten=801&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": "强踢成功"
}
参数名 类型 参数值
status boolean true false
msg string

1、强踢成功

2、通道不存在

3、连接 PBX 失败

批量获取录音

批量获取录音

  • 批量获取录音

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string getReordingFilesList 调用方法
agent string 分机号  

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=getReordingFilesList&agent=801&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": "录音文件"
}
参数名 类型 参数值
status boolean true false
msg string 录音文件
无条件转移

无条件转移

  • 设置分机无条件转移号码

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string cfPhone 调用方法
exten string 分机号  
phone string 转移号码  

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=cfPhone&exten=801&phone=13800138000&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": "设置成功"
}
参数名 类型 参数值
status boolean true false
msg string 设置成功、失败
无应答转移

无应答转移

  • 设置分机无应答情况下转移到号码上接听

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string cfuPhone 调用方法
exten string 分机号  
phone string 转移号码  

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=cfuPhone&exten=801&phone=13800138000&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": "设置成功"
}
参数名 类型 参数值
status boolean true false
msg string 设置成功、失败
遇忙转移

遇忙转移

  • 设置分机示忙条件下转移到号码上接听

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string cfbPhone 调用方法
exten string 分机号  
phone string 转移号码  

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=cfbPhone&exten=801&phone=13800138000&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": "设置成功"
}
参数名 类型 参数值
status boolean true false
msg string 设置成功、失败
清除转移功能

清除转移功能

-清除转移功能

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string delPhone 调用方法
exten string 分机号  

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=delPhone&exten=801&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": "设置成功"
}
参数名 类型 参数值
status boolean true false
msg string 设置成功、失败
获取单条通话记录

获取单条通话记录

  • 通过uid获取单条通话记录。

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string getRecodeByUID 调用方法
uid string uid 通话记录中的 unqueid 或是弹屏中的 uid
date string 格式:2017-10-02  

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=getRecodeByUID&date=2019-10-14 09:03:55&uid=1571015035.10&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": {
        "calldate": "2019-10-14 09:03:55",
        "src": "857",
        "dst": "13557312308",
        "duration": "70",
        "billsec": "24",
        "disposition": "ANSWERED",
        "amaflags": "4",
        "uniqueid": "1571015035.10",
        "tag": "0",
        "userfield": "audio:857-13557312308-20191014-090355-1571015035.10-cdbrx.mp3",
        "ring_start": "2019-10-14 09:03:55",
        "answer_time": "2019-10-14 09:04:41",
        "ring_end": "2019-10-14 09:04:41",
        "exten_ring": 46,
        "hangup_time": "2019-10-14 09:05:05",
        "province": "广西",
        "city": "南宁市"
    }
}
参数名 类型 参数值
status boolean true false
msg string 通话记录
∟calldate string 呼叫时间
∟src string 主叫
∟dst string 被号
∟duration string 总时长(单位:秒)
∟billsec string 通话时长(单位:秒)
∟disposition string 接听状态,ANSWERED 已经接听,NO ANSWER 未接听,FAILED 呼叫失败
∟amaflags string 状态标签,0 自动外呼,1 点击外呼,2 分机互打,3 呼入,4 呼出
∟uniqueid string 唯一标识
∟userfield string 录音文件
∟answer_time string 分机应答时间
∟hangup_time string 挂机时间
∟exten_ring string 分机振铃时长(单位:秒)
∟ring_start string 振铃开始时间
∟ring_end string 振铃结束时间
∟province string 省份
∟city string 城市
获取分机状态

获取分机状态

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string getExtenStatus 调用方法
agent string 分机

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=getExtenStatus&agent=801&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": {
        "extension": "8002",
        "status": "4",
        "ut": "1691078646",
        "dnd": "1",
        "dnd_type": "",
        "work_no": "",
        "call_after": 0
    }
}
参数名 类型 参数值
status boolean true false
msg string
∟extension string 分机
∟status string 分机状态 0 空闲 1 通话中 4未注册 8震铃
∟dnd string 示忙状态 1示忙中 0非示忙
∟dnd_type string 示忙类型
∟work_no string 工号
∟ut string 更新时间
获取多个分机状态

获取多个分机状态

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string getAllExtenStatus 调用方法
agent string 分机

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=getAllExtenStatus&agent=801&userName=xxx&passWord=xxxx

返回信息

{"status":true,"msg":"[{\"extension\":\"8001\",\"status\":\"0\",\"dnd\":\"0\",\"dnd_type\":\"\",\"work_no\":\"\",\"ut\":\"1685503237\"},{\"extension\":\"8002\",\"status\":\"4\",\"dnd\":\"0\",\"dnd_type\":\"\",\"work_no\":\"\",\"ut\":\"1685437399\"},{\"extension\":\"8003\",\"status\":\"4\",\"dnd\":\"0\",\"dnd_type\":\"0\",\"work_no\":\"\",\"ut\":\"1685365343\"}]"}
参数名 类型 参数值
status boolean true false
msg string
∟extension string 分机
∟status string 分机状态 0 空闲 1 通话中 4未注册 8震铃
∟dnd string 示忙状态 1示忙中 0非示忙
∟work_no string 工号
∟ut string 更新时间
获取所有用户

获取所有用户

使用流程

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string getCompanyUsers 调用方法

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=getCompanyUsers&userName=xxx&passWord=xxxx

返回信息

{
    "status":true,
    "msg":[
        {
            "username":"wx8036",
            "password":"8efbdfa284eb4c68eac6a5a7d277997e",
            "extension":"8036",
            "dnd":"0",
            "status":"4"
        },
        {
            "username":"wx8037",
            "password":"8efbdfa284eb4c68eac6a5a7d277997e",
            "extension":"8037",
            "dnd":"0",
            "status":"4"
        }
    ]
}
参数名 类型 参数值
status boolean true false
msg string
∟username string 用户名
∟password string 用户密码密文
∟extension string 分机号
∟status string 分机状态 0 空闲 1 通话中 4未注册 8震铃
∟dnd string 示忙状态 1示忙中 0非示忙
获取录音文件-getMonitorByUniquid

获取录音文件-getMonitorByUniquid

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string getMonitorByUniquid 调用方法
uniquid string 通话唯一标识  
calldate string "Y_m_d" 格式化,如:2018_12_06

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=getMonitorByUniquid&uniquid=1595897341.19&calldate=2020_7_28&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": "monitor/szptdb/2020-07/28/6009-13343072528-20200728-084902-1595897341.19-szptdb.mp3"
}
参数名 类型 参数值
status boolean true false
msg string 录音文件

说明

录音文件可使用如下格式调用播放 http://xxx.xxx.xxx.xxx/monitor/userName/2018-12/06/801-18219103020-20181206-191627-1544094979.16.mp3

获取录音(定制-需要验证)

获取录音流-getCallVoiceFile

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string getCallVoiceFile 调用方法
uniqueid string 通话唯一标识 通话记录中可获取
userfield string 语音文件名称 通话记录中可获取到

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=getCallVoiceFile&userName=xxxx&passWord=xxxx&uniqueid=1596694833.0&userfield=audio:801-18219103020-20200806-142035-1596694833.0-tc.mp3

成功返回信息

语音文件文件流

失败返回信息

参数名 类型 参数值
status boolean true false
status bool true/false
msg string 失败信息说明

说明

如果验证成功并文件存在,将输出文件流

普通点击呼叫异步接听(不返回uniqueid)

普通点击呼叫异步接听(不返回uniqueid)

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string OnClickCall 调用方法
exten string 分机号 需要发起呼叫的分机号
toTel string 号码 需要进行呼叫的号码

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=OnClickCall&exten=801&toTel=13800138000&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": ""
}
参数名 类型 参数值
status boolean true false
msg string 呼叫成功、呼叫失败
普通点击呼叫同步接听(返回uniqueid)

普通点击呼叫同步接听(返回uniqueid)

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string OnClickCallUniqueid 调用方法
exten string 分机号 需要发起呼叫的分机号
toTel string 号码 需要进行呼叫的号码
actionId string 用户业务标签 用户业务标签

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=OnClickCallUniqueid&exten=801&toTel=13800138000&actionId=&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": ""
}
参数名 类型 参数值
status boolean true false
msg string 呼叫成功、呼叫失败
uniquid string 会话标识
action string 用户业务标签
隐藏点击拨号异步接听(不返回uniqueid)

隐藏点击拨号异步接听(不返回uniqueid)

☆☆☆ 隐藏点击拨号的录音文件的号码也是隐藏的

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string OnClickCallHide 调用方法
exten string 分机号 需要发起呼叫的分机号
toTel string 号码 需要进行呼叫的号码

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=OnClickCallHide&exten=801&toTel=13800138000&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": ""
}
参数名 类型 参数值
status boolean true false
msg string 呼叫成功、呼叫失败
隐藏点击拨号同步接听(返回uniqueid)

隐藏点击拨号同步接听(返回uniqueid)

☆☆☆ 隐藏点击拨号的录音文件的号码也是隐藏的

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string OnClickCallHideUniqueid 调用方法
exten string 分机号 需要发起呼叫的分机号
toTel string 号码 需要进行呼叫的号码
actionId string 用户业务标签 用户业务标签

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=OnClickCallHideUniqueid&exten=801&toTel=13800138000&actionId=&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": ""
}
参数名 类型 参数值
status boolean true false
msg string 呼叫成功、呼叫失败
uniquid string 会话标识
action string 用户业务标签
点击呼叫异步接听(手机回拨不返回uniqueid)

点击呼叫异步接听(手机回拨不返回uniqueid)

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string OnClickCallLocal 调用方法
exten string 分机号 需要发起呼叫的分机号
toTel string 号码 需要进行呼叫的号码
actionId string 用户业务标签
myPhone string 号码 发起调用者的号码

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=OnClickCallLocal&exten=801&toTel=13800138000&myPhone=18219103021&actionId=c9527&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": ""
}
参数名 类型 参数值
status boolean true false
msg string 呼叫成功、呼叫失败
uniquid string 会话标识
action string 用户业务标签
点击呼叫同步接听(手机回拨返回uniqueid)

点击呼叫同步接听(手机回拨返回uniqueid)

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string OnClickCallLocalUniqueid 调用方法
exten string 分机号 需要发起呼叫的分机号
toTel string 号码 需要进行呼叫的号码
actionId string 用户业务标签
myPhone string 号码 发起调用者的号码

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=OnClickCallLocalUniqueid&exten=801&toTel=13800138000&myPhone=18219103021&actionId=c9527&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": ""
}
参数名 类型 参数值
status boolean true false
msg string 呼叫成功、呼叫失败
uniquid string 会话标识
action string 用户业务标签
回拨接口定制版-发起呼叫

回拨接口定制版-发起呼叫

该接口为特定客户进行的定制版,非标准提供的功能。 主要解决了原手机回拨会产生两条记录的情况

接口地址

GET/webAPI/viki_OnClickCallBack.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string OnClickCallBack 调用方法
phone string 客户电话 -
myPhone string 号码 发起调用者的号码
actionId string 用户业务标签 -

系统将先呼叫phone接通后再进行呼叫myPhone。

请求示例

http://xxx.xxx.xxx.xxx/webAPI/viki_OnClickCallBack.php?model=OnClickCallBack&phone=13800138000&myPhone=18219103021&actionId=c9527&userName=xxx&passWord=xxxx

返回信息

{
    "status": true,
    "msg": "",
	"session":"",
	"action":""
}
参数名 类型 参数值
status boolean true false
msg string 呼叫成功、呼叫失败
session string 会话标识
action string 用户业务标签
回拨接口定制版-获取记录

回拨接口定制版-获取记录

通过上面接口返回的sessionsession获取通话记录

接口地址

GET/webAPI/viki_OnClickCallBack.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string getRecodeBySession 调用方法
session string 会话标识 参考上一个接口返回的session
date string 呼叫的日期 -

请求示例

http://xxx.xxx.xxx.xxx/webAPI/viki_OnClickCallBack.php?model=getRecodeBySession&session=67595556056560e835c43874e5bec4b7&date=2020-05-09&userName=xxx&passWord=xxxx

返回信息

返回内容与接口获取单条通话记录一致

批量查询通话记录

批量查询通话记录

接口地址

GET/webAPI/getCallRecords.php

参数:

参数名 是否必须 类型 参数值 说明
model string getList 例:getList,调用方法,该参数为固定值
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
page string 第几页 例:1 ,默认第1页
rows string 每页多少条 例:20,默认20条
sidx string 排序字段 例:calldate,默认 时间字段,可用字段: calldate、src、dst、billsec、disposition、addtime
sord string 排序方式 例:desc,默认倒序,可用参数 desc / asc
extenRand string 分机范围 例:803,804,805 ,默认空,多个分机使用 英文逗号','分割
stime string Y-m-d H:i:s 开始时间,默认 当天xxxx-xx-xx 00:00:00
etime string Y-m-d H:i:s 结束时间,默认 当天xxxx-xx-xx 23:59:59
src string 主叫号码
dst string 被叫号码
billsec1 string 最短通话时长 例:5,默认为空,单位为秒
billsec2 string 最长通话时长 例:100,默认为空,单位为秒
disposition string 通话状态 例:ANSWERED , 默认为空,可用参数 ANSWERED->已接听 / NO ANSWER->未接听
amaflags string 通话类型 例:1 ,默认为空,可用参数 0->自动外呼 / 1->点击外呼 / 2->分机互打 / 3->手动呼入 / 4->手动呼出
tag string 是否已质检 例:1,默认为空,可用参数 0->未质检 / 1->已质检

请求示例

http://xxx.xxx.xxx.xxx/webAPI/getCallRecords.php?model=getList&userName=xxxx&passWord=xxxxx&page=1&rows=20&sidx=calldate&sord=desc&src=&dst=
// 最基础的访问Url => http://xxx.xxx.xxx.xxx/webAPI/getCallRecords.php?model=getList&userName=xxxx&passWord=xxxxx , 其他参数,有需要就传,没需要可以不传,不传的时候,后台使用默认值

返回信息

无接通
{
    "status": true,
    "msg": "success",
    "total": 1,            // 总页数
    "records": 1,         // 总条数
    "rows": [
        {
			"amaflags": "4"
			"answer_stamp": "2023-08-19 11:56:19"
			"billsec": "00:00:26"
			"calldate": "2023-08-19 11:56:10"
			"disposition": "ANSWERED"
			"dst": "1345xxxxx32"
			"src": "8036"
			"tag": ""
			"uniqueid": "xx-xx-xx-xx-xx-x-xx"
			"userfield": "http://vs01.wei-fu.cn/monitor/xx/2023-08/19/xx-xx-xx-xx-xx-xx-xx.wav"
}
    ]
}


参数名 类型 参数值
status boolean true false
msg string success
∟calldate string 呼叫时间
∟answer_stamp string 接听时间
∟src string 主叫
∟dst string 被号
∟billsec string 通话时长(单位:秒)
∟disposition string 接听状态,ANSWERED 已经接听,NO ANSWER 未接听,FAILED 呼叫失败
∟amaflags string 状态标签,0 自动外呼,1 点击外呼,2 分机互打,3 呼入,4 呼出
∟uniqueid string 唯一标识
∟userfield string 录音文件
∟tag string 按键
隐藏点击拨号异步接听(自定义隐藏格式)

隐藏点击拨号异步接听(自定义隐藏格式)

☆☆☆ 支持在软电话或实体话机上自定义号码隐藏格式

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string OnClickCallHideMiddle 调用方法
exten string 分机号 需要发起呼叫的分机号
toTel string 号码 需要进行呼叫的号码
actionId string 用户业务标签
displayPhone string 自定义隐藏格式 如果不传值,则默认以手机号中间四位为*号隐藏;
如果传值为11位的参数,则在软电话或实体话机上显示该参数值。

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=OnClickCallHideMiddle&exten=8001&toTel=13800138000&actionId=561336&userName=xxx&passWord=xxxx&displayPhone=1380013****

返回信息

{
    "status": true,
    "msg": ""
}
参数名 类型 参数值
status boolean true false
msg string 呼叫成功、呼叫失败
action string 用户业务标签
隐藏点击拨号同步接听(自定义隐藏格式)

隐藏点击拨号同步接听(自定义隐藏格式)

☆☆☆ 支持在软电话或实体话机上自定义号码隐藏格式

接口地址

GET/webAPI/webHttpAPI.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
model string OnClickCallHideUniqueidMiddle 调用方法
exten string 分机号 需要发起呼叫的分机号
toTel string 号码 需要进行呼叫的号码
actionId string 用户业务标签
displayPhone string 自定义隐藏格式 如果不传值,则默认以手机号中间四位为*号隐藏;
如果传值为11位的参数,则在软电话或实体话机上显示该参数值。

请求示例

http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=OnClickCallHideUniqueidMiddle&exten=8001&toTel=13800138000&actionId=561336&userName=xxx&passWord=xxxx&displayPhone=1380013****

返回信息

{
    "status": true,
    "msg": ""
}
参数名 类型 参数值
status boolean true false
msg string 呼叫成功、呼叫失败
uniquid string 会话标识
action string 用户业务标签
未接来电查询

批量查询通话记录

接口地址

GET/webAPI/MissCall.php

参数:

参数名 是否必须 类型 参数值 说明
model string getList 例:getList,调用方法,该参数为固定值
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
page string 第几页 例:1 ,默认第1页
rows string 每页多少条 例:20,默认20条
sidx string 排序字段 例:calldate,默认 时间字段,可用参数
sord string 排序方式 例:desc,默认倒序,可用参数 desc / asc
stime string Y-m-d H:i:s 开始时间,默认 当天xxxx-xx-xx 00:00:00
etime string Y-m-d H:i:s 结束时间,默认 当天xxxx-xx-xx 23:59:59
mobileHidden string 是否号码隐藏 例:1,默认为0,可用参数 0->不隐藏 / 1-> 隐藏

请求示例

http://xxx.xxx.xxx.xxx/webAPI/MissCall.php?model=getList&userName=xxxx&passWord=xxxxx&page=1&rows=20&sidx=calldate&sord=desc&mobileHidden=1

返回信息

{
    "total": 16,            // 总页数
    "records": 306,         // 总条数
    "rows": [
        {
			calldate: "2022-08-16 16:05:48"
			dst: "8405"  // 被叫
			encry_src: "eb7c79c2fee905182a299c6f31d62d94"  // 主叫密文
			isVisit: "2"    //  1已回访 2未回访
			outtime: null   //  回访时间
			src: "199****0162"  // 主叫
			status: "1"  //1未回复,2已回复
			uniqueid: "1660637148.127293" //cdr的回复电话记录的uniqueid
        }
    ]
}
参数名 类型 参数值
status boolean true false
msg string 通话记录
rows string json数据
∟calldate string 呼叫时间
∟dst string 被号
∟src string 主叫
∟encry_src string 主叫密文
∟isVisit string 回访状态 1已回访 2未回访
∟outtime string 回访时间
∟status string 状态标签,1未回复,2已回复
∟uniqueid string 唯一标识
自动外呼(高级)- 按步骤如下

简要描述:

外呼任务接口,可创建标准外呼任务、智能自动外呼任务。

接口调用形式

简要描述:

本接口支持POST或GET两种传递参数方式

请求域名:

  • http://[IP]/auto_call_api/

说明:

  • 该接口与标准接口参数形式不同,请认真查看每个接口参数内容。
  • [IP]是呼叫中心系统的Ip地址。在实际调用接口时,请替换为真实地址。
  • 接口内的username、password的内容均为明文。
返回状态及错误码

【例如:{"status":"200","msg":null,"data":null}】

编号 状态 说明
1 200 成功
2 400 用户名不能为空
3 401 密码不能为空
4 402 公司登录名不能为空
5 403 用户名或密码错误
6 404 公司code不存在
7 405 模板ID不能为空
8 406 任务名称不能为空
9 407 呼叫系数不能为空
10 408 任务ID不能为空
11 409 任务不存在
12 410 手机号码不能为空
获取任务模板

获取任务模板

  • 获取已存在系统中的任务模板。

接口地址

GET/auto_call_api/getTaskTemplate.php

参数:

参数名 是否必须 类型 参数值 说明
username string 用户名
password string 密码
company_code string 公司编号  

请求示例

http://[ip]/auto_call_api/getTaskTemplate.php?username=admin&password=test&company_code=test

返回信息

{
    "status": "200",
    "msg": null,
    "data": [
        {
            "id": "69",
            "project_name": "自动外呼接口测试",
            "relay_num": "2019101401/1574668631",
            "project_extensions": "874",
            "queue_name": "90167",
            "mobile_sum": "0",
            "called_sum": "0",
            "task_num": "0",
            "is_del": "0",
            "call_max": "1",
            "welcomid": null,
            "qrecord": null
        }
    ]
}
参数名 类型 参数值
status boolean 状态码
msg string 消息
data array 数据
-id array 序号
-project_name string 模板名称
-project_extensions string 项目成员,分机列表用”,”隔开
-relay_num string 呼叫线路
-queue_name string 队列名称
-mobile_sum string 号码总数
-called_sum string 已呼叫总数
-task_num string 任务总数
-is_del string 是否被删除 0 未删除 1已删除
-call_max string 最大呼叫数
-welcomid string 欢迎语ID
-qrecord string 队列背景音
获取任务列表

获取任务列表

  • 获取任务列表,包含标准外呼任务和智能外呼任务。

接口地址

GET/auto_call_api/getTaskList.php

参数:

参数名 是否必须 类型 参数值 说明
username string 用户名
password string 密码
company_code string 公司编号  
stime string 创建时间起始 格式 2018-12-10%2010:00:00
etime string 创建时间结束 格式 2018-12-10%2013:43:33

请求示例

http://[ip]/auto_call_api/getTaskList.php?username=admin&password=test&company_code=test

返回信息

{
    "status": "200",
    "msg": null,
    "data": [
        {
            "id": "210",
            "project_id": "69",
            "project_name": "自动外呼接口测试",
            "company_id": "8",
            "task_name": "test",
            "task_type": "queue",
            "create_time": "2019-11-25 15:57:50",
            "task_status": "ready",
            "call_max": "1",
            "task_cortrol_type": "g",
            "task_override": "1.00",
            "task_loss_ceiling": "0",
            "queue_name": "90167",
            "task_callerid": "2019101401",
            "count": "2",
            "success": "0",
            "loss": "0",
            "fail": "0",
            "calling": "0"
        }
    ]
}
参数名 类型 参数值
status boolean 状态码
msg string 消息
data array 数据
-id string 任务序号
-project_id string 模板序号
-project_name string 模板名称
-company_id string 公司序号
-task_name string 任务名称
-task_type string 呼叫类型queue表示群呼
-create_time string 创建时间
-task_status string 任务状态 run 、 stop 、 push 、finish,对应运行,停止,暂停,已完成
-call_max string 最大并发数
-task_cortrol_type string 控制方式(g普通),(i智能),(ai高级智能)
-task_override string 呼叫系数 在自动外呼的模式下:呼叫总数=空闲坐席*呼叫系数
-task_loss_ceiling string 呼损
-queue_name string 队列名称
-task_callerid string 呼出主叫
-count string 总号码数
-success string 成功呼叫数
-loss string 呼损数
-fail string 呼叫失败数
-calling string 呼叫中数
创建标准外呼任务

创建标准外呼任务

  • 创建标准外呼任务,返回任务id序号
  • 标准外呼任务,不管坐席空闲数、按照设置的最大值不断呼叫。

接口地址

GET/auto_call_api/getTaskAdd.php

参数:

参数名 是否必须 类型 参数值 说明
username string 用户名
password string 密码
company_code string 公司编号  
template_id number 模板id
task_name string 任务名称  

请求示例

http://[ip]/auto_call_api/getTaskAdd.php?username=admin&password=test&company_code=test&template_id=6&task_name=123

返回信息

{
    "status": "200",
    "msg": "211",
    "data": null
}
参数名 类型 参数值
status boolean 状态码
msg string 任务id
创建智能外呼任务

创建标准外呼任务

  • 创建标准外呼任务,返回任务id序号
  • 智能外呼任务,根据坐席空闲数比例外呼、如1:2。

接口地址

GET/auto_call_api/getAiTaskAdd.php

参数:

参数名 是否必须 类型 参数值 说明
username string 用户名
password string 密码
company_code string 公司编号  
template_id number 模板id  
task_name string 任务名称  
task_override number 呼叫系数  

请求示例

http://[ip]/auto_call_api/getAiTaskAdd.php?username=admin&password=test&company_code=test&template_id=6&task_name=123&task_override=3

返回信息

{
    "status": "200",
    "msg": "212",
    "data": null
}
参数名 类型 参数值
status boolean 状态码
msg string 任务id
提交任务号码

提交任务号码

  • 上传号码到任务中,以备呼叫。
  • 请注意,该接口必须是POST表单方式

接口地址

POST/auto_call_api/postTaskPhones.php

参数:

参数名 是否必须 类型 参数值 说明
username string 用户名
password string 密码
company_code string 公司编号  
task_id string 任务id  
phones string 多个号码之间用英文逗号分隔  

请求示例

http://[ip]/auto_call_api/postTaskPhones.php

返回信息

{
    "status": "200",
    "msg": "成功"
}
参数名 类型 参数值
status boolean 状态码
任务控制

任务控制

  • 任务控制,启动任务呼叫、暂停任务呼叫等操作。

接口地址

GET/auto_call_api/getTaskAction.php

参数:

参数名 是否必须 类型 参数值 说明
username string 用户名
password string 密码
company_code string 公司编号  
task_id string 任务id  
action string 控制指令,
del,run,push,stop,分别对应删除,运行,暂停,停止
 

请求示例

http://[ip]/auto_call_api/getTaskAction.php?username=admin&password=test&company_code=test&task_id=19&action=stop

返回信息

{
    "status": "200",
    "msg": "stop",
    "data": null
}
参数名 类型 参数值
status boolean 状态码
msg string 返回当前控制指令
获取任务列表号码

获取任务列表号码

  • 获取该任务的号码。

接口地址

GET/auto_call_api/getTaskPhonesList.php

参数:

参数名 是否必须 类型 参数值 说明
username string 用户名
password string 密码
company_code string 公司编号  
task_id string 任务id序号  
phone string 号码  
stime string 号码的增加时间 格式 2018-12-02%2020:15:27
etime string 号码的增加时间 格式 2018-12-02%2022:15:27
page string 起始页 默认1  
row number 页数 默认20  

请求示例

http://[ip]/auto_call_api/getTaskPhonesList.php?username=admin&password=test&company_code=test&task_id=210

返回信息

{
    "status": true,
    "msg": "",
    "data": {
        "num": "1",
        "list": [
            {
                "0": "6",
                "id": "6",
                "1": "18219103022",
                "mobile": "18219103022",
                "call_status": "0",
                "3": null,
                "call_time": null,
                "4": "0",
                "call_billsec": "0",
                "5": null,
                "call_uniqueid": null,
                "6": null,
                "extension": null,
                "7": null,
                "action_id": null,
                "8": "0",
                "ring_time": "0",
                "9": "0",
                "qstime": "0",
                "10": "0",
                "qs": "0",
                "11": "",
                "recoding": "",
                "12": "2019-11-25 16:24:33",
                "addtime": "2019-11-25 16:24:33",
                "13": "0",
                "del": "0",
                "14": "0",
                "cust_id": "0",
                "15": "69",
                "project_id": "69",
                "16": "210",
                "task_id": "210",
                "17": "10",
                "cust_task_id": "10"
            }
        ],
        "page": 1,
        "row": 20
    }
}
参数名 类型 参数值
status boolean 状态码
msg string 消息
data array 数据
-num string 数量,如果查无数据为0
-list array 数据集
--id array 记录序号
--mobile string 手机号码
--call_status string 呼叫状态,0未呼叫、1呼叫成功、2待回访、3呼叫失败、4呼叫中
--call_time string 呼叫时间
--call_billsec string 通话时长
--call_uniqueid string 通话标识
--extension string 接听坐席或者队列
--ring_time string 振铃时长
--qstime string 队列振铃时长
--recoding string 录音文件
--addtime string 添加时间
自动外呼(ims版)- 按步骤如下

简要描述:

外呼任务接口,可创建标准外呼任务、智能自动外呼任务。

ims版接口调用形式

简要描述:

本接口支持POST或GET两种传递参数方式

请求域名:

  • http://[IP]/auto_call_api/

说明:

  • 该接口与标准接口参数形式不同,请认真查看每个接口参数内容。
  • [IP]是呼叫中心系统的Ip地址。在实际调用接口时,请替换为真实地址。
  • 接口内的username、password的内容均为明文。
ims版返回状态及错误码

【例如:{"status":"200","msg":null,"data":null}】

编号 状态 说明
1 200 成功
2 400 用户名不能为空
3 401 密码不能为空
4 402 公司登录名不能为空
5 403 用户名或密码错误
6 404 公司code不存在
7 405 模板ID不能为空
8 406 任务名称不能为空
9 407 呼叫系数不能为空
10 408 任务ID不能为空
11 409 任务不存在
12 410 手机号码不能为空
ims版获取任务模板

获取任务模板

  • 获取已存在系统中的任务模板。

接口地址

GET/auto_call_api/getTaskTemplate.php

参数:

参数名 是否必须 类型 参数值 说明
username string 用户名
password string 密码
company_code string 公司编号  

请求示例

http://[ip]/auto_call_api/getTaskTemplate.php?username=admin&password=test&company_code=test

返回信息

{
    "status": "200",
    "msg": null,
    "data": [
        {
            "id": "69",
            "project_name": "自动外呼接口测试",
            "relay_num": "2019101401/1574668631",
            "project_extensions": "874",
            "queue_name": "90167",
            "mobile_sum": "0",
            "called_sum": "0",
            "task_num": "0",
            "is_del": "0",
            "call_max": "1",
            "welcomid": null,
            "qrecord": null
        }
    ]
}
参数名 类型 参数值
status boolean 状态码
msg string 消息
data array 数据
-id array 序号
-project_name string 模板名称
-project_extensions string 项目成员,分机列表用”,”隔开
-relay_num string 呼叫线路
-queue_name string 队列名称
-mobile_sum string 号码总数
-called_sum string 已呼叫总数
-task_num string 任务总数
-is_del string 是否被删除 0 未删除 1已删除
-call_max string 最大呼叫数
-welcomid string 欢迎语ID
-qrecord string 队列背景音
ims版获取任务列表

获取任务列表

  • 获取任务列表,包含标准外呼任务和智能外呼任务。

接口地址

GET/auto_call_api/getTaskList.php

参数:

参数名 是否必须 类型 参数值 说明
username string 用户名
password string 密码
company_code string 公司编号  
stime string 创建时间起始 格式 2018-12-10%2010:00:00
etime string 创建时间结束 格式 2018-12-10%2013:43:33

请求示例

http://[ip]/auto_call_api/getTaskList.php?username=admin&password=test&company_code=test

返回信息

{
    "status": "200",
    "msg": null,
    "data": [
        {
            "id": "210",
            "project_id": "69",
            "project_name": "自动外呼接口测试",
            "company_id": "8",
            "task_name": "test",
            "task_type": "queue",
            "create_time": "2019-11-25 15:57:50",
            "task_status": "ready",
            "call_max": "1",
            "task_cortrol_type": "g",
            "task_override": "1.00",
            "task_loss_ceiling": "0",
            "queue_name": "90167",
            "task_callerid": "2019101401",
            "count": "2",
            "success": "0",
            "loss": "0",
            "fail": "0",
            "calling": "0"
        }
    ]
}
参数名 类型 参数值
status boolean 状态码
msg string 消息
data array 数据
-id string 任务序号
-project_id string 模板序号
-project_name string 模板名称
-company_id string 公司序号
-task_name string 任务名称
-task_type string 呼叫类型queue表示群呼
-create_time string 创建时间
-task_status string 任务状态 run 、 stop 、 push 、finish,对应运行,停止,暂停,已完成
-call_max string 最大并发数
-task_cortrol_type string 控制方式(g普通),(i智能),(ai高级智能)
-task_override string 呼叫系数 在自动外呼的模式下:呼叫总数=空闲坐席*呼叫系数
-task_loss_ceiling string 呼损
-queue_name string 队列名称
-task_callerid string 呼出主叫
-count string 总号码数
-success string 成功呼叫数
-loss string 呼损数
-fail string 呼叫失败数
-calling string 呼叫中数
ims版创建标准外呼任务

创建标准外呼任务

  • 创建标准外呼任务,返回任务id序号
  • 标准外呼任务,不管坐席空闲数、按照设置的最大值不断呼叫。

接口地址

GET/auto_call_api/getTaskAdd.php

参数:

参数名 是否必须 类型 参数值 说明
username string 用户名
password string 密码
company_code string 公司编号  
template_id number 模板id
task_name string 任务名称  

请求示例

http://[ip]/auto_call_api/getTaskAdd.php?username=admin&password=test&company_code=test&template_id=6&task_name=123

返回信息

{
    "status": "200",
    "msg": "211",
    "data": null
}
参数名 类型 参数值
status boolean 状态码
msg string 任务id
ims版创建智能外呼任务

创建标准外呼任务

  • 创建标准外呼任务,返回任务id序号
  • 智能外呼任务,根据坐席空闲数比例外呼、如1:2。

接口地址

GET/auto_call_api/getAiTaskAdd.php

参数:

参数名 是否必须 类型 参数值 说明
username string 用户名
password string 密码
company_code string 公司编号  
template_id number 模板id  
task_name string 任务名称  
task_override number 呼叫系数  

请求示例

http://[ip]/auto_call_api/getAiTaskAdd.php?username=admin&password=test&company_code=test&template_id=6&task_name=123&task_override=3

返回信息

{
    "status": "200",
    "msg": "212",
    "data": null
}
参数名 类型 参数值
status boolean 状态码
msg string 任务id
ims版提交任务号码

提交任务号码

  • 上传号码到任务中,以备呼叫。
  • 请注意,该接口必须是POST表单方式

接口地址

POST/auto_call_api/postTaskPhones.php

参数:

参数名 是否必须 类型 参数值 说明
username string 用户名
password string 密码
company_code string 公司编号  
task_id string 任务id  
phones string 多个号码之间用英文逗号分隔  

请求示例

http://[ip]/auto_call_api/postTaskPhones.php

返回信息

{
    "status": "200",
    "msg": "成功"
}
参数名 类型 参数值
status boolean 状态码
ims版获取号码组列表

获取号码组列表

  • 获取号码组列表。

接口地址

GET/auto_call_api/getGroupList.php

参数:

参数名 是否必须 类型 参数值 说明
username string 用户名
password string 密码
company_code string 公司编号  
name string 号码组名称
stime string 创建时间起始 格式 2018-12-10%2010:00:00
etime string 创建时间结束 格式 2018-12-10%2013:43:33

请求示例

http://[ip]/auto_call_api/getGroupList.php?username=admin&password=test&company_code=test

返回信息

{
	"status":"200",
	"msg":null,
	"data":[
		{
			"id":"25",
			"name":"演示",
			"addtime":"2022-04-29 14:33:56",
			"mobiles":[
				{
					"mobile":"02863212738",
					"extension":"8001"
				}
			]
		}
	]
}
参数名 类型 参数值
status boolean 状态码
msg string 消息
data array 数据
-id string 号码组序号
-name string 号码组名称
-addtime string 号码组添加时间
-mobiles string 号码组里的号码数据
--mobile string 号码
--extension string 号码属于的分机
ims版任务控制

任务控制

  • 任务控制,启动任务呼叫、暂停任务呼叫等操作。

接口地址

GET/auto_call_api/getTaskAction.php

参数:

参数名 是否必须 类型 参数值 说明
username string 用户名
password string 密码
company_code string 公司编号  
task_id string 任务id  
action string 控制指令,
del,run,push,stop,分别对应删除,运行,暂停,停止
 
group_ids string 号码组id,
action 为 run 时,group_ids为必传,action 为 del,push,stop ,group_ids不传
 

请求示例

http://[ip]/auto_call_api/getTaskAction.php?username=admin&password=test&company_code=test&task_id=19&action=stop&group_ids=25

返回信息

{
    "status": "200",
    "msg": "stop",
    "data": null
}
参数名 类型 参数值
status boolean 状态码
msg string 返回当前控制指令
ims版获取任务列表号码

获取任务列表号码

  • 获取该任务的号码。

接口地址

GET/auto_call_api/getTaskPhonesList.php

参数:

参数名 是否必须 类型 参数值 说明
username string 用户名
password string 密码
company_code string 公司编号  
task_id string 任务id序号  
phone string 号码  
stime string 号码的增加时间 格式 2018-12-02%2020:15:27
etime string 号码的增加时间 格式 2018-12-02%2022:15:27
page string 起始页 默认1  
row number 页数 默认20  

请求示例

http://[ip]/auto_call_api/getTaskPhonesList.php?username=admin&password=test&company_code=test&task_id=210

返回信息

{
    "status": true,
    "msg": "",
    "data": {
        "num": "1",
        "list": [
            {
                "0": "6",
                "id": "6",
                "1": "18219103022",
                "mobile": "18219103022",
                "call_status": "0",
                "3": null,
                "call_time": null,
                "4": "0",
                "call_billsec": "0",
                "5": null,
                "call_uniqueid": null,
                "6": null,
                "extension": null,
                "7": null,
                "action_id": null,
                "8": "0",
                "ring_time": "0",
                "9": "0",
                "qstime": "0",
                "10": "0",
                "qs": "0",
                "11": "",
                "recoding": "",
                "12": "2019-11-25 16:24:33",
                "addtime": "2019-11-25 16:24:33",
                "13": "0",
                "del": "0",
                "14": "0",
                "cust_id": "0",
                "15": "69",
                "project_id": "69",
                "16": "210",
                "task_id": "210",
                "17": "10",
                "cust_task_id": "10"
            }
        ],
        "page": 1,
        "row": 20
    }
}
参数名 类型 参数值
status boolean 状态码
msg string 消息
data array 数据
-num string 数量,如果查无数据为0
-list array 数据集
--id array 记录序号
--mobile string 手机号码
--call_status string 呼叫状态,0未呼叫、1呼叫成功、2待回访、3呼叫失败、4呼叫中
--call_time string 呼叫时间
--call_billsec string 通话时长
--call_uniqueid string 通话标识
--extension string 接听坐席或者队列
--ring_time string 振铃时长
--qstime string 队列振铃时长
--recoding string 录音文件
--addtime string 添加时间
AI任务外呼
接口说明

简要描述:

采用 HTTP 的GET方式进行数据传输。在使用接口时,以如下形式 进行调用,返回数据格式为 json字符串,如果需要支持返回跨域请在参数后面加入 callback=xxxxx

请求域名:

  • http://系统IP/

接口说明:

  • 接口采用 http get 模式,请求和响应数据均为 utf-8 编码的 json 格式
  • 响应内容为 json 字符串
  • 请求示例:
http://xxx.xxx.xxx.xxx/aiAPI/xxx.php

userName 参数是云呼配置中的公司账号名

passWord 参数通过获取密钥接口生成。

获取秘钥

获取密钥

该接口生成的密钥用于给各接口中的passWord参数使用。

★★★★★★★★ 联系superadmin获得★★★★★★★★★★★★★★

调用接口 http:// xxx.xxx.xxx.xxx/aiAPI/lib/pe.php,生成接口密钥。

调用实例:

http:// xxx.xxx.xxx.xxx/aiAPI/lib/pe.php?pass=xxxx&key=xxx
参数 类型 说明
pass string superadmin设置的公司admin账号的密码,需进行 url 编码
key string superadmin设置的公司调用密钥,需进行 url 编码

返回信息:

参数 说明
-1 提交的密码或密钥为空

其它内容查看具体返回值

获取AI话术接口

获取AI话术列表

  • 获取AI话术列表

接口地址

POST/aiAPI/getAiTalks.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成

请求示例

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
	"userName":"XXXX",
	"passWord":"XXXXXX",
}

参数说明

{
    "info": "获取话术成功!",
    "status": true,
    "data": [
        {
            "id": "1",
            "name": "xxx"
        },
        {
            "id": "2",
            "name": "xxx1"
        },
        {
            "id": "3",
            "name": "xxx5"
        },
        {
            "id": "4",
            "name": "xxx9"
        }
    ]
}

返回信息说明

参数名 类型 参数值
status boolean 状态码
info string 返回信息
data array 数据
∟id string 话术编号
∟name string 话术名称
获取AI意图筛选接口

获取AI意图筛选接口

  • 获取AI意图筛选接口

接口地址

POST/aiAPI/getAiClassification.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
talkid string 话术编号id 通过接口【获取AI话术接口】获得

请求示例

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
	"userName":"XXXX",
	"passWord":"XXXXXX",
	"talkid":"1",
}

参数说明

{
    "info": "获取分类数据成功!",
    "status": true,
    "data": [
        {
            "id": "1",
            "name": "分类名称1"
        },
        {
            "id": "2",
            "name": " 分类名称2"
        },
        {
            "id": "3",
            "name": "分类名称3"
        }
    ]
}

返回信息说明

参数名 类型 参数值
status boolean 状态码
info string 返回信息
data array 数据
∟id string 意图分类编号
∟name string 意图分类名称
获取AI线路

获取AI线路

  • 获取AI线路

接口地址

POST/aiAPI/getAiCallLine.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成

请求示例

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
	"userName":"XXXX",
	"passWord":"XXXXXX",
}

参数说明

{
    "info": "获取AI线路成功!",
    "status": true,
    "data": [
        {
            "gateway": "viki_strd", // 线路名称(创建AI任务接口中,选择外呼线路时传递的就是这个值)
            "from_user": "202302020101"
        }
    ]
}

返回信息说明

参数名 类型 参数值
status boolean 状态码
info string 返回信息
data array 数据
∟gateway string 线路名称(创建AI任务接口中,选择外呼线路时传递的就是这个值)
∟from_user string 线路编号,只用于显示
获取AI转接选项

获取AI转接选项

  • 获取AI转接选项

接口地址

POST/aiAPI/getAiTransfer.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成

请求示例

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
	"userName":"XXXX",
	"passWord":"XXXXXX",
}

参数说明

{
    "info": "获取AI线路成功!",
    "status": true,
    "data": [
        {
            "code": "11678332200", // 转接唯一值(创建AI任务接口中,选择转接设置时传递的就是这个值)
            "name": "转xx队列"
        },
		{
            "code": "11678332201",
            "name": "转xx1队列"
        }
    ]
}

返回信息说明

参数名 类型 参数值
status boolean 状态码
info string 返回信息
data array 数据
∟code string 转接唯一值(创建AI任务接口中,选择转接设置时传递的就是这个值)
∟name string 转接的配置名称,用于显示
获取AI语音包

获取AI语音包

  • 获取AI语音包

接口地址

POST/aiAPI/getAiVoicePackage.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
talkid string 话术编号id 通过接口【获取AI话术接口】获得

请求示例

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
	"userName":"XXXX",
	"passWord":"XXXXXX",
	"talkid":"1",
}

参数说明

{
    "info": "获取语音包数据成功!",
    "status": true,
    "data": [
        {
            "id": "1",
            "name": "语音包名1"
        },
        {
            "id": "2",
            "name": "语音包名2"
        },
        {
            "id": "3",
            "name": "语音包名3"
        }
    ]
}

返回信息说明

参数名 类型 参数值
status boolean 状态码
info string 返回信息
data array 数据
∟id string 语音包ID
∟name string 语音包名称
获取AI任务最大并发数

获取AI任务最大并发数

  • 获取AI任务最大并发数

接口地址

POST/aiAPI/getAiConcurrent.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成

请求示例

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
	"userName":"XXXX",
	"passWord":"XXXXXX",
}

参数说明

{
    "info": "获取任务最大并发数成功!",
    "status": true,
    "data": "10"  //最大并发数(在调用创建AI任务时,并发数不能大于该数量)
}

返回信息说明

参数名 类型 参数值
status boolean 状态码
info string 返回信息
data string 最大并发数(在调用创建AI任务时,并发数不能大于该数量)
获取AI任务列表

获取AI任务列表

  • 获取AI任务列表

接口地址

POST/aiAPI/getAiTask.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
taskName string 任务名称 任务名称
taskStatus string 任务状态 任务状态 ready(就绪) 、 run(运行中)、 push(暂停中) 、stop(完成)
stime string 任务创建开始时间 如:2023-02-10 09:35:23
etime string 任务创建结束时间 如:2023-02-10 14:35:23

请求示例

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
	"userName":"XXXX",
	"passWord":"XXXXXX",
	"taskName":"测试",
	"taskStatus": "stop",
	"stime":"2023-02-10 09:35:23",
	"etime":"2023-06-30 14:35:23"
}

参数说明

{
    "info": "获取数据成功!",
    "status": true,
    "data": [
        {
            "id": "250",
            "task_name": "测试1",
            "start_time": "09:00",
            "end_time": "22:00",
            "sleep_stime": "12:00",
            "sleep_etime": "14:00",
            "task_status": "stop",
            "create_time": "2023-03-28 17:17:57"
        },
        {
            "id": "256",
            "task_name": "数据中心测试任务",
            "start_time": "09:00",
            "end_time": "23:00",
            "sleep_stime": "12:00",
            "sleep_etime": "14:00",
            "task_status": "stop",
            "create_time": "2023-03-31 17:45:20"
        },
        {
            "id": "259",
            "task_name": "测试任务",
            "start_time": "09:00",
            "end_time": "18:00",
            "sleep_stime": "12:00",
            "sleep_etime": "12:01",
            "task_status": "stop",
            "create_time": "2023-04-21 12:14:25"
        }
    ]
}

返回信息说明

参数名 类型 参数值
status boolean 状态码
info string 返回信息
data array 数据
∟id string 任务序号
∟name string 任务名称
∟start_time string 允许外呼开始时间,24小时制 如:09:00
∟end_time string 允许外呼结束时间,24小时制 如:23:00
∟sleep_stime string 休息开始时间,24小时制 如:12:00
∟sleep_etime string 休息结束时间,24小时制 如:14:00
∟create_time string 任务创建时间
-task_status string 任务状态 ready(就绪) 、 run(运行中)、 push(暂停中) 、stop(完成)
获取AI任务话术变量

获取AI任务话术变量

  • 获取该任务话术的变量

接口地址

POST/aiAPI/getAiTaskVariable.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
taskId string 任务id 通过接口【AI任务列表】获取

请求示例

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
	"userName":"XXXX",
	"passWord":"XXXXXX",
	"taskId":"284",
}

返回信息

{
    "status": false,
    "info": "任务ID不能为空!",
    "data": []
}
{
    "status": false,
    "info": "任务不存在或已被删除!",
    "data": []
}
{
    "status": false,
    "info": "AI应用配置错误,请联系管理员!",
    "data": []
}
{
    "status": false,
    "info": "变量获取失败!",
    "data": []
}
{
    "status": false,
    "info": "任务没有变量!",
    "data": []
}
{
    "status": true,
    "info": "成功获取变量",
    "data": {
        "姓名": "xxxxx",
        "尊称": "xxxxx",
        "学校名称": "xxxxx"
    }
}

返回信息说明

参数名 类型 参数值
status boolean 状态码
info string 返回信息
data string 返回json格式数据,格式为 { "变量名称1":"xxx(待填写变量值1)","变量名称2":"xxx(待填写变量值2)" ,"变量名称3":"xxx(待填写变量值3)" }
创建AI任务

添加AI任务

  • 添加AI任务
  • 请注意,该接口必须是POST方式 ,数据为json格式

接口地址

POST/aiAPI/addAiTask.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
taskName string 任务名称 任务名称
nluProjectId string 话术编号id 通过接口【获取AI话术接口】获得
roleId string 意图编号id 通过接口【获取AI意图筛选接口】获得
trunkId string 线路编号id 通过接口【获取AI线路】获得
transferId string 转接选项编号id 通过接口【获取AI转接选项】获得
voiceId string 语音包编号id 通过接口【获取AI语音包】获得
concurrency string 默认值为:0 任务并发数
startTime string 24小时制 如:09:00 外呼开始时间
endTime string 24小时制 如:23:00 允许外呼结束时间
sleepStime string 24小时制 如:12:00 休息开始时间
sleepEtime string 24小时制 如:14:00 休息结束时间
isBusy string 0 关闭 1开启;默认值为:0 是否开启坐席全忙暂停任务
failCall string 0 关闭 1 开启;默认值为:0 是否开启任务重呼
callCount string 重呼次数 重呼次数
failTime string 单位秒 重呼时间间隔

请求示例

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
	"userName":"wfwl",
	"passWord":"cc332bedede66a5a659272fc4c86751cee35e646d6ff25079cadc645d30c46df",
	"taskName":"任务名称",
	"nluProjectId":"14",
	"roleId":"52",
	"trunkId":"qiognqi_bg_20220888",
	"transferId":"11678332203",
	"voiceId":"",
	"concurrency":"5",
	"startTime":"09:00",
	"endTime":"23:00",
	"sleepStime":"12:00",
	"sleepEtime":"14:00",
	"isBusy":"1",
	"failCall":"1",
	"callCount":"10",
	"failTime":"6"
}

返回信息

{
    "info": "任务名称不能为空!",
    "status": false,
    "data": []
}
{
    "info": "话术名称不能为空!",
    "status": false,
    "data": []
}
{
    "info": "线路不能为空!",
    "status": false,
    "data": []
}
{
    "info": "运行开始时间不能为空!",
    "status": false,
    "data": []
}
{
    "info": "运行结束时间不能为空!",
    "status": false,
    "data": []
}
{
    "info": "休息开始时间不能为空!",
    "status": false,
    "data": []
}
{
    "info": "休息结束时间不能为空!",
    "status": false,
    "data": []
}
{
    "info": "任务并发数不能小于0!",
    "status": false,
    "data": []
}
{
    "info": "任务并发数不能大于总并发数!",
    "status": false,
    "data": []
}
{
    "info": "任务名称已存在!",
    "status": false,
    "data": []
}
{
    "info": "任务创建成功!",
    "status": true,
    "data": {
        "id": "288"
    }
}

参数名 类型 参数值
status boolean 状态码
info string 返回信息
data json  
∟id string 任务ID
AI任务追加号码数据

AI任务追加号码

  • 把号码数据提交到现有的任务,进行任务呼叫
  • 请注意,该接口必须是POST表单方式

接口地址

POST/aiAPI/addToAiTaskPhones.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
taskId string 任务id 通过接口【AI任务列表】获取
repeat int 是否去重 1 否,2 去重;默认值为 2 去重
filtrate int 是否黑名单过滤 1 否,2 去重;默认值为 2 去重
phones array 号码集合 每次请求最多传递 1000 个号码
∟phone string 外呼号码  
∟variable string 外呼变量值 外呼变量值,格式为 { "变量名称1":"变量值1","变量名称2":"变量值2" };例如:{ "企业名称":"某某公司", "客户姓名":"张三", "性别":"先生" } ,备注:其中‘变量名称’与 变量数量 根据机器人话术填写

请求示例

Accept: application/json
Content-Type: application/josn;charset=utf-8
{			
	"userName":"wfwl",
	"passWord":"xxxxx",
	"taskId":"284",
	"phones":[
		{
			"phone":"13590189001",
			"variable":{"姓名":"xx","尊称":"xx","学校名称":"xx"}
		},
		{
			"phone":"13590189002",
			"variable":{"姓名":"xx","尊称":"xx","学校名称":"xx"}
		}
	]
}

返回信息

{
    "info": "数据追加成功!",
    "status": true,
    "data": {
	"badNum": 1,
	"badMobile": [
		{
			"mobile": "13590189001",
			"variable": {"姓名": "xx","尊称": "xx","学校名称": "xx"}
		}
	],
	"repeatNum": 1,
	"repeatMobile": [
		{
			"mobile": "13590189002",
			"variable": {"姓名": "xx","尊称": "xx","学校名称": "xx"}
		}
	],
	"filtrateNum": 1,
	"filtrateMobile": [
		{
			"mobile": "13590189149",
			"variable": {"姓名": "xx","尊称": "xx","学校名称": "xx"}
		}
	],
	"sussNum": 2,
	"totalNum": 5
    }
}
参数名 类型 参数值
status boolean 状态码
info string 返回信息
data array  
∟badNum int 非法号码的数量
∟badMobile array 非法号码清单
∟repeatNum int 号码重复的数量
∟repeatMobile array 重复号码清单
∟sussNum int 追加成功的数量
∟filtrateNum int 号码黑名单过滤的数量
∟filtrateMobile array 号码黑名单过滤的清单
∟totalNum int 号码的总数量
AI任务开启/暂停

操作AI任务

  • 可以对指定的AI任务进行开启或者暂停的操作

接口地址

POST/aiAPI/doAiTask.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
taskId string 任务id 通过接口【AI任务列表】获取
type string 操作类型 run(开启)、 push(暂停)

请求示例

Accept: application/json
Content-Type: application/josn;charset=utf-8
{			
	"userName":"wfwl",
	"passWord":"xxxxx",
	"taskId":"284",
	"type":"push"
}
{			
	"userName":"wfwl",
	"passWord":"xxxxx",
	"taskId":"284",
	"type":"run"
}

返回信息

{
    "info": "操作成功!",
    "status": true,
    "data": []
}
参数名 类型 参数值
status boolean 状态码
info string 返回信息
data json  
获取AI任务详情

获取AI任务详情

  • 获取该任务的所有号码明细情况

接口地址

POST/aiAPI/getAiTaskDetail.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
taskId int 任务ID 通过接口【AI任务列表】获取
mobile string 外呼号码 外呼号码
call_status string 呼叫状态,取值:0(未呼叫);1(呼叫中);2(呼叫成功);3(呼叫失败);5(接口错误) 呼叫状态
call_stime string 通话结束时长:2023-06-10 00:00:00 通话结束时长
call_etime string 呼叫结束时间:2023-06-30 14:00:00 呼叫结束时间
call_sbillsec string 通话开始时长:5 通话开始时长
call_ebillsec string 通话结束时长:30 通话结束时长
remarks string 备注 备注
variable string 变量 变量
all_intent_label string 所有命中标签 所有命中标签
transferred string 是否转接人工 0 否 1是 是否转接人工
page_size string 每页条数 每页条数
page string 页码 页码

请求示例

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
	"userName":"XXXX",
	"passWord":"XXXXXX",
	"taskId":"284",
}

参数说明

{
    "info": "获取数据成功!",
    "status": true,
    "data": {
        "list": [
            {
                "mobile": "13590189150",
                "call_billsec": "0",
                "call_status": "3",
                "create_time": "2023-06-29 19:31:02",
                "call_time": "2023-06-30 11:10:06",
                "anwser_time": "0000-00-00 00:00:00",
                "hangup_time": "2023-06-30 11:10:06",
                "zmrh_core_uuid": "api-8b806c2e-16f3-11ee-a0ed-00163e0aa13b",
                "remarks": null,
                "variable": {
                    "姓名": "苏工",
                    "尊称": "先生",
                    "学校名称": "深圳大学"
                },
                "call_num": "1",
                "gateway_name": "viki_strd",
                "all_intent_label": null,
                "rules_class": null,
                "transferred": "0",
                "transf_num": null,
                "transf_type": null,
                "transf_billsec": "0",
                "uniqueid": ""
            },
            {
                "mobile": "13590189149",
                "call_billsec": "0",
                "call_status": "3",
                "create_time": "2023-06-29 19:31:02",
                "call_time": "2023-06-30 11:10:06",
                "anwser_time": "0000-00-00 00:00:00",
                "hangup_time": "2023-06-30 11:10:06",
                "zmrh_core_uuid": "api-8b8159f4-16f3-11ee-b64c-00163e0e1a40",
                "remarks": null,
                "variable": {
                    "姓名": "苏工",
                    "尊称": "先生",
                    "学校名称": "深圳大学"
                },
                "call_num": "1",
                "gateway_name": "viki_strd",
                "all_intent_label": null,
                "rules_class": null,
                "transferred": "0",
                "transf_num": null,
                "transf_type": null,
                "transf_billsec": "0",
                "uniqueid": ""
            }
        ],
        "page": {
            "count": "10",
            "page": "5",
            "page_size": "2"
        }
    }
}

返回信息说明

参数名 类型 参数值
status boolean 状态码
info string 返回信息
data json 数据
∟list json 详细数据
∟∟mobile string 外呼号码
∟∟call_billsec string 通话时长(秒))
∟∟call_status string 呼叫状态:0(未呼叫);1(呼叫中);2(呼叫成功);3(呼叫失败);5(接口错误)
∟∟create_time string 添加时间
∟∟call_time string 呼叫时间
∟∟anwser_time string 接听时间
∟∟hangup_time string 挂机时间
∟∟zmrh_core_uuid string 挂机时间
∟∟remarks string 备注
∟∟variable string 变量
∟∟call_num string 呼叫次数
∟∟gateway_name string 线路名称
∟∟all_intent_label string 所有命中标签
∟∟rules_class string 命中意图及意图标签
∟∟transferred string 是否转接人工 0 否 1是
∟∟transf_num string 转接分机号/队列号
∟∟transf_type string 转接类型 1 坐席 2队列
∟∟transf_billsec string 转接的接听时长
∟∟uniqueid string 转接人工后关联通话记录的唯一标志
∟page json 分页明细
∟∟count int 记录总数
∟∟page int 当前页数
∟∟page_size int 每页条数
AI挂机回调推送

简要描述:

  • 挂机回调

回调地址:

设置回调地址,支持HTTP,HTTPS两种请求 数据请求为 POST 表单方式

请求示例:

** 部分字段含有汉字需要Unicode转换 **

{
	"zmrh_core_uuid": "api-16e648a6-b7e5-11ed-b953-00163e0e1a40",
	"task_id": "1",
	"table_id": "1",
	"mobile": "13800138001",
	"call_billsec": "12",
	"call_status": "2",
	"call_time": "2023-05-23 10:47:07",
	"call_monitor": "http://ai_record.wei-fu.cn/record_seesion/2023-05/23/api-16e648a6-b7e5-11ed-b953-00163e0e1a40.wav",
	"anwser_time": "2023-05-23 10:47:14",
	"hangup_time": "2023-05-23 10:47:26",
	"variable": {
		"企业名称": "某某金融",
		"客户姓名": "李某某",
		"性别": "女士",
	},
	"all_intent_label": "方便,同意",
	"rules_class": "同意还款",
	"transferred": "0",
	"transf_type": "",
	"transf_num": "",
	"transf_billsec": ""
}

返回参数说明:

参数名 类型 说明
zmrh_core_uuid string 会话唯一值
task_id string 任务ID
table_id string 号码ID
task_id int 呼叫号码ID
mobile string 手机号码
call_billsec string 通话时长,单位秒
call_status string 呼叫状态,2:成功,3:失败
call_time datetime 呼叫时间
call_monitor string 录音地址
anwser_time datetime 接听时间
hangup_time datetime 挂机时间
task_mark string 流程标签
taskflag string 意图标签
anwser_time calldate 呼叫应答时间
hangup_time calldate 挂机时间
variable string 名单变量、根据上传内容
all_intent_label string 所有命中的标签,多个以英文逗号“,”隔开
rules_class string 命中的分类名称
transferred string 是否转接 0:未转接,1:转接
transf_type string 转接类型,1:坐席,2:队列
transf_num string 转接的队列号或坐席号
transf_billsec string 转接的通话时长
获取AI对话详情

获取AI对话详情

  • 获取AI对话详情

接口地址

POST/aiAPI/getAiDialogue.php

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 通过获取密钥接口生成
calltime string 呼叫时间 时间格式:"2023-06-22 10:29:21"
zmrh_core_uuid string 会话唯一值 在AI挂机回调,或者获取AI任务详情中可以获取到

请求示例

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
	"userName":"XXXX",
	"passWord":"XXXXXX",
	"calltime":"2023-06-22 10:29:21",
	"calltime":"api-16e648a6-b7e5-11ed-b953-00163e0e1a40",
}

返回信息

{
	"info": "获取AI线路成功!",
    "status": true,
	"data": [{
		"addtime": "2023-02-08 14:10:42",
		"nlu_project_id": "5",
		"recording_files": "http://xx.xx.xx/monitor/xxx-xxx-xxx-xxx-xxx/5/recod/default/2023-02-08/xxx/5_63_55.wav",
		"speak_role": "AI",
		"zmrh_appid": "xx-xx-xxx-xxx-900a7e1ad4d5",
		"zmrh_core_uuid": "api-xx-xx-xxx-xxxx-00163e09d63e",
		"display": "您好,请问是{客户姓名}{性别}吗?",
		"main_id": "63",
		"hangup": "0",
		"t_nlp_time":"120"
	}, {
		"addtime": "2023-02-08 14:10:48",
		"nlu_project_id": "5",
		"recording_files": "http://xxx.xxx.xxx/monitor/xxxx-xxx-xx-xxx-xxxx/5/monitor/2023-02-08/xxxx/0.wav",
		"speak_role": "human",
		"zmrh_appid": "xxx-xxxx-xxx-xxx-900a7e1ad4d5",
		"zmrh_core_uuid": "api-xxx-xxx-xxx-xxx-xxx",
		"display": "嗯,是的。",
		"key_worlds": "嗯/,/是的/。",
		"hit": "是的",
		"count_weight": "1",
		"node_class": "0",
		"intent_label": "已提醒",
		"t_asr":"456",
		"t_record":"2345"
	}]
}

返回参数

参数名 类型 参数值
status boolean 状态码
info string 返回信息
data array 数据
∟addtime datetime 添加时间
∟nlu_project_id string 话术ID
∟recording_files string 录音地址
∟speak_role string 角色, AI:机器人 human:用户
∟zmrh_appid string appid
∟display string 内容
∟zmrh_core_uuid string 呼叫唯一标识
∟main_id string 节点ID (AI对话独有)
∟hangup string 是否挂机 0:否 1:是(AI对话独有)
∟t_nlp_time string NLP响应时长,单位毫秒(AI对话独有)
∟key_worlds string 分词(用户对话独有)
∟hit string 击中分词(用户对话独有)
∟count_weight string 权重(用户对话独有)
∟node_class string 节点类型(用户对话独有)
∟intent_label string 意图标记(用户对话独有)
∟t_asr string ASR响应时长,单位毫秒(用户对话独有)
∟t_record string 用户录音,单位毫秒(用户对话独有)
CRM接口
获取客户资料字段

获取客户资料字段

  • 获取客户资料列表所配置的字段

接口地址

POST/webAPI/crm.php?model=getCrmFields

接口说明:

  • 接口采用 json + http 模式,请求和响应数据均为 utf-8 编码的 json 格式
  • 请求内容包含:请求消息体
  • 响应内容为 json 字符串

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 在标准接口中 获取密钥接口 生成

请求示例

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
    "userName": "xxx",
    "passWord": "xxx"
}

返回信息

参数名 类型 参数值
status boolean 接口响应状态 true false
msg string 文字说明
data list 数据集
data.value string 字段名
data.name string 字段中文名称
data.type string 字段类型,char:字符型 time:时间格式型(“2022-09-12 12:23:34”) select:下拉单选型
data.option list 当字段类型为select型时才有的参数,里面包含的是下拉的选项值

返回实例

{
    "status": true,
    "msg": "获取成功",
    "data": [
        {
            "value": "custXM",
            "name": "姓名",
            "type": "char"
        },
        {
            "value": "mobile",
            "name": "手机号",
            "type": "char"
        },{
            "value": "sex",
            "name": "性别",
            "type": "select",
            "option": [
                {
                    "id": "1",
                    "name": "男"
                },
                {
                    "id": "2",
                    "name": "女"
                }
            ]
        },
        {
            "value": "custyysj",
            "name": "预约时间",
            "type": "time"
        }
    ]
}
添加客户资料

添加客户资料

  • 添加客户资料接口

接口地址

POST/webAPI/crm.php?model=addCrmData

接口说明:

  • 接口采用 json + http 模式,请求和响应数据均为 utf-8 编码的 json 格式
  • 请求内容包含:请求消息体
  • 响应内容为 json 字符串

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 在标准接口中 获取密钥接口 生成
data list 数据集 需要添加的客户资料数据,单次请求最大不能超过1000条

请求示例

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
    "userName": "xxx",
    "passWord": "xxx",
	"data":[{
				"mobile": "13800138000",
				"custXM": "客户1",
				"sex": "1",
				"custyysj": "2022-09-21 12:00:00"
			}, {
				"mobile": "13800138002",
				"custXM": "客户2",
				"sex": "2",
				"custyysj": "2022-09-22 10:00:00"
			}]
}

请求参数 data 说明:

  • 上面的请求参数的 data 中 key 为 获取客户资料字段 接口返回的,数量和值必须保持一致,顺序不做要求,如果不一致,将无法保存

返回信息

参数名 类型 参数值
status boolean 接口响应状态 true false
msg string 文字说明
data list 数据集
data.count string 保存成功的数量
data.info string 如果有未添加成功的,这里输出未成功原因

返回实例

{
    "status": true,
    "msg": "添加成功",
    "data": {
            "count": "2",
			"info": ""
        }
}
查询客户资料

查询客户资料

  • 查询客户资料

接口地址

POST/webAPI/crm.php?model=getCrmList

接口说明:

  • 接口采用 json + http 模式,请求和响应数据均为 utf-8 编码的 json 格式
  • 请求内容包含:请求消息体
  • 响应内容为 json 字符串

参数:

参数名 是否必须 类型 参数值 说明
userName string 公司账号名 公司账号名
passWord string 密码 在标准接口中 获取密钥接口 生成
mobile string 手机号查询 支持模糊查询

请求示例

Accept: application/json
Content-Type: application/josn;charset=utf-8
{
    "userName": "xxx",
    "passWord": "xxx",
	"mobile":"13800138001"
}

返回信息

参数名 类型 参数值
status boolean 接口响应状态 true false
msg string 文字说明
data list 数据集,key 值的意思请参考 获取客户资料字段 接口所返回的数据

返回实例

{
    "status": true,
    "msg": "获取成功",
    "data": [
        {
            "mobile": "13800138001",
			"custXM": "客户1",
			"sex": "1",
			"custyysj": "2022-09-21 12:00:00"
        }
    ]
}
回调

数据回调:

  • 系统支持在通话挂机后次本次通话推送到用户设置的接收地址。 - 设置地址:系统设置-》回调地址-》挂机回调地址
分机状态回调

分机状态回调地址

  • 系统支持在通话接听后把分机状态推送到用户设置的接收地址。
  • 设置地址:系统设置-》回调地址-》分机状态回调地址 分机状态回调

参数:

  • 该接口是以post表单方式推送到接收地址。

说明:

  • 分机状态:SIP分机注册的状态
  • 示忙状态:分机逻辑示忙状态,示忙中的分机电话不能呼入进来。
  • 最大响应时间:3s

推送数据


{
	"exten":"8089",
	"status":"0",
	"dnd":"0"
}
参数名 类型 参数值
exten string 分机号
status string 分机状态
dnd string 示忙状态
  • 分机状态 : 0 已注册, 1 通话中,4 未注册, 8 振铃
  • 示忙状态 : 0 示闲, 1 示忙
分机振铃回调

分机振铃回调地址(来电弹屏)

  • 系统支持在通话接听前,把本次通话信息推送到用户设置的接收地址。
  • 设置地址:系统设置-》回调地址-》分机振铃回调地址

参数:

  • 该接口是以post表单方式推送到接收地址。
  • 最大响应时间:3s

推送数据


{
"uniqueid":"1651085102.14",
"src":"1868****812",
"dst":"8089",
"pjid":"oc2373006",
"activation":"2022-04-28 02:45:05",
"in_time":"2022-04-28 02:45:01",
"did":"0835****707",
"ivr":null,
"ivr_key":null,
"queue":9001,
"queue_in_time":"2022-04-28 02:45:02",
"uuid":"oc2373006",
"com_id":"25"
}

参数名 类型 参数值
uniqueid string 通话唯一标识
src string 主叫
dst string 被号
pjid string 任务标识,如果是任务接通则会有相应信息
activation string 推送时间
in_time string 呼入系统时间
did string 拨打什么号码呼入
ivr string 最后交互IVR
ivr_key string 最后IVR交互中按键信息
queue string 进入的队列
queue_in_time string 进入队列时间
uuid string 唯一值
com_id string 公司ID
接听回调推送

接听回调推送

  • 系统支持在通话接听后把本次通话信息推送到用户设置的接收地址。
  • 设置地址:系统设置-》回调地址-》接听回调地址 回调地址设置

参数:

  • 该接口是以post表单方式推送到接收地址。

推送数据


{
"uniqueid":"1651085102.14",
"src":"1868****812",
"dst":"8089",
"pjid":"oc2373006",
"activation":"2022-04-28 02:45:05",
"in_time":"2022-04-28 02:45:01",
"did":"0835****707",
"ivr":null,
"ivr_key":null,
"queue":9001,
"queue_in_time":"2022-04-28 02:45:02",
"uuid":"oc2373006",
"com_id":"25"
}

参数名 类型 参数值
uniqueid string 通话唯一标识
src string 主叫
dst string 被叫
pjid string 任务标识,如果是任务接通则会有相应信息
activation string 推送时间
in_time string 呼入系统时间
did string 拨打什么号码呼入
ivr string 最后交互IVR
ivr_key string 最后IVR交互中按键信息
queue string 进入的队列
queue_in_time string 进入队列时间
uuid string 唯一值
com_id string 公司ID
挂机回调推送

挂机回调推送

  • 系统支持在通话挂机后把本次通话推送到用户设置的接收地址。
  • 设置地址:系统设置-》回调地址-》挂机回调地址 回调地址设置

参数:

  • 该接口是以post表单方式推送到接收地址。

推送数据

{
	"ring_start": "2019-11-26 18:20:44",
	"answer_time": "2019-11-26 18:20:48",
	"ring_end": "2019-11-26 18:20:48",
	"exten_ring": 4,
	"province": "广东",
	"city": "湛江市",
	"uniqueid": "1574763644.0",
	"lastdata": "SIP\/2019090901\/18219103020,300,T",
	"disposition": "ANSWERED",
	"dst": "18219103020",
	"src": "901",
	"dcontext": "from-internal",
	"userfield": "audio:901-18219103020-20191126-182044-1574763644.0-test.mp3",
	"amaflags": "4",
	"duration": "23",
	"billsec": "19"
}
参数名 类型 参数值
ring_start string 开始振铃时间
answer_time string 分机应答时间
ring_end string 振铃结束时间
exten_ring string 分机振铃时长(单位:秒)
province string 省份
city string 城市
uniqueid string 通话唯一标识
lastdata string 系统应用数据
disposition string 接听状态,ANSWERED 已经接听,NO ANSWER 未接听,FAILED 呼叫失败
src string 主叫
dst string 被叫
userfield string 录音文件
amaflags string 状态标签,0 自动外呼,1 点击外呼,2 分机互打,3 呼入,4 呼出
duration string 总时长 (单位:秒)
billsec string 通话时长 (单位:秒)
第三方弹屏地址

第三方弹屏地址

  • 场景:配置第三方弹屏地址之后,呼入呼出时,自动弹出第三方系统的信息页面,没有配置第三方弹屏地址,弹屏将显示蚁巢呼叫中心系统默认的弹屏界面
  • 设置地址:系统设置-》回调地址-》第三方弹屏弹屏地址 ![]

  • get表单方式推送到接收地址。

    参数说明

参数名 类型 参数值
activation string 呼叫时间
calla string 主叫
callb string 被叫
uid string 通话记录的唯一标识
pjid string 非任务点击呼叫 pjid=click;任务的点击呼叫pjid=0_1_733_click,其中 733为任务ID,1为任务数据表里的数据id;任务自动外呼 以oc开头 :pjid=oc1921083804_218_2069,其中 218为任务ID,2069为任务数据表里的数据id; 平常软件电话直呼pjid的值为空
hp string 手机号码加密密文
calldir string in 为呼入,out为呼出
调用demo
PHP

php 调用demo:

/**
 ****************************************
 * @功能 ant api demo
 * @author maspop@gmail.com
 * @copyright zmrh 2020
 * @version $id
 ****************************************
 */
define('CC_IP','http://cc.wei-fu.cn');
define('API_URL',CC_IP."/webAPI/webHttpAPI.php?");



function http_get($url){
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);
    $result = curl_exec($ch);
    return $result;
}

//点击拨号
//调用接口前需要确认分机已注册在线

//公共参数
//加密查看文档地址 http://doc.wei-fu.cn/docs/show/75
$data['userName'] = 'test';
$data['passWord'] = '9da06d5eb0bcd66986c657e42929bdb298b00f03cb4d2262fbb33c04f1560229';


function clickCall($data){
    $data['model'] = 'OnClickCall';//调用的方法
    $data['exten'] = '805';//坐席的分机
    $data['toTel'] = 18520859587;//要呼叫的号码
    $url = API_URL.http_build_query($data);

    $result = http_get($url);
    var_dump($result);
}


//示忙
//http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=setBuys&agent=801&userName=xxx&passWord=xxx
function setBuys($data){
    $data['model'] = 'setBuys';//调用的方法
    $data['agent'] = '805';//坐席的分机
    $url = API_URL.http_build_query($data);
    $result = http_get($url);
    var_dump($result);
}
//示闲
//http://xxx.xxx.xxx.xxx/webAPI/webHttpAPI.php?model=setIdle&agent=801&userName=xxx&passWord=xxx
function setIdle($data){
    $data['model'] = 'setIdle';//调用的方法
    $data['agent'] = '1095';//坐席的分机
    $url = API_URL.http_build_query($data);
    $result = http_get($url);
    var_dump($result);
}


clickCall($data);

//其它接口请参考 接口文档地址
//http://doc.wei-fu.cn/docs/show/76
JAVA

JAVA 调用demo: 实例下载


/*
 * To change this license header, choose License Headers in Project Properties.
 * To change this template file, choose Tools | Templates
 * and open the template in the editor.
 */
package vikirequestclientDemo;
import util.HttpUtil;

/**
 *
 * @author Luojie
 */
public class HttpRequestClient {
                
	public static void main(String[] args) throws Exception {
        
            //获取key , 只需要获取一次
            String key = java.net.URLEncoder.encode("xxx", "utf-8"); //后台superadmin设置的 = xxx
            String pass = java.net.URLEncoder.encode("xxx", "utf-8"); //公司admin登录的密码 = xxx
            String url = "http://xxx.wei-fu.cn/webAPI/pe.php?pass="+pass+"&key="+key; //服务器地址
            String ret = HttpUtil.doPost(url, "");
            System.out.println(ret);
            
            //点击拨号
            String userName = "test"; //公司编号
            String passWord = ret; //通过上面过程获取
            String model = "OnClickCall";
            String exten = "8004"; //分机
            String toTel = "1380013800"; //被叫
            url = "http://xxx.wei-fu.cn/webAPI/webHttpAPI.php?model="+model+"&exten="+exten+"&toTel="+toTel+"&userName="+userName+"&passWord="+passWord; 
            ret = HttpUtil.doPost(url, "");
            System.out.println(ret);   
		
	}
    
}


C#

C# 调用demo: 实例下载


using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace WindowsFormsAppVikiApi
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void button1_Click(object sender, EventArgs e)
        {
            string pass = HttpHelper.UrlEncode("admin的密码");
            string key = HttpHelper.UrlEncode("superadmin设置的公司的key");
            string strURL =  "http://服务器地址/webAPI/pe.php?pass=" + pass + "&key=" + key;
            string ret = HttpHelper.Post(strURL,"","");
            textBox1.Text = ret.ToString();
        }

        private void button2_Click(object sender, EventArgs e)
        {
            string userName = "test"; //公司编号
            string passWord = textBox1.Text.Trim(); //通过上面过程获取
            string model = "OnClickCall";
            string exten = "8004"; //分机
            string toTel = "1380013800"; //被叫
            string url = "http://服务器地址/webAPI/webHttpAPI.php?model=" + model + "&exten=" + exten + "&toTel=" + toTel + "&userName=" + userName + "&passWord=" + passWord;
            string ret = HttpHelper.Post(url, "", "");
            textBox2.Text = ret.ToString();
        }
    }
}


websocket推送状态(分机状态、来电弹屏)
说明

#接口说明 本接口用于开放给合作伙伴,有开发能力的人员使用。 该接口可通过websocket方式连通,获取到系统推送的分机状态及来电消息。

** 接口地址**

ws://weifumq.wei-fu.cn:15674/ws
获取routingkey

#获取routingkey

###接口地址 http://呼叫中心地址/cloud-app/getRoutingkey.html

请求方式

POST

参数表

参数名 类型 说明
extension string 分机号
com_code string 公司账号
user string 用户名,该用户名已经与分机号绑定

返回数据

json 字符串信息

  1. 成功返回
{"code":200,"msg":"ok","data":"899979357deaf40dbf075773c300805b"}
  1. 失败返回
{"code":300,"msg":"error","data":[]}

说明: 成功返回的data参数是本次接口返回的routingkey,可用于返回订阅接口使用

接口订阅

#接口订阅

接口需要开发人员有前端技术能力

此处的接口地址请参看说明页面



var has_had_focus = false;
var reconnectInterval=1000;
var timeoutInterval = 2000;
var pipe = function(el_name, send) {

var print = function(m, p) {

	//add log
	if(m=="Whoops! Lost connection to undefined"){
		//消息服务器链接失败业务提示
	//console.log(m);
	}

	if(m.indexOf("CONNECTED")>-1){
	weifuStatus(2); //准备链接业务提示
	//console.log(m);
	}

	if(m.indexOf("connected to server")>-1){
	 //链接成功业务提示
	// console.log(m);
	}

	if(m.indexOf("ERROR")>-1){
	if(m.indexOf("NOT_FOUND")>-1){
		//消息通道未建立业务提示
	}
	//console.log(m);
	}

	if(m.indexOf("PING")>-1){
	console.log('心跳 101'); //心跳
	}

	if(m.indexOf("SUBSCRIBE")>-1){
		//订阅成功业务提示
	}

	return print;
};

var print_first = pipe('#first', function(data) {
//    client.send('/topic/test', {"content-type":"text/plain"}, data);
});

 var routingkey = 'xxxxxx';#接口获取
 var ws = new WebSocket("接口地址");
 // Init Client
 var client = Stomp.over(ws);

// SockJS does not support heart-beat: disable heart-beats
client.heartbeat.outgoing = 59000;
client.heartbeat.incoming = 0;
client.debug = pipe('#second');

// Declare on_connect
var on_connect = function(x) {
//订阅消息
client.subscribe("/exchange/weifu_pop/"+routingkey, function(message) {
	var content = message.body;
	console.log(content);
	var obj = JSON.parse(content);
	//业务需求实现可在这里编写
	});
};

// Declare on_error
var on_error =  function(msg) {
	console.log('error:'+msg);
};

// Conect to RabbitMQ
client.connect('厂家申请', '厂家申请', on_connect, on_error, '/');
电话条

简要描述:

提供集成常用的功能于一体,为客户自主开发时嵌入系统内使用。

效果图:

主要功能:

  1. 点击呼叫
  2. 呼叫转移
  3. 示忙\示闲
  4. 呼叫保持\呼叫恢复
  5. 服务满意度
  6. 分机状态显示

开发要求

该电话条部署在蚁巢呼叫中心服务器,开发人员以iframe将该页面载入,并传入对应坐席用户的分机参数,如图exten参数接收,配合注册话机后可使用对应的功能。

如客户蚁巢呼叫中心服务器部署在本地,请先联系我方人员部署并配置。

补丁列表

蚁巢标准版补丁:

1、特殊号码外呼权限