开发者文档

会议管理

一、创建云会议

简要描述：

  • 创建云会议接口

请求URL：

  • https://openapi.quanshi.com/conference/conference/reservConference2

请求方式：

  • POST

参数：

参数名 必选 类型 说明
appId 否 int 应用ID，请传6
appKey 否 string 客户唯一标识
userId 否 int 主持人用户ID ，userId与email不要同时为空
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 入会口令

参数：inviteeList

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

传参示例

{
    "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"
}

返回参数说明

参数名 类型 说明
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 直播链接（无直播时该字段不返回）

备注

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

二、编辑云会议

简要描述：

  • 编辑云会议接口

请求URL：

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

请求方式：

  • POST

参数：

参数名 必选 类型 说明
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 手机号

传参示例

{
    "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"
}

返回参数说明

参数名 类型 说明
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 电话会议入会连接

备注

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

三、取消云会议

简要描述：

  • 取消云会议接口

请求URL：

  • https://openapi.quanshi.com/conference/conference/cancelReservConference/:appId/ :conferenceId/:language/:userIdEmail/:callbackUrl/:email_notify/:sms_notify

请求方式：

  • GET

参数：

参数名 必选 类型 说明
appId 是 int 应用ID，请传6
conferenceId 是 string 要取消的会议ID
language 否 string 取消会议的邮件通知语言，默认 zh-cn ，（注意：值不传递的时候，路由/还是要有的）
userIdEmail 是 string 会议主持人userId或者邮箱（支持不传递主持人userId，而传递主持人邮箱）
email_notify 否 bool 取消会议是否邮件通知，true:通知，false:不通知
sms_notify 否 bool 取消会议是否短信通知，true:通知，false:不通知

请求示例

https://openapi.quanshi.com/conference/conference/cancelReservConference/6/239130656/Zh-cn/eyh1%40test1.com

返回示例

{
    "status": 0,
    "result": null,
    "msg": "conferenceserver-192.168.35.230-1598338444.890303267.75",
    "request_id": "confopenapiserver-192.168.22.58-1598338443.968339000.89",
    "timestamp": 1598338443968,
    "callSeq": "",
    "content_type": "application/json",
    "request_duration": "1.544086893s"
}

返回参数说明

参数名 类型 说明
status int 0:成功，非0 失败

备注

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

四、获取云会议列表

简要描述：

  • 获取云会议列表接口

请求URL：

  • https://openapi.quanshi.com/conference/business/getConferenceList

请求方式：

  • POST

参数：

参数名 必选 类型 说明
appId 是 int 应用ID，请传6
userId 否 int 获取会议列表账号的userID（userId不传递时，必须传递email）
emailAccount 否 string 账号的电子邮箱,（userId不传递时，必须传递email）
startDate 否 string 获取会议列表的开始时间，不传默认当前时间
endDate 否 string 获取会议列表的结束时间，不传默认当前时间之后3个月

返回示例

{
    "status": 0,
    "result": {
        "totalNum": 1,
        "list": {
            "2020-07-07": [{
                "userId": "4307081",
                "conferenceId": "2797400",
                "conferenceTitle": "\u6d4b\u8bd5%",
                "startTime": "2020-07-07 14:00:00",
                "endTime": "2020-07-07 16:00:00",
                "length": "120",
                "pcode1": "83152555",
                "pcode2": "37193425",
                "status": "1",
                "location": "",
                "from": "",
                "attendeeList": [{
                    "email": "dtest04@quanshitest.com",
                    "mobile": "",
                    "name": "dtest04",
                    "countryNum": "",
                    "extName": "",
                    "extType": "0"
                }],
                "creatorAccount": "bing.shao@quanshi.cn",
                "userName": "\u90b5\u5175",
                "isHost": 1
            }]
        },
        "currentTime": "2020-07-07 13:58:06"
    },
    "content_type": "application\/json"
}

返回参数说明

参数名 类型 说明
status int 0：成功，非0失败
result json字符串 查询结果

返回result参数说明

参数名 类型 说明
totalNum int 查询会议场数
list json 查询会议场数,里面的key值为会议的日期

返回 list 参数说明，里面的key值为会议的日期

参数名 类型 说明
2020-07-07 数组 会议的日期
userId int 主持人userID
conferenceId string 会议ID
conferenceTitle string 会议标题
startTime string 会议开始时间
endTime string 会议结束时间
length string 会议时长
pcode1 int 会议主持人密码
pcode2 int 会议参会人密码
status string 会议状态（1：已创建，2：正在召开，4：已结束，18：已锁定，5：已过期）
location string 会议地点，暂时该字段无用，可以忽略
from string 会议来源
attendeeList json数组 参会人列表
email string 参会人电子邮箱
mobile string 参会人手机号
name string 参会人姓名
countryNum string 参会人手机号国家码
extName string 参会人扩展别名
extType string 参会人扩展类型
creatorAccount string 创建会议账号
userName string 创建会议账号姓名
isHost int 是否主持人
currentTime string 当前时间

备注

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

五、获取云会议基本信息

简要描述：

  • 获取云会议基本信息接口

请求URL：

  • https://openapi.quanshi.com/conference/conference/getConferenceBaseInfoById/6/2797400

请求方式：

  • POST

参数：

参数名 必选 类型 说明
appId 是 int 应用ID
conferenceId 是 string 会议ID

返回示例

{
    "status": 0,
    "result": {
        "userId": "81299515",
        "conferenceTitle": "\u7ebf\u4e0bOpenAPi\u6d4b\u8bd5\u4f1a\u8bae",
        "startTime": "2020-09-04 20:30:00",
        "endTime": "2020-09-04 21:30:00",
        "length": "60",
        "pcode1": "201501000033328565",
        "pcode2": "201501000033328566",
        "conferenceId": "239136921",
        "timezone": "GMT+8\uff0c\u5317\u4eac\uff0c\u91cd\u5e86\uff0c\u4e0a\u6d77\uff0c\u9999\u6e2f\uff0c\u53f0\u5317\uff0c\u65b0\u52a0\u5761\uff0c\u4f69\u65af",
        "tempConferenceId": "",
        "status": "5",
        "location": "",
        "inviteeGroupList": "",
        "from": "uc",
        "billingcode": "93711845",
        "displayName": "eyh1",
        "name": "eyh1",
        "hostJoinUrl": "http:\/\/mtest.qsh1.cn\/k\/NJTwFXgdhKo",
        "attendeeJoinUrl": "http:\/\/mtest.qsh1.cn\/k\/NJTwFD9a6no",
        "total_invitee": "6",
        "invitee": [{
            "groupName": "",
            "email": "longly02@wanda.com",
            "mobile": "",
            "countryNum": "",
            "name": "longly02@wanda.com",
            "isDuring": "0",
            "updateTime": "",
            "cId": "0",
            "extType": "0",
            "extName": ""
        }, {
            "groupName": "",
            "email": "wanda1@wanda.com",
            "mobile": "",
            "countryNum": "",
            "name": "wanda1@wanda.com",
            "isDuring": "0",
            "updateTime": "",
            "cId": "0",
            "extType": "0",
            "extName": ""
        }, {
            "groupName": "",
            "email": "wanda2@wanda.com",
            "mobile": "",
            "countryNum": "",
            "name": "wanda2@wanda.com",
            "isDuring": "0",
            "updateTime": "",
            "cId": "0",
            "extType": "0",
            "extName": ""
        }, {
            "groupName": "",
            "email": "wanda3@wanda.com",
            "mobile": "",
            "countryNum": "",
            "name": "wanda3@wanda.com",
            "isDuring": "0",
            "updateTime": "",
            "cId": "0",
            "extType": "0",
            "extName": ""
        }, {
            "groupName": "",
            "email": "wanda4@wanda.com",
            "mobile": "",
            "countryNum": "",
            "name": "wanda4@wanda.com",
            "isDuring": "0",
            "updateTime": "",
            "cId": "0",
            "extType": "0",
            "extName": ""
        }, {
            "groupName": "",
            "email": "wanda5@wanda.com",
            "mobile": "",
            "countryNum": "",
            "name": "wanda5@wanda.com",
            "isDuring": "0",
            "updateTime": "",
            "cId": "0",
            "extType": "0",
            "extName": ""
        }],
        "currentTime": "2020-09-08 09:53:16",
        "moreAccessNumUrl": "http:\/\/meetnow.quanshi.com\/20180322test2\/conference\/access_number\/6\/81299515.html",
        "accessNum": [{
            "area": "ALL",
            "number": "400-810-5211"
        }, {
            "area": "Beijing",
            "number": "+86(10)5808-4299"
        }],
        "statusInfo": null,
        "extraInfo": null,
        "wcallUrl": "https:\/\/dwz.cn\/dO7DLljN",
        "hardwareLocation": "",
        "hardwareVideoIpList": ["192.168.37.91"],
        "pullUrl": ""
    },
    "msg": "conferenceserver-192.168.35.230-1599529996.171420070.657",
    "request_id": "confopenapiserver-192.168.22.47-1599529996.86422000.847",
    "timestamp": 1599529996086,
    "callSeq": "",
    "content_type": "application/json",
    "request_duration": "1.39344639s"
}

返回参数说明

参数名 类型 说明
status int 0:成功，非0失败
result json字符串 会议信息结果

返回result参数说明

参数名 类型 说明
userId int 主持人用户ID
conferenceId string 会议ID
conferenceTitle string 会议标题
startTime string 会议开始时间
endTime string 会议结束时间
length string 会议时长
pcode1 int 会议主持人密码
pcode2 int 会议参会人密码
status string 会议状态（1：已创建，2：正在召开，4：已结束，18：已锁定，5：已过期）
timezone string 时区信息
tempConferenceId string 临时会议iD
location string 忽略该字段
from string 会议来源
billingcode string 会议BC
displayName string 会议主持人姓名
name string 会议主持人姓名
hostJoinUrl string 会议主持人入会链接
attendeeJoinUrl string 会议参会人入会链接
total_invitee int 会议邀请人数
invitee 数组 会议邀请人数数组

返回invitee参数说明

参数名 类型 说明
groupName string 组名，该字段暂时无用
email string 参会人电子邮箱
mobile string 参会人手机号
name string 参会人姓名
countryNum string 参会人手机号国家码
isDuring string  
updateTime string 更新时间
extType string 参会人扩展类型
extName string 参会人扩展名称
currentTime string 当前时间
moreAccessNumUrl string 更多接入号地址
accessNum 数组 接入号信息
area string 接入号区域
number string 接入号
statusInfo string 状态信息
extraInfo string 扩展信息
wcallUrl string 电话入会短链接
hardwareLocation string  
hardwareVideoIpList 数组 硬件视频接入地址列表
pullUrl 字符串 直播拉流地址

备注

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

六、获取会议状态和会中人数

简要描述：

  • 获取会议状态和会中人数接口

请求URL：

  • https://openapi.quanshi.com/conference/conference/getConfStatus

请求方式：

  • POST

参数：

参数名 必选 类型 说明
appId 是 int 应用ID,请传6
userId 是 int 主持人userId
conferenceId 是 string 会议ID

返回示例

{
    "status": 0,
    "result": {
        "confStatus": 5,
        "attendees": 0,
        "pwdType": 1,
        "mayJoin": 0,
        "advanceHours": "2"
    },
    "msg": "conferenceserver-192.168.35.230-1599532068.812942156.86",
    "request_id": "confopenapiserver-192.168.22.47-1599532068.843353000.81",
    "timestamp": 1599532068843,
    "callSeq": "",
    "content_type": "application/json",
    "request_duration": "443.767051ms"
}

返回参数说明

参数名 类型 说明
status int 0:成功，非0失败
result json字符串 返回结果
confStatus int 会议状态（1：已创建，2：正在召开，4：已结束，18：已锁定，5：已过期）
attendees int 参会人个数
pwdType int 密码类型，0：固定密码，1：动态密码
mayJoin int 是否可以入会，0：否，1：是
advanceHours string 可以提前入会的时间，单位小时

备注

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

七、获取入会链接

简要描述：

  • 获取入会链接接口

请求URL：

  • https://openapi.quanshi.com/conference/launch/joinConference

请求方式：

  • POST

参数：

参数名 必选 类型 说明
appId 是 int 应用ID，请传6
pcode 是 string 会议密码
name 否 string 姓名，可以为邮箱
new_name 否 string 新姓名
conferenceId 否 string 会议ID
nick_name 否 string 别名，替换入会者的名字（可以跟姓名一样）
securityInfo 否 json string 安全信息
参数名 必选 类型 说明
isSecurityLink 否 int 是否需要安全连接， 1： 是， 0： 否， 默认为0
userId 否 int 用户Id，当isSecurityLink=1，userId必填
timeout 否 int 过期时间，单位分钟 默认5分钟
usableCount 否 int 使用次数 默认6次

返回示例

{
    "status": 0,
    "result": "http:\/\/mtest.qsh1.cn\/k\/NJPfc2GYR9k",
    "msg": "conferenceserver-192.168.35.230-1599616466.259709136.932",
    "request_id": "confopenapiserver-192.168.28.45-1599616466.156023296.887",
    "timestamp": 1599616466156,
    "callSeq": "",
    "content_type": "application/json",
    "request_duration": "497.316566ms"
}

返回参数说明

参数名 类型 说明
status int 0：成功，非0失败
result string 入会链接

备注

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

八、获取入会吊起串

简要描述：

  • 获取入会吊起串接口

请求URL：

  • https://openapi.quanshi.com/conference/launch/launchString

请求方式：

  • POST

参数：

参数名 必选 类型 说明
appId 是 int 应用ID，请传6
appKey 是 string 认证用的应用唯一标识，整合时提供
pcode 是 string 会议密码
name 是 string 姓名（可以为邮箱和姓名）
conferenceId 否 string 会议ID
from 否 string 来源，不填默认“uc”
iconUrl 否 string 用户头像,支持jpg和png格式，是一个http链接，比如http://abcd.com/myhead.png

返回示例

