差别
这里会显示出您选择的修订版和当前版本之间的差别。
两侧同时换到之前的修订记录 前一修订版 后一修订版 | 前一修订版 后一修订版 两侧同时换到之后的修订记录 | ||
im:server:basics:chatroom [2020/07/31 09:32] shenchong [管理超级管理员] |
im:server:basics:chatroom [2020/08/20 04:01] huanxinfudh [获取禁言列表] |
||
---|---|---|---|
行 1054: | 行 1054: | ||
|移除禁言|/{org_name}/{app_name}/chatrooms/{chatroom_id}/mute/{member1}(,{member2},…)|从聊天室的禁言列表中移除用户| | |移除禁言|/{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 | | |usernames|要被添加禁言用户的 ID | | ||
行 1128: | 行 1078: | ||
^参数^说明^ | ^参数^说明^ | ||
|result|操作结果;true:添加成功;false:添加失败| | |result|操作结果;true:添加成功;false:添加失败| | ||
- | |expire|禁言到期时间,单位毫秒。“-1000“代表永久禁言| | + | |expire|禁言到期时间,单位毫秒| |
|user|被禁言用户的 ID | | |user|被禁言用户的 ID | | ||
行 1202: | 行 1152: | ||
=====管理超级管理员===== | =====管理超级管理员===== | ||
- | 环信提供多个管理聊天室超级管理员的接口,包括获取、添加、移除等 | + | 环信提供多个管理聊天室超级管理员的接口,包括获取、添加、移除等。超级管理员身份给予了普通用户创建聊天室的权限,普通用户默认没有权限创建聊天室。 |
^名称^请求^描述^ | ^名称^请求^描述^ | ||
|获取超级管理员列表|/{org_name}/{app_name}/chatrooms/super_admin|获取超级管理员列表| | |获取超级管理员列表|/{org_name}/{app_name}/chatrooms/super_admin|获取超级管理员列表| |