Skip to content

群 ID 说明 ​

调用创建群接口成功创建群组时,系统会自动生成一个群 ID,通过响应参数 chat_id 返回。群 ID 是一个群组的唯一标识,使用该 ID 可调用涉及群组的开放平台 OpenAPI,例如,发送消息、将用户或机器人拉入群聊、获取群信息等。

chat_id的格式是由oc_开头的字符串,例如:oc_a0553eda9014c201e6969b478895c230。

群 ID 获取方式 ​

不同场景的群 ID 获取方式不同,具体说明如下。

通过群设置页获取群 ID ​

Note

  • 需要将飞书客户端版本升级到 7.60 及以上。
  • 支持单聊或群聊两种模式。

群成员可以通过点击右上角的群菜单选项进入群设置页面,查看群 ID。

img_v3_02uh_0960ac8c-3983-4732-8506-c0702b88869g.jpg

通过 API 调试台一键获取群 ID ​

  1. 登录 API 调试台。

  2. 选择一个需要使用群 ID 的接口,例如指定群管理员。

    image.png

  3. 在 路径参数 页签,点击 选择群组。

  4. 在弹出的对话框中选择群组,并点击 复制群组 ID。

    image.png

    成功复制后,即可将群组 ID 粘贴到对应参数值中使用,如下图所示。

    image.png

调用 API 获取存量群 ID ​

  1. 创建应用并启用机器人能力。

  2. 将该应用机器人添加到需要获取群 ID 的群组内。

    在未知群 ID 的情况下,需要打开飞书客户端,在指定群组的 ··· > 设置 > 群机器人 > 添加机器人 内添加应用机器人。

  3. 调用获取用户或机器人所在的群列表或者搜索对用户或机器人可见的群列表接口,获取目标群组的 chat_id。

调用 API 新建群时获取 ​

  1. 创建应用并启用机器人能力。
  2. 以应用身份调用创建群接口,从响应结果中获取 chat_id。

获取单聊的 chat_id ​

群模式分为 群组、话题、单聊 三类,该类型可通过获取群信息接口的响应参数 chat_mode 查看,其中的 单聊 类型不同于 群组、话题 类型,单聊是指机器人与用户单独聊天的窗口。想要获取 单聊 类型的 chat_id,需要以下操作:

  1. 创建应用并启用机器人能力。

  2. 使用应用调用发送消息接口,向指定用户发送消息,并从响应结果中获取 chat_id。

    使用该 chat_id 获取群信息时,响应参数 chat_mode 取值为 p2p,即单聊。

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