跳转至

成员禁言

指定聊天室禁言

在 App 中如果不想让某一用户在聊天室中发言时,可将此用户在聊天室中禁言,被禁言用户可以接收查看聊天室中用户聊天信息,但不能发送消息。

添加

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

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

URL:http://api-cn.ronghub.com/chatroom/user/gag/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/gag/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/gag/rollback

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

URL:http://api-cn.ronghub.com/chatroom/user/gag/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/gag/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/gag/list

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

URL:http://api-cn.ronghub.com/chatroom/user/gag/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/gag/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"
  }]
}

聊天室全局禁言

如果不想让某一用户在所有聊天室中发言时,可将此用户添加到聊天室全局禁言中,被禁言用户可以接收查看聊天室中用户聊天信息,但不能发送消息。

提示

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

添加

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

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

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

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

HTTP 方法:POST

表单参数

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

返回值

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

JSON 格式:

{"code":200}

XML 格式:

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

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

示例

HTTP 请求:

POST /chatroom/user/ban/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=2582&userId=2583&minute=1

HTTP 响应:

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

{"code":200}

移除

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

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

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

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

HTTP 方法:POST

表单参数

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

返回值

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

JSON 格式:

{"code":200}

XML 格式:

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

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

示例

HTTP 请求:

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

userId=2582

HTTP 响应:

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

{"code":200}

查询

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

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

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

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

HTTP 方法:POST

表单参数

返回值

名称 类型 说明
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/ban/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,
  "users":[{
    "time":"2015-09-25 16:12:38",
    "userId":"2582"
  }]
}