穷奇云接口

接口文档

更新日期

更新说明 20250512

1、智媒云话术平台新增意图采集配置

2、CC701 AI任务详情页面，新增意图采集报表导出功能



更新说明 20250423

1、智能语音通知场景“单个发起呼叫” 和 “批量发起呼叫(txt号码表)” 语音通知接口新增参数“pre_waiting”。该参数可以在客户接听后延迟指定时间等待后再播放通知内容。使用场景为应对现在小号呼叫前播放“隐私保护提醒”的优化方案。如果是小号呼叫建议为3秒，如果是固话呼叫可以不用传参。
2、挂机新增字段“sip_hangup_disposition”标识挂机方。具体判断参考“http://doc.wei-fu.cn/docs/show/391”



更新说明 20250309

1、重构TTS合成和录音缓存文件存储方式的核心组件(支持缓存技术)

2、不再兼容美团API

3、优化并发性能

4、优化调度算法

5、支持阿里云音色

编号 发音人 说明
1 zhiyuan 知媛，普通话女声
2 zhiyue 知悦，普通话女声
3 zhistella 知莎，普通话女声
4 zhida 知达，普通话男声
5 aiqi 艾琪，温柔女声
6 aicheng 艾诚，标准男声
7 aijia 艾佳，标准女声
8 siqi 思琪，温柔女声
9 sijia 思佳，标准女声
10 mashu 马树，儿童剧男声
11 yuer 悦儿，儿童剧女声
12 ruoxi 若兮，温柔女声
13 aida 艾达，标准男声
14 sicheng 思诚，标准男声
15 ninger 宁儿，标准女声
16 xiaoyun 小云，标准女声
17 xiaogang 小刚，标准男声
18 ruilin 瑞琳，标准女声
19 zhiya 知雅，普通话女声
20 aiyue 艾悦，温柔女声
21 aiya 艾雅，严厉女声
22 aijing 艾婧，严厉女声
23 aimei 艾美，甜美女声
24 siyue 思悦，温柔女声
25 aina 艾娜，浙普女声
26 aishuo 艾硕，自然男声
27 aiyu 艾雨，自然女声
28 xiaomei 小美，甜美女声
29 yina 伊娜，浙普女声
30 sijing 思婧，严厉女声
31 zhimao 知猫，普通话女声
32 laomei 老妹，吆喝女声
33 laotie 老铁，东北老铁
34 xiaoxian 小仙，亲切女声
35 guijie 柜姐，亲切女声
36 stella Stella，知性女声
37 maoxiaomei 猫小美，活力女声
38 qiaowei 巧薇，卖场广播
39 ailun 艾伦，悬疑解说
40 aifei 艾飞，激昂解说
41 yaqun 亚群，卖场广播
42 stanley Stanley，沉稳男声
43 kenny Kenny，温暖男声
44 rosa Rosa，自然女声
45 kelly Kelly，香港粤语女声
46 jiajia 佳佳，粤语女声
47 dahu 大虎，东北话男声
48 aikan 艾侃，天津话男声
49 taozi 桃子，粤语女声
50 qingqing 青青，台湾话女声
51 cuijie 翠姐，东北话女声
52 xiaoze 小泽，湖南重口音
53 shanshan 姗姗，粤语女声
54 chuangirl 小玥，四川话女声
55 aixia 艾夏，客服数字人
56 zhigui 知柜，直播数字人
57 zhishuo 知硕，客服数字人
58 zhixiaobai 知小白，对话数字人
59 zhixiaoxia 知小夏，对话数字人
60 zhixiaomei 知小妹，直播数字人



更新说明 20241204

1、重构TTS合成和录音缓存文件存储方式的核心组件

2、新增清除缓存公共API

3、有效说话次数（有ASR识别的数）

4、未说话次数（未ASR识别的数）

4、无关键字对话次数（无关键字）

5、有关键字的对话次数

6、推送新增字段

字段 说明
asr_sure 有效说话次数（ASR有识别的数）
asr_deny 未说话次数（ASR无识别的数）
key_word_deny 无意图【在有设置意图的情况下】对话次数（无关键字）
key_word_sure 有意图【在有设置意图的情况下】的对话次数

7、小V机器人支持新增字段分类筛选



更新说明 20241113

1、新增节点标签支持，follow_label

2、新增节点max_wait_time最大监听时间支持

3、新增节点max_wait_time最大静音时间支持

4、优化TTS合成缓存处理



更新说明 20240828

1、小V机器人公共问题“转人工”算法优化

2、新增“转人工”场景设置，在蚁巢节点可以设置转人遇忙模式：“人工等待”或者AI继续接管。

3、如果开启AI接管、建议在蚁巢节点禁用“坐席全忙暂停”



更新说明 20240826

1、上报转接号对应的分机队列的分机空闲数（如果分机空闲为0则不发起转接、由小V机器人接管。）（接口说明）



更新说明 20240719

1、优化TTS节点轮询算法

2、自动屏蔽异常节点

3、部分重构、提高性能。



更新说明 20240716

1、优化小V机器人公共问题接续逻辑（话术设计新增公共问题跳转到下一级设置）。

2、优化系统漏洞、解决API HTTP REQUEST 部分头部返回请求字段的问题。

3、部分重构、提高性能。



更新说明 20240708

1、优化TTS合成。

2、如果文件并未正常生成、则重复3次请求。（间隔1秒）



更新说明 20240607

  1. [新增]AI机器人延迟呼叫功能，使用场景：如客户说晚点联系我，明天联系我等等，系统会自动等待设定时间后再次进行呼叫，具体配置在 AI意图筛选->延迟呼叫 中设置，如下图

  2. [新增] AI新增自动加企微功能，该插件由第三方软件平台提供，配置在 AI意图筛选->加企微 中设置，具体使用方法请咨询我们技术支持人员

  3. [新增] AI外呼统计报表新增加企微相关的统计数据，如下图：



更新说明 20240602

1、小V机器人，如果机器人话术对应的变量没有正常提交、或者格式不对、则忽略合成变量，直接用“变量名称”替代。

更新说明 20240321

1、小V机器人支持某句话由变量开始，比如：“{姓名}，先生您好。”

2、如果变量字典异常、返回原来的内容、而不是返回空、导致没声音现象出现。

3、添加对应日志消息



更新说明 20231103

1、语音通知回执新增呼叫节点参数，“call_pbx_node”, 接口地址



更新说明 20231014

1、蚁巢对接支持MySQL事件推送（调用方式内部约定、暂不对外开放）

2、需要IP开发相应端口

3、蚁巢设置如下：

4、历史话单字段“requests_text”标记为：{code:200,msg:mysql}



更新说明 20231011

1、优化极个别意图数据json格式异常导致的推送失败。

更新说明 20230913

1、优化MYSQL性能、进一步提升服务器的综合性能利用率。 2、优化TTS的合成处理、主动识别失败任务重新合成、并且添加日志监控机制。 3、优化中间件性能 4、优化转接人工多种场景下的记录（待回访记录）

更新说明 20230907

1、优化API输出，通过ob_clear()；去掉偶发脏数据。

更新说明 20230811

1、优化ASR算法

2、对噪音“嗯。”处理

3、对静音的逻辑判断和处理

