更新群发言权限

更新指定群组的发言权限，可设置为所有群成员可发言、仅群主或管理员可发言、指定群成员可发言。

前提条件

应用需要开启机器人能力。

使用限制

• 如果以用户身份（user_access_token）调用本接口，则该用户必须是群组的群主，才可以更新群发言权限。
• 如果以应用身份（tenant_access_token）调用本接口，则该应用机器人需要符合以下任一情况才可以更新群发言权限。
  • 机器人是群组的群主。
  • 机器人是群组的创建者、具备==更新应用所创建群的群信息（im:chat:operate_as_owner）== 权限，且仍在群组内。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/im/v1/chats/:chat_id/moderation
HTTP Method	PUT
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	im:chat 获取与更新群组信息 im:chat:moderation:write_only 操作群发言权限
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

路径参数

名称	类型	描述
chat_id	string	群 ID。获取方式： - 创建群，从返回结果中获取该群的 chat_id。 - 调用获取用户或机器人所在的群列表接口，可以查询用户或机器人所在群的 chat_id。 - 调用搜索对用户或机器人可见的群列表，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 示例值："oc_a0553eda9014c201e6969b478895c230"

查询参数

名称	类型	必填	描述
user_id_type	string	否	用户 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

请求体

名称	类型	必填	描述
moderation_setting	string	否	群发言模式 可选值有： - all_members：所有群成员可发言 - only_owner：仅群主或管理员可发言 - moderator_list：指定群成员可发言，取该值时需要选择设置 moderator_added_list 和 moderator_removed_list 示例值："moderator_list"
moderator_added_list	string\[\]	否	当 moderation_setting 取值为 moderator_list 时，以 ID 列表形式添加可发言的用户。 注意： - ID 类型与查询参数 user_id_type 取值一致，推荐使用 OpenID，获取方式可参考文档如何获取 Open ID。 - 列表内的用户如果不在群组内，则会被自动过滤掉。 - 请求时，请确保 moderator_added_list 和 moderator_removed_list 两个参数内的 ID 不重复。 示例值：["4d7a3c6g"]
moderator_removed_list	string\[\]	否	当 moderation_setting 取值为 moderator_list 时，以 ID 列表形式移除可发言的用户。 注意： - ID 类型与查询参数 user_id_type 取值一致，推荐使用 OpenID，获取方式可参考文档如何获取 Open ID。 - 列表内的用户如果不在群组内，则会被自动过滤掉。 - 请求时，请确保 moderator_added_list 和 moderator_removed_list 两个参数内的 ID 不重复。 示例值：["4d7a3c6g"]

请求体示例

{
    "moderation_setting": "moderator_list",
    "moderator_added_list": [
        "4d7a3c6g"
    ],
    "moderator_removed_list": [
        "4d7a3c6g"
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码	错误码	描述	排查建议
400	232001	Your request contains an invalid request parameter.	参数错误。请参考 API 文档参数描述，排查请求时参数是否填写有误。
400	232004	Such an app does NOT exist.	作为操作者的 app_id 不存在，请联系技术支持。
400	232006	Your request specifies a chat_id which is invalid.	无效的 chat_id，请检查 chat_id 是否正确。获取方式： - 创建群，从返回结果中获取该群的 chat_id。 - 调用获取用户或机器人所在的群列表接口，可以查询用户或机器人所在群的 chat_id。 - 调用搜索对用户或机器人可见的群列表，可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。
400	232009	Your request specifies a chat which has already been dissolved.	群组已被解散，无法操作。
400	232010	Operator and chat can NOT be in different tenants.	调用接口的操作者和被操作的群组不在同一租户下，无法操作。需确保当前的操作者和被操作的群组在同一租户下。
400	232011	Operator can NOT be out of the chat.	调用接口的操作者不在群组内，无法操作。你需要将当前调用 API 的应用或用户加入待操作的群组后重试。
400	232015	Your request specifies a member_id_type which is NOT supported.	无效的 user_id_type（或 member_id_type），请检查参数取值是否正确。参数详细说明可参考具体 API 文档内提供的参数描述。
400	232017	No Permission: If the operator is NOT owner or creator with the scope, the operator can NOT complete the request.	调用接口的操作者在群组中不具备群主、群创建者等管理身份，无法操作。 - 如果以用户身份（user_access_token）调用本接口，则该用户必须是群组的群主，才可以更新群发言权限。 - 如果以应用身份（tenant_access_token）调用本接口，则该应用机器人需要符合以下任一情况才可以更新群发言权限。 - 机器人是群组的群主。 - 机器人是群组的创建者、具备 更新应用所创建群的群信息（im:chat:operate_as_owner） 权限，且仍在群组内。
400	232019	The request has been rate limited.	触发群限流，请控制请求的速度，详情参见频控策略。
400	232025	Bot ability is not activated.	应用未启用机器人能力。你需要登录开发者后台，在应用详情页的 应用能力 > 添加应用能力 页面内，添加 机器人 能力，并发布应用使配置生效。具体操作参见机器人能力。
400	232033	The operator or invited bots does NOT have the authority to manage external chats without the scope.	当前被操作的群为外部群，暂不支持操作外部群。只有开启对外共享能力的机器人支持外部群，详情参见机器人支持外部群和外部用户单聊。
400	232034	The app is unavailable or inactivated by the tenant.	应用在本租户下未安装或未启用。需要先安装应用，再使用应用调用接口。
400	232060	This chat is banned.	群聊被禁言，如有疑问请咨询技术支持。
400	232092	Meeting in progress. Unable to modify group posting permissions.	会议进行过程中无法修改群发言权限。需等会议结束后重试。

更多错误码信息，参见通用错误码。