跳转至

保活服务

当聊天室中 1 小时无人说话,同时没有人加入聊天室时,融云服务端会自动把聊天室内所有成员踢出聊天室并销毁聊天室。如果不希望聊天室自动销毁,可以使用此服务将指定聊天室进行保活处理,保活的聊天室不会被自动销毁,需要调用 API 接口销毁聊天室。

提示

此服务在开通 IM 商用版的情况下,可申请开通,详细请联系商务,电话:13161856839。

添加

方法名:/chatroom/keepalive/add

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/chatroom/keepalive/add.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
chatroomId String 聊天室 Id。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<code>200</code>

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

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

HTTP 响应:

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

{"code":200}

移除

方法名:/chatroom/keepalive/remove

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/chatroom/keepalive/remove.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

名称 类型 说明
chatroomId String 聊天室 Id。(必传)

返回值

名称 类型 说明
code Int 返回码,200 为正常。

JSON 格式:

{"code":200}

XML 格式:

<code>200</code>

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

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

HTTP 响应:

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

{"code":200}

查询

方法名:/chatroom/keepalive/query

签名方法:请参考 通用 API 接口签名规则

URL:http://api-cn.ronghub.com/chatroom/keepalive/query.[format]

[format] 表示返回格式,可以为 jsonxml,注意不要带 [ ]。

HTTP 方法:POST

表单参数

返回值

名称 类型 说明
code Int 返回码,200 为正常。
chatroomIds String[] 保活聊天室数组。

JSON 格式:

{
  "code":200,
  "chatroomIds":["1000","1001"]
}

XML 格式:

<xml>
  <code>200</code>
  <chatroomIds>
    <string>1000</string>
    <string>1001</string>
  </users>
</xml>

返回值请参考 API 方法返回值说明

示例

HTTP 请求:

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

HTTP 响应:

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

{"code":200,"chatroomIds":["1000","1001"]}