跳转至

用户封禁

在 App 中如果想将某一用户踢出聊天室并在一段时间内不允许再进入聊天室时,可实现将用户对指定的聊天室做封禁处理,被封禁用户将被踢出聊天室,并在设定的时间内不能再进入聊天室中。

添加

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

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

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

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

HTTP 方法:POST

表单参数

名称 类型 说明
userId String 用户 Id,可同时封禁多个用户,最多不超过 20 个。(必传)
chatroomId String 聊天室 Id。(必传)
minute String 封禁时长,以分钟为单位,最大值为43200分钟。(必传)

返回值

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

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

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

示例

HTTP 请求:

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

userId=2583&userId=2582&chatroomId=16&minute=1

HTTP 响应:

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

{"code":200}

移除

方法名:/chatroom/user/block/rollback

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

URL:http://api-cn.ronghub.com/chatroom/user/block/rollback.[format]

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

HTTP 方法:POST

表单参数

名称 类型 说明
userId String 用户 Id,可同时移除多个用户,最多不超过 20 个。(必传)
chatroomId String 聊天室 Id。(必传)

返回值

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

JSON 格式:

{"code":200}

XML 格式:

<xml><code>200</code></xml>

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

示例

HTTP 请求:

POST /chatroom/user/block/rollback.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

userId=2583&userId=2582&chatroomId=16

HTTP 响应:

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

{"code":200}

查询

方法名:/chatroom/user/block/list

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

URL:http://api-cn.ronghub.com/chatroom/user/block/list.[format]

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

HTTP 方法:POST

表单参数

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

返回值

名称 类型 说明
code Int 返回码,200 为正常。
users String 被封禁用户数组。
time String 解禁时间。
userId String 被封禁用户 Id。

JSON 格式:

{
  "code":200,
  "users":[{
    "time":"2015-09-25 16:12:38",
    "userId":"2582"
  }]
}

XML 格式:

<code>200</code>
<users>
 <map>
   <entry>
     <string>time</string>
     <string>2015-09-25 16:12:38</string>
   </entry>
   <entry>
     <string>userId</string>
     <string>2582</string>
   </entry>
 </map>
</users>

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

示例

HTTP 请求:

POST /chatroom/user/block/list.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":[{
    "time":"2015-09-25 16:12:38",
    "userId":"2582"
  }]
}