更新时间: 2021-03-08
# 功能描述
聊天室 1 小时内无人说话，同时没有人加入聊天室时，融云服务端会自动把聊天室内所有成员踢出聊天室并销毁聊天室。聊天室保活功能，可以确保聊天室在此状态下不被自动销毁，只能通过调用 API 接口销毁聊天室。
如需要使用此功能，开发者可在开发者后台IM 商用版-增值服务 (opens new window)中开通，开通后可设置 5 个聊天室为保活状态，如需要多个请联系商务。
# 实现方法
# 添加保活聊天室
# 功能接口
请求地址： https://数据中心域名/chatroom/keepalive/add.json
请求方法： POST
调用频率： 无限制
签名规则： 所有请求融云服务端 API 接口的请求均需要进行规则校验，详细请参考 通用 API 接口签名规则
# 输入参数
| 参数 | 类型 | 必传 | 说明 |
|---|---|---|---|
| chatroomId | String | 是 | 聊天室 Id。 |
# 返回结果
| 返回值 | 返回类型 | 说明 |
|---|---|---|
| code | Int | 返回码，200 为正常。 |
# 示例代码
Request：
POST /chatroom/keepalive/add.json HTTP/1.1 Host: api-cn.ronghub.com App-Key: uwd1c0sxdlx2 Nonce: 14314 Timestamp: 1408710653491 Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8 Content-Type: application/x-www-form-urlencoded chatroomId=16已复制
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Response：
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 {"code":200}已复制
1
2
3
4
2
3
4
# 移除保活聊天室
# 功能接口
请求地址： https://数据中心域名/chatroom/keepalive/remove.json
请求方法： POST
调用频率： 无限制
签名规则： 所有请求融云服务端 API 接口的请求均需要进行规则校验，详细请参考 通用 API 接口签名规则
# 输入参数
| 参数 | 类型 | 必传 | 说明 |
|---|---|---|---|
| chatroomId | String | 是 | 聊天室 Id。 |
# 返回结果
| 返回值 | 返回类型 | 说明 |
|---|---|---|
| code | Int | 返回码，200 为正常。 |
# 示例代码
Request：
POST /chatroom/keepalive/remove.json HTTP/1.1 Host: api-cn.ronghub.com App-Key: uwd1c0sxdlx2 Nonce: 14314 Timestamp: 1408710653491 Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8 Content-Type: application/x-www-form-urlencoded chatroomId=16已复制
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Response：
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 {"code":200}已复制
1
2
3
4
2
3
4
# 查询保活聊天室
# 功能接口
请求地址： https://数据中心域名/chatroom/keepalive/query.json
请求方法： POST
调用频率： 无限制
签名规则： 所有请求融云服务端 API 接口的请求均需要进行规则校验，详细请参考 通用 API 接口签名规则
# 输入参数
无
# 返回结果
| 返回值 | 返回类型 | 说明 |
|---|---|---|
| code | Int | 返回码，200 为正常。 |
| chatroomIds | String[] | 保活聊天室数组。 |
# 示例代码
Request：
POST /chatroom/keepalive/query.json HTTP/1.1 Host: api-cn.ronghub.com App-Key: uwd1c0sxdlx2 Nonce: 14314 Timestamp: 1408710653491 Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8 Content-Type: application/x-www-form-urlencoded已复制
1
2
3
4
5
6
7
2
3
4
5
6
7
Response：
HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 {"code":200,"chatroomIds":["1000","1001"]}已复制
1
2
3
4
2
3
4