News and Announcements

Release Notes

Announcements

Product Introduction

Overview

Basic Concepts

Scenarios

Features

Account System

User Profile and Relationship Chain

Message Management

Group Related

Official Account

Audio/Video Call

Use Limits

Purchase Guide

Billing Overview

Pricing

Purchase Instructions

Renewal Guide

Service Suspension Explanation

Refund Policy

Development Guidelines

Demo Zone

Activate Service

Free Demos

Quick Run

Download

SDK and Demo Source Code

Update Log

Chat Interaction (UI Included)

TUIKit Introduction

Getting Started

Full-feature Integration

Single-function Integration

Build with AI

Build Basic Interfaces

More Features

Customizing Appearance

Internationalization

Push Service

Overview

Noun explanation

Activate the Service

Quick Start

Manufacturer Channel

Statistics

Troubleshooting Tool

Client APIs

REST API

Push Callback

Advanced Features

Release Notes

Error Codes

FAQS

Desk

Overview

Quick Start

Integration Guide

Admin Operation Manual

Agent Manual

More Practices

Live Streaming Setup Guide

AI Chatbot

Super Large Entertainment and Collaboration Community

Discord Implementation Guide

How to Integrate Chat into Games

WhatsApp Channel-style Official Account Integration Solution

Send Red Packet

Firewall Restrictions

No UI Integration

Quick Start

SDK Integration

Initialization

Message

Conversation

Group

Community Topic

User Profile and Relationship Chain

Offline Push

Cloud Search

Local Search

Official Channel Management

Client APIs

JavaScript

Android

iOS & macOS

Swift

Flutter

Electron

Unity

React Native

C APIs

C++

Server APIs

Secure authentication with UserSig

RESTful APIs

Webhooks

Console Guide

New Console Introduction

Creating and Upgrading an Application

Basic Configuration

Feature Configuration

Account Management

Group Management

Official Channel Management

Webhook Configuration

Usage

Viewing Guide for Resource Packages

Real-Time Monitor

Auxiliary Development Tools

Access Management

Advanced Features

FAQs

uni-app FAQs

Purchase

SDK

Account Authentication

User Profile and Relationship Chain

Message

Group

Audio-Video Group

Nickname and Profile Photo

Security Compliance Certification

Service Level Agreement

Security Compliance Certification

Chat Policies

Data Privacy and Security Agreement

Migration

Migration Solutions

Migration Solutions Lite

Error Codes

Recalling Push

PDF

Focus Mode

Font Size

Last updated: 2026-02-11 17:03:31

