文档帮助平台
首页服务端API参考 会议管理 添加会议
添加会议
更新时间：2025-04-29 08:09:21

添加会议

请求方法

POST

请求地址

/users/{userId}/meetings

请求参数

请求参数 参数类型 数据类型 是否必须 参数说明
userId Path Integer 是 用户Id，长度32
profile Body Integer 否 会议模式，默认 ：0，可选值： 0 = 视频会议模式；2 = 研讨会模式; 3 = 语音会议模式
subject Body String 是 会议主题，长度小于128
conferencePassword Body String 否 会议密码 ，六位数字。未传该参数，表示使用个人会议配置；传入空值，代表密码为空；设置会议密码需传入该参数，并且密码为六位数数字
startDate Body String 是 会议开始日期，格式为yyyy-MM-dd，允许当前日期到未来1年内的日期。例：2019-12-01
startTime Body String 是 会议开始时间，格式为HH:mm，小时部分使用24小时计算。会议开始时间必须大于当前时间。例：19:05
zoneId Body String 否 时区id。没有值时，使用企业注册时设置的时区。具体时区列表信息详见基础信息-查询时区列表接口
durationHour Body Integer 是 会议持续时间小时部分，取值范围为[0, 48)。
durationMinute Body Integer 是 会议持续时间分钟部分，当durationHour为0时，可选值为：30、45；其他情况下，可选值为：0、15、30、45。：
recurrenceType Body Integer 否 周期会议循环类型，取值范围为：0：按天循环，1：按周循环，2：按月的第X天循环。此项没有值表示单次会议。 注意：直播类型的会议不能预约为周期会议
interval Body Integer 否 时间间隔，当recurrenceType为0和1时必输。
当recurrenceType为0时，取值范围为[1, 365]。
当recurrenceType为1时，取值范围为[1, 52]。
例：当recurrenceType为0时，interval = 2，表示每隔2天进行一个会议。
dayOfWeeks Body String[] 否 每周的周几，当recurrenceType为1时必输。取值范围为：1：星期日，2：星期一，3：星期二，4：星期三，5：星期四，6：星期五，7：星期六
rangeEndDate Body String 否 循环结束日期，格式为yyyy-MM-dd，当recurrenceType有值时必输。循环结束日期必须大于会议开始日期。最大可以选择1年以内的日期
remark Body String 否 备注，最大长度为300
participants Body Participant[] 否 参会成员列表。参会成员数量最大支持100个，默认创建者为组织者
extensionType Body Integer 否 会议扩展类型，取值范围为：1：RTMP、7：自有直播、8：自有直播+rtmp。注意，预约为RTMP的会议在编辑的时候不能变更为普通会议。
enableAutoRecord Body Boolean 否 是否开启自动录制，默认为个人信息-高级设置中的自动录制设置
speakMode Body Integer 否 发言模式类型，取值范围： 0：自由发言，1：举手发言，默认值为0
enableWaitingRoom Body Boolean 否 是否启用会议等候室 默认跟随个人会议设置
~~waitingRoomMode~~ Body Integer 否 已废弃，，支持旧版本兼容,请使用waitingRoomModeList这个字段。会议等候室设置，可选值：0=企业内所有人；1=仅主持人；2=企业内所有人及受邀参会者；3=仅受邀参会者 启用会议等候室设置时，必填
enableJoinAutoMute Body Boolean 否 是否入会自动静音 默认跟随个人会议设置
enableJoinForwardModerator Body Boolean 否 是否允许主持人之前加入 默认跟随个人会议设置
~~enableScreenShareWatermark~~ Body Boolean 否 已废弃,支持旧版本兼容,请使用enableWatermark字段。是否启用屏幕共享水印，默认跟随个人会议设置（启用需先开启仅登录用户入会）
enableWatermark Body Boolean 否 是否启用水印,默认跟随个人会议设置 （启用需先开启仅登录用户入会）
watermarkTransparency Body Integer 否 水印透明度，0：浅；1：中；2：深，默认跟随个人会议设置
watermarkFontSize Body Integer 否 水印文字大小，0：小；1：中；2：大，默认跟随个人会议设置
enableOnlyLoginUserJoin Body Boolean 否 是否启用仅登录用户入会 默认跟随个人会议设置 （关闭“仅登录用户入会”时需同步关闭水印）
conferenceTemplateId Body String 否 会议模板Id
language Header String 否 修改会议邮件通知会议日程的语言，默认为英文，中文：zh,英文：en
enableReachTimeAutoInvite Body Boolean 否 是否开启到点自动邀请，默认为个人信息-基础设置中的到点自动邀请设置，受企业强管控
waitingRoomModeList Body Integer[] 否 会议等候室设置（新），可选值：0=开启企业内所有人；1=开启受邀参会者；2=开启第三方入会Ip白名单 启用会议等候室设置时，必填。对于只传递字段waitingRoomMode的场景，已做兼容处理。如果同时传递字段waitingRoomMode和字段waitingRoomModeList，则取字段waitingRoomModeList的值。
isVideo Body Boolean 否 是否视频会议
rooms Body room[] 否 会议室ID列表，最大包含200条记录
rtmpWatchPwd Body String 否 直播密码，密码长度为4位。设置直播密码时,rtmpWatchLimitType的值应设置为1
rtmpRichTextRemark Body String 否 直播介绍
rtmpWatchLimitType Body Integer 否 直播观看限制类型，0：所有人，1：需要密码. 不传递，默认为0

