English

get_group_list

get_group_list只读群信息

获取群列表

Call via POST http://127.0.0.1:3000/get_group_list (JSON params as the body) or WebSocket.

Parameters

Param	Type	Required	Default	Description
`no_cache`	bool	–	`false`

Returns (data)

群信息对象数组。

Every response is wrapped in the standard envelope: { "status": "ok", "retcode": 0, "data": ... }. The table below describes data.

data is an array; each element:

Field	Type	Required	Description
`group_id`	integer	✓	群号
`group_name`	string	✓	群名
`group_remark`	string	✓	当前账号设置的群备注
`member_count`	integer	✓	当前成员数
`max_member_count`	integer	✓	成员上限
`group_create_time`	integer	–	建群时间戳（秒）
`group_level`	integer	–	群等级（列表批量场景恒 0，详见 get_group_info）
`group_memo`	string	–	群简介 / 公告预览
`group_all_shut`	integer (-1 / 0)	✓	是否开启全员禁言（-1 开启，0 关闭）

Raw JSON Schema

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "group_id": {
        "type": "integer",
        "description": "群号"
      },
      "group_name": {
        "type": "string",
        "description": "群名"
      },
      "group_remark": {
        "type": "string",
        "description": "当前账号设置的群备注"
      },
      "member_count": {
        "type": "integer",
        "description": "当前成员数"
      },
      "max_member_count": {
        "type": "integer",
        "description": "成员上限"
      },
      "group_create_time": {
        "type": "integer",
        "description": "建群时间戳（秒）"
      },
      "group_level": {
        "type": "integer",
        "description": "群等级（列表批量场景恒 0，详见 get_group_info）"
      },
      "group_memo": {
        "type": "string",
        "description": "群简介 / 公告预览"
      },
      "group_all_shut": {
        "type": "integer",
        "enum": [
          -1,
          0
        ],
        "description": "是否开启全员禁言（-1 开启，0 关闭）"
      }
    },
    "required": [
      "group_id",
      "group_name",
      "group_remark",
      "member_count",
      "max_member_count",
      "group_all_shut"
    ]
  }
}

Examples

curl

Python

JavaScript

SnowLuma SDK

curl -X POST http://127.0.0.1:3000/get_group_list \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer <access-token>' \
  -d '{"no_cache":false}'

Using an AI assistant?

MCP-capable clients can discover and call this action directly — no hand-written HTTP. See MCP.

ON THIS PAGE

get_group_list#

Parameters#

Returns (data)#

Examples#

get_group_list

Parameters

Returns (data)

Examples