4、对识别准确性（声音特征）的优化和处理



更新说明 20230609

1、部分TTS合成录音问题，（发言人数据库存储字符长度限制为10，调整为20）

2、http://合成节点/ttslog/2023-06-09.log （年-月-日）可以获取到合成日志

3、TTS合成“团凡杰”下线

4、最新TTS发言人如下：



更新说明 20230425

1、应用欠费提示 407 apppp is arrears 应用已欠费费



更新说明 20230318

1、修复静音话术的合成

2、修复静音话术的播放



更新说明 20230318

1、修复一些常驻内存缓存缓存数据导致的BUG

2、优化重复问、静音、公共问题转回、挂机事件等方案

3、支持转接人工动作（蚁巢-队列/分机）

4、优化内存池缓存的模型和架构

5、会话详情表新增字段：ai_say_class, 其内容为【isstart：开场白， silencet：静音 ，publict：公共问题回复，public_currentt：公共问题重复说 ， public_nextt：公共问题后下一句，sessiont：正常对话】



更新说明 20230309

1、转接接口参数调整：{"ip":"192.168.1.1","callerid":"18681471111","port":"5060","timeout":"45"}，ip为IP地址、callerid为主叫、port为端口，默认5060、timeout为转接超时设置，默认45秒

2、AI对话详情新增2个字段，action_class：(转接类型0不转接，1外线（手机\固话），2，蚁巢),transfer : 转接参数, 目前不支持转手机/固话。



更新说明 20230222

1、AI挂机接口推送接口中，analysis_rules_data字段内增加all_intent_label属性，all_intent_label表示为该通电话中触发的所有意图标签

更新说明 20230215

1、更新TTS发音人，全新的发音人包括："meifannan","tuanfanhu","tuanfanjie","meifanqian","meifanyu","meifantong","tuanmijia","meifanya","meifanxi","meifanlin"


更新说明 20230209

1、推送接口新增 意图规则分析 接口


更新说明 20230208

1、新增 获取AI对话详情 接口


更新说明 20230202

1、机器人新增转接参数，"transfer"


更新说明 20230130

1、机器人新增分析脚本ID变量，"analysis_rules_id"


更新说明 20230104

1、新增允许调节的最大并发数"allow_maxcall"
2、原"maxcall"，调整为当前并发数
3、新增 更新呼叫并发
4、更新 单个发起呼叫（AI）接口

更新说明 20221130

1、获取应用当前呼叫信息接口增加批次查询条件，batch

更新说明 20221128

1、新增根据批次删除呼叫队列接口，调用后立马删除队列中改批次未呼叫的数据（delcallqueue.php）

更新说明 20221104

1、新增机器人应用接口，单号码提交（startcallai.php）

更新说明 20220803

1、新增获取应用当前呼叫信息接口（getappcallqueue.php），查询应用当前各个状态的数量

更新说明 20201119

1、新增单个发起呼叫高级版（seniorstartcall.php），调用后马上进行呼叫，支持录音文件全部自定义，分为4个部分：主录音、按键提示音、按键后播放录音、结束后录音。如果不设置按键提示音、则以主录音为第一段录音。

更新说明 20200719

1、修改推送脚本、采用新的多线程组件推送

更新说明 20200630

1、批量发起呼叫所有接口新增参数 callnow, 约定提交后是否马上呼叫

更新说明 20200629

1、新增上传录音文件接口：addplayfile.php
2、新增删除录音文件接口：delplayfile.php

更新说明 20200623

1、按键推送新增批次字段

更新说明 20200614

1、startcall.php 接口新增short_phone字段，该字段为转接分机号，如拨打饿了么外卖，1861888888转12345

更新说明 20200603

1、batch 批次长度允许80位
2、startcallbyfile.php 接口调用后会暂停任务、需要改变为“运行”状态

更新说明 20200514

play_url 不允许提交带汉字或者特殊字符串内容

更新说明 20200427

更新批量发起呼叫（号码+文字）的号码格式说明。

更新说明 20200422

新增TTS合成余额限制

接口及返回状态码描述

接口描述

1.1、接口调用形式

本接口采用HTTP方式调用如：http://xx.xx.xx/qiongqiapi/

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

1.2、返回状态及错误码

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

编号 状态 返回值 说明
1 200 success 调用成功
2 400 appid is null appid不能为空
3 401 appsecret is null 密码不能为空
4 402 appkey is null 应用key不能为空
5 403 phone list file is null 或者 phone is null 拨打手机不能为空
6 404 play_url or words is null 录音播放路径或TTS文字不能为空
7 405 appid or appsecret is error appid或密码错误
8 406 app is disable 应用不可用
9 407 app is arrears 应用已欠费
10 408 not support batch submit 不支持批量提交
11 409 app_status is null 应用状态为空
12 410 app_status is not 1 or 2 应用不在执行或暂停状态
13 411 callday is null 呼叫日期不能为空
14 412 phone is null 拨打手机不能为空
15 413 callday is no "Ymd" 呼叫日期不是“Ymd”格式
16 414 app_play_url is null 录音文件地址为空
17 415 app_play_url non existent 录音文件地址不在系统列表
18 416 play_url too long, max strlen is 100 录音文件最大32个字符长度
19 417 batch too long, max strlen is 32 批次/备注最大32个字符长度
20 418 phonelist is null 号码列表为空
21 419 phonelist format error 号码列表格式错误，应该是号码加逗号,如 18680080001,18681471888
22 420 not support wav upload submit 该应用不支持上传wav或mp3文件
23 421 file format no wav or mp3 文件格式不是wav或mp3
24 422 file too max 文件太大（不能大于2M）
25 423 file name not support chinese characters 只支持中文文件名
26 424 file already exists 文件已存在
27 425 mkdir fail 系统创建文件目录失败、请联系我们
28 426 file move fail 系统移动文件失败、请联系我们
29 427 no upload file 没有上传文件
30 428 words is no UTF-8 合成文字不是UTF-8编码
31 429 sorry, your tts credit is running low 语音合成点数不够
32 430 play_url have chinese characters play_url 含有中文字符串
33 431 short_phone is no number short_phone 不是数字
34 432 remarks is null 备注名称不能为空
35 433 voice error 录音操作失败
36 444 move file fail 上传文件移动失败
37 445 fail insufficient privilege 没有立刻呼叫权限
38 446 nlu_project_id too long, max strlen is 100 项目ID模板太长
39 447 nlu_project_id have chinese characters 项目ID包含特殊字符
40 448 nlu_project_id is NULL 项目ID为空
41 449 variable is no UTF-8 AI话术变量格式非UTF-8
42 450 ttsstatus is no 0/1/2 值只能是0、1、2
43 451 ttsstatus is null 变量合成状态为空，0不用合成的录音、1已经合成、3待合成
44 452 variable is null ttsstatus=2的情况下变量不能为空
45 453 maxcall is null 最大并发数不能为空
46 454 maxcall is notnumeric maxcall 不是数字类型
47 455 maxcall > allow_maxcall 大于最大并发值
48 456 tts_info is not json data tts_info 不是正确的JSON格式字符串
49 457 voice or volume or speed or engine variable error voice 或者 volume 或者 speed 或者 engine 变量为空
50 458 variable is not json data variable 不是正确的JSON格式字符串
51 459 xxx is no number xxx 不是数字字符串
52 460 xxx is error xxx 不是该应用的线路
53 461 transfer format is error 转接数据格式错误
54 462 transfer ip format is error 转接数据的IP格式错误
55 463 transfer callerid format is error 转接数据的callerid格式错误
56 464 ip is null ip 参数为空
57 465 callerid_list is null callerid_list 数据为空
58 466 pre_waiting is null pre_waiting 格式不为数字

