预约会议

功能说明

企业预约新的会议，用于预约、管理会议日程。邀请终端参加特定主题会议，并支持设置自动录制、自动呼叫预约终端等功能。

默认接口请求频率限制：20次/秒。

实现方法

REST URL

POST https://sdk.xylink.com/api/rest/external/{version}/conference/reminder/create?enterpriseId=XXX&signature=XXX

请求参数说明

参数	参数类型	参数位置	是否必须	默认值	说明	初始平台
version	String	Path	是	无	v1	5.2（2024-0329版本）
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得	5.2（2024-0329版本）
signature	String	Query	签名鉴权1.0（旧）：是签名鉴权2.0：否	无	API签名，参考签名鉴权	5.2（2024-0329版本）
callLimit	boolean	Body	否	无	会议是否锁定（如果是true，那么会议将在开始时锁定，主动入会仅限预约会议参会者列表人员)	5.2（2024-0329版本）
title	String	Body	是	无	会议标题非法参数提示：无效的title（空值）	5.2（2024-0329版本）
address	String	Body	否	无	会议地址	5.2（2024-0329版本）
details	String	Body	否	无	会议描述	5.2（2024-0329版本）
startTime	long	Body	是	无	会议开始时间Unix毫秒时间戳 (开始时间不得大于等于结束时间)	5.2（2024-0329版本）
endTime	long	Body	是	无	会议结束时间Unix毫秒时间戳	5.2（2024-0329版本）
participants	List<Json>	Body	否	无	参加会议的参会者列表	5.2（2024-0329版本）
└type	String	Body	否	无	小鱼手机号：account 邮箱：email 小鱼设备号：deviceNumber h323设备：h323Number 呼叫号码：callNumber	5.2（2024-0329版本）
└value	String	Body	否	无	参会者type对应的值	5.2（2024-0329版本）
meetingHost	List	Body	否	无	会议主持人集合（主持人必须在参会者中，且主持人最多不超过3个，硬终端为deviceId且只支持以下型号AE350,AE380,NE90;软终端为手机号）	5.2（2024-0329版本）
└type	String	Body	否	无	小鱼手机号：account 邮箱：email 小鱼设备号：deviceNumber 呼叫号码：callNumber	5.2（2024-0329版本）
└value	String	Body	否	无	主持人type对应的值	5.2（2024-0329版本）
autoInvite	int	Body	否	0	开会时，是否自动呼叫小鱼终端入会。0：不自动呼叫，为默认值；1：自动呼叫	5.2（2024-0329版本）
meetingRoomNumber	String	Body	是	无	预约会议时使用的云会议室号	5.2（2024-0329版本）
autoRecord	int	Body	否	0	自动录制，0：不自动录制；1：自动录制	5.2（2024-0329版本）
needInviteCallback	boolean	Body	否	false	是否返回邀请入会回调（需同时注册邀请入会回调）	5.2（2024-0329版本）注：公有云暂不支持
enableOffLineRecord	int	Body	否	无	是否开启离线录制，0：实时转码录制；1：离线转码录制	5.2（2024-0329版本）
offlineTranscodePriority	String	Body	否	无	离线转码优先级（high，normal）	5.2（2024-0329版本）
lineRateMin	int	Body	否	无	云会议室会议速率选项，最低带宽可选值： -1\|128\|192\|256\|320\|384\|512\|768\|832\|1024\|1152\|1280\|1472\|1536\|1728\|1920\|2048\|2560\|3072\|3584\|4096	5.2（2024-0329版本）
lineRateMax	int	Body	否	无	云会议室会议速率选项，最高带宽可选值： -1\|128\|192\|256\|320\|384\|512\|768\|832\|1024\|1152\|1280\|1472\|1536\|1728\|1920\|2048\|2560\|3072\|3584\|4096	5.2（2024-0329版本）
meetingSponsor	Json	Body	否	无	会议预约人	5.2（2024-0329版本）
└type	String	Body	否	无	小鱼手机号：account 邮箱：email 呼叫号码：callNumber	5.2（2024-0329版本）
└value	String	Body	否	无	会议预约人type对应的值	5.2（2024-0329版本）
mainImage	String	Body	否	无	主画面设备	5.2（2024-0329版本）
└type	String	Body	否	无	小鱼设备号：deviceNumber h323设备：h323Number	5.2（2024-0329版本）
└value	String	Body	否	无	主画面type对应的值	5.2（2024-0329版本）
recordViewLayout	Json	Body	否	无	会议录制布局	5.2（2024-0329版本）
└mainLayout	Json	Body	否	无	会议主录制布局	5.2（2024-0329版本）
└extrasLayout	Json	Body	否	无	会议多路录制布局，需要对云会议室申请权限，最多限制5路	5.2（2024-0329版本）
└ layout	--	Body	否	无	画面布局配置	5.2（2024-0329版本）
└ screen	String	Body	否	无	横竖屏类型，可选值"landscape"（横屏），"portrait"（竖屏）	5.2（2024-0329版本）
└ people	--	Body	否	无	只有people情况下的布局配置	5.2（2024-0329版本）
└ maxCells	Integer	Body	否	无	最大窗口数量，实际参会人数超过maxCells时，只显示maxCells个人	5.2（2024-0329版本）
└ view	String	Body	否	无	布局类型，可选值包括： asymOverlap：非对称叠加； asymTiling：非对称平铺； symTiling：对称平铺	5.2（2024-0329版本）
└ mode	String	Body	否	无	布局模式："auto"（自动布局：主会场优先）	5.2（2024-0329版本）
└ specified	List<Json>	Body	否	无	指定画面终端列表	5.2（2024-0329版本）
└ └ type	String	Body	否	无	小鱼手机号：account 邮箱：email 小鱼设备号：deviceNumber h323设备：h323Number 呼叫号码：callNumber	5.2（2024-0329版本）
└ └ value	String	Body	否	无	指定的终端类型type对应的值	5.2（2024-0329版本）
└ content	--	Body	否	无	只有content情况下的布局配置	5.2（2024-0329版本）
└ maxCells	Integer	Body	否	无	最大窗口数量，实际参会人数超过maxCells时，只显示maxCells个人	5.2（2024-0329版本）
└ view	String	Body	否	无	布局类型，可选值： "asymOverlap"（非对称叠加）, "asymTiling"（非对称平铺）, "symTiling"（对称平铺）	5.2（2024-0329版本）
└ mode	String	Body	否	无	布局模式："auto"（自动布局：主会场优先）	5.2（2024-0329版本）
└ prefer	boolean	Body	否	false	指示是否content（第一分屏）幕显示，可选值：true（#1分屏）, false（#2分屏）	5.2（2024-0329版本）
└ OSD	--	Body	否	无	叠加在视频上的附属信息	5.2（2024-0329版本）
└ nameplate	--	Body	否	无	叠加终端名称	5.2（2024-0329版本）
└ enabled	boolean	Body	否	无	是否启动功能，可选值：true：叠加；false：不叠加	5.2（2024-0329版本）

