数据总览

最近更新时间:2021-08-06 10:22:32

查看PDF

国内短信数据总览(GetInternalSmsOverview)

描述

国内短信数据总览

HTTP METHOD

GET

请求参数

公共参数列表 详情

名称 类型 必须 长度限制 参数格式 描述 备注
Action String 确定值 [a-zA-Z]+ 操作接口名,系统规定参数,取值:GetInternalSmsOverview
Version String 确定值 版本号,系统规定参数,取值:2019-05-01
BeginDate String 开始日期,例:2020-05-01
EndDate String 结束日期,例:2020-05-03
SignId Int 签名ID,控制台(短信服务》国内短信》短信签名)可查
TemplateId Int 模板ID,控制台(短信服务》国内短信》短信模板)可查
SmsType Int 类型值:1验证码, 2 通知 ,3营销类短信 短信类型

返回结果

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

名称 类型 描述 备注
RequestId String 请求唯一标识
Stats 列表 短信数据统计列表
Stats定义
名称 类型 描述 备注
SendAmount Int 发送量
SuccessAmount Int 成功量
ChargingAmount Int 计费量
FailAmount Int 失败量
SuccessRate String 成功率

示例(调用成功)

请求示例

curl -X GET \
  'http://sms.api.ksyun.com/?Action=GetInternalSmsOverview&Version=2019-05-01&BeginDate=2020-05-01&EndDate=2020-05-01&Signature=xxxx&SignatureVersion=1.0&Timestamp=2019-08-13T17:18:36Z&Service=sms&Accesskey=xxx' \
  -H 'accept: application/json' \
  -H 'Authorization: ****'

响应成功返回示例

{
    "Stats": {
        "2020-05-01": {
            "SendAmount": 1,
            "SuccessAmount": 1,
            "ChargingAmount": 1,
            "FailAmount": 0,
            "SuccessRate": "100.00%"
        },
        "2020-05-02": {
            "SendAmount": 0,
            "SuccessAmount": 0,
            "ChargingAmount": 0,
            "FailAmount": 0,
            "SuccessRate": "0.00%"
        },
        "2020-05-03": {
            "SendAmount": 0,
            "SuccessAmount": 0,
            "ChargingAmount": 0,
            "FailAmount": 0,
            "SuccessRate": "0.00%"
        }
    },
    "RequestId": "4083a4c2-fd22-4f4c-a898-790d7f5c66b1"
}

响应失败返回示例

{
    "RequestId": "ED9B3DF4-75AF-4573-8DD4-7611C57292F2",
    "Error": {
        "Type": "sender",
        "Message": "Action not found",
        "Code": "ActionNotFound"
    }
}

访问API错误码查看更多错误码

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

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

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

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

更多建议

0/200

评价建议不能为空

提交成功!

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

问题反馈