List group channel members

Retrieve a paginated list of members in a group channel. You can filter by member role and control sort order.

Request

POST: https://[Base URL](/platform-chat-api/base-url)/v4/group-channel/member/list

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.
memberRole	Number	No	Member role filter. 0: All members (default). 1: Regular members. 2: Admins. 3: Group owner.
pageToken	String	No	Pagination token returned from the previous request. Omit for the first request.
pageSize	Number	No	Number of results per page. Default: 50. Maximum: 100.
order	Number	No	Sort order by join time. 0: Ascending. 1: Descending (default).

Request example

HTTP

POST /v4/group-channel/member/list HTTP/1.1
Host: api.sg-light-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json

{
    "channelId": "groupId1",
    "memberRole": 0,
    "pageToken": "XXXXX",
    "pageSize": 50,
    "order": 1
}

Response

Field	Type	Description
code	Number	Return code. 0 indicates success. See Status codes.
totalCount	Number	Total number of group members.
pageToken	String	Pagination token for the next page. Only present if there are more results.
members	Array	List of member objects.
members[i].userId	String	Member's user ID.
members[i].nickname	String	Member's group nickname.
members[i].role	Number	Member role. 1: Regular member. 2: Admin. 3: Group owner.
members[i].joinedAt	String	Timestamp when the member joined the group.
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": {
        "totalCount": 40,
        "pageToken": "XXXXX",
        "members": [
            {
                "userId": "u01",
                "role": 1,
                "nickname": "nickname1",
                "joinedAt": 12343433499942
            },
            {
                "userId": "u02",
                "nickname": "nickname2",
                "joinedAt": 12343433499943,
                "role": 3,
                "extra": "xxxx"
            }
        ]
    }
}