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
聚焦模式
字号
最后更新时间: 2026-02-11 17:03:31
若全员/标签推送内容有误,终端用户查看或点击后会对产品有负面影响,此时需要及时处理。您可以选择撤回该推送。

功能说明

终止:推送任务下发需要一定时间,未下发的账号会终止下发。
撤回:已下发的账号,支持撤回未读/漫游。
覆盖:若已下发的账号收到了离线推送,支持覆盖该条推送。
本接口支持全员/标签推送任务的终止/撤回/覆盖。本文后续默认将终止/撤回/覆盖简称为撤回。
撤回有效期为24小时,从任务发起时间开始计算,超过24小时的推送任务无法撤回。

接口调用说明

请求 URL 示例

https://xxxxxx/v4/timpush/revoke?usersig=xxx&identifier=admin&sdkappid=88888888&random=99999999&contenttype=json

请求参数说明

参数
说明
https
请求协议:HTTPS
请求方式:POST
xxxxxx
SDKAppID 所在国家/地区对应的专属域名。
中国:console.tim.qq.com
新加坡:adminapisgp.im.qcloud.com
首尔: adminapikr.im.qcloud.com
东京:adminapijpn.im.qcloud.com
法兰克福:adminapiger.im.qcloud.com
硅谷:adminapiusa.im.qcloud.com
雅加达:adminapiidn.im.qcloud.com
v4/timpush/revoke
请求接口。
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
sdkappid
创建应用时,即时通信控制台分配的 SdkAppid。
random
请输入随机的32位无符号整数,取值范围0 - 4294967295。
contenttype
固定值为:json

调用频率

本接口调用限制1次/s。

请求包示例

{
"TaskId": "660cc447_537ed82a_200000cd7ee17f5_84035729_bc614e", // 24小时内发送的推送taskId
"OfflinePushInfo": { // 若推送时指定不存漫游/未读(OnlineOnlyFlag=0),则撤回时必须带上OfflinePushinfo
"Desc": "对方撤回了一条消息",
"Ext": "{\\"entity\\":{\\"key1\\":\\"value1\\",\\"key2\\":\\"value2\\"}}" // 透传字段,推送使用 JSON 格式字符串
}
}
注意:
1. 支持离线推送覆盖的厂商:APNS/Google FCM/华为/荣耀。其他厂商的离线推送不支持覆盖。(Google FCM的notification模式支持覆盖,data模式暂不支持覆盖)
2. 撤回时若接收方在前台,默认离线推送(通知栏消息)已读,则不会覆盖该条离线推送。

请求包字段说明

字段
类型
属性
说明
TaskId
String
必填
全员/标签推送任务 ID。
OfflinePushInfo
Object
选填
离线推送信息配置,具体请参见 公共参数(OfflinePushInfo说明)
注意:
若设置 OfflinePushInfo.PushFlag=1或者不设置 OfflinePushInfo,不会覆盖离线推送。

应答包体示例

{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0
}

应答包字段说明

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

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。公共错误码(60000到79999)参见 错误码 文档。
错误码
含义说明
90001
JSON 格式解析失败,请检查请求包是否符合 JSON 规范。
90009
请求需要 App 管理员权限。
90049
撤回 TaskId 不合法,无推送记录。通过 发起全员/标签推送 接口进行推送,返回的 TaskId 才能用于撤回。
90050
重复撤回,已经撤回的推送任务不能重复调用。
90051
撤回过于频繁,撤回限频1次/s。
90052
超过撤回有效期,撤回要求在24小时内,超过24小时的推送任务无法撤回。
90053
撤回无效。推送任务指定不存漫游/未读(OnlineOnlyFlag=0),但是撤回时没有带上 OfflinePushInfo。
91000
服务内部错误,请重试。

接口调试工具

通过 REST API 在线测试 工具调试本接口。

参考

帮助和支持

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

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

文档反馈