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 WebhooksAfter a Group Message Extension Is Configured

After a Group Message Extension Is Configured

PDF
Focus Mode
Font Size
Last updated: 2026-01-04 17:41:05

Feature Overview

This webhook allows your app backend to monitor user message extension operations in group chats in real-time.

Notes

To receive this webhook, you must configure the callback URL and turn on the corresponding switch. For detailed configuration steps, see Webhook Overview.
The Chat backend sends HTTPS POST requests to your app backend. After receiving a webhook request, verify that the SDKAppID parameter matches your application's SDKAppID. For additional security considerations, see Webhook Overview: Security Considerations.

Webhook Triggering Scenarios

This webhook is triggered when message extensions are set for group chats through either:
Client SDK: Users configure message extensions via the client.
REST API: Admins configure message extensions using the Set Group Message Extension.

Webhook Triggering Timing

The webhook fires after a group message extension is successfully set.

API Description

Sample Request URL

In the following example, the callback URL configured for 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
Callback URL.
SDKAppID
The SDKAppID assigned in the chat console when creating an application.
CallbackCommand
Fixed as: Group.CallbackAfterGroupMsgExtension.
contenttype
Request body fixed as JSON.
ClientIP
Client IP address (e.g., 127.0.0.1).
OptPlatform
Client platform. For the valid values, see the description of the OptPlatform parameter in Webhook Protocol.

Sample request

// Set Message Extension KV
{
"CallbackCommand": "Group.CallbackAfterGroupMsgExtension",
"GroupId":"test",
"MsgSeq":10,
"OperateType":1,
"ExtensionList":[
{"Key":"key2","Value":"value2","Seq":56}, // Version number of a single KV
{"Key":"key3","Value":"12122","Seq":56}
],
"Seq":56, // Represents the latest version number of the entire message
"EventTime":1764688294360
}

// Delete Message Extension KV
{
"CallbackCommand": "Group.CallbackAfterGroupMsgExtension",
"GroupId":"test",
"MsgSeq":10,
"OperateType":2,
"ExtensionList":[
{"Key":"key2","Value":"","Seq":57},
{"Key":"key3","Value":"","Seq":57}
],
"Seq":57, // Represents the latest version number of the entire message
"EventTime":1764688312045
}

// Clear Message Extension KV
{
"CallbackCommand": "Group.CallbackAfterGroupMsgExtension",
"GroupId":"test",
"MsgSeq":10,
"OperateType":3,
"ExtensionList":[],
"Seq":58, // Represents the latest version number of the entire message
"EventTime":1764688329047
}

Request fields

Field
Type
Description
CallbackCommand
String
Callback command.
GroupId
String
Group ID.
MsgSeq
Integer
Group message Seq.
OperateType
Integer
1: Set message extension key-value(KV) pairs.
2: Delete message extension KV.
3: Clear all message extension KV.
ExtensionList
Array
Array of message extension key-value pairs.
Seq
Integer
Version number.
EventTime
Integer
Event trigger timestamp, in milliseconds.

Sample response

{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0 // 0: callback successful; 1: callback error.
}

Response fields

Field
Type
Required
Description
ActionStatus
String
Required
Request processing result:
OK: Successfully processed.
FAIL: Processing failed.
ErrorCode
Integer
Required
Error Code:
0: Callback processed successfully.
1: Callback processing error.
ErrorInfo
String
Required
Error Message.

References

Help and Support

Was this page helpful?

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

Feedback