编辑云会议

编辑云会议

1. 接口描述

接口名称:

https://openapi.quanshi.com/conference/conference/updateReservConference

发送方式:

POST

参数格式:

accept: application/json;content-type: application/json

2. 输入参数

参数名 必选 类型 说明
appId int 应用ID,请传6
appKey string 客户唯一标识
userId int 主持人用户ID (userId不传递时email必传)
email string 主持人邮箱地址(支持不能提供userId但是通过该邮箱获得userId)
conferenceId string 会议ID
title string 会议主题
length int 会议时长,分钟为单位
starttime string 会议开始时间(格式为2013-05-30 14:41:20)
seting json string 参会人设置
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 直播密码
AllowInvite int 显示邀请参会人按钮, 1:显示(默认) 0:不显示
hardwareVideo int 是否有硬件视频入会(0:无,默认,1:有)
enableCloudMCU int 0:老版本(默认) 1:云会议新版本,表示启用云MCU,若在预约会议时传递了1,则此时编辑会议时必须传1,否则在入会时无法启用云MCU
sv int 客户端新版标识,默认0,若enableCloudMCU为1,则sv的值必须大于等于100
joinLogin int 参会人入会必须登录 0:不需要登录(默认)1:需要登录
useWaitingRoom int 是否开启等候室的开关,0:否,1:是 默认0
summary string 备注
openWatchword int 是否开启入会口令 ,0:否,1:是,默认0
eventWatchword string 入会口令

参数:inviteeList

参数名 必选 类型 说明
userId uint64 用户名
email string 邮箱 ,userId没有传递的情况下,email和mobile 必传一个
mobile string 手机号

3. 示例

传参示例

{
    "appId": "6",
    "userName": "cx084@qs.com",
    "password": "2020194374",
    "hostUserId": "4307081 ",
    "userId": "4307081",
    "title": "线下OpenAPi测试会议",
    "length": "60",
    "starttime": "2020-07-07T14:30:00",
    "conferenceId": "2797368",
    "seting": {
        "isShowInfo": "true",
        "isShowVideo": "true",
        "isOnly": "true",
        "isAllowUnmute": "true"
    },
    "isShowInfo": "true",
    "isOnly": "true",
    "email_notify": "true",
    "sms_notify": "true",
    "password_type": "1",
    "callbackUrl": "reservConference",
    "autoRecord": "0",
    "informType": 3,
    "extend": "wanda.com",
    "inviteeList": [{
        "mobile": "",
        "email": "bing.shao@quanshi.com"
    }]
}

返回示例

{
    "status": 0,
    "result": {
        "conferenceId": "239138209",
        "pcode1": "201501000033328907",
        "pcode2": "201501000033328908",
        "userId": 81299515,
        "conferenceTitle": "\u6d4b\u8bd5%",
        "billingCode": "93711915",
        "billingcode": "93711915",
        "startTime": "2020-09-07 20:00:00",
        "endTime": "2020-09-07 22:00:00",
        "length": 120,
        "status": 1,
        "creatorAccount": "eyh1@test1.com",
        "creatorName": "eyh1",
        "location": "",
        "currentTime": "2020-09-07 17:27:03",
        "title": "\u9080\u8bf7\u60a8\u53c2\u52a0eyh1\u7684\u4f1a\u8bae",
        "dTitle": "\u6d4b\u8bd5%",
        "hostname": "eyh1",
        "desc": "201501000033328908",
        "host": "eyh1",
        "hostConferenceUrl": "http:\/\/mtest.qsh1.cn\/k\/NJTMteq20Xg",
        "attendeeJoinUrl": "http:\/\/mtest.qsh1.cn\/k\/NJTMt0axYaN",
        "informType": 0,
        "from": "uc",
        "hostMobile": "",
        "email_notify": true,
        "h323Ip": ["192.168.37.91"],
        "startTimeUnix": 0,
        "endTimeUnix": 0,
        "usedConfTickets": 0,
        "wcallUrl": "https:\/\/dwz.cn\/8TWBelgG",
        "hostConferenceLongUrl": "http:\/\/mtest.qsh1.cn\/k\/NJTMteq20Xg",
        "attendeeJoinLongUrl": "http:\/\/mtest.qsh1.cn\/k\/NJTMt0axYaN"
    },
    "msg": "conferenceserver-192.168.35.230-1599470823.522894231.559",
    "request_id": "confopenapiserver-192.168.28.45-1599470823.419064538.847",
    "timestamp": 1599470823419,
    "callSeq": "",
    "content_type": "application/json",
    "request_duration": "582.192866ms"
}

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 电话会议入会连接

备注

  • 更多返回错误代码请看首页的错误代码描述