{
    "status": 0,
    "result": "tang:///us:meet-e-update-lab.quanshi.com|meet-e-update-lab.quanshi.com/upgradeserver/up:80|80/app:6/skin:1/site:60001/hs:82/aac:1/ahc:1/auv:0/aav:1/pinCode:7310/bpc:1/hwv:0/chwv:0/arc:0/fromTry:0/aasv:0/alo:0/hcv:0/autoET:0/vmh:0/aaum:0/isMax:0/nt:3/pwdType:1/lang:cn/dm:meetnow.quanshi.com/siteUrl:20180322test2.quanshi.com/meetnow/Version:/mv:/needUpdate:0/forceUpdate:0/conf_id:1868643072/aal:8|7|12|9|35|14|11|6/cid:239131342/huid:81299515/puid:81299515/user_id:888461427/fuc:1/rc:0/dpm:e/vmit:0/rec:1/productType:1/ums_user_id:81299515/userStatus:82/account:0/showAttInfo:1/autoRec:0/mustSelectAudio:0/autoVideo:0/customerCode:020880/inviteeSize:1/confscalePC:1200/confscalePSTN:400/isSeegle:0/videoStandardSet:1/mpm:0/swb:1/cm:0/businessModel:1/docShareServerUrl:https://confdlprint.quanshi.com/video:1/monitor:0/raiseHand:1/rollCall:1/audioRec:0/lock:1/chat:1/translate:1/shareDesktop:1/shareDoc:1/sharePhoneDesktop:1/sync:1/showSpeaker:1/asd:1/summary:1/confSet:1/videoConferenceMode:0/callin:1/callCountryCode:86/feedback:1/remoteVideoConferenceRoom:0/remoteVideoConferenceRoomType:0/scaleThreshold:500/accountSurvey:1/conferencePartySurvey:1/loginStatus:1/fromProduct:uc/multichannelVideo:0/videoControl:0/watermark:0/enableDoc:1/enableWhiteboard:0/meetingAllowExternal:1/isViewHD:0/afterConferenceMarketingMaxNumber:3/afterConferenceMarketing:0/hasTimebook:1/afterConferenceMarketingUrl:https://meetservicem.quanshi.com/mkt/register.html/autoConnectVoipVoice:0/siteId:80606/fromProductId:20/productStatus:62/pcode:201501000033327369/mcuJoinMode:0/cts_ip:192.168.35.94-test-e-cts1.quanshi.com|123.127.19.47/dts_ip:192.168.35.94-test-e-dts1.quanshi.com/channel_info:1|11695225|77008|11695232|77015|258|11695219|77002|11695226|77009|259|11695220|77003|11695227|77010|516|11695224|77007|11695231|77014|775|11695223|77006|11695230|77013|776|11695221|77004|11695228|77011|777|11695222|77005|11695229|77012/conferenceConfig:0/live:0/callMcu:0/ds_zip_ratio:0/recordFile:0",
    "msg": "conferenceserver-192.168.35.230-1598412220.217265088.596",
    "request_id": "confopenapiserver-192.168.22.58-1598412220.490351000.162",
    "timestamp": 1598412220490,
    "callSeq": "",
    "content_type": "application/json",
    "request_duration": "596.626672ms"
}

返回参数说明

参数名 类型 说明
status int 0:成功，非0失败
result sting 入会吊起串

备注

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

九、获取录制文件回放地址

简要描述：

  • 获取录制文件回放地址

请求URL：

  • https://openapi.quanshi.com/conference/movie/getConfReplay

请求方式：

  • POST

参数：

参数名 必选 类型 说明
appId 是 int 应用ID，请传6
email 是 string数组 邮箱数组（获取该邮箱下所有已结束的会议列表）(不能超过10个)
dateTime 否 string 指获取哪天的会议记录，格式： (YYYY-mm-dd~YYYY-mm-dd)（最大可获取14天）,不填默认取当天的会议记录

请求示例

{
    "appId": 6,
    "dateTime": "",
    "email": ["xmlpay16@hys.com"]
}

返回示例

{
    "status": 0,
    "result": {
        "xmlpay16@hys.com": [{
            "userId": "81705619",
            "conferenceId": "1060282",
            "tempConferenceId": "1868782592",
            "startTime": "2020-08-27 10:56:44",
            "endTime": "2020-08-27 11:56:44",
            "length": "60",
            "pwdType": "0",
            "informType": "3",
            "pcode1": "2020255379",
            "pcode2": "2020255380",
            "status": "4",
            "conferenceTitle": "xmlpay16的会议",
            "hasReport": "1",
            "isReportReady": "1",
            "hasRecord": "1",
            "isRecordConvertReady": "1",
            "realStartTime": "2020-08-27 10:56:44",
            "realEndTime": "2020-08-27 10:59:29",
            "replayUrl": "https://rtest.qsh1.cn/rec/page?id=20200827hh8d49343922960fj74",
            "downloadUrl": "https://rtest.qsh1.cn/resources/20200827/1868782592/downloadzip/xmlpay16的会议_20200827105645.mp4",
            "recordDownUrl": "https://rtest.qsh1.cn/resources/20200827/1868782592/downloadzip/xmlpay16的会议_20200827105645.mp4",
            "recordUrl": "https://rtest.qsh1.cn/resources/20200827/1868782592/downloadzip/xmlpay16的会议_20200827105645.mp4",
            "reportDownUrl": "https://uniform.quanshi.com/rest/conference/report/download/1868782592"
        }, {
            "userId": "81705619",
            "conferenceId": "1060281",
            "tempConferenceId": "1868780800",
            "startTime": "2020-08-27 10:55:42",
            "endTime": "2020-08-27 11:55:42",
            "length": "60",
            "pwdType": "0",
            "informType": "3",
            "pcode1": "2020255379",
            "pcode2": "2020255380",
            "status": "4",
            "conferenceTitle": "xmlpay16的会议",
            "hasReport": "1",
            "isReportReady": "1",
            "hasRecord": "1",
            "isRecordConvertReady": "1",
            "realStartTime": "2020-08-27 10:55:42",
            "realEndTime": "2020-08-27 10:56:40",
            "recordDownUrl": "https://rtest.qsh1.cn/resources/20200827/1868780800/downloadzip/xmlpay16的会议_20200827105542.mp4",
            "recordUrl": "https://rtest.qsh1.cn/resources/20200827/1868780800/downloadzip/xmlpay16的会议_20200827105542.mp4",
            "reportDownUrl": "https://uniform.quanshi.com/rest/conference/report/download/1868780800"
        }, {
            "userId": "81705619",
            "conferenceId": "1060280",
            "tempConferenceId": "1868778752",
            "startTime": "2020-08-27 10:50:02",
            "endTime": "2020-08-27 11:50:02",
            "length": "60",
            "pwdType": "0",
            "informType": "3",
            "pcode1": "2020255379",
            "pcode2": "2020255380",
            "status": "4",
            "conferenceTitle": "xmlpay16的会议",
            "hasReport": "1",
            "isReportReady": "1",
            "hasRecord": "1",
            "isRecordConvertReady": "1",
            "realStartTime": "2020-08-27 10:50:02",
            "realEndTime": "2020-08-27 10:55:38",
            "recordDownUrl": "https://rtest.qsh1.cn/resources/20200827/1868778752/downloadzip/xmlpay16的会议_20200827105003.mp4",
            "recordUrl": "https://rtest.qsh1.cn/resources/20200827/1868778752/downloadzip/xmlpay16的会议_20200827105003.mp4",
            "reportDownUrl": "https://uniform.quanshi.com/rest/conference/report/download/1868778752"
        }, {
            "userId": "81705619",
            "conferenceId": "1060279",
            "tempConferenceId": "1868778240",
            "startTime": "2020-08-27 10:49:17",
            "endTime": "2020-08-27 11:49:17",
            "length": "60",
            "pwdType": "0",
            "informType": "3",
            "pcode1": "2020255379",
            "pcode2": "2020255380",
            "status": "4",
            "conferenceTitle": "xmlpay16的会议",
            "hasReport": "1",
            "isReportReady": "1",
            "hasRecord": "1",
            "isRecordConvertReady": "1",
            "realStartTime": "2020-08-27 10:49:17",
            "realEndTime": "2020-08-27 10:49:59",
            "recordDownUrl": "https://rtest.qsh1.cn/resources/20200827/1868778240/downloadzip/xmlpay16的会议_20200827104917.mp4",
            "recordUrl": "https://rtest.qsh1.cn/rec/page?id=20200827hh8d49343922960fj74",
            "reportDownUrl": "https://uniform.quanshi.com/rest/conference/report/download/1868778240"
        }, {
            "userId": "81705619",
            "conferenceId": "1060278",
            "tempConferenceId": "1868992000",
            "startTime": "2020-08-27 10:48:20",
            "endTime": "2020-08-27 11:48:20",
            "length": "60",
            "pwdType": "0",
            "informType": "3",
            "pcode1": "2020255379",
            "pcode2": "2020255380",
            "status": "4",
            "conferenceTitle": "xmlpay16的会议",
            "hasReport": "1",
            "isReportReady": "1",
            "hasRecord": "1",
            "isRecordConvertReady": "1",
            "realStartTime": "2020-08-27 10:48:20",
            "realEndTime": "2020-08-27 10:49:12",
            "recordDownUrl": "https://rtest.qsh1.cn/resources/20200827/1868992000/downloadzip/xmlpay16的会议_20200827104821.mp4",
            "recordUrl": "https://rtest.qsh1.cn/resources/20200827/1868992000/downloadzip/xmlpay16的会议_20200827104821.mp4",
            "reportDownUrl": "https://uniform.quanshi.com/rest/conference/report/download/1868992000"
        }, {
            "userId": "81705619",
            "conferenceId": "1060277",
            "tempConferenceId": "1868983552",
            "startTime": "2020-08-27 10:45:15",
            "endTime": "2020-08-27 11:45:15",
            "length": "60",
            "pwdType": "0",
            "informType": "3",
            "pcode1": "2020255379",
            "pcode2": "2020255380",
            "status": "4",
            "conferenceTitle": "xmlpay16的会议",
            "hasReport": "1",
            "isReportReady": "1",
            "hasRecord": "1",
            "isRecordConvertReady": "1",
            "realStartTime": "2020-08-27 10:45:15",
            "realEndTime": "2020-08-27 10:48:20",
            "recordDownUrl": "https://rtest.qsh1.cn/resources/20200827/1868983552/downloadzip/xmlpay16的会议_20200827104515.mp4",
            "recordUrl": "https://rtest.qsh1.cn/resources/20200827/1868983552/downloadzip/xmlpay16的会议_20200827104515.mp4",
            "reportDownUrl": "https://uniform.quanshi.com/rest/conference/report/download/1868983552"
        }]
    },
    "request_id": "confopenapiserver-192.168.28.45-1598507348.85408098.59",
    "timestamp": 1598507348085,
    "callSeq": "",
    "content_type": "application/json",
    "request_duration": "49.347465ms"
}

返回参数说明

参数名 类型 说明
status int 0：成功 ，非0失败
result json 查询的结果，有查询到的邮箱作为主键的数组
userId int 用户id
conferenceId string 会议ID
tempConferenceId string 临时会议ID
startTime string 会议开始时间
endTime string 会议结束时间
length int 会议时长
pwdType string 会议密码类型，0：固定，1：动态
informType string 会议密码类型，0：固定，1：动态
pcode1 string 会议主持人密码
pcode2 string 会议参会人密码
conferenceTitle string 会议标题
hasReport string 是否有会议报告，0：无，1有
isReportReady string 是否有会议报告已准备就绪，0：无，1有
hasRecord string 是否有会议录制，0：无，1有
isRecordConvertReady string 是否有会议录制准备就绪，0：无，1有
realStartTime string 会议真实开始时间
realEndTime string 会议真实结束时间
recordUrl string 会议录制播放地址
recordDownUrl string 会议录制下载地址
reportDownUrl string 会议报告下载地址

备注

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

十、获取会后报告数据

简要描述：

  • 获取会后报告数据接口

请求URL：

  • https://openapi.quanshi.com/conference/report/getReportData

请求方式：

  • POST

参数：

参数名 必选 类型 说明
appId 是 int 应用ID，请传6
conferenceId 是 string 要获取哪场会议的报告就传递该场会议的conferenceId
userId 是 int 该场会议的主持人的userId

请求示例

{
    "appId": 6,
    "conferenceId": "1231232",
    "userId": 2162625
}

返回示例

{
    "status": 0,
    "result": {
        "summary": {
            "confTitle": "测试会议1",
            "startTime": "2020-08-10 13:31:11 ",
            "endTime": "2020-08-10 15:51:16",
            "totalNum": 2
        },
        "attendees": [{
                "name": "徐杰",
                "groupName": "数据组",
                "mobile": "18766774523",
                "email": " 088413@sf-express.net.cn",
                "role": 0,
                "joinTime": "2020-08-10 14:46:25",
                "offlineTime": "2020-08-10 15:46:35",
                "totalTime": "01:00:10",
                "clientType": "pc",
                "accessType": "voip",
                "ip": "219.130.113.9 13829267807",
                "phoneTime": "",
                "voipTime": "01:00:00"
            },
            {
                "name": "孙海山",
                "groupName": "未分组",
                "mobile": "1391233564",
                "email": "088411@sf-express.net.cn",
                "role": 1,
                "joinTime": "2020-08-10 13:56:44",
                "offlineTime": "2020-08-10 15:51:14",
                "totalTime": "01:54:30",
                "clientType": "phone",
                "accessType": "phone",
                "ip": "1391233564",
                "phoneTime": "01:54:30",
                "voipTime": ""
            }
        ],
        "invitees": [{
                "name": "徐杰",
                "groupName": "数据组",
                "mobile": "18766774523",
                "email": " 088413@sf-express.net.cn",
                "role": 0,
                "joinTime": "2020-08-10 14:46:25",
                "offlineTime": "2020-08-10 15:46:35",
                "totalTime": "01:00:10",
                "clientType": "pc",
                "accessType": "voip",
                "ip": "219.130.113.9 13829267807",
                "phoneTime": "",
                "voipTime": "01:00:00",
                "attend": 1
            },
            {
                "name": "孙海山",
                "groupName": "未分组",
                "mobile": "1391233564",
                "email": "088411@sf-express.net.cn",
                "role": 1,
                "joinTime": "2020-08-10 13:56:44",
                "offlineTime": "2020-08-10 15:51:14",
                "totalTime": "01:54:30",
                "clientType": "pc",
                "accessType": "phone",
                "ip": "1391233564",
                "phoneTime": "01:54:30",
                "voipTime": "",
                "attend": 1
            },
            {
                "name": "邝小军",
                "groupName": "未分组",
                "mobile": "75725566201",
                "email": "088416@sf-express.net.cn",
                "role": 0,
                "joinTime": "",
                "offlineTime": "",
                "totalTime": "",
                "clientType": "",
                "accessType": "",
                "ip": "",
                "phoneTime": "",
                "voipTime": "",
                "attend": 0
            }
        ],
        "live": [{
                "name": "邝小军",
                "mobile": "75725566201",
                "joinTime": "2020-08-05 08:56:12",
                "offlineTime": "2020-08-05 16:16:15",
                "deviceType": "pc",
                "totalTime": "07:45:03",
                "browserName": "Chrome Mobile",
                "ip": "112.251.4.203, 10.90.42.237",
                "city": "中国-北京"
            },
            {
                "name": "孙海山",
                "mobile": "",
                "joinTime": "2020-08-05 07:50:12",
                "offlineTime": "2020-08-05 15:51:15",
                "deviceType": "phone",
                "totalTime": "08:01:03",
                "browserName": "Chrome Mobile",
                "ip": "112.251.4.203, 10.90.42.237",
                "city": "广东-深圳"
            }
        ],
        "handsup": [],
        "invitees": [],
        "live": null,
        "rollcall": [],
        "summary": {
            "attendeePercentage": "",
            "confTitle": "中台早会",
            "endTime": "2021-07-19 10:24:53",
            "handsupCount": 0,
            "handsupPercentage": "",
            "inviteAttendedCount": 0,
            "inviteCount": 0,
            "rollcallAnswer": [],
            "rollcallNum": 0,
            "startTime": "2021-07-19 09:59:48",
            "totalCount": 13,
            "videoRollcallAnswer": [],
            "videoRollcallNum": 0
        },
        "videoRollcall": []
    },
    "msg": "confspaceserver-10.90.158.147-1626661895.95962844.988",
    "request_id": "confopenapiserver-10.90.154.171-1626661895.32156752.375",
    "reqid": "confopenapiserver-10.90.154.171-1626661895.32156752.375",
    "timestamp": 1626661895032,
    "content_type": "application/json",
    "request_duration": "236.98775ms"
}

