证券版会议管理
证券版新建单场会议
1. 接口描述
接口名称:
/eventopenapi/single/event/create
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
token | String | 是 | 统一鉴权token |
meetingType | Integer | 否 | 会议类型 1:分析师会议 2:上市公司会议 3:专家会议 4:小范围交流会 5.晨会 6.在线培训 7.指定范围会议 |
meetingForm | Int | 是 | 会议方式 1:电话会议,2:网络会议,4:保密会议 |
hostId | Long | 是 | 主持人ID(可通过 https://developer.quanshi.com/cn/api/122 查询) |
title | String | 是 | 会议主题, 主题不能超过30个字 |
startTime | Long | 是 | 开始时间(时间戳,单位秒) |
length | Int | 是 | 会议时长(单位分钟) |
liveCover | String | 否 | 活动间(直播)封面图URL 尺寸1280x720px 图片小于2MB(jpg、png) |
summary | String | 否 | 会议简介 简介内容不能超过500个字, 目前支持受限的Html标记 分段:p, span, ul, li, br 图形:img 字体:strong, em, u |
manualService | Int | 否 | 是否需要项目经理开关,1: 开启,2: 关闭(默认1) |
callbackUrl | String | 否 | 会议回调地址 |
labels | Array | 否 | 活动标签 |
customStr | String | 否 | 自定义内容 |
extraInfo | Json | 否 | 会议扩展信息 |
participants | Json | 否 | 会议参会人列表 |
extraInfo
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
recommends | Array | 否 | 直播转播平台,1:在企业站点上公开, 8:每市, 16: choice, 32: 同花顺 |
recommendJoinLimit | Int | 否 | 直播转播观看条件, 1: 仅企业白名单客户才可参会, 7: 平台所有机构投资者均可参会 |
listedCompany | Json | 否 | 上市公司名称, meetingType=2时必填 |
participants
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
roleId | Long | 是 | 参会人角色ID(必须是会议详情中的btplRole字段定义的roleId,且managerType=2) |
userId | Long | 否 | 参会人UMSID(userId, email, mobile 三选一) |
name | String | 否 | 姓名 |
company | String | 否 | 公司 |
String | 否 | 邮箱 | |
countryCode | String | 否 | 国家码(默认86) |
mobile | String | 否 | 手机号 |
extendInfo | JSON | 否 | 扩展信息 |
participants->extendInfo 参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
description | String | 否 | 人员介绍 |
outcall | Integer | 否 | 是否外呼入会,0:否,1:是 |
listedCompany
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
customerName | String | 否 | 上市公司名称 |
stockCode | Integer | 否 | 代码 |
3. 输出参数
参数 | 类型 | 说明 |
---|---|---|
timeStamp | Long | 返回时间(时间戳,单位毫秒) |
requestId | String | 请求ID(在接口异常时, 需提供请求ID) |
code | Int | 返回的状态码 |
msg | String | 当返回结果的状态码不为200时,包含的错误信息 |
data | Json | 返回数据 |
data 参数说明
参数 | 类型 | 说明 |
---|---|---|
eventId | Long | 直播会议ID |
title | String | 会议主题 |
startTime | Long | 会议开始时间(时间戳,单位秒) |
length | Int | 会议时长(时间戳,单位分钟) |
eventForm | Int | 会议形式 1: 电话活动,3: 网络会议,4: 实时互动直播,7: 大型直播活动 |
summary | String | 会议概要 |
hostId | Long | 主持人ID |
billingCode | String | 云会议计费BC |
conferenceId | String | 云会议ID |
pcode1 | String | 主持人入会密码 |
pcode2 | String | 参会人入会密码 |
hostJoinUrl | String | 主持人入会链接 |
joinHostUrl | String | 助理主持人链接 |
guestJoinUrl | String | 嘉宾入会链接 |
audienceUnionUrl | String | 参会者链接 |
testAudienceUnionUrl | String | 测试会参会者链接 |
liveCover | String | 活动间(直播)封面图URL |
callbackUrl | String | 会议回调地址 |
liveScreen | Int | 云活动手机屏幕显示方式,0: 横屏,1:竖屏 |
manualService | Int | 是否需要项目经理开关,1:开启,2:关闭 |
liveLag | Int | 直播延迟设置 0:正常延迟,1:无延迟 |
labels | Array | 活动标签 |
customStr | String | 自定义内容 |
liveOpenFlag | Int | 开启实时互动直播 0: 否, 1: 是(仅针对eventForm=3有效) |
joinLimit | Int | 观众直播入会限制 0: 公开, 1: 白名单(非白名单(电话入会)拒绝入会) |
extraInfo | Json | 会议扩展信息 |
btplRole | Json | 专业活动角色信息 |
liveStreamUrl | Json Array | 直播平台拉流地址,当请求参数 isReturnLiveStreamUrl = 1 时返回 |
liveCode | String | 直播码,只有genLiveCode=1时,才会有值 |
liveStreamUrl 数组中的单个对象
参数 | 类型 | 说明 |
---|---|---|
rtmp_url | String | RTMP拉流地址 |
flv_url | String | FLV拉流地址 |
hls_url | String | HLS拉流地址 |
provider | String | 直播平台名称, netease:网易,tencent:腾讯,ali:阿里, ks: 金山, quanshi: 全时 |
layout_type | Int | 直播布局 1: PC布局(默认),2:移动竖屏(用于二期扩展) |
url_expire_time | Long | 过期时间(单位毫秒) |
audio_url | String | 单独音频流, 只在provider=quanshi的平台给出 |
extraInfo 参数
参数 | 类型 | 说明 |
---|---|---|
isTest | Int | 是否需要测试会议 0:否,1:是 |
isPublic | Int | 公共活动类型 0:非公开,1:公开 |
btplId | Int | 业务模板ID |
btplName | String | 业务模板名称 |
parentEventId | Long | 母直播的eventId |
parentRecordList | JSON | 转播录制ID数组 |
isDisableRecord | Int | 直播录制是否自动录制 1:手动录制, 0:自动录制 |
recommends | Array | 直播转播平台,1:在企业站点上公开, 8:每市, 16: choice, 32: 同花顺 |
recommendJoinLimit | Int | 直播转播观看条件, 1: 仅企业白名单客户才可参会, 7: 平台所有机构投资者均可参会 |
btplRole 参数
参数 | 类型 | 说明 |
---|---|---|
roleId | Int | 角色ID |
roleName | String | 角色名称 |
managerType | Int | 管理类型 1:管理者,2:辅助管理者(联席主持人),3:参会人, -1: 企业管理者 |
joinconfway | Int | 入会方式 1: 电话,2: 网络,3: 电话+网络,4: 直播 |
link | String | 入会链接 |
internallink | String | 内部使用链接 |
4. 示例
输入示例1: 创建标准活动
{
"startTime":{{startTime}},
"length":30,
"meetingForm":1,
"hostId":{{userId}},
"meetingType":2,
"labels":["1"],
"liveCover":"https://www.quanshi.com/themes/quanshi/images/case-yiliao.png",
"title":"{{title}}",
"extraInfo":{
"recommends":[1,2,4,8,16],
"joinLimits":[1],
"listedCompany":{
"stockCode":"22334",
"customerName":"2333333"
}
},
"participants":[
{"roleId":2,"email":"test@123.com","name":"mike"},
{"roleId":3,"email":"test@124.com","name":"jack"},
{"roleId":4,"email":"test@125.com","name":"mary"}
],
"summary":"this is a test"
}
输出示例
{
"timeStamp": 1729057192928,
"code": 200,
"msg": "Successfully to create the event!",
"data": {
"summary": "this is a test",
"eventId": 657347,
"liveCode": "",
"hostJoinUrl": "https://stest.qsh1.cn/a/HVCZeX7D39D4",
"length": 30,
"hostId": 88589613,
"liveStreamUrl": null,
"title": "2024-10-16 14:39:50 会议",
"customStr": null,
"joinHostUrl": "https://stest.qsh1.cn/a/GVCZeX985C32",
"labels": [
"1"
],
"billingCode": "95531313",
"pcode2": "201501000037768108",
"pcode1": "201501000037768107",
"conferenceId": "239836705",
"manualService": 2,
"audienceUnionUrl": "https://ltest.qsh1.cn/activity/gektXgcWl",
"btplRole": [
{
"managerType": 1,
"internallink": null,
"roleId": 1000,
"roleName": "主持人",
"link": "https://stest.qsh1.cn/a/HVCZeX7D39D4",
"joinconfway": 898
},
{
"managerType": 2,
"internallink": null,
"roleId": 1001,
"roleName": "联席主持人",
"link": "https://stest.qsh1.cn/a/GVCZeX985C32",
"joinconfway": 3987
},
{
"managerType": 3,
"internallink": "https://ntest.qsh1.cn/k/mLiyQe5qGHD?jointid=RlzbYrNDvnL1pGP8NENGC6PKWzeHOGiIpM7vPAWLS7xL4VJMtcdRoXPMoHmRIud2",
"roleId": 1003,
"roleName": "嘉宾",
"link": "https://ltest.qsh1.cn/activity/gektXgbWl",
"joinconfway": 1
},
{
"managerType": 3,
"internallink": "https://ntest.qsh1.cn/k/mLiyQe5qGHD?jointid=RlzbYrNDvnL1pGP8NENGC6PKWzeHOGiIpM7vPAWLS7ywuCRITaoikYGEKAQnAFKK",
"roleId": 1004,
"roleName": "观众",
"link": "https://ltest.qsh1.cn/activity/gektXgcWl",
"joinconfway": 1
}
],
"startTime": 1729058090,
"callbackUrl": null,
"guestJoinUrl": "https://ntest.qsh1.cn/k/mLiyQe5qGHD?jointid=RlzbYrNDvnL1pGP8NENGC6PKWzeHOGiIpM7vPAWLS7xL4VJMtcdRoXPMoHmRIud2",
"extraInfo": {
"btplName": "上市公司会议",
"btplId": 126999,
"recommends": [
1,
2,
4,
8,
16
],
"recommendJoinLimit": null,
"rebroadcast": null,
"liveConfig": null
}
},
"requestId": "127.0.0.1-1729057190927.5299624"
}