数据总览

国际短信数据总览（GetInternalSmsOverview）

描述

国际短信数据总览

HTTP METHOD

GET

请求参数

公共参数列表 详情

名称	类型	必须	长度限制	参数格式	描述	备注
Action	String	是	确定值	[a-zA-Z]+	操作接口名，系统规定参数，取值：GetInternationalSmsOverview
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 通知	短信类型

返回结果

通过指定 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=GetInternationalSmsOverview&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错误码查看更多错误码