*返回示例 会议不存在 *

{
    "status": 50709，
    "msg":"conference does not exist  8762238 or get conference failed",
    "content_type": "application/json"
}

返回参数说明

参数名 类型 说明
stauts int64 0:成功，其他值：失败
summary array 会议概览
confTitle string 会议标题
startTime string 会议开始时间
endTime string 会议结束时间
totalCount int 入会人数(去除了重复入会次数)
inviteCount int 邀请人数
inviteAttendedCount int 邀请人的入会人数
attendeePercentage string 出席率，inviteAttendedCount/inviteCount:"14%"
rollcallNum int 签到点名次数
rollcallAnswer array 签到点名应答详情-见签到点名详情
videoRollcallNum int 视频点名次数
videoRollcallAnswer array 视频点名应答详情-见签到点名详情
handsupCount int 举手人数
handsupPercentage int 举手人数占比
attendees array 参会人入会明细，见参会人明细
invitees array 邀请人入会信息，见邀请人入会明细
live array 直播明细，见直播明细
rollcall array 签到点名明细，见签到点名明细
videoRollcall array 视频点名明细，见视频点名明细
handsup array 举手明细，见举手明细

签到点名详情

参数名 类型 说明
num int 签到点名应答次数
percentage string 签到点名应答占点名总数的百分比

参会人明细

参数名 类型 说明
name string 名字
groupName string 组名
mobile string 手机
email string 邮箱
role int 0：参会人，1：主持人
joinTime string 入会时间
totalTIme string 入会时长
offlineTime string 离会时间
clientType string pc，phone,从手机还是pc端入会
accessType string 语音连接方式：voip：网络语音，phone：电话语音
ip string 用户入会ip地址或者电话，如果用户数据端入会后使用电话语音，还包含了入会的电话号码：“183.186.246.249 17694879663”，如果用户使用电话入会：“17694879663”，显示电话号码，如果用户使用电脑语音，显示ip地址“183.186.246.249”
phoneTime string 电话语音时长
voipTime string 网络语音时长
city string 用户所在地区：国家-城市-区
extType int 扩展类型 0：无（默认） 1：qq，2：微信，3：云直播
extName string 扩展名，和扩展类型配合使用

邀请人入会明细

参数名 类型 说明
attend int 0:未入会，1：出席
name string 名字
groupName string 组名
mobile string 手机
email string 邮箱
role int 0：参会人，1：主持人
joinTime string 入会时间
totalTIme string 入会时长
offlineTime string 离会时间
clientType string pc，phone,从手机还是pc端入会
accessType string 语音连接方式：voip：网络语音，phone：电话语音
ip string 用户入会ip地址或者电话，如果用户数据端入会后使用电话语音，还包含了入会的电话号码：“183.186.246.249 17694879663”，如果用户使用电话入会：“17694879663”，显示电话号码，如果用户使用电脑语音，显示ip地址“183.186.246.249”
phoneTime string 电话语音时长
voipTime string 网络语音时长

直播观看明细

参数名 类型 说明
name string 名字
mobile string 手机
joinTime string 进入时间
offlineTime string 退出时间
totalTime string 观看时长
deviceType string 观看方式：pc或phone
browserName string 观看使用的浏览器
ip string 用户接入ip地址
city string 用户所在地区：国家-城市-区
extInfo array 扩展信息

签到点名明细

参数名 类型 说明
name string 名字
mobile string 手机
email string 邮箱
groupName string 组名
Answered int数组 应答数组，数组长度表示点名的次数，值表示是否应答，0:没有应答，1:应答，比如[0,1],表示点名了2次，第1次未应答，第2次应答。
extType int 扩展类型 0：无（默认） 1：qq，2：微信，3：云直播
extName string 扩展名，和扩展类型配合使用

视频点名明细 同签到点名明细

举手明细

参数名 类型 说明
name string 名字
mobile string 手机
email string 邮箱
groupName string 组名
createTime int 举手时间
extType int 扩展类型 0：无（默认） 1：qq，2：微信，3：云直播
extName string 扩展名，和扩展类型配合使用

备注

十一、获取接入号

简要描述：

  • 获取接入号接口

请求URL：

  • https://openapi.quanshi.com/conference/conference/getPhoneAccessNum

请求方式：

  • POST

参数：

参数名 必选 类型 说明
appKey 是 string 用户名
acFlag 否 string 获取的接入号类型（0：不取专属接入号，1：默认取得专属接入号）
billingCode 否 string BC
phone 是 string 电话号码
strategy 否 string 未取得归属地时的处理策略 （1：默认返回北京接入号）

请求示例

{
    "acFlag": "0",
    "appKey": "598c2c48555672a3579e0c678d395782",
    "billingCode": "",
    "phone": "010-59937429",
    "strategy": "1"
}

返回示例

{
    "status": 0,
    "result": [{
        "accessId": "7135",
        "accessno": "01058858950",
        "accessNoType": "1",
        "platform": "summit2"
    }],
    "request_id": "confopenapiserver-192.168.22.65-1608605836.255003000.162",
    "reqid": "confopenapiserver-192.168.22.65-1608605836.255003000.162",
    "timestamp": 1608605836255,
    "content_type": "application/json",
    "request_duration": "391.441376ms"
}

返回参数说明

参数名 类型 说明
status int 0:成功，非0失败
result 数组 结果数组
accessId string 允许ID
accessno string 允许号码
accessNoType string 允许号码类型
platform string 平台

备注

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

十二、删除录制

简要描述：

  • 删除录制接口

请求URL：

  • https://openapi.quanshi.com/conference/movie/recordsDelete

请求方式：

  • POST

参数：

参数名 必选 类型 说明
appId 是 int 应用ID，默认传6
userId 是 int 会议主持人ums userId
tempConferenceIds 是 stringList 临时会议ID数组，每次最大20场会议

传参示例

{
    "appId": 6,
    "userId": 63873738,
    "tempConferenceIds ": ["5627222221", "89868687677", "2786363689"]
}

返回示例

{
    "status": 0,
    "result": null,
    "msg": "delete record success",
    "request_id": "confopenapiserver-192.168.22.89-1609913798.679475000.81",
    "reqid": "confopenapiserver-192.168.22.89-1609913798.679475000.81",
    "timestamp": 1609913798679,
    "content_type": "application/json",
    "product_type": "",
    "device_type": "",
    "iscycle": "",
    "isgnet": "",
    "mem_count": "",
    "verify": "",
    "video_conference_mode": "",
    "live_flag": "",
    "conferenceid": "",
    "record": 0,
    "share_media": 0,
    "hardware_video": 0,
    "accessNumber": "",
    "client_ip": "",
    "request_duration": "2.77349593s"
}

返回参数说明

参数名 类型 说明
status int 0：成功，非0失败

备注

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

十三、已预约的会议绑定盒子

简要描述：

  • 盒子与已预约会议绑定接口
  • 盒子的客户编码需要与会议主持人的客户编码（customerCode）一致，即盒子与会议主持人在一个客户下
  • 尽量让客户提前将盒子和会议室在会议管理中心进行绑定
  • 每次绑定都会清空该conferenceId之前绑定的所有盒子信息，以本次提交的盒子来绑定会议

请求URL：

  • http://confopenapi.quanshi.com/conference/conference/confBindBox

请求方式：

  • POST

参数：

参数名 必选 类型 说明
boxInfoList 是 数组 盒子ID和会议室ID的绑定对应关系,数组最大长度为20；若boxInfoList为空，表示删除该conferenceId之前绑定的所有盒子
conferenceId 是 字符串 已预约的会议id ，不允许为空

boxInfoList参数：

参数名 必选 类型 说明
boxId 是 string array 盒子id数组（盒子ID必须跟会议主持人在一个客户下，即customerCode相同）
conferenceRoomId 是 int 盒子绑定的会议室ID（如果盒子绑定了会议室传会议室ID，如果没绑定则传0）
conferenceRoomPhone 否 string 会议室电话

请求示例

{
    "boxInfoList": [{
        "boxId": "GN3399BOX0001856",
        "conferenceRoomId": 187567899,
        "conferenceRoomPhone": "010-256567"
    }, {
        "boxId": "GN3399BOX0001429",
        "conferenceRoomId": 187567899,
        "conferenceRoomPhone": "010-256597"
    }, {
        "boxId": "GN3399BOX0001875",
        "conferenceRoomId": 187567999,
        "conferenceRoomPhone": "010-256598"
    }],
    "conferenceId": "239376958"
}

删除会议绑定的盒子请求示例

{
    "boxInfoList": [],
    "conferenceId": "239376700"
}

返回示例(正常)

{
    "status": 0,
    "result": {
        "invalidBoxIdList": [],
        "successBoxIdList": [{
            "boxId": "GN3399BOX0001856",
            "conferenceRoomId": 187567899,
            "conferenceRoomPhone": "010-256567"
        }, {
            "boxId": "GN3399BOX0001429",
            "conferenceRoomId": 187567899,
            "conferenceRoomPhone": "010-256597"
        }, {
            "boxId": "GN3399BOX0001875",
            "conferenceRoomId": 187567999,
            "conferenceRoomPhone": "010-256598"
        }]
    },
    "request_id": "confopenapiserver-192.168.22.47-1610417984.700268000.81",
    "reqid": "confopenapiserver-192.168.22.47-1610417984.700268000.81",
    "timestamp": 1610417984700,
    "content_type": "application/json",
    "product_type": "",
    "device_type": "",
    "iscycle": "",
    "isgnet": "",
    "mem_count": "",
    "verify": "",
    "video_conference_mode": "",
    "live_flag": "",
    "conferenceid": "",
    "record": 0,
    "share_media": 0,
    "hardware_video": 0,
    "accessNumber": "",
    "client_ip": "",
    "request_duration": "1.877526067s"
}

返回示例(传递的盒子全部未通过校验） ---该错误返回中包含盒子的客户编码与会议主持人的客户编码不一致的错误返回的示例)

{
    "status": 51208,
    "result": {
        "invalidBoxIdList": [{
            "boxId": "GN3399BOX0001856",
            "conferenceRoomId": 187567899,
            "conferenceRoomPhone": "010-256567",
            "errMsg": "the customerCode of this boxId: GN3399BOX0001856 difference with conference host's customerCode"
        }, {
            "boxId": "GN3399BOX0001429",
            "conferenceRoomId": 187567899,
            "conferenceRoomPhone": "010-256597",
            "errMsg": "the customerCode of this boxId: GN3399BOX0001429 difference with conference host's customerCode"
        }, {
            "boxId": "GN3399BOX0001875",
            "conferenceRoomId": 187567999,
            "conferenceRoomPhone": "010-256598",
            "errMsg": "the customerCode of this boxId: GN3399BOX0001875 difference with conference host's customerCode"
        }],
        "successBoxIdList": []
    },
    "msg": "the num of valid boxIds is 0",
    "request_id": "confopenapiserver-192.168.22.47-1610417816.588745000.81",
    "reqid": "confopenapiserver-192.168.22.47-1610417816.588745000.81",
    "timestamp": 1610417816588,
    "content_type": "application/json",
    "product_type": "",
    "device_type": "",
    "iscycle": "",
    "isgnet": "",
    "mem_count": "",
    "verify": "",
    "video_conference_mode": "",
    "live_flag": "",
    "conferenceid": "",
    "record": 0,
    "share_media": 0,
    "hardware_video": 0,
    "accessNumber": "",
    "client_ip": "",
    "request_duration": "1.233418452s"
}

返回示例(传递的盒子存在无效的盒子)

{
    "status": 0,
    "result": {
        "invalidBoxIdList": [{
            "boxId": "GN3399BOX0001859",
            "conferenceRoomId": 187567899,
            "conferenceRoomPhone": "010-256567",
            "errMsg": "not found box info by boxId:GN3399BOX0001859"
        }],
        "successBoxIdList": [{
            "boxId": "GN3399BOX0001429",
            "conferenceRoomId": 187567899,
            "conferenceRoomPhone": "010-256597"
        }, {
            "boxId": "GN3399BOX0001875",
            "conferenceRoomId": 187567999,
            "conferenceRoomPhone": "010-256598"
        }]
    },
    "request_id": "confopenapiserver-192.168.22.47-1610418262.235930000.887",
    "reqid": "confopenapiserver-192.168.22.47-1610418262.235930000.887",
    "timestamp": 1610418262235,
    "content_type": "application/json",
    "product_type": "",
    "device_type": "",
    "iscycle": "",
    "isgnet": "",
    "mem_count": "",
    "verify": "",
    "video_conference_mode": "",
    "live_flag": "",
    "conferenceid": "",
    "record": 0,
    "share_media": 0,
    "hardware_video": 0,
    "accessNumber": "",
    "client_ip": "",
    "request_duration": "1.655531488s"
}

返回参数说明

参数名 类型 说明
status int 0:成功，非0失败 （50103：请求的参数不合法；50709：会议不存在；51104：未查到会议主持人账号信息；51101：校验管理员失败，请检查核对使用的证书是否与会议主持人在同一个客户下；51208：传递的所有盒子均为通过校验）
result object 接口返回结果
request_id string 接口请求唯一标识

返回 result 参数说明

参数名 类型 说明
successBoxIdList object 数组 与会议绑定成功的盒子信息
invalidBoxIdList object 数组 与会议未绑定成功的盒子信息

返回 result.successBoxIdList 参数说明

参数名 类型 说明
boxId string array 盒子id数组（盒子ID必须跟会议主持人在一个客户下，即customerCode相同）
conferenceRoomId int 盒子绑定的会议室ID（如果盒子绑定了会议室传会议室ID，如果没绑定则传0）
conferenceRoomPhone string 会议室电话

返回 result.invalidBoxIdList 参数说明

参数名 类型 说明
boxId string array 盒子id数组（盒子ID必须跟会议主持人在一个客户下，即customerCode相同）
conferenceRoomId int 盒子绑定的会议室ID（如果盒子绑定了会议室传会议室ID，如果没绑定则传0）
conferenceRoomPhone string 会议室电话
errMsg string 失败原因

备注

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

十四、创建云会议（支持会议室）

简要描述：

  • 创建云会议接口

请求URL：

  • https://openapi.quanshi.com/confopenapi/room/reservConference

请求方式：

  • POST

参数：

