会议管理
环信使用 REST 的方式来对音视频会议进行管理操作,包括创建会议,解散会议,获取会议及从会议中踢人。
注:
REST API
音视频会议管理在集成过程中,可以使用以下4个接口来对会议进行管理操作。请查看以下 REST API 详细文档说明。
名称 | 请求 | Method |
---|
创建一个会议 | /{orgName}/{appName}/conferences | POST |
解散一个会议 | /{orgName}/{appName}/conferences/{confrId} | DELETE |
获取会议信息 | /{orgName}/{appName}/conferences/{confrId} | GET |
从会议中踢掉一个人 | /{orgName}/{appName}/conferences/{confrId}/{userName} | DELETE |
创建会议
HTTP Request
![img](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFoAAAANCAYAAAApI3lNAAADOklEQVRYhe2XT2gcVRjAf9/bMcZlKSKl1dlklVhLidX6h6DJbg5aFIQexEuhKDnUXip1JunBUw+lQg9id5eCRTyUFAse1IN/L2IPmV0jViqopZTQQ+OOpYdSJMo2zL6vh5ldNmkzwVQwCf3BY4b3fe978733zfe9B3e5y3pC0oRekO8FfRPoTbr+Ai4gTFeL4Xxbzw/yOUX3AEPAFUQmRcxMZWS2Y8uv5XtVdRcwChjgDMhX1VJj3qu521B2Lf2V8kW12Li4UidXAyZdrFlFjwDPApuB54CTKN96NXcDgB+4GxT9EjgAzALbUP1RrS21rfi1vKOqHwFHgDnAxu96fCLoN0AOeDRpTwNHk2fSp7n/0Of/BSdVqkoS9Mero2EdwK/1PaBqz6G8DnygsB8oiDBaKYbh+E8FY29EJ0A/nJhynzg2GlqULcCrwHC1FP4W28nnVHGPlWYtcDZp+LX8gKq+JnC4UgrXdBR3kx7RIiC6IME4PXINuAg8fLDe7wC7gY8rxTAEKA9dtiLyHrDVGp6J7WCJN7XwztkBACrFxly1tHQ6UF25U6uR9IXWrpYQ3Wj1AduB3yPbuh/oA37uHjaw6b4ZYE6VQQCBS8Ap4HSz2TzhBe5TB6cLy2/yOiLVWUURBIQDXuCWvcCdVJgCvjdiPgF6iAvl9e5xbz82Q9KXAygXG5FB3gL2AoPAVBRFn/lBfssSE6dX6TXIMsWwwzXgT+JF3u2IjJWLf8wLNIF/gE3dyv65Rwywka4NKJcaUbUUfi5Gdgq8AmxU9Gu/3ndroRNY8ButA1KLoYi0U8fpdjFcIM9krmurdQkYBj7tCP6ef5I40n9ZPKYy0oiAwA/cMYVf1drtwPRtZv93nqxylsnRixL0IsrDsxY4CezxgvxWgPFaf4/CIWDa3Js5D+AF7ote4E749Yd6OqaRBwEECe/UibVA+vGuTUpwiZFTavUF0DNe4H5jtTUIFAR5qTzUubAYYFyt7PUCtw5kQV8GjmaczOU78mCNsEyOljlE9hEf525LZaTRdBznDWAf8YVlUkR2mHu40NbJZrPfCfI4cDjR+QHYaYx59/3nb1nnqyhjqlxZiUOrlZsVGxxfj+coKgAAAABJRU5ErkJggg==) | /{org_name}/{app_name}/conferences |
---|
参数 | 说明 |
---|
Content-Type | application/json |
Authorization | Bearer ${token} |
Request Body
名称 | 类型 | 描述 |
---|
confrType | int | 10: 普通模式 11: 大会议模式 12: 直播模式 |
password | string | 指定密码时,将使用此密码;不指定,将由服务端生成 |
confrDelayMillis | long | 会议临时保留时长,指从会议创建成功到第一个用户加入会议之间的时长,单位是毫秒。超过这个保留时间,会议将被解散。第一个人加入会议之后,此保留时间失效,当最后一人离开会议,会议会立即被销毁。此参数默认是120秒,建议不要设置超过60分钟。 |
memDefaultRole | int | 会议成员默认角色。用户A通过会议 ID 密码获取加入会议后的角色就是这个 1:观众,3:主播,7:管理员(拥有主播权限)。 缺省时,根据会议类型设置,目前规则如下:普通模式默认主播;大会议模式默认主播;直播模式默认观众 |
allowAudienceTalk | boolean | true 允许观众上麦 |
creator | string | 指定创建者,creator 将会成为这个会议的管理员,拥有管理员权限 |
rec | boolean | true 此会议将被录制 |
recMerge | boolean | true 此会议的所有通话将被合并到一个文件 |
supportWechatMiniProgram | boolean | true 这个会议将支持小程序,同时会议编码被强制更新为H264,VP8。注意:默认的会议是不支持小程序的,如果想要支持小程序,请手动指定这个参数为true |
useVCodes | 数组 | 指定会议将要采用的编码方式如[“H264”,“VP8”] |
maxTalkerCount | int | 会议主播人数 |
maxVideoCount | int | 会议最大视频数 |
maxAudienceCount | int | 会议中的最大人数 |
Response Body
名称 | 类型 | 描述 |
---|
type | int | 10: 普通模式 11: 大会议模式 12: 直播模式 |
talkerLimit | int | 主播上限数,大会议模式全部是是主播 |
id | string | 会议ID |
password | string | 会议密码 |
allowAudienceTalk | boolean | 允许观众上麦,大会议模式时忽略此项 |
audienceLimit | int | 观众上限数,大会议模式无观众 |
expireDate | Date | 过期时间,创建会议后,如果在 expireDate 之前没有人加入会议,将会被系统强制解散 |
请求示例
curl -L -X POST 'http://127.0.0.1:9090/easemob-demo/hcl/conferences' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YWMtaJszCI5vEemOhnkmxEo52QAAAAAAAAAAAAAAAAAAAAHmqirKW28R6ZB2cYf5QmSUAQMAAAFrVLgKfgBPGgC863CANqOsZOAF1tnxLeMc0Z-gRFCQwqV-0MB5nVAB5A' \
--header 'Content-Type: application/json' \
--data-raw '{
"confrType": 10,
"password": "",
"confrDelayMillis": 100000,
"memDefaultRole":3,
"allowAudienceTalk": false,
"confrId": "",
"creator":"122",
"rec":false,
"recMerge":false,
"supportWechatMiniProgram": true,
"useVCodes": [
"H264",
"VP8"
],
"maxTalkerCount":9,
"maxVideoCount":9,
"maxAudienceCount":20
}'
可能返回的结果示例
- 返回值200,表示会议创建成功
- 返回值401,未授权[无token、token错误、token过期]
- 返回值403,没有开通音视频增值服务调用接口失败
{
"error": 0,
"id": "IM3SKW51SKH4TB80LV45000C7",
"type": 10,
"mixed": false,
"password": "0.37898245722568236",
"audienceLimit": 600,
"talkerLimit": 6,
"expireDate": "2019-06-14 15:41:58",
"allowAudienceTalk": true
}
解散会议
HTTP Request
![img](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFoAAAANCAYAAAApI3lNAAADGElEQVRYhe2Xy2sUSxTGf6cmRiMSLxJE0iOIV1EuOmkR9D8QBDeKD7jgmyxcuBbX4SJ3J7jQhQtFBBci6DKIC/Gxk56gLkRESPdFJMQg42Qcu+u46O6k03Zm+qKJD/w2XX3qPKq/qvqqGn7jN34lSKdOzziDwN/Jaxt4hfDAjYKp1Kdeqfar6gmgJxceujY4n8m1H/jPtcGjolr1SnWdqu4v6PJdG9zwKs56lH0dvmTUjYKxeqU6oKpHAJPzaLg2uDRv/AIjT04e64B/gMvACmAY5Q/POCddG4wCqLIq8bkDTGVi29lECsPAQ6CQaFXdnOS5AthMV9peBvyZtHuBY8AtYCKx9Sd11gDngBtAM5MnO7ZFR0eiFRBoC3J2yPrvxypre63aEeBavVLdPhT5vgiogggjQ1HwvFO+jtsnRqtvqZzeNO238x1unPsUgLdk7Soie0SEc0NR8OTLUUPFcGZrGLzpXnJxkN9ec5ASo8mzFo23RRgBmqp6EEBVC2OLUMazfLZiiJaYzu+AMit6Dpav7Gt8mJr2gG0AgqAoquzyzOBfcYQC5p5r/ck0LrV2G0/ro+7zzGCYRLURGXUjv1VudLOFIssezzipXFhE7rqR/777EBYG3TQamPs5Gydf4hlnAlgdW2boO6BIU2Yi9CkwQ/Q8tOTRCwwrYhPfBqr3gQKiKZw5nTUeZvacCFF9AvzYRGfxbGADnyanB4FY/xKRFmHY7aDRJTd0s2+p7C7S6LIZ0x1WMRz6aTQ6RWaV8OldawDYATyOO7+1RpfNp4Vcf63GLxRKEZ2i3lPtR/UCMGUMN4F4RZdAaQL+B1PFB/GPSXVH6UgoXAZc9YzTr1a3AG8E9tbCYM69VJWLnnEaWZsRc7QWjU9k8h32jLMzV+Zf1wb3k/byVpvbnnGy9+i3RsypWjSe02kpnONUOiLLdc842ZiWEXOyFo1/l/t0t1vHC4kPFYAQ4VXPEhnb0vLDjNsEcJzM7lAUiadp5odB4p+INV9UQF4nLx6ztbJoKhrmbI3E93XeWVE/6TPZtS0QMt+hugj4DPFVLm+6aF2QAAAAAElFTkSuQmCC) | /{orgName}/{appName}/conferences/{confrId} |
---|
需要在请求时对应填写{confrId},需要删除的会议 ID 。
参数 | 说明 |
---|
Content-Type | application/json |
Authorization | Bearer ${token} |
请求示例
curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/conferences/TURN25AIYAVxASW7PL1Q00C51'
可能返回的结果
- 返回值200,表示会议解散成功
- 返回值404,表示该会议ID不存在
- 返回值401,未授权[无token、token错误、token过期]
- 返回值403,没有开通音视频增值服务调用接口失败
踢掉会议中成员
HTTP Request
![img](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFoAAAANCAYAAAApI3lNAAADGElEQVRYhe2Xy2sUSxTGf6cmRiMSLxJE0iOIV1EuOmkR9D8QBDeKD7jgmyxcuBbX4SJ3J7jQhQtFBBci6DKIC/Gxk56gLkRESPdFJMQg42Qcu+u46O6k03Zm+qKJD/w2XX3qPKq/qvqqGn7jN34lSKdOzziDwN/Jaxt4hfDAjYKp1Kdeqfar6gmgJxceujY4n8m1H/jPtcGjolr1SnWdqu4v6PJdG9zwKs56lH0dvmTUjYKxeqU6oKpHAJPzaLg2uDRv/AIjT04e64B/gMvACmAY5Q/POCddG4wCqLIq8bkDTGVi29lECsPAQ6CQaFXdnOS5AthMV9peBvyZtHuBY8AtYCKx9Sd11gDngBtAM5MnO7ZFR0eiFRBoC3J2yPrvxypre63aEeBavVLdPhT5vgiogggjQ1HwvFO+jtsnRqtvqZzeNO238x1unPsUgLdk7Soie0SEc0NR8OTLUUPFcGZrGLzpXnJxkN9ec5ASo8mzFo23RRgBmqp6EEBVC2OLUMazfLZiiJaYzu+AMit6Dpav7Gt8mJr2gG0AgqAoquzyzOBfcYQC5p5r/ck0LrV2G0/ro+7zzGCYRLURGXUjv1VudLOFIssezzipXFhE7rqR/777EBYG3TQamPs5Gydf4hlnAlgdW2boO6BIU2Yi9CkwQ/Q8tOTRCwwrYhPfBqr3gQKiKZw5nTUeZvacCFF9AvzYRGfxbGADnyanB4FY/xKRFmHY7aDRJTd0s2+p7C7S6LIZ0x1WMRz6aTQ6RWaV8OldawDYATyOO7+1RpfNp4Vcf63GLxRKEZ2i3lPtR/UCMGUMN4F4RZdAaQL+B1PFB/GPSXVH6UgoXAZc9YzTr1a3AG8E9tbCYM69VJWLnnEaWZsRc7QWjU9k8h32jLMzV+Zf1wb3k/byVpvbnnGy9+i3RsypWjSe02kpnONUOiLLdc842ZiWEXOyFo1/l/t0t1vHC4kPFYAQ4VXPEhnb0vLDjNsEcJzM7lAUiadp5odB4p+INV9UQF4nLx6ztbJoKhrmbI3E93XeWVE/6TPZtS0QMt+hugj4DPFVLm+6aF2QAAAAAElFTkSuQmCC) | /{orgName}/{appName}/conferences/{confrId}/{userName} |
---|
需要在请求时对应填写{confrId},需要删除的会议 ID 。
userName为成员用户名。
参数 | 说明 |
---|
Content-Type | application/json |
Authorization | Bearer ${token} |
请求示例
curl -X DELETE -H 'Accept: application/json' -H 'Authorization: Bearer YWMt7CoyjusbEeixOi3iod4eDAAAAAAAAAAAAAAAAAAAAAGL4CTw6XgR6LaXXVmNX4QCAgMAAAFnJlhJIwBPGgCqtjiyVnR209iyr8kNbhJhhanNQDdP9CMmpK2G-NIUOQ' 'http://a1.easemob.com/easemob-demo/testapp/conferences/TURN25AIYAVxASW7PL1Q00C51/yangss'
可能返回的结果
- 返回值200,表示会议解散成功
- 返回值404,表示该会议ID不存在
- 返回值401,未授权[无token、token错误、token过期]
- 返回值403,没有开通音视频增值服务调用接口失败
获取会议信息
HTTP Request
![img](data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAFoAAAANCAYAAAApI3lNAAAB70lEQVRYhe3WP0iVURjH8c8REUqQjIYIC+wPSH9oqLjqENUQtLkYbVIQUVub9zaESPcGLgVBUFNRS7TlKNl2fTEiQqJBGm4QDuIQYmXiadCuXgtfFIe81y+8w/uc3/n3e5/3OYcttqgmQqqi+wWl8f24hFZ8wTNJ7jPIFJqIV1C/ouecJHdPe2G7GG+sMsN7SW5oXavfRNSlKkrjXRhFhwWTj2FYe2HPomIn7uAEDix7WheaY/2y2CHcwoVlsV0btJf/mpVZWEkm34LHeKAu9Clm53XcJcY2zY1fK8WhX5L9+NcYI7lvuA5ODzT4+escnkhyTzdkB5uE1Y3mIqapG1DsnQfFXvi0rtniunpVBWlGn8I7x5unJauoIkI8L5M/XI6F8NpIdmoD1lgVpBm9AyWPri28ZfJ96Fxsuy/JDYrlNO3GTLlnNIZKo9OP3qolzegp7HZmmDdnCeGVGEfRjxYQgsWUvvrPGl1B7daOtFtHESf9SJrASPatfQcHMVlW1K53ayLF6PASxPnbOvIL2T9RqkPDkmQNs9XwR1m9dCTZCZlCD/G5eZ0y+Q9mZ9twVDBWKY4PZfLTlbHQI8kuZX+o3SKdVqPZlhnyPTlC7MJejBIGNTdOLComcdmfv6N8OAZCnFkx2hxuIqWWVx+/AfnLhJM/ulbpAAAAAElFTkSuQmCC) | /{orgName}/{appName}/conferences/{confrId} |
---|
需要在请求时对应填写{confrId},需要获取的会议 ID 。
参数 | 说明 |
---|
Content-Type | application/json |
Authorization | Bearer ${token} |
Response Body
名称 | 类型 | 描述 |
---|
type | int | 10: 普通模式 11: 大会议模式 12: 直播模式 |
talkerLimit | int | 主播上限数,大会议模式全部是是主播 |
id | string | 会议ID |
password | string | 会议密码 |
allowAudienceTalk | boolean | 允许观众上麦,大会议模式时忽略此项 |
audienceLimit | int | 观众上限数,大会议模式无观众 |
expireDate | Date | 过期时间,创建会议后,如果在 expireDate 之前没有人加入会议,将会被系统强制解散 |
mems | Array | 现有成员列表 |
请求示例
curl -X GET \
http://a1.easemob.com/1100181023201864/voicechatroom/conferences/IM3SKW51SKH4TB80LV45000C7 \
-H 'Accept: */*' \
-H 'Authorization: Bearer YWMtaJszCI5vEemOhnkmxEo52QAAAAAAAAAAAAAAAAAAAAHmqirKW28R6ZB2cYf5QmSUAQMAAAFrVLgKfgBPGgC863CANqOsZOAF1tnxLeMc0Z-gRFCQwqV-0MB5nVAB5A'
可能返回的结果示例
- 返回值200,表示会议获取成功
- 返回值404,表示该会议ID不存在
- 返回值401,未授权[无token、token错误、token过期]
- 返回值403,没有开通音视频增值服务调用接口失败
{
"error": 0,
"id": "13H05522N8TEXW49ESW00C10618",
"type": 11,
"mixed": true,
"password": "",
"audienceLimit": 0,
"talkerLimit": 30,
"allowAudienceTalk": true,
"mems": [{
"memberId": "13H05522N8TEXW49ESW00C10618M2",
"memName": "easemob-demo#chatdemoui_lulu3",
"role": 7
}]
}