公告：融云新文档中心已上线，欢迎到新文档中心阅读 IM 服务端文档。
查询聊天室信息
更新时间:2024-01-02
PDF
获取聊天室基础信息，包括聊天室 ID、创建时间、人数、自动销毁类型、是否全体禁言等。
该接口替代了废弃接口获取聊天室基础信息(废弃)。
请求方法
POST： https://数据中心域名/chatroom/get.json
频率限制： 每秒钟限 100 次
签名规则： 所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded，支持以下 HTTP 表单参数：
| 参数 | 类型 | 必传 | 说明 |
|---|---|---|---|
| chatroomId | String | 是 | 聊天室 ID |
请求示例
POST /chatroom/get.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX(最大长度36)
chatroomId=gid1
已复制
1
2
3
4
5
6
7
8
9
10
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象：
| 返回值 | 返回类型 | 说明 |
|---|---|---|
| code | Int | 返回码。200 ：处理成功。23410:聊天室不存在 |
| chatroomId | String | 聊天室 ID |
| createTime | long | 聊天室创建时间 |
| memberCount | int | 聊天室当前人数 |
| destroyType | int | 指定聊天室的销毁方式。0：默认值，表示不活跃时销毁。默认情况下，所有聊天室的自动销毁方式均为不活跃时销毁，一旦不活跃长达到 60 分钟即被销毁，可通过 destroyTime 延长该时间。1：固定时间销毁，设置为该类型后，聊天室默认在创建 60 分钟后自动销毁，可通过 destroyTime 设置更长的存活时间。 |
| destroyTime | int | 设置聊天室销毁等待时间。在 destroyType=0 时，表示聊天室应在不活跃达到该时长时自动销毁。在 destroyType=1 时，表示聊天室应在创建以后存活时间达到该时长后自动销毁。单位为分钟，最小值 60 分钟，最大 10080 分钟（7 天）。 |
| ban | boolean | 是否已开启聊天室全体禁言，默认 false。 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: XXXXXXXXXXXXXXXXXXXXXXXXXXXX
{"code":200,"chatroomId":"chatroom001","createTime":1694777649942,"memberCount":0,"destroyType":1,"destroyTime":120,"ban":true}
已复制
1
2
3
4
5
131 6185 6839