DeleteAllFriends
https://zim-api.zego.im/
By calling this API, you can delete all friends for a user in one-way or two-way mode.
Taking users A and B as examples to illustrate one-way deletion and two-way deletion:
- One-way deletion: When user A deletes user B in one-way mode, user B is no longer a friend of user A, but user A is still a friend of user B.
- Two-way deletion: When user A deletes user B in two-way mode, they are no longer friends with each other.
After successfully deleting friends for users, the clients of the relevant users will receive friend list update notifications through the following ZIM SDK callback interface:
| iOS | Android | macOS | Windows |
|---|---|---|---|
| friendListChanged | onFriendListChanged | friendListChanged | onFriendListChanged |
| Web | Mini Program | Flutter | React Native |
|---|---|---|---|
| friendListChanged | friendListChanged | onFriendListChanged | friendListChanged |
| uni-app | uni-app x | HarmonyOS |
|---|---|
| friendListChanged | friendListChanged |
'!', '#', '$', '%', '&', '(', ')', '+', '-', ':', ';', '<', '=', '.', '>', '?', '@', '[', ']', '^', '_', '{', '}', '|', '~'Request
Query Parameters
- 0：Two-way deletion.
- 1：One-way deletion.
Possible values: [DeleteAllFriends]
API prototype parameter
https://zim-api.zego.im/?Action=DeleteAllFriends
💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.
💡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature example for how to generate.
💡Public parameter. Current Unix timestamp, in seconds. Refer to Signature example for how to generate, with a maximum error of 10 minutes.
Possible values: [2.0]
Default value: 2.0
💡Public parameter. Signature version number.
💡Public parameter. Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate an API request signature.
Possible values: <= 32 characters
Delete all friends for this UserId (who has logged in to the ZIM service by calling the login method on the client, or has completed registration by calling the server-side API).
Possible values: [0, 1]
Deletion type:
Responses
- 200
- application/json