跳转至

用户白名单

现在聊天室中用户在离线 30 秒后或离线后聊天室中产生 30 条消息时会被自动踢出聊天室。将用户加入到白名单后,用户将处于被保护状态,在以上情况下将不会被自动踢出聊天室。白名单中用户在当前聊天室中发送消息的级别将高于 High Level 。聊天室销毁后,对应白名单也自动销毁。

建议使用场景:

  • 如您的应用为直播业务,建议将主播用户 ID 加入到聊天室白名单中,以避免主播离线后被自动踢出聊天室。
  • 当您通过 Server API 向聊天室中发送用来触发移动端某些系统行为的命令消息时,可将发送者 ID 加入到白名单中,以避免在高并发情况下消息丢失的情况。

提示

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

添加

方法名:/chatroom/user/whitelist/add

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

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

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

HTTP 方法:POST

表单参数

名称 类型 说明
chatroomId String 聊天室 Id。(必传)
userId String 聊天室中用户 Id,可提交多个,聊天室中白名单用户最多不超过 5 个。(必传)

返回值

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

JSON 格式:

{"code":200}

XML 格式:

<code>200</code>

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

示例

HTTP 请求:

POST /chatroom/user/whitelist/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&userId=123&userId=456

HTTP 响应:

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

{"code":200}

移除

方法名:/chatroom/user/whitelist/remove

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

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

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

HTTP 方法:POST

表单参数

名称 类型 说明
chatroomId String 聊天室 Id。(必传)
userId String 聊天室白名单中用户 Id,可提交多个,最多不超过 5 个。(必传)

返回值

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

JSON 格式:

{"code":200}

XML 格式:

<code>200</code>

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

示例

HTTP 请求:

POST /chatroom/user/whitelist/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&userId=123&userId=456

HTTP 响应:

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

{"code":200}

查询

方法名:/chatroom/user/whitelist/query

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

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

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

HTTP 方法:POST

表单参数

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

返回值

名称 类型 说明
code Int 返回码,200 为正常。
users String[] 白名单用户数组。

JSON 格式:

{
  "code":200,
  "users":["user1","user2"]
}

XML 格式:

<xml>
  <code>200</code>
  <users>
    <string>user1</string>
    <string>user2</string>
  </users>
</xml>

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

示例

HTTP 请求:

POST /chatroom/user/whitelist/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

chatroomId=16

HTTP 响应:

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

{"code":200,"users":["user1","user2"]}