差别
这里会显示出您选择的修订版和当前版本之间的差别。
两侧同时换到之前的修订记录 前一修订版 后一修订版 | 前一修订版 后一修订版 两侧同时换到之后的修订记录 | ||
im:server:basics:conferencemanage [2019/06/14 10:15] jk [踢掉会议中成员] |
im:server:basics:conferencemanage [2020/03/05 03:25] simon.fu [REST API] |
||
---|---|---|---|
行 6: | 行 6: | ||
环信使用 REST 的方式来对音视频会议进行管理操作,包括**创建会议**,**解散会议**,**获取会议**及**从会议中踢人**。 | 环信使用 REST 的方式来对音视频会议进行管理操作,包括**创建会议**,**解散会议**,**获取会议**及**从会议中踢人**。 | ||
- | **注:**在[[im:other:integrationcases:tc|TC Demo]]中,环信仅使用了**创建会议**,**解散会议**两个API,开发者可根据自身需求,选择使用。 | + | **注:** |
+ | * 使用此文档接口的前提是,首先得开通音视频服务。 | ||
+ | |||
+ | * 在[[im:other:integrationcases:tc|TC Demo]]中,环信仅使用了**创建会议**,**解散会议**两个API,开发者可根据自身需求,选择使用。 | ||
====== REST API ====== | ====== REST API ====== | ||
行 16: | 行 19: | ||
|创建一个会议|/{orgName}/{appName}/conferences|POST| | |创建一个会议|/{orgName}/{appName}/conferences|POST| | ||
|解散一个会议|/{orgName}/{appName}/conferences/{confrId}|DELETE| | |解散一个会议|/{orgName}/{appName}/conferences/{confrId}|DELETE| | ||
- | |获取会议|/{orgName}/{appName}/conferences/{confrId}|GET| | + | |获取会议信息|/{orgName}/{appName}/conferences/{confrId}|GET| |
|从会议中踢掉一个人|/{orgName}/{appName}/conferences/{confrId}/{userName}|DELETE| | |从会议中踢掉一个人|/{orgName}/{appName}/conferences/{confrId}/{userName}|DELETE| | ||
行 43: | 行 46: | ||
|confrType|int|10: 普通模式 11: 大会议模式 12: 直播模式| | |confrType|int|10: 普通模式 11: 大会议模式 12: 直播模式| | ||
|password|string|指定密码时,将使用此密码;不指定,将由服务端生成| | |password|string|指定密码时,将使用此密码;不指定,将由服务端生成| | ||
- | |confrDelayMillis|long|会议创建后,保留时间。服务端创建了会议后,如果过了confrDelayMillis没有人加入会议,将会被系统强制解散。缺省时,服务器统一配置为150秒| | + | |confrDelayMillis|long|会议创建后,保留时间。服务端创建了会议后,如果在confrDelayMillis之内没有人加入会议,将会被系统强制解散。但是一旦有人成功进入会后,当最后一人离开会议,会议会立即被销毁;不会再保留confrDelayMillis时间。缺省时,服务器统一配置为150秒。| |
|memDefaultRole|int|会议成员默认角色。用户A通过会议 ID 密码获取加入会议后的角色就是这个 1:观众,3:主播,7:管理员(拥有主播权限)。 缺省时,根据会议类型设置,目前规则如下:普通模式默认主播;大会议模式默认主播;直播模式默认观众| | |memDefaultRole|int|会议成员默认角色。用户A通过会议 ID 密码获取加入会议后的角色就是这个 1:观众,3:主播,7:管理员(拥有主播权限)。 缺省时,根据会议类型设置,目前规则如下:普通模式默认主播;大会议模式默认主播;直播模式默认观众| | ||
|allowAudienceTalk|boolean|true 允许观众上麦| | |allowAudienceTalk|boolean|true 允许观众上麦| | ||
行 66: | 行 69: | ||
<code> | <code> | ||
curl -X POST \ | curl -X POST \ | ||
- | http://a1-hsb.easemob.com/1100181023201864/voicechatroom/conferences \ | + | http://a1.easemob.com/1100181023201864/voicechatroom/conferences \ |
-H 'Accept: */*' \ | -H 'Accept: */*' \ | ||
-H 'Authorization: Bearer YWMtaJszCI5vEemOhnkmxEo52QAAAAAAAAAAAAAAAAAAAAHmqirKW28R6ZB2cYf5QmSUAQMAAAFrVLgKfgBPGgC863CANqOsZOAF1tnxLeMc0Z-gRFCQwqV-0MB5nVAB5A' \ | -H 'Authorization: Bearer YWMtaJszCI5vEemOhnkmxEo52QAAAAAAAAAAAAAAAAAAAAHmqirKW28R6ZB2cYf5QmSUAQMAAAFrVLgKfgBPGgC863CANqOsZOAF1tnxLeMc0Z-gRFCQwqV-0MB5nVAB5A' \ | ||
行 186: | 行 189: | ||
- | 需要在请求时对应填写{confrId},需要删除的会议 ID 。 | + | 需要在请求时对应填写{confrId},需要获取的会议 ID 。 |
=== Request Headers === | === Request Headers === | ||
行 208: | 行 211: | ||
<code> | <code> | ||
curl -X GET \ | curl -X GET \ | ||
- | http://a1-hsb.easemob.com/1100181023201864/voicechatroom/conferences/IM3SKW51SKH4TB80LV45000C7 \ | + | http://a1.easemob.com/1100181023201864/voicechatroom/conferences/IM3SKW51SKH4TB80LV45000C7 \ |
-H 'Accept: */*' \ | -H 'Accept: */*' \ | ||
-H 'Authorization: Bearer YWMtaJszCI5vEemOhnkmxEo52QAAAAAAAAAAAAAAAAAAAAHmqirKW28R6ZB2cYf5QmSUAQMAAAFrVLgKfgBPGgC863CANqOsZOAF1tnxLeMc0Z-gRFCQwqV-0MB5nVAB5A' | -H 'Authorization: Bearer YWMtaJszCI5vEemOhnkmxEo52QAAAAAAAAAAAAAAAAAAAAHmqirKW28R6ZB2cYf5QmSUAQMAAAFrVLgKfgBPGgC863CANqOsZOAF1tnxLeMc0Z-gRFCQwqV-0MB5nVAB5A' | ||
行 215: | 行 218: | ||
=== 可能返回的结果示例 === | === 可能返回的结果示例 === | ||
- | **返回值200,表示会议解散成功** | + | **返回值200,表示会议获取成功** |
<code> | <code> | ||
{ | { | ||
行 233: | 行 236: | ||
返回值401,未授权[无token、token错误、token过期] | 返回值401,未授权[无token、token错误、token过期] | ||
+ | 返回值403,没有开通音视频增值服务调用接口失败 | ||
---- | ---- |