Skip to content

设置主持人

设置会议的主持人。

Warning: 发起设置主持人的操作者必须具有相应的权限(如果操作者为用户,必须是会中当前主持人);该操作使用CAS并发安全机制,需传入会中当前主持人,如果操作失败可使用返回的最新数据重试

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/vc/v1/meetings/:meeting_id/set_host
HTTP MethodPATCH
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用vc:meeting 更新会议信息
字段权限要求> Tip: 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

路径参数

名称类型描述
meeting_idstring会议ID(视频会议的唯一标识,视频会议开始后才会产生)
示例值:"6911188411932033028"

查询参数

名称类型必填描述
user_id_typestring用户 ID 类型
示例值:open_id
可选值有
- open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多:如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的,在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID,应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多:如何获取 Union ID? - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内,一个用户的 User ID 在所有应用(包括商店应用)中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多:如何获取 User ID?
默认值open_id
当值为 user_id,字段权限要求contact:user.employee_id:readonly 获取用户 user ID

请求体

名称类型必填描述
host_usermeeting_user将要设置的主持人
  └ idstring用户ID
示例值:"ou_3ec3f6a28a0d08c45d895276e8e5e19b"
  └ user_typeint用户类型
示例值:1
可选值有
- 1: 飞书用户 - 2: rooms用户 - 3: 文档用户 - 4: neo单品用户 - 5: neo单品游客用户 - 6: pstn用户 - 7: sip用户
old_host_usermeeting_user当前主持人(CAS并发安全:如果和会中当前主持人不符则会设置失败,可使用返回的最新数据重新设置)
  └ idstring用户ID
示例值:"ou_3ec3f6a28a0d08c45d895276e8e5e19b"
  └ user_typeint用户类型
示例值:1
可选值有
- 1: 飞书用户 - 2: rooms用户 - 3: 文档用户 - 4: neo单品用户 - 5: neo单品游客用户 - 6: pstn用户 - 7: sip用户

请求体示例

json
{
    "host_user": {
        "id": "ou_3ec3f6a28a0d08c45d895276e8e5e19b",
        "user_type": 1
    },
    "old_host_user": {
        "id": "ou_3ec3f6a28a0d08c45d895276e8e5e19b",
        "user_type": 1
    }
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ host_usermeeting_user会中当前主持人
    └ idstring用户ID
    └ user_typeint用户类型
可选值有
- 1: 飞书用户 - 2: rooms用户 - 3: 文档用户 - 4: neo单品用户 - 5: neo单品游客用户 - 6: pstn用户 - 7: sip用户

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "host_user": {
            "id": "ou_3ec3f6a28a0d08c45d895276e8e5e19b",
            "user_type": 1
        }
    }
}

错误码

HTTP状态码错误码描述排查建议
500121001internal error服务器内部错误,如果重试无效可联系管理员
400121002not support暂不支持该功能
400121003param error参数错误,检查参数的取值范围(请按照上面字段说明自查)
403121005no permission无权限进行该操作,建议检查token类型、操作者身份以及资源的归属
409121006data conflict通常由于CAS机制导致,可在更新数据后重试
400122001meeting status unexpected会议状态不正确(例如:会中操作而会议不在进行中状态)
404122002meeting not exist所操作的会议不存在
400122003operator user not in meeting进行会中操作的用户必须在会中
400122004target user not in meeting会中操作的对象用户必须在会中
400122005cannot operate self用户进行会中操作时,操作对象不能是自己
400122009participant status not expected操作对象状态错误(例如:用户不在会议中)

内容来源:飞书开放平台 · 自动爬取整理