电话机器人商用部署

调用说明

调用方式说明：

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

主动调用需要传入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

请求参数:

参数名

类型

是否必须

描述

实例

username

String

是

登录帐号

test

psd

String

是

登录密码

******

响应：

参数名

类型

描述

errorCode

Integer

响应码  0 成功

Description

String

响应描述

Auth

String

成功响应的Token

data

Object

用户对象

入参JSON实例：

{

    "username" : "test",

    "psd" : "******",

}

JSON响应实例：

{

    "errorCode": 0,

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

    "Auth": "86AB322122CE394A3258FDE585C6BA16",

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

}

2）拨打电话，播放语音验证码
功能说明：

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

更新说明： --

请求：

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

请求方法：

POST

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

Auth: {登录时返回的Token}

请求参数:

参数名

类型

是否必须

描述

实例

targetPhone

String

是

被叫号码

13331233595

sourcePhone

String

是

主叫号码

13331233595

busiId

String

否

业务ID

100

file

String

否

语音文件的Base64编码

--

fileName

String

否

文件名称

如：aaa.wav如果系统已存在相同的文件名，直接使用不解析file字段。以提升性能。

talkContent

String

否

转TTS的文字

验证码：5566

retry

Integer

否

默认 1 次后挂机

响应：

参数名

类型

描述

errorCode

Integer

响应码  0 成功

Description

String

响应描述

入参JSON实例：

{

    "targetPhone" : "13331233595",

"sourcePhone" : "13331233595",

"busiId" : "1000",

"file" : "UUXA23LXXLSOEK2KXKDJELLSLSLOIEKXK8929KXKXLXLDKKELXDLEKK23L",

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

"retry" : 3

}

JSON响应实例：

{

    "errorCode": 0,

    "description": "操作成功."