Skip to main content

Overview

My friend list, sorted alphabetically by default.

Request

Authentication: Add authentication headers to the request. See Authentication

Method: GET

Rate limit: 100 requests/second

Endpoint: https://API domain/jim/friends/list

Content-Type: application/json

Request parameters

ParameterData typeRequiredDescription
pageintNoFor pagination. Page numbering starts at 1.
sizeintNoItems per page. Default: 20. Maximum: 50.
order_tagstringNoStarting pinyin letter.

Request example

GET /jim/friends/list?size=50&page=1&order_tag=a HTTP/1.1
appkey: appkey
Authorization: xxxxxxxxxxxxxxxxxx
Content-Type: application/json

Response example

{
"code":0,
"msg":"sucess",
"data":{
"items":[
{
"user_id":"userid1",
"nickname":"user1",
"avatar":"https://file.juggle.im/abcdfafsdaf.png",
"pinyin":"u",
"friend_info":{
"is_friend":true,
"display_name":"displayname"
}
},{
"user_id":"userid2",
"nickname":"user2",
"avatar":"https://file.juggle.im/abcdfafsdaf.png",
"pinyin":"u",
"friend_info":{
"is_friend":true,
"display_name":"displayname"
}
}
]
}
}