# 接口文档
# 协议说明
基于http协议，通过HTTP的 POST 方式交换数据，推荐使用HTTP长连接。
双方需要保证数据传输的完整性和安全性。安全认证采用数字签名的方式，数字签名根据密码、手机号、时间戳32位MD5生成
# 规范说明
# 字符编码
服务器请求和返回都采用UTF-8编码
# 接口地址
https://www.djkf.cn/platform/api/
# 语音通知发送
此接口用于单个语音通知消息，例如
语音通知语音验证码语音报警等应用场景。
# 请求格式
| HTTP方法 | URL | 描述 |
|---|---|---|
| POST | /open/notification | |
| 消息参数 | 是否必填 | 描述 |
| account | 是 | 用户接口账号(点集提供的apiAccount) |
| password | 是 | 数字签名：(接口密码(点集提供的apiKey)+手机号+时间戳 32位MD5加密生成) |
| mobile | 是 | 接收语音通知的号码，（暂时只支持一个号码） |
| templateId | 是 | 语音通知模板ID，在语音后台设置好联系客服审核通过即可使用 |
| timestamps | 是 | 时间戳，语音通知发送当前时间毫秒数，生成数字签名用，有效时间1分钟，强烈建议实时生成 |
| paramsJson | 否 | 动态参数，json转string。例如："{"name":"王先生","type":"短信"}"。绑定模板中有动态参数时必须传对应参数。 |
示例
account=a923hjidfsifokw908234kjopspo9892&password=a857f9e0a3fff325c5072130526e10aa&mobile=14748551184&templateId=1392030959419392¶msJson="{"code":"8899"}"×tamps=1699263716732
# 响应格式
| 消息体 | 类型 | 描述 |
|---|---|---|
| code | Int | 响应码见附录- respcode |
| msg | String | 信息标识，用于对应状态报告 |
| data | Long | 请求成功后对应此次语音通知唯一的业务ID(businessId) |
| repId | Long | 接口唯一Id，若请求错误请提供该ID以便排查问题 |
返回报文示例：
{
"code": 200,
"msg": "请求成功",
"data": 1392036383621120
}
1
2
3
4
5
2
3
4
5
# 语音机器人任务创建
# 请求格式
| HTTP方法 | URL | 描述 |
|---|---|---|
| POST | /open/task | |
| 消息参数 | 是否必填 | 描述 |
| account | 是 | 用户接口账号(点集提供的apiAccount) |
| password | 是 | 数字签名：(接口密码(点集提供的apiKey)+手机号+时间戳 32位MD5加密生成) |
| mobile | 是 | 语音账户绑定的手机号 |
| temId | 是 | 任务模板ID，制作完话术并设置好模板任务获取 |
| timestamps | 是 | 时间戳，语音通知发送当前时间毫秒数，生成数字签名用，有效时间1分钟，强烈建议实时生成 |
| robotNum | 否 | 设置该任务默认使用机器人数量(默认为1，最大不能超过账户拥有机器人数量) |
| data | 是 | 外呼数据，数据采用JSONString格式加密。格式内容如下： |
任务数据加密前的内容格式：
[
{
"name": "张三",
"phone": "18688888888",
"ext1": "扩展参数1",
"ext2": "扩展参数2",
"ext3": "扩展参数3",
"ext4": "扩展参数4",
"ext5": "扩展参数5"
},
{
...
}
]
//（以上数据是加密前的格式，发送过来的数据是经过RSA加密的结果。）
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
DATA数据使用RSA加密。密钥请联系客服管理员获取，密钥用于请求内容加密与回执内容解密。请妥善保管！！！
# 响应格式
| 消息体 | 类型 | 描述 |
|---|---|---|
| code | int | 响应码见附录- respcode |
| msg | String | 信息标识，用于对应状态报告 |
| data | obj | 请求返回参数 |
| data.taskId | Long | 任务ID，后续可根据此ID操作对应任务 |
| data.total | int | 任务外呼总数 |
| data.submitNum | int | 提交总数 |
| data.errorNum | int | 错误数据数量 |
| data.errorData | Obj | 错误数据原因 |
| data.errorData.mobile | String | 错误数据手机号 |
| data.errorData.code | int | 错误状态码(1:重复;2:手机格式错误;3:黑名单;) |
| repId | Long | 接口唯一Id，若请求错误请提供该ID以便排查问题 |
返回报文示例：
{
"code": 200,
"msg": "请求成功",
"data": {
"taskId": 137898204370,
"total": 100,
"submitNum": 98,
"errorNum": 2,
"errorData": [
{
"mobile": "18688888888",
"code": "1"
},
{
...
}
]
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# 语音机器人任务操作
# 请求格式
| HTTP方法 | URL | 描述 |
|---|---|---|
| POST | /open/task/update | |
| 消息参数 | 是否必填 | 描述 |
| account | 是 | 用户接口账号(点集提供的apiAccount) |
| password | 是 | 数字签名：(接口密码(点集提供的apiKey)+手机号+时间戳 32位MD5加密生成) |
| mobile | 是 | 语音账户绑定的手机号 |
| taskId | 是 | 任务ID,需要操作的任务ID |
| timestamps | 是 | 时间戳，语音通知发送当前时间毫秒数，生成数字签名用，有效时间1分钟，强烈建议实时生成 |
| status | 是 | 操作任务为指定状态code， 枚举：（启动：1，暂停：0，取消：-1） |
# 响应格式
| 消息体 | 类型 | 描述 |
|---|---|---|
| code | Int | 响应码见附录- respcode |
| msg | String | 信息标识，用于对应状态报告 |
| data | String | 请求结果 |
| repId | Long | 接口唯一Id，若请求错误请提供该ID以便排查问题 |
返回报文示例：
{
"code": 200,
"msg": "请求成功",
"data": 1392036383621120
}
1
2
3
4
5
2
3
4
5