Get specific group channel members
Retrieve member information for specified users in a group channel.
Request
POST: https://Base URL/v4/group-channel/member/batch/get
Rate limit: 100 per second
Signature: Required. See API request signature.
Request body
Content type: application/json
| Parameter | Type | Required | Description |
|---|---|---|---|
channelId | String | Yes | Group channel ID. |
userIds | Array | Yes | Array of user IDs to query. Maximum: 100. |
Request example
HTTP
POST /v4/group-channel/member/batch/get HTTP/1.1
Host: api.sg-light-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json
{
"channelId": "groupId1",
"userIds": [
"u01",
"u02"
]
}
Response
| Field | Type | Description |
|---|---|---|
code | Number | Return code. 0 indicates success. See Status codes. |
result | Object | Response data. |
result.members | Array | List of member objects. |
result.members[i].userId | String | Member user ID. |
result.members[i].nickname | String | Group nickname. |
result.members[i].role | String | Member role. 1: regular member. 2: admin. 3: group owner. |
result.members[i].joinedAt | String | Timestamp when the member joined the group. |
result.members[i].extra | String | Additional member information. |
Response example
HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code": 0,
"result": {
"members": [
{
"userId": "u01",
"role": 1,
"nickname": "nickname1",
"joinedAt": 12343433499942
},
{
"userId": "u02",
"nickname": "nickname2",
"joinedAt": 12343433499943,
"role": 3,
"extra": "xxxx"
}
]
}
}