差别
这里会显示出您选择的修订版和当前版本之间的差别。
两侧同时换到之前的修订记录 前一修订版 后一修订版 | 前一修订版 后一修订版 两侧同时换到之后的修订记录 | ||
im:server:basics:chatroom [2020/07/31 09:16] shenchong [移除禁言] |
im:server:basics:chatroom [2020/07/31 09:45] shenchong [管理超级管理员] |
||
---|---|---|---|
行 1202: | 行 1202: | ||
=====管理超级管理员===== | =====管理超级管理员===== | ||
- | 环信提供多个管理聊天室超级管理员的接口,包括获取、添加、移除等 | + | 环信提供多个管理聊天室超级管理员的接口,包括获取、添加、移除等。超级管理员身份给予了普通用户创建聊天室的权限,普通用户默认没有权限创建聊天室。 |
^名称^请求^描述^ | ^名称^请求^描述^ | ||
|获取超级管理员列表|/{org_name}/{app_name}/chatrooms/super_admin|获取超级管理员列表| | |获取超级管理员列表|/{org_name}/{app_name}/chatrooms/super_admin|获取超级管理员列表| | ||
|添加超级管理员|/{org_name}/{app_name}/chatrooms/super_admin|添加用户至超级管理员列表| | |添加超级管理员|/{org_name}/{app_name}/chatrooms/super_admin|添加用户至超级管理员列表| | ||
|移除超级管理员|/{org_name}/{app_name}/chatrooms/super_admin/{superAdmin}|从超级管理员列表列表中移除用户| | |移除超级管理员|/{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|接口限流说明]] | ||
+ | |||
+ | [[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> | <WRAP group> |