Skip to main content

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

ParameterTypeRequiredDescription
channelIdStringYesGroup channel ID.
userIdsArrayYesArray 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

FieldTypeDescription
codeNumberReturn code. 0 indicates success. See Status codes.
resultObjectResponse data.
result.membersArrayList of member objects.
result.members[i].userIdStringMember user ID.
result.members[i].nicknameStringGroup nickname.
result.members[i].roleStringMember role. 1: regular member. 2: admin. 3: group owner.
result.members[i].joinedAtStringTimestamp when the member joined the group.
result.members[i].extraStringAdditional 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"
}
]
}
}