1.短信优化
1.1 协议说明
1.2 请求参数
请求参数Body以multipart/form-data方式提交
1.3 响应内容
响应body数据为JSON格式。
1.4 返回成功示例
{
"chargeStatus": 1,
"message": "请求成功",
"data": {
"code": 0,
"data": "SUCCESS",
"message": "SUCCESS"
},
"code": "200000"
}
1.5 返回失败示例
{
"chargeStatus": 0,
"message": "校验异常:检测内容不能为空",
"code": "400001"
}
2. 短信诊断
2.1 协议说明
2.2 请求参数
请求参数Body以multipart/form-data方式提交
2.3 响应内容
响应body数据为JSON格式。
2.4 返回成功示例
{
"chargeStatus": 1,
"message": "请求成功",
"data": {
"code": 0,
"data": "SUCCESS",
"message": "SUCCESS"
},
"code": "200000"
}
2.5 返回失败示例
{
"chargeStatus": 0,
"message": "校验异常:检测内容不能为空",
"code": "400001"
}
3. 查询历史检测任务
3.1 协议说明
3.2 请求参数
请求参数Body以multipart/form-data方式提交
3.3 响应内容
响应body数据为JSON格式。
3.4 返回成功示例
{
"chargeStatus": 0,
"message": "请求成功",
"data": {
"total": 2,
"list": [
{
"unknownRate": 0,
"signature": "短信",
"successRate": 0,
"smsCount": 2,
"updateTime": 1702626378000,
"content": "测试生成短信或优化短信",
"loopCount": 0,
"createTime": 1702626378000,
"appId": "XXXXXX",
"goalRate": 0.8,
"interceptRate": 0,
"id": 655797794288820200,
"contentType": 1,
"status": 0
},
{
"unknownRate": 0,
"signature": "短信",
"successRate": 0,
"smsCount": 1,
"updateTime": 1702626703000,
"content": "测试生成短信或优化短信2",
"loopCount": 5,
"createTime": 1702626185000,
"appId": "XXXXXX",
"goalRate": 0.8,
"looped": 8,
"interceptRate": 0,
"id": 655796982531612700,
"contentType": 1,
"status": 2
}
]
},
"code": "200000"
}
4. 根据任务id查询⼿机⼚商查询诊断业务
4.1 协议说明
4.2 请求参数
请求参数Body以multipart/form-data方式提交
4.3 响应内容
响应body数据为JSON格式。
4.4 返回成功示例
{
"chargeStatus": 0,
"message": "请求成功",
"data": [
{
"origContent": "测试生成短信或优化短信",
"original": false,
"successRate": 0.51890004,
"signature": "短信",
"teleNumber": "移动",
"type": "other",
"content": "【创蓝云智】信息 >> 测试生成短信或优化短信。请击信息 >> 下订单,www.abc.com获取详情。退订回T。",
"createTime": 1702626771000,
"interceptRate": 0.4811,
"id": 655799439412289500,
"taskId": 655796982531612700
},
{
"origContent": "测试生成短信或优化短信",
"original": false,
"successRate": 0.51890004,
"signature": "短信",
"teleNumber": "移动",
"type": "other",
"content": "【创蓝云智】具体信息 >> 测试生成短信或优化短信。请击谨防过期 >> www.abc.com获取详情。退订回T。",
"createTime": 1702626703000,
"interceptRate": 0.4811,
"id": 655799155118170100,
"taskId": 655796982531612700
}
],
"code": "200000"
}
5. 获取指定诊断任务和⼚商中最好的记录
5.1 协议说明
5.2 请求参数
请求参数Body以multipart/form-data方式提交
5.3 响应内容
响应body数据为JSON格式。
5.4 返回成功示例
{
"chargeStatus": 0,
"message": "请求成功",
"data": [
{
"origContent": "测试生成短信或优化短信",
"original": false,
"successRate": 0.51890004,
"signature": "短信",
"teleNumber": "移动",
"type": "other",
"content": "【创蓝云智】测试生成短信或优化短信,请注意本次测试内容符合要求,无需修改。www.abc.com退R.",
"createTime": 1702626222000,
"interceptRate": 0.4811,
"id": 655797138974957600,
"taskId": 655796982531612700
}
],
"code": "200000"
}
6. 获取指定诊断任务记录列表
6.1 协议说明
6.2 请求参数
请求参数Body以multipart/form-data方式提交
6.3 响应内容
响应body数据为JSON格式。
6.4 返回成功示例
{
"chargeStatus": 0,
"message": "请求成功",
"data": {
"total": 2,
"list": [
{
"origContent": "测试生成短信或优化短信",
"original": false,
"successRate": 0.51890004,
"signature": "短信",
"teleNumber": "移动",
"type": "other",
"content": "【创蓝云智】信息 >> 测试生成短信或优化短信。请击信息 >> 下订单,www.abc.com获取详情。退订回T。",
"createTime": 1702626771000,
"interceptRate": 0.4811,
"id": 655799439412289500,
"taskId": 655796982531612700
},
{
"origContent": "测试生成短信或优化短信",
"original": false,
"successRate": 0.51890004,
"signature": "短信",
"teleNumber": "移动",
"type": "other",
"content": "【创蓝云智】具体信息 >> 测试生成短信或优化短信。请击谨防过期 >> www.abc.com获取详情。退订回T。",
"createTime": 1702626703000,
"interceptRate": 0.4811,
"id": 655799155118170100,
"taskId": 655796982531612700
}
]
},
"code": "200000"
}
7. 批量删除诊断任务
7.1 协议说明
7.2 请求参数
请求参数Body以multipart/form-data方式提交
7.3 响应内容
响应body数据为JSON格式。
7.4 返回成功示例
{
"chargeStatus": 0,
"message": "请求成功",
"data": [
655796982531612700
],
"code": "200000"
}
8. 批量删除诊断记录
8.1 协议说明
8.2 请求参数
请求参数Body以multipart/form-data方式提交
8.3 响应内容
响应body数据为JSON格式。
8.4 返回成功示例
{
"chargeStatus": 0,
"message": "请求成功",
"data": [
655797138454863872
],
"code": "200000"
}
```-->
| 日期 | 版本 | 修订内容摘要 |
| -------- | ----------------------------------------------------------- |---------- |
| 2024-07-30 | v2.0.0 | 更新接口文档|
## 1.闪测2.0API公共参数
本文罗列并说明 闪测2.0API设计的公共请求参数和返回参数
### 请求参数
下表为公共请求参数说明:
<style>
.sms-auth-header-scroll-table {
width: 100%;
max-width: 100%;
overflow: hidden;
}
.sms-auth-header-scroll-table .markdown-table-scroll {
display: block !important;
width: 100% !important;
max-width: 100% !important;
margin: 16px 0 !important;
overflow-x: auto !important;
overflow-y: hidden !important;
-webkit-overflow-scrolling: touch;
overscroll-behavior-x: contain;
}
.sms-auth-header-scroll-table .markdown-table-scroll > table {
width: 700px !important;
min-width: 700px !important;
max-width: none !important;
table-layout: fixed !important;
}
.sms-auth-header-scroll-table th {
white-space: nowrap !important;
}
.sms-auth-header-scroll-table td {
white-space: normal !important;
overflow-wrap: anywhere !important;
word-break: break-word !important;
}
</style>
<div class="sms-auth-header-scroll-table">
<table>
<colgroup>
<col style="width:100px;">
<col style="width:100px;">
<col style="width:90px;">
<col style="width:100px;">
<col style="width:120px;">
<col style="width:190px;">
</colgroup>
<thead>
<tr>
<th>参数名</th>
<th>请求类型</th>
<th>类型</th>
<th>是否必须</th>
<th>示例值</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="white-space:nowrap!important;">appId</td>
<td style="white-space:nowrap!important;">header</td>
<td style="white-space:nowrap!important;">String</td>
<td style="white-space:nowrap!important;">是</td>
<td></td>
<td></td>
</tr>
<tr>
<td style="white-space:nowrap!important;">appKey</td>
<td style="white-space:nowrap!important;">header</td>
<td style="white-space:nowrap!important;">String</td>
<td style="white-space:nowrap!important;">是</td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
</div>
### 返回参数
对成功和异常返回的判断标准做出说明。同时,说明返回数据的格式(例如JSON/XML)。
下表为公共返回参数说明
| 参数名称 | 类型 | 示例值 | 说明
| --- | --- | --- | --- |
| code | integer(int 32) | |状态码
| data | String | |返回数据内容
| message | String | |状态码信息
## 一、检测
### 1.单条短信检测
协议说明
| 名称 | 说明 |
| --- | --- |
| 协议 | HTTPS POST |
| 编码格式 | UTF8 |
| 返回类型 | application/json |
| URL | https://api.253.com/open/flashVP/query_diagnosis_single|
| 并发说明 | 50QPS(特殊需求联系运营) |
#### 1.2 请求参数
请求参数Body以multipart/form-data⽅式提交
| 参数名 | 是否必须 | 类型 | 说明 |
| --- | --- | --- | --- |
| appId | 是 | String | 请在https://www.chuanglan.com/登录后获取
| appKey | 是 | String | 请在https://www.chuanglan.com/登录后获取
| content | 是 | String | 检测短信内容,内容最大长度500个字符
| smsSender | 否 | String | 短信运营商
| brandsPercent | 否 | String | 检测手机号品牌分布,例如:"华为":0.8,other":0.2|
#### 品牌分布key列表:
| 品牌名称 | 描述 |
| --- | ---
| other | 其他,不确定的时候使用
| apple | 苹果手机
| huawei | 华为手机
| vivo | vivo手机
| oppo | oppo手机
|honor |荣耀手机
|redmi |红米手机
|xiaomi |小米手机
|realme |真我手机
|oneplus |一加手机
|samsung |三星手机
|meizu |魅族手机
#### 1.3 响应内容
响应body数据为json格式
| 字段名 | 类型| 说明
| --- | --- | --- |
| chargeStatus| int | 是否收费,1:收费;0:不收费
| code | String| 响应code码。200000:成功,其他失败。
| message | String| 响应code码解释
| data | Object|
| code |int |状态码
| data |String |返回结果
| message |String |状态码描述
#### 1.4 返回成功示例
```json
{
"chargeStatus": 1,
"message": "请求成功",
"data": {
"code": 0,
"data": "701117312634023936",
"message": "SUCCESS"
},
"code": "200000"
}
1.5 返回失败示例
{
"chargeStatus": 0,
"message": "校验异常:检测内容不能为空",
"code": "400001"
}
二、AIGG优化
1. 短信优化
1.1协议说明
1.2 请求参数
请求参数Body以multipart/form-data⽅式提交
品牌分布key列表
1.3 响应内容
响应body数据为JSON格式
1.4 返回成功示例
{
"chargeStatus": 1,
"message": "请求成功",
"data": {
"code": 0,
"data": "701117312634023936",
"message": "SUCCESS"
},
"code": "200000"
}
1.5 返回失败示例
{
"chargeStatus": 0,
"message": "校验异常:检测内容不能为空",
"code": "400001"
}
2.失败的检测优化任务,重新发起诊断
协议说明
2.1请求参数
请求参数Body以multipart/form-data⽅式提交
2.2响应内容
响应body数据为JSON格式
2.3返回成功示例
{
"chargeStatus": 0,
"message": "请求成功",
"data": "710195537187254272",
"code": "200000"
三、内容分析
1.内容分析
1.1 协议说明
1.2请求参数
请求参数Body以multipart/form-data⽅式提交
1.3响应内容
响应body数据为JSON格式。
1.4返回成功示例
{
"chargeStatus": 0,
"message": "请求成功",
"data": "710195537187254272",
"code": "200000"
四、查询
1.查询历史检测任务
1.1协议说明
1.2请求参数
请求参数Body以multipart/form-data⽅式提交
1.3响应内容
响应body数据为JSON格式。
1.4返回成功示例
{
"chargeStatus": 0,
"message": "请求成功",
"data": {
"total": 2,
"list": [
{
"unknownRate": 0.0,
"successRate": 0.9784742,
"smsCount": 2,
"updateTime": 1719217649000,
"content": "测试⽣成短信或优化短信",
"origSuccessRate": 0.9784742,
"origInterceptRate": 0.0215258,
"taskType": 0,
"loopCount": 0,
"createTime": 1719217642000,
"appId": "XXXXXX",
"looped": 1,
"interceptRate": 0.0215258,
"id": 725386597290954752,
"contentType": 1,
"status": 3
},
{
"unknownRate": 0.0,
"successRate": 0.9784742,
"smsCount": 2,
"updateTime": 1719217649000,
"content": "测试⽣成短信或优化短信2",
"origSuccessRate": 0.9784742,
"origInterceptRate": 0.0215258,
"taskType": 0,
"loopCount": 0,
"createTime": 1719217642000,
"appId": "XXXXXX",
"looped": 1,
"interceptRate": 0.0215258,
"id": 725386597290954752,
"contentType": 1,
"status": 3
}
]
},
"code": "200000"
2.获取指定诊断任务记录列表
2.1协议说明
2.2请求参数
请求参数Body以multipart/form-data⽅式提交
2.3响应内容
响应body数据为JSON格式
2.4返回成功示例
{
"chargeStatus": 0,
"message": "请求成功",
"data": {
"total": 2,
"list": [
{
"origContent": "测试⽣成短信或优化短信",
"original": false,
"successRate": 0.51890004,
"signature": "短信",
"teleNumber": "移动",
"type": "other",
"content": "【创蓝云智】信息 >> 测试⽣成短信或优化短信。请击信息 >> 下订单,www.abc.com获取详情。退订回T。",
"createTime": 1702626771000,
"interceptRate": 0.4811,
"id": 655799439412289500,
"taskId": 655796982531612700
},
{
"origContent": "测试⽣成短信或优化短信",
"original": false,
"successRate": 0.51890004,
"signature": "短信",
"teleNumber": "移动",
"type": "other",
"content": "【创蓝云智】具体信息 >> 测试⽣成短信或优化短信。请击谨防过期 >> www.abc.com获取详情。退订回T。",
"createTime": 1702626703000,
"interceptRate": 0.4811,
"id": 655799155118170100,
"taskId": 655796982531612700
}
]
},
"code": "200000"
}
3根据任务id查询检测记录详情(包括各个品牌信息,返回检测设备进度)
3.1协议说明
3.2请求参数
请求参数Body以multipart/form-data⽅式提交
3.3响应内容
响应body数据为JSON格式
3.4返回成功示例
{
"chargeStatus": 0,
"message": "请求成功",
"data": [
{
"deviceCount": 15,
"successRate": 1,
"checkCount": 15,
"brandinfo": {
"xiaomi": 0.040039,
"meizu": 0.000845,
"honor": 0.092777,
"oneplus": 0.008952,
"apple": 0.319193,
"huawei": 0.169605,
"samsung": 0.00674,
"realme": 0.014084,
"oppo": 0.132436,
"blackshark": 0.001654,
"redmi": 0.050572,
"vivo": 0.1525,
"nzone": 0.000865,
"hinova": 0.001372
},
"interceptRate": 0,
"recordViews": [
{
"origContent": "测试",
"original": true,
"successRate": 1,
"type": "apple",
"content": "测试",
"createTime": 1704695800000,
"progress": 1,
"interceptRate": 0,
"id": 664477577455165400,
"taskId": 664477575207018500
},
{
"origContent": "测试",
"original": true,
"successRate": 1,
"type": "huawei",
"content": "测试",
"createTime": 1704695800000,
"progress": 1,
"interceptRate": 0,
"id": 664477577455165400,
"taskId": 664477575207018500
}
]
}
],
"code": "200000"
}
4.历史检测任务(状态查询)
4.1协议说明
该接⼝将基于历史任务的updateTime进⾏查询
4.2请求参数
请求参数Body以multipart/form-data⽅式提交
4.3响应内容
响应body数据为JSON格式
4.4 返回成功示例
{
"chargeStatus": 0,
"message": "请求成功",
"data": {
"total": 2,
"list": [
{
"unknownRate": 0,
"signature": "短信",
"successRate": 0,
"smsCount": 2,
"updateTime": 1702626378000,
"content": "测试⽣成短信或优化短信",
"loopCount": 0,
"createTime": 1702626378000,
"appId": "XXXXXX",
"goalRate": 0.8,
"interceptRate": 0,
"id": 655797794288820200,
"contentType": 1,
"status": 0
},
{
"unknownRate": 0,
"signature": "短信",
"successRate": 0,
"smsCount": 1,
"updateTime": 1702626703000,
"content": "测试⽣成短信或优化短信2",
"loopCount": 5,
"createTime": 1702626185000,
"appId": "XXXXXX",
"goalRate": 0.8,
"looped": 8,
"interceptRate": 0,
"id": 655796982531612700,
"contentType": 1,
"status": 2
}
]
},
"code": "200000"
}
5.获取短信内容文本分析结果列表
5.1 协议说明
5.2请求参数
请求参数Body以multipart/form-data⽅式提交
5.3响应内容
5.4 返回成功示例
{
"chargeStatus": 0,
"message": "请求成功",
"data": [
[
"⼀同",
"联名",
"抢",
"来",
"周边",
"等",
"奇幻",
"世界",
"戳"
],
[
"世界",
"联名"
]
],
"code": "200000"
}
闪测2.0公共错误码
本⽂罗列并说明公共错误码。若想了解某个接⼝业务逻辑相关的错误码,请参考该接⼝的说明⽂档。
异常返回⽰例:
{
"code": 100104,
"data": "",
"message": "诊断记录创建失败"
}