获取应用状态

#获取应用状态

接口地址

POST/qiongqiapi/getappstatus.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/getappstatus.php?appid=18cf6012-4330-11ea-9310-00163e0c8cf9&appsecret=123456&appkey=zmrh

返回信息

{
	"status": "200",
	"msg": "success",
	"data": {
		"appid": "18cf6012-4330-11ea-9310-00163e0c8cf9",
		"app_status": "6",
		"app_balance": "100.000000",
		"app_billing_unit": "0.060000",
		"addtime": "2020-01-30 15: 14: 04 ",
		"app_pbx ":null,
		"gateway ":"gw2 ",
		"app_exten_script ":"zmrh_call_01 ",
		"app_play_url ":"http:\/\/114.55.35.119\/qiongqi\/temp\/voice\/15814995155494.wav",
		"push_cmd":"http:\/\/",
		"is_enable":"1",
		"mobile":"18681471812",
		"apptype":"1",
		"start_call":"00:00",
		"end_call":"23:59",
		"maxcall":"100"，
		"allow_maxcall":"100"
		}
}

返回参数

编号 参数 说明
1 status 调用状态，参考状态说明
2 msg sucess 成功 failed 失败
3 data 返回数据
4 app_status 应用状态、默认0，1执行，2暂停，3欠费，4余额告警，5 停用 ，6 完成
5 app_balance 余额
6 app_billing_unit 计费单位
7 billing_type 计费类型，1、6s，2、60s
8 addtime 添加时间
9 app_pbx pbx服务器编号、默认轮训集群
10 gateway 注册网关落地
11 app_exten_script 应用脚本
12 app_play_url 录音播放地址 如http://xxx.mp3
13 push_cmd 推送地址
14 is_enable 是否启用 是1、否0
15 mobile 手机号
16 apptype 0 单号码请求 ，1 多号码请求
17 start_call 批量外呼开始呼叫时间
18 end_call 批量外呼结束呼叫时间
19 maxcall 当前并发
20 allow_maxcall 允许最大并发
32 app_early_media 是否开启分析挂机原因，0 不开、1 开

单个发起呼叫

#单个发起呼叫

调用后马上进行呼叫

接口地址

POST/qiongqiapi/startcall.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 phone 是 被叫号码
5 volume 否 0-100，默认50. 其中100为最⾼⾳量对应0 dbfs, 50对应-6 dbfs
6 pitch 否 TTS语调，范围是-500~500，默认0
7 speech 否 TTS语速，0-100，默认50
8 voice 否 TTS发音人，默认“meifannan”,包括"meifannan","tuanfanhu","tuanfanjie","meifanqian","meifanyu","meifantong","tuanmijia","meifanya","meifanxi","meifanlin"
9 call_num 是 音频播放次数
10 words 否 TTS文字(只支持UTF-8编码、不支持 “)”，“（”，“）”，“—”，“{”，“}” 等特殊字符串)
11 play_url 否 录音播放地址 如http://xxx.mp3 （长度小于100位）
12 batch 否 批次或备注 长度小于等于80位
13 short_phone 否 转接短号 长度小于等于6位
14 pre_waiting 否 呼叫接通后等待多少秒开始播放语音（只支持数字），针对目前小号中间插播“隐私声明”的场景优化，建议3秒

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/startcall.php?appid=18cf6012-4330-11ea-9310-00163e0c8cf9&appsecret=123456&appkey=zmrh&phone=13902515162&pitch=100&speech=75&voice=ruoxi&call_num=2&words=祝福大家元宵节快&play_url=http://114.55.35.119/qiongqi/temp/voice/15814995155494.wav

返回信息

{
	"status": "200",
	"msg": "success",
	"data": "api-bace6fde-5131-11ea-99e8-00163e0c8cf9"
}

返回参数

编号 参数 说明
1 status 调用状态，参考状态说明
2 msg sucess 成功 failed 失败
3 data 返回key （全局唯一值）

单个发起呼叫（AI）

#单个发起呼叫（AI机器人外呼）

调用后进入队列、如果队列在运行中、则开始呼叫

接口地址

POST/qiongqiapi/startcallai.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 phone 是 被叫号码
5 call_num 否 失败呼叫次数
6 nlu_project_id 是 VIKINLU的话术id
7 tts_info 否 TTS合成的JSON表达格式，如：{"voice":"meifannan","volume":"100","speed":"0","engine":"mt"} ，TTS发音人，默认“meifannan”,包括"meifannan","tuanfanhu","tuanfanjie","meifanqian","meifanyu","meifantong","tuanmijia","meifanya","meifanxi","meifanlin"
8 variable 否 话术变量的JSON表达格式，如：{"客户姓名":"张三","性别":"先生","逾期天数":"3","欠款金额":"768.23","客服电话":"07551234567"}
9 analysis_rules_id 否 意图分析规则ID，只能是数字
10 gateway_name 否 自定义网关名称（线路），通过智媒云接口获取
11 push_cmd 否 自定义推送地址
12 transfer 否 转接服务，JSON格式，{"ip":"192.168.1.1","callerid":"18681471111","port":"5060","timeout":"45"}，ip为IP地址、callerid为主叫、port为端口，默认5060、timeout为转接超时设置，默认45秒
13 batch 否 批次或备注 长度小于等于80位
14 voice_typle 否 发言人类型、语音包的类型
15 pre_waiting 否 单位秒，呼叫接通后等待多少秒开始播放语音，针对目前小号中间插播“隐私声明”的场景优化，建议3秒

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/startcallai.php?appid=xxx&appsecret=xxx&appkey=xxx&phone=1380013800&call_num=3&nlu_project_id=5&tts_info={"voice":"meifannan","volume":"100","speed":"0","engine":"mt"}&variable={"客户姓名":"张三","性别":"先生","逾期天数":"3","欠款金额":"768.23","客服电话":"07551234567"}&batch=ABC&analysis_rules_id=1&gateway_name=2&push_cmd=3

返回信息

{
	"status": "200",
	"msg": "success",
	"data": "api-bace6fde-5131-11ea-99e8-00163e0c8cf9"
}

返回参数

编号 参数 说明
1 status 调用状态，参考状态说明
2 msg sucess 成功 failed 失败
3 data 返回key （全局唯一值）

清理缓存（AI）

#清理小V机器人缓存

接口地址

POST/qiongqiapi/update_appid_cache.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh

请求示例

http://xx.xx.xx.xx/qiongqiapi/update_appid_cache.php?appid=247a63ca-4xxxxxx&appsecret=axxxxxb&appkey=zmxx

返回信息

{
    "status": "200",
    "msg": "success",
    "data": ""
}

返回参数

编号 参数 说明
1 status 调用状态，参考状态说明
2 msg sucess 成功 failed 失败
3 data 返回数据

