预约会议

功能说明

自 5.2-20260928 起支持在预约时配置 AI 预设（aiOptions）并绑定会议材料（materials）。模板/版式 ID 非法时硬失败；材料绑定失败时预约仍成功且 bindStatus=failed。与 transcriptionMode 字段并存。

自 5.2-20260928 和邮储 5.2-20260626f-20260814起支持创建预约会议时支持设置五项音视频参数（其中lineRateMin、lineRateMax 是5.2-240329支持过的；contentRatio、peopleMaxResFps、contentMaxResFps 为本次新增可选字段）。

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

默认接口请求频率限制：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-20240329 公有云
enterpriseId	String	Query	是	无	企业ID，通过管理平台-云视讯API获得	5.2-20240329 公有云
signature	String	Query	签名鉴权1.0（旧）：是签名鉴权2.0：否	无	API签名，参考签名鉴权	5.2-20240329 公有云
callLimit	boolean	Body	否	无	会议是否锁定（如果是true，那么会议将在开始时锁定，主动入会仅限预约会议参会者列表人员)	5.2-20240329 公有云
title	String	Body	是	无	会议标题非法参数提示：无效的title（空值）	5.2-20240329 公有云
address	String	Body	否	无	会议地址	5.2-20240329 公有云
details	String	Body	否	无	会议描述	5.2-20240329 公有云
startTime	long	Body	是	无	会议开始时间Unix毫秒时间戳；startTime和endTime必须成对出现,开始时间不得大于等于结束时间	5.2-20240329 公有云
endTime	long	Body	是	无	会议结束时间Unix毫秒时间戳;startTime和endTime必须成对出现,开始时间不得大于等于结束时间	5.2-20240329 公有云
participants	List	Body	否	无	参加会议的参会者列表，最大支持200预约人，可以申请扩充	5.2-20240329 公有云
└type	String	Body	否	无	小鱼手机号：account 邮箱：email 小鱼设备号：deviceNumber h323设备：h323Number 呼叫号码：callNumber 三方用户id:externalUserId	5.2-20240329 公有云其中 externalUserId 自5.2-20250627 开始支持，不存在的用户自动创建，最大不存在人数为20，如果超限，可以重试（首次调用时已自动创建）。
└value	String	Body	否	无	参会者type对应的值	5.2-20240329 公有云
meetingHost	List	Body	否	无	会议主持人集合（主持人最多不超过100个，硬终端为deviceId且只支持以下型号AE350,AE380,NE90;软终端为手机号）。注意，风铃下默认设置了系统操作员为主持人，所以最大支持 99 个	5.2-20240329 公有云
└type	String	Body	否	无	小鱼手机号：account 邮箱：email 小鱼设备号：deviceNumber 呼叫号码：callNumber	5.2-20240329 公有云
└value	String	Body	否	无	主持人type对应的值	5.2-20240329 公有云
autoInvite	int	Body	否	0	开会时，是否自动呼叫小鱼终端入会。0：不自动呼叫，为默认值；1：自动呼叫	5.2-20240329 公有云
meetingRoomNumber	String	Body	是	无	预约会议时使用的云会议室号	5.2-20240329 公有云
autoRecord	int	Body	否	0	自动录制，0：不自动录制；1：自动录制	5.2-20240329 公有云
needInviteCallback	boolean	Body	否	false	是否返回邀请入会回调（需同时注册邀请入会回调）	5.2-20240329 公有云
enableOffLineRecord	int	Body	否	无	是否开启离线录制，0：实时转码录制；1：离线转码录制	5.2-20240329 公有云
offlineTranscodePriority	String	Body	否	无	离线转码优先级（high，normal）	5.2-20240329 公有云
transcriptionMode	Integer	Body	否	无	文字转写使用模式 0 不开启文字转写 1 开启录制时，同时开启文字转写 2 会议开启后，自动开启文字转写注：文字转写，需要企业购买转写License，并为会议室配置授权	5.2-20250926 公有云不存在
aiOptions	Object	Body	否	无	AI 预设（转写/纪要开关、纪要模板、Word 版式）。未传则不设置。与 transcriptionMode 并存，互不影响。	5.2-20260928 公有云不存在
└transcriptionEnabled	Boolean	Body	否	无	是否开启转写预设	5.2-20260928 公有云不存在
└minutesEnabled	Boolean	Body	否	无	是否开启会议纪要预设	5.2-20260928 公有云不存在
└minutesTemplateId	String	Body	否	无	会议纪要模板 ID。非法 ID 硬失败，预约不创建/不更新。	5.2-20260928 公有云不存在
└wordStyleId	String	Body	否	无	纪要 Word 版式 ID。非法 ID 硬失败。	5.2-20260928 公有云不存在
materials	Array	Body	否	无	创建时绑定的会议材料列表。单次最多 50 条；materialId 对应材料中心 docId。绑定失败时预约仍成功，对应项 bindStatus=failed。	5.2-20260928 公有云不存在
└materialId	String	Body	是	无	材料 ID。必填；最长 512；禁止含 .. / \。	5.2-20260928 公有云不存在
└useForAi	Boolean	Body	否	无	是否用于 AI 分析	5.2-20260928 公有云不存在
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-20240329 公有云
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-20240329 公有云
meetingSponsor	Json	Body	否	无	会议预约人	5.2-20240329 公有云
└type	String	Body	否	无	小鱼手机号：account 邮箱：email 呼叫号码：callNumber	5.2-20240329 公有云
└value	String	Body	否	无	会议预约人type对应的值	5.2-20240329 公有云
mainImage	Json	Body	否	无	主画面设备	5.2-20240329 公有云
└type	String	Body	否	无	小鱼设备号：deviceNumber h323设备：h323Number	5.2-20240329 公有云
└value	String	Body	否	无	主画面type对应的值	5.2-20240329 公有云
recordViewLayout	Json	Body	否	无	会议录制布局,详细结构可见下方示例	5.2-20240329 公有云
└mainLayout	Json	Body	否	无	会议主录制布局，详细结构可见下方示例	5.2-20240329 公有云
└extrasLayout	Json	Body	否	无	会议多路录制布局，需要对云会议室申请权限，最多限制5路	5.2-20240329 公有云
└ layout	--	Body	否	无	画面布局配置	5.2-20240329 公有云
└ screen	String	Body	否	无	横竖屏类型，可选值"landscape"（横屏），"portrait"（竖屏）	5.2-20240329 公有云
└ people	--	Body	否	无	只有people情况下的布局配置	5.2-20240329 公有云
└ maxCells	Integer	Body	否	无	最大窗口数量，实际参会人数超过maxCells时，只显示maxCells个人	5.2-20240329 公有云
└ view	String	Body	否	无	布局类型，可选值包括： asymOverlap：非对称叠加； asymTiling：非对称平铺； symTiling：对称平铺	5.2-20240329 公有云
└ mode	String	Body	否	无	布局模式："auto"（自动布局：主会场优先）	5.2-20240329 公有云
└ specified	List	Body	否	无	指定画面终端列表	5.2-20240329 公有云
└ └ type	String	Body	否	无	小鱼手机号：account 邮箱：email 小鱼设备号：deviceNumber h323设备：h323Number 呼叫号码：callNumber	5.2-20240329 公有云
└ └ value	String	Body	否	无	指定的终端类型type对应的值	5.2-20240329 公有云
└ content	--	Body	否	无	只有content情况下的布局配置	5.2-20240329 公有云
└ maxCells	Integer	Body	否	无	最大窗口数量，实际参会人数超过maxCells时，只显示maxCells个人	5.2-20240329 公有云
└ view	String	Body	否	无	布局类型，可选值： "asymOverlap"（非对称叠加）, "asymTiling"（非对称平铺）, "symTiling"（对称平铺）	5.2-20240329 公有云
└ mode	String	Body	否	无	布局模式："auto"（自动布局：主会场优先）	5.2-20240329 公有云
└ prefer	boolean	Body	否	false	指示是否content（第一分屏）幕显示，可选值：true（#1分屏）, false（#2分屏）	5.2-20240329 公有云
└ OSD	--	Body	否	无	叠加在视频上的附属信息	5.2-20240329 公有云
└ nameplate	--	Body	否	无	叠加终端名称	5.2-20240329 公有云
└ enabled	boolean	Body	否	无	是否启动功能，可选值：true：叠加；false：不叠加	5.2-20240329 公有云
hotWords	List	Body	否	无	预约会议热词	5.2-20260626 公有云不存在
contentRatio	String	Body	否	未传或 null 时保留原值；传 0.0 重置为自动	内容占比；0.0 表示自动。允许值：0.0、0.3、0.5、0.7	5.2-20260928 邮储 5.2-20260626f-20260814 公有云不存在
peopleMaxResFps	String	Body	否	未传或 null 时保留原值	视频最大分辨率与帧率。允许值：3840_216030、1920_108060、1920_108030、1280_72060、1280_720*30	5.2-20260928 邮储 5.2-20260626f-20260814 公有云不存在
contentMaxResFps	String	Body	否	未传或 null 时保留原值	内容共享最大分辨率与帧率。允许值与 peopleMaxResFps 相同	5.2-20260928 邮储 5.2-20260626f-20260814 公有云不存在

