接口文档

日期	版本	修订内容摘要
2024-07-30	v2.0.0	更新接口文档

1.闪测2.0API公共参数

请求参数

参数名	请求类型	类型	是否必须	示例值	说明
appId	header	String	是
appKey	header	String	是

返回参数

参数名称	类型	示例值	说明
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 请求参数

参数名	是否必须	类型	说明
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 响应内容

字段名	类型	说明
chargeStatus	int	是否收费，1:收费；0：不收费
code	String	响应code码。200000：成功，其他失败。
message	String	响应code码解释
data	Object
code	int	状态码
data	String	返回结果
message	String	状态码描述

1.4 返回成功示例

{
     "chargeStatus": 1,
     "message": "请求成功",
     "data": {
           "code": 0,
           "data": "701117312634023936",
           "message": "SUCCESS"
     },
     "code": "200000"
}

1.5 返回失败示例

{
     "chargeStatus": 0,
     "message": "校验异常：检测内容不能为空",
     "code": "400001"
}

二、AIGG优化

1. 短信优化

1.1协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/flashVP/query_diagnosis
并发说明	50QPS（特殊需求联系运营）

1.2 请求参数

参数名	是否必须	类型	说明
appId	是	String	请在https://www.chuanglan.com/登录后获取
appKey	是	String	请在https://www.chuanglan.com/登录后获取
content	是	String	检测短信内容：生成短信或优化短信
brandsPercent	否	String	检测手机号品牌分布，例如:"华为":0.8,other":0.2
smsCount	否	String	检测任务用户对生成的短信计费条数限制
coreWords	否	String	检测内容固定词组，多条以英文逗号,拼接
content	否	String	检测内容类型：0.生成短信1.优化短信 默认1
loopCount	否	String	短信优化内容最少循环次数
smsSender	否	String	短信运营商

品牌分布key列表

品牌名称	描述
other	其他，不确定的时候使用
apple	苹果手机
huawei	华为手机
vivo	vivo手机
oppo	oppo手机
honor	荣耀手机
redmi	红米手机
xiaomi	小米手机
realme	真我手机
oneplus	一加手机
samsung	三星手机
meizu	魅族手机

1.3 响应内容

字段名	类型	说明
chargeStatus	int	是否收费，1:收费；0：不收费
code	String	响应code码。200000：成功，其他失败。
message	String	响应code码解释
data	Object
code	int	状态码
data	String	返回结果
message	String	状态码描述

1.4 返回成功示例

{
     "chargeStatus": 1,
     "message": "请求成功",
     "data": {
         "code": 0,
         "data": "701117312634023936",
         "message": "SUCCESS"
     },
     "code": "200000"
}

1.5 返回失败示例

{
     "chargeStatus": 0,
     "message": "校验异常：检测内容不能为空",
     "code": "400001"
}

2.失败的检测优化任务，重新发起诊断

协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/flashVP/analysis/restart
并发说明	50QPS（特殊需求联系运营）

2.1请求参数

参数名	是否必须	类型	说明
appId	是	String	请在https://www.chuanglan.com/登录后获取
appKey	是	String	请在https://www.chuanglan.com/登录后获取
taskId	是	Integer	任务id

2.2响应内容

字段名	类型	说明
chargeStatus	int	是否收费，1:收费；0：不收费
code	String	响应code码。200000：成功，其他失败。
message	String	响应code码解释
data	String	任务id

2.3返回成功示例

