差别

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

--- im:server:basics:group [2019/12/20 10:40]
huanxinfudh [群组角色]
+++ im:server:basics:group [2020/02/05 07:45]
huanxinfudh [群组成员全部解除禁言]
@@ 行 1685: / 行 1685: @@
 ^{{:im:server:basics:post.png?nolink&90|}}^**/{org_name}/{app_name}/chatgroups/{group_id}/mute**^
-需要在请求时对应填写{group_id}，需要移除黑名单的群组 ID ，以及需{username}，要移除的 IM 用户名。
+需要在请求时对应填写{group_id}，需要添加禁言的群组 ID ，以及需{username}，要添加禁言的 IM 用户名。
 === Request Headers ===
@@ 行 1773: / 行 1773: @@
 [[http://api-docs.easemob.com/|使用 Easemob REST API 在线测试]]
+----
+====群组成员全部禁言====
+将一个群组内所有群组成员禁言，但不包含群主以及群组管理员。群组成员被禁言后，将无法在群中发送消息。
+=== HTTP Request ===
+^{{:im:server:basics:post.png?nolink&90|}}^**/{org_name}/{app_name}/chatgroups/{group_id}/mute**^
+需要在请求时对应填写{group_id}，需要禁言的群组 ID。
+=== Request Headers ===
+^参数^说明^
+|Content-Type|application/json|
+|Authorization|Bearer ${token}|
+=== Request Body ===
+^参数^说明^
+|mute_duration|禁言的时间，单位毫秒，如果是“-1000”代表永久|
+|role|要被添加禁言的角色是群组成员 |
+=== Response Body ===
+^参数^说明^
+|result|操作结果；true：添加成功；false：添加失败|
+|expire|禁言到期时间|
+|user|被禁言用户的 ID |
+=== 请求示例 ===
+<code php>
+curl -X POST HTTP://a1.easemob.com/easemob-demo/testuser/chatgroups/126677237549236788/mute -d '{"mute_duration":86400000,"role":"member"}' -H 'Authorization: Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'
+</code>
+=== 可能返回的结果示例 ===
+**返回值200，添加禁言成功**
+<code json>
+{
+  "action" : "post",
+  "application" : "4d7e4ba0-dc4a-11e3-90d5-e1ffbaacdaf5",
+  "uri" : "http://a1.easemob.com/easemob-demo/testuser/chatgroups/126677237549236788/mute",
+  "entities" : [ ],
+  "data" : [ {
+    "result" : true,
+    "expire" : 1580888150285,
+    "user" : "chenchaobing"
+  }, {
+    "result" : true,
+    "expire" : 1580888150285,
+    "user" : "u1"
+  }, {
+    "result" : true,
+    "expire" : 1580888150285,
+    "user" : "ccb2008"
+  } ],
+  "timestamp" : 1580887550311,
+  "duration" : 0,
+  "organization" : "easemob-demo",
+  "applicationName" : "testuser"
+}
+</code>
+如果返回结果是<wrap em>429、503</wrap>或者其他<wrap em>5xx</wrap>，有可能代表该接口被限流了，请稍微暂停一下并重试。详见[[im:450errorcode:45restastrict|接口限流说明]]
+----
+====群组成员全部解除禁言===
+将一个群组内所有群组成员解除禁言。
+=== HTTP Request ===
+^{{:im:server:basics:delete.png?nolink&90|}}^**/{org_name}/{app_name}/chatgroups/{group_id}/mute?role=member**^
+需要在请求时对应填写{group_id}，需要解除禁言的群组 ID。
+=== Request Headers ===
+^参数^说明^
+|Content-Type|application/json|
+|Authorization|Bearer ${token}|
+=== Response Body ===
+^参数^说明^
+|result|操作结果；true：添加成功；false：添加失败|
+|user|被解除禁言用户的 ID |
+=== 请求示例 ===
+<code php>
+curl -X DELETE HTTP://a1.easemob.com/easemob-demo/testuser/chatgroups/126677237549236788/mute?role=member -H 'Authorization: Bearer YWMtG4T5wkOTEeST5V-9lp7f-wAAAUnafsqrQFnCU4gI0-rQImw4523fWqIasd1'
+</code>
+=== 可能返回的结果示例 ===
+**返回值200，解除禁言成功**
+<code json>
+{
+  "action" : "delete",
+  "application" : "4d7e4ba0-dc4a-11e3-90d5-e1ffbaacdaf5",
+  "params" : {
+    "role" : [ "member" ]
+  },
+  "uri" : "http://a1.easemob.com/easemob-demo/testuser/chatgroups/126677237549236788/mute",
+  "entities" : [ ],
+  "data" : [ {
+    "result" : true,
+    "user" : "chenchaobing"
+  }, {
+    "result" : true,
+    "user" : "u1"
+  }, {
+    "result" : true,
+    "user" : "ccb2008"
+  } ],
+  "timestamp" : 1580888462028,
+  "duration" : 0,
+  "organization" : "easemob-demo",
+  "applicationName" : "testuser"
+}
+</code>
+如果返回结果是<wrap em>429、503</wrap>或者其他<wrap em>5xx</wrap>，有可能代表该接口被限流了，请稍微暂停一下并重试。详见[[im:450errorcode:45restastrict|接口限流说明]]
 ----