HTTP状态码

返回值 描述
200 操作成功，详见响应参数
400 客户端传参异常
401 鉴权失败
500 服务端异常

响应参数

参数 数据类型 描述
id String 会议id

Participant对象定义

参数 参数类型 数据类型 是否必需 描述
id Body String 是 参会者id，长度小于64，若为外部参会者，可以为邮箱地址
role Body Integer 是 参会者角色，0：组织者（仅创建人）；1：主持人（仅用户或硬件终端）；2：参会者。
type Body Integer 否 参会者类型，0：内部参会者；1：外部参会者。默认：0

room对象定义

参数 参数类型 数据类型 是否必需 描述
roomId Body String 是 实体会议室id
type Body Integer 是 room类型，1：实体会议室

请求消息示例

POST /open/api/v2/users/3637ad2cc6d040aeaf27f78d8c8826db/meetings HTTP/1.1
Host: api.yealink.com
Content-Type: application/json

{
    "profile": 2,
    "subject": "test",
    "conferencePassword": "123456",
    "zoneId": "China_Standard_Time",
    "startDate": "2020-03-11",
    "startTime": "20:50",
    "durationHour": 2,
    "durationMinute": 0,
    "recurrenceType": null,
    "interval": 1,
    "dayOfWeeks": [
        3
    ],
    "rangeEndDate": "2020-03-13",
    "remark": "",
    "participants": [
        {
            "id": "3637ad2cc6d040aeaf27f78d8c8826db",
            "type": 0,
            "role": 0
        }
    ],
    "enableAutoRecord": false,
    "extensionType": 1,
    "speakMode": 1,
    "enableWaitingRoom": false,
    "waitingRoomMode": 3,
    "enableJoinAutoMute": false,
    "enableJoinForwardModerator": false,
    "enableScreenShareWatermark": false,
    "enableWatermark": true,
    "watermarkTransparency": 1, 
    "watermarkFontSize": 1,
    "conferenceTemplateId":"df5beef37533439695fbc672232fb67c",
    "enableOnlyLoginUserJoin": false,
     "isVideo": false,
    "rooms": [
        {
            "roomId": "3637ad2cc6d040aeaf27f78d8c8826db",
            "type": 1
        }
    ]
}

响应消息示例

HTTP/1.1 200 
Content-Type: application/json;charset=UTF-8

{
	"id":"0b889ae484e84ac8bd77ccd6402e3d45"
}

CURL命令示例

curl -XPOST -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' -d '{"profile": 2,"subject":"test","conferencePassword": "123456","zoneId":"China_Standard_Time","startDate":"2020-03-11","startTime":"20:50","durationHour":2,"durationMinute":0,"recurrenceType":null,"interval":1,"dayOfWeeks":[3],"rangeEndDate":"2020-03-13","remark":"","participants":[{"id":"3637ad2cc6d040aeaf27f78d8c8826db","type":0,"role":0}],"enableAutoRecord":false,"extensionType":1,"speakMode": 1,"enableWaitingRoom":false,"waitingRoomMode":3,"enableJoinAutoMute": false, "enableJoinForwardModerator": false,"enableScreenShareWatermark": false,"conferenceTemplateId":"df5beef37533439695fbc672232fb67c","enableOnlyLoginUserJoin": false}' 'https://api.yealink.com/open/api/v2/users/3637ad2cc6d040aeaf27f78d8c8826db/meetings'
本页目录