{
     "chargeStatus": 0,
     "message": "请求成功",
     "data": "710195537187254272",
     "code": "200000"

三、内容分析

1.内容分析

1.1 协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/flashVP/text_analysis
并发说明	50QPS（特殊需求联系运营）

1.2请求参数

参数名	是否必须	类型	说明
appId	是	String	请在https://www.chuanglan.com/登录后获取
appKey	是	String	请在https://www.chuanglan.com/登录后获取
taskId	是	Integer	检测内容：生成短信或优化短信
brandsPercent	否	String	检测手机号品牌分布，例如:"huawei":0.8,"other""0.2"
smsCount	否	String	检测任务用户对生成的短信计费条数限制
coreWords	否	String	检测内容固定词组，多条以英文逗号,拼接

1.3响应内容

字段名	类型	说明
chargeStatus	int	是否收费，1:收费；0：不收费
code	String	响应code码。200000：成功，其他失败。
message	String	响应code码解释
data	String	任务id

1.4返回成功示例

{
     "chargeStatus": 0,
     "message": "请求成功",
     "data": "710195537187254272",
     "code": "200000"

四、查询

1.查询历史检测任务

1.1协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/flashVP/diagnosis_history
并发说明	50QPS（特殊需求联系运营）

1.2请求参数

参数名	是否必须	类型	说明
appId	是	String	请在https://www.chuanglan.com/登录后获取
appKey	是	String	请在https://www.chuanglan.com/登录后获取
keyword	否	Integer	关键字
startTime	否	String	开始时间,（yyyy-MM-dd HH:mm:ss）
endTime	否	String	结束时间, (yyyy-MM-dd HH:mm:ss)
page	否	String	当前页数，默认0
pageSize	否	String	每页条数，默认10

1.3响应内容

字段名	类型	说明
chargeStatus	int	是否收费，1:收费；0：不收费
code	String	响应code码。200000：成功，其他失败。
message	String	响应code码解释
data	Object
total	int	总条数
list	List	返回列表
unknownRate	double	短信未知率
origSuccessRate	double	原始短信成功率
origInterceptRate	double	原始短信拦截率
successRate	double	短信成功率
smsCount	int	检测任务用户对生成的短信计费条数限制
updataTime	long	更新时间
content	String	检测任务用户使用的短信内容
loopCount	int	设置循环优化次数
looped	int	已经循环优化次数
creatTime	long	创建时间
appId	String	用户应用id
interceptRate	double	短信拦截率
id	long	任务id
contentType	int	检测内容类型:0.生成短信1.优化短信 默认0
status	int	任务状态<0为任务失败 =0未开始任务 >0任务进行中 =3任务完成

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协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/flashVP/recordspage
并发说明	50QPS（特殊需求联系运营）

2.2请求参数

参数名	是否必须	类型	说明
appId	是	String	请在https://www.chuanglan.com/登录后获取
appKey	是	String	请在https://www.chuanglan.com/登录后获取
taskId	是	String	任务id

2.3响应内容

字段名	类型	说明
chargeStatus	int	是否收费，1:收费；0：不收费
code	String	响应code码。200000：成功，其他失败。
message	String	响应code码解释
data	Object
total	int	总条数
list	List	返回列表
origContent	String	AIGC优化前的内容
original	boolean	诊断是否发送的AIGC优化前的内容
successRate	double	这次诊断的成功率
sinnature	String	诊断原始内容的签名
teleNumber	String	诊断时所用的号码
type	String	诊断的品牌
content	String	诊断发送的内容
creatTime	long	诊断记录创建爱你时间
interceptRate	double	这次诊断的拦截率
id	long	诊断记录id
taskId	long	诊断id

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": 655799439412289536,
             "taskId": 655796982531612672
           },
           {
             "origContent": "测试⽣成短信或优化短信",
             "original": false,
             "successRate": 0.51890004,
             "signature": "短信",
              "teleNumber": "移动",
             "type": "other",
             "content": "【创蓝云智】具体信息 >> 测试⽣成短信或优化短信。请击谨防过期 >> www.abc.com获取详情。退订回T。",
             "createTime": 1702626703000,
             "interceptRate": 0.4811,
             "id": 655799155118170112,
             "taskId": 655796982531612672
           }
         ]
     },
 "code": "200000"
}

3根据任务id查询检测记录详情（包括各个品牌信息，返回检测设备进度）

3.1协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/flashVP/detail
并发说明	50QPS（特殊需求联系运营）

3.2请求参数

参数名	是否必须	类型	说明
appId	是	String	请在https://www.chuanglan.com/登录后获取
appKey	是	String	请在https://www.chuanglan.com/登录后获取
taskId	是	String	任务id

3.3响应内容

