QueryFriendList

API prototype parameter

https://zim-api.zego.im/?Action=QueryFriendList

💡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.

💡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.

Query the friend list of 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).

How many friends' information to retrieve at a time. Value range is [0, 100]. If not filled in or the value is 0 or greater than 100, the value is 100.

Pagination flag. Fill in 0 for the first time, and then fill in the Next value returned last time. When the returned Next is 0, it means the friend list retrieval is complete.

For example, if FromUserId has 250 friends, when calling this API to query:

• First call: Limit is 100, Next is empty, query friends 1 ~ 100; the Next value in the returned result is num1.
• Second call: Limit is 100, Next is num1, query friends 101 ~ 200; the Next value in the returned result is num2.
• Third call: Limit is 100, Next is num2, query friends 201 ~ 250; query is complete, the Next in the returned result is 0.