Feature Description

Through this callback, the app backend can monitor users’ group creation requests in real time. The backend can reject users’ requests for creating groups.

Notes

• To enable the callback, you must configure the callback URL and toggle on the callback protocol. For details on the configuration method, see Third-Party Callback Configuration.
• The callback direction is that 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 in the request URL is consistent with its own SDKAppID.
• For other security-related issues, see Third-Party Callback Introduction: Security Considerations.

Callback Triggering Scenarios

• An app user uses a client to create a group.
• The app admin creates a group through the RESTful API.

Callback Triggering Time

Perform the callback before the IM backend prepares to create a group.

API Description

Request URL example

In the following example, the callback URL configured by the app is https://www.example.com.
Example:

https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

Request parameters

Request packet example

{
  "CallbackCommand": "Group.CallbackBeforeCreateGroup", // Callback command
  "Operator_Account": "leckie", // Operator
  "Owner_Account": "leckie", // Group owner
  "Type": "Public", // Group type
  "Name": "MyFirstGroup", // Group name
  "CreatedGroupNum": 123, //Number of groups of the same type already created by the user
  "MemberList": [ // Initial member list
      {
          "Member_Account": "bob"
      },
      {
          "Member_Account": "peter"
      }
  ]
}

Request packet fields

Response packet examples

Allowing to create

Allow the user to create the group.

{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0 // Allow to create
}

Rejecting to create

Reject the user’s request to create the group. In this case, the group will not be created, and error code 10016 will be returned to the invoker.

{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 1 // Reject to create
}

Response packet fields

References

• Third-party callback introduction
• RESTful APIs: creating groups