Skip to main content

Overview

Queries the members on a chatroom's allowlist.

Request

Authentication: Add authentication headers to the request. See Authentication.

Method: GET

Rate limit: 100 requests/second

Endpoint: https://API domain/apigateway/chatrooms/allowmembers/query

Content-Type: application/json

Request Parameters

ParameterData TypeRequiredDescription
chat_idstringYesChatroom ID. Maximum length: 32 characters.
offsetstringNoPagination offset. Each response returns the offset for the next page. Leave empty for the initial query.
limitintNoNumber of records to return. Default: 100. Maximum: 1,000.

Request Example

GET /apigateway/chatrooms/allowmembers/query?chat_id=xxx&offset=xx&limit=100 HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json

Response Example

{
"code":0,
"msg":"sucess",
"data":{
"chat_id":"xxx",
"members":[
{
"member_id":"xxx",
"end_time":172987634564
}
],
"offset":"xxxx"
}
}