全员/标签推送消息链路
功能说明
开启开通推送服务 Push 后,调用该接口,可以查看全员/标签推送的链路数据,该接口支持7天内数据查询。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/timpush/all_member_push_trace?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/all_member_push_trace | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
1次/秒。
请求包示例
{"TaskID":"xxx-yyy-zzz","UserID":"xyz"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
TaskID | String | 必填 | 查询的推送任务TaskID。 |
UserID | String | 必填 | 查询推送接收的用户UserID。 |
应答包体示例
{"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": "sucess","InstanceTrace": [{"InstanceId": "74224656","PushTime": "2025-03-13 16:16:27","DeviceModel": "","System": "Android","SystemVersion": "","EventType":1,"PushPlatform": 1,"Token": "aabbc","CertId": "1122","SdkVersion": "8.0.1","PushVersion": "8.0.1","NotificationStatus": 1,"last_active_terminal": 1,"IMCommitStat": {"IMStat": {"PushStatus": 1,"ErrorCode": 0,"ErrorInfo": "success","EventTime": "2025-03-13 16:16:29"}},"OfflinePushStat": {"OfflineStat": {"PushStatus": 1,"ErrorCode": 0,"ErrorInfo": "success","EventTime": "2025-03-13 16:16:29"},"ChannelStat": {"PushStatus": 1,"ErrorCode": 0,"ErrorInfo": "success","EventTime": "2025-03-13 16:16:29"},"DeviceStat": {"PushStatus": 1,"ErrorCode": 0,"ErrorInfo": "success","EventTime": "2025-03-13 16:16:29"},"ClickStat": {"PushStatus": 1,"ErrorCode": 0,"ErrorInfo": "success","EventTime": "2025-03-13 16:16:29"}},"OnlinePushStat": {"ChannelStat": {"PushStatus": 1,"ErrorCode": 0,"ErrorInfo": "success","EventTime": "2025-03-13 16:16:29"},"DeviceStat": {"PushStatus": 1,"ErrorCode": 0,"ErrorInfo": "success","EventTime": "2025-03-13 16:16:29"}}}]}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果,OK 表示处理成功,FAIL 表示失败。 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败。 |
ErrorInfo | String | 错误信息。 |
InstanceTrace | Array | 各个IM实例推送相关的链路数据整理。 |
InstanceId | String | IM实例标识。 |
PushTime | String | 推送任务时间。 |
DeviceModel | String | 设备型号。 |
System | String | 设备系统。 |
SystemVersion | String | 设备系统版本。 |
EventType | Integer | 1=离线推送;2=在线推送。 |
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表示荣耀推送 |
Token | String | 厂商Token。 |
CertId | String | 证书ID。 |
SdkVersion | String | SDK版本号。 |
PushVersion | String | 推送插件版本号。 |
NotificationStatus | Integer | 通知栏状态是否开启。 |
LastActiveTerminal | Integer | 是否是最近激活的IM实例。 |
IMCommitStat | Object | 提交IM服务器的状态。 |
IMStat | Object | IM的状态。 |
OfflinePushStat | Object | 离线通道的状态。 |
OfflineStat | Object | 提交离线通道的状态。 |
ChannelStat | Object | 提交厂商通道的状态。 |
DeviceStat | Object | 消息推送至设备的状态。 |
ClickStat | Object | 用户点击的状态。 |
OnlinePushStat | Object | 在线通道的状态。 |
ChannelStat | Object | 提交厂商通道的状态。 |
DeviceStat | Object | 消息推送至设备的状态。 |
PushStatus | Integer | 成功或者失败,1表示成功,2表示失败。 |
ErrorCode | Integer | 失败对应的错误码。 |
ErrorInfo | String | 错误描述。 |
EventTime | String | 事件发送时间。 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ResultCode、ResultInfo、ErrorCode 以及 ErrorInfo 来表示的。
本 API 私有错误码如下:
错误码 | 描述 |
91000 | 请求错误,请根据错误提示排查问题。 |
90009 | 请求缺少权限,请使用管理员调用。 |
90045 | 服务没有开通,请确保服务开启使用。 |
90100 | 请求参数无效,请根据文档检查参数是否合法。 |
90102 | 请求内部错误,请稍后重试。 |
90103 | 换账号失败,请检查UserID是否合法。 |