tencent cloud

Chat

제품 소개
제품 개요
Basic Concepts
응용 시나리오
기능 소개
계정 시스템
사용자 정보 및 관계망
메시지 관리
그룹 시스템
Official Account
Audio/Video Call
사용 제한
구매 가이드
과금 개요
요금 안내
Purchase Instructions
Renewal Guide
연체 안내
Refund Policy
다운로드 센터
SDK & Demo 소스 코드
업데이트 로그
시나리오 솔루션
Live Streaming Setup Guide
AI Chatbot
대규모 엔터테인먼트 협업 커뮤니티
Discord 구현 가이드
IM을 게임에 통합하는 방법
WhatsApp Channel-style Official Account Integration Solution
Send Red Packet
Firewall Restrictions
클라이언트 APIs
SDK API(Web)
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C APIs
C++
서버 APIs
Secure authentication with UserSig
RESTful APIs
Webhooks
콘솔 가이드
New Console Introduction
애플리케이션 생성 및 업그레이드
기본 설정
기능 설정
계정 관리
그룹 관리
Official Channel Management
콜백 설정
모니터링 대시보드
Viewing Guide for Resource Packages
Real-Time Monitor
개발 보조 툴
액세스 관리
Advanced Features
FAQ
uni-app FAQs
구매
SDK 관련 질문
계정 인증
사용자 정보 및 관계망
메시지
그룹
라이브 방송 그룹
닉네임 및 프로필 사진
협약 및 인증
Service Level Agreement
컴플라이언스 인증
IM 정책
개인 정보 보호 정책
데이터 개인 정보 보호 및 보안 계약
에러 코드
문의하기

Recalling Push

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 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



도움말 및 지원

문제 해결에 도움이 되었나요?

피드백