跳到主要内容

查询聊天室信息

获取聊天室基础信息，包括聊天室 ID、创建时间、人数、自动销毁类型、是否全体禁言等。

该接口替代了废弃接口获取聊天室基础信息(废弃)。

请求方法​

POST： https://数据中心域名/chatroom/get.json

频率限制： 每秒钟限 100 次

签名规则： 所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。

正文参数​

HTTP 请求正文数据格式为 application/x-www-form-urlencoded，支持以下 HTTP 表单参数：

参数类型必传说明
chatroomIdString是聊天室 ID

请求示例​

HTTP
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

返回结果​

HTTP 响应正文包含具有以下结构的 JSON 对象：

返回值返回类型说明
codeInt返回码。200：处理成功。23410：聊天室不存在。
chatroomIdString聊天室 ID。
createTimeLong聊天室创建时间。
memberCountInt聊天室当前人数。
destroyTypeInt聊天室的自动销毁类型。
  • 0：不活跃时销毁（默认）。默认情况下，所有聊天室的自动销毁方式均为不活跃时销毁，一旦不活跃长达到 60 分钟即被销毁，可通过 destroyTime 延长该时间。
  • 1：固定时间销毁。聊天室在创建 60 分钟后自动销毁，可通过 destroyTime 设置更长的存活时间。
destroyTimeInt聊天室销毁时间配置，单位为分钟。根据 destroyType 的值有不同含义：
  • 当 destroyType 为 0 (不活跃时销毁) 时，表示聊天室不活跃达到该时长后自动销毁。
  • 当 destroyType 为 1 (固定时间销毁) 时，表示聊天室从创建开始，存活该时长后自动销毁。
最小值为 60 分钟，最大值为 10080 分钟（7 天）。
banBoolean是否已开启聊天室全体禁言，默认为 false。

返回结果示例​

HTTP
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}
最后于 更新