数据统计

发送数据统计（每天）

按天统计的短信数据

URL

https://api.sendcloud.net/smsapi/data/sendDay

HTTP请求方式

post    get

参数说明

参数	类型	必须	说明
smsUser	string	是	smsUser
days	string	*	过去 days 天内的统计数据 (`days=1`表示今天)
startDate	string	*	开始日期, 格式为`yyyy-MM-dd`
endDate	string	*	结束日期, 格式为`yyyy-MM-dd`
msgTypeStr	string	否	短信类型，`0`表示国内短信，`1`表示彩信，`2`表示国际短信，`3`表示语音， `5`表示影音
templateIdsStr	string	否	多个模板ID，用`;`分开, 如:`templateIdsStr=1;2;3`
aggregate	string	否	是否聚合, `0`不聚合，`1`聚合，默认为`0`
signature	string	是	数字签名, 合法性验证
labelIdsStr	string	否	短信标签Id列表，用;分开，如 labelIdsStr=123456;456789

提示:

获取统计数据时, 必须指定时间区间. 即 startDate 与 endDate 的组合 或者 days 参数 需二者取一
查询的天数不超过 100
聚合表示将所有维度的数据聚合累加

请求示例

https://api.sendcloud.net/smsapi/data/sendDay?smsUser=***&days=***&msgTypeStr=***&templateIdsStr=***&aggregate=***&signature=***

返回值说明

参数	说明
sendDate	发送日期
templateId	短信模板ID
msgType	短信类型
requestNum	请求总数
sendNum	送达数量
processFailedNum	处理失败数量
sendFailedNum	发送失败数量
billingNum	计费数量
sendRatio	送达比例
processFailedRatio	处理失败比例
sendFailedRatio	发送失败比例

返回值示例

不聚合情况下

{
    "result" : true,
    "statusCode" : 200,
    "message" : "请求成功",
    "info" : {
        "dataList" : [{
                "billingNum" : "2",
                "msgType" : "0",
                "processFailedNum" : "0",
                "processFailedRatio" : "0.00",
                "requestNum" : "1",
                "sendDate" : "2016-09-27",
                "sendFailedNum" : "1",
                "sendFailedRatio" : "100.00",
                "sendNum" : "0",
                "sendRatio" : "0.00",
                "templateId" : "2"
            }, {
                "billingNum" : "1",
                "msgType" : "0",
                "processFailedNum" : "0",
                "processFailedRatio" : "0.00",
                "requestNum" : "1",
                "sendDate" : "2016-09-14",
                "sendFailedNum" : "0",
                "sendFailedRatio" : "0.00",
                "sendNum" : "1",
                "sendRatio" : "100.00",
                "templateId" : "2"
            }
        ],
        "dataListSize" : 2
    }
}

聚合情况下

{
    "message" : "请求成功",
    "result" : true,
    "statusCode" : 200，
    "info" : {
        "total" : {
            "billingNum" : "42",
            "msgType" : "None",
            "processFailedNum" : "6",
            "processFailedRatio" : "13.95",
            "requestNum" : "43",
            "sendDate" : "2016-09-01到2016-09-30",
            "sendFailedNum" : "11",
            "sendFailedRatio" : "25.58",
            "sendNum" : "26",
            "sendRatio" : "60.47",
            "templateId" : "None"
        }
    }
}

处理失败统计

查询处理失败的分类统计信息

URL

https://api.sendcloud.net/smsapi/data/processFailed

HTTP请求方式

post    get

参数说明

参数	类型	必须	说明
smsUser	string	是	smsUser
days	string	*	过去 days 天内的统计数据 (`days=1`表示今天)
startDate	string	*	开始日期, 格式为`yyyy-MM-dd`
endDate	string	*	结束日期, 格式为`yyyy-MM-dd`
msgTypeStr	string	否	短信类型，`0`表示国内短信，`1`表示彩信，`2`表示国际短信，`3`表示语音， `5`表示影音
templateIdsStr	string	否	多个模板ID，用`;`分开, 如:`templateIdsStr=1;2;3`
aggregate	string	否	是否聚合, `0`不聚合，`1`聚合，默认为`0`
signature	string	是	数字签名, 合法性验证
labelIdsStr	string	否	短信标签Id列表，用;分开，如 labelIdsStr=123456;456789

提示:

获取统计数据时, 必须指定时间区间. 即 startDate 与 endDate 的组合 或者 days 参数 需二者取一
查询的天数不超过 100
聚合表示将所有维度的数据聚合累加

请求示例

https://api.sendcloud.net/smsapi/data/processFailed?smsUser=***&days=***&msgTypeStr=***&templateIdsStr=***&aggregate=***&signature=***

返回值说明

参数	说明
sendDate	发送日期
templateId	短信模板ID
msgType	短信类型
globalBlackListNum	全局拦截个数
userBlackListNum	局部拦截个数
unsubscribleNum	取消订阅个数
keyWordFilterNum	关键词过滤个数
errorVarsNum	替换变量错误个数
contentTooLongNum	内容长度超限个数
frequencyExceedNum	频率超限个数
sendTypeUnsupportedNum	短信发送类型不支持个数

返回值示例

不聚合情况下

