标记短信到达

最近更新时间:2022-01-13 16:16:04

查看PDF

标记短信到达(DeliveredSms)

描述

当短信验证码回填后,客户调用接口通知给金山云,便于金山云通过回填率,更直观监测通道质量。

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

公共参数列表 详情

名称 类型 必须 长度限制(字符) 参数格式 描述 备注
Action String 确定值 [a-zA-Z]+ 操作接口名,系统规定参数,取值:DeliveredSms
Version String 确定值 版本号,系统规定参数,取值:2019-05-01
Sid String 发短信接口返回的发送标识Sid Sid与ExtId传一个即可
ExtId String 客户自定义流水号 Sid与ExtId传一个即可
SendDate String 短信记录的发送日期,例:2020-10-01 当传ExtId时,需要传发送日期

返回结果

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

参数 描述
RequestId 每次接口请求的标识

请求示例

curl -X POST \
  'http://ksms.ksyun.com/' \
  -H 'accept: application/json' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -H 'host: ksms.ksyun.com' \
  -d 'Action=DeliveredSms&Version=2019-05-01&Sid=23ab28a0331605513620&Signature=xxxx&SignatureVersion=1.0&Timestamp=2019-08-13T17:18:36Z&Service=ksms&Accesskey=xxx'

响应成功返回示例

{
    "RequestId": "c114d383-bcf0-4167-b57e-7fca43e4dd43"
}

响应失败返回示例

{
    "RequestId": "ED9B3DF4-75AF-4573-8DD4-7611C57292F2",
    "Error": {
        "Type": "sender",
        "Message": "Invalid Sid",
        "Code": "InvalidSid"
    }
}

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

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

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

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

更多建议

0/200

评价建议不能为空

提交成功!

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

问题反馈