If the content pushed to all staff/Tag is incorrect, it may negatively impact the product when the end user views or clicks it. Timely handling is necessary. You can choose to recall the push.
Feature Overview
Terminate: Issuing push tasks takes some time, and the accounts not yet issued will have their deliveries terminated.
Recall: For accounts that have been issued, it supports recalling unread/roaming messages.
Overwrite: If the issued accounts have received offline push, it supports overwriting the push.
This interface supports the termination/recall/overwrite of push tasks for All-user/Tags. In the following text, termination/recall/overwrite is referred to as recall by default.
The recall validity period is 24 hours, starting from the task initiation time. Push tasks older than 24 hours cannot be recalled.
API Calling Description
Sample request URL
https://xxxxxx/v4/timpush/revoke?usersig=xxx&identifier=admin&sdkappid=88888888&random=99999999&contenttype=json
Request parameters
Parameter
Description
https
Request protocol: HTTPS
Request method: POST
xxxxxx
The dedicated domain corresponding to the country/region of your SDKAppID.
China: console.tim.qq.com
Singapore :adminapisgp.im.qcloud.com
Seoul : adminapikr.im.qcloud.com
Tokyo：adminapijpn.im.qcloud.com
Frankfurt :adminapiger.im.qcloud.com
Silicon Valley :adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/timpush/revoke
Request API.
usersig
The Signature generated by the App admin account. For details, see Generating UserSig.
identifier
You must be an App admin account. For more details, see App Admins.
sdkappid
SdkAppid assigned by the Chat console when creating an app.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype
Fixed value: json
Invocation Frequency
This interface invocation is limited to 1 time per second.
Sample request packets
{
    "TaskId": "660cc447_537ed82a_200000cd7ee17f5_84035729_bc614e",  // Push taskId sent within 24 hours
     "OfflinePushInfo": { // If roaming/unread is not specified when pushing (OnlineOnlyFlag=0), OfflinePushInfo must be included when recalling
        "Title": "Recall Title",
        "Desc": "The other party has recalled a message",
        "Ext": "{\\"entity\\":{\\"key1\\":\\"value1\\",\\"key2\\":\\"value2\\"}}" // Passthrough field, using JSON format string for push
    }
}
Note:
1. Supported vendors for Offline Push Overwrite: APNS/Google FCM/Huawei/Honor. Offline push overwrite is not supported for other vendors. (Google FCM notification mode supports overwrite, data mode does not support overwrite yet)
2. When recalling, if the recipient is in the foreground and the default offline push (notification bar message) is read, that offline push will not be overwritten.
﻿Request Packet Field Description
Field
Type
Attribute
Description
TaskId
String
Required
All Staff/ Tag Push Task ID.
OfflinePushInfo
Object
Optional
Offline Push Notification Configuration, please refer to OfflinePushInfo Description.
Note：
If OfflinePushinfo.PushFlag=1 is set or OfflinePushInfo is not set, offline push will not be overwritten.
Sample response packets
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}
Response packet field description
Field
Type
Description
ActionStatus
String
Processed Request Result:
OK: Indicates successful processing.
FAIL: Indicates failure.
ErrorCode
Integer
Error Identifier:
0 indicates success.
Non-zero indicates failure.
ErrorInfo
String
Error message.
Error codes
Unless a network error occurs (e.g., a 502 error), the HTTP return code for this interface is always 200. The actual error code and error information are represented through ErrorCode and ErrorInfo in the response payload. For common error codes (60000 to 79999), refer to the Error Codes document. 
Error code
Description
90001
Failed to parse the JSON format. Please ensure the request packet conforms to the JSON specification.
90009
The request requires App Administrator permissions.
90049
Invalid TaskId for recall, no push records. Use the All-user/Tags push interface for the push, and only the returned TaskId can be used for recall.
90050
Duplicate recall, a push task that has already been recalled cannot be recalled again.
90051
Recall too frequent, recall frequency limit is 1 time per second.
90052
Exceeds recall validity period, recall must be done within 24 hours. Push tasks older than 24 hours cannot be recalled.
90053
Recall invalid. The push task specified no roaming/unread (OnlineOnlyFlag=0), but OfflinePushInfo was not included during recall.
91000
Internal service error, please try again.
API Debugging Tool
Use the RESTful API online debugging tool to debug this API.
Reference
﻿All-user/Tag Push﻿
﻿Set application attribute name﻿
﻿Get application attribute name﻿
﻿Set user attributes﻿
﻿Delete user attributes﻿
﻿Get User Attributes﻿
﻿Add User Tags﻿
﻿Get User Tags﻿
﻿Delete User Tags﻿
﻿Clear User Tags﻿
﻿Push Recall﻿
﻿

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

Help us improve! Rate your documentation experience in 5 mins.

Feedback

Parameter	Description
https	Request protocol: HTTPS Request method: POST
xxxxxx	The dedicated domain corresponding to the country/region of your SDKAppID. China: `console.tim.qq.com` Singapore :`adminapisgp.im.qcloud.com` Seoul : `adminapikr.im.qcloud.com` Tokyo：`adminapijpn.im.qcloud.com` Frankfurt :`adminapiger.im.qcloud.com` Silicon Valley :`adminapiusa.im.qcloud.com` Jakarta: `adminapiidn.im.qcloud.com`
v4/timpush/revoke	Request API.
usersig	The Signature generated by the App admin account. For details, see Generating UserSig.
identifier	You must be an App admin account. For more details, see App Admins.
sdkappid	SdkAppid assigned by the Chat console when creating an app.
random	A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype	Fixed value: `json`

Field	Type	Attribute	Description
TaskId	String	Required	All Staff/ Tag Push Task ID.
OfflinePushInfo	Object	Optional	Offline Push Notification Configuration, please refer to OfflinePushInfo Description. Note： If OfflinePushinfo.PushFlag=1 is set or OfflinePushInfo is not set, offline push will not be overwritten.

Error code	Description
90001	Failed to parse the JSON format. Please ensure the request packet conforms to the JSON specification.
90009	The request requires App Administrator permissions.
90049	Invalid TaskId for recall, no push records. Use the All-user/Tags push interface for the push, and only the returned TaskId can be used for recall.
90050	Duplicate recall, a push task that has already been recalled cannot be recalled again.
90051	Recall too frequent, recall frequency limit is 1 time per second.
90052	Exceeds recall validity period, recall must be done within 24 hours. Push tasks older than 24 hours cannot be recalled.
90053	Recall invalid. The push task specified no roaming/unread (OnlineOnlyFlag=0), but OfflinePushInfo was not included during recall.
91000	Internal service error, please try again.

tencent cloud

Chat

Recalling Push

Feature Overview

API Calling Description

Sample request URL

Request parameters

Invocation Frequency

Sample request packets

﻿Request Packet Field Description

Sample response packets

Response packet field description

Error codes

API Debugging Tool

Reference

Help and Support

Request Packet Field Description