参数名 必选 类型 说明
userId 否 int 主持人用户ID（userId不传递时，必须传递email）
email 否 string 主持人邮箱地址（支持不能提供userId但是通过该邮箱获得userId）
title 是 string 会议主题
length 是 int 会议时长,分钟为单位
starttime 是 string 会议开始时间（格式为2013-05-30 14:41:20）
liveOpenFlag 否 int 是否开启直播,0: 不开启（默认值） 1: 开启；（账号必须有直播权限才可以预约出有直播的会议）
livePassword 否 string 直播密码
participantsLists 否 string 参会人列表，包括两种：UMS UserId和外部Email
autoVideo 否 int 入会是否自动开启视频
joinLogin 否 int 参会人入会必须登录 0:不需要登录(默认）1:需要登录
useWaitingRoom 否 int 是否开启等候室的开关，0：否，1：是 默认0
summary 否 string 备注
openWatchword 否 int 是否开启入会口令 ，0：否，1：是，默认0
eventWatchword 否 string 入会口令
joinConfSelTag 否 int 是否开启入会选择标签配置，0：否，1：是，默认0
joinConfTags 否 string 入会标签字符串，若joinConfSelTag=1，joinConfTagList不允许为空，标签之间用英文逗号区分,如“aa,bb”
cycle 否 string 是否是周期会议，0：否，1：是
repeatEndDate 否 int 周期会议截止时间,秒
cycleRole 否 Object —-周期规则—-
composeRoomList 否 Object 会议室信息，

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：分会场
equipIdList 否 []int 设备id

composeRoomList参数示例：

"composeRoomList":[
    {
        "roomId":6518,
        "equipIdList":[6152]
    },
    {
        "roomId":6515,
        "isMainRoom":1,
        "equipIdList":[6146,6148]
    }]

传参示例

{
     "composeRoomList": [ {
        "roomId":10935,
        "isMainRoom":1,
        "equipIdList":[58933]
    }],
    "userId" : 88415897,
    "sessionId":"8f2458beaa42aaaadfb74ec84fdd6efc2f0af7ee",
    "starttime":"2021-09-15 19:00:00",
    "title" :"王迪的会议测试233",
    "length" : 30,
    "liveOpenFlag":0,
    "livePassword":"",
    "hardwareVideo":1,
    "autoVideo":2

}

返回示例

{
    "status": 0,
    "result": {
        "conferenceId": "239418513",
        "pcode1": "201501000037317973",
        "pcode2": "201501000037317974",
        "billingcode": "95346906",
        "groupId": 80555958,
        "eventId": 524331,
        "attendeeJoinUrl": "https://mtest.qsh1.cn/k/m2ZFS7ogGeT",
        "hostJoinUrl": "https://mtest.qsh1.cn/k/m2ZFSuNQn7e",
        "pullUrl": "",
        "liveViewFlag": 0,
        "livePlaybackFlag": 0,
        "livePlaybackTime": 0,
        "beeAttendeeJoinUrl": "",
        "beeHostJoinUrl": "",
        "confHostId": 0,
        "largeGroup": 0,
        "usedConfTickets": 0,
        "wcallurl": "https://dwz.cn/siMDpAnQ",
        "joinHostUrl": "",
        "guestJoinUrl": "",
        "audienceJoinUrl": "https://mtest.qsh1.cn/k/m2ZFS7ogGeT",
        "audienceUnionUrl": "",
        "userId": 88415897,
        "conferenceTitle": "王迪的会议测试233",
        "billingCode": "95346906",
        "startTime": "2021-09-15 19:00:00",
        "endTime": "2021-09-15 19:30:00",
        "length": 30,
        "status": 1,
        "createAccount": "3d105bd7-2d40-4fdf-9704-01cdb2976753",
        "createName": "php0827_001",
        "currentTime": "2021-09-14 18:29:40",
        "title": "php0827_001",
        "dTitle": "王迪的会议测试233",
        "hostName": "php0827_001",
        "desc": "201501000037317974",
        "host": "php0827_001",
        "hostConferenceUrl": "https://mtest.qsh1.cn/k/m2ZFSuNQn7e",
        "hostMobile": "",
        "h323Ip": [
            "192.168.37.91"
        ],
        "startTimeUnix": 1631703600,
        "endTimeUnix": 1631705400,
        "hostConferenceLongUrl": "https://mtest.qsh1.cn/k/m2ZFSuNQn7e",
        "attendeeJoinLongUrl": "https://mtest.qsh1.cn/k/m2ZFS7ogGeT",
        "email_notify": false
    },
    "request_id": "confopenapiserver-192.168.50.25-1631615374.731526800.847",
    "reqid": "confopenapiserver-192.168.50.25-1631615374.731526800.847",
    "timestamp": 1631615374731,
    "content_type": "application/json",
    "product_type": "",
    "device_type": "",
    "iscycle": "",
    "isgnet": "",
    "mem_count": "",
    "verify": "",
    "video_conference_mode": "",
    "live_flag": "",
    "conferenceid": "",
    "record": 0,
    "share_media": 0,
    "hardware_video": 0,
    "accessNumber": "",
    "client_ip": "",
    "request_duration": "5.7510017s"
}

返回参数说明

参数名 类型 说明
status int 0:成功，非0失败
result json字符串 预约会议返回的结果

返回result参数说明

参数名 类型 说明
conferenceId string 预约会议ID
eventId 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 直播链接（无直播时该字段不返回）

备注

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

十五、编辑云会议（支持会议室）

简要描述：

  • 编辑云会议接口

请求URL：

  • https://openapi.quanshi.com/confopenapi/room/updateReservConference

请求方式：

  • POST

参数：

参数名 必选 类型 说明
eventId 否 int eventId ,和conferenceId 2选1
conferenceId 否 string 会议Id ,和eventId 2选1
userId 否 int 主持人用户ID（userId不传递时，必须传递email）
email 否 string 主持人邮箱地址（支持不能提供userId但是通过该邮箱获得userId）
title 是 string 会议主题
length 是 int 会议时长,分钟为单位
starttime 是 string 会议开始时间（格式为2013-05-30 14:41:20）
liveOpenFlag 否 int 是否开启直播,0: 不开启（默认值） 1: 开启；（账号必须有直播权限才可以预约出有直播的会议）
livePassword 否 string 直播密码
participantsLists 否 string 参会人列表，包括两种：UMS UserId和外部Email
autoVideo 否 int 入会是否自动开启视频
joinLogin 否 int 参会人入会必须登录 0:不需要登录(默认）1:需要登录
useWaitingRoom 否 int 是否开启等候室的开关，0：否，1：是 默认0
summary 否 string 备注
openWatchword 否 int 是否开启入会口令 ，0：否，1：是，默认0
eventWatchword 否 string 入会口令
joinConfSelTag 否 int 是否开启入会选择标签配置，0：否，1：是，默认0
joinConfTags 否 string 入会标签字符串，若joinConfSelTag=1，joinConfTagList不允许为空，标签之间用英文逗号区分,如“aa,bb”
cycle 否 string 是否是周期会议，0：否，1：是
repeatEndDate 否 int 周期会议截止时间,秒
cycleRole 否 Object —-周期规则—-
composeRoomList 否 Object 会议室信息，

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：分会场
equipIdList 否 []int 设备id

composeRoomList参数示例：

"composeRoomList":[
    {
        "roomId":6518,
        "equipIdList":[6152]
    },
    {
        "roomId":6515,
        "isMainRoom":1,
        "equipIdList":[6146,6148]
    }]

修改传参示例

{
    "eventId":524331,
    "conferenceId":"239418513",
     "composeRoomList": [ {
        "roomId":10935,
        "isMainRoom":1,
        "equipIdList":[58934123]
    }],
    "userId" : 88415897,
    "sessionId":"8f2458beaa42aaaadfb74ec84fdd6efc2f0af7ee",
    "starttime":"2021-09-15 18:30:00",
    "title" :"王迪的会议测q1q2q3q4",
    "length" : 40,
    "liveOpenFlag":0,
    "livePassword":""
}

修改返回示例

{
    "status": 0,
    "result": {
        "conferenceId": "239418513",
        "pcode1": "201501000037317973",
        "pcode2": "201501000037317974",
        "billingcode": "95346906",
        "groupId": 80555958,
        "eventId": 524331,
        "attendeeJoinUrl": "https://mtest.qsh1.cn/k/m2ZFS7ogGeT",
        "hostJoinUrl": "https://mtest.qsh1.cn/k/m2ZFSuNQn7e",
        "pullUrl": "",
        "liveViewFlag": 0,
        "livePlaybackFlag": 0,
        "livePlaybackTime": 0,
        "beeAttendeeJoinUrl": "",
        "beeHostJoinUrl": "",
        "confHostId": 0,
        "largeGroup": 0,
        "usedConfTickets": 0,
        "wcallurl": "https://dwz.cn/siMDpAnQ",
        "joinHostUrl": "",
        "guestJoinUrl": "",
        "audienceJoinUrl": "https://mtest.qsh1.cn/k/m2ZFS7ogGeT",
        "audienceUnionUrl": "",
        "userId": 88415897,
        "conferenceTitle": "王迪的会议测试233",
        "billingCode": "95346906",
        "startTime": "2021-09-15 19:00:00",
        "endTime": "2021-09-15 19:30:00",
        "length": 30,
        "status": 1,
        "createAccount": "3d105bd7-2d40-4fdf-9704-01cdb2976753",
        "createName": "php0827_001",
        "currentTime": "2021-09-14 18:29:40",
        "title": "php0827_001",
        "dTitle": "王迪的会议测试233",
        "hostName": "php0827_001",
        "desc": "201501000037317974",
        "host": "php0827_001",
        "hostConferenceUrl": "https://mtest.qsh1.cn/k/m2ZFSuNQn7e",
        "hostMobile": "",
        "h323Ip": [
            "192.168.37.91"
        ],
        "startTimeUnix": 1631703600,
        "endTimeUnix": 1631705400,
        "hostConferenceLongUrl": "https://mtest.qsh1.cn/k/m2ZFSuNQn7e",
        "attendeeJoinLongUrl": "https://mtest.qsh1.cn/k/m2ZFS7ogGeT",
        "email_notify": false
    },
    "request_id": "confopenapiserver-192.168.50.25-1631615374.731526800.847",
    "reqid": "confopenapiserver-192.168.50.25-1631615374.731526800.847",
    "timestamp": 1631615374731,
    "content_type": "application/json",
    "product_type": "",
    "device_type": "",
    "iscycle": "",
    "isgnet": "",
    "mem_count": "",
    "verify": "",
    "video_conference_mode": "",
    "live_flag": "",
    "conferenceid": "",
    "record": 0,
    "share_media": 0,
    "hardware_video": 0,
    "accessNumber": "",
    "client_ip": "",
    "request_duration": "5.7510017s"
}

返回参数说明

参数名 类型 说明
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 电话会议入会连接

备注

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

十六、取消云会议（支持会议室）

简要描述：

  • 取消云会议接口

请求URL：

  • https://openapi.quanshi.com/confopenapi/room/cancelReservConference

请求方式：

  • POST

参数：

参数名 必选 类型 说明
eventId 否 int eventId ,和conferenceId 2选1
conferenceId 否 string 会议Id ,和eventId 2选1
userId 否 int 主持人用户ID（userId不传递时，必须传递email）
email 否 string 主持人邮箱地址（支持不能提供userId但是通过该邮箱获得userId）
shareUserId 否 int 是否是助理，0：否，1：是

传参示例

{
    "userId" : 88415897,
    "conferenceId": "239418513"
}

修改返回示例

{
    "status": 0,
    "result": null,
    "request_id": "confopenapiserver-192.168.50.25-1631780004.395728100.511",
    "reqid": "confopenapiserver-192.168.50.25-1631780004.395728100.511",
    "timestamp": 1631780004395,
    "content_type": "application/json",
    "product_type": "",
    "device_type": "",
    "iscycle": "",
    "isgnet": "",
    "mem_count": "",
    "verify": "",
    "video_conference_mode": "",
    "live_flag": "",
    "conferenceid": "",
    "record": 0,
    "share_media": 0,
    "hardware_video": 0,
    "accessNumber": "",
    "client_ip": "",
    "request_duration": "945.9988ms"
}

返回参数说明

参数名 类型 说明
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 电话会议入会连接

备注

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

十七、获取会议详情（支持会议室）

简要描述：

  • 获取会议详情接口

请求URL：

  • https://openapi.quanshi.com/confopenapi/room/conference/infos

请求方式：

  • POST

参数：

参数名 必选 类型 说明
pcode 否 string 主持人会议密码,pcode ,和conferenceId 2选1
conferenceId 否 string 会议Id ,pcode,和conferenceId 2选1
userId 是 int 主持人用户ID

传参示例

{
    "conferenceId":"239608224",
    "userId":87679779
}

修改返回示例

{
    "status": 0,
    "result": [
        {
            "CreateTime": 1641350988,
            "ExtraMeetingRoom": null,
            "ManagerCustomerCode": "",
            "accessNumberInfo": null,
            "accessNumbers": {
                "ChooseBySelf": [
                    {
                        "area": "北京",
                        "chooseBySelf": 0,
                        "number": "+86(10)5932-1988"
                    },
                    {
                        "area": "上海",
                        "chooseBySelf": 0,
                        "number": "+86(21)3599-4558"
                    }
                ],
                "En-us": [
                    {
                        "area": "ALL",
                        "chooseBySelf": 0,
                        "number": "400-810-8822"
                    },
                    {
                        "area": "Beijing",
                        "chooseBySelf": 0,
                        "number": "+86(10)5851-2020"
                    }
                ],
                "Zh-cn": [
                    {
                        "area": "全国",
                        "chooseBySelf": 0,
                        "number": "400-139-8500"
                    }
                ]
            },
            "addAttendList": null,
            "addDeviceList": [],
            "addMediaList": null,
            "advanceHours": "1",
            "allowBox": 0,
            "allowExternal": 1,
            "allowHardVideo": 1,
            "allowLync": 1,
            "appSource": "meeting",
            "approvalName": "",
            "approvalStatus": 0,
            "approvalUserId": 0,
            "attendList": [
                {
                    "cityCode": "",
                    "companyName": "",
                    "contactId": "",
                    "countryCode": "",
                    "displayName": "",
                    "mobileNumber": "",
                    "officePhone": "",
                    "orgName": "",
                    "phoneEmail": "",
                    "phoneName": "",
                    "productStatus": 1,
                    "status": "W",
                    "user": "87679779",
                    "userProfile": null,
                    "userType": 1
                }
            ],
            "attendeeJoinUrl": "https://mtest.qsh1.cn/k/mkmvH0rno22",
            "audienceJoinUrl": "https://mtest.qsh1.cn/k/mkmvH0rno22",
            "audienceUnionUrl": "https://ltest.qsh1.cn/activity/gdn2MT2",
            "audioConferenceType": 0,
            "authority": null,
            "billingCode": "95374258",
            "calExtraInfo": {
                "allowH323": 0,
                "showAccessNumbers": 0,
                "showWebRTCUrl": 0
            },
            "calType": "E",
            "callbackURL": "",
            "callbackUd": "",
            "capacity": 0,
            "clientOs": "",
            "clientType": 0,
            "confHostId": 0,
            "confMaster": 0,
            "confMode": 0,
            "confNodeType": 1,
            "conferenceId": "239608224",
            "creatorName": "",
            "creatorUserId": 0,
            "customerCode": "153603",
            "delAttendList": null,
            "delDeviceList": [],
            "delMediaList": null,
            "detailHouseList": null,
            "enableCloudMCU": 1,
            "endTime": 1641355200,
            "equipList": [],
            "eventForm": 7,
            "eventId": 545444,
            "eventLive": 0,
            "eventManualService": 0,
            "eventSource": 0,
            "exchangeExternalId": "",
            "exchangeSyncDate": 0,
            "externalFlag": "",
            "extrasInfo": "",
            "groupId": 80571506,
            "guestJoinUrl": "http://stest.qsh1.cn/a/NVv6IX3B8965",
            "guestJoinVerifyUrl": "https://ltest.qsh1.cn/activity/gdn2MT2?role=3",
            "hostId": 87679779,
            "hostJoinUrl": "https://mtest.qsh1.cn/k/mkmvHYkjYRT",
            "hostName": "分流测试1",
            "hostsLayout": "",
            "houseList": [],
            "importance": 0,
            "isGnet": 1,
            "isPlugin": false,
            "isSharedMedia": 0,
            "joinConfSelTag": 0,
            "joinConfTags": "",
            "joinLogin": 0,
            "joinUrlType": 1,
            "jointHostUrl": "http://stest.qsh1.cn/a/OVv6IX996B35",
            "jointHostVerifyUrl": "https://ltest.qsh1.cn/activity/gdn2MT2?role=2",
            "largeGroup": 0,
            "ledgerTag": "[]",
            "length": 60,
            "liveChannelID": 20944,
            "liveCover": "",
            "liveOpenFlag": 1,
            "livePlaybackFlag": 3,
            "livePlaybackTime": 0,
            "livePullPwd": "123456",
            "livePullUrl": "https://ltest.qsh1.cn/activity/gdn2MM5",
            "liveScreen": 0,
            "liveViewFlag": 1,
            "location": "",
            "mailLang": 0,
            "meetingLanguage": "",
            "meetingRoom": 0,
            "modifyTime": 1641350986,
            "nochangeAttendList": null,
            "nochangeDeviceList": [],
            "oldConfHostId": 0,
            "oriStart": 0,
            "parJoinConfLogined": 0,
            "parentId": 0,
            "passwordFlag": 0,
            "pcode1": "201501000037379619",
            "pcode2": "201501000037379620",
            "recurrenceInfo": null,
            "rejectReason": "",
            "restLength": 0,
            "roomId": "",
            "sharedMedia": null,
            "sharedMediaInfo": null,
            "siteId": 173406,
            "sourceDomain": "testcloudb.quanshi.com",
            "startTime": 1641351600,
            "status": 4,
            "summary": "",
            "sv": 0,
            "telAccess": 0,
            "timezone": "Asia/Shanghai",
            "timezoneForEmail": "Asia/Shanghai",
            "title": "%E5%88%86%E6%B5%81%E6%B5%8B%E8%AF%951%E7%9A%84%E4%BC%9A%E8%AE%AE",
            "uniformEnv": "",
            "updAttendList": null,
            "updateFlag": 0,
            "useWaitingRoom": 0,
            "usedConfTickets": 0,
            "videoConferenceMode": 0,
            "watchMcuVideoMode": 0,
            "wcallMonitorUrl": "",
            "wcallUrl": "https://dwz.cn/AAfgllqY",
            "webRTCUrl": "https://mtest.qsh1.cn/k/mkmvH0rno22?priority=web",
            "wholeType": 0
        }
    ],
    "request_id": "uniformserver-172.10.87.168-1641951719.52963626.69",
    "reqid": "confopenapiserver-10.1.89.7-1641951719.3450400.887",
    "timestamp": 1641951719003,
    "content_type": "application/json",
    "product_type": "",
    "device_type": "",
    "iscycle": "",
    "isgnet": "",
    "mem_count": "",
    "verify": "",
    "video_conference_mode": "",
    "live_flag": "",
    "conferenceid": "",
    "record": 0,
    "share_media": 0,
    "hardware_video": 0,
    "accessNumber": "",
    "client_ip": "",
    "request_duration": "427.0245ms"
}

返回参数说明

参数名 类型 说明
status int 0:成功，非0失败
result json字符串 预约会议返回的结果

result参数说明

参数名 类型 说明
eventId int 日程id
title string 会议主题
summary string 会议概要
location string 会议地址
startTime int 会议开始时间
endTime int 会议结束时间
length int 会议时长
restLength int  
isGnet int 是否云会议，0：否，1：是
audioConferenceType int 是否电话会议，0：否，1：是
conferenceId string 会议id
billingCode string 计费码
pcode1 string 主持人入会密码
pcode2 string 参会人入会密码
groupId int 群组id
confHostId int 中小企业创建人id
capacity int 会议室方数
hostId int 创建人id
hostName string 创建人名称
siteId int 站点id
calType string 会议类型，E：单场会议，M：周期会议
status int 会议状态,0:已取消，1：已创建，4：已结束
eventSource int 用于控制是否关联exchange，若关联不发邮件和标识日程创建端，0：未关联 1：关联, 2: web端会议
extrasInfo string 扩展信息
roomId string 会议室id
oriStart int  
timezone string 时区
importance int 重要性，0：否，1：是
attendList ——-ajson 参会人信息
attendList->user string 参会人id
attendList->userType int 参会人类型，1：内部参会人，2：外部参会人，3：电话参会人
attendList->phoneName string 电话参会人名称
attendList->phoneEmail string 电话参会人邮箱
attendList->status string 参会人状态，W:已确认，A：已接受，R:拒绝
attendList->productStatus int  
attendList->countryCode string 国家码
attendList->companyName string 所属公司名称
attendList->orgName string 所属组织名称
attendList->contactId string  
attendList->mobileNumber string 手机号
attendList->officePhone string 办公电话
attendList->cityCode string 城市码
attendList->displayName string 显示名称
houseList array 会议室列表
equipList array 设备列表
sharedMedia json 是否有共享影音，0：否，1：是
allowExternal int  
attendeeJoinUrl string 参会人入会链接
hostJoinUrl string 创建人入会链接
meetAttendeeJoinUrl string 云会议参会人入会链接
meetHostJoinUrl string 云会议主持人入会链接
joinUrlType int 入会连接类型
uniformEnv string  
mailLang int 邮件语言
isPlugin bool  
detailHouseList json 会议室详情，如下
allowHardVideo int 是否允许硬件视频，0：否，1：是
allowBox int 是否允许盒子入会，0：否，1： 是
allowLync int 是否允许Lync入会， 0：否，1：是
appSource string 产品类型，tb：蜜蜂，uc：空间
videoConferenceMode int  
largeGroup int 是否超大组，0：否，1：是
livePullUrl string 直播链接
livePullPwd string 入直播密码
liveViewFlag int 直播观看类型 0：所有人都可以观看 1：有密码 2：需要认证身份 默认值为0
livePlaybackFlag int 回访类型; -1:不允许回看;;0:永不过期; 1:自定义过期时间;2:1个月有效;3:3个月有效
livePlaybackTime int 过期时间 仅当livePlaybackFlag为1至3时有效,取值范围：-1：不允许回看 ，0：永不过期，其他是时间戳
sourceDomain string  
sharedMediaInfo json 共享影音信息
liveOpenFlag int 是否允许直播，0：否，1：是
wcallurl string 云会议电话会议链接
accessNumberInfo object 接入号信息
enable bool 是否有接入号
accessNumber_zh string 中文接入号
accessNumber_en string 英文接入号
accessNumber_url string 接入号链接
confNodeType int 会议节点类型 0:保密会议(默认）1:标准会议
hostsLayout string “1-4” (可选视频布局，“1-4”：4路平均布局；“1-7”：1+7布局；“1-21”：1+21布局：默认：“1-7”)，如果没有此属性，则默认是“1-7”
watchMcuVideoMode int 可选0、1和2，1表示观看多路云会议视频模式，2表示观看多路硬件视频模式，0表示既不是1模式也不是2模式。
joinLogin int 0:参会入会不需要先登录（默认） 1:参会人入会必须先登录
approvalStatus int 日程申请状态, 0无需审批, 1待审批, 2审批通过 3审批拒绝，只有日程是直播活动时才有值，默认0
creatorUserId int 活动创建人userId，和会议主持人不同，相当于助理，只有日程是直播活动时才有值，默认0
creatorName int 活动创建人name，和会议主持人不同，相当于助理，只有日程是直播活动时才有值，默认“”
jointHostUrl string 助理链接（联系主持人链接)，只有日程是直播活动时才有值，默认“”
approvalName string 审批人名，只有日程是直播活动时才有值，默认“”
rejectReason string 拒绝的原因，只有日程是直播活动时才有值，默认“”
joinConfSelTag int 是否入会选择标签配置（0:否，1:是）
joinConfTags string 入会标签字符串,标签之间逗号分隔
eventForm int 活动形式，1:电话，2:网络，3:电话+网络，4:直播，5:电话+直播，6:网络+直播，7:电话+网络+直播
wcallMonitorUrl string 电话活动的监控链接
audienceUnionUrl string 观众落地页链接
guestJoinUrl string 嘉宾入会链接
audienceJoinUrl string 观众入会链接
liveScreen int 云活动手机屏幕显示方式，0:横屏（默认）1：竖屏
eventManualService int 是否需要人工服务开关，0：没有传递值，1：开启，2：关闭，默认1
calExtraInfo object 会议设置参数
webRTCUrl string webRTC 入会链接
accessNumers json对象 接入号信息, “Zh-cn”:中文接入号。”En-us“：英文接入号 “ChooseBySelf”:自选（一般没有）

calExtraInfo结构

参数名 类型 说明
allowH323 int 用来控制是否显示h323。0:关闭 1：开启 默认关闭
openWatchword int 是否开启入会口令开关，0：否，1：是，默认0
eventWatchword string 入会口令，默认空
labels string 活动标签字符串数组json字符串

houseList和equipList结构

参数名 类型 说明
DeviceId int 设备id
DeviceType int 设备类型，2：会议室；3：会议室关联的设备
DeviceName string 设备名称
City string 会议室所在城市
Location string 会议室所在地址
Floor int 会议室所在楼层
IsMainRoom int 会议室类型，0：默认值（用于兼容openapi一场会预约多个会议室的需求）；1：主会场；2：分会场
ParentDeviceId int 父设备id
ParentDeviceType int 父设备类型，2：会议室；3：会议室关联的设备
ApplyUserId int 申请人id
ApprovalStatus int 申请状态,0:待审核；1:未批准;2:已批准 ，3：会议室被取消

houseList和equipList参数示例

[{"DeviceId":6518,
"DeviceType":2,
"DeviceName":"杏花村",
"City":"西安",
"Location":"锦业路",
"Floor":14,
"IsMainRoom":0,
"ParentDeviceId":0,
"ParentDeviceType":0,
"ApplyUserId":22563698,
"ApprovalStatus":1
},
{"DeviceId":6516,
"DeviceType":2,
"DeviceName":"杏花村2",
"City":"西安",
"Location":"锦业路",
"Floor":14,
"IsMainRoom":0,
"ParentDeviceId":0,
"ParentDeviceType":0,
"ApplyUserId":22563698,
"ApprovalStatus":1
}]

detailHouseList结构

参数名 类型 说明
ApplyUserId int 会议室申请人用户id
ApplyStatus int 会议室审批状态,0:待审核；1:未批准;2:已批准 ，3：会议室被取消
DeviceId int 会议室id
DeviceName string 会议室名称
City string 会议室所在城市
Location int 会议室所在地址
Floor string 会议室所在楼层
DeviceType int 设备类型，2：会议室；3：会议室关联的设备
IsMainRoom int 会议室类型，0：默认值（用于兼容openapi一场会预约多个会议室的需求）；1：主会场；2：分会场
SubDevices json 会议室设备
DeviceId int 会议室设备id
DeviceName string 会议室设备名称
DeviceType int 会议室设备类型

detailHouseList参数示例

[{
"DeviceId":6516,
"DeviceType":2,
"DeviceName":"杏花村2",
"City":"西安",
"Location":"锦业路",
"Floor":14,
"IsMainRoom":0,
"ApplyUserId":22563698,
"ApprovalStatus":1,
SubDevices:[{
    "DeviceId":6546,
    "DeviceType":3,
    "DeviceName":"盒子"
    },
    {
    "DeviceId":6547,
    "DeviceType":3,
    "DeviceName":"盒子2"
    }]
}]

accessNumbers返回参数说明

参数名 类型 说明
area string 区域
number string 接入号码
chooseBySelf string 是否有自选，默认0

十八、获取会议列表（支持会议室）

简要描述：

  • 获取会议列表接口

请求URL：

  • https://openapi.quanshi.com/confopenapi/room/conference/list

请求方式：

  • POST

参数：

参数名 必选 类型 说明
startTime 是 string 开始时间
endTime 是 string 结束时间
userId 是 int 主持人用户ID
inCycle 否 int 是否包含周期会议, 0 不包含（默认），1 包含

传参示例

{
    "startTime":1641020400,
    "endTime":1641538800,
    "userId":87679779
}

修改返回示例

{
    "status": 0,
    "result": [
        {
            "CreateTime": 1641362281,
            "ExtraMeetingRoom": null,
            "ManagerCustomerCode": "",
            "accessNumberInfo": null,
            "accessNumbers": {
                "ChooseBySelf": [
                    {
                        "area": "北京",
                        "chooseBySelf": 0,
                        "number": "+86(10)5932-1988"
                    },
                    {
                        "area": "上海",
                        "chooseBySelf": 0,
                        "number": "+86(21)3599-4558"
                    }
                ],
                "En-us": [
                    {
                        "area": "ALL",
                        "chooseBySelf": 0,
                        "number": "400-810-8822"
                    },
                    {
                        "area": "Beijing",
                        "chooseBySelf": 0,
                        "number": "+86(10)5851-2020"
                    }
                ],
                "Zh-cn": [
                    {
                        "area": "全国",
                        "chooseBySelf": 0,
                        "number": "400-139-8500"
                    }
                ]
            },
            "addAttendList": null,
            "addDeviceList": [],
            "addMediaList": null,
            "advanceHours": "1",
            "allowBox": 0,
            "allowExternal": 1,
            "allowHardVideo": 1,
            "allowLync": 1,
            "appSource": "meeting",
            "approvalName": "",
            "approvalStatus": 0,
            "approvalUserId": 0,
            "attendList": [
                {
                    "cityCode": "",
                    "companyName": "",
                    "contactId": "",
                    "countryCode": "",
                    "displayName": "",
                    "mobileNumber": "",
                    "officePhone": "",
                    "orgName": "",
                    "phoneEmail": "",
                    "phoneName": "",
                    "productStatus": 1,
                    "status": "W",
                    "user": "87679779",
                    "userProfile": null,
                    "userType": 1
                }
            ],
            "attendeeJoinUrl": "https://mtest.qsh1.cn/k/mkmvKqT2D22",
            "audienceJoinUrl": "https://mtest.qsh1.cn/k/mkmvKqT2D22",
            "audienceUnionUrl": "https://ltest.qsh1.cn/activity/gdn3mw9",
            "audioConferenceType": 0,
            "authority": null,
            "billingCode": "95374287",
            "calExtraInfo": {
                "allowH323": 0,
                "showAccessNumbers": 0,
                "showWebRTCUrl": 0
            },
            "calType": "E",
            "callbackURL": "",
            "callbackUd": "",
            "capacity": 0,
            "clientOs": "",
            "clientType": 0,
            "confHostId": 0,
            "confMaster": 0,
            "confMode": 0,
            "confNodeType": 1,
            "conferenceId": "239608260",
            "creatorName": "",
            "creatorUserId": 0,
            "customerCode": "153603",
            "delAttendList": null,
            "delDeviceList": [],
            "delMediaList": null,
            "detailHouseList": null,
            "enableCloudMCU": 1,
            "endTime": 1641366000,
            "equipList": [],
            "eventForm": 7,
            "eventId": 545480,
            "eventLive": 0,
            "eventManualService": 0,
            "eventSource": 0,
            "exchangeExternalId": "",
            "exchangeSyncDate": 0,
            "externalFlag": "",
            "extrasInfo": "",
            "groupId": 80571542,
            "guestJoinUrl": "http://stest.qsh1.cn/a/NVV5IX439282",
            "guestJoinVerifyUrl": "https://ltest.qsh1.cn/activity/gdn3mw9?role=3",
            "hostId": 87679779,
            "hostJoinUrl": "https://mtest.qsh1.cn/k/mkmvK0qTqN0",
            "hostName": "分流测试1",
            "hostsLayout": "",
            "houseList": [],
            "importance": 0,
            "isGnet": 1,
            "isPlugin": false,
            "isSharedMedia": 0,
            "joinConfSelTag": 0,
            "joinConfTags": "",
            "joinLogin": 0,
            "joinUrlType": 1,
            "jointHostUrl": "http://stest.qsh1.cn/a/OVV5IX96186A",
            "jointHostVerifyUrl": "https://ltest.qsh1.cn/activity/gdn3mw9?role=2",
            "largeGroup": 0,
            "ledgerTag": "[]",
            "length": 60,
            "liveChannelID": 20956,
            "liveCover": "",
            "liveOpenFlag": 1,
            "livePlaybackFlag": 3,
            "livePlaybackTime": 0,
            "livePullPwd": "222222",
            "livePullUrl": "https://ltest.qsh1.cn/activity/gdn3mB8",
            "liveScreen": 0,
            "liveViewFlag": 1,
            "location": "",
            "mailLang": 0,
            "meetingLanguage": "",
            "meetingRoom": 0,
            "modifyTime": 1641362280,
            "nochangeAttendList": null,
            "nochangeDeviceList": [],
            "oldConfHostId": 0,
            "oriStart": 0,
            "parJoinConfLogined": 0,
            "parentId": 0,
            "passwordFlag": 0,
            "pcode1": "201501000037379677",
            "pcode2": "201501000037379678",
            "recurrenceInfo": null,
            "rejectReason": "",
            "restLength": 0,
            "roomId": "",
            "sharedMedia": null,
            "sharedMediaInfo": null,
            "siteId": 173406,
            "sourceDomain": "testcloudb.quanshi.com",
            "startTime": 1641362400,
            "status": 4,
            "summary": "",
            "sv": 0,
            "telAccess": 0,
            "timezone": "Asia/Shanghai",
            "timezoneForEmail": "Asia/Shanghai",
            "title": "%E5%AE%A2%E6%88%B7%E7%AB%AF%E7%BA%A6%E4%BC%9A",
            "uniformEnv": "",
            "updAttendList": null,
            "updateFlag": 0,
            "useWaitingRoom": 0,
            "usedConfTickets": 0,
            "videoConferenceMode": 0,
            "watchMcuVideoMode": 0,
            "wcallMonitorUrl": "",
            "wcallUrl": "https://dwz.cn/Q8ogM8hE",
            "webRTCUrl": "https://mtest.qsh1.cn/k/mkmvKqT2D22?priority=web",
            "wholeType": 0
        }
    ],
    "request_id": "uniformserver-172.10.87.168-1641967098.227651071.21",
    "reqid": "confopenapiserver-10.1.89.7-1641967094.904103600.887",
    "timestamp": 1641967094904,
    "content_type": "application/json",
    "product_type": "",
    "device_type": "",
    "iscycle": "",
    "isgnet": "",
    "mem_count": "",
    "verify": "",
    "video_conference_mode": "",
    "live_flag": "",
    "conferenceid": "",
    "record": 0,
    "share_media": 0,
    "hardware_video": 0,
    "accessNumber": "",
    "client_ip": "",
    "request_duration": "4.7352709s"
}

返回参数说明

参数名 类型 说明
status int 0:成功，非0失败
result json字符串 预约会议返回的结果

result参数说明

参数名 类型 说明
eventId int 日程id
title string 会议主题
summary string 会议概要
location string 会议地址
startTime int 会议开始时间
endTime int 会议结束时间
length int 会议时长
restLength int  
isGnet int 是否云会议，0：否，1：是
audioConferenceType int 是否电话会议，0：否，1：是
conferenceId string 会议id
billingCode string 计费码
pcode1 string 主持人入会密码
pcode2 string 参会人入会密码
groupId int 群组id
confHostId int 中小企业创建人id
capacity int 会议室方数
hostId int 创建人id
hostName string 创建人名称
siteId int 站点id
calType string 会议类型，E：单场会议，M：周期会议
status int 会议状态,0:已取消，1：已创建，4：已结束
eventSource int 用于控制是否关联exchange，若关联不发邮件和标识日程创建端，0：未关联 1：关联, 2: web端会议
extrasInfo string 扩展信息
roomId string 会议室id
oriStart int  
timezone string 时区
importance int 重要性，0：否，1：是
attendList ——-ajson 参会人信息
attendList->user string 参会人id
attendList->userType int 参会人类型，1：内部参会人，2：外部参会人，3：电话参会人
attendList->phoneName string 电话参会人名称
attendList->phoneEmail string 电话参会人邮箱
attendList->status string 参会人状态，W:已确认，A：已接受，R:拒绝
attendList->productStatus int  
attendList->countryCode string 国家码
attendList->companyName string 所属公司名称
attendList->orgName string 所属组织名称
attendList->contactId string  
attendList->mobileNumber string 手机号
attendList->officePhone string 办公电话
attendList->cityCode string 城市码
attendList->displayName string 显示名称
houseList array 会议室列表
equipList array 设备列表
sharedMedia json 是否有共享影音，0：否，1：是
allowExternal int  
attendeeJoinUrl string 参会人入会链接
hostJoinUrl string 创建人入会链接
meetAttendeeJoinUrl string 云会议参会人入会链接
meetHostJoinUrl string 云会议主持人入会链接
joinUrlType int 入会连接类型
uniformEnv string  
mailLang int 邮件语言
isPlugin bool  
detailHouseList json 会议室详情，如下
allowHardVideo int 是否允许硬件视频，0：否，1：是
allowBox int 是否允许盒子入会，0：否，1： 是
allowLync int 是否允许Lync入会， 0：否，1：是
appSource string 产品类型，tb：蜜蜂，uc：空间
videoConferenceMode int  
largeGroup int 是否超大组，0：否，1：是
livePullUrl string 直播链接
livePullPwd string 入直播密码
liveViewFlag int 直播观看类型 0：所有人都可以观看 1：有密码 2：需要认证身份 默认值为0
livePlaybackFlag int 回访类型; -1:不允许回看;;0:永不过期; 1:自定义过期时间;2:1个月有效;3:3个月有效
livePlaybackTime int 过期时间 仅当livePlaybackFlag为1至3时有效,取值范围：-1：不允许回看 ，0：永不过期，其他是时间戳
sourceDomain string  
sharedMediaInfo json 共享影音信息
liveOpenFlag int 是否允许直播，0：否，1：是
wcallurl string 云会议电话会议链接
accessNumberInfo object 接入号信息
enable bool 是否有接入号
accessNumber_zh string 中文接入号
accessNumber_en string 英文接入号
accessNumber_url string 接入号链接
confNodeType int 会议节点类型 0:保密会议(默认）1:标准会议
hostsLayout string “1-4” (可选视频布局，“1-4”：4路平均布局；“1-7”：1+7布局；“1-21”：1+21布局：默认：“1-7”)，如果没有此属性，则默认是“1-7”
watchMcuVideoMode int 可选0、1和2，1表示观看多路云会议视频模式，2表示观看多路硬件视频模式，0表示既不是1模式也不是2模式。
joinLogin int 0:参会入会不需要先登录（默认） 1:参会人入会必须先登录
approvalStatus int 日程申请状态, 0无需审批, 1待审批, 2审批通过 3审批拒绝，只有日程是直播活动时才有值，默认0
creatorUserId int 活动创建人userId，和会议主持人不同，相当于助理，只有日程是直播活动时才有值，默认0
creatorName int 活动创建人name，和会议主持人不同，相当于助理，只有日程是直播活动时才有值，默认“”
jointHostUrl string 助理链接（联系主持人链接)，只有日程是直播活动时才有值，默认“”
approvalName string 审批人名，只有日程是直播活动时才有值，默认“”
rejectReason string 拒绝的原因，只有日程是直播活动时才有值，默认“”
joinConfSelTag int 是否入会选择标签配置（0:否，1:是）
joinConfTags string 入会标签字符串,标签之间逗号分隔
eventForm int 活动形式，1:电话，2:网络，3:电话+网络，4:直播，5:电话+直播，6:网络+直播，7:电话+网络+直播
wcallMonitorUrl string 电话活动的监控链接
audienceUnionUrl string 观众落地页链接
guestJoinUrl string 嘉宾入会链接
audienceJoinUrl string 观众入会链接
liveScreen int 云活动手机屏幕显示方式，0:横屏（默认）1：竖屏
eventManualService int 是否需要人工服务开关，0：没有传递值，1：开启，2：关闭，默认1
calExtraInfo object 会议设置参数
webRTCUrl string webRTC 入会链接
accessNumers json对象 接入号信息, “Zh-cn”:中文接入号。”En-us“：英文接入号 “ChooseBySelf”:自选（一般没有）

calExtraInfo结构

参数名 类型 说明
allowH323 int 用来控制是否显示h323。0:关闭 1：开启 默认关闭
openWatchword int 是否开启入会口令开关，0：否，1：是，默认0
eventWatchword string 入会口令，默认空
labels string 活动标签字符串数组json字符串

houseList和equipList结构

参数名 类型 说明
DeviceId int 设备id
DeviceType int 设备类型，2：会议室；3：会议室关联的设备
DeviceName string 设备名称
City string 会议室所在城市
Location string 会议室所在地址
Floor int 会议室所在楼层
IsMainRoom int 会议室类型，0：默认值（用于兼容openapi一场会预约多个会议室的需求）；1：主会场；2：分会场
ParentDeviceId int 父设备id
ParentDeviceType int 父设备类型，2：会议室；3：会议室关联的设备
ApplyUserId int 申请人id
ApprovalStatus int 申请状态,0:待审核；1:未批准;2:已批准 ，3：会议室被取消

houseList和equipList参数示例

[{"DeviceId":6518,
"DeviceType":2,
"DeviceName":"杏花村",
"City":"西安",
"Location":"锦业路",
"Floor":14,
"IsMainRoom":0,
"ParentDeviceId":0,
"ParentDeviceType":0,
"ApplyUserId":22563698,
"ApprovalStatus":1
},
{"DeviceId":6516,
"DeviceType":2,
"DeviceName":"杏花村2",
"City":"西安",
"Location":"锦业路",
"Floor":14,
"IsMainRoom":0,
"ParentDeviceId":0,
"ParentDeviceType":0,
"ApplyUserId":22563698,
"ApprovalStatus":1
}]

detailHouseList结构

参数名 类型 说明
ApplyUserId int 会议室申请人用户id
ApplyStatus int 会议室审批状态,0:待审核；1:未批准;2:已批准 ，3：会议室被取消
DeviceId int 会议室id
DeviceName string 会议室名称
City string 会议室所在城市
Location int 会议室所在地址
Floor string 会议室所在楼层
DeviceType int 设备类型，2：会议室；3：会议室关联的设备
IsMainRoom int 会议室类型，0：默认值（用于兼容openapi一场会预约多个会议室的需求）；1：主会场；2：分会场
SubDevices json 会议室设备
DeviceId int 会议室设备id
DeviceName string 会议室设备名称
DeviceType int 会议室设备类型

detailHouseList参数示例

[{
"DeviceId":6516,
"DeviceType":2,
"DeviceName":"杏花村2",
"City":"西安",
"Location":"锦业路",
"Floor":14,
"IsMainRoom":0,
"ApplyUserId":22563698,
"ApprovalStatus":1,
SubDevices:[{
    "DeviceId":6546,
    "DeviceType":3,
    "DeviceName":"盒子"
    },
    {
    "DeviceId":6547,
    "DeviceType":3,
    "DeviceName":"盒子2"
    }]
}]

accessNumbers返回参数说明

参数名 类型 说明
area string 区域
number string 接入号码
chooseBySelf string 是否有自选，默认0

十九、获取某场会议录制文件

简要描述：

  • 根据会议ID获取录制文件

请求URL：

  • https://openapi.quanshi.com/confopenapi/conference/movie/getConfReplayById

请求方式：

  • POST

参数：

参数名 必选 类型 说明
userId 是 int 主持人ID
conferenceId 是 string 会议Id

请求示例

{
    "conferenceId": "239599729",
    "userId":88413072
}

返回示例

{
    "status":0,
    "result":{
        "userId":"88413072",
        "conferenceId":"239599729",
        "tempConferenceId":"1032713472",
        "startTime":"2021-11-19 11:30:00",
        "endTime":"2021-11-19 12:30:00",
        "length":"60",
        "pwdType":"1",
        "informType":"0",
        "pcode1":"201501000037362141",
        "pcode2":"201501000037362142",
        "conferenceTitle":"dww001的会议",
        "hasReport":"1",
        "isReportReady":"1",
        "hasRecord":"1",
        "isRecordConvertReady":"1",
        "realStartTime":"2021-11-19 11:10:19",
        "realEndTime":"2021-11-19 11:12:28",
        "recordFlag":"1",
        "replayUrl":"https://rtest.qsh1.cn/rec/page? id=c584982126c643dd9abc7c61eb84993a&v=1",
        "downloadUrl":"https://rtest.qsh1.cn/resources/20211119/1032713472/downloadzip/c584982126c643d d9abc7c61eb84993a.mp4?dname=dww001的会议_20211119111019.mp4",
        "recordUrl":"https://rtest.qsh1.cn/rec/page? id=c584982126c643dd9abc7c61eb84993a&v=1",
        "recordDownUrl":"https://rtest.qsh1.cn/resources/20211119/1032713472/downloadzip/c584982126c643d d9abc7c61eb84993a.mp4?dname=dww001的会议_20211119111019.mp4",
        "reportDownUrl":"http://uniform.quanshi.com/confspace/report/download2/6e96b1edf4ee99f8b16b39b1d fda4960/GkZe1R7_8BYTE7J8G4Axhg/Fh1SLCy9qlX3UVYj-D8iBQ/239599729"
    },
    "request_id":"confopenapiserver-172.10.5.232-1638326714.844929057.888",
    "reqid":"confopenapiserver-172.10.5.232-1638326714.844929057.888",
    "timestamp":1638326714844,
    "content_type":"application/json",
    "product_type":"",
    "device_type":"",
    "iscycle":"",
    "isgnet":"",
    "mem_count":"",
    "verify":"",
    "video_conference_mode":"",
    "live_flag":"",
    "conferenceid":"",
    "record":0,
    "share_media":0,
    "hardware_video":0,
    "accessNumber":"",
    "client_ip":"",
    "request_duration":"15.791746ms"
}

返回参数说明

参数名 类型 说明
status int 0：成功 ，非0失败
result json 查询的结果，有查询到的邮箱作为主键的数组
userId int 用户id
conferenceId string 会议ID
tempConferenceId string 临时会议ID
startTime string 会议开始时间
endTime string 会议结束时间
length int 会议时长
pwdType string 会议密码类型，0：固定，1：动态
informType string 会议密码类型，0：固定，1：动态
pcode1 string 会议主持人密码
pcode2 string 会议参会人密码
conferenceTitle string 会议标题
hasReport string 是否有会议报告，0：无，1有
isReportReady string 是否有会议报告已准备就绪，0：无，1有
hasRecord string 是否有会议录制，0：无，1有
isRecordConvertReady string 是否有会议录制准备就绪，0：无，1有
realStartTime string 会议真实开始时间
realEndTime string 会议真实结束时间
recordUrl string 会议录制播放地址
recordDownUrl string 会议录制下载地址
reportDownUrl string 会议报告下载地址

备注

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

二十、免密观看直播

简要描述：

  • 对于带直播密码的会议，通过接口获取url可以实现免密观看、并且带入观众姓名、手机号等信息可以免验证手机号进行讨论

请求URL：

  • https://openapi.quanshi.com/confopenapi/conference/getPullUrl

请求方式：

  • POST

参数：

参数名 必选 类型 说明
userId 是 int 主持人ID
conferenceId 是 string 会议Id
timeout 否 int 过期时间，单位/分钟，默认5分钟
usableCount 否 int 可使用次数 , 默认6次
extId 否 string 第三方ID
name 是 string 姓名（可以为邮箱和姓名）
mobile 否 string 电话号码
countryCode 否 string 国家码，例:86
email 否 string 邮箱

请求示例

{
    "conferenceId": "239608266",
    "userId": 87679779,
    "timeout":600,
    "usableCount":100,
    "name":"extIdtest1234",
    "extId":"extIdtest1234@pxy.com",
    "mobile":"15811258254",
    "countryCode":"86",
    "email":"test1234@pxy.com"
}

返回示例

{
    "status": 0,
    "result": "https://ltest.qsh1.cn/3/gdn3sj9?t=1345d7d7-add7-45da-94af-dbc8c0a51bb4",
    "request_id": "confopenapiserver-10.1.89.7-1641431568.325437200.81",
    "reqid": "confopenapiserver-10.1.89.7-1641431568.325437200.81",
    "timestamp": 1641431568334,
    "content_type": "application/json",
    "product_type": "",
    "device_type": "",
    "iscycle": "",
    "isgnet": "",
    "mem_count": "",
    "verify": "",
    "video_conference_mode": "",
    "live_flag": "",
    "conferenceid": "",
    "record": 0,
    "share_media": 0,
    "hardware_video": 0,
    "accessNumber": "",
    "client_ip": "",
    "request_duration": "879.0502ms"
}

返回参数说明

参数名 类型 说明
status int 0：成功 ，非0失败
result string 返回免密观看url

备注

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

二十一、获取免密入会链接

简要描述：

  • 获取入会链接接口-主持人、参会人； 如果是获取免登录参会人入会链接，用户ID必须是本企业的参会人的用户ID

请求URL：

  • https://openapi.quanshi.com/confopenapi/conference/launch/joinConferenceNoSecret

请求方式：

  • POST

参数：

参数名 必选 类型 说明
pcode 是 string 会议密码
userId 是 int 用户ID

返回示例

{
    "status": 0,
    "result": {
        "joinLink": "https://mtest.qsh1.cn/k/mkmgXQud77o?token=5b23de7a-e4ce-47bc-a4eb-dd7afeab8f22&wuid=87679779"
    },
    "request_id": "confopenapiserver-10.1.89.5-1639640688.927186700.81",
    "reqid": "confopenapiserver-10.1.89.5-1639640688.927186700.81",
    "timestamp": 1639640688935,
    "content_type": "application/json",
    "product_type": "",
    "device_type": "",
    "iscycle": "",
    "isgnet": "",
    "mem_count": "",
    "verify": "",
    "video_conference_mode": "",
    "live_flag": "",
    "conferenceid": "",
    "record": 0,
    "share_media": 0,
    "hardware_video": 0,
    "accessNumber": "",
    "client_ip": "",
    "request_duration": "574.0329ms"
}

返回参数说明

参数名 类型 说明
status int 0：成功，非0失败
joinLink string 免密入会链接

备注

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

二十二、获取会前客户端吊起串

简要描述：

  • 获取会前客户端吊起串接口

请求URL：

  • https://openapi.quanshi.com/confopenapi/conference/launch/launchMeetingClient

请求方式：

  • POST

参数：

参数名 必选 类型 说明
userId 是 int 用户ID

请求示例

{
    "userId":88600761
}

返回示例

{
    "status": 0,
    "result": {
        "token": "a44f75ee-7aa2-48f0-975b-059fe4c60e6c",
        "userId": 88600761,
        "webJoinLink": "tang:///app:6/skin:1/site:60000/Version:5.0.0/goto:login/token:a44f75ee-7aa2-48f0-975b-059fe4c60e6c/wuid:88600761",
        "appJoinLink": "qsgnet://com.gnet.onemeeting?goto=login&token=a44f75ee-7aa2-48f0-975b-059fe4c60e6c&wuid=88600761"
    },
    "request_id": "confopenapiserver-10.1.89.5-1639378912.425660300.887",
    "reqid": "confopenapiserver-10.1.89.5-1639378912.425660300.887",
    "timestamp": 1639378912425,
    "content_type": "application/json",
    "product_type": "",
    "device_type": "",
    "iscycle": "",
    "isgnet": "",
    "mem_count": "",
    "verify": "",
    "video_conference_mode": "",
    "live_flag": "",
    "conferenceid": "",
    "record": 0,
    "share_media": 0,
    "hardware_video": 0,
    "accessNumber": "",
    "client_ip": "",
    "request_duration": "226.0129ms"
}

返回参数说明

参数名 类型 说明
status int 0：成功 ，非0失败
result json 查询的结果，有查询到的邮箱作为主键的数组
appJoinLink string app入会吊起串
webJoinLink string web入会吊起串

备注

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

二十三、获取云会议列表-管理员视角

简要描述：

  • 获取会议列表接口

请求URL：

  • https://openapi.quanshi.com/confopenapi/room/conference/listByAdmin

请求方式：

  • POST

参数：

参数名 必选 类型 说明
startTime 是 string 开始时间, 毫秒
endTime 是 string 结束时间, 毫秒
adminUserId 是 int 管理员userId
limit 否 int 分页参数，每页返回多少条记录，默认值10
eventIdFilter 否 int 分页参数，最后一条会议的eventId

传参示例

{
    "startTime":1641020400,
    "endTime":1648897421,
    "adminUserId":12345824
}

修改返回示例

{
    "status": 0,
    "result": [
        {
            "CreateTime": 1648868614,
            "ExtraMeetingRoom": null,
            "ManagerCustomerCode": "",
            "accessNumberInfo": null,
            "accessNumbers": {
                "ChooseBySelf": null,
                "En-us": null,
                "Zh-cn": null
            },
            "addAttendList": null,
            "addDeviceList": [],
            "addMediaList": null,
            "advanceHours": "1",
            "allowBox": 0,
            "allowExternal": 1,
            "allowHardVideo": 0,
            "allowLync": 1,
            "appSource": "meeting",
            "approvalName": "",
            "approvalStatus": 0,
            "approvalUserId": 0,
            "attendList": [
                {
                    "cityCode": "",
                    "companyName": "",
                    "contactId": "",
                    "countryCode": "",
                    "displayName": "",
                    "mobileNumber": "",
                    "officePhone": "",
                    "orgName": "",
                    "phoneEmail": "",
                    "phoneName": "",
                    "productStatus": 1,
                    "status": "W",
                    "user": "88609824",
                    "userProfile": null,
                    "userType": 1
                }
            ],
            "attendeeJoinUrl": "https://mtest.qsh1.cn/k/mkGLmNNg59e",
            "audienceJoinUrl": "",
            "audienceUnionUrl": "",
            "audioConferenceType": 0,
            "authority": null,
            "billingCode": "95387727",
            "calExtraInfo": {
                "allowH323": 0,
                "eventWatchword": "",
                "openWatchword": 0,
                "showAccessNumbers": 0,
                "showWebRTCUrl": 0
            },
            "calType": "E",
            "callbackURL": "",
            "callbackUd": "",
            "capacity": 0,
            "clientOs": "",
            "clientType": 0,
            "confHostId": 0,
            "confMaster": 0,
            "confMode": 0,
            "confNodeType": 1,
            "conferenceId": "239704683",
            "creatorName": "",
            "creatorUserId": 0,
            "customerCode": "154305",
            "delAttendList": null,
            "delDeviceList": [],
            "delMediaList": null,
            "detailHouseList": null,
            "enableCloudMCU": 1,
            "endTime": 1648873800,
            "equipList": [],
            "eventForm": 0,
            "eventId": 557933,
            "eventLive": 0,
            "eventManualService": 0,
            "eventSource": 0,
            "exchangeExternalId": "",
            "exchangeSyncDate": 0,
            "externalFlag": "",
            "extrasInfo": "",
            "groupId": 80583020,
            "guestJoinUrl": "",
            "guestJoinVerifyUrl": "",
            "hostId": 88609824,
            "hostJoinUrl": "https://mtest.qsh1.cn/k/mkGLmxHjaT2",
            "hostName": "pxytest0001",
            "hostsLayout": "",
            "houseList": [],
            "importance": 0,
            "isGnet": 1,
            "isPlugin": false,
            "isSharedMedia": 0,
            "joinConfSelTag": 0,
            "joinConfTags": "",
            "joinLogin": 0,
            "joinUrlType": 1,
            "jointHostUrl": "",
            "jointHostVerifyUrl": "",
            "largeGroup": 0,
            "ledgerTag": "[]",
            "length": 60,
            "liveChannelID": 0,
            "liveCover": "",
            "liveOpenFlag": 0,
            "livePlaybackFlag": 0,
            "livePlaybackTime": 0,
            "livePullPwd": "",
            "livePullUrl": "",
            "liveScreen": 0,
            "liveViewFlag": 0,
            "location": "",
            "mailLang": 0,
            "meetingLanguage": "",
            "meetingRoom": 0,
            "modifyTime": 1648868613,
            "nochangeAttendList": null,
            "nochangeDeviceList": [],
            "oldConfHostId": 0,
            "oriStart": 0,
            "parJoinConfLogined": 0,
            "parentId": 0,
            "passwordFlag": 0,
            "pcode1": "201501000037413389",
            "pcode2": "201501000037413390",
            "recurrenceInfo": null,
            "rejectReason": "",
            "restLength": 0,
            "roomId": "",
            "sharedMedia": null,
            "sharedMediaInfo": null,
            "siteId": 176822,
            "sourceDomain": "testcloudb.quanshi.com",
            "startTime": 1648870200,
            "status": 4,
            "summary": "",
            "sv": 0,
            "telAccess": 0,
            "testAudienceUnionUrl": "",
            "timezone": "Asia/Shanghai",
            "timezoneForEmail": "Asia/Shanghai",
            "title": "pxytest0001%E7%9A%84%E4%BC%9A%E8%AE%AE002",
            "uniformEnv": "",
            "updAttendList": null,
            "updateFlag": 0,
            "useWaitingRoom": 0,
            "usedConfTickets": 0,
            "videoConferenceMode": 0,
            "watchMcuVideoMode": 0,
            "wcallMonitorUrl": "",
            "wcallUrl": "https://dwz.cn/qpVw7kvS",
            "webRTCUrl": "https://mtest.qsh1.cn/k/mkGLmNNg59e?priority=web",
            "wholeType": 0
        },
        {
            "CreateTime": 1648868599,
            "ExtraMeetingRoom": null,
            "ManagerCustomerCode": "",
            "accessNumberInfo": null,
            "accessNumbers": {
                "ChooseBySelf": null,
                "En-us": null,
                "Zh-cn": null
            },
            "addAttendList": null,
            "addDeviceList": [],
            "addMediaList": null,
            "advanceHours": "1",
            "allowBox": 0,
            "allowExternal": 1,
            "allowHardVideo": 0,
            "allowLync": 1,
            "appSource": "meeting",
            "approvalName": "",
            "approvalStatus": 0,
            "approvalUserId": 0,
            "attendList": [
                {
                    "cityCode": "",
                    "companyName": "",
                    "contactId": "",
                    "countryCode": "",
                    "displayName": "",
                    "mobileNumber": "",
                    "officePhone": "",
                    "orgName": "",
                    "phoneEmail": "",
                    "phoneName": "",
                    "productStatus": 1,
                    "status": "W",
                    "user": "88609824",
                    "userProfile": null,
                    "userType": 1
                }
            ],
            "attendeeJoinUrl": "https://mtest.qsh1.cn/k/mkGLLrhR05g",
            "audienceJoinUrl": "",
            "audienceUnionUrl": "",
            "audioConferenceType": 0,
            "authority": null,
            "billingCode": "95387726",
            "calExtraInfo": {
                "allowH323": 0,
                "eventWatchword": "",
                "openWatchword": 0,
                "showAccessNumbers": 0,
                "showWebRTCUrl": 0
            },
            "calType": "E",
            "callbackURL": "",
            "callbackUd": "",
            "capacity": 0,
            "clientOs": "",
            "clientType": 0,
            "confHostId": 0,
            "confMaster": 0,
            "confMode": 0,
            "confNodeType": 1,
            "conferenceId": "239704682",
            "creatorName": "",
            "creatorUserId": 0,
            "customerCode": "154305",
            "delAttendList": null,
            "delDeviceList": [],
            "delMediaList": null,
            "detailHouseList": null,
            "enableCloudMCU": 1,
            "endTime": 1648884600,
            "equipList": [],
            "eventForm": 0,
            "eventId": 557932,
            "eventLive": 0,
            "eventManualService": 0,
            "eventSource": 0,
            "exchangeExternalId": "",
            "exchangeSyncDate": 0,
            "externalFlag": "",
            "extrasInfo": "",
            "groupId": 80583019,
            "guestJoinUrl": "",
            "guestJoinVerifyUrl": "",
            "hostId": 88609824,
            "hostJoinUrl": "https://mtest.qsh1.cn/k/mkGLLeDGaje",
            "hostName": "pxytest0001",
            "hostsLayout": "",
            "houseList": [],
            "importance": 0,
            "isGnet": 1,
            "isPlugin": false,
            "isSharedMedia": 0,
            "joinConfSelTag": 0,
            "joinConfTags": "",
            "joinLogin": 0,
            "joinUrlType": 1,
            "jointHostUrl": "",
            "jointHostVerifyUrl": "",
            "largeGroup": 0,
            "ledgerTag": "[]",
            "length": 60,
            "liveChannelID": 0,
            "liveCover": "",
            "liveOpenFlag": 0,
            "livePlaybackFlag": 0,
            "livePlaybackTime": 0,
            "livePullPwd": "",
            "livePullUrl": "",
            "liveScreen": 0,
            "liveViewFlag": 0,
            "location": "",
            "mailLang": 0,
            "meetingLanguage": "",
            "meetingRoom": 0,
            "modifyTime": 1648868598,
            "nochangeAttendList": null,
            "nochangeDeviceList": [],
            "oldConfHostId": 0,
            "oriStart": 0,
            "parJoinConfLogined": 0,
            "parentId": 0,
            "passwordFlag": 0,
            "pcode1": "201501000037413387",
            "pcode2": "201501000037413388",
            "recurrenceInfo": null,
            "rejectReason": "",
            "restLength": 0,
            "roomId": "",
            "sharedMedia": null,
            "sharedMediaInfo": null,
            "siteId": 176822,
            "sourceDomain": "testcloudb.quanshi.com",
            "startTime": 1648881000,
            "status": 4,
            "summary": "",
            "sv": 0,
            "telAccess": 0,
            "testAudienceUnionUrl": "",
            "timezone": "Asia/Shanghai",
            "timezoneForEmail": "Asia/Shanghai",
            "title": "pxytest0001%E7%9A%84%E4%BC%9A%E8%AE%AE",
            "uniformEnv": "",
            "updAttendList": null,
            "updateFlag": 0,
            "useWaitingRoom": 0,
            "usedConfTickets": 0,
            "videoConferenceMode": 0,
            "watchMcuVideoMode": 0,
            "wcallMonitorUrl": "",
            "wcallUrl": "https://dwz.cn/vJxzY9Ir",
            "webRTCUrl": "https://mtest.qsh1.cn/k/mkGLLrhR05g?priority=web",
            "wholeType": 0
        },
        {
            "CreateTime": 1648868687,
            "ExtraMeetingRoom": null,
            "ManagerCustomerCode": "",
            "accessNumberInfo": null,
            "accessNumbers": {
                "ChooseBySelf": null,
                "En-us": null,
                "Zh-cn": null
            },
            "addAttendList": null,
            "addDeviceList": [],
            "addMediaList": null,
            "advanceHours": "1",
            "allowBox": 0,
            "allowExternal": 1,
            "allowHardVideo": 0,
            "allowLync": 1,
            "appSource": "meeting",
            "approvalName": "",
            "approvalStatus": 0,
            "approvalUserId": 0,
            "attendList": [
                {
                    "cityCode": "",
                    "companyName": "",
                    "contactId": "",
                    "countryCode": "",
                    "displayName": "",
                    "mobileNumber": "",
                    "officePhone": "",
                    "orgName": "",
                    "phoneEmail": "",
                    "phoneName": "",
                    "productStatus": 1,
                    "status": "W",
                    "user": "88609800",
                    "userProfile": null,
                    "userType": 1
                },
                {
                    "cityCode": "",
                    "companyName": "",
                    "contactId": "",
                    "countryCode": "",
                    "displayName": "",
                    "mobileNumber": "",
                    "officePhone": "",
                    "orgName": "",
                    "phoneEmail": "",
                    "phoneName": "",
                    "productStatus": 1,
                    "status": "W",
                    "user": "88609824",
                    "userProfile": null,
                    "userType": 1
                }
            ],
            "attendeeJoinUrl": "https://mtest.qsh1.cn/k/mkGLNnkQY7o",
            "audienceJoinUrl": "",
            "audienceUnionUrl": "",
            "audioConferenceType": 0,
            "authority": null,
            "billingCode": "95387728",
            "calExtraInfo": {
                "allowH323": 0,
                "eventWatchword": "",
                "openWatchword": 0,
                "showAccessNumbers": 0,
                "showWebRTCUrl": 0
            },
            "calType": "E",
            "callbackURL": "",
            "callbackUd": "",
            "capacity": 0,
            "clientOs": "",
            "clientType": 0,
            "confHostId": 0,
            "confMaster": 0,
            "confMode": 0,
            "confNodeType": 1,
            "conferenceId": "239704684",
            "creatorName": "",
            "creatorUserId": 0,
            "customerCode": "154305",
            "delAttendList": null,
            "delDeviceList": [],
            "delMediaList": null,
            "detailHouseList": null,
            "enableCloudMCU": 1,
            "endTime": 1648899000,
            "equipList": [],
            "eventForm": 0,
            "eventId": 557934,
            "eventLive": 0,
            "eventManualService": 0,
            "eventSource": 0,
            "exchangeExternalId": "",
            "exchangeSyncDate": 0,
            "externalFlag": "",
            "extrasInfo": "",
            "groupId": 80583021,
            "guestJoinUrl": "",
            "guestJoinVerifyUrl": "",
            "hostId": 88609800,
            "hostJoinUrl": "https://mtest.qsh1.cn/k/mkGLNxkT2N0",
            "hostName": "裴秀月",
            "hostsLayout": "",
            "houseList": [],
            "importance": 0,
            "isGnet": 1,
            "isPlugin": false,
            "isSharedMedia": 0,
            "joinConfSelTag": 0,
            "joinConfTags": "",
            "joinLogin": 0,
            "joinUrlType": 1,
            "jointHostUrl": "",
            "jointHostVerifyUrl": "",
            "largeGroup": 0,
            "ledgerTag": "[]",
            "length": 60,
            "liveChannelID": 0,
            "liveCover": "",
            "liveOpenFlag": 0,
            "livePlaybackFlag": 0,
            "livePlaybackTime": 0,
            "livePullPwd": "",
            "livePullUrl": "",
            "liveScreen": 0,
            "liveViewFlag": 0,
            "location": "",
            "mailLang": 0,
            "meetingLanguage": "",
            "meetingRoom": 0,
            "modifyTime": 1648890522,
            "nochangeAttendList": null,
            "nochangeDeviceList": [],
            "oldConfHostId": 0,
            "oriStart": 0,
            "parJoinConfLogined": 0,
            "parentId": 0,
            "passwordFlag": 0,
            "pcode1": "201501000037413391",
            "pcode2": "201501000037413392",
            "recurrenceInfo": null,
            "rejectReason": "",
            "restLength": 0,
            "roomId": "",
            "sharedMedia": null,
            "sharedMediaInfo": null,
            "siteId": 176822,
            "sourceDomain": "testcloudb.quanshi.com",
            "startTime": 1648895400,
            "status": 4,
            "summary": "",
            "sv": 0,
            "telAccess": 0,
            "testAudienceUnionUrl": "",
            "timezone": "Asia/Shanghai",
            "timezoneForEmail": "Asia/Shanghai",
            "title": "%E8%A3%B4%E7%A7%80%E6%9C%88%E7%9A%84%E4%BC%9A%E8%AE%AE001",
            "uniformEnv": "",
            "updAttendList": null,
            "updateFlag": 0,
            "useWaitingRoom": 0,
            "usedConfTickets": 0,
            "videoConferenceMode": 0,
            "watchMcuVideoMode": 0,
            "wcallMonitorUrl": "",
            "wcallUrl": "https://dwz.cn/rDnO6ikw",
            "webRTCUrl": "https://mtest.qsh1.cn/k/mkGLNnkQY7o?priority=web",
            "wholeType": 0
        }
    ],
    "request_id": "uniformserver-172.10.57.235-1649314806.943280859.385",
    "reqid": "confopenapiserver-10.1.89.7-1649314806.767707000.847",
    "timestamp": 1649314806767,
    "content_type": "application/json",
    "product_type": "",
    "device_type": "",
    "iscycle": "",
    "isgnet": "",
    "mem_count": "",
    "verify": "",
    "video_conference_mode": "",
    "live_flag": "",
    "conferenceid": "",
    "record": 0,
    "share_media": 0,
    "hardware_video": 0,
    "accessNumber": "",
    "client_ip": "",
    "request_duration": "360.0206ms"
}

返回参数说明

参数名 类型 说明
status int 0:成功，非0失败
result json字符串 预约会议返回的结果

result参数说明

参数名 类型 说明
eventId int 日程id
title string 会议主题
summary string 会议概要
location string 会议地址
startTime int 会议开始时间
endTime int 会议结束时间
length int 会议时长
restLength int  
isGnet int 是否云会议，0：否，1：是
audioConferenceType int 是否电话会议，0：否，1：是
conferenceId string 会议id
billingCode string 计费码
pcode1 string 主持人入会密码
pcode2 string 参会人入会密码
groupId int 群组id
confHostId int 中小企业创建人id
capacity int 会议室方数
hostId int 创建人id
hostName string 创建人名称
siteId int 站点id
calType string 会议类型，E：单场会议，M：周期会议
status int 会议状态,0:已取消，1：已创建，4：已结束
eventSource int 用于控制是否关联exchange，若关联不发邮件和标识日程创建端，0：未关联 1：关联, 2: web端会议
extrasInfo string 扩展信息
roomId string 会议室id
oriStart int  
timezone string 时区
importance int 重要性，0：否，1：是
attendList ——-ajson 参会人信息
attendList->user string 参会人id
attendList->userType int 参会人类型，1：内部参会人，2：外部参会人，3：电话参会人
attendList->phoneName string 电话参会人名称
attendList->phoneEmail string 电话参会人邮箱
attendList->status string 参会人状态，W:已确认，A：已接受，R:拒绝
attendList->productStatus int  
attendList->countryCode string 国家码
attendList->companyName string 所属公司名称
attendList->orgName string 所属组织名称
attendList->contactId string  
attendList->mobileNumber string 手机号
attendList->officePhone string 办公电话
attendList->cityCode string 城市码
attendList->displayName string 显示名称
houseList array 会议室列表
equipList array 设备列表
sharedMedia json 是否有共享影音，0：否，1：是
allowExternal int  
attendeeJoinUrl string 参会人入会链接
hostJoinUrl string 创建人入会链接
meetAttendeeJoinUrl string 云会议参会人入会链接
meetHostJoinUrl string 云会议主持人入会链接
joinUrlType int 入会连接类型
uniformEnv string  
mailLang int 邮件语言
isPlugin bool  
detailHouseList json 会议室详情，如下
allowHardVideo int 是否允许硬件视频，0：否，1：是
allowBox int 是否允许盒子入会，0：否，1： 是
allowLync int 是否允许Lync入会， 0：否，1：是
appSource string 产品类型，tb：蜜蜂，uc：空间
videoConferenceMode int  
largeGroup int 是否超大组，0：否，1：是
livePullUrl string 直播链接
livePullPwd string 入直播密码
liveViewFlag int 直播观看类型 0：所有人都可以观看 1：有密码 2：需要认证身份 默认值为0
livePlaybackFlag int 回访类型; -1:不允许回看;;0:永不过期; 1:自定义过期时间;2:1个月有效;3:3个月有效
livePlaybackTime int 过期时间 仅当livePlaybackFlag为1至3时有效,取值范围：-1：不允许回看 ，0：永不过期，其他是时间戳
sourceDomain string  
sharedMediaInfo json 共享影音信息
liveOpenFlag int 是否允许直播，0：否，1：是
wcallurl string 云会议电话会议链接
accessNumberInfo object 接入号信息
enable bool 是否有接入号
accessNumber_zh string 中文接入号
accessNumber_en string 英文接入号
accessNumber_url string 接入号链接
confNodeType int 会议节点类型 0:保密会议(默认）1:标准会议
hostsLayout string “1-4” (可选视频布局，“1-4”：4路平均布局；“1-7”：1+7布局；“1-21”：1+21布局：默认：“1-7”)，如果没有此属性，则默认是“1-7”
watchMcuVideoMode int 可选0、1和2，1表示观看多路云会议视频模式，2表示观看多路硬件视频模式，0表示既不是1模式也不是2模式。
joinLogin int 0:参会入会不需要先登录（默认） 1:参会人入会必须先登录
approvalStatus int 日程申请状态, 0无需审批, 1待审批, 2审批通过 3审批拒绝，只有日程是直播活动时才有值，默认0
creatorUserId int 活动创建人userId，和会议主持人不同，相当于助理，只有日程是直播活动时才有值，默认0
creatorName int 活动创建人name，和会议主持人不同，相当于助理，只有日程是直播活动时才有值，默认“”
jointHostUrl string 助理链接（联系主持人链接)，只有日程是直播活动时才有值，默认“”
approvalName string 审批人名，只有日程是直播活动时才有值，默认“”
rejectReason string 拒绝的原因，只有日程是直播活动时才有值，默认“”
joinConfSelTag int 是否入会选择标签配置（0:否，1:是）
joinConfTags string 入会标签字符串,标签之间逗号分隔
eventForm int 活动形式，1:电话，2:网络，3:电话+网络，4:直播，5:电话+直播，6:网络+直播，7:电话+网络+直播
wcallMonitorUrl string 电话活动的监控链接
audienceUnionUrl string 观众落地页链接
guestJoinUrl string 嘉宾入会链接
audienceJoinUrl string 观众入会链接
liveScreen int 云活动手机屏幕显示方式，0:横屏（默认）1：竖屏
eventManualService int 是否需要人工服务开关，0：没有传递值，1：开启，2：关闭，默认1
calExtraInfo object 会议设置参数
webRTCUrl string webRTC 入会链接
accessNumers json对象 接入号信息, “Zh-cn”:中文接入号。”En-us“：英文接入号 “ChooseBySelf”:自选（一般没有）

calExtraInfo结构

参数名 类型 说明
allowH323 int 用来控制是否显示h323。0:关闭 1：开启 默认关闭
openWatchword int 是否开启入会口令开关，0：否，1：是，默认0
eventWatchword string 入会口令，默认空
labels string 活动标签字符串数组json字符串

houseList和equipList结构

参数名 类型 说明
DeviceId int 设备id
DeviceType int 设备类型，2：会议室；3：会议室关联的设备
DeviceName string 设备名称
City string 会议室所在城市
Location string 会议室所在地址
Floor int 会议室所在楼层
IsMainRoom int 会议室类型，0：默认值（用于兼容openapi一场会预约多个会议室的需求）；1：主会场；2：分会场
ParentDeviceId int 父设备id
ParentDeviceType int 父设备类型，2：会议室；3：会议室关联的设备
ApplyUserId int 申请人id
ApprovalStatus int 申请状态,0:待审核；1:未批准;2:已批准 ，3：会议室被取消

houseList和equipList参数示例

[{"DeviceId":6518,
"DeviceType":2,
"DeviceName":"杏花村",
"City":"西安",
"Location":"锦业路",
"Floor":14,
"IsMainRoom":0,
"ParentDeviceId":0,
"ParentDeviceType":0,
"ApplyUserId":22563698,
"ApprovalStatus":1
},
{"DeviceId":6516,
"DeviceType":2,
"DeviceName":"杏花村2",
"City":"西安",
"Location":"锦业路",
"Floor":14,
"IsMainRoom":0,
"ParentDeviceId":0,
"ParentDeviceType":0,
"ApplyUserId":22563698,
"ApprovalStatus":1
}]

detailHouseList结构

参数名 类型 说明
ApplyUserId int 会议室申请人用户id
ApplyStatus int 会议室审批状态,0:待审核；1:未批准;2:已批准 ，3：会议室被取消
DeviceId int 会议室id
DeviceName string 会议室名称
City string 会议室所在城市
Location int 会议室所在地址
Floor string 会议室所在楼层
DeviceType int 设备类型，2：会议室；3：会议室关联的设备
IsMainRoom int 会议室类型，0：默认值（用于兼容openapi一场会预约多个会议室的需求）；1：主会场；2：分会场
SubDevices json 会议室设备
DeviceId int 会议室设备id
DeviceName string 会议室设备名称
DeviceType int 会议室设备类型

detailHouseList参数示例

[{
"DeviceId":6516,
"DeviceType":2,
"DeviceName":"杏花村2",
"City":"西安",
"Location":"锦业路",
"Floor":14,
"IsMainRoom":0,
"ApplyUserId":22563698,
"ApprovalStatus":1,
SubDevices:[{
    "DeviceId":6546,
    "DeviceType":3,
    "DeviceName":"盒子"
    },
    {
    "DeviceId":6547,
    "DeviceType":3,
    "DeviceName":"盒子2"
    }]
}]

accessNumbers返回参数说明

参数名 类型 说明
area string 区域
number string 接入号码
chooseBySelf string 是否有自选，默认0

产品

支持

关于全时

下载

关注我们


全时微信公众号
24小时热线
400-810-1919