创建云会议
新建会议
1. 接口描述
接口名称:
https://openapi.quanshi.com/conference/conference/reservConference2
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appId | 否 | int | 应用ID,请传6 |
appKey | 否 | string | 客户唯一标识 |
userId | 否 | int | 主持人用户ID ,userId与email不要同时为空 |
否 | string | 主持人邮箱地址(支持不能提供userId但是通过该邮箱获得userId) | |
title | 是 | string | 会议主题 |
length | 是 | int | 会议时长,分钟为单位 |
starttime | 是 | string | 会议开始时间(格式为2013-05-30 14:41:20) |
seting | 否 | json string | 参会人设置 |
from | 否 | string | 预约会议的来源,比如"uc" |
cycle | 否 | string | 周期会议标识,0:默认值,非周期会议,2:周期会议 |
isShowInfo | 否 | int | 是否公开参会人列表(0:否,1:是) |
isShowVideo | 否 | int | 是否开放参会人共享视频权限(0:否,1:是) |
showVideo | 否 | int | 是否开放参会人共享视频权限(0:否,1:是) |
isAllowUnmute | 否 | int | 是否允许参会人自我解除静音(0:否,1:是) |
allowUnmute | 否 | int | 是否允许参会人自我解除静音(0:否,1:是) |
isOnly | 否 | int | 是否针对本场会议的设置(0:否,1:是) |
showInfo | 否 | int | 是否公开参会人列表(0:否,1:是) |
inviteeList | 否 | 数组 | 被邀请的参会人列表,没有参会人是,请保证是空数组,不要使用空字符串 |
email_notify | 否 | bool | 参会人邮件通知(false:否,true:是)主持人邮件不受影响 |
sms_notify | 否 | bool | 参会人短信通知(false:否,true:是)主持人短信不受影响 |
password_type | 否 | int | 密码类型(0:固定密码 1:安全密码) |
autoRecord | 否 | int | 0:不自动录音,1:自动录音,默认0 |
confLevelMute | 否 | int | 1:会议级别允许参会人解除静音 2:会议级别不允许参会人自我解除静音 非必填项,不传值默认为0 |
estimateSize | 否 | int | 预计邀请人数 |
recordCallbackUrl | 否 | string | 录制完成回调URL |
mustSelectAudio | 否 | int | 0: 用户可以关闭音频选择框 (默认值) 1: 用户不能关闭音频选择框(如果api传入这个值,这个用户即使有其他端已经入会并连入音频,还是会让他选择音频) |
autoVideo | 否 | int | 0: 不自动开启视频(默认值) 1: 自动开启视频 |
confLevelVideoStandard | 否 | int | 会议级别视频清晰度 1:标清,2:高清,4:超清 选填,默认0表示未设置 |
extend | 否 | string | 参会人邮箱后缀扩展字段,支持当参会人为非邮箱格式时,拼接此扩展字段设定有效邮箱。 例如:参会人中某一数据为“zhangsan”,该扩展字段为“quanshi.com”或者“@quanshi.com”,则拼接后的实际参会人邮箱为“zhangsan@quanshi.com” |
liveOpenFlag | 否 | int | 是否开启直播,0: 不开启(默认值) 1: 开启 |
livePassword | 否 | string | 直播密码 |
enableCloudMCU | 否 | int | 0:老版本(默认) 1:云会议新版本,表示启用云MCU |
sv | 否 | int | 默认0,若enableCloudMCU为1,则sv的值必须大于等于100 |
joinLogin | 否 | int | 参会人入会必须登录 0:不需要登录(默认)1:需要登录 |
useWaitingRoom | 否 | int | 是否开启等候室的开关,0:否,1:是 默认0 |
summary | 否 | string | 备注 |
periodEndDate | 否 | string | 周期会议结束日期 格式:2018-12-30 |
openWatchword | 否 | int | 是否开启入会口令 ,0:否,1:是,默认0 |
eventWatchword | 否 | string | 入会口令 |
callbackUrl | 否 | string | 语言转文字完成回调URL |
参数:inviteeList
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
userId | 否 | uint64 | 用户名 |
否 | string | 邮箱 ,userId没有传递的情况下,email和mobile 必传一个 | |
mobile | 否 | string | 手机号 |
3. 示例
传参示例
{
"cycle": 0,
"appId": 6,
"email_notify": true,
"length": 120,
"sms_notify": false,
"starttime": "2020-09-07 20:00:00",
"from": "uc",
"title": "测试%",
"userId": 81299515,
"password_type": "0",
"inviteeList": [{
"name": "dtest04",
"email": "dtest04@quanshitest.com",
"mobile": "",
"cId": 0,
"groupName": "",
"groupId": ""
}],
"inviteeGroupList": [],
"recordCallbackUrl": "http://134.com",
"extraInfo": {
"joinMethod": {
"box": 0,
"hardwareVideo": 1,
"lync": 0
}
}
}
返回示例
{
"status": 0,
"result": {
"conferenceId": "239139091",
"pcode1": "201501000033329181",
"pcode2": "201501000033329182",
"userId": 81299515,
"conferenceTitle": "\u6d4b\u8bd5%",
"billingCode": "93712151",
"billingcode": "93712151",
"startTime": "2020-09-08 20:00:00",
"endTime": "2020-09-08 22:00:00",
"length": 120,
"status": 1,
"creatorAccount": "eyh1@test1.com",
"creatorName": "eyh1",
"location": "",
"currentTime": "2020-09-08 15:23:34",
"title": "\u9080\u8bf7\u60a8\u53c2\u52a0eyh1\u7684\u4f1a\u8bae",
"dTitle": "\u6d4b\u8bd5%",
"hostname": "eyh1",
"desc": "201501000033329182",
"host": "eyh1",
"hostConferenceUrl": "http:\/\/mtest.qsh1.cn\/k\/NJu0FajedAo",
"attendeeJoinUrl": "http:\/\/mtest.qsh1.cn\/k\/NJu0Fq5Dq9o",
"informType": 0,
"from": "uc",
"hostMobile": "",
"email_notify": true,
"h323Ip": ["192.168.37.91"],
"startTimeUnix": 0,
"endTimeUnix": 0,
"usedConfTickets": 0,
"wcallUrl": "https:\/\/dwz.cn\/BbvIBxtz",
"hostConferenceLongUrl": "http:\/\/mtest.qsh1.cn\/k\/NJu0FajedAo",
"attendeeJoinLongUrl": "http:\/\/mtest.qsh1.cn\/k\/NJu0Fq5Dq9o"
},
"msg": "conferenceserver-192.168.35.230-1599549814.204008317.9",
"request_id": "confopenapiserver-192.168.28.45-1599549813.881554224.81",
"timestamp": 1599549813881,
"callSeq": "",
"content_type": "application/json",
"request_duration": "626.841849ms"
}
4. 返回参数
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
result | json字符串 | 预约会议返回的结果 |
返回result参数说明
参数名 | 类型 | 说明 |
---|---|---|
conferenceId | string | 预约会议ID |
pcode1 | string | 会议主持人密码 |
pcode2 | string | 会议参会人密码 |
userId | uint64 | 主持人userId |
conferenceTitle | string | 会议标题 |
billingcode | string | 会议billingCode |
billingCode | string | 会议billingCode |
startTime | string | 会议开始时间 |
endTime | string | 会议结束时间 |
length | int64 | 会议时长 |
creatorAccount | string | 创建者账号 |
creatorName | string | 创建者名字 |
currentTime | string | 创建时间 |
title | string | 邮件邀请标题 |
dTitle | string | 会议标题 |
hostName | string | 主持人姓名 |
desc | string | 描述 |
host | string | 主持人账号 |
hostConferenceUrl | string | 主持人入会连接 |
attendeeJoinUrl | string | 参会人入会链接 |
hostConferenceLongUrl | string | 主持人入会连接 |
attendeeJoinLongUrl | string | 参会人入会链接 |
email_notify | boolean | 是否发送邮件 |
informType | int64 | 通知类型 |
from | string | 来源 |
hostMobile | string | 主持人手机 |
email_notify | bool | 邮件通知,true:是,false:否 |
h323Ip | array | 硬件视频ip地址,数组类型 |
startTimeUnix | int64 | 会议开始时间unix时间戳 |
endTimeUnix | int64 | 会议结束时间unix时间戳 |
usedConfTickets | int64 | 返回的消耗会议券数量 |
wcallUrl | string | 电话会议入会连接 |
pullPwd | string | 直播密码(依赖传参与传参中的一致原密码返回,无直播时该字段不返回) |
pullUrl | string | 直播链接(无直播时该字段不返回) |
callbackUrl语音转文字回调示例
{
"method":"speachtotxtready",
"timestamp":1661305648971,
"msgId":"74097A40-5EDC-8CDC-8E46-732E1411FE9E",
"siteId":82851,
"customerCode":"990003",
"speachtxt":{
"confId":"22062882",//会议id
"billingCode":"43845936",
"hostId":12593106, //主持人id
"tempConferenceId":"671399984",
"sttDownLoadUrl":"https://rackbeta.qsh1.cn/resources/20220824/671399984/downloadzip/def51434a5a4451fb364d42182cde84.txt"
}
}
备注
- 更多返回错误代码请看首页的错误代码描述