群API

获取群列表

GetIslandList

接口

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

描述

用于获取当前机器人加入的所有群的集合

入参

出参

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

数据

字段类型说明
islandIdstring群号
islandNamestring群名称
coverUrlstring群头像
memberCountint群总人数
onlineMemberCountint群在线人数
defaultChannelIdstring默认访问频道ID
systemChannelIdstring系统消息频道ID

出参示例

{
    "status": 0,
    "message": "success",
    "data": [{
            "islandId": "10001",
            "islandName": "测试群",
            "coverUrl": "https://img.imdodo.com/dodo/730ace7b311879cee67bbbea41018bbe.png",
            "memberCount": 1000,
            "onlineMemberCount": 500,
            "defaultChannelId": "1000101",
            "systemChannelId": "1000102"
        }
    ]
}

获取群信息

GetIslandInfo

接口

地址版本方式权限
/api/v1/island/infov1POST不需要权限

描述

用于获取指定群的详细信息

入参

字段类型必传说明
islandIdstring群号

出参

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

数据

字段类型说明
islandIdstring群号
islandNamestring群名称
coverUrlstring群头像
memberCountint群总人数
onlineMemberCountint群在线人数
descriptionstring群简介
defaultChannelIdstring默认访问频道ID
systemChannelIdstring系统消息频道ID

入参示例

{
    "islandId": "10001"
}

出参示例

{
    "data": {
        "islandId": "10001",
        "islandName": "测试群",
        "coverUrl": "https://img.imdodo.com/dodo/730ace7b311879cee67bbbea41018bbe.png",
        "memberCount": 1000,
        "onlineMemberCount": 500,
        "description": "这个是一个测试群",
        "defaultChannelId": "1000101",
        "systemChannelId": "1000102"
    },
    "status": 0,
    "message": "success"
}

获取群等级排行榜

GetIslandLevelRankList

接口

地址版本方式权限
/api/v1/island/level/rank/listv1POST不需要权限

描述

用于获取指定群的群等级排行榜

提示

只对开通了群等级的群有效

入参

字段类型必传说明
islandIdstring群号

出参

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

数据

字段类型说明
dodoIdstringDoDo号
nickNamestring群昵称
levelint等级
rankint排名,返回前100名

入参示例

{
    "islandId": "10001"
}

出参示例

{
    "status": 0,
    "message": "success",
    "data": [{
            "dodoId": "666666",
            "nickName": "测试群昵称",
            "level": 1,
            "rank": 1
        }
    ]
}

获取群禁言名单

GetIslandMuteList

接口

地址版本方式权限
/api/v1/island/mute/listv1POST成员管理-管理成员

描述

用于获取指定群的群禁言名单

入参

字段类型必传说明
islandIdstring群号
pageSizeint页大小,最大100
maxIdlong上一页最大ID值,为提升分页查询性能,需要传入上一页查询记录中的最大ID值,首页请传0

数据

字段类型说明
maxIdobject最大ID值
listlist<object>数据列表

列表项

字段类型说明
dodoIdstringDoDo号

入参示例

{
    "islandId": "10001",
    "pageSize": 100,
    "maxId": 0
}

出参示例

{
    "data": {
        "maxId": 12345,
        "list": [{
                "dodoId": "666666"
            }
        ]
    },
    "status": 0,
    "message": "success"
}

获取群封禁名单

GetIslandBanList

接口

地址版本方式权限
/api/v1/island/ban/listv1POST成员管理-管理成员

描述

用于获取指定群的群封禁名单

入参

字段类型必传说明
islandIdstring群号
pageSizeint页大小,最大100
maxIdlong上一页最大ID值,为提升分页查询性能,需要传入上一页查询记录中的最大ID值,首页请传0

数据

字段类型说明
maxIdobject最大ID值
listlist<object>数据列表

列表项

字段类型说明
dodoIdstringDoDo号

入参示例

{
    "islandId": "10001",
    "pageSize": 100,
    "maxId": 0
}

出参示例

{
    "data": {
        "maxId": 12345,
        "list": [{
                "dodoId": "666666"
            }
        ]
    },
    "status": 0,
    "message": "success"
}