上报转接号的接听对象空闲数（AI）

#上报转接号对应的分机队列的分机空闲数，如果分机空闲为0则不发起转接、由小V机器人接管。

接口地址

POST/qiongqiapi/uploadcalleridstatus.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 ip 是 转接服务器IP地址
5 callerid_list 是 转接号码对应坐席空闲数，JSON数组格式，callerid：转接号，exten_idle_num：空闲数，参考： [{"callerid":"18681461811","exten_idle_num":"3"},{"callerid":"18681471810","exten_idle_num":"0"}]

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/uploadcalleridstatus.php?appid=********&appsecret=********&appkey=********&ip=*****&callerid_list=*****

返回信息

{
	"status": "200",
	"msg": "success",
	"data": "1672840282"}
}

返回参数

编号 参数 说明
1 status 调用状态，参考状态说明
2 msg sucess 成功 failed 失败
3 data 时间戳

批量发起呼叫 (txt号码表)

#批量发起呼叫

批量发起呼叫是通过plist.txt文件批量上传号码进行呼叫的。调用后任务状态自动设置为“暂停”，需要将任务设置为“执行”状态才开始呼叫。也可以通过参数callnow调整。

接口地址

POST/qiongqiapi/startcallbyfile.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 volume 否 0-100，默认50. 其中100为最⾼⾳量对应0 dbfs, 50对应-6 dbfs
5 pitch 否 TTS语调，范围是-500~500，默认0
6 speech 否 TTS语速，0-100，默认50
7 voice 否 TTS发音人，默认“meifannan”,包括"meifannan","tuanfanhu","tuanfanjie","meifanqian","meifanyu","meifantong","tuanmijia","meifanya","meifanxi","meifanlin"
8 call_num 否 呼叫次数
9 words 否 TTS文字(只支持UTF-8编码、不支持“)”，“（”，“）”，“—”，“{”，“}” 等特殊字符串)
10 play_url 否 录音播放地址 如http://xxx.mp3 （长度小于100位）
11 phonetxt 是 上传文件、文件名必须为plist.txt，示例文件下载：plist.txtplist.txt
12 batch 否 批次或备注 长度小于等于80位
13 callnow 否 是否提交后马上呼叫（是：1，不是：0），默认1

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/startcallbyfile.php?appid=18cf6012-4330-11ea-9310-00163e0c8cf9&appsecret=123456&appkey=zmrh&words=知行合一，止于至善，技术是一种力量&pitch=&speech=&voice=&call_num=&play_url=http://114.55.35.119/qiongqi/temp/voice/15814995155494.wav

返回信息

{
	"status": "200",
	"msg": "success",
	"data": 14
	"error":["1868"]
}

返回参数

编号 参数 说明
1 status 调用状态，参考状态说明
2 msg sucess 成功 failed 失败
3 data 返回成功导入号码量
4 error 返回错误的号码（格式不对）

批量发起呼叫 (号码＋","隔开)

#批量发起呼叫

批量发起呼叫，号码通过逗号隔开传值，支持每次传值设置批次或备注。调用后任务状态自动设置为“暂停”，需要将任务设置为“执行”状态才开始呼叫。也可以通过参数callnow调整。

接口地址

POST/qiongqiapi/startcallbyphonelist.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 volume 否 0-100，默认50. 其中100为最⾼⾳量对应0 dbfs, 50对应-6 dbfs
5 pitch 否 TTS语调，范围是-500~500，默认0
6 speech 否 TTS语速，0-100，默认50
7 voice 否 TTS发音人，默认“meifannan”,包括"meifannan","tuanfanhu","tuanfanjie","meifanqian","meifanyu","meifantong","tuanmijia","meifanya","meifanxi","meifanlin"
8 call_num 否 呼叫次数
9 words 否 TTS文字(只支持UTF-8编码、不支持“)”，“（”，“）”，“—”，“{”，“}” 等特殊字符串)
10 play_url 否 录音播放地址 如http://xxx.mp3 （长度小于100位）
11 phonelist 是 号码列表、最大默认支持20000个号码（如：186********,187********）
12 batch 否 批次或备注 长度小于等于80位
13 callnow 否 是否提交后马上呼叫（是：1，不是：0），默认1

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/startcallbyphonelist.php?appid=18cf6012-4330-11ea-9310-00163e0c8cf9&appsecret=123456&appkey=zmrh&words=知行合一，止于至善，技术是一种力量&pitch=&speech=&voice=&call_num=&play_url=http://114.55.35.119/qiongqi/temp/voice/15814995155494.wav

返回信息

{
	"status": "200",
	"msg": "success",
	"data": 14
	"error":["1868"]
}

返回参数

编号 参数 说明
1 status 调用状态，参考状态说明
2 msg sucess 成功 failed 失败
3 data 返回成功导入号码量
4 error 返回错误的号码（格式不对）

批量发起呼叫 (号码+播放地址)

#批量发起呼叫

批量发起呼叫是通过plist.txt文件批量上传号码和对应录音播放地址进行呼叫。调用后任务状态自动设置为“暂停”，需要将任务设置为“执行”状态才开始呼叫。也可以通过参数callnow调整。

接口地址

POST/qiongqiapi/startcallbyfileplayurl.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 call_num 否 呼叫次数
5 play_url 否 录音播放地址 如http://xxx.mp3 （长度小于100位）
6 phonetxt 是 上传文件、文件名必须为plist.txt 号码格式见下文：“号码格式说明”
7 batch 否 批次或备注 长度小于等于80位
8 callnow 否 是否提交后马上呼叫（是：1，不是：0），默认1

号码格式说明（号码|播放地址）

示例文件下载：plist.txtplist.txt

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/startcallbyfileplayurl.php?appid=18cf6012-4330-11ea-9310-00163e0c8cf9&appsecret=123456&appkey=zmrh

返回信息

{
	"status": "200",
	"msg": "success",
	"data": 14
	"error":["1868"]
}

返回参数

编号 参数 说明
1 status 调用状态，参考状态说明
2 msg sucess 成功 failed 失败
3 data 返回成功导入号码量
4 error 返回错误的号码（格式不对）

批量发起呼叫 (号码+文字)

#批量发起呼叫

批量发起呼叫是通过plist.txt文件批量上传号码和对应录音播放地址进行呼叫。调用后任务状态自动设置为“暂停”，需要将任务设置为“执行”状态才开始呼叫。也可以通过参数callnow调整。

接口地址

POST/qiongqiapi/startcallbyfileword.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 call_num 否 呼叫次数
5 play_url 否 录音播放地址 如http://xxx.mp3 （长度小于100位）
6 phonetxt 是 上传文件、文件名必须为plist.txt 号码格式见下文：“号码格式说明”
7 batch 否 批次或备注 长度小于等于80位
8 callnow 否 是否提交后马上呼叫（是：1，不是：0），默认1

号码格式说明（号码|TTS文字）

示例文件下载：plist.txtplist.txt

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/startcallbyfileword.php?appid=18cf6012-4330-11ea-9310-00163e0c8cf9&appsecret=123456&appkey=zmrh

返回信息

{
	"status": "200",
	"msg": "success",
	"data": 14
	"error":["1868"]
}

