Block users

Overview

You can call this operation to batch block up to 20 users for a user.

If you need a higher limit (1,000 at maximum), contact ZEGOCLOUD technical support.

After users are blocked, the client of the user receives the notification in the following ZIM SDK callbacks.

Request method and endpoint

• Request method: POST
• Request URL: https://zim-api.zego.im/?Action=AddUsersToBlacklist
• Protocol: HTTPS
• QPS limit: 20 calls per second

Request parameters

The following table describes only the operation-specific request parameters and some common request parameters. For the complete list of common request parameters, see the Common request parameters section of the Accessing Server APIs topic.

Sample request

• Request URL:

  https://zim-api.zego.im/?Action=AddUsersToBlacklist
  &<Common request parameters>

  https://zim-api.zego.im/?Action=AddUsersToBlacklist
  &<Common request parameters>

• Request body:

  {
      "FromUserId": "zego_user",
      "UserIds": [
          "user1",
          "user2",
          "user3",
          "user4"
      ]
  }

  {
      "FromUserId": "zego_user",
      "UserIds": [
          "user1",
          "user2",
          "user3",
          "user4"
      ]
  }

Response parameters

Sample response

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
    "ErrList": [
        {
            "UserId": "user1",
            "SubCode": 660000002
        }
    ]
}

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
    "ErrList": [
        {
            "UserId": "user1",
            "SubCode": 660000002
        }
    ]
}

Return codes

The following table describes only the return codes related to the business logic of the operation. For the complete list of return codes, see Return codes.