差别

这里会显示出您选择的修订版和当前版本之间的差别。

到此差别页面的链接

两侧同时换到之前的修订记录 前一修订版
后一修订版
前一修订版
im:server:basics:chatroom [2020/07/31 09:45]
shenchong [管理超级管理员]
im:server:basics:chatroom [2020/10/13 03:34] (当前版本)
huanxinfudh [聊天室角色]
行 27: 行 27:
   * 聊天室创建者拥有聊天室所有权限;   * 聊天室创建者拥有聊天室所有权限;
   * 聊天室管理员拥有添加/​移除黑名单、添加/​移除禁言等权限。   * 聊天室管理员拥有添加/​移除黑名单、添加/​移除禁言等权限。
 +  * 创建者+管理员 一共100个,即管理员最多可添加99个
  
 ---- ----
行 1054: 行 1055:
 |移除禁言|/​{org_name}/​{app_name}/​chatrooms/​{chatroom_id}/​mute/​{member1}(,​{member2},​…)|从聊天室的禁言列表中移除用户| |移除禁言|/​{org_name}/​{app_name}/​chatrooms/​{chatroom_id}/​mute/​{member1}(,​{member2},​…)|从聊天室的禁言列表中移除用户|
  
-====获取禁言列表==== + 
-获取当前聊天室的禁言用户列表+====添加禁言==== 
 +将一个用户禁言用户被禁言后,将无法在聊天室中发送消息
 === HTTP Request === === HTTP Request ===
  
-^{{:​im:​server:​basics:​get.png?​nolink&​90|}}^**/​{org_name}/​{app_name}/​chatrooms/​{chatroom_id}/​mute**^ +^{{:​im:​server:​basics:​post.png?​nolink&​90|}}^** /​{org_name}/​{app_name}/​chatrooms/​{chatroom_id}/​mute**^ 
-需要在请求时对应填写{chatroom_id},需要获取禁言列表的聊天室 ID 。+需要在请求时对应填写{chatroom_id},需要添加禁言的聊天室 ID 。
  
 === Request Headers === === Request Headers ===
行 1066: 行 1068:
 |Content-Type|application/​json| |Content-Type|application/​json|
 |Authorization|Bearer ${token}| |Authorization|Bearer ${token}|
 +
 +=== Request Body ===
 +
 +^参数^说明^
 +|mute_duration|禁言的时间,单位毫秒,如果是“-1”代表永久(实际的到期时间为当前时间戳加上Long最大值)|
 +|usernames|要被添加禁言用户的 ID |
  
 === Response Body === === Response Body ===
  
 ^参数^说明^ ^参数^说明^
-|expire|禁言到期时间单位毫秒。“-1000“代表永久禁言|+|result|操作结果;true:添加成功;false:添加失败| 
 +|expire|禁言到期时间,单位毫秒|
 |user|被禁言用户的 ID | |user|被禁言用户的 ID |
  
 === 请求示例 === === 请求示例 ===
 <code php> <code php>
-curl -X GET HTTP://​a1.easemob.com/​easemob-demo/​testapp/​chatrooms/​1265710621211/​mute -H '​Authorization:​ Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'​+curl -X POST HTTP://​a1.easemob.com/​easemob-demo/​testapp/​chatrooms/​1265710621211/​mute ​-d '​{"​usernames":​["​user1"​],​ "​mute_duration":​86400000}' ​-H '​Authorization:​ Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'​
 </​code>​ </​code>​
 === 可能返回的结果示例 === === 可能返回的结果示例 ===