录制布局

通过预约会议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"
        },
        {
            "type": "externalUserId",
            "value": "xxxxxx"
        }
    ],
    "meetingSponsor": {
        "type": "account",
        "value": "xxxxxx"
    },
    "hotWords": ["Qos", "k8s", "小鱼易连"],
    "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
                }
            }
        }
    }
,
    "aiOptions": {
        "transcriptionEnabled": true,
        "minutesEnabled": true,
        "minutesTemplateId": "tpl_xxxxxx",
        "wordStyleId": "style_xxxxxx"
    },
    "materials": [
        {
            "materialId": "mat_xxxxxx",
            "useForAi": true
        }
    ]
}

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

返回结果示例：

{
    "reminderId":"9680cec97da4af94017e0103d42a77b8",
    "meetingRoomNumber":"9100630037",
    "aiOptions": {
        "transcriptionEnabled": true,
        "minutesEnabled": true,
        "minutesTemplateId": "tpl_xxxxxx",
        "wordStyleId": "style_xxxxxx"
    },
    "materials": [
        {
            "materialId": "mat_xxxxxx",
            "useForAi": true,
            "bindStatus": "success",
            "parseStatus": 1
        }
    ]
}

返回参数说明

参数	说明
reminderId	预约会议id
meetingRoomNumber	云会议室号
aiOptions	实际保存的 AI 预设；未设置时可能为空
└transcriptionEnabled	转写预设开关
└minutesEnabled	纪要预设开关
└minutesTemplateId	纪要模板 ID
└wordStyleId	Word 版式 ID
materials	材料绑定结果列表
└materialId	材料 ID
└useForAi	是否用于 AI
└bindStatus	绑定结果：success / failed
└parseStatus	材料解析状态：0/1/2/3（服务端回写）

该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
1001	invalid.parameter	materials/aiOptions 参数非法（如 materialId 缺失/超长/含路径穿越、条数超限、模板/版式非法等，详见 developerMessage）
1001	invalid.parameter	会议已开始或已结束，不可更新 materials/aiOptions
2001	permission.denied	材料不属于当前企业或无权限绑定

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

2026-07-28 11:02:17

导出PDF文档