{
    "result" : true,
    "statusCode" : 200,
    "message" : "请求成功",
    "info" : {
        "count" : 2,
        "voList" : [{
                "frequencyExceedNum" : "0",
                "errorVarsNum" : "0",
                "globalBlackListNum" : "0",
                "keyWordFilterNum" : "0",
                "msgType" : "0",
                "sendDate" : "2016-09-09",
                "sendTypeUnsupportedNum" : "0",
                "templateId" : "2",
                "unsubscribleNum" : "0",
                "userBlackListNum" : "0",
                "contentTooLongNum" : "0"
            }, {
                "frequencyExceedNum" : "0",
                "errorVarsNum" : "0",
                "globalBlackListNum" : "0",
                "keyWordFilterNum" : "0",
                "msgType" : "0",
                "sendDate" : "2016-09-27",
                "sendTypeUnsupportedNum" : "0",
                "templateId" : "2",
                "unsubscribleNum" : "0",
                "userBlackListNum" : "0",
                "contentTooLongNum" : "0"
            }
        ]
    }
}

聚合情况下

{
    "result" : true,
    "statusCode" : 200,
    "message" : "请求成功",
    "info" : {
        "total" : {
            "frequencyExceedNum" : "0",
            "errorVarsNum" : "0",
            "globalBlackListNum" : "6",
            "keyWordFilterNum" : "0",
            "msgType" : "None",
            "sendDate" : "2016-07-28到2016-11-04",
            "sendTypeUnsupportedNum" : "0",
            "templateId" : "None",
            "unsubscribleNum" : "0",
            "userBlackListNum" : "0",
            "contentTooLongNum" : "0"
        }
    }
}

发送失败统计

查询发送失败的分类统计信息

URL

https://api.sendcloud.net/smsapi/data/sendFailed

HTTP请求方式

post    get

参数说明

参数	类型	必须	说明
smsUser	string	是	smsUser
days	string	*	过去 days 天内的统计数据 (`days=1`表示今天)
startDate	string	*	开始日期, 格式为`yyyy-MM-dd`
endDate	string	*	结束日期, 格式为`yyyy-MM-dd`
msgTypeStr	string	否	短信类型，`0`表示国内短信，`1`表示彩信，`2`表示国际短信，`3`表示语音， `5`表示影音
templateIdsStr	string	否	多个模板ID，用`;`分开, 如:`templateIdsStr=1;2;3`
aggregate	string	否	是否聚合, `0`不聚合，`1`聚合，默认为`0`
signature	string	是	数字签名, 合法性验证
labelIdsStr	string	否	短信标签Id列表，用;分开，如 labelIdsStr=123456;456789

提示:

获取统计数据时, 必须指定时间区间. 即 startDate 与 endDate 的组合 或者 days 参数 需二者取一
查询的天数不超过 100
聚合表示将所有维度的数据聚合累加

请求示例

https://api.sendcloud.net/smsapi/data/processFailed?smsUser=***&days=***&msgTypeStr=***&templateIdsStr=***&signature=***

返回值说明

参数	说明
sendDate	发送日期
templateId	短信模板ID
msgType	短信类型
emptyPhoneNumberNum	空号个数
outOfServiceNum	停机个数
complaintsNum	投诉个数
busyNum	占线个数
noAnswerNum	无人接听个数
interceptNum	拦截个数
breakDownNum	手机故障个数
notInServiceNum	不在服务区个数
shutDownNum	关机个数
othersNum	其他

返回值示例

不聚合情况下

{
    "result" : true,
    "statusCode" : 200,
    "message" : "请求成功",
    "info" : {
        "count" : 2,
        "voList" : [{
                "breakDownNum" : "0",
                "busyNum" : "0",
                "complaintsNum" : "0",
                "emptyPhoneNumberNum" : "0",
                "interceptNum" : "3",
                "msgType" : "0",
                "noAnswerNum" : "0",
                "notInServiceNum" : "0",
                "othersNum" : "0",
                "outOfServiceNum" : "0",
                "sendDate" : "2016-09-09",
                "shutDownNum" : "0",
                "templateId" : "2"
            }, {
                "breakDownNum" : "0",
                "busyNum" : "0",
                "complaintsNum" : "0",
                "emptyPhoneNumberNum" : "0",
                "interceptNum" : "0",
                "msgType" : "0",
                "noAnswerNum" : "0",
                "notInServiceNum" : "0",
                "othersNum" : "1",
                "outOfServiceNum" : "0",
                "sendDate" : "2016-09-27",
                "shutDownNum" : "0",
                "templateId" : "2"
            }
        ]
    }
}

聚合情况下

{
    "result" : true,
    "statusCode" : 200,
    "message" : "请求成功",
    "info" : {
        "total" : {
            "breakDownNum" : "0",
            "busyNum" : "0",
            "complaintsNum" : "0",
            "emptyPhoneNumberNum" : "5",
            "interceptNum" : "3",
            "msgType" : "None",
            "noAnswerNum" : "2",
            "notInServiceNum" : "0",
            "othersNum" : "2",
            "outOfServiceNum" : "0",
            "sendDate" : "2016-08-07到2016-11-04",
            "shutDownNum" : "0",
            "templateId" : "None"
        }
    }
}