一、状态报告推送

推送方式： POST，创蓝服务器主动推送至用户配置的回调地址
Content-Type： application/json
编码格式： utf-8

说明

接收方 http 类型为 post，数据类型为 json 数组，返回 "ok"（注意：直接返回字符串 ok）。

推送参数

参数名称	参数类型	描述	示例
accountId	String	账号 id	208458
batchId	String	批次号	1353610635174481920
clErrorCode	String	创蓝错误码	CL_1000
createTime	Long	创建时间（毫秒时间戳）	1611560900063
deliveryStatus	String	投递状态：1 成功 2 失败	2
msgId	String	消息 id	172372892338618368
phone	String	手机号（脱敏）	156********
submitNo	String	提交号	20845820210125154818660

推送示例

[
    {
        "accountId": "208458",
        "batchId": "1353610635174481920",
        "clErrorCode": "CL_1000",
        "createTime": 1611560900063,
        "deliveryStatus": "2",
        "msgId": "172372892338618368",
        "phone": "156********",
        "submitNo": "20845820210125154818660"
    },
    {
        "accountId": "208458",
        "batchId": "1353610635174481920",
        "clErrorCode": "CL_1000",
        "createTime": 1611560900090,
        "deliveryStatus": "2",
        "msgId": "172372892338618369",
        "phone": "156********",
        "submitNo": "20845820210125154818660"
    }
]

⚠️ 对方接收到推送后需要返回字符串 "ok"

二、状态报告拉取

接口url: https://rcs.253.com/videosms/api/v2/report/pull
Content-Type： application/json
请求方式: json 格式封装的字符串，采用 post 方式提交请求
编码格式： utf-8

完整公共请求头、CheckSum 验签算法统一参考：API调用说明

说明

开通此接口功能后，状态报告保存时间为 72 小时；数据拉取成功后服务器会删除当前拉取成功的数据，不再保存！请用户及时存储。

请求体 body

本接口无业务请求参数，鉴权通过请求头AppId实现。

参数名称	参数类型	是否必填	描述	示例
无业务入参	—	—	接口仅需传递公共请求头，请求Body传空JSON对象 `{}`	—

请求示例

{}

接口响应

响应体 body

参数名称	参数类型	描述	示例
code	String	返回码	"102000"
msg	String	错误描述	"请求成功"
requestId	String	请求id	32位uuid
data	Array	状态报告列表
→ phone	String	手机号	18717950159
→ batchId	String	批次号	1111111111111
→ submitNo	String	提交号	2222222222222
→ deliveryStatus	String	投递状态：1 成功 2 失败	1
→ createTime	Long	创建时间（毫秒时间戳）	1656036261113
→ clErrorCode	String	创蓝错误码	CL_0000

响应示例

{
    "code": "102000",
    "msg": "请求成功",
    "requestId": "32位uuid",
    "data": [
        {
            "phone": "18717950159",
            "batchId": "1111111111111",
            "submitNo": "2222222222222",
            "deliveryStatus": "1",
            "createTime": 1656036261113,
            "clErrorCode": "CL_0000"
        },
        {
            "phone": "18912345678",
            "batchId": "3333333333333",
            "submitNo": "44444444444",
            "deliveryStatus": "1",
            "createTime": 1656036261115,
            "clErrorCode": "CL_0000"
        }
    ]
}

产品中心

热门搜索

中国站

国际站

状态报告

一、状态报告推送

说明

推送参数

推送示例

二、状态报告拉取

说明

请求体 body

请求示例

接口响应

响应体 body

响应示例