普通推送数据统计
功能说明
开启开通推送服务 Push 后,调用该接口,可以查询IM单/群聊消息推送相关统计数据。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/timpush/normal_push_statistics?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名。 中国: console.tim.qq.com 新加坡: adminapisgp.im.qcloud.com 首尔: adminapikr.im.qcloud.com 法兰克福: adminapiger.im.qcloud.com 硅谷: adminapiusa.im.qcloud.com 雅加达: adminapiidn.im.qcloud.com |
v4/timpush/normal_push_statistics | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
1次/秒。
请求包示例
{"StartTime":1741104000,"EndTime":1741795200}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
StartTime | Integer | 必填 | 查询的起始unix时间戳,单位为秒,最大支持30天内数据查询。 |
EndTime | Integer | 必填 | 查询的起始unix时间戳,单位为秒,最大支持30天内数据查询。 |
应答包体示例
{"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": "sucess","TotalCount": 933478,"SentCount": 637076,"DeliveredCount": 7616,"ClickCount": 421,"PlatformStatistics": [{"PushPlatform": 8,"TotalCount": 293,"SentCount": 0,"DeliveredCount": 0,"ClickCount": 0}]}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果,OK 表示处理成功,FAIL 表示失败。 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败。 |
ErrorInfo | String | 错误信息。 |
TotalCount | Integer | 可发送数量。 |
SentCount | Integer | 发送数量。 |
DeliveredCount | Integer | 触达数量。 |
ClickCount | Integer | 点击数量。 |
PlatformStatistics | Array | 各个推送通道统计结果。 |
PushPlatform | Integer | 推送厂商(在线推送 EventType = 2不区分厂商,默认返回0): PushPlatform = 0表示未知厂商 PushPlatform = 1表示 Apple APNS 推送 PushPlatform = 2表示小米推送 PushPlatform = 3表示华为推送 PushPlatform = 4表示 Google FCM 推送 PushPlatform = 5表示魅族推送 PushPlatform = 6表示 OPPO 推送 PushPlatform = 7表示 vivo 推送 PushPlatform = 8表示荣耀推送 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ResultCode、ResultInfo、ErrorCode 以及 ErrorInfo 来表示的。
本 API 私有错误码如下:
错误码 | 描述 |
91000 | 请求错误,请根据错误提示排查问题。 |
90009 | 请求缺少权限,请使用管理员调用。 |
90045 | 服务没有开通,请确保服务开启使用。 |
90100 | 请求参数无效,请根据文档检查参数是否合法。 |
90102 | 请求内部错误,请稍后重试。 |
90103 | 换账号失败,请检查UserID是否合法。 |