解散群
通过 chat_id 解散指定群组。通过 API 解散群组后,群聊天记录将不会保存。
前提条件
应用需要开启机器人能力。
使用限制
如果以应用身份(tenant_access_token)解散群,则应用机器人需要符合以下任一情况。
- 应用机器人是群主。
- 应用机器人是群的创建者,且应用已开通 更新应用所创建群的群信息(im:chat:operate_as_owner)权限。
如果以用户身份(user_access_token)解散群,需要该用户是群主。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/im/v1/chats/:chat_id |
| HTTP Method | DELETE |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | im:chat 获取与更新群组信息 im:chat:delete 解散群 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
chat_id | string | 群 ID。获取方式: - 创建群,从返回结果中获取该群的 chat_id。 - 调用获取用户或机器人所在的群列表接口,可以查询用户或机器人所在群的 chat_id。 - 调用搜索对用户或机器人可见的群列表,可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。 注意:仅支持群模式为 group 的群组 ID。你可以调用获取群信息接口,在返回结果中查看 chat_mode 参数取值是否为 group。示例值:"oc_a0553eda9014c201e6969b478895c230" |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 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 | 232008 | Your request specifies a chat whose type is NOT supported currently. | 不支持的群模式(chat_mode)或群类型(chat_type)。本接口仅支持传入群模式为 group 的群组 ID,你可以调用获取群信息接口,在返回结果中查看 chat_mode 参数取值是否为 group。 |
| 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 | 232017 | No Permission: If the operator is NOT owner or creator with the scope, the operator can NOT complete the request. | 调用接口的操作者在群组中不具备群主、群创建者等管理身份,无法操作。 - 如果以应用身份(tenant_access_token)解散群,则应用机器人需要符合以下任一情况。 - 应用机器人是群主。 - 应用机器人是群的创建者,且应用已开通 更新应用所创建群的群信息(im:chat:operate_as_owner)权限。 - 如果以用户身份(user_access_token)解散群,需要该用户是群主。 |
| 400 | 232024 | Users do not have the visibility of the app, or the operator does not have collaboration permissions with the target users. | 机器人对用户没有可见性,或操作者与用户间没有协作权限。 - 如果是机器人对用户没有可见性,需要在开发者后台 > 应用详情页 > 应用发布 > 版本管理与发布 编辑应用对用户的可见性并发布应用。具体操作参考配置应用可用范围。 - 如果是操作者与用户之间没有协作权限,请检查是否与目标用户有协作权限,如屏蔽、未添加为联系人等。 |
| 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. | 应用在本租户下未安装或未启用。需要先安装应用,再使用应用调用接口。 |
更多错误码信息,参见通用错误码。
