创建云会议
创建云会议(支持会议室)
1. 接口描述
接口名称:
/confopenapi/room/reservConference
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
Http Header
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
token | 是 | 接口调用鉴权参数 | 也可以放在http body中 |
Http Body
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
userId | 否 | int | 主持人用户ID(userId不传递时,必须传递email) |
否 | string | 主持人邮箱地址(支持不能提供userId但是通过该邮箱获得userId) | |
title | 是 | string | 会议主题 |
length | 是 | int | 会议时长,分钟为单位 |
starttime | 是 | string | 会议开始时间(格式为2013-05-30 14:41:20) |
summary | 否 | string | 备注 |
callbackUrl | 否 | string | 接口回调地址 |
participantsLists | 否 | string | 参会人列表,包括两种:UMS UserId和外部Email,用分号分隔;例子 "participantsLists":"kai.zhang_5@quanshi.com;81422209", 如果传递邮箱, 视为外部参会人 |
liveOpenFlag | 否 | int | 是否开启直播,0: 不开启(默认值) 1: 开启;(账号必须有直播权限才可以预约出有直播的会议) |
livePassword | 否 | string | 直播密码 |
joinLogin | 否 | int | 参会人入会必须登录 0:不需要登录(默认)1:需要登录 |
useWaitingRoom | 否 | int | 是否开启等候室的开关,0:否,1:是 默认0 |
openWatchword | 否 | int | 是否开启入会口令 ,0:否,1:是,默认0 |
eventWatchword | 否 | string | 入会口令 |
confMode | 否 | int | 会议类型 0:视频会议(默认)1:数据会议 |
isGnet | 否 | int | 是否使用云会议,0:不使用(现场会),1:使用(默认1) |
joinConfSelTag | 否 | int | 是否开启入会选择标签配置,0:否,1:是,默认0 |
joinConfTags | 否 | string | 入会标签字符串,若joinConfSelTag=1,joinConfTagList不允许为空,标签之间用英文逗号区分,如“aa,bb” |
hide | 否 | int | 会议室设备上是否隐藏会议主题 0:显示会议主题(默认) 1:隐藏会议主题 |
reservDevices | 否 | int | 选了会议室时候,设备上是否显示会议 0:显示(默认),1:不显示 |
cycle | 否 | string | 是否是周期会议,0:否,1:是 |
repeatEndDate | 否 | int | 周期会议截止时间,秒 |
cycleRole | 否 | Object | —-周期规则—- |
composeRoomList | 否 | Object | 会议室信息 |
participants | 否 | Array | 参会人信息 |
calExtraInfo | 否 | Object | 会议预约其它参数 |
confNodeType | 否 | int | 会议节点类型 0:保密会议 1:标准会议 |
autoVideo | 否 | int | 视频入会,0:入会时不自动开启视频,1:入会时自动开启视频,2-自由开关 |
calExtraInfo参数说明
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
btplId | 否 | int | 业务模版ID |
eventHostSecret | 否 | string | 主持人秘钥, 最小长度6位 |
confMute | 否 | int | 入会全体静音,0:关闭 ,1:打开 |
autoRecord | 否 | int | 入会录制控制,0:手动开启录制,1:自动开启录制 |
relieveMute | 否 | int | 会议解除静音,0:仅主持人才能解除,1:允许参会人自己解除 |
videoControl | 否 | int | 会中视频共享权限,1是主持人控制,2是参会人自由控制 |
customStr | 否 | Object | 用户自定义字段,可以为JSON或者字符串等 |
roomType | 否 | int | 会议室提供方 0:全时(默认) 1:wps |
participants 参数说明
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
userId | 否 | string | 被邀请人全时用户ID, 类型为字符串类型 |
roleId | 否 | int | 被邀请人会中角色ID |
userType | 否 | int | 用户类型 1:内部用户 2:邮箱 3: 手机 4:微信 |
cycleRole结构
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
frequency | 否 | string | 重复频率,日/周/月, "daily","weekly","monthly" |
interval | 否 | int | 间隔次数 |
byday | 否 | string | 哪一天,MO,TU,WE,TH,FR,SA,SU |
bymonthday | 否 | string | 日期,当frequency=monthly 时候,定义 |
cycleRole参数示例:
"cycleRole":{
"frequency":"weekly",
"interval":1,
"byday":"MO,WE"
}
"cycleRole":{
"frequency":"monthly",
"interval":1,
"bymonthday":"1,17,19"
}
composeRoomList结构
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
roomId | 否 | int | 会议室id |
isMainRoom | 否 | int | 会议室类型,0:默认值,1:主会场,2:分会场 |
thirdRoomId | 否 | string | 第三方会议室ID |
composeRoomList参数示例:
"composeRoomList":[
{
"roomId":6518,
"thirdRoomId":"44740"
},
{
"roomId":6515,
"isMainRoom":1,
"thirdRoomId":"44740"
}]
3. 示例
传参示例
{
"composeRoomList": [ {
"roomId":10935,
"isMainRoom":1
}],
"userId" : 88415897,
"starttime":"2021-09-15 19:00:00",
"title" :"测试222",
"length" : 30,
"calExtraInfo":{"btplId":179005},
"participants":[
{"userId":"88894206", "roleId":1001},
{"userId":"88894205", "roleId":1003}
]
}
4. 返回参数
参数名 | 类型 | 说明 |
---|---|---|
status | int | 0:成功,非0失败 |
result | json字符串 | 预约会议返回的结果 |
返回result参数说明
参数名 | 类型 | 说明 |
---|---|---|
conferenceId | string | 预约会议ID |
eventId | string | 预约会议对应的日程ID |
pcode1 | string | 会议主持人密码 |
pcode2 | string | 会议参会人密码 |
userId | uint64 | 主持人userId |
title | string | 会议标题 |
billingCode | string | 会议billingCode |
startTime | string | 会议开始时间 |
endTime | string | 会议结束时间 |
length | int64 | 会议时长 |
hostName | string | 主持人姓名 |
hostJoinUrl | string | 主持人入会连接 |
joinHostUrl | string | 联席主持人入会连接 |
attendeeJoinUrl | string | 参会人入会链接 |
hostMobile | string | 主持人手机 |
h323Ip | array | 硬件视频ip地址,数组类型 |
wcallUrl | string | 电话会议入会连接 |
livePullUrl | string | 直播连接 |
livePullPwd | string | 直播密码 |
btplRole | Array | 专业活动模版信息 |
btplRole 参数说明
参数名 | 类型 | 说明 |
---|---|---|
managerType | int | 管理类型 1:管理者,2:辅助管理者(联席主持人),3:参会人 |
roleId | int | 角色ID |
roleName | string | 角色ID |
link | string | 入会链接 |
返回示例
{
"status": 0,
"result": {
"conferenceId": "239825215",
"pcode1": "201501000037728203",
"pcode2": "201501000037728204",
"billingcode": "95515214",
"eventId": 645538,
"attendeeJoinUrl": "https://ntest.qsh1.cn/k/mLF752QR2DN",
"hostJoinUrl": "https://ntest.qsh1.cn/k/mLF75A7AkGa",
"wcallurl": "https://stest.qsh1.cn/a/IRHlQiRUuTpYXBC5656",
"userId": 88610840,
"createAccount": "pxytest34@pxy.quanshi.com",
"hostName": "裴晓潇",
"hostMobile": "11232131223",
"startTime": "2023-11-15 12:29:09",
"endTime": "2023-11-15 13:29:09",
"length": 60,
"status": 1,
"title": "2023-11-15 12:29:09 会议",
"h323Ip": [
"192.168.37.91"
],
"confMode": 0,
"livePullUrl": "",
"livePullPwd": "",
"btplRole": [
{
"managerType": 1,
"roleId": 1000,
"link": "https://stest.qsh1.cn/a/HVA0iXD198CC",
"roleName": "采购代理"
},
{
"managerType": 2,
"roleId": 1001,
"link": "https://stest.qsh1.cn/a/GVA0iX4C0C60",
"roleName": "监管人员"
},
{
"managerType": 3,
"roleId": 1003,
"link": "https://stest.qsh1.cn/a/FVA0iXF52763",
"roleName": "评标专家"
},
{
"managerType": 2,
"roleId": 1004,
"link": "https://stest.qsh1.cn/a/EVA0iX1A3A82",
"roleName": "监控接入端"
}
]
},
"request_id": "confopenapiserver-10.108.4.9-1700018949.691748600.81",
"reqid": "confopenapiserver-10.108.4.9-1700018949.691748600.81",
"timestamp": 1700018949701,
"request_duration": "7.9528161s"
}
备注
- 更多返回错误代码请看首页的错误代码描述