返回参数

编号 参数 说明
1 status 调用状态，参考状态说明
2 msg sucess 成功 failed 失败
3 data 返回成功导入号码量
4 error 返回错误的号码（格式不对）

单个发起呼叫高级版

#单个发起呼叫高级版

调用后马上进行呼叫

接口地址

POST/qiongqiapi/seniorstartcall.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 phone 是 被叫号码
5 volume 否 0-100，默认50. 其中100为最⾼⾳量对应0 dbfs, 50对应-6 dbfs
6 pitch 否 TTS语调，范围是-500~500，默认0
7 speech 否 TTS语速，0-100，默认50
8 voice 否 TTS发音人，默认“meifannan”,包括"meifannan","tuanfanhu","tuanfanjie","meifanqian","meifanyu","meifantong","tuanmijia","meifanya","meifanxi","meifanlin"
9 call_num 是 呼叫次数
10 words 否 TTS文字(只支持UTF-8编码、不支持“)”，“（”，“）”，“—”，“{”，“}” 等特殊字符串)
11 play_url 否 录音播放地址 （系统中上传的文件名，不带:".wav"后缀，如16057447735032）
12 batch 否 批次或备注 长度小于等于80位
13 short_phone 否 转接短号 长度小于等于6位
14 call_key_filename 否 按键提示音，设置后则不将主录音重复按键提示（系统中上传的文件名，不带:".wav"后缀，如16057447735032）
15 call_key_again 否 重听按键 0-9
16 call_key_leaving 否 语音留言按键 0-9 ，留言最大时长30秒、静音检测5秒，VAD=5
17 call_key_0_filename 否 按0后播放录音（系统中上传的文件名，不带:".wav"后缀，如16057447735032）
18 call_key_1_filename 否 按1后播放录音（系统中上传的文件名，不带:".wav"后缀，如16057447735032）
19 call_key_2_filename 否 按2后播放录音（系统中上传的文件名，不带:".wav"后缀，如16057447735032）
20 call_key_3_filename 否 按3后播放录音（系统中上传的文件名，不带:".wav"后缀，如16057447735032）
21 call_key_4_filename 否 按4后播放录音（系统中上传的文件名，不带:".wav"后缀，如16057447735032）
22 call_key_5_filename 否 按5后播放录音（系统中上传的文件名，不带:".wav"后缀，如16057447735032）
23 call_key_6_filename 否 按6后播放录音（系统中上传的文件名，不带:".wav"后缀，如16057447735032）
24 call_key_7_filename 否 按7后播放录音（系统中上传的文件名，不带:".wav"后缀，如160574477350322）
25 call_key_8_filename 否 按8后播放录音（系统中上传的文件名，不带:".wav"后缀，如16057447735032）
26 call_key_9_filename 否 按9后播放录音（系统中上传的文件名，不带:".wav"后缀，如16057447735032）
27 call_leaving_end_filename 否 交互完成最后播放录音 （系统中上传的文件名，不带:".wav"后缀，如16057447735032）

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/seniorstartcall.php?appid=588d10b8-xxxx-11ea-85ea-00163e0c8cf9&appsecret=******&appkey=zmrh&phone=18681471812&pitch=50&speech=-100&voice=aixia&call_num=3&words=感谢您选择智媒云&call_key_filename=16057447735032&call_key_again=1&call_key_leaving=2&call_key_0_filename=16057446529435&call_key_1_filename=16057446655539&call_key_2_filename=16057446731988&call_key_3_filename=16057446844495&call_key_4_filename=16057446923317&call_key_5_filename=16057447014732&call_key_6_filename=16057447088489&call_key_7_filename=16057447162748&call_key_8_filename=16057447257702&call_key_9_filename=16057447321250&call_leaving_end_filename=16057448104059

返回信息

{
	"status": "200",
	"msg": "success",
	"data": "api-bace6fde-5131-11ea-99e8-00163e0c8cf9"
}

返回参数

编号 参数 说明
1 status 调用状态，参考状态说明
2 msg sucess 成功 failed 失败
3 data 返回key （全局唯一值）

语音留言获取方式

http://呼叫节点/record/年-月/日/appid.返回key.wav

示例: http://47.112.114.91/record/2020-11/19/588d10b8-91a6-11ea-85ea-00163e0c8cf9.api-0f63a070-2a0b-11eb-bda8-00163e067252.wav

开始或执行应用

#更新应用状态

接口地址

POST/qiongqiapi/updatestatus.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 app_status 是 应用状态 【1执行，2暂停】

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/updatestatus.php?appid=18cf6012-4330-11ea-9310-00163e0c8cf9&appsecret=123456&appkey=zmrh&app_status=1

返回信息

{
	"status": "200",
	"msg": "success",
	"data": 17
}

返回参数

编号 参数 说明
1 status 调用状态，参考状态说明 【1执行，2暂停】
2 msg sucess 成功 failed 失败
3 data 返回数据

更新呼叫并发

#设置当前呼叫的并发数(maxcall)，在最大并发（allow_maxcall）允许数量内

接口地址

POST/qiongqiapi/updateappmaxcall.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 maxcall 是 设置最大并发数、但是该值只允许在allow_maxcall范围内

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/updateappmaxcall.php?appid=xxxx&appsecret=xxxxxx&appkey=xxxxx&maxcall=9

返回信息

{
	"status": "200",
	"msg": "success",
	"data": "1672840282"}
}

返回参数

编号 参数 说明
1 status 调用状态，参考状态说明
2 msg sucess 成功 failed 失败
3 data 时间戳

根据批次删除呼叫队列

#通过批次删除呼叫队列

接口地址

POST/qiongqiapi/delcallqueue.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 batch 是 批次

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/delcallqueue.php?appid=18cf6012-4330-11ea-9310-00163e0c8cf9&appsecret=123456&appkey=zmrh&batch=xxxx

返回信息

{
    "status": "200",
    "msg": "success",
    "data": ""
}

返回参数

编号 参数 说明
1 status 调用状态，参考状态说明
2 msg sucess 成功 failed 失败
3 data 空，无意义

获取应用当前呼叫信息

#获取应用当前呼叫信息

接口地址

POST/qiongqiapi/getappcallqueue.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 batch 否 批次

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/getappcallqueue.php?appid=18cf6012-4330-11ea-9310-00163e0c8cf9&appsecret=123456&appkey=zmrh

返回信息

{
	"status":"200",
	"msg":"success",
	"data":{
		"waiting":0,
		"ttsing":0,
		"ttsend":0,
		"calling":0,
		"callend":0
	}
}

返回参数

编号 参数 说明
1 waiting 等待中的数量
2 ttsing 转TTS中的数量
3 ttsend TTS转换完成数量
4 calling 呼叫中的数量
5 callend 呼叫完成等待推送的数量

通过手机号码查询记录

#通过手机号码查询记录

接口地址

POST/qiongqiapi/getcallbyphone.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 phone 是 被叫手机
5 callday 是 呼叫时间只能是Ymd格式，如20200216

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/getcallbyphone.php?appid=18cf6012-4330-11ea-9310-00163e0c8cf9&appsecret=123456&appkey=zmrh&phone=18681471812&callday=20200216

返回信息

