差别
这里会显示出您选择的修订版和当前版本之间的差别。
两侧同时换到之前的修订记录 前一修订版 | |||
im:server:basics:live_draft [2018/11/22 10:56] jk |
im:server:basics:live_draft [2018/11/22 11:14] (当前版本) jk |
||
---|---|---|---|
行 1101: | 行 1101: | ||
[[http://api-docs.easemob.com/|使用 Easemob REST API 在线测试]] | [[http://api-docs.easemob.com/|使用 Easemob REST API 在线测试]] | ||
---- | ---- | ||
+ | |||
+ | ===== 主播管理 ===== | ||
+ | ''待补充'' | ||
+ | ^名称^请求^描述^ | ||
+ | |新建主播|/{org_name}/{app_name}/chatrooms/super_admin|给一个普通IM用户赋予主播权限,只有拥有主播权限的用户| | ||
+ | |分页获取appKey下的主播列表| /{org_name}/{app_name}/liverooms/anchors|''待补充''| | ||
+ | |移除主播角色|/{org_name}/{app_name}/liverooms/anchors/${username}|移除用户的主播角色| | ||
+ | |主播关联直播聊天室|/{org_name}/{app_name}/liverooms/anchors/${username}/join/{liveroomid}|关联后,主播变成该直播聊天室的候选主播| | ||
+ | |主播取消关联直播聊天室|/{org_name}/{app_name}/liverooms/anchors/${username}/release/{liveroomid}|''待补充''| | ||
+ | |获取主播关联的直播聊天室列表| /{org_name}/{app_name}/liverooms/anchors/${username}/joined_liveroom_list|''待补充''| | ||
+ | |获取一个直播聊天室下的关联主播列表|/{org_name}/{app_name}/liverooms/${liveroomid}/anchors|''待补充''| | ||
+ | |主播绑定直播聊天室|/{org_name}/{app_name}/liverooms/${liveroomid}/anchors/${username}|绑定直播聊天室,主播即变成这个直播聊天室的正式主播| | ||
+ | |||
+ | ==== 新建主播 ==== | ||
+ | 给一个普通IM用户赋予主播权限,只有拥有主播权限的用户,才能创建直播聊天室。 | ||
+ | |||
+ | === HTTP Request === | ||
+ | |||
+ | ^{{:im:server:ready:post.png?nolink&90|}}^**/{org_name}/{app_name}/chatrooms/super_admin**^ | ||
+ | |||
+ | === Request Headers === | ||
+ | |||
+ | ^参数^说明^ | ||
+ | |Content-Type|application/json| | ||
+ | |Authorization|Bearer ${token}| | ||
+ | |||
+ | === Request Body === | ||
+ | |||
+ | ^参数^说明^ | ||
+ | |''不完整''|''不完整''| | ||
+ | |||
+ | === Response Body === | ||
+ | |||
+ | ^参数^说明^ | ||
+ | |''不完整''|''不完整''| | ||
+ | |||
+ | === 请求示例 === | ||
+ | |||
+ | <code php> | ||
+ | curl -X POST -H "Authorization: Bearer YWMti2bp0NdNEea6On9r7PFKfAAAAVq-FyjtBdvG8hGqmEStXoaECQBgCHIBaqo" http://127.0.0.1:8080/easemob-demo/chatdemoui/chatrooms/super_admin -d'{"superadmin":"z10"}' | ||
+ | </code> | ||
+ | |||
+ | === 可能返回的结果示例 === | ||
+ | |||
+ | **返回值200,表示新建成功** | ||
+ | |||
+ | <code json> | ||
+ | { | ||
+ | "action": "post", | ||
+ | "application": "4d7e4ba0-dc4a-11e3-90d5-e1ffbaacdaf5", | ||
+ | "uri": "http://127.0.0.1:8080/easemob-demo/chatdemoui/chatrooms/super_admin", | ||
+ | "entities": [ ], | ||
+ | "data": { | ||
+ | "result": "success" | ||
+ | }, | ||
+ | "timestamp": 1496236798886, | ||
+ | "duration": 0, | ||
+ | "organization": "easemob-demo", | ||
+ | "applicationName": "chatdemoui" | ||
+ | } | ||
+ | </code> | ||
+ | |||
+ | ''**其他返回值待补充**'' | ||
+ | |||
+ | 如果返回结果是<wrap em>429、503</wrap>或者其他<wrap em>5xx</wrap>,有可能代表该接口被限流了,请稍微暂停一下并重试。详见[[im:450errorcode:45restastrict|接口限流说明]] | ||
+ | |||
+ | [[http://api-docs.easemob.com/|使用 Easemob REST API 在线测试]] | ||
+ | ---- | ||
+ | |||
+ | |||
+ | ==== 分页获取appKey下的主播列表 ==== | ||
+ | ''待补充'' | ||
+ | |||
+ | === HTTP Request === | ||
+ | |||
+ | ^{{:im:server:ready:get.png?nolink&90|}}^**/{org_name}/{app_name}/liverooms/anchors**^ | ||
+ | |||
+ | === Request Headers === | ||
+ | |||
+ | ^参数^说明^ | ||
+ | |Content-Type|application/json| | ||
+ | |Authorization|Bearer ${token}| | ||
+ | |||
+ | === Request Body === | ||
+ | |||
+ | ^参数^说明^ | ||
+ | |pagenum|当前页数| | ||
+ | |pagesize|每页显示数量| | ||
+ | |||
+ | === Response Body === | ||
+ | |||
+ | ^参数^说明^ | ||
+ | |''不完整''|''不完整''| | ||
+ | |||
+ | === 请求示例 === | ||
+ | |||
+ | <code php> | ||
+ | curl -X GET -H "Authorization: Bearer YWMti2bp0NdNEea6On9r7PFKfAAAAVq-FyjtBdvG8hGqmEStXoaECQBgCHIBaqo" http://127.0.0.1:8080/easemob-demo/chatdemoui/liverooms/anchors?pagenum=2&pagesize=2 | ||
+ | </code> | ||
+ | |||
+ | === 可能返回的结果示例 === | ||
+ | |||
+ | **返回值200,表示获取成功** | ||
+ | |||
+ | <code json> | ||
+ | { | ||
+ | "action": "get", | ||
+ | "application": "4d7e4ba0-dc4a-11e3-90d5-e1ffbaacdaf5", | ||
+ | "params": { | ||
+ | "pagesize": [ | ||
+ | "2" | ||
+ | ], | ||
+ | "pagenum": [ | ||
+ | "2" | ||
+ | ] | ||
+ | }, | ||
+ | "uri": "http://127.0.0.1:8080/easemob-demo/chatdemoui/liverooms/anchors", | ||
+ | "entities": [ ], | ||
+ | "data": [ | ||
+ | "no88", | ||
+ | "no3" | ||
+ | ], | ||
+ | "timestamp": 1496242313900, | ||
+ | "duration": 0, | ||
+ | "organization": "easemob-demo", | ||
+ | "applicationName": "chatdemoui", | ||
+ | "count": 2 | ||
+ | } | ||
+ | </code> | ||
+ | |||
+ | ''**其他返回值待补充**'' | ||
+ | |||
+ | 如果返回结果是<wrap em>429、503</wrap>或者其他<wrap em>5xx</wrap>,有可能代表该接口被限流了,请稍微暂停一下并重试。详见[[im:450errorcode:45restastrict|接口限流说明]] | ||
+ | |||
+ | [[http://api-docs.easemob.com/|使用 Easemob REST API 在线测试]] | ||
+ | ---- | ||
+ | |||
+ | ==== 移除主播角色 ==== | ||
+ | 移除用户的主播角色,用户不会被删除,变成普通IM用户。 | ||
+ | |||
+ | === HTTP Request === | ||
+ | |||
+ | ^{{:im:server:ready:delete.png?nolink&90|}}^**/{org_name}/{app_name}/liverooms/anchors/${username}**^ | ||
+ | |||
+ | === Request Headers === | ||
+ | |||
+ | ^参数^说明^ | ||
+ | |Content-Type|application/json| | ||
+ | |Authorization|Bearer ${token}| | ||
+ | |||
+ | === Request Body === | ||
+ | |||
+ | ^参数^说明^ | ||
+ | |pagenum|当前页数| | ||
+ | |pagesize|每页显示数量| | ||
+ | |||
+ | === Response Body === | ||
+ | |||
+ | ^参数^说明^ | ||
+ | |''不完整''|''不完整''| | ||
+ | |||
+ | === 请求示例 === | ||
+ | |||
+ | <code php> | ||
+ | curl -X DELETE -H "Authorization: Bearer YWMti2bp0NdNEea6On9r7PFKfAAAAVq-FyjtBdvG8hGqmEStXoaECQBgCHIBaqo" http://127.0.0.1:8080/easemob-demo/chatdemoui/liverooms/anchors/z10 | ||
+ | </code> | ||
+ | |||
+ | === 可能返回的结果示例 === | ||
+ | |||
+ | **返回值200,表示获取成功** | ||
+ | |||
+ | <code json> | ||
+ | { | ||
+ | "action": "delete", | ||
+ | "application": "4d7e4ba0-dc4a-11e3-90d5-e1ffbaacdaf5", | ||
+ | "uri": "http://127.0.0.1:8080/easemob-demo/chatdemoui/liverooms/anchors/z10", | ||
+ | "entities": [ ], | ||
+ | "data": { | ||
+ | "action": "remove_anchor", | ||
+ | "username": "z10", | ||
+ | "result": true | ||
+ | }, | ||
+ | "timestamp": 1496291020316, | ||
+ | "duration": 0, | ||
+ | "organization": "easemob-demo", | ||
+ | "applicationName": "chatdemoui" | ||
+ | } | ||
+ | </code> | ||
+ | |||
+ | ''**其他返回值待补充**'' | ||
+ | |||
+ | 如果返回结果是<wrap em>429、503</wrap>或者其他<wrap em>5xx</wrap>,有可能代表该接口被限流了,请稍微暂停一下并重试。详见[[im:450errorcode:45restastrict|接口限流说明]] | ||
+ | |||
+ | [[http://api-docs.easemob.com/|使用 Easemob REST API 在线测试]] | ||
+ | ---- | ||
+ | |||
+ | |||
+ |