跳转至

群组动作

get_guild_info 获取群组信息

字段名 数据类型 默认值 说明
guild_id string - 群组 ID
字段名 数据类型 默认值 说明
guild_id string - 群组 ID
guild_name string - 群组名称 
{
    "action": "get_guild_info",
    "params": {
        "guild_id": "123456"
    }
}

{
    "status": "ok",
    "retcode": 0,
    "data": {
        "guild_id": "12345",
        "guild_name": "一群大笨蛋"
    },
    "message": ""
}

get_guild_list 获取群组列表

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

无。

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

{
    "action": "get_guild_list",
    "params": {}
}

{
    "status": "ok",
    "retcode": 0,
    "data": [
        {
            "guild_id": "12345",
            "guild_name": "一群大笨蛋"
        },
        {
            "guild_id": "54321",
            "guild_name": "一群大笨蛋2群"
        }
    ],
    "message": ""
}

set_guild_name 设置群组名称

字段名 数据类型 默认值 说明
guild_id string - 群组 ID
guild_name string - 新群组名称

无。

{
    "action": "set_guild_name",
    "params": {
        "guild_id": "12345",
        "guild_name": "一个非常普通的群名"
    }
}

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

get_guild_member_info 获取群组成员信息

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

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

get_guild_member_list 获取群组成员列表

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

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

{
    "action": "get_guild_member_list",
    "params": {
        "guild_id": "123456"
    }
}

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

leave_guild 退出群组

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

无。

{
    "action": "leave_guild",
    "params": {
        "guild_id": "12345"
    }
}

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

get_channel_info 获取频道信息

字段名 数据类型 默认值 说明
guild_id string - 群组 ID
channel_id string - 频道 ID
字段名 数据类型 默认值 说明
channel_id string - 频道 ID
channel_name string - 频道名称 
{
    "action": "get_channel_info",
    "params": {
        "guild_id": "123456",
        "channel_id": "12"
    }
}

{
    "status": "ok",
    "retcode": 0,
    "data": {
        "channel_id": "12",
        "channel_name": "笨蛋频道"
    },
    "message": ""
}

get_channel_list 获取频道列表

获取指定群组中机器人可见的频道列表。

字段名 数据类型 默认值 说明
guild_id string - 群组 ID
joined_only bool false 只获取机器人账号已加入的频道列表

频道信息列表，数据类型为 list[resp[`get_channel_info`]]。

{
    "action": "get_channel_list",
    "params": {
        "guild_id": "12345"
    }
}

{
    "status": "ok",
    "retcode": 0,
    "data": [
        {
            "channel_id": "12",
            "channel_name": "笨蛋频道"
        },
        {
            "channel_id": "13",
            "channel_name": "聪明频道"
        }
    ],
    "message": ""
}

set_channel_name 设置频道名称

字段名 数据类型 默认值 说明
guild_id string - 群组 ID
channel_id string - 频道 ID
channel_name string - 新频道名称

无。

{
    "action": "set_channel_name",
    "params": {
        "guild_id": "12345",
        "channel_id": "13",
        "channel_name": "笨蛋频道2"
    }
}

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

get_channel_member_info 获取频道成员信息

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

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

get_channel_member_list 获取频道成员列表

字段名 数据类型 默认值 说明
guild_id string - 群组 ID
channel_id string - 频道 ID

频道成员信息列表，数据类型为 list[resp[`get_channel_member_info`]]。

{
    "action": "get_channel_member_list",
    "params": {
        "guild_id": "123456",
        "channel_id": "12"
    }
}

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

leave_channel 退出频道

字段名 数据类型 默认值 说明
guild_id string - 群组 ID
channel_id string - 频道 ID

无。

{
    "action": "leave_channel",
    "params": {
        "guild_id": "12345",
        "channel_id": "12"
    }
}

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