智能语音系统

Restful接口文档

一、开发引导 

调用说明

调用方式说明：

第一种方式：主动调用 这种调用方式是客户主动调用接口获取数据或实现功能；

主动调用需要传入APP_KEY和APP_SECRET用于权限校验；

注意：请在开发对接程序前联系技术支持进行注册，如果你还未签约，请先签约开通账户。

第二种方式：方法回调 这种调用方式是当达到预设条件如：任务完成或通话结束时，由系统主动向指定地址发送信息；

注意：请在开发前自主配置好回调地址。

机器人API是使用HTTP并遵循REST原则设计的Web服务接口；

您可以使用几乎任何客户端和任何编程语言与REST API进行交互。

通过发送简单的HTTP请求就可以轻松接入使用。

调用方式分为两种：主动调用和方法回调。

统一请求格式

URL格式：

/ai/{resource}/{function}

说明：

{resource}为资源名，通常对应一类API

{function}为该资源提供的操作方法

请求响应的结果为json格式

我们目前已经提供的接口，请参考API。

HTTP头信息:

Accept:application/json;charset=utf-8

说明：

请求方式(Method)：统一用POST方式 编码：UTF-8

二、接口说明 

1、系统级-配置回调地址（超级管理员使用）

D:\huluwa\config\config.properties

找打以上文件，配置以下项：

huluwa.callbackURL = http://192.168.1.100/callback

配置完成后，重启系统。

2、用户级-配置回调地址（普通用户使用）

进入“计划与推送”菜单配置事件回调地址

3、主动接收消息

1）登录接口，获取令牌

功能说明：

通过此接口可以获取到登录Token，后续任何请求只需要发送Token即可完成请求验证。

更新说明： --

请求：

URL：http://{ip}/ai/user/mmlogin

请求方法：

POST

请求参数:

响应：

入参JSON实例：

{

    "username" : "test",

    "password" : "123456",

}

JSON响应实例：

{

    "errorCode": 0,

    "description": "登录成功.", //返回刚刚创建的任务ID

    "Auth": "86AB322122CE394A3258FDE585C6BA16",

    "data": {用户对象数据}

}

2）拨打电话，播放语音验证码

功能说明：

通过此接口可以实现拨打电话并播放语音验证码。

更新说明： --

请求：

URL：http://{ip}/ai/audiovercode/play

请求方法：

POST

请求头：必须带上登录时返回的Token

Auth: {登录时返回的Token}

请求参数:

响应：

入参JSON实例：

{

    "targetPhone" : "13900001111",

"sourcePhone" : "13022221111",

"busiId" : "1000",

"file" : "UUXA23LXXLSOEK2KXKDJELLSLSLOIEKXK8929KXKXLXLDKKELXDLEKK23L",

"talkContent" : "验证码是：5599",

"retry" : 3

}

JSON响应实例：

{

    "errorCode": 0,

    "description": "操作成功."

}

3）设置拨打时间段

功能说明：

通过此接口可以实现新增拨打时间段。

更新说明： --

请求：

URL：http://{ip}/ai/dialtimerange/add

请求方法：

POST

请求头：必须带上登录时返回的Token

Auth: {登录时返回的Token}

响应：

入参JSON实例：

{

    "startTime" : "09:30",

"endTime" : "10:50"

}

JSON响应实例：

{

    "errorCode": 0,

    "description": "操作成功."

}

查询所有的拨打时间段

功能说明：

通过此接口可以实现当前所有的拨打时间段。

更新说明： --

请求：

URL：http://{ip}/ai/dialtimerange/refresh

请求方法：

GET

请求头：必须带上登录时返回的Token

Auth: {登录时返回的Token}

响应：

响应data的参数说明：

JSON响应实例：

{

"errorCode": 0,

"description": "",

"data": [{

"endtime": "12:30",

"id": 1,

"operate": 1,

"starttime": "09:30",

"userid": 1

}, {

"endtime": "18:30",

"id": 2,

"operate": 1,

"starttime": "13:30",

"userid": 1

}, {

"endtime": "10:50",

"id": 702,

"operate": 1,

"starttime": "09:30",

"userid": 1

}]

}

启用或停用拨打时间段

功能说明：

通过此接口可以实现拨打时间段的启用或停用。

更新说明： --

请求：

URL：http://{ip}/ai/dialtimerange/update

