二、 语音验证码API
1.1 版本说明
| 日期 | 版本 | 修订内容摘要 |
|---|
| 2023-08-24 | v1.0.0 | 更新接口文档 |
1.2 协议说明
1.3 请求参数
数据提交方式：x-www-form-urlencoded
| 参数名 | 参数类型 | 是否必传 | 参数说明 |
|---|
| appId | String | 是 | 应用id ，详情请看,功能介绍->接口详情 |
| appKey | String | 是 | 应用key ，详情请看,功能介绍->接口详情 |
| mobile | String | 是 | 被叫号码，限单个，仅支持11位国内号码 |
| content | String | 是 | 验证码内容，4-6位数字 |
| billUrl | String | 否 | 话单推送回调地址 （长度250以内） |
| transData | String | 否 | 透传数据(话单推送回调时返回 长度50以内) |
请求示例：
{
"appId": "*****",
"appKey": "*****,
"mobile": "176***5202"
"content": "你好，您的验证码是：123456",
"billUrl": "http://****/voice/test/test3",
"transData": "3333"
}
1.4 响应内容
响应 body 数据为 JSON 格式。
| 字段名 | 类型 | 说明 |
|---|
| code | String | 响应 code 码。200000：成功，其他失败。详见code码 |
| message | String | 响应 code 码解释 |
| data | Object | 返回对象 |
| callId | String | 呼叫唯一标识 Id |
1.5 返回数据示例（成功）
{
"message": "请求成功",
"data": {
"callId": "YYYZM9*******564224"
},
"code": "200000"
}
1.6 返回数据示例（失败）
{
"message": "系统异常",
"code": "500000"
}
二、 消息状态报告推送
2.1 版本说明
| 日期 | 版本 | 修订内容摘要 |
|---|
| 2023-08-24 | v1.0.0 | 更新接口文档 |
2.2 推送格式说明
| 名称 | 说明 |
|---|
| 接口名称 | 消息状态报告推送 |
| 协议 | HTTPS POST |
| 编码格式 | UTF8 |
| Content-Type | application/x-www-form-urlencoded |
| 返回类型 | application/json |
2.2 请求参数
数据回推方式：x-www-form-urlencoded
| 参数名 | 参数类型 | 是否必传 | 参数说明 |
|---|
| callId | String | 是 | 调用ID号，每次调用生成唯一的ID号 |
| callDesc | String | 是 | 通话结束原因状态码 详见code码 |
| callDescMsg | String | 是 | 通话结束原因状态码描述 |
| callStatus | String | 是 | 呼叫结果 0-成功 1-失败 |
| mobile | String | 是 | 被叫号码 |
| startTime | String | 是 | 语音接听时间，毫秒级时间戳 |
| callTime | String | 是 | 通话时长(s) |
| transData | String | 是 | 透传数据 |
2.2 建议返回结果（成功）
{
"message": "请求成功",
"code": "200000"，
"success": true
}
PS：话单推送是以通话维度进行的，一般在打完后就会回立即推送，有重拨的号码，话单会在拨打结束后再次推送，若没有收到话单，最长6个小时以后会统一进行话单推送。
三、 查询话单
3.1 版本说明
| 日期 | 版本 | 修订内容摘要 |
|---|
| 2023-10-10 | v1.0.0 | 更新接口文档 |
3.2 协议说明
3.3 请求参数
| 参数名 | 参数类型 | 是否必传 | 参数说明 |
|---|
| appId | String | 是 | 应用id |
| appKey | String | 是 | 应用key |
| page | String | 是 | 页码 |
| size | String | 是 | 分页大小（最大100） |
| messageType | String | 是 | 查询的话单类型 1 语音验证码 2 语音通知 3 语音营销 |
| mobile | String | 否 | 被叫号码 |
| templateId | String | 否 | 模板id |
| taskId | String | 否 | 任务id（批量接口查询使用 批量API接口返回的callid） |
| batchNo | String | 否 | 批次号（单条接口查询使用 单条API接口返回的callid） |
| startDate | String | 是 | 开始调用时间（yyyy-MM-dd HH:mm:ss）(支持查最近90天) |
| endDate | String | 否 | 结束调用时间（yyyy-MM-dd HH:mm:ss） |
3.4 返回参数
| 参数名 | 数据类型 | 参数说明 |
|---|
| code | string | 响应code码。200000：成功，其他失败。详见code码 |
| message | string | 响应code码解释 |
| data | Object | 返回对象 |
| data>>total | string | 查询总数 |
| data>>pageSize | string | 每页个数 |
| data>>pageNum | string | 页码 |
| data>>list | List | 话单数据 |
| data>>list>>callId | string | 回调的callid |
| data>>list>>callDesc | string | 错误码 |
| data>>list>>callDescMsg | string | 错误描述 |
| data>>list>>mobile | string | 被叫号码 |
| data>>list>>templateId | string | 模板id |
| data>>list>>callState | string | 呼叫状态 0成功 1失败 2未知（空值表示本次通话在进行中 |
| data>>list>>smsStatus | string | 挂机短信状态 0 关闭 1 未发送 2 已发送未回执 3 未知 4 发送成功 5 发送失败 |
| data>>list>>smsSendTime | string | 挂机短信发送时间 13位时间戳 |
| data>>list>>fmsStatus | string | 闪信状态 0 关闭 1 未发送 2 已发送未回执 3 未知 4 发送成功 5 发送失败 |
| data>>list>>id | string | 话单唯一id |
3.5 返回数据示例（成功）
{
"message": "请求成功",
"data": {
"total": 12,
"pageSize": 10,
"list": [
{
"callId": "YYTZ1128********79040",
"callDesc": "0",
"mobile": "159*****82",
"templateId": "11134*****042240",
"callState": "1",
"recallCount": "0",
"callDescMsg": "未规定",
"smsStatus": "0",
"invokeTime": "1689040342414",
"fmsStatus": "1",
"fmsSendStatus": "DELIVRD",
"id": "112826********3280"
},
{
"callId": "YYTZ1128********63553",
"callDesc": "0",
"mobile": "159*****182",
"templateId": "1113********40",
"callState": "1",
"recallCount": "0",
"callDescMsg": "未规定",
"smsStatus": "0",
"invokeTime": "1689****0877",
"fmsStatus": "0",
"fmsSendStatus": "",
"id": "11282*******48"
}
],
"pageNum": 2
},
"code": "200000"
}
没有更多了
