会议管理


环信使用 REST 的方式来对音视频会议进行管理操作,包括创建会议解散会议获取会议从会议中踢人

注:

  • 使用此文档接口的前提是,首先得开通音视频服务。
  • TC Demo中,环信仅使用了创建会议解散会议两个API,开发者可根据自身需求,选择使用。

REST API

音视频会议管理在集成过程中,可以使用以下4个接口来对会议进行管理操作。请查看以下 REST API 详细文档说明。

名称请求Method
创建一个会议/{orgName}/{appName}/conferencesPOST
解散一个会议/{orgName}/{appName}/conferences/{confrId}DELETE
获取会议/{orgName}/{appName}/conferences/{confrId}GET
从会议中踢掉一个人/{orgName}/{appName}/conferences/{confrId}/{userName}DELETE

HTTP Request

/{org_name}/{app_name}/conferences

Request Headers

参数 说明
Content-Typeapplication/json
AuthorizationBearer ${token}

Request Body

名称 类型 描述
confrTypeint10: 普通模式 11: 大会议模式 12: 直播模式
passwordstring指定密码时,将使用此密码;不指定,将由服务端生成
confrDelayMillislong会议创建后,保留时间。服务端创建了会议后,如果在confrDelayMillis之内没有人加入会议,将会被系统强制解散。但是一旦有人成功进入会后,当最后一人离开会议,会议会立即被销毁;不会再保留confrDelayMillis时间。缺省时,服务器统一配置为150秒。
memDefaultRoleint会议成员默认角色。用户A通过会议 ID 密码获取加入会议后的角色就是这个 1:观众,3:主播,7:管理员(拥有主播权限)。 缺省时,根据会议类型设置,目前规则如下:普通模式默认主播;大会议模式默认主播;直播模式默认观众
allowAudienceTalkbooleantrue 允许观众上麦
creatorstring指定创建者,creator 将会成为这个会议的管理员,拥有管理员权限
recbooleantrue 此会议将被录制
recMergebooleantrue 此会议的所有通话将被合并到一个文件

Response Body

名称类型描述
typeint10: 普通模式 11: 大会议模式 12: 直播模式
talkerLimitint主播上限数,大会议模式全部是是主播
idstring会议ID
passwordstring会议密码
allowAudienceTalkboolean允许观众上麦,大会议模式时忽略此项
audienceLimitint观众上限数,大会议模式无观众
expireDateDate过期时间,创建会议后,如果在 expireDate 之前没有人加入会议,将会被系统强制解散

请求示例

curl -X POST \
  http://a1.easemob.com/1100181023201864/voicechatroom/conferences \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer YWMtaJszCI5vEemOhnkmxEo52QAAAAAAAAAAAAAAAAAAAAHmqirKW28R6ZB2cYf5QmSUAQMAAAFrVLgKfgBPGgC863CANqOsZOAF1tnxLeMc0Z-gRFCQwqV-0MB5nVAB5A' \
  -H 'Cache-Control: no-cache' \
  -H 'Connection: keep-alive' \
  -H 'Content-Type: application/json' \
  -d '{
    "allowAudienceTalk" : true,
    "confrDelayMillis" : 3600,
    "confrType" : 10,
    "creator" : "huangcl",
    "memDefaultRole" : 3
}'

可能返回的结果示例

返回值200,表示会议创建成功

{
    "error": 0,
    "id": "IM3SKW51SKH4TB80LV45000C7",
    "type": 10,
    "mixed": false,
    "password": "0.37898245722568236",
    "audienceLimit": 600,
    "talkerLimit": 6,
    "expireDate": "2019-06-14 15:41:58",
    "allowAudienceTalk": true
}

返回值401,未授权[无token、token错误、token过期]

返回值403,没有开通音视频增值服务调用接口失败


HTTP Request

/{orgName}/{appName}/conferences/{confrId}

需要在请求时对应填写{confrId},需要删除的会议 ID 。

Request Headers

参数 说明
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

/{orgName}/{appName}/conferences/{confrId}/{userName}

需要在请求时对应填写{confrId},需要删除的会议 ID 。

userName为成员用户名。

Request Headers

参数 说明
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

/{orgName}/{appName}/conferences/{confrId}

需要在请求时对应填写{confrId},需要获取的会议 ID 。

Request Headers

参数 说明
Content-Type application/json
Authorization Bearer ${token}

Response Body

名称类型描述
typeint10: 普通模式 11: 大会议模式 12: 直播模式
talkerLimitint主播上限数,大会议模式全部是是主播
idstring会议ID
passwordstring会议密码
allowAudienceTalkboolean允许观众上麦,大会议模式时忽略此项
audienceLimitint观众上限数,大会议模式无观众
expireDateDate过期时间,创建会议后,如果在 expireDate 之前没有人加入会议,将会被系统强制解散

请求示例

curl -X GET \
  http://a1.easemob.com/1100181023201864/voicechatroom/conferences/IM3SKW51SKH4TB80LV45000C7 \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer YWMtaJszCI5vEemOhnkmxEo52QAAAAAAAAAAAAAAAAAAAAHmqirKW28R6ZB2cYf5QmSUAQMAAAFrVLgKfgBPGgC863CANqOsZOAF1tnxLeMc0Z-gRFCQwqV-0MB5nVAB5A'

可能返回的结果示例

返回值200,表示会议获取成功

{
  "error": 0,
  "id": "IM3SKW51SKH4TB80LV45000C7",
  "type": 10,
  "mixed": false,
  "password": "0.37898245722568236",
  "audienceLimit": 600,
  "talkerLimit": 6,
  "allowAudienceTalk": true
}

返回值404,表示该会议ID不存在

返回值401,未授权[无token、token错误、token过期]

返回值403,没有开通音视频增值服务调用接口失败


上一页:文件上传下载

下一页:录制提取