{
	"status": "200",
	"msg": "success",
	"data": [{
			"start_stamp": "2020-02-16 23:48:25",
			"end_stamp": "2020-02-16 23: 48: 25 ",
			"zmrh_core_uuid ":"api - c34a8372 - 50 d3 - 11e a - 805 d - 00163e0 c8cf9 ",
			"call_uuid ":"0e46 cb8d - 5308 - 46 c6 - bbdd - 53676e7908 cd ",
			"answer_stamp ":null,
			"uduration ":"160003 ",
			"billsec ":"0 ",
			"caller_id_number ":"18681471812 ",
			"hangup_cause ":"NO_USER_RESPONSE ",
			"app_billing_unit ":"0.06 ",
			"billing_type ":"1 ",
			"node_tts_address ":"None ",
			"play_url ":"http:\/\/114.55.35.119\/qiongqi\/temp\/voice\/15814995155494.wav",
			"bill_num":"0",
			"bill_total":"0.00",
			"analysis":"0"
		}]
}

返回参数

编号 参数 说明
1 start_stamp 开始时间
2 end_stamp 结束时间
3 zmrh_core_uuid 系统呼叫唯一UUID
4 call_uuid 呼叫UUID
5 answer_stamp 接听时间
6 uduration 处理时间 微秒
7 billsec 通话时长 秒
8 caller_id_number 被叫手机
9 hangup_cause 挂机原因
10 app_billing_unit 计费单位
11 billing_type 计费类型，默认1 6s计费, 2 分钟60秒计费
12 node_tts_address TTS录音地址，如果有play_url忽略，批量上传的呼叫不支持
13 play_url 录音播放地址 如http://xxx.mp3
14 bill_num 计费次数
15 bill_total 总费用
16 analysis 保留字段

通过key查询记录

#通过应用ID查询记录

接口地址

POST/qiongqiapi/getcallbykey.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 key 是 key
5 callday 是 呼叫时间只能是Ymd格式，如20200216

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/getcallbykey.php?appid=18cf6012-4330-11ea-9310-00163e0c8cf9&appsecret=123456&appkey=zmrh&callday=20200216&key=api-4e4e1996-50c7-11ea-805d-00163e0c8cf9

返回信息

