查询短信记录

最近更新时间:2021-06-11 10:31:18

查看PDF

查询短信记录(QuerySmsDetail)

描述

查询短信记录

HTTP METHOD

GET

请求参数

公共参数列表 详情

名称 类型 必须 长度限制(字符) 参数格式 描述 备注
Action String 确定值 [a-zA-Z]+ 操作接口名,系统规定参数,取值:QuerySmsDetail
Version String 确定值 版本号,系统规定参数,取值:2019-05-01
SendDate String 短信记录的发送日期,例:2020-10-01
Mobile String [0-9]+ 手机号: 国内 11位数字,例如 1xxxxxxxx。国际 : +国家代号手机号码,例如 +861xxxxxxxx
Sid String 发短信接口返回的发送标识Sid
ExtId String 客户自定义流水号

返回结果

通过指定 Accept:application/json,返回的数据格式为json

参数 描述
Sid 发短信接口返回的发送标识Sid
NationCode 国家(或地区)码,数字
ErrCode 短信状态码
Status 短信接收状态,SUCCESS(成功)、FAIL(失败)
NationEnCode 国家(或地区)码,英文
SendTime 短信发送时间
Mobile 手机号
ReceiveTime 用户实际接收到短信的时间
ExtId 客户下发短信时的自定义流水号
SmsType 短信类型
SmsTotal 长短信拆分后的条数

请求示例

https://ksms.api.ksyun.com/?Action=QuerySmsDetail&Version=2019-05-01&SendDate=2020-10-01&Mobile=13500000000&Signature=xxxx&SignatureVersion=1.0&Timestamp=2019-08-13T17:18:36Z&Service=ksms&Accesskey=xxx

响应成功返回示例

{
    "RequestId": "68a911b6-aa32-4edd-9327-e7cbdbbbf394",
    "Data": [
        {
            "SmsTotal": 5,
            "SendTime": "2020-10-01 16:00:20",
            "ReceiveTime": "2020-10-01 16:00:29",
            "Sid": "23ab28a0331605513620",
            "NationCode": "86",
            "ExtId": "test1234",
            "Status": "SUCCESS",
            "ErrCode": "DELIVRD",
            "NationEnCode": "CN",
            "SmsType": 1,
            "Mobile": "13500000000"
        },
        {
            "SmsTotal": 5,
            "SendTime": "2020-10-01 16:00:16",
            "ReceiveTime": "2020-10-01 16:00:23",
            "Sid": "e93d2fc4c61605513616",
            "NationCode": "86",
            "ExtId": "test1234",
            "Status": "SUCCESS",
            "ErrCode": "DELIVRD",
            "NationEnCode": "CN",
            "SmsType": 1,
            "Mobile": "13500000000"
        }
    ]
}

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

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

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

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

更多建议

0/200

评价建议不能为空

提交成功!

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

问题反馈