After a Topic Is Deleted

最終更新日:2024-02-07 17:28:39

Feature Overview
This callback allows you to view the deletion status of a topic in real time on the application backend. Specifically, you can view the real-time log of the topic deletion or sync the information to other systems.
Notes
To enable this callback, you must configure the URL. This callback and the callback after group disbanding use the same switch. For detailed directions, see Webhook Configuration.
During this callback, the IM backend initiates an HTTP POST request to the app backend.
After receiving the callback 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 Third-Party Callback Overview.
You need to enable the topic feature in the console before using it.
Callback Triggering Scenarios
The application user deletes a topic on the client.
The application admin deletes a topic through the RESTful API.
Callback Triggering Timing
It will be triggered after a topic is deleted.
API Calling Description
Sample request URL
In the following sample, the callback 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
Callback URL
SdkAppid
The SDKAppID assigned by the IM console when the app is created
CallbackCommand
Fixed value: Group.CallbackAfterTopicDestroyed.
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 Callback Protocols section of Third-Party Callback Overview.
Sample request
{
    "CallbackCommand": "Group.CallbackAfterTopicDestroyed", // Callback command
    "GroupId": "@TGS#_@TGS#cQVLVHIM62CJ", // Group ID of the deleted topic
    "Type": "Community", 	// Group type
    "TopicIdList":[		// List of the deleted topics
       "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic",
       "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic_1"
    ]
}
Request fields
Object
Type
Description
CallbackCommand
String
Callback command
GroupId
String
Group of the deleted topic
Type
String
Group type of the deleted topic. Here, it is Community.
TopicIdList
String
List of the deleted topics
Sample response
The application backend records the topic deletion information and sends the callback response packet.
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0
}
Response fields
Field
Type
Required
Description
ActionStatus
String
Yes
Request result. OK: Successful; FAIL: Failed
ErrorCode
Integer
Required
Error code. We recommend you set it to 0. This callback is used to notify users of the topic deletion. The error code value of the user doesn't affect the deletion process.
ErrorInfo
String
Yes
Error information
References
Third-Party Callback Overview
RESTful API: Deleting Topic

tencent cloud

Recent Pages

After a Topic Is Deleted

Feature Overview

Notes

Callback Triggering Scenarios

Callback Triggering Timing

API Calling Description

Sample request URL

Request parameters

Sample request

Request fields

Sample response

Response fields

References

この記事はお役に立ちましたか？

この記事はお役に立ちましたか？

Parameter	Description
https	The request protocol is HTTPS, and the request method is POST.
www.example.com	Callback URL
SdkAppid	The `SDKAppID` assigned by the IM console when the app is created
CallbackCommand	Fixed value: `Group.CallbackAfterTopicDestroyed`.
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 Callback Protocols section of Third-Party Callback Overview.

Object	Type	Description
CallbackCommand	String	Callback command
GroupId	String	Group of the deleted topic
Type	String	Group type of the deleted topic. Here, it is `Community`.
TopicIdList	String	List of the deleted topics

Field	Type	Required	Description
ActionStatus	String	Yes	Request result. `OK`: Successful; `FAIL`: Failed
ErrorCode	Integer	Required	Error code. We recommend you set it to `0`. This callback is used to notify users of the topic deletion. The error code value of the user doesn't affect the deletion process.
ErrorInfo	String	Yes	Error information

tencent cloud

サインアップ

ログイン

Recent Pages

After a Topic Is Deleted

Feature Overview

Notes

Callback Triggering Scenarios

Callback Triggering Timing

API Calling Description

Sample request URL

Request parameters

Sample request

Request fields

Sample response

Response fields

References

この記事はお役に立ちましたか？

この記事はお役に立ちましたか？