{
{
	"status": "200",
	"msg": "success",
	"data": [{
		"start_stamp": "2020-02-16 22:19:16",
		"end_stamp": "2020-02-16 22:19:16",
		"zmrh_core_uuid": "api-4e4e1996-50c7-11ea-805d-00163e0c8cf9",
		"call_uuid": "fa11eabd-a954-4b8b-90ca-6f982630d7b0",
		"answer_stamp": null,
		"uduration": "159993",
		"billsec": "0",
		"caller_id_number": "18520859587",
		"hangup_cause": "NO_USER_RESPONSE",
		"app_billing_unit": "0.06",
		"billing_type": "1",
		"node_tts_address": "None",
		"play_url": "http:\/\/114.55.35.119\/qiongqi\/temp\/voice\/15814995155494.wav",
		"bill_num": "0",
		"bill_total": "0.00",
		"analysis": "0"
	}]
}

返回参数

编号 参数 说明
1 start_stamp 开始时间
2 end_stamp 结束时间
3 zmrh_core_uuid 系统呼叫唯一UUID
4 call_uuid 呼叫UUID
5 answer_stamp 接听时间
6 uduration 处理时间 微秒
7 billsec 通话时长 秒
8 caller_id_number 被叫手机
9 hangup_cause 挂机原因
10 app_billing_unit 计费单位
11 billing_type 计费类型，默认1 6s计费, 2 分钟60秒计费
12 node_tts_address TTS录音地址，如果有play_url忽略，批量上传的呼叫不支持
13 play_url 录音播放地址 如http://xxx.mp3
14 bill_num 计费次数
15 bill_total 总费用
16 analysis 保留字段

通过日期查询记录

#通过日期查询记录

接口地址

POST/qiongqiapi/getcallbyday.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 callday 是 呼叫时间只能是Ymd格式，如20200216

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/getcallbyday.php?appid=18cf6012-4330-11ea-9310-00163e0c8cf9&appsecret=123456&appkey=zmrh&callday=20200216

返回信息

{
	"status": "200",
	"msg": "success",
	"data": [{
		"start_stamp": "2020-02-16 23:48:25",
		"end_stamp": "2020-02-16 23:48:25",
		"zmrh_core_uuid": "api-c34a8372-50d3-11ea-805d-00163e0c8cf9",
		"call_uuid": "0e46cb8d-5308-46c6-bbdd-53676e7908cd",
		"answer_stamp": null,
		"uduration": "160003",
		"billsec": "0",
		"caller_id_number": "18681471812",
		"hangup_cause": "NO_USER_RESPONSE",
		"app_billing_unit": "0.06",
		"billing_type": "1",
		"node_tts_address": "None",
		"play_url": "http:\/\/114.55.35.119\/qiongqi\/temp\/voice\/15814995155494.wav",
		"bill_num": "0",
		"bill_total": "0.00",
		"analysis": "0"
	}, {
		"start_stamp": "2020-02-16 23:48:25",
		"end_stamp": "2020-02-16 23:48:25",
		"zmrh_core_uuid": "api-c34a8552-50d3-11ea-805d-00163e0c8cf9",
		"call_uuid": "659adf2b-d34e-40e1-8d23-dec6b687916a",
		"answer_stamp": null,
		"uduration": "160003",
		"billsec": "0",
		"caller_id_number": "18520859587",
		"hangup_cause": "NO_USER_RESPONSE",
		"app_billing_unit": "0.06",
		"billing_type": "1",
		"node_tts_address": "None",
		"play_url": "http:\/\/114.55.35.119\/qiongqi\/temp\/voice\/15814995155494.wav",
		"bill_num": "0",
		"bill_total": "0.00",
		"analysis": "0"
	}]
}

返回参数

编号 参数 说明
1 start_stamp 开始时间
2 end_stamp 结束时间
3 zmrh_core_uuid 系统呼叫唯一UUID
4 call_uuid 呼叫UUID
5 answer_stamp 接听时间
6 uduration 处理时间 微秒
7 billsec 通话时长 秒
8 caller_id_number 被叫手机
9 hangup_cause 挂机原因
10 app_billing_unit 计费单位
11 billing_type 计费类型，默认1 6s计费, 2 分钟60秒计费
12 node_tts_address TTS录音地址，如果有play_url忽略，批量上传的呼叫不支持
13 play_url 录音播放地址 如http://xxx.mp3
14 bill_num 计费次数
15 bill_total 总费用
16 analysis 保留字段

通过批次查询记录

#通过日期查询记录

接口地址

POST/qiongqiapi/getcallbybatch.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 callday 是 呼叫时间只能是Ymd格式，如20200216
5 batch 否 批次/备注

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/getcallbyday.php?appid=18cf6012-4330-11ea-9310-00163e0c8cf9&appsecret=123456&appkey=zmrh&callday=20200216

返回信息

{
	"status": "200",
	"msg": "success",
	"data": [{
		"start_stamp": "2020-02-16 23:48:25",
		"end_stamp": "2020-02-16 23:48:25",
		"zmrh_core_uuid": "api-c34a8372-50d3-11ea-805d-00163e0c8cf9",
		"call_uuid": "0e46cb8d-5308-46c6-bbdd-53676e7908cd",
		"answer_stamp": null,
		"uduration": "160003",
		"billsec": "0",
		"caller_id_number": "18681471812",
		"hangup_cause": "NO_USER_RESPONSE",
		"app_billing_unit": "0.06",
		"billing_type": "1",
		"node_tts_address": "None",
		"play_url": "http:\/\/114.55.35.119\/qiongqi\/temp\/voice\/15814995155494.wav",
		"bill_num": "0",
		"bill_total": "0.00",
		"analysis": "0"
	}, {
		"start_stamp": "2020-02-16 23:48:25",
		"end_stamp": "2020-02-16 23:48:25",
		"zmrh_core_uuid": "api-c34a8552-50d3-11ea-805d-00163e0c8cf9",
		"call_uuid": "659adf2b-d34e-40e1-8d23-dec6b687916a",
		"answer_stamp": null,
		"uduration": "160003",
		"billsec": "0",
		"caller_id_number": "18520859587",
		"hangup_cause": "NO_USER_RESPONSE",
		"app_billing_unit": "0.06",
		"billing_type": "1",
		"node_tts_address": "None",
		"play_url": "http:\/\/114.55.35.119\/qiongqi\/temp\/voice\/15814995155494.wav",
		"bill_num": "0",
		"bill_total": "0.00",
		"analysis": "0"
	}]
}

返回参数

编号 参数 说明
1 start_stamp 开始时间
2 end_stamp 结束时间
3 zmrh_core_uuid 系统呼叫唯一UUID
4 call_uuid 呼叫UUID
5 answer_stamp 接听时间
6 uduration 处理时间 微秒
7 billsec 通话时长 秒
8 caller_id_number 被叫手机
9 hangup_cause 挂机原因
10 app_billing_unit 计费单位
11 billing_type 计费类型，默认1 6s计费, 2 分钟60秒计费
12 node_tts_address TTS录音地址，如果有play_url忽略，批量上传的呼叫不支持
13 play_url 录音播放地址 如http://xxx.mp3
14 bill_num 计费次数
15 bill_total 总费用
16 analysis 保留字段

挂机接口推送参数说明(标准)

接口推送参数说明

1、推送地址设置：


2、采用POST表单方式推送，推送参数说明如下：
编号 参数 说明
1 appid 应用ID
2 zmrh_core_uuid 平台会话唯一值
3 call_uuid 呼叫唯一值
4 start_stamp 开始时间 ，格式 “yyyy-MM-dd HH:mm:ss”，如“2020-03-13 13:33:33”,默认为呼叫时间
5 end_stamp 结束时间 ，格式 “yyyy-MM-dd HH:mm:ss”，如“2020-03-13 13:33:33”,如果未接听等于start_stamp
6 answer_stamp 接听时间 ，格式 “yyyy-MM-dd HH:mm:ss” ，如“2020-03-13 13:33:33”,若未接听为“None”
7 uduration 处理时间 微秒
8 billsec 通话时长 秒
9 caller_id_number 被叫手机
10 hangup_cause 接听状态 （详情查看底部状态说明）
11 app_billing_unit 计费单元
12 billing_type 计费类型，默认1 6s计费, 2 分钟60秒计费
13 node_tts_address TTS录音地址，如果有play_url忽略，批量上传的呼叫不支持
14 play_url 录音播放地址 如http://xxx.mp3
15 bill_num 计费次数
16 bill_total 总费用
17 early_media 是否分析挂机原因
18 early_media_text 挂机原因识别【收费项】，状态值包括：正忙，通话中、关机、停机、不在服务区、无法接听、空号、无法接通、不存在、邮箱、秘书、助理、未知 (一般是彩铃音)
19 call_key 客户按键
20 call_pbx_node 呼叫节点，通过该节点可以获取通话录音
21 analysis 是否分析
22 batch 批次/备注
23 sip_hangup_disposition 参考“4.挂机方判断说明”
24 pre_waiting 呼叫接通后等待多少秒开始播放语音

3、hangup_cause字段挂机状态说明：
编号 内容 说明
1 NORMAL_CLEARING 正常接听正常挂断
2 CALL_REJECTED 呼叫拒绝（一般运营商或线路返回603）
3 NO_ANSWER 用户无应答
4 NO_USER_RESPONSE 用户无响应
5 NONE 如果一方主动挂断，另一方为平台挂断则为NONE, 正常
6 NORMAL_TEMPORARY_FAILURE FAILURE：呼叫线路超时
7 NORMAL_UNSPECIFIED 一般是线路不通, 可能盲区
8 RECOVERY_ON_TIMER_EXPIRE 一般是媒体超时, 异常
9 UNALLOCATED_NUMBER 一般是线路不通, 可能盲区
10 USER_BUSY 用户忙
11 其他 呼叫未应答, 异常

4、挂机方判断说明：
编号 内容 说明
1 recv_bye 正常接听后挂机
2 recv_refuse 客户拒接
3 send_cancel 客户不接听、避免等待主动挂机，可以认为是超时未接听
4 send_refuse 线路拒接，如返回40x,50x等 ‌

挂机接口推送参数说明(AI)

接口推送参数说明

1、推送地址设置：

2、采用POST表单方式推送，推送参数说明如下：

编号 参数 说明
1 appid 应用ID
2 zmrh_core_uuid 平台会话唯一值
3 call_uuid 呼叫唯一值
4 start_stamp 开始时间 ，格式 “yyyy-MM-dd HH:mm:ss”，如“2020-03-13 13:33:33”,默认为呼叫时间
5 end_stamp 结束时间 ，格式 “yyyy-MM-dd HH:mm:ss”，如“2020-03-13 13:33:33”,如果未接听等于start_stamp
6 answer_stamp 接听时间 ，格式 “yyyy-MM-dd HH:mm:ss” ，如“2020-03-13 13:33:33”,若未接听为“None”
7 uduration 处理时间 微秒
8 billsec 通话时长 秒
9 caller_id_number 被叫手机
10 hangup_cause 接听状态 （详情查看底部状态说明）
11 app_billing_unit 计费单元
12 billing_type 计费类型，默认1 6s计费, 2 分钟60秒计费
13 node_tts_address TTS录音地址，如果有play_url忽略，批量上传的呼叫不支持
14 play_url 录音播放地址 如http://xxx.mp3
15 bill_num 计费次数
16 bill_total 总费用
17 early_media 是否分析挂机原因
18 early_media_text 挂机原因识别【收费项】，状态值包括：正忙，通话中、关机、停机、不在服务区、无法接听、空号、无法接通、不存在、邮箱、秘书、助理、未知 (一般是彩铃音)
19 call_key 客户按键
20 analysis 是否分析
21 batch 批次/备注
22 nlu_project_id 话术ID
23 voice_typle 语音包，NULL则系统合成到NULL，如果有值则直接
24 tts_info TTS合成参数
25 variable AI变量内容
26 analysis_rules_id 分析规则ID
27 gateway_name 自定义网关（线路）
28 push_cmd 自定义推送地址
29 call_pbx_node 呼叫节点
30 analysis_rules_data 意图分析结果 ： {"rules_name": "规则名称", "billsec": "53", "rules_class": "40秒的", "intent_label": ["已提醒", "二次确认提醒", "正常确认结束"], "all_intent_label": ["已提醒","已确认","二次确认提醒", "正常确认结束"], "v": 4，"follow_label_array":["流程标签1","流程标签2"],"asr_sure":"有效说话次数(ASR有识别的数）","asr_deny":"未说话次数（ASR无识别的数）","key_word_deny":"无意图【在有设置意图的情况下】对话次数（无关键字）,"key_word_sure":"有意图【在有设置意图的情况下】的对话次数"}

3、录音获取

http://call_pbx_node/record_session/年-月/日/zmrh_core_uuid.wav

（如：http://47.112.114.91/record_session/2023-02/08/api-024d9b84-a75e-11ed-af03-00163e0df928.wav）

4、hangup_cause字段挂机状态说明：

编号 内容 说明
1 NORMAL_CLEARING 正常接听正常挂断
2 CALL_REJECTED 呼叫拒绝（一般运营商或线路返回603）
3 NO_ANSWER 用户无应答
4 NO_USER_RESPONSE 用户无响应
5 NONE 如果一方主动挂断，另一方为平台挂断则为NONE, 正常
6 NORMAL_TEMPORARY_FAILURE FAILURE：呼叫线路超时
7 NORMAL_UNSPECIFIED 一般是线路不通, 可能盲区
8 RECOVERY_ON_TIMER_EXPIRE 一般是媒体超时, 异常
9 UNALLOCATED_NUMBER 一般是线路不通, 可能盲区
10 USER_BUSY 用户忙
11 其他 呼叫未应答, 异常

获取AI对话详情

#获取AI对话详情

接口地址

GET/qiongqiapi/getaidialog.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 calltime 是 呼叫时间,时间格式：2023-02-08 12:12:25
4 zmrh_core_uuid 是 呼叫的唯一标识

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/getaidialog.php?appid=xxx&appsecret=xxx&calltime=2023-02-08 12:12:25&zmrh_core_uuid=xxx

返回信息

{
	"status": "200",
	"msg": "success",
	"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"
	}]
}

