After Official Channel Is Destroyed
Feature Overview
The app backend can monitor the dissolution dynamics of the official channel in real time through this webhook, including: real-time recording of the official channel's dissolution (for example, logging or syncing to other systems).
Notes
To enable the webhook, you must configure the Webhook URL and toggle on the corresponding protocol. For more information on the configuration method, see Webhook Configuration.
During this webhook, 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 additional safety-related concerns, please refer to the Webhook Overview: Security Considerations document.
Webhook Triggering Scenarios
The app administrator destroys the official channel through the REST API.
Webhook Triggering Timing
After the official channel is successfully destroyed.
API Calling Description
Sample request URL
In the subsequent example, the webhook URL configured within 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 | SDKAppID assigned by the Chat console when an app is created. |
CallbackCommand | Fixed to: OfficialAccount.CallbackAfterOfficialAccountDestroyed. |
contenttype | Fixed value: JSON. |
ClientIP | Client IP, such as: 127.0.0.1. |
OptPlatform | Client Platform, for values please refer to Webhook Overview: Webhook Protocol for the meaning of the OptPlatform parameter. |
Sample request
{"CallbackCommand": "OfficialAccount.CallbackAfterOfficialAccountDestroyed", // Callback command"Official_Account" : "@TOA#_test_OA_for_penn","Owner_Account": "107867", // Owner of the official channel"Name": "TestOfficialAccount", // Group name"EventTime": 1670574414123// Event trigger timestamp in milliseconds}
Request fields
Object | Features | Feature |
CallbackCommand | String | Webhook command. |
Official_Account | String | ID of the destroyed official channel. |
Owner_Account | String | The creator of the official channel, who is also the owner of the official channel. |
Name | String | Name of the official channel. |
EventTime | Integer | Event trigger timestamp in milliseconds. |
Sample response
Following data synchronization, the app backend dispatches a webhook response packet.
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0}
Response fields
Field | Type | Attribute | Description |
ActionStatus | String | Mandatory | Processed Request Result: OK: Indicates successful processing FAIL: Indicates failure |
ErrorCode | Integer | Mandatory | Error Code, a 0 here means to ignore the response. |
ErrorInfo | String | Mandatory | Error message. |
References
REST API:Destroy official channel