请求方法：

POST

请求头：必须带上登录时返回的Token

Auth: {登录时返回的Token}

响应：

入参JSON实例：

{

"id": 702,

"operate": 1

}  

JSON响应实例：

{

    "errorCode": 0,

    "description": "操作成功."

}

4）快速拨打电话

功能说明：

通过此接口实现快速拨打电话。

更新说明： --

请求：

URL：http://{ip}/ai/notouchphone/addPhone

请求方法：

POST

请求头：必须带上登录时返回的Token

Auth: {登录时返回的Token}

userData的数据结构体：

响应：

入参JSON实例：

{

"userData": [

{

"phone":"13699998888",

"name":"张三",

"source":"网络",

"sex":"男",

"companyname":"科技有限公司",

"sort":"聚合",

"address":"北京前门",

"remark1":"备注1",

"remark2":"备注2",

"remark3":"备注3",

"remark4":"备注4",

"remark5":"备注5"

},

{

"phone":"13699996666",

"name":"李四",

"source":"网络",

"sex":"男",

"companyname":"科技有限公司",

"sort":"聚合",

"address":"北京前门",

"remark1":"备注1",

"remark2":"备注2",

"remark3":"备注3",

"remark4":"备注4",

"remark5":"备注5"

}

],

"ai2WordsId":1

}  

或userData入参实列

{

"phone":"13966661111,13622221111",

"ai2WordsId":1

}  

JSON响应实例：

{

    "errorCode": 0,

    "description": "加入拨打计划成功."

}

5）导入号码文件

功能说明：

通过此接口实现批量号码导入。

更新说明： --

请求：

URL：http://{ip}/ai/notouchphone/uploadFile

请求方法：

POST

请求头：必须带上登录时返回的Token

Auth: {登录时返回的Token}

请求头：

Content-Type: multipart/form-data;

BODY部分上传文件

6）将所有号码加入拨打或结束拨打

功能说明：

通过此接口实现起用所有号码的拨打。

更新说明： --

请求：

URL：http://{ip}/ai/notouchphone/updateAll

请求方法：

POST

请求头：必须带上登录时返回的Token

Auth: {登录时返回的Token}

响应：

入参JSON实例：

{

"id":"-1","status":1

}  

JSON响应实例：

{

    "errorCode": 0,

    "description": ""

}

7）批量分页获取待拨打名单列表

功能说明：

通过此接口实现查询所有待拨打名单列表。

更新说明： --

请求：

URL：http://{ip}/ai/notouchphone/phone/{page}

请求方法：GET

URL变量值：{page}是当前请求的页码，比如当前请求第5页，直接发送

http://{ip}/ai/notouchphone/phone/5

请求头：必须带上登录时返回的Token

Auth: {登录时返回的Token}

响应：

Data数据结构体说明：

JSON响应实例：

{

"errorCode": 0,

"description": "",

"pages": 418,

"pageSize": 30,

"pageNum": 1,

"total": 12529,

"data": [{

"dialFailedCount": 0,

"id": 2,

"noUserResponseCount": 0,

"phone": "133****1176",

"status": 0,

"uploadtime": 1543308937000,

"userid": 1

}, {

"dialFailedCount": 0,

"id": 3,

"noUserResponseCount": 0,

"phone": "158****8344",

"status": 0,

"uploadtime": 1543308937000,

"userid": 1

}]

}

8）批量分页获取已拨打名单列表

功能说明：

通过此接口实现查询所有已拨打名单列表。

更新说明： --

请求：

URL：http://{ip}/ai/touchphone/phone/{page}

请求方法：GET

URL变量值：{page}是当前请求的页码，比如当前请求第5页，直接发送

http://{ip}/ai/touchphone/phone/5

请求头：必须带上登录时返回的Token

Auth: {登录时返回的Token}

响应：

JSON响应实例：

