群API

获取群列表

GetIslandList

接口

地址	版本	方式	权限
/api/v2/island/list	v2	POST	不需要权限

描述

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

入参

无

出参

字段	类型	说明
status	int	返回码
message	string	返回信息
data	list<object>	数据列表

数据

字段	类型	说明
islandSourceId	string	群ID
islandId	string	群号
islandName	string	群名称
coverUrl	string	群头像
memberCount	int	群总人数
onlineMemberCount	int	群在线人数
defaultChannelId	string	默认访问频道ID
systemChannelId	string	系统消息频道ID

出参示例

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

获取群信息

GetIslandInfo

接口

地址	版本	方式	权限
/api/v2/island/info	v2	POST	不需要权限

描述

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

入参

字段	类型	必传	说明
islandSourceId	string	是	群ID

出参

字段	类型	说明
status	int	返回码
message	string	返回信息
data	object	返回数据

数据

字段	类型	说明
islandSourceId	string	群ID
islandName	string	群名称
coverUrl	string	群头像
memberCount	int	群总人数
onlineMemberCount	int	群在线人数
description	string	群简介
defaultChannelId	string	默认访问频道ID
systemChannelId	string	系统消息频道ID
ownerDodoSourceId	string	群主DoDoID

入参示例

{
    "islandSourceId": "10001"
}

出参示例

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

获取群等级排行榜

GetIslandLevelRankList

接口

地址	版本	方式	权限
/api/v2/island/level/rank/list	v2	POST	不需要权限

描述

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

提示

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

入参

字段	类型	必传	说明
islandSourceId	string	是	群ID

出参

字段	类型	说明
status	int	返回码
message	string	返回信息
data	list<object>	数据列表

数据

字段	类型	说明
dodoSourceId	string	DoDoID
nickName	string	群昵称
level	int	等级
rank	int	排名，返回前100名

入参示例

{
    "islandSourceId": "10001"
}

出参示例

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

获取群禁言名单

GetIslandMuteList

接口

地址	版本	方式	权限
/api/v2/island/mute/list	v2	POST	成员管理-管理成员

描述

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

入参

字段	类型	必传	说明
islandSourceId	string	是	群ID
pageSize	int	是	页大小，最大100
maxId	long	是	上一页最大ID值，为提升分页查询性能，需要传入上一页查询记录中的最大ID值，首页请传0

数据

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

列表项

字段	类型	说明
dodoSourceId	string	DoDoID

入参示例

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

出参示例

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

获取群封禁名单

GetIslandBanList

接口

地址	版本	方式	权限
/api/v2/island/ban/list	v2	POST	成员管理-管理成员

描述

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

入参

字段	类型	必传	说明
islandSourceId	string	是	群ID
pageSize	int	是	页大小，最大100
maxId	long	是	上一页最大ID值，为提升分页查询性能，需要传入上一页查询记录中的最大ID值，首页请传0

数据

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

列表项

字段	类型	说明
dodoSourceId	string	DoDoID

入参示例

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

出参示例

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