机器人API

获取机器人信息

GetBotInfo

接口

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

描述

用于获取当前机器人基础信息

入参

出参

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

数据

字段类型说明
clientIdstring机器人唯一标识
dodoIdstring机器人DoDo号
nickNamestring机器人昵称
avatarUrlstring机器人头像

出参示例

{
    "status": 0,
    "message": "success",
    "data": {
        "clientId": "88888888",
        "dodoId": "555555",
        "nickName": "测试机器人",
        "avatarUrl": "https://img.imdodo.com/dodo/465752845d9c99055716816f364537e4.png"
    }
}

机器人退群

SetBotIslandLeave

接口

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

描述

用于操作当前机器人退出指定群

入参

字段类型必传说明
islandIdstring群号

出参

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

入参示例

{
    "islandId": "10001"
}

出参示例

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

获取机器人邀请列表

GetBotInviteList

接口

地址版本方式权限
/api/v1/bot/invite/listv1POST

描述

用于获取可邀请机器人的用户集合

提示

开发者平台-授权管理-授权范围需开启仅被邀请可用

入参

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

出参

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

数据

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

列表项

字段类型说明
dodoIdstringDoDo号
nickNamestringDoDo昵称
avatarUrlstring头像

入参示例

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

出参示例

{
    "data": {
        "maxId": 12345,
        "list": [{
                "dodoId": "666666",
                "nickName": "测试DoDo昵称",
                "avatarUrl": "https://static.imdodo.com/DoDoRes/Avatar/6.png"
            }
        ]
    },
    "status": 0,
    "message": "success"
}

添加成员到机器人邀请列表

SetBotInviteAdd

接口

地址版本方式权限
/api/v1/bot/invite/addv1POST

描述

用于添加成员到机器人邀请列表

提示

开发者平台-授权管理-授权范围需开启仅被邀请可用

入参

字段类型必传说明
dodoIdstringDoDo号

出参

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

入参示例

{
    "dodoId": "666666"
}

出参示例

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

移除成员出机器人邀请列表

SetBotInviteRemove

接口

地址版本方式权限
/api/v1/bot/invite/removev1POST

描述

用于移除成员出机器人邀请列表

提示

开发者平台-授权管理-授权范围需开启仅被邀请可用

入参

字段类型必传说明
dodoIdstringDoDo号

出参

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

入参示例

{
    "dodoId": "666666"
}

出参示例

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