{

"errorCode": 0,

"description": "",

"pages": 6,

"pageSize": 30,

"pageNum": 1,

"total": 160,

"data": [{

"callinout": 0,

"chanelEndTime": 0,

"channelStartTime": 0,

"dialtime": 1544423883000,

"id": 161,

"intention": 9,

"phone": "136****1682",

"telephoneMinute": 0,

"readstatus": 1,   //此属性 == 1 表示已读，没有此属性或==0 未读

"userid": 1,

"uuid": "479bb159-6073-4e3d-a6ba-b9a033751f2e"

}, {

"callinout": 0,

"chanelEndTime": 0,

"channelStartTime": 0,

"conversationtime": 13,

"dialtime": 1544412340000,

"grade": 26,

"id": 160,

"intention": 2,

"phone": "136****1682",

"telephoneMinute": 1,

"userid": 1,

"uuid": "6b9ab6e3-99c7-46b6-be80-49aa9a4501b8"

}]

}

Data数据结构体说明：

9）单个查询拨打详情

功能说明：

通过此接口查询拨打的详情数据。

更新说明： --

请求：

URL：http://{ip}/ai/touchphone/id/{id}

请求方法：GET

URL变量值：{id}是当前请求的拨打记录的编号，比如当前请求的编号是 5，直接发送

http://{ip}/ai/touchphone/id/5

请求头：必须带上登录时返回的Token

Auth: {登录时返回的Token}

响应：

JSON响应实例：

{

"errorCode": 0,

"description": "",

"data": {

"callinout": 0,

"chanelEndTime": 0,

"channelStartTime": 0,

"conversationtime": 19,

"dialtime": 1544436117000,

"grade": 25,

"id": 4744,

"intention": 2,

"phone": "13699995555",

"recordfilepath": "RDovcmVjb3JkLzIwMTgtMTItMTAvOTAwMTEzNjY4MTYxNjgyLjA1OGYxZTBmLWJjNGMtNGVlNy04MjU2LTM3N2NlMDJmMDNkMS5tcDM=",

"tableIndex": "",

"talkCount": 2,

"talkStatus": 1,

"telephoneMinute": 1,

"uploadtime": 1544436117000,

"userid": 1,

"uuid": "058f1e0f-bc4c-4ee7-8256-377ce02f03d1"

}

}

Data数据结构体说明：

10）查询对话详情

功能说明：

通过此接口查询拨打的详情数据。

更新说明： --

请求：

URL：http://{ip}/ai/chat/tpid/{id}

请求方法：GET

URL变量值：{id}是当前请求的拨打记录的编号，比如当前请求的编号是 5，直接发送

http://{ip}/ai/chat/tpid/5

请求头：必须带上登录时返回的Token

Auth: {登录时返回的Token}

响应：

JSON响应实例：

{

"errorCode": 0,

"description": "",

"pages": 1,

"pageSize": 7,

"pageNum": 1,

"total": 7,

"data": [{

"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"

}]

}

Data数据结构体说明：

11）获取音频流

功能说明：

通过此接口获取录音文件的音频流。

更新说明： --

请求：

URL：http://{ip}/ai/touchphone/audio/{path}

请求方法：GET

URL变量值：{path}是查询拨打详情，系统返回的地址，见第8小节或第9小节字段：khvoicepath或recordfilepath

http://{ip}/ai/touchphone/audio/RDovcmVjb3JkLzIwMTgtMTEtMzAvMTM4ODAzMDc5OTMuNThiNmI3YmUtODliNC00NTQ1LWI1ZmMtNjc2MzBiMDBlNWFjLm1wMw==

请求头：必须带上登录时返回的Token

Auth: {登录时返回的Token}

响应：二进制音频流。

12）批量获取任务

功能说明：

通过此接口实现查询当前用户的最新的前100条任务。

更新说明： --

请求：

URL：http://{ip}/ai/task/find100

请求方法：GET

请求头：必须带上登录时返回的Token

Auth: {登录时返回的Token}

响应：

Data数据结构体说明：

JSON响应实例：

