Check blockships

Overview

You can call this operation to batch check the blockships of a user between up to 20 users, that is, whether the user blocks them. If you need a higher limit, contact ZEGOCLOUD technical support.

Operation prototype

• Request method: POST
• Request URL: https://zim-api.zego.im/?Action= CheckUsersIsInBlacklist
• 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 Public request parameters section of the Accessing Server APIs topic.

Sample request

• Request URL:

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

• Request body:

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

Response parameters

Sample response

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
    "Succ": [
        {
            "UserId": "user1",
            "Result": 1
        },
        {
            "UserId": "user2",
            "Result": 1
        }
    ],
    "ErrList": [
        {
            "UserId": "user3",
            "SubCode": 660000002
        },
        {
            "UserId": "user4",
            "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.