返回参数

编号 参数 说明
1 addtime 添加时间
2 nlu_project_id 话术ID
3 recording_files 录音地址
4 speak_role 角色, AI:机器人 human:用户
5 zmrh_appid appid
6 zmrh_core_uuid 呼叫唯一标识
7 display 内容
8 main_id 节点ID （AI对话独有）
9 hangup 是否挂机 0：否 1：是（AI对话独有）
10 t_nlp_time NLP响应时长，单位毫秒（AI对话独有）
11 key_worlds 分词（用户对话独有）
12 hit 击中分词（用户对话独有）
13 count_weight 权重（用户对话独有）
14 node_class 节点类型（用户对话独有）
15 intent_label 意图标记（用户对话独有）
16 t_asr ASR响应时长，单位毫秒（用户对话独有）
17 t_record 用户录音，单位毫秒（用户对话独有）

按键接口推送参数说明

接口推送参数说明

采用POST表单方式推送，推送参数说明如下：

编号 参数 说明
1 zmrh_core_uuid 平台会话唯一值
2 caller_id_number 被叫手机
3 call_key 客户按键 （最多支持20字段）
4 batch 批次/备注

获取上传录音文件列表

#获取上传录音文件列表

接口地址

POST/qiongqiapi/getplayfilelist.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/getplayfilelist.php?appid=18cf6012-4330-11ea-9310-00163e0c8cf9&appsecret=123456&appkey=zmrh

返回信息

{
	"status": "200",
	"msg": "success",
	"data": {[{"app_play_url":"http:\/\/xx.xx.xx.xx\/qiongqi\/temp\/voice\/15827760518116.wav"},{"app_play_url":"http:\/\/xx.xx.xx.xx\/qiongqi\/temp\/voice\/15828179289487.wav"}]}
}

返回参数

编号 参数 说明
1 status 调用状态，参考状态说明
2 msg sucess 成功 failed 失败
3 data 返回数据 （app_play_url 文件列表）

设置当前呼叫录音文件

#设置当前呼叫使用的录音文件

接口地址

POST/qiongqiapi/setplayfile.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 app_play_url 是 录音地址，必须是穷奇业务系统上传的才有效

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/setplayfile.php?appid=xxxxxxxxx&appsecret=xxxxxxxx&appkey=zmrh&app_play_url=http://xx.xx.xx.xx/qiongqi/temp/voice/xxxxxxxxxxxx.wav

返回信息

{
	"status": "200",
	"msg": "success",
	"data": "0"}
}

返回参数

编号 参数 说明
1 status 调用状态，参考状态说明
2 msg sucess 成功 failed 失败
3 data 返回数据 （app_play_url 文件列表）

上传录音文件

#上传录音文件

接口地址

POST/qiongqiapi/addplayfile.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 voiceFile 是 录音文件
5 remarks 是 备注名称

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/addplayfile.php?appid=588d10b8-91a6-11ea-85ea-00163e0c8cf9&appsecret=123456&appkey=zmrh&remarks=testupload

返回信息

{
    "status": "200",
    "msg": "success",
    "data": {
        "app_play_url": "http://xxx.xxx.xxx.xxx/qiongqi/voice/588d10b8-91a6-11ea-85ea-00163e0c8cf9/15934119173964.wav"
    }
}

返回参数

编号 参数 说明
1 status 调用状态，参考状态说明
2 msg sucess 成功 failed 失败
3 app_play_url 返回录音播放路径

删除录音文件

#删除录音文件

接口地址

POST/qiongqiapi/delplayfile.php

参数说明:

编号 参数 必填 说明
1 appid 是 应用ID
2 appsecret 是 应用密码=公司密码
3 appkey 是 应用key=公司ID，如zmrh
4 app_play_url 是 录音播放路径

请求示例

http://xxx.xxx.xxx.xxx/qiongqiapi/delplayfile.php?appid=588d10b8-91a6-11ea-85ea-00163e0c8cf9&appsecret=123456&appkey=zmrh&app_play_url=http://xxx.xxx.xxx.xxx/qiongqi/voice/588d10b8-91a6-11ea-85ea-00163e0c8cf9/15934119173964.wav

返回信息

{
    "status": "200",
    "msg": "success",
    "data": ""
}

返回参数

编号 参数 说明
1 status 调用状态，参考状态说明
2 msg sucess 成功 failed 失败
3 data 返回数据

视频演示

视频演示

接口对接演示

  • 单个发起呼叫
  • 批量发起呼叫 (txt号码表)
  • 批量发起呼叫 (号码＋,隔开)
  • 批量发起呼叫 (号码+播放地址)
  • 批量发起呼叫 (号码+文字)

系统操作演示

  • 智媒云号码导入
  • 智媒云号码+文字导入.mp4
  • 智媒云带变量导入

常见问题

传递唯一值

#如何传递唯一值

1、通过全局唯一值

如上图：通过API调用时候返回的唯一值，该值在整个业务生命周期都存在。

2、通过自定义批次

如上图：批次是根据第三方业务需求传递的值，该值可以重复，一般用于第三方标记业务属性。