接口描述:
为用户创建一个会议
公共参数:
参数名称 | 是否必须 | 参数值 | 备注 |
---|---|---|---|
Content-Type | 是 | application/json | 无 |
X-Q-Signature | 是 | string | 签名 |
X-Q-SceretId | 是 | string | 用于表示 API 调用者身份 |
请求方法:
POST
接口请求域名:
https://api.meeting.streamlake.com/rest/v1/conference/create
输入参数:
参数名称 | 是否必须 | 参数类型 | 参数含义 | 示例 | 备注说明 |
---|---|---|---|---|---|
creator | 是 | String | 会议创建者的userId | "zhangsan1001" | 此处所传参数为会议拥有者UID,是调用方用于标示用户的唯一 ID |
conferenceType | 是 | Integer | 会议类型 | 默认为1:预定会议 | 目前只支持预定会议的创建 |
topic | 是 | String | 会议主题 | "xxxx的会议" | 会议主题最多可支持128个字符 |
startTime | 是 | Long | 预定会议开始时间(毫秒) | 1636451887569 | 无 |
endTime | 是 | Long | 预定会议结束时间(毫秒) | 1636451947569 | 无 |
invitees | 是 | String数组 | 邀请参会人列表 | ["zhangsan1001","lisi2021"] | 邀请参会人列表支持传递多个参会人UID,最多设置300人 |
hosts | 否 | String数组 | 指定主持人列表 | ["zhangsan1001",'lisi2021'] | 指定主持人列表支持传递多个主持人UID,最多设置15名主持人 |
defaultMute | 否 | Boolean | 所有人加入时静音 | false:不静音;true:静音 | 所有人入会时静音 |
defaultCloseCamera | 否 | Boolean | 所有人加入时关闭视频 | false:不关闭视频;true:关闭视频 | 所有人入会时关闭视频 |
onlyInvitees | 否 | Boolean | 仅受邀用户可参会 | false :全部用户可入会;true:仅受邀用户可参会 | 当开启后,仅受邀用户可入会,非受邀用户无法进入会议 |
applicationIds | 否 | String数组 | 应用Id列表 | ["peixun","yanjiang"] | 此处应用ID的设置会在会议中展示,应用ID需联系业务对接人获取,暂不支持自动创建及获取 |
输出参数:
参数名称 | 参数类型 | 参数含义 | 示例 | 备注说明 |
---|---|---|---|---|
conferenceCode | String | 会议码 | "222111000" | 9位会议码,可通过该会议码加入会议 |
scheduleId | String | 会议ID | "10202020202088833" | 会议唯一ID |
creator | String | 会议创建者UID | "zhangsan101" | 调用方用于标示用户的唯一 ID |
topic | String | 会议主题 | "xxx的会议" | 无 |
startTime | Long | 预定会议开始时间(毫秒) | 1636451887569 | 无 |
endTime | Long | 预定会议结束时间(毫秒) | 1636451947569 | 无 |
invitees | String数组 | 邀请参会成员列表 | ["zhangsan101","lisi202", "zhaowu111"] | 调用方用于标示用户的唯一 ID列表 |
hosts | String数组 | 指定主持人列表 | ["zhangsan101","lisi202", "zhaowu111"] | 调用方用于标示用户的唯一 ID列表 |
defaultMute | Boolean | 所有人加入会议时静音 | false:不静音;true:静音 | 无 |
defaultCloseCamera | Boolean | 所有人加入会议时关闭视频 | false:不关闭视频;true:关闭视频 | 无 |
onlyInvitees | Boolean | 仅受邀用户可参会 | false:全部用户可入会;true:仅受邀用户可参会 | 无 |
applicationIds | String数组 | 应用ID列表 | ["peixun","yanjiang"] | 无 |
link | String | 入会链接 | “https://api.meeting.streamlake.com/xxxxxxxxxxxxx” | 点击该链接可以进入会议 |