The app backend uses this callback to monitor users’ requests to join groups in real time, including blocking these requests.
This callback is triggered when an app user submits a request to join a group through the client.
This callback is triggered before the IM backend adds the requesting user to the group. (If the request needs to be approved by the admin, the callback occurs before the admin is notified.)
In the following example, 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
Parameter | Description |
---|---|
https | The request protocol is HTTPS, and the request method is POST. |
www.example.com | The callback URL. |
SdkAppid | The SDKAppID assigned by the IM console when an app is created. |
CallbackCommand | The value is fixed to Group.CallbackBeforeApplyJoinGroup. |
contenttype | The value is fixed to JSON. |
ClientIP | The client IP address, whose format is similar to 127.0.0.1. |
OptPlatform | The client platform. For details on the possible values, see the OptPlatform parameter in Third-Party Callback Overview: Callback Protocols. |
{
"CallbackCommand": "Group.CallbackBeforeApplyJoinGroup", // Callback command
"GroupId" : "@TGS#2J4SZEAEL",
"Type": "Public", // Group type
"Requestor_Account": "jared" // Requester
}
Field | Type | Description |
---|---|---|
CallbackCommand | String | The callback command. |
GroupId | String | The ID of the group that generates group messages. |
Type | String | The type of the group that generates group messages, such as Public. For details, see Group Types. |
Requestor_Account | String | The UserID of the requester. |
Allows the system to continue to process the user’s request to join a group.
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0 // Indicates that the system can continue to process the request to join the group.
}
Disallows the system to continue to process the user’s request to join a group and returns error code 10016
to the caller.
{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 1 // Indicates that the request to join a group is rejected.
}
Field | Type | Attribute | Description |
---|---|---|---|
ActionStatus | String | Required | The request processing result. OK: succeeded. FAIL: failed. |
ErrorCode | Integer | Required | The error code. 0: the system can continue to process the request. 1: the request is rejected. If the request needs to be approved by the admin, the system must wait for the admin to approve the request even if error code 0 is returned. |
ErrorInfo | String | Required | Error information. |
Was this page helpful?