Skip to content

判断用户或机器人是否在群里

根据使用的 access_token 判断对应的用户或者机器人是否在指定的群里。

前提条件

调用该接口的应用,需要开启机器人能力

使用限制

获取内部群信息时,操作者须与群组在同一租户下。

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/im/v1/chats/:chat_id/members/is_in_chat
HTTP MethodGET
接口频率限制1000 次/分钟、50 次/秒
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可im:chat 获取与更新群组信息 im:chat:readonly 获取群组信息 im:chat.members:read 查看群成员 im:chat.group_info:readonly 读取群信息(历史版本)

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

路径参数

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

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ is_in_chatboolean用户或者机器人是否在群中

响应体示例

json
{
    "code": 0,
    "msg": "success",
    "data": {
        "is_in_chat": false
    }
}

错误码

HTTP状态码错误码描述排查建议
400232004Such an app does NOT exist.作为操作者的 app_id 不存在,请联系技术支持
400232006Your request specifies a chat_id which is invalid.无效的 chat_id,请检查 chat_id 是否正确。获取方式: - 创建群,从返回结果中获取该群的 chat_id。 - 调用获取用户或机器人所在的群列表接口,可以查询用户或机器人所在群的 chat_id。 - 调用搜索对用户或机器人可见的群列表,可搜索用户或机器人所在的群、对用户或机器人公开的群的 chat_id。
400232010Operator and chat can NOT be in different tenants.调用接口的操作者和被操作的群组不在同一租户下,无法操作。需确保当前的操作者和被操作的群组在同一租户下。
400232025Bot ability is not activated.应用未启用机器人能力。你需要登录开发者后台,在应用详情页的 应用能力 > 添加应用能力 页面内,添加 机器人 能力,并发布应用使配置生效。具体操作参见机器人能力
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.应用在本租户下未安装或未启用。需要先安装应用,再使用应用调用接口。

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

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