Batch delete friends

Overview

You can call this operation to batch delete up to 20 friends for a user in a one-way or two-way manner. If you need a higher limit (50 at maximum), contact ZEGOCLOUD technical support.

In this example, one-way deletion and two-way deletion are explained.

• One-way deletion: If user A deletes user B in a one-way manner, user B is no longer a friend of user A, but not vice versa.
• Two-way deletion: If user A deletes user B in a two-way manner, they are no longer friends with each other.

After friends are deleted, the client of the user receives the friend list update notification in the following ZIM SDK callbacks.

Operation prototype

• Request method: POST
• Request URL: https://zim-api.zego.im/?Action=DeleteFriends
• 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=DeleteFriends
  &<Common request parameters>

• Request body:

  {
      "FromUserId": "zego_user",
      "UserIds": [
          "user_id1",
          "user_id2"
      ],
      "DeleteType": 1
  }

Response parameters

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782",
    "ErrorList": [
        {
            "UserId": "usera2",
            "SubCode": 660800022
        }
    ]
}

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.