Skip to content

获取群标签列表

TIP

群标签 是云湖的一种群内的用户身份组,相当于 身份组、头衔组 的概念

请求URL

请求类型

POST

请求示例

bash
curl --location 'https://chat-go.jwzhd.com/open-apis/v1/group/tag/list?token=016ec8e4d17a4fbda3ccb0e99b44aca0' \
--header 'Content-Type: application/json' \
--data '{
    "groupId": "307149245"
}'

请求头

bash
Content-Type: "application/json; charset=utf-8"

请求参数

字段类型是否必填说明
groupIdstring群组ID

权限说明

机器人需要在该群聊中

响应内容

字段类型说明
codeint响应代码
msgstring响应信息,包括异常信息
dataObject返回数据
data.listArray标签列表
data.list[].tagstring标签名称
data.list[].descstring标签描述
data.list[].colorstring标签颜色
data.list[].sortint64排序值

响应示例

json
{
    "code": 1,
    "data": {
        "list": [
            {
                "tag": "koishi测试群",
                "desc": "测试用户标签",
                "color": "#FF5733",
                "sort": 1
            },
            {
                "tag": "1",
                "desc": "测试用户标签",
                "color": "#FF5733",
                "sort": 1
            }
        ]
    },
    "msg": "success"
}
json
{
    "code": 1,
    "data": {
        "list": []
    },
    "msg": "success"
}

错误码说明

错误码说明
1002参数缺失或有误
1003未授权(非法token)
-1业务错误(如机器人不在群中等)