跳转至

群动作

get_group_info 获取群信息

字段名 数据类型 默认值 说明
group_id string - 群 ID
字段名 数据类型 默认值 说明
group_id string - 群 ID
group_name string - 群名称 
{
    "action": "get_group_info",
    "params": {
        "group_id": "123456"
    }
}

{
    "status": "ok",
    "retcode": 0,
    "data": {
        "group_id": "123456",
        "group_name": "一群大笨蛋"
    },
    "message": ""
}

get_group_list 获取群列表

获取机器人加入的群列表。

无。

群信息列表，数据类型为 list[resp[`get_group_info`]]。

{
    "action": "get_group_list",
    "params": {}
}

{
    "status": "ok",
    "retcode": 0,
    "data": [
        {
            "group_id": "123456",
            "group_name": "一群大笨蛋"
        },
        {
            "group_id": "654321",
            "group_name": "一群大笨蛋2群"
        }
    ],
    "message": ""
}

get_group_member_info 获取群成员信息

字段名 数据类型 默认值 说明
group_id string - 群 ID
user_id string - 用户 ID
字段名 数据类型 默认值 说明
user_id string - 用户 ID
user_name string - 用户名称/姓名/昵称
user_displayname string - 用户设置的群内显示名称或账号显示名称，若无则为空字符串 
{
    "action": "get_group_member_info",
    "params": {
        "group_id": "123456",
        "user_id": "3847573"
    }
}

{
    "status": "ok",
    "retcode": 0,
    "data": {
        "user_id": "3847573",
        "user_name": "我是大笨蛋",
        "user_displayname": "本群最菜的"
    },
    "message": ""
}

get_group_member_list 获取群成员列表

字段名 数据类型 默认值 说明
group_id string - 群 ID

群成员信息列表，数据类型为 list[resp[`get_group_member_info`]]。

{
    "action": "get_group_member_list",
    "params": {
        "group_id": "123456"
    }
}

{
    "status": "ok",
    "retcode": 0,
    "data": [
        {
            "user_id": "111222333",
            "user_name": "我是大笨蛋",
            "user_displayname": "本群最菜的"
        },
        {
            "user_id": "444555666",
            "user_name": "我是小笨蛋",
            "user_displayname": "本群最强的"
        }
    ],
    "message": ""
}

set_group_name 设置群名称

字段名 数据类型 默认值 说明
group_id string - 群 ID
group_name string - 新群名称

无。

{
    "action": "set_group_name",
    "params": {
        "group_id": "2452352435",
        "group_name": "一个非常普通的群名"
    }
}

{
    "status": "ok",
    "retcode": 0,
    "data": null,
    "message": ""
}

leave_group 退出群

字段名 数据类型 默认值 说明
group_id string - 群 ID

无。

{
    "action": "leave_group",
    "params": {
        "group_id": "2452352435"
    }
}

{
    "status": "ok",
    "retcode": 0,
    "data": null,
    "message": ""
}