接上文AI电销机器人-智能AI机器人源码,电话机器人源码和系统部署运行环境freeswitch







21)话术的启用
功能说明:
通过此接口实现对话术的启用。

更新说明: —
请求:
URL:http://{ip}/ai/ai2words/start
请求方法:POST
请求头:必须带上登录时返回的Token
Auth: {登录时返回的Token}
|
参数名 |
类型 |
是否必须 |
描述 |
实例 |
|
wordsId |
Integer |
是 |
话术的编号 |
20 |
响应:
|
参数名 |
类型 |
描述 |
|
errorCode |
Integer |
响应码 0 成功 |
|
Description |
String |
响应描述 |
|
data |
JSON |
详细的数据 |
JSON请求实例:
{
“wordsId”:20,
}
JSON响应实例:
{
“errorCode”: 0,
“description”: “启用成功”,
“data”: “”
}
22)指定话单修改意向等级
功能说明:
通过此接口实现对指定话单修改意向等级。

更新说明: —
请求:
URL:http://{ip}/ai/touchphone/updateGrade
请求方法:POST
请求头:必须带上登录时返回的Token
Auth: {登录时返回的Token}
|
参数名 |
类型 |
是否必须 |
描述 |
实例 |
|
grade |
Integer |
是 |
意向等级 |
21 A类 22 B类 23 C类 24 D类 25 E类 26 F类 |
|
Id |
Integer |
是 |
编号 |
话单编号 |
响应:
|
参数名 |
类型 |
描述 |
|
errorCode |
Integer |
响应码 0 成功 |
|
Description |
String |
响应描述 |
|
data |
JSON |
详细的数据 |
JSON请求实例:
{
“id”: 1,
“grade”: 21
}
JSON响应实例:
{
“errorCode”: 0,
“description”: “操作成功”,
“data”: “”
}
4、系统级回调消息
1)创建用户成功后回调
功能说明:
通过此接口可以实现创建用户成功后,主动推送用户信息到其他系统。
更新说明: —
请求方法:
POST
请求参数:
|
参数名 |
类型 |
是否必须 |
描述 |
实例 |
|
action |
String |
是 |
动作 |
NEW_USER_NOTIFY |
|
username |
String |
是 |
用户账户 |
admin |
|
password |
String |
是 |
密码 |
admin |
|
userId |
String |
是 |
用户ID |
100 |
|
level |
Integer |
是 |
用户等级 |
0 超级管理员 1 普通用户 2 代理用户 |
响应:
|
参数名 |
类型 |
描述 |
|
errorCode |
Integer |
响应码 0 成功 |
|
description |
String |
响应描述 |
入参JSON实例:
{
“action” : “NEW_USER_NOTIFY”,
“username” : “admin”,
“password” : “admin”,
“userId” : 100,
“level” : 0
}
JSON响应实例:
{
“errorCode”: 0,
“description”: “操作成功.”
}
2)删除用户成功后回调
功能说明:
通过此接口可以实现删除用户成功后,主动推送被删除的用户信息到其他系统。
更新说明: —
请求方法:
POST
请求参数:
|
参数名 |
类型 |
是否必须 |
描述 |
实例 |
|
action |
String |
是 |
动作 |
DELETE_USER_NOTIFY |
|
username |
String |
是 |
用户账户 |
admin |
|
userId |
String |
是 |
用户ID |
100 |
响应:
|
参数名 |
类型 |
描述 |
|
errorCode |
Integer |
响应码 0 成功 |
|
description |
String |
响应描述 |
入参JSON实例:
{
“action” : “NEW_USER_NOTIFY”,
“username” : “admin”,
“userId” : 100
}
JSON响应实例:
{
“errorCode”: 0,
“description”: “操作成功.”
}
3)语音验证码拨打电话完成主动回调(语音验证码功能联系管理员授权)
功能说明:
通过此接口可以实现拨打电话播放语音验证码完成后的回调。
更新说明: —
请求:
URL:用户配置的回调地址
请求方法:
POST
请求参数:
|
参数名 |
类型 |
是否必须 |
描述 |
实例 |
|
action |
String |
是 |
动作 |
DAIL_FINISH_NOTIFY |
|
targetPhone |
String |
是 |
被叫号码 |
13666669999 |
|
sourcePhone |
String |
是 |
主叫号码 |
13622225555 |
|
busiId |
String |
是 |
业务ID |
100 |
|
UUID |
String |
是 |
唯一ID |
AAAA-BBBB |
|
touchPhoneId |
Integer |
是 |
通过唯一ID |
通过此ID可以查询对应的通话记录 |
|
conversationTime |
Integer |
是 |
通话时长 |
单位秒 |
响应:
|
参数名 |
类型 |
描述 |
|
errorCode |
Integer |
响应码 0 成功 |
|
description |
String |
响应描述 |
入参JSON实例:
{
“action” : “DAIL_FINISH_NOTIFY”,
“targetPhone” : “13900001111”,
“sourcePhone” : “13022221111”,
“busiId” : “1000”,
“UUID” : “AAAA-BBBB-CCCC-DDDD”,
“touchPhoneId” : 3,
“conversationTime” : 39
}
a
JSON响应实例:
{
“errorCode”: 0,
“description”: “操作成功.”
}
5、用户级回调消息
1)电话拨打完成后的回调
功能说明:
通过此接口可以实现机器人和用户通话完成后,主动推送拨打详情给第三方系统。
更新说明: —
请求方法:
POST
请求参数:
|
参数名 |
类型 |
是否必须 |
描述 |
实例 |
|
action |
String |
是 |
动作 |
USER_PHONE_FINISH_NOTIFY |
|
Id |
Integer |
是 |
编号 |
1 |
|
phone |
String |
是 |
手机号码 |
13600001234 |
|
name |
String |
是 |
名称 |
张三 |
|
source |
String |
是 |
来源 |
广告客户 |
|
intention |
Integer |
是 |
接听状态 |
2 已接听 9未接听挂断/关机/欠费 10无人接听 |
|
grade |
Integer |
否 |
客户等级 |
21 A类(较强) 22 B类(一般) 23 C类(很少) 24 D类(需筛选) 25 E类(需再次跟进) 26 F类(无需跟进) |
|
focus |
String |
否 |
客户关注点 |
利息多少 |
|
uploadtime |
Long |
是 |
上传时间 |
1544436127000 |
|
dailtime |
Long |
是 |
拨打时间 |
1544436127000 |
|
conversationtime |
Integer |
否 |
通话时长,单位:秒 |
30 |
|
talkcount |
Integer |
否 |
通话轮次 |
3 |
|
touchPhoneId |
Integer |
是 |
通过唯一ID |
通过此ID可以查询对应的通话记录 |
|
sex |
String |
否 |
性别 |
男 |
|
company |
String |
否 |
公司 |
XXX公司 |
|
sort |
String |
否 |
分类 |
XXX分类 |
|
address |
String |
否 |
地址 |
XXX 地址 |
|
remark1 |
String |
否 |
备注1 |
备注1 |
|
remark2 |
String |
否 |
备注2 |
备注2 |
|
remark3 |
String |
否 |
备注3 |
备注3 |
|
remark4 |
String |
否 |
备注4 |
备注4 |
|
remark5 |
String |
否 |
备注5 |
备注5 |
|
wordsId |
Integer |
否 |
话术ID |
话术ID |
|
wordsName |
String |
否 |
话术的名称 |
话术的名称 |
|
userId |
Integer |
是 |
用户ID |
用户ID |
|
taskId |
Integer |
是 |
任务ID |
默认0 快捷拨打任务编号 其它为创建的任务的编号 |
|
chatList |
Array |
否 |
对话记录 |
对话格式见案例 |
响应:
|
参数名 |
类型 |
描述 |
|
errorCode |
Integer |
响应码 0 成功 |
|
description |
String |
响应描述 |
入参JSON实例:
{
“action” : “USER_PHONE_FINISH_NOTIFY”,
“phone” : “13699998888”,
“name” : “张三”,
中间省略
“userId” : 100,
“taskId” : 23,
“chatList” : [{
“id”: 15676,
“inserttime”: 1544436127000,
“khcontent”: “喂,您好!(停顿两秒)您好,这边是可以大量外呼的销售机器人,您有兴趣了解下吗?”,
“khtype”: 0,
“khvoicepath”: “RDovdm9pY2VGaWxlL0FJMnFpdGFjaGFucGludHVpZ3VhbmctamlxaXJlbnppeGlhby0xODkyOF8yMDE4MTExMjE0MTMwM181NDkvdXBsb2FkLTIwMTgwOTI5MTQyMzA0XzQ0Ni53YXY=”,
“phone”: “900113668161682”,
“touchphoneid”: 4744,
“uuid”: “058f1e0f-bc4c-4ee7-8256-377ce02f03d1”
}, {
“id”: 15677,
“inserttime”: 1544436131000,
“khcontent”: “啊”,
“khtype”: 1,
“khvoicepath”: “RDovcmVjb3JkLzIwMTgtMTItMTAvOTAwMTEzNjY4MTYxNjgyXzA1OGYxZTBmLWJjNGMtNGVlNy04MjU2LTM3N2NlMDJmMDNkMV8xLndhdg==”,
“phone”: “900113668161682”,
“touchphoneid”: 4744,
“uuid”: “058f1e0f-bc4c-4ee7-8256-377ce02f03d1”
}]
}
JSON响应实例:
{
“errorCode”: 0,
“description”: “操作成功.”
}
2)任务自动拨打完成后的回调
功能说明:
通过此接口可以实现机器人的任务自动拨打完成后,主动推送拨打详情给第三方系统。
更新说明: —
请求方法:
POST
请求参数:
|
参数名 |
类型 |
是否必须 |
描述 |
实例 |
|
action |
String |
是 |
动作 |
USER_TASK_FINISH_NOTIFY |
|
taskId |
Integer |
是 |
任务编号 |
默认0 快捷拨打任务编号 其它为创建的任务的编号 |
|
taskName |
String |
是 |
任务名称 |
任务名称 |
|
userId |
Integer |
是 |
用户ID |
用户ID |
|
taskId |
Integer |
是 |
任务ID |
默认0 快捷拨打任务编号 其它为创建的任务的编号 |
|
status |
Integer |
是 |
任务状态 |
10已完成 |
响应:
|
参数名 |
类型 |
描述 |
|
errorCode |
Integer |
响应码 0 成功 |
|
description |
String |
响应描述 |
入参JSON实例:
{
“action” : ” USER_TASK_FINISH_NOTIFY”,
“taskId” : 1,
“taskName” : “快捷外呼”,
“userId” : 100,
“taskId” : 23
}
JSON响应实例:
{
“errorCode”: 0,
“description”: “操作成功.”
}
6、测试工具PostMan
1)登录测试

请求模式选择:POST

Body标签页下面输入请求内容,见上图。
登录成功,返回:

1)语音验证码播放测试

请求头输入认证KEY和VALUE,见上图

7、FAQ
1、此文档是系统所有接口的全部么?
答:不是的,整套系统都是采用的RESTful调用,也就是任何功能都有RESTful接口,但提供商没有将所有接口文档化。没有文档化的接口,根据对接端客户的需求再进行二次文档化。客户购买系统后,也可以通过谷歌浏览器按F12进入调式模式的方式查询每个功能的RESTful的接口详情。






本文来自网络,不代表协通编程立场,如若转载,请注明出处:https://net2asp.com/d4615ef348.html
