tencent cloud

Chat

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
Login and Logout
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
Privacy Policy
Data Privacy and Security Agreement
Migration
Migration Solutions
Migration Solutions Lite
Error Codes
Contact Us
DocumentationChatServer APIsWebhooksGroup WebhooksCallback After Recalling Group Messages

Callback After Recalling Group Messages

PDF
Focus Mode
Font Size
Last updated: 2025-02-28 11:06:35

Overview

This webhook event is used by the app backend to check the recalls of group messages in real time.

Notes

To enable this webhook, you must configure a webhook URL and toggle on the corresponding protocol. For more information on the configuration method, see Webhook Configuration.
During this webhook event, the Chat backend initiates an HTTP POST request to the app backend.
After receiving the webhook request, the app backend must check whether the SDKAppID contained in the request URL is the SDKAppID of the app.
For more security considerations, see the Security Considerations section in Webhook Overview.

Webhook Triggering Scenarios

An app user recalls a group message on the client.
An app admin recalls a group message via calling the RESTful API.

Webhook Triggering Timing

After a group message is recalled successfully

API Calling Description

Sample request URL

In the following sample, the webhook URL configured in the app is https://www.example.com. Example:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

Request parameters

Parameter
Description
https
The request protocol is HTTPS, and the request method is POST.
www.example.com
Webhook URL.
SdkAppid
The SDKAppID assigned by the Chat console when the app is created.
CallbackCommand
Fixed value: Group.CallbackAfterRecallMsg.
contenttype
Fixed value: json.
ClientIP
Client IP, such as 127.0.0.1.
OptPlatform
Client platform. For valid values, see the description of OptPlatform in the Webhook Protocols section of Webhook Overview.

Sample request

{
"CallbackCommand":"Group.CallbackAfterRecallMsg", // Webhook command
"Operator_Account":"admin", // Operator
"Type": "Community", // Group type
"GroupId":"1213456", // Group ID
"MsgSeqList":[ // `MsgSeq` list of recalled messages
{
"MsgSeq":130,
"MsgId":"144115213033478435-1739361321-2512805311"
}
],
"TopicId":"@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic",// Topic ID, which applies only to topic-enabled communities
"EventTime":"1670574414123"// Event trigger timestamp in milliseconds
}

Request fields

Object
Type
Description
CallbackCommand
String
Webhook command.
Operator_Account
String
The UserID of the operator who recalls a group message.
Type
String
Type of the group that generates group messages, such as Public. For details, see Group Types section in Group System.
GroupId
String
Group ID.
MsgSeqList
Array
List of recalled messages,which containing MsgId and MsgSeqfields , representing the client message unique identifier and message MsgSeq of the withdrawn message, respectively.
TopicId
String
Topic ID, which indicates message recall in the topic and applies only to topic-enabled communities.
EventTime
Integer
Event trigger timestamp in milliseconds.

Sample response

{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0 //The value `0` indicates that the webhook result is ignored.
}

Response fields

Field
Type
Required
Description
ActionStatus
String
Yes
Request result. OK: Successful; FAIL: Failed.
ErrorCode
Integer
Yes
Error code. The value 0 indicates that the webhook result is ignored.
ErrorInfo
String
Yes
Error information.

References

Help and Support

Was this page helpful?

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

Feedback