[

    {

        "aintentionrate": 0,

        "allcount": 60,

        "bflines": 2,

        "bintentionrate": 0,

        "cintentionrate": 0,

        "configFaultCount": 99999,

        "connectedcount": 0,

        "continuousFaultCount": 0,

        "createtime": 1619766179000,

        "curLines": 0,

        "dialmodel": 0,

        "dialprogress": 0,

        "dialswitchonrate": 0,

        "dintentionrate": 0,

        "disabled": 1,

        "eintentionrate": 0,

        "endtime": "18:00",

        "fintentionrate": 0,

        "id": 13,

        "intentionrate": 0,

        "noendtime": "13:30",

        "noheardcount": 0,

        "nostarttime": "12:10",

        "startdate": 1619712000000,

        "starttime": "09:00",

        "status": 1,

        "switchoffcount": 0,

        "talkxy2rate": 0,

        "talkxy4rate": 0,

        "talkxy6rate": 0,

        "talkxy9rate": 0,

        "talkzy10rate": 0,

        "taskName": "测试_xxxxx",

        "timexy10rate": 0,

        "timexy119rate": 0,

        "timexy59rate": 0,

        "timezy120rate": 0,

        "updatetime": 1619766179000,

        "userid": 1,

        "wordsid": 1,

        "wordsname": "贷款话术1.0"

    },

    {

        "aintentionrate": 0,

        "allcount": 0,

        "bflines": 1,

        "bintentionrate": 0,

        "cintentionrate": 0,

        "configFaultCount": 1,

        "connectedcount": 0,

        "continuousFaultCount": 0,

        "createtime": 1619681731000,

        "curLines": 0,

        "dialmodel": 0,

        "dialprogress": 0,

        "dialswitchonrate": 0,

        "dintentionrate": 0,

        "disabled": 1,

        "eintentionrate": 0,

        "endtime": "18:00",

        "fintentionrate": 0,

        "id": 11,

        "intentionrate": 0,

        "noendtime": "13:30",

        "noheardcount": 0,

        "nostarttime": "12:10",

        "startdate": 1618243200000,

        "starttime": "09:00",

        "status": 10,

        "switchoffcount": 0,

        "talkxy2rate": 0,

        "talkxy4rate": 0,

        "talkxy6rate": 0,

        "talkxy9rate": 0,

        "talkzy10rate": 0,

        "taskName": "test",

        "timexy10rate": 0,

        "timexy119rate": 0,

        "timexy59rate": 0,

        "timezy120rate": 0,

        "updatetime": 1619681731000,

        "userid": 1,

        "wordsid": 1,

        "wordsname": "贷款话术1.0"

    }

]

13）创建拨打任务

功能说明：

通过此接口实现创建拨打任务。

更新说明： --

请求：

URL：http://{ip}/ai/task/add

请求方法：

POST

请求头：必须带上登录时返回的Token

Auth: {登录时返回的Token}

userData的数据结构体：

DialWeek的数据结构体：

响应：

入参JSON实例：

{

"taskName": "test0909",

"startDate": "2019-09-28",

"startTime": "9:00",

"endTime": "18:00",

"noStartTime": "12:10",

"noEndTime": "13:30",

"wordsId": "3314",

"configFaultCount": "",

"bfLines": "1",

"userData": [

{

"phone":"13699998888",

"name":"张三",

"source":"网络",

"sex":"男",

"companyname":"科技有限公司",

"sort":"聚合",

"address":"北京前门",

"remark1":"备注1",

"remark2":"备注2",

"remark3":"备注3",

"remark4":"备注4",

"remark5":"备注5"

},

{

"phone":"13699996666",

"name":"李四",

"source":"网络",

"sex":"男",

"companyname":"科技有限公司",

"sort":"聚合",

"address":"北京前门",

"remark1":"备注1",

"remark2":"备注2",

"remark3":"备注3",

"remark4":"备注4",

"remark5":"备注5"

}

]

}

JSON响应实例：

{

"errorCode": 0,

"description": "创建成功。",

"data": {

"taskId":1

}

}

14）开始任务、暂停任务

功能说明：

通过此接口实现任务的开始、暂停

更新说明： --

请求：

URL：http://{ip}/ai/task/updateStatus

请求方法：

POST

请求头：必须带上登录时返回的Token

响应：

JSON请求实例：

{

"taskId":"12",

"status":2

}

JSON响应实例：

{

"errorCode": 0,

"description": "操作成功",

"data": ""

}

15）编辑任务

功能说明：

通过此接口实现任务的编辑。

更新说明： --

请求：

URL：http://{ip}/ai/task/modify

请求方法：

POST

请求头：必须带上登录时返回的Token

DialWeek的数据结构体：

响应：

JSON请求实例：

