接口文档

日期	版本	修订内容摘要
2023-08-18	v2.0.0	更新接口文档

1. 闪测接口

1. 协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
请求类型	multipart/form-data
返回类型	application/json
URL	https://api.253.com/open/flashVerify/send

2. 请求参数说明

• 请求参数Body以multipart/form-data方式提交

参数名	是否必填	说明
appId	是	请在api.253.com登录后获取
appKey	是	请在api.253.com登录后获取
nametitle	是	短信签名，不能超过20个字符
content	是	短信内容

3. 响应参数说明

• 响应body数据为JSON格式

字段名	类型	说明
chargeStatus	int	计费状态 1-收费 0-不收费
code	String	响应code码。200000：成功，其他失败。请对照万数状态码
message	String	响应code码解释
data	Object	返回对象
msgId	String	闪测调用标识id
msgContent	String	短信内容
msgSendTime	String	闪测时间

4. 请求示例

{
appId:请在api.253.com登录后获取
appKey:请在api.253.com登录后获取
title:创蓝
content:闪测测试9999
}

5. 响应示例

• 请求成功

{
    "chargeStatus":1,
    "message":"成功",
    "data":{
        "msgId":"23062818064800902210000046548901",
        "msgContent":"【创蓝】闪测测试9999",
        "msgSendTime":"1687946808000"
    },
    "code":"200000"
}

2. 查询闪测结果接口

1. 协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
请求类型	multipart/form-data
返回类型	application/json
URL	https://api.253.com/open/flashVerify/query

2. 请求参数说明

参数名	是否必填	说明
appId	是	请在api.253.com登录后获取
appKey	是	请在api.253.com登录后获取
msgId	是	闪测调用标识id
type	是	查询类型 0-成功率 1-返回终端手机品牌的成功率 2-指定手机品牌下的机型触达情况 3-根据市场手机品牌占有率返回触达率列表
manufacturer	否	手机品牌，比如xiaomi,huawei等。type参数为2的情况下，该参数必填 (枚举：honor、huawei、meizu、OnePlus、oppo、realme、 redmi、samsung、smartisan、sony、vivo、xiaomi)

3. 响应参数说明

字段名	类型	说明
chargeStatus	int	计费状态 1-收费 0-不收费
code	String	响应code码。200000：成功，其他失败。请对照万数状态码
message	String	响应code码解释
data	Object	返回对象
successRate	Number	成功率
unknownRate	Number	未知率
channelfailRate	Number	通道失败率
interceptRate	Number	拦截率

4. 请求示例

{appId:请在api.253.com登录后获取
appKey:请在api.253.com登录后获取
msgId:23062818064800902210000046548901
type:0
}

5. 响应示例

• 请求成功

{
    "chargeStatus":1,
    "message":"成功",
    "data":{
        "successRate":"62.50",
        "unknownRate":"16.67",
        "channelfailRate":"12.50",
        "interceptRate":"8.33"
    },
    "code":"200000"
}

3. 闪测查询详情接口

1 协议说明

名称	说明
协议	HTTPS POST
编码格式	UTF8
请求类型	multipart/form-data
返回类型	application/json
URL	https://api.253.com/open/flashVerify/flashVerifyDetail

2 请求参数说明

参数名	是否必填	说明
appId	是	请在api.253.com登录后获取
appKey	是	请在api.253.com登录后获取
msgId	是	闪测调用标识id

3 响应参数说明

字段名	类型	说明
chargeStatus	Integer	计费状态 1-收费 0-不收费
code	String	响应code码。200000：成功，其他失败。请对照万数状态码
message	String	响应code码解释
data	Object	返回对象
resultobj	Object	返回结果
riskLevel	Integer	风险等级
auditLevel	Integer	通道失败率
words	String	拦截率
msgId	String	闪测调用标识id
interceptRate	Double	拦截率：拦截率大于100，为提交失败
manufactureRate	Object	厂商拦截率
interceptRate	Double	拦截率
avgInterceptRate	Double	厂商平均拦截率，根据词库，按品牌分类，失败/所有=厂商平均拦截率
manufacturer	String	厂商名称：xiaomi,huawei .....

4 请求示例

{appId:请在api.253.com登录后获取
appKey:请在api.253.com登录后获取
msgId:23062818064800902210000046548901
}

3.5 响应示例

• 请求成功

{
        "tradeNo": "1130925375530991616",
        "chargeStatus": 1,
        "message": "成功",
        "data": {
                "resultObj": [{
                        "riskLevel": 0,
                        "auditLevel": 1,
                        "words": "询",
                        "msgId": "22120714434200202001000000000157",
                        "interceptRate": 37.63,
                        "manufacturerRate": [{
                                        "interceptRate": 47.85,
                                        "avgInterceptRate": 36.56,
                                        "manufacturer": "xiaomi"
                                },
                                {
                                        "interceptRate": 53.65,
                                        "avgInterceptRate": 50.43,
                                        "manufacturer": "huawei"
                                }
                        ],
                        "riskRason": ""
                }],
                "chargeCounts": 0,
                "resultCode": "000000",
                "resultMsg": "成功"
        },
        "code": "200000"
}