API Overview
Message Callbacks
Status Codes
Overview
Searches group members.
Request
Authentication: Add authentication headers to the request. See Authentication
Method:
POST
Rate limit:
100 requests/second
Endpoint: https://API domain/jim/groups/members/search
Content-Type:
application/json
Request parameters
| Parameter | Data type | Required | Description | |
|---|---|---|---|---|
| group_id | string | Yes | Group ID. | |
| key | string | Yes | Keyword. | |
| offset | string | No | Pagination offset. | |
| limit | number | No | Items per page. Default: 100. |
Request example
POST /jim/groups/members/search HTTP/1.1
appkey: appkey
Authorization: xxxxxxxxxxxxxxxxxx
Content-Type: application/json
{
"group_id":"groupid1",
"key":"user"
}
Response example
{
"code":0,
"msg":"sucess",
"data":{
"items":[
{
"user_id":"userid1",
"nickname":"xxx",
"avatar":"xxxxxxx",
"member_type":0
}
],
"offset":"xxxx"
}
}
Response codes
| Response codes | Description |
|---|