身份组API

获取身份组列表

GetRoleList

接口

地址版本方式权限
/api/v1/role/listv1POST不需要权限

描述

用于获取指定群下身份组集合

入参

字段类型必传说明
islandIdstring群号

出参

字段类型说明
statusint返回码
messagestring返回信息
datalist<object>数据列表

数据

字段类型说明
roleIdstring身份组ID
roleNamestring身份组名称
roleColorstring身份组颜色
positionint身份组排序位置
permissionstring身份组权限值(16进制)

入参示例

{
    "islandId": "10001"
}

出参示例

{
    "status": 0,
    "message": "success",
    "data": [{
            "roleId": "12345678",
            "roleName": "测试身份组",
            "roleColor": "#ffffff",
            "position": 1,
            "permission": "1f"
        }
    ]
}

创建身份组

SetRoleAdd

接口

地址版本方式权限
/api/v1/role/addv1POST通用权限-管理权限与身份组

描述

用于在指定群下创建指定身份组

提示

按DoDo群限制,10次/30秒

入参

字段类型必传说明
islandIdstring群号
roleNamestring身份组名称,非必传,不传时设置为新的身份组,不能大于32个字符或16个汉字
roleColorstring身份组颜色,非必传,不传时默认为#333333,16进制HEX格式颜色码
positionint身份组排序位置,非必传,不传时默认为1,不可传比机器人身份组大的排序值
permissionstring身份组权限值(16进制),非必传,不传时默认为0

出参

字段类型说明
statusint返回码
messagestring返回信息
dataobject返回数据

数据

字段类型说明
roleIdstring身份组ID

入参示例

{
    "islandId": "10001",
    "roleName": "测试身份组",
    "roleColor": "#ffffff",
    "position": 1,
    "permission": "1f"
}

出参示例

{
    "status": 0,
    "message": "success",
    "data": {
        "roleId": "12345678"
    }
}

编辑身份组

SetRoleEdit

接口

地址版本方式权限
/api/v1/role/editv1POST通用权限-管理权限与身份组

描述

用于在指定群下编辑指定身份组

入参

字段类型必传说明
islandIdstring群号
roleIdstring身份组ID
roleNamestring身份组名称,非必传,不传时默认不改动,不能大于32个字符或16个汉字
roleColorstring身份组颜色,非必传,不传时默认不改动,16进制HEX格式颜色码
positionint身份组排序位置,非必传,不传时默认不改动,不可传比机器人身份组大的排序值
permissionstring身份组权限值(16进制),非必传,不传时默认不改动

出参

字段类型说明
statusint返回码
messagestring返回信息

入参示例

{
    "islandId": "10001",
    "roleId": "12345678",
    "roleName": "测试身份组",
    "roleColor": "#ffffff",
    "position": 1,
    "permission": "1f"
}

出参示例

{
    "status": 0,
    "message": "success"
}

删除身份组

SetRoleRemove

接口

地址版本方式权限
/api/v1/role/removev1POST通用权限-管理权限与身份组

描述

用于在指定群下删除指定身份组

入参

字段类型必传说明
islandIdstring群号
roleIdstring身份组ID

出参

字段类型说明
statusint返回码
messagestring返回信息

入参示例

{
    "islandId": "10001",
    "roleId": "12345678"
}

出参示例

{
    "status": 0,
    "message": "success"
}

赋予成员身份组

SetRoleMemberAdd

接口

地址版本方式权限
/api/v1/role/member/addv1POST通用权限-管理权限与身份组

描述

用于在指定群下为指定用户赋予指定身份组

入参

字段类型必传说明
islandIdstring群号
dodoIdstringDoDo号
roleIdstring身份组ID

出参

字段类型说明
statusint返回码
messagestring返回信息

入参示例

{
    "islandId": "10001",
    "dodoId": "666666",
    "roleId": "12345678"
}

出参示例

{
    "status": 0,
    "message": "success"
}

取消成员身份组

SetRoleMemberRemove

接口

地址版本方式权限
/api/v1/role/member/removev1POST通用权限-管理权限与身份组

描述

用于在指定群下为指定用户取消指定身份组

入参

字段类型必传说明
islandIdstring群号
dodoIdstringDoDo号
roleIdstring身份组ID

出参

字段类型说明
statusint返回码
messagestring返回信息

入参示例

{
    "islandId": "10001",
    "dodoId": "666666",
    "roleId": "12345678"
}

出参示例

{
    "status": 0,
    "message": "success"
}