录制布局

通过预约会议API进行预约时可指定会议的录制布局，支持横屏布局或竖屏布局，默认为横屏。横屏情况下支持以下四种布局类型：布局类型默认为POP，录制默认最大支持9分屏。画面布局模式默认按主会场优先的顺序排列，没有主会场的情况下，按语音激励顺序显示，同时平台支持按上图顺序指定各个分屏终端。当参会者或会场个数大于指定分屏个数时，画面将不会被显示。对于有内容共享的情况，可设置共享内容画面的分屏顺序为第1分屏或第2分屏，默认为第1分屏，支持按一定间隔时间自动切换。竖屏模式下，默认为非对称叠加，最大支持3分屏，布局样式如下：

请求消息体示例（Json）

{
    "title": "title-test",
    "startTime": xxxxxx,
    "endTime": xxxxxx,
    "meetingRoomNumber": "xxxxxx",
    "address": "address--test",
    "details": "details--test",
    "autoInvite": 1,
    "participants": [
        {
            "type": "account",
            "value": "xxxxxx"
        },
        {
            "type": "email",
            "value": "xxxxxx"
        },
        {
            "type": "deviceNumber",
            "value": "xxxxxx"
        },
        {
            "type": "callNumber",
            "value": "xxxxxx"
        },
        {
            "type": "h323Number",
            "value": "xxxxxx"
        }
    ],
    "meetingSponsor": {
        "type": "account",
        "value": "xxxxxx"
    },
    "recordViewLayout": {
        "mainLayout": {
            "layout": {
                "screen":"landscape",
                "people": {
                    "maxCells":1,
                    "view":"symTiling",
                    "mode":"auto",
                    "specified":[
                        {
                            "type": "account",
                            "value": "xxxxxx"
                        }
                    ]
                },
                "content":{
                    "view": "symTiling",
                    "mode": "auto",
                    "prefer": false
                }
            },
            "OSD": {
                "nameplate": {
                    "enabled": true
                }
            }
        }
    }
}

几种场景布局场景配置示例：

返回结果示例：

{
    "reminderId":"9680cec97da4af94017e0103d42a77b8",
    "meetingRoomNumber":"9100630037"
}

返回参数说明

参数	说明
reminderId	预约会议id
meetingRoomNumber	云会议室号

该API常见错误码

errorCode	userMessage	说明
9000101	invalid title	无效的title（空值）
9000102	invalid time	无效的时间（须满足startTime < endTime）
9000103	invalid password	无效的入会密码（须满足密码长度 < 16）
9000104	invalid participant type	无效的参会者类型（支持手机号, 邮箱，callNumber, 小鱼设备号, h323Number）
9000105	unknown participant	未知的参会者（参会者type满足, 但是value在小鱼世界不存在）
9000106	too many host	会议主持人超限（最大限度：3）
9000107	host.not.in.participant	会议主持人必须在会议参会者中
9000108	invalid reminderId	无效的预约会议id

其他错误码详细见小鱼RESTAPI错误码

2024-03-22 10:05:33

导出PDF文档