成员API

获取成员列表

GetMemberList

接口

地址版本方式权限
/api/v1/member/listv1POST群内开通成员隐私保护模式时,需要拥有成员管理-管理成员权限

描述

用于获取指定群的成员集合

提示

群内开通成员隐私保护模式时,需要拥有成员管理-管理成员权限

入参

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

出参

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

数据

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

列表项

字段类型说明
dodoIdstringDoDo号
nickNamestring群昵称
personalNickNamestringDoDo昵称
avatarUrlstring头像
joinTimestring加群时间
sexint性别,-1:保密,0:女,1:男
levelint等级
isBotint是否机器人,0:否,1:是
onlineDeviceint在线设备,0:无,1:PC在线,2:手机在线
onlineStatusint在线状态,0:离线,1:在线,2:请勿打扰,3:离开

入参示例

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

出参示例

{
    "data": {
        "maxId": 12345,
        "list": [{
                "dodoId": "666666",
                "nickName": "测试群昵称",
                "personalNickName": "测试DoDo昵称",
                "avatarUrl": "https://img.doufan.tv/dodo/71922683339a16fa6958bd00263f81ea.png",
                "joinTime": "2022-02-02 02:02:02",
                "sex": 1,
                "level": 1,
                "isBot": 0,
                "onlineDevice": 1,
                "onlineStatus": 1
            }
        ]
    },
    "status": 0,
    "message": "success"
}

获取成员信息

GetMemberInfo

接口

地址版本方式权限
/api/v1/member/infov1POST群内开通成员隐私保护模式时,需要拥有成员管理-管理成员权限

描述

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

提示

群内开通成员隐私保护模式时,需要拥有成员管理-管理成员权限

入参

字段类型必传说明
islandIdstring群号
dodoIdstringDoDo号

出参

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

数据

字段类型说明
islandIdstring群号
dodoIdstringDoDo号
nickNamestring群昵称
personalNickNamestringDoDo昵称
avatarUrlstring头像
joinTimestring加群时间
sexint性别,-1:保密,0:女,1:男
levelint等级
isBotint是否机器人,0:否,1:是
onlineDeviceint在线设备,0:无,1:PC在线,2:手机在线
onlineStatusint在线状态,0:离线,1:在线,2:请勿打扰,3:离开

入参示例

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

出参示例

{
    "data": {
        "islandId": "10001",
        "dodoId": "666666",
        "nickName": "测试群昵称",
        "personalNickName": "测试DoDo昵称",
        "avatarUrl": "https://img.doufan.tv/dodo/71922683339a16fa6958bd00263f81ea.png",
        "joinTime": "2022-02-22 02:02:02",
        "sex": 1,
        "level": 1,
        "isBot": 0,
        "onlineDevice": 1,
        "onlineStatus": 1,
    },
    "status": 0,
    "message": "success"
}

获取成员身份组列表

GetMemberRoleList

接口

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

描述

用于获取指定群下指定成员拥有的身份组集合

入参

字段类型必传说明
islandIdstring群号
dodoIdstringDoDo号

出参

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

数据

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

入参示例

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

出参示例

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

获取成员邀请信息

GetMemberInvitationInfo

接口

地址版本方式权限
/api/v1/member/invitation/infov1POST高级权限-超级管理员

描述

用于获取指定群下指定成员的邀请信息

提示

只对开通了邀请系统的群有效

入参

字段类型必传说明
islandIdstring群号
dodoIdstringDoDo号

出参

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

数据

字段类型说明
dodoIdstringDoDo号
nickNamestring群昵称
invitationCountint邀请人数

入参示例

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

出参示例

{
    "data": {
        "dodoId": "666666",
        "nickName": "测试群昵称",
        "invitationCount": 100
    },
    "status": 0,
    "message": "success"
}

编辑成员群昵称

SetMemberNickNameEdit

接口

地址版本方式权限
/api/v1/member/nickname/editv1POST成员管理-管理成员

描述

用于在指定群下编辑指定成员的群昵称

入参

字段类型必传说明
islandIdstring群号
dodoIdstringDoDo号
nickNamestring群昵称,昵称不能大于32个字符或16个汉字

出参

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

入参示例

{
    "islandId": "10001",
    "dodoId": "666666",
    "nickName": "群昵称编辑测试"
}

出参示例

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

禁言成员

SetMemberMuteAdd

接口

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

描述

用于在指定群下禁言指定成员

入参

字段类型必传说明
islandIdstring群号
dodoIdstringDoDo号
durationint禁言时长(秒),最长7天
reasonstring禁言原因,原因不能大于64个字符或32个汉字

出参

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

入参示例

{
    "islandId": "10001",
    "dodoId": "666666",
    "duration": 30,
    "reason": "禁言测试"
}

出参示例

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

取消成员禁言

SetMemberMuteRemove

接口

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

描述

用于在指定群下取消指定成员的禁言

入参

字段类型必传说明
islandIdstring群号
dodoIdstringDoDo号

出参

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

入参示例

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

出参示例

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

永久封禁成员

SetMemberBanAdd

接口

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

描述

用于在指定群下永久封禁指定成员

提示

按群限制,1次/10秒

入参

字段类型必传说明
islandIdstring群号
dodoIdstringDoDo号
noticeChannelIdstring通知频道ID
reasonstring封禁理由,理由不能大于64个字符或32个汉字

出参

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

入参示例

{
    "islandId": "10001",
    "dodoId": "666666",
    "noticeChannelId": "12345",
    "reason": "封禁测试"
}

出参示例

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

取消成员永久封禁

SetMemberBanRemove

接口

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

描述

用于在指定群下取消指定成员的永久封禁

入参

字段类型必传说明
islandIdstring群号
dodoIdstringDoDo号

出参

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

入参示例

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

出参示例

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