差别

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

--- im:server:basics:chatroom [2020/07/31 09:17]
shenchong [管理超级管理员]
+++ im:server:basics:chatroom [2020/08/20 04:01]
huanxinfudh [获取禁言列表]
@@ 行 1054: / 行 1054: @@
 |移除禁言|/{org_name}/{app_name}/chatrooms/{chatroom_id}/mute/{member1}(,{member2},…)|从聊天室的禁言列表中移除用户|
-====获取禁言列表====
-获取当前聊天室的禁言用户列表。
-=== HTTP Request ===
-^{{:im:server:basics:get.png?nolink&90|}}^**/{org_name}/{app_name}/chatrooms/{chatroom_id}/mute**^
-需要在请求时对应填写{chatroom_id}，需要获取禁言列表的聊天室 ID 。
-=== Request Headers ===
-^参数^说明^
-|Content-Type|application/json|
-|Authorization|Bearer ${token}|
-=== Response Body ===
-^参数^说明^
-|expire|禁言到期时间，单位毫秒。“-1000“代表永久禁言|
-|user|被禁言用户的 ID |
-=== 请求示例 ===
-<code php>
-curl -X GET HTTP://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/mute -H 'Authorization: Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'
-</code>
-=== 可能返回的结果示例 ===
-**返回值200，表示获取禁言列表成功**
-<code json>
-{
-    "action": "post",
-    "application": "527cd7e0-04b3-11e7-9f59-ef10ecd81ff0",
-    "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/1265710621211/mute",
-    "entities": [],
-    "data": [{
-        "expire": 1489158589481,
-        "user": "user1"
-    },
-    {
-        "expire": 1489158589481,
-        "user": "user2"
-    },
-    "timestamp": 1489072802179,
-    "duration": 0,
-    "organization": "easemob-demo",
-    "applicationName": "testapp"
-}
-</code>
-如果返回结果是<wrap em>429、503</wrap>或者其他<wrap em>5xx</wrap>，有可能代表该接口被限流了，请稍微暂停一下并重试。详见[[im:450errorcode:45restastrict|接口限流说明]]
-[[http://api-docs.easemob.com/|使用 Easemob REST API 在线测试]]
-----
 ====添加禁言====
@@ 行 1121: / 行 1071: @@
 ^参数^说明^
-|mute_duration|禁言的时间，单位毫秒，如果是“-1000”代表永久|
+|mute_duration|禁言的时间，单位毫秒，如果是“-1”代表永久（实际的到期时间为当前时间戳加上Long最大值）|
 |usernames|要被添加禁言用户的 ID |
@@ 行 1128: / 行 1078: @@
 ^参数^说明^
 |result|操作结果；true：添加成功；false：添加失败|
-|expire|禁言到期时间,单位毫秒。“-1000“代表永久禁言|
+|expire|禁言到期时间,单位毫秒|
 |user|被禁言用户的 ID |
@@ 行 1202: / 行 1152: @@
 =====管理超级管理员=====
-环信提供多个管理聊天室超级管理员的接口，包括获取、添加、移除等
+环信提供多个管理聊天室超级管理员的接口，包括获取、添加、移除等。超级管理员身份给予了普通用户创建聊天室的权限，普通用户默认没有权限创建聊天室。
 ^名称^请求^描述^
 |获取超级管理员列表|/{org_name}/{app_name}/chatrooms/super_admin|获取超级管理员列表|
 |添加超级管理员|/{org_name}/{app_name}/chatrooms/super_admin|添加用户至超级管理员列表|
 |移除超级管理员|/{org_name}/{app_name}/chatrooms/super_admin/{superAdmin}|从超级管理员列表列表中移除用户|
+====分页获取聊天室超级管理员列表====
+可以分页获取聊天室超级管理员列表的接口。
+=== HTTP Request ===
+^{{:im:server:basics:get.png?nolink&90|}}^**/{org_name}/{app_name}/chatrooms/super_admin**^
+=== Request Headers ===
+^参数^说明^
+|Content-Type|application/json|
+|Authorization|Bearer ${token}|
+=== Response Body ===
+^参数^说明^
+|data|聊天室超级管理员ID列表 |
+=== 请求示例 ===
+<code php>
+curl -X GET http://a1.easemob.com/easemob-demo/testapp/chatrooms/super_admin?pagenum=2&pagesize=2 -H 'Authorization: Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'
+</code>
+=== 可能返回的结果示例 ===
+**返回值200，表示获取聊天室成员成功**
+<code json>
+{
+    "action": "get",
+    "application": "9fa492a0-40b1-11e5-b1b9-a76b05da6904",
+    "params": {
+        "pagesize": [
+            "2"
+        ],
+        "pagenum": [
+            "2"
+        ]
+    },
+    "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/super_admin",
+    "entities": [],
+    "data": [
+        "hxtest1",
+        "hxtest11",
+        "hxtest10"
+    ],
+    "timestamp": 1596187292391,
+    "duration": 0,
+    "organization": "easemob-demo",
+    "applicationName": "testapp",
+    "count": 3
+}
+</code>
 如果返回结果是<wrap em>429、503</wrap>或者其他<wrap em>5xx</wrap>，有可能代表该接口被限流了，请稍微暂停一下并重试。详见[[im:450errorcode:45restastrict|接口限流说明]]
@@ 行 1212: / 行 1213: @@
 [[http://api-docs.easemob.com/|使用 Easemob REST API 在线测试]]
 ----
+==== 添加超级管理员 ====
+给用户添加聊天室超级管理员身份。
+=== HTTP Request ===
+^{{:im:server:basics:post.png?nolink&90|}}^**/{org_name}/{app_name}/chatrooms/super_admin**^
+=== Request Headers ===
+^参数^说明^
+|Content-Type|application/json|
+|Authorization|Bearer ${token}|
+=== Request Body ===
+^参数^说明^
+|superadmin|添加的用户名称|
+=== Response Body ===
+在返回值中查看data字段包含的信息
+^参数^说明^
+|result|添加结果，true表示添加成功，false表示添加失败|
+=== 请求示例 ===
+<code php>
+curl -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/super_admin'
+</code>
+=== 可能返回的结果示例 ===
+**返回值200，表示聊天室成员添加成功**
+<code json>
+{
+    "action": "post",
+    "application": "9fa492a0-40b1-11e5-b1b9-a76b05da6904",
+    "uri": "http://a1.easemob.com/easemob-demo/testapp/hxdemo2/chatrooms/super_admin",
+    "entities": [],
+    "data": {
+        "result": "success",
+        "resource": ""
+    },
+    "timestamp": 1596187658017,
+    "duration": 1,
+    "organization": "easemob-demo",
+    "applicationName": "testapp"
+}
+</code>
+**返回值404，表示添加的用户或聊天室不存在**
+<code json>
+{
+  "error": "resource_not_found",
+  "timestamp": 1542554114398,
+  "duration": 0,
+  "exception": "com.easemob.group.exception.ResourceNotFoundException",
+  "error_description": "username user10 doesn't exist!"
+}
+</code>
+**返回值401，未授权[无token、token错误、token过期]**
+<code json>
+{
+  "error": "group_authorization",
+  "timestamp": 1542554229364,
+  "duration": 0,
+  "exception": "com.easemob.group.exception.GroupAuthorizationException",
+  "error_description": "this token is bad, or has expired!"
+}
+</code>
+如果返回结果是<wrap em>429、503</wrap>或者其他<wrap em>5xx</wrap>，有可能代表该接口被限流了，请稍微暂停一下并重试。详见[[im:450errorcode:45restastrict|接口限流说明]]
+[[http://api-docs.easemob.com/|使用 Easemob REST API 在线测试]]
+----
+==== 移除超级管理员 ====
+移除超级管理员。
+=== HTTP Request ===
+^{{:im:server:basics:delete.png?nolink&90|}}^**/{org_name}/{app_name}/chatrooms/super_admin/{superAdmin}**^
+需要在请求时对应填写{superAdmin}，需要删除的 IM 用户名。
+=== Request Headers ===
+^参数^说明^
+|Content-Type|application/json|
+|Authorization|Bearer ${token}|
+=== 请求示例 ===
+<code php>
+curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/chatrooms/super_admin/user1'
+</code>
+=== 可能返回的结果示例 ===
+**返回值200，表示聊天室成员删除成功**
+<code json>
+{
+    "action": "delete",
+    "application": "9fa492a0-40b1-11e5-b1b9-a76b05da6904",
+    "uri": "http://a1.easemob.com/easemob-demo/testapp/chatrooms/super_admin/hxtest10",
+    "entities": [],
+    "data": {
+        "newSuperAdmin": "user1",
+        "resource": ""
+    },
+    "timestamp": 1596187855832,
+    "duration": 0,
+    "organization": "easemob-demo",
+    "applicationName": "testapp"
+}
+</code>
+**返回值401，未授权[无token、token错误、token过期]**
+<code json>
+{
+  "error": "group_authorization",
+  "timestamp": 1542555910183,
+  "duration": 0,
+  "exception": "com.easemob.group.exception.GroupAuthorizationException",
+  "error_description": "this token is bad, or has expired!"
+}
+</code>
+如果返回结果是<wrap em>429、503</wrap>或者其他<wrap em>5xx</wrap>，有可能代表该接口被限流了，请稍微暂停一下并重试。详见[[im:450errorcode:45restastrict|接口限流说明]]
+[[http://api-docs.easemob.com/|使用 Easemob REST API 在线测试]]
+----
 <WRAP group>