跳到主要内容

聊天室保活

聊天室保活功能可防止聊天室因长时间无活动而被系统自动销毁。默认情况下，当聊天室在 1 小时内同时满足以下两个条件时，即时通讯（IM）服务端会自动销毁该聊天室：

  1. 无成员发送消息
  2. 无新成员加入

启用保活功能后，即使满足上述条件，聊天室也不会被自动销毁，您必须调用 API 接口手动销毁。

开通服务​

使用聊天室保活功能前，请在融云控制台，通过应用配置 > IM 服务 > IM 服务管理 > 普通服务，开通聊天室保活功能。 img_1.png

提示

每个 App Key 最多可设置 5 个保活聊天室。如需更多配额，请联系商务申请。

如未开通服务，Server API 将返回 1009 错误。注意，在未开通服务时，如果连续请求导致 API 请求频率超过限制，Server API 会返回 HTTP 429 Too Many Requests 错误（错误码为 1008）。

请求方法​

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

频率限制： 每秒钟限 100 次

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

正文参数​

请求需使用 application/x-www-form-urlencoded 格式，参数如下：

参数类型必传说明
chatroomIdString是需要保活的聊天室 ID

请求示例​

HTTP
POST /chatroom/keepalive/add.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2  // 从控制台获取的有效 App Key
Nonce: 14314           // 随机数
Timestamp: 1408710653491  
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8  // 按签名规范生成
Content-Type: application/x-www-form-urlencoded

chatroomId=16  // 需要保活的聊天室 ID

返回结果​

HTTP 响应正文为 JSON 格式，包含以下字段：

返回值返回类型说明
codeNumber返回码，200 表示操作成功。

返回结果示例​

HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":200}
最后于 更新