字段名	类型	说明
chargeStatus	int	是否收费，1:收费；0：不收费
code	String	响应code码。200000：成功，其他失败。
message	String	响应code码解释
data	List	返回列表
successRate	double	这次诊断的成功率
deviceCount	int	需要检测的品牌数
checkCount	int	已经完成检测的品牌数
interceptRate	double	这次诊断的拦截率
brandinfo	Map	品牌分布信息
recordViews	List	诊断激励详情列表
content	String	诊断发送内容
createTime	long	诊断记录创建时间
id		long
interceptRate	double	这次诊断的拦截率
originalContent	String	AIGC优化前的内容
original	boolean	诊断发送的内容
process	int	诊断原始内容的签名
signature	String	这次诊断的拦截率
successRate	double	这次诊断的成功率
taskId	long	诊断记录id
teleNumber	String	诊断id
type	String	诊断的品牌

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": 664477577455165440,
         "taskId": 664477575207018496
     },
     {
         "origContent": "测试",
         "original": true,
         "successRate": 1,
         "type": "huawei",
         "content": "测试",
         "createTime": 1704695800000,
         "progress": 1,
         "interceptRate": 0,
         "id": 664477577455165440,
         "taskId": 664477575207018496
     }
     ]
     }
 ],
 "code": "200000"
}

4.历史检测任务（状态查询）

4.1协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/flashVP/diagnosis/list
并发说明	50QPS（特殊需求联系运营）

4.2请求参数

参数名	是否必须	类型	说明
appId	是	String	请在https://www.chuanglan.com/登录后获取
appKey	是	String	请在https://www.chuanglan.com/登录后获取
startTime	否	String	开始时间,（yyyy-MM-dd HH:mm:ss）
endTime	否	String	结束时间, (yyyy-MM-dd HH:mm:ss)
page	否	String	当前页数，默认0
pageSize	否	String	每页条数，默认10

4.3响应内容

字段名	类型	说明
data	Object
total	int	总条数
list	List	返回列表
message	String	响应code码解释
data	object
total	int	总条数
list	List	返回列表
unknownRate	double	短信未知率
sinbature	String	检测任务用户使用的短信签名
successRate	double	短信成功率
smsCount	int	检测任务用户对生成的短信计费条数限制
updataTime	long	更新时间
content	String	检测任务用户使用的短信内容
loopCount	int	已经循环优化次数
creatTime	long	创建时间
appId	String	用户应用id
goalRate	double	检测任务需要达标的阈值
interceptRate	double	短信拦截率
id	long	任务id
contentType	int	检测内容类型:0.生成短信1.优化短信 默认0
status	int	任务状态<0为任务失败 =0未开始任务 >0任务进行中 =3任务完成

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": 655797794288820224,
           "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": 655796982531612672,
           "contentType": 1,
           "status": 2
       }
     ]
   },
 "code": "200000"
}

5.获取短信内容文本分析结果列表

5.1 协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
返回类型	application/json
URL	https://api.253.com/open/flashVP/analysis/list
并发说明	50QPS（特殊需求联系运营）

5.2请求参数

参数名	是否必须	类型	说明
appId	是	String	请在https://www.chuanglan.com/登录后获取
appKey	是	String	请在https://www.chuanglan.com/登录后获取
taskId	是	String	任务id

5.3响应内容

字段名	类型	说明
chargeStatus	int	是否收费，1:收费；0：不收费
code	String	响应code码。200000：成功，其他失败。
message	String	响应code码解释
data	List	多个敏感词组，每组表示闪测敏感词后短信内容可以满足触达率要求，有可返回空数组，表示该短信内容绝大部分

5.4 返回成功示例

{
 "chargeStatus": 0,
 "message": "请求成功",
 "data": [
     [
         "⼀同",
         "联名",
         "抢",
         "来",
         "周边",
         "等",
         "奇幻",
         "世界",
         "戳"
      ],
      [
         "世界",
         "联名"
      ]
    ],
 "code": "200000"
}

闪测2.0公共错误码

状态码	错误码	错误信息	说明
400	请求参数错误
401	请求Header错误
500	未知错误		服务出现故障
200	100101	拆分号码库失败
200	100102	号码库终端分布请求失败
200	100103	AIGC⽣成或优化内容失败
200	100104	诊断记录创建失败
200	100107	⽂件号码库不能为空
200	100108	loopCount⽣成短信时，最少检测优化1次
200	100109	历史诊断检测任务不存在
200	100110	⽆可下载的品牌分布数据
200	100111	诊断记录创建失败
200	100112	品牌分布格式错误,例如:"huawei":0.8,"other":0.2

{
     "code": 100104,
     "data": "",
     "message": "诊断记录创建失败"
}