拉取状态报告

最近更新时间:2021-09-16 13:56:56

查看PDF

拉取状态报告(PullSmsReport)

描述

拉取短信状态报告

建议: 使用HTTP推送功能,获取状态报告。
使用拉取功能可能存在状态报告丢失的情况,
比如:网络超时,客户拉取状态报告服务自身处理异常等

HTTP METHOD

GET

请求参数

公共参数列表 详情

名称 类型 必须 长度限制(字符) 参数格式 描述 备注
Action String 确定值 [a-zA-Z]+ 操作接口名,系统规定参数,取值:PullSmsReport
Version String 确定值 版本号,系统规定参数,取值:2019-05-01
Size Integer 每次拉取个数,默认(最大)500
IsInternational Integer 默认拉取国内短信,如果拉取国际短信状态,此参数需要传值1

示例(调用成功)

请求示例

https://ksms.api.ksyun.com/?Action=PullSmsReport&Version=2019-05-01&业务参数

返回示例

{
    "RequestId": "68a911b6-aa32-4edd-9327-e7cbdbbbf394",
    "Data": [
        {
            "SendTime": "2020-06-05 14:47:02",
            "ReceiveTime": "2020-06-05 14:47:02",
            "Sid": "e8bd2ba7e2711591339622",
            "NationCode": "86",
            "ExtId": "asd123",
            "ErrDesc": "停机、无法接通",
            "Status": "FAIL",
            "ErrCode": "SERVICE_ERROR",
            "NationEnCode": "CN",
            "SmsType": 2,
            "Mobile": "1xxxxxxxxxx",
            "SmsTotal": 1
        },
        {
            "SendTime": "2020-06-05 15:13:14",
            "ReceiveTime": "2020-06-05 15:13:14",
            "Sid": "1caef0622c101591341194",
            "NationCode": "86",
            "ExtId": "asd123",
            "ErrDesc": "停机、无法接通",
            "Status": "FAIL",
            "ErrCode": "109",
            "NationEnCode": "CN",
            "SmsType": 2,
            "Mobile": "1xxxxxxxxxx",
            "SmsTotal": 2
        }
    ]
}
参数 描述
Sid 发短信接口返回的发送标识Sid
NationCode 国家(或地区)码,数字
ErrCode 短信状态码
ErrDesc 短信状态码描述
Status 短信接收状态,SUCCESS(成功)、FAIL(失败)
NationEnCode 国家(或地区)码,英文
SendTime 短信发送时间
Mobile 手机号
ReceiveTime 用户实际接收到短信的时间
ExtId 客户下发短信时的自定义流水号
SmsType 短信类型
SmsTotal 长短信拆分后的条数

文档内容是否对您有帮助?

根本没帮助
文档较差
文档一般
文档不错
文档很好

在文档使用中是否遇到以下问题

内容不全,不深入
内容更新不及时
描述不清晰,比较混乱
系统或功能太复杂,缺乏足够的引导
内容冗长

更多建议

0/200

评价建议不能为空

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

问题反馈