API Overview
Message Callbacks
Status Codes
Overview
Searches my friends.
Request
Authentication: Add authentication headers to the request. See Authentication
Method:
POST
Rate limit:
100 requests/second
Endpoint: https://API domain/jim/friends/search
Content-Type:
application/json
Request parameters
| Parameter | Data type | Required | Description | |
|---|---|---|---|---|
| key | string | Yes | Keyword. | |
| offset | string | No | Pagination offset. | |
| limit | number | No | Items per page. Default: 100. |
Request example
POST /jim/friends/search HTTP/1.1
appkey: appkey
Authorization: xxxxxxxxxxxxxxxxxx
Content-Type: application/json
{
"key":"user"
}
Response example
{
"code":0,
"msg":"sucess",
"data":{
"items":[
{
"user_id":"userid1",
"nickname":"user1",
"avatar":"https://file.juggle.im/abcdfafsdaf.png",
"user_type":0
},{
"user_id":"userid2",
"nickname":"user2",
"avatar":"https://file.juggle.im/abcdfafsdaf.png",
"user_type":0
}
]
}
}