tencent cloud

Overview

This webhook event is used by the app backend to check users' group creation requests in real time. The app backend can also reject the requests.

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

• The app user creates a group on the client.
• The app admin creates a group through the RESTful API.

Webhook Triggering Timing

It will be triggered before the Chat backend creates a group.

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

Sample request

{
    "CallbackCommand": "Group.CallbackBeforeCreateGroup", // Webhook command
    "Operator_Account": "leckie", // Operator
    "Owner_Account": "leckie", // Group owner
    "Type": "Public", // Group type
    "Name": "MyFirstGroup", // Group name
    "CreateGroupNum": 123, // Number of groups of the same type that the user has created
    "MemberList": [ // List of initial members
        {
            "Member_Account": "bob"
        },
        {
            "Member_Account": "peter"
        }
    ],
    "EventTime":"1670574414123"// Event trigger timestamp in milliseconds
}

Request fields

Sample response

Creation allowed

The user is allowed to create a group.

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // Creation allowed
}

Creation disallowed

The user is not allowed to create a group. No group will be created, and the error code 10016 will be returned to the caller.

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 1 // Creation refused
}

Response fields

References

• Webhook Overview
• RESTful API: Creating a Group