Skip to content

指定群管理员

指定群组,将群内指定的用户或者机器人设置为群管理员。

前提条件

应用需要开启机器人能力

使用限制

仅群组内的群主可以指定群管理员。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/im/v1/chats/:chat_id/managers/add_managers
HTTP MethodPOST
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可im:chat 获取与更新群组信息 im:chat.managers:write_only 添加、删除群管理员
字段权限要求> 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"

路径参数

名称类型描述
chat_idstring群 ID。获取方式:
- 创建群,从返回结果中获取该群的 chat_id。 - 调用获取用户或机器人所在的群列表接口,可以查询用户或机器人所在群的 chat_id。 - 调用搜索对用户或机器人可见的群列表,可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。
注意:仅支持群模式为 群组(group)话题(topic) 的群组 ID。你可以调用获取群信息接口,在返回结果中查看 chat_mode 参数取值是否为 grouptopic
示例值:"oc_a0553eda9014c201e6969b478895c230"

查询参数

名称类型必填描述
member_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? - app_id: 飞书开放平台应用的唯一标识。在创建应用时,由系统自动生成,用户不能自行修改。了解更多:如何获取应用的 App ID?
默认值open_id
当值为 user_id,字段权限要求contact:user.employee_id:readonly 获取用户 user ID

请求体

名称类型必填描述
manager_idsstring\[\]要设置为管理员的 ID,ID 类型与查询参数 member_id_type 取值一致。
- 如果是用户(member_id_type 取值为 user_id/open_id/union_id),推荐使用用户的 open_id,获取方式可参考文档如何获取 Open ID
- 如果是机器人(member_id_type 取值为 app_id),请参考如何获取应用的 App ID
注意
- 对于普通群,最多可指定 10 个管理员。 - 对于超大群,最多可指定 20 个管理员。 - 单次请求指定机器人时,最多可指定 5 个机器人。
超大群和普通群的区别,参见超大群与普通群有什么区别
示例值:["ou_9204a37300b3700d61effaa439f34295"]
数据校验规则
- 最大长度:50

请求体示例

json
{
    "manager_ids": [
        "ou_9204a37300b3700d61effaa439f34295"
    ]
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ chat_managersstring\[\]当前群组内,用户类型管理员的用户 ID。ID 类型与查询参数 member_id_type 取值一致(如果 member_id_type 取值 app_id,则当前参数返回的是用户 open_id)。
  └ chat_bot_managersstring\[\]当前群组内,机器人类型管理员的 App ID。

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "chat_managers": [
            "ou_9204a37300b3700d61effaa439f34295"
        ],
        "chat_bot_managers": [
            "cli_a10fbf7e94b8d01d"
        ]
    }
}

错误码

HTTP状态码错误码描述排查建议
400232001Your request contains an invalid request parameter.参数错误,参考接口文档提供的参数描述,检查输入参数是否有误。
400232009Your request specifies a chat which has already been dissolved.群组已被解散,无法操作。
400232011Operator can NOT be out of the chat.操作者不在群组中。你需要将当前调用 API 的应用或用户加入待操作的群组后重试。此外还需要符合当前接口的要求,例如应用机器人或者用户必须是群组的群主。
400232019The request has been rate limited.触发群限流,请控制请求的速度,详情参见频控策略
400232024Users do not have the visibility of the app, or the operator does not have collaboration permissions with the target users.机器人对用户没有可见性,或操作者与用户间没有协作权限。 - 如果是机器人对用户没有可见性,需要在开发者后台 > 应用详情页 > 应用发布 > 版本管理与发布 编辑应用对用户的可见性并发布应用。具体操作参考配置应用可用范围。 - 如果是操作者与用户之间没有协作权限,请检查是否与目标用户有协作权限,如屏蔽、未添加为联系人等。
400232025Bot ability is not activated.机器人能力未启用。你需要登录开发者后台进入应用详情页,在 应用能力 > 添加应用能力 功能页面内添加 机器人 能力,并发布应用使配置生效。具体操作参考如何启用机器人能力
400232027There are no valid members in the ID list specified in your request.成员 ID 列表为空或不存在有效的成员。请检查传入的 ID 是否有误。
400232033The operator or invited bots does NOT have the authority to manage external chats without the scope.当前被操作的群为外部群,暂不支持操作外部群。只有开启对外共享能力的机器人支持外部群,详情参见机器人支持外部群和外部用户单聊
400232034The app is unavailable or inactivated by the tenant.应用在本租户下未安装或未启用。需要先安装应用,再使用应用调用接口。
400232038The operator is not chat owner, no permission to complete the request.操作者不是群主,没有权限添加或删除管理员。
400232039The operation of Add/Delete chat managers has succeeded. But the current managers list was not returned due to service problems.增加或删除群管理员处理成功,但是由于服务问题未返回目前群组内的管理员名单。如需要得到群组内的管理员名单,可以尝试再次请求或者咨询技术支持
400232040The chat managers has reached the limit of maximum number.群管理员人数达到上限。你可以删除其他群管理员后重试。 - 对于普通群,最多可指定 10 个管理员。 - 对于超大群,最多可指定 20 个管理员。

更多错误码信息,参见通用错误码

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