差别
这里会显示出您选择的修订版和当前版本之间的差别。
| 两侧同时换到之前的修订记录 前一修订版 后一修订版 | 前一修订版 | ||
|
im:server:basics:conferencemanage [2019/06/25 11:00] jk [创建会议] |
im:server:basics:conferencemanage [2020/06/25 02:27] allenwang 移除 |
||
|---|---|---|---|
| 行 7: | 行 7: | ||
| **注：** | **注：** | ||
| - | * 使用此文档接口的前提是，首先得开通音视频服务。 | + | * 原会议类型模式目前已经进行优化，用户可以直接使用普通模式， 大会议模式和直播模式将弃用。 |
| | | ||
| * 在[[im:other:integrationcases:tc|TC Demo]]中，环信仅使用了**创建会议**，**解散会议**两个API，开发者可根据自身需求，选择使用。 | * 在[[im:other:integrationcases:tc|TC Demo]]中，环信仅使用了**创建会议**，**解散会议**两个API，开发者可根据自身需求，选择使用。 | ||
| 行 19: | 行 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| | ||
| 行 44: | 行 44: | ||
| ^名称 ^类型 ^描述^ | ^名称 ^类型 ^描述^ | ||
| - | |confrType|int|10: 普通模式 11: 大会议模式 12: 直播模式| | + | |confrType|int|10: 普通模式 <del>11: 大会议模式 12: 直播模式</del>| |
| |password|string|指定密码时，将使用此密码；不指定，将由服务端生成| | |password|string|指定密码时，将使用此密码；不指定，将由服务端生成| | ||
| - | |confrDelayMillis|long|会议创建后，保留时间。服务端创建了会议后，如果在confrDelayMillis之内没有人加入会议，将会被系统强制解散。但是一旦有人成功进入会后，当最后一人离开会议，会议会立即被销毁；不会再保留confrDelayMillis时间。缺省时，服务器统一配置为150秒。| | + | |confrDelayMillis|long|会议临时保留时长，指从会议创建成功到第一个用户加入会议之间的时长，单位是毫秒。超过这个保留时间，会议将被解散。第一个人加入会议之后，此保留时间失效，当最后一人离开会议，会议会立即被销毁。此参数默认是120秒，建议不要设置超过60分钟。| |
| - | |memDefaultRole|int|会议成员默认角色。用户A通过会议 ID 密码获取加入会议后的角色就是这个 1:观众，3:主播，7:管理员（拥有主播权限）。 缺省时，根据会议类型设置，目前规则如下：普通模式默认主播；大会议模式默认主播；直播模式默认观众| | + | |memDefaultRole|int|会议成员默认角色。用户A通过会议 ID 密码获取加入会议后的角色就是这个 1:观众，3:主播，7:管理员（拥有主播权限）。 缺省时，根据会议类型设置，目前规则如下：普通模式默认主播；<del>大会议模式默认主播；直播模式默认观众</del>| |
| |allowAudienceTalk|boolean|true 允许观众上麦| | |allowAudienceTalk|boolean|true 允许观众上麦| | ||
| |creator|string|指定创建者，creator 将会成为这个会议的管理员，拥有管理员权限| | |creator|string|指定创建者，creator 将会成为这个会议的管理员，拥有管理员权限| | ||
| |rec|boolean|true 此会议将被录制| | |rec|boolean|true 此会议将被录制| | ||
| |recMerge|boolean|true 此会议的所有通话将被合并到一个文件| | |recMerge|boolean|true 此会议的所有通话将被合并到一个文件| | ||
| + | |supportWechatMiniProgram|boolean|true 这个会议将支持小程序，同时会议编码被强制更新为H264,VP8。注意：默认的会议是不支持小程序的，如果想要支持小程序，请手动指定这个参数为true| | ||
| + | |useVCodes|数组|指定会议将要采用的编码方式如["H264","VP8"]| | ||
| === Response Body === | === Response Body === | ||
| ^名称^类型^描述^ | ^名称^类型^描述^ | ||
| - | |type|int|10: 普通模式 11: 大会议模式 12: 直播模式| | + | |type|int|10: 普通模式 <del>11: 大会议模式 12: 直播模式</del>| |
| - | |talkerLimit|int|主播上限数，大会议模式全部是是主播| | + | |talkerLimit|int|主播上限数，<del>大会议模式全部是是主播</del>| |
| |id|string|会议ID| | |id|string|会议ID| | ||
| |password|string|会议密码| | |password|string|会议密码| | ||
| - | |allowAudienceTalk|boolean|允许观众上麦，大会议模式时忽略此项| | + | |allowAudienceTalk|boolean|允许观众上麦，<del>大会议模式时忽略此项</del>| |
| - | |audienceLimit|int|观众上限数，大会议模式无观众| | + | |audienceLimit|int|观众上限数，<del>大会议模式无观众</del>| |
| |expireDate|Date|过期时间，创建会议后，如果在 expireDate 之前没有人加入会议，将会被系统强制解散| | |expireDate|Date|过期时间，创建会议后，如果在 expireDate 之前没有人加入会议，将会被系统强制解散| | ||
| 行 68: | 行 70: | ||
| === 请求示例 === | === 请求示例 === | ||
| <code> | <code> | ||
| - | curl -X POST \ | + | curl --location --request POST 'http://127.0.0.1:9090/easemob-demo/hcl/conferences' \ |
| - | http://a1.easemob.com/1100181023201864/voicechatroom/conferences \ | + | --header 'Content-Type: application/json' \ |
| - | -H 'Accept: */*' \ | + | --header 'Authorization: Bearer YWMtaJszCI5vEemOhnkmxEo52QAAAAAAAAAAAAAAAAAAAAHmqirKW28R6ZB2cYf5QmSUAQMAAAFrVLgKfgBPGgC863CANqOsZOAF1tnxLeMc0Z-gRFCQwqV-0MB5nVAB5A' \ |
| - | -H 'Authorization: Bearer YWMtaJszCI5vEemOhnkmxEo52QAAAAAAAAAAAAAAAAAAAAHmqirKW28R6ZB2cYf5QmSUAQMAAAFrVLgKfgBPGgC863CANqOsZOAF1tnxLeMc0Z-gRFCQwqV-0MB5nVAB5A' \ | + | --header 'Content-Type: application/json' \ |
| - | -H 'Cache-Control: no-cache' \ | + | --data-raw '{ |
| - | -H 'Connection: keep-alive' \ | + | "confrType": 10, |
| - | -H 'Content-Type: application/json' \ | + | "password": "", |
| - | -d '{ | + | "confrDelayMillis": 100000, |
| - | "allowAudienceTalk" : true, | + | "memDefaultRole":3, |
| - | "confrDelayMillis" : 3600, | + | "allowAudienceTalk": false, |
| - | "confrType" : 10, | + | "confrId": "", |
| - | "creator" : "huangcl", | + | "creator":"122", |
| - | "memDefaultRole" : 3 | + | "rec":false, |
| + | "recMerge":false, | ||
| + | "supportWechatMiniProgram": true, | ||
| + | "useVCodes": [ | ||
| + | "H264", | ||
| + | "VP8" | ||
| + | ] | ||
| + | |||
| + | | ||
| }' | }' | ||
| </code> | </code> | ||
| 行 172: | 行 182: | ||
| === 可能返回的结果 === | === 可能返回的结果 === | ||
| - | 返回值200，表示会议解散成功 | + | 返回值200，表示踢掉会议中成员成功 |
| 返回值404，表示该会议ID不存在 | 返回值404，表示该会议ID不存在 | ||
| 行 182: | 行 192: | ||
| ---- | ---- | ||
| - | ===== 获取一个会议 ===== | + | ===== 获取会议信息 ===== |
| === HTTP Request === | === HTTP Request === | ||
| 行 189: | 行 199: | ||
| - | 需要在请求时对应填写{confrId}，需要删除的会议 ID 。 | + | 需要在请求时对应填写{confrId}，需要获取的会议 ID 。 |
| === Request Headers === | === Request Headers === | ||
| 行 199: | 行 209: | ||
| ^名称^类型^描述^ | ^名称^类型^描述^ | ||
| - | |type|int|10: 普通模式 11: 大会议模式 12: 直播模式| | + | |type|int|10: 普通模式 <del>11: 大会议模式 12: 直播模式</del>| |
| - | |talkerLimit|int|主播上限数，大会议模式全部是是主播| | + | |talkerLimit|int|主播上限数，<del>大会议模式全部是是主播</del>| |
| |id|string|会议ID| | |id|string|会议ID| | ||
| |password|string|会议密码| | |password|string|会议密码| | ||
| - | |allowAudienceTalk|boolean|允许观众上麦，大会议模式时忽略此项| | + | |allowAudienceTalk|boolean|允许观众上麦，<del>大会议模式时忽略此项</del>| |
| - | |audienceLimit|int|观众上限数，大会议模式无观众| | + | |audienceLimit|int|观众上限数，<del>大会议模式无观众</del>| |
| |expireDate|Date|过期时间，创建会议后，如果在 expireDate 之前没有人加入会议，将会被系统强制解散| | |expireDate|Date|过期时间，创建会议后，如果在 expireDate 之前没有人加入会议，将会被系统强制解散| | ||
| + | |mems |Array |现有成员列表| | ||
| 行 218: | 行 229: | ||
| === 可能返回的结果示例 === | === 可能返回的结果示例 === | ||
| - | **返回值200，表示会议解散成功** | + | **返回值200，表示会议获取成功** |
| <code> | <code> | ||
| { | { | ||
| "error": 0, | "error": 0, | ||
| - | "id": "IM3SKW51SKH4TB80LV45000C7", | + | "id": "13H05522N8TEXW49ESW00C10618", |
| - | "type": 10, | + | "type": 11, |
| - | "mixed": false, | + | "mixed": true, |
| - | "password": "0.37898245722568236", | + | "password": "", |
| - | "audienceLimit": 600, | + | "audienceLimit": 0, |
| - | "talkerLimit": 6, | + | "talkerLimit": 30, |
| - | "allowAudienceTalk": true | + | "allowAudienceTalk": true, |
| + | "mems": [{ | ||
| + | "memberId": "13H05522N8TEXW49ESW00C10618M2", | ||
| + | "memName": "easemob-demo#chatdemoui_lulu3", | ||
| + | "role": 7 | ||
| + | }] | ||
| } | } | ||
| </code> | </code> | ||