{

    "id": "13",

    "taskName": "测试_xxxxx",

    "startDate": "2021-04-30",

    "startTime": "09:00",

    "endTime": "18:00",

    "noStartTime": "12:10",

    "noEndTime": "13:30",

    "wordsId": "1",

    "configFaultCount": "99999",

    "bfLines": "2",

    "dialWeek": {

        "day1": 0,

        "day2": 1,

        "day3": 1,

        "day4": 0,

        "day5": 0,

        "day6": 0,

        "day7": 0,

        "finishPush": 1,

        "nearFinishPush": 0

    }

}

JSON响应实例：

{

"errorCode": 0,

"description": "操作成功",

"data": ""

}

16）删除任务

功能说明：

通过此接口实现任务的开始、暂停

更新说明： --

请求：

URL：http://{ip}/ai/task/delete

请求方法：

POST

请求头：必须带上登录时返回的Token

响应：

JSON请求实例：

{

    "id": 17

}

JSON响应实例：

{

"errorCode": 0,

"description": "操作成功",

"data": ""

}

17）删除任务的已拨打号码

功能说明：

通过此接口实现删除任务的已拨打号码

更新说明： --

请求：

URL：http://{ip}/ai/touchphone/delete

请求方法：

POST

请求头：必须带上登录时返回的Token

响应：

JSON请求实例：

{

    "id": "4,3"

}

JSON响应实例：

{

"errorCode": 0,

"description": "操作成功",

"data": ""

}

18）批量添加号码

功能说明：

通过此接口实现任务的号码添加。

更新说明： --

请求：

URL：http://{ip}/ai/notouchphone/insertDb

请求方法：

POST

请求头：必须带上登录时返回的Token

Data的对象结构体：

响应：

JSON请求实例：

{

"taskId": 22,

"data":

[{

"phone":"15555555555",

"name": "张三",

},{

"phone":"15555555555",

"name": "张三"

}]}

JSON响应实例：

{

"errorCode": 0,

"description": "操作成功",

"data": ""

}

19）获取指定任务的待拨打号码

功能说明：

通过此接口实现查询指定任务的待拨打的号码。

更新说明： --

请求：

URL：http://{ip}/ai/notouchphone/phone/{页码}?taskId={任务ID}

请求方法：GET

请求头：必须带上登录时返回的Token

Auth: {登录时返回的Token}

响应：

Data数据结构体说明：

JSON响应实例：

{

    "errorCode": 0,

    "description": "",

    "pages": 2,

    "pageSize": 30,

    "pageNum": 2,

    "total": 60,

    "data": [

        {

            "address": "",

            "companyName": "",

            "dialFailedCount": 0,

            "id": 245670,

            "name": "",

            "noUserResponseCount": 0,

            "phone": "180****5326",

            "remark1": "",

            "remark2": "",

            "remark3": "",

            "remark4": "",

            "remark5": "44764",

            "sex": "",

            "sort": "",

            "source": "",

            "status": 1,

            "taskId": 13,

            "uploadtime": 1619766179000,

            "userid": 1

        },

        {

            "address": "",

            "companyName": "",

            "dialFailedCount": 0,

            "id": 245671,

            "name": "",

            "noUserResponseCount": 0,

            "phone": "180****5553",

            "remark1": "",

            "remark2": "",

            "remark3": "",

            "remark4": "",

            "remark5": "44765",

            "sex": "",

            "sort": "",

            "source": "",

            "status": 1,

            "taskId": 13,

            "uploadtime": 1619766179000,

            "userid": 1

        }

    ]

}

20）获取话术

功能说明：

通过此接口实现查询系统当前所有的话术。

更新说明： --

请求：

URL：http://{ip}/ai/ai2words/find

请求方法：GET

请求头：必须带上登录时返回的Token

Auth: {登录时返回的Token}

响应：

Data数据结构体说明：

JSON响应实例：

{

"errorCode": 0,

"description": "",

"data": [{

"asrWait": 3000,

"copyNumber": 0,

"createtime": 1548413428000,

"defaultGrade": 24,

"dirPath": "D:/voiceFile/AI2huifang_20190819141705_40/",

"hotWords": "旺旺留言",

"id": 188,

"ismarket": 0,

"isonline": 1,

"ispy": 0,

"ispyVague": 0,

"isuse": 0,

"playbackWait": 5000,

"unKnowPriority": 0,

"updatetime": 1556181841000,

"userid": 1,

"wordsDescription": "",

"wordsSubType": 10001,

"wordsType": 10000,

"wordsname": "回访"

}]

}

21）话术的启用

应用截图