Overview
Queries basic chatroom information, including its name, attributes, member count, and details for a subset of its members.
Request
Authentication: Add authentication headers to the request. See Authentication.
Method:
GET
Rate limit:
100 requests/second
Endpoint: https://API domain/apigateway/chatrooms/info
Content-Type:
application/json
Request Parameters
| Parameter | Data Type | Required | Description | |
|---|---|---|---|---|
| chat_id | string | Yes | Chatroom ID. Maximum length: 32 characters. | |
| order | int | No | Member sort order. 0: descending; 1: ascending. | |
| count | int | No | Number of chatroom members to return. Default: 100. |
Request Example
GET /apigateway/chatrooms/info?chat_id=xxx&order=0&count=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",
"chat_name":"xxx",
"is_mute":false,
"member_count":10000,
"members":[
{
"member_id":"xxx",
"member_name":"xxx",
"added_time":172987634564
}
],
"atts":[
{
"key":"k1",
"value":"v1",
"att_time":172345678345,
"user_id":"userid1"
}
]
}
}