-**返回值200,表示获取禁言列表成功**+**返回值200,表示添加禁言成功**
 <code json> <code json>
 { {
行 1086: 行 1095:
     "​entities":​ [],     "​entities":​ [],
     "​data":​ [{     "​data":​ [{
 +        "​result":​ true,
         "​expire":​ 1489158589481,​         "​expire":​ 1489158589481,​
         "​user":​ "​user1"​         "​user":​ "​user1"​
-    }+    }]
-    { +    "​timestamp": ​1489072189508,
-        "​expire":​ 1489158589481,​ +
-        "​user":​ "​user2"​ +
-    }+
-    "​timestamp": ​1489072802179,+
     "​duration":​ 0,     "​duration":​ 0,
     "​organization":​ "​easemob-demo",​     "​organization":​ "​easemob-demo",​
行 1105: 行 1111:
 ---- ----
  
-====添加禁言==== +====移除禁言==== 
-一个用户禁言。用户被禁言后,将无法在聊天室中发送消息。+将用户禁言列表中移除移除后,用户可以正常在聊天室中发送消息。
 === HTTP Request === === HTTP Request ===
  
-^{{:​im:​server:​basics:​post.png?​nolink&​90|}}^** /​{org_name}/​{app_name}/​chatrooms/​{chatroom_id}/​mute**^ +^{{:​im:​server:​basics:​delete.png?​nolink&​90|}}^**/​{org_name}/​{app_name}/​chatrooms/​{chatroom_id}/​mute/​{member1}(,​{member2},​…)**^ 
-需要在请求时对应填写{chatroom_id},需要添加禁言的聊天室 ID 。+需要在请求时对应填写{chatroom_id},需要移除禁言的聊天室 ID ,以及{member1}(,​{member2},​…,需要移除禁言的用户名
  
 === Request Headers === === Request Headers ===
行 1117: 行 1123:
 |Content-Type|application/​json| |Content-Type|application/​json|
 |Authorization|Bearer ${token}| |Authorization|Bearer ${token}|
- 
-=== Request Body === 
- 
-^参数^说明^ 
-|mute_duration|禁言的时间,单位毫秒,如果是“-1000”代表永久| 
-|usernames|要被添加禁言用户的 ID | 
- 
-=== Response Body === 
- 
-^参数^说明^ 
-|result|操作结果;true:添加成功;false:添加失败| 
-|expire|禁言到期时间,​单位毫秒。“-1000“代表永久禁言| 
-|user|被禁言用户的 ID | 
  
 === 请求示例 === === 请求示例 ===
 <code php> <code php>
-curl -X POST HTTP://​a1.easemob.com/​easemob-demo/​testapp/​chatrooms/​1265710621211/​mute ​-d '​{"​usernames":​["​user1"], "​mute_duration":​86400000}' ​-H '​Authorization:​ Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'​+curl -X DELETE ​HTTP://​a1.easemob.com/​easemob-demo/​testapp/​chatrooms/​1265710621211/​mute/user1  -H '​Authorization:​ Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'​
 </​code>​ </​code>​
 === 可能返回的结果示例 === === 可能返回的结果示例 ===
-**返回值200,表示添加禁言成功**+**返回值200,表示移除禁言成功**
 <code json> <code json>
 { {
-    "​action":​ "post",+    "​action":​ "delete",
     "​application":​ "​527cd7e0-04b3-11e7-9f59-ef10ecd81ff0",​     "​application":​ "​527cd7e0-04b3-11e7-9f59-ef10ecd81ff0",​
-    "​uri":​ "​http://​a1.easemob.com/​easemob-demo/​testapp/​chatrooms/​1265710621211/​mute",​+    "​uri":​ "​http://​a1.easemob.com/​easemob-demo/​testapp/​chatrooms/​1265710621211/​mute/user1",
     "​entities":​ [],     "​entities":​ [],
     "​data":​ [{     "​data":​ [{
         "​result":​ true,         "​result":​ true,
-        "​expire":​ 1489158589481,​ 
         "​user":​ "​user1"​         "​user":​ "​user1"​
     }],     }],
-    "​timestamp": ​1489072189508,+    "​timestamp": ​1489072695859,
     "​duration":​ 0,     "​duration":​ 0,
     "​organization":​ "​easemob-demo",​     "​organization":​ "​easemob-demo",​
行 1160: 行 1152:
 ---- ----
  
-====移除禁言==== +====获取禁言列表==== 
-将用户从禁言列表中移除。移除后,用户可以正常在聊天室中发送消息+获取当前聊天室的禁言用户列表
 === HTTP Request === === HTTP Request ===
  
-^{{:​im:​server:​basics:​delete.png?​nolink&​90|}}^**/​{org_name}/​{app_name}/​chatrooms/​{chatroom_id}/​mute/​{member1}(,​{member2},​…)**^ +^{{:​im:​server:​basics:​get.png?​nolink&​90|}}^**/​{org_name}/​{app_name}/​chatrooms/​{chatroom_id}/​mute**^ 
-需要在请求时对应填写{chatroom_id},需要移除禁言的聊天室 ID ,以及{member1}(,​{member2},​…,需要移除禁言的用户名+需要在请求时对应填写{chatroom_id},需要获取禁言列表的聊天室 ID 。
  
 === Request Headers === === Request Headers ===
行 1172: 行 1164:
 |Content-Type|application/​json| |Content-Type|application/​json|
 |Authorization|Bearer ${token}| |Authorization|Bearer ${token}|
 +
 +=== Response Body ===
 +
 +^参数^说明^
 +|expire|禁言到期时间,单位毫秒|
 +|user|被禁言用户的 ID |
  
 === 请求示例 === === 请求示例 ===
 <code php> <code php>
-curl -X DELETE ​HTTP://​a1.easemob.com/​easemob-demo/​testapp/​chatrooms/​1265710621211/​mute/​user1  ​-H '​Authorization:​ Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'​+curl -X GET HTTP://​a1.easemob.com/​easemob-demo/​testapp/​chatrooms/​1265710621211/​mute -H '​Authorization:​ Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'​
 </​code>​ </​code>​
 === 可能返回的结果示例 === === 可能返回的结果示例 ===
-**返回值200,表示移除禁言成功**+**返回值200,表示获取禁言列表成功**
 <code json> <code json>
 { {
-    "​action":​ "delete",+    "​action":​ "post",
     "​application":​ "​527cd7e0-04b3-11e7-9f59-ef10ecd81ff0",​     "​application":​ "​527cd7e0-04b3-11e7-9f59-ef10ecd81ff0",​
-    "​uri":​ "​http://​a1.easemob.com/​easemob-demo/​testapp/​chatrooms/​1265710621211/​mute/user1",+    "​uri":​ "​http://​a1.easemob.com/​easemob-demo/​testapp/​chatrooms/​1265710621211/​mute",​
     "​entities":​ [],     "​entities":​ [],
     "​data":​ [{     "​data":​ [{
-        "result": ​true,+        "expire": ​1489158589481,
         "​user":​ "​user1"​         "​user":​ "​user1"​
-    }]+    }
-    "​timestamp": ​1489072695859,+    { 
 +        "​expire":​ 1489158589481,​ 
 +        "​user":​ "​user2"​ 
 +    }
 +    "​timestamp": ​1489072802179,
     "​duration":​ 0,     "​duration":​ 0,
     "​organization":​ "​easemob-demo",​     "​organization":​ "​easemob-demo",​
行 1200: 行 1202:
 [[http://​api-docs.easemob.com/​|使用 Easemob REST API 在线测试]] [[http://​api-docs.easemob.com/​|使用 Easemob REST API 在线测试]]
 ---- ----
- 
 =====管理超级管理员===== =====管理超级管理员=====
 环信提供多个管理聊天室超级管理员的接口,包括获取、添加、移除等。超级管理员身份给予了普通用户创建聊天室的权限,普通用户默认没有权限创建聊天室。 环信提供多个管理聊天室超级管理员的接口,包括获取、添加、移除等。超级管理员身份给予了普通用户创建聊天室的权限,普通用户默认没有权限创建聊天室。