Skip to main content

Overview

Queries a user's friend list.

Request

Authentication: Add authentication headers to the request. See Authentication.

Method: GET

Rate limit: 100 requests/second

Endpoint: https://API domain/apigateway/friends/query

Content-Type: application/json

Request Parameters

ParameterData TypeRequiredDescription
user_idstringYesUser ID. Maximum length: 32 characters.
orderintNoFriend sort order. 0: descending; 1: ascending.
limitintNoNumber of friends to return. Default: 100.
offsetstringNoPagination offset.

Request Example

GET /apigateway/friends/query?user_id=userid1&limit=100 HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json

Response Example

{
"code":0,
"msg":"sucess",
"data":{
"items":[
{
"friend_id":"userid2",
"display_name":"xxx"
}
],
"offset":"xxxx"
}
}