tencent cloud

即时通信 IM

动态与公告
产品动态
公告
产品简介
产品概述
基本概念
应用场景
功能介绍
账号系统
用户资料与关系链
消息管理
群组相关
公众号系统
音视频通话 Call
使用限制
购买指南
计费概述
价格说明
购买指引
续费指引
停服说明
退费说明
开发指引
Demo 专区
开通服务
体验 Demo
快速跑通
下载中心
SDK & Demo 源码
更新日志
聊天互动(含 UI)
TUIKit 组件介绍
快速开始
全功能接入
单功能接入
AI 集成
构建基础界面
更多特性
定义外观
国际化界面语言
推送服务(Push)
服务概述
名词解释
开通服务
快速跑通
厂商通道
数据统计
排查工具
客户端 API
服务端 API
推送回调
高级功能
更新日志
错误码
常见问题
智能客服
功能概述
快速入门
集成指引
管理员操作手册
客服操作手册
更多实践
直播间搭建
AI 聊天机器人方案
超大娱乐协作社群
Discord 实现指南
游戏内集成 Chat 指南
类 WhatsApp Channel 搭建方案
发送红包
Chat 应对防火墙限制相关
无 UI 集成
快速开始
集成 SDK
初始化
登录登出
消息相关
会话相关
群组相关
社群话题
用户管理
离线推送
云端搜索
本地搜索
公众号
客户端 API
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C 接口
C++
服务端 API
生成 UserSig
REST API
第三方回调
控制台指南
新版控制台介绍
创建并升级应用
基本配置
功能配置
账号管理
群组管理
公众号管理
回调配置
用量统计
资源包查看指南
实时监控
开发辅助工具
访问管理
高级功能
常见问题
uni-app 常见问题
购买相关问题
SDK 相关问题
账号鉴权相关问题
用户资料与关系链相关问题
消息相关问题
群组相关问题
直播群相关问题
昵称头像相关问题
协议与认证
服务等级协议
安全合规认证
IM 政策
隐私政策
数据隐私和安全协议
平滑迁移方案
平滑迁移完整版
平滑迁移简化版
错误码
联系我们

全员/标签/单推回调

PDF
聚焦模式
字号
最后更新时间: 2025-10-27 10:39:23

功能说明

开启推送插件后,推送结果可以通过配置基础回调的方式,将结果转发给 App 后台。

注意事项

该回调属于下行扩散后的事件回调,为防止大量回调请求打垮 App 后台,默认QPS:1000次/s。超频的回调会延迟一段时间重试,如果您因业务需求需要调整 QPS,可以提交工单申请。
要启用回调,必须配置回调 URL,并打开本回调对应的开关,配置方法详见 第三方回调配置 文档。
回调的方向是即时通信 Chat 后台向 App 后台发起 HTTP POST 请求。
App 后台在收到回调请求之后,务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。
其他安全相关事宜请参见 第三方回调简介:安全考虑 文档。

接口说明

请求 URL 示例

以下示例中 App 配置的回调 URL 为https://www.example.com 示例:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json

请求参数说明

字段
说明
https
请求协议为 HTTPS
请求方式为 POST
www.example.com
回调 URL
SdkAppid
创建应用时在即时通信 Chat 控制台分配的 SDKAppID
CallbackCommand
固定为:Push.AllMemberPush
contenttype
请求包体固定为 JSON

请求包示例

{
"Events": [ // events数组长度范围为1~100
{
"CallbackCommand":"Push.AllMemberPush",
"EventType": 1, // 事件类型,EventType=1表示离线推送
"TaskId": "657bf434_537529d8_2000005e80aa873_2780d131_bc614e", // 全员/标签/单推推送 TaskId
"TaskTime": 1557481127, // 全员推送任务发起时间戳, 单位为秒
"EventTime": 1557481128, // 事件发生时间戳, 单位为秒
"To_Account": "user2", // 接受者
"PushPlatform": 1, // 推送厂商
"PushStage": 1, // 推送阶段
"ErrCode": 0, // 推送事件结果
"ErrInfo": "OK" // 推送事件结果描述,可能为空
},
{
"CallbackCommand":"Push.AllMemberPush",
"EventType": 2, // 事件类型,EventType=2表示在线推送
"TaskId": "657bf434_537529d8_2000005e80aa873_2780d131_9", // 全员/标签/单推推送 TaskId
"TaskTime": 1557481127, // 全员推送任务发起时间戳, 单位为秒
"EventTime": 1557481129, // 事件发生时间戳, 单位为秒
"To_Account": "user3", // 接受者
"PushPlatform": 0, // 推送厂商
"PushStage": 1, // 推送阶段
"ErrCode": 0, // 推送事件结果
"ErrInfo": "OK" // 推送事件结果描述,可能为空
},
....
]
}

请求包字段说明

字段
类型
说明
Events
Array [ Event Object ]
批量回调内容,最多包含100个回调事件(Event Object)的数据
Event Object结构
字段
类型
说明
CallbackCommand
String
回调命令
EventType
Integer
事件类型:
EventType = 1表示离线推送
EventType = 2表示在线推送
TaskId
String
全员推送发送时返回的任务 ID
DataId
String
客户业务自定义标识,回调透传推送请求中的该字段
TaskTime
Integer
全员推送任务发起时间戳,单位为秒
EventTime
Integer
事件发生时间戳,单位为秒
To_Account
String
消息接收者 UserID
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表示荣耀推送
DeviceType
Integer
推送设备类型(离线推送 EventType = 1不区分设备类型,默认返回0):
DeviceType = 0表示未知设备
DeviceType = 1表示 Apple 设备
DeviceType = 2表示小米设备
DeviceType = 3表示华为设备
DeviceType = 4表示 Google 设备
DeviceType = 5表示魅族设备
DeviceType = 6表示 OPPO 设备
DeviceType = 7表示 vivo 设备
DeviceType = 8表示荣耀设备
DeviceType = 9表示鸿蒙设备
PushStage
Integer
推送阶段:
PushStage = 1表示推送发送
PushStage = 2表示推送触达
PushStage = 3表示推送点击
ErrCode
Integer
推送事件结果:
ErrCode = 0表示成功
ErrCode 非0表示失败
ErrInfo
String
推送事件结果描述,可能为空

应答包示例

{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0 // 0为回调成功,1为回调出错
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果:
OK 表示处理成功
FAIL 表示失败
ErrorCode
Integer
错误码
ErrorInfo
String
错误说明


帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