Batch add friends

Overview

You can call this operation to batch add up to 20 friends for a user without their consent. If you need a higher limit (50 at maximum), contact ZEGOCLOUD technical support.

Each user can have a maximum of 3000 friends.

After friends are added, the client of the user receives the notification in the following ZIM SDK callbacks.

Operation prototype

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

• Request URL:

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

• Request body:

  {
      "FromUserId": "zego_user",
      "FriendInfos": [
          {
              "UserId": "usera1",
              "Wording": "Wording1",
              "FriendAlias": "alias1",
              "Attributes": [
                  {
                      "Key": "k1",
                      "Value": "Value"
                  },
                  {
                      "key": "k2",
                      "Value": "Value1"
                  }
              ]
          },
          {
              "UserId": "usera2",
              "Wording": "Wording2",
              "FriendAlias": "alias2",
              "Attributes": [
                  {
                      "key": "k3",
                      "Value": "Value"
                  },
                  {
                      "key": "k0",
                      "Value": "Value1"
                  }
              ]
          }
      ]
  }

Response parameters

Sample response

{
    "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.