GoCQHTTPExtend (onebot-sdk 0.3.1 API)

所有已知子接口:

BaseBot
```
public interface GoCQHTTPExtend
```
从以下版本开始:

2025/2/9 01:42

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`ActionData<CheckUrlSafelyResp>`	`checkUrlSafely(java.lang.String url)` 检查链接安全性安全等级, 1: 安全 2: 未知 3: 危险
`ActionRaw`	`createGroupFileFolder(long groupId, java.lang.String folderName)` 创建群文件文件夹
`ActionRaw`	`deleteEssenceMsg(int msgId)` 移出精华消息
`ActionRaw`	`deleteFriend(long friendId)` 删除好友
`ActionRaw`	`deleteGroupFile(long groupId, java.lang.String fileId, int busId)` 删除群文件
`ActionRaw`	`deleteGroupFileFolder(long groupId, java.lang.String folderId)` 删除群文件文件夹
`ActionRaw`	`deleteUnidirectionalFriend(long userId)` 删除单向好友
`ActionData<DownloadFileResp>`	`downloadFile(java.lang.String url)` 调用 go cq http 下载文件
`ActionData<DownloadFileResp>`	`downloadFile(java.lang.String url, int threadCount, java.lang.String headers)` 调用 go cq http 下载文件
`ActionList<EssenceMsgResp>`	`getEssenceMsgList(long groupId)` 获取精华消息列表
`ActionData<GroupAtAllRemainResp>`	`getGroupAtAllRemain(long groupId)` 获取群 @全体成员剩余次数
`ActionData<GroupFilesResp>`	`getGroupFilesByFolder(long groupId, java.lang.String folderId)` 获取群子目录文件列表
`ActionData<UrlResp>`	`getGroupFileUrl(long groupId, java.lang.String fileId, int busId)` 获取群文件资源链接
`ActionList<GroupMemberInfoResp>`	`getGroupMemberList(long groupId, boolean noCache)` 获取群成员列表
`ActionData<GroupFilesResp>`	`getGroupRootFiles(long groupId)` 获取群根目录文件列表
`ActionList<ChannelInfoResp>`	`getGuildChannelList(java.lang.String guildId, boolean noCache)` 获取子频道列表
`ActionList<GuildListResp>`	`getGuildList()` 获取频道列表
`ActionData<GuildMemberListResp>`	`getGuildMemberList(java.lang.String guildId, java.lang.String nextToken)` 获取频道成员列表由于频道人数较多(数万), 请尽量不要全量拉取成员列表, 这将会导致严重的性能问题尽量使用 getGuildMemberProfile 接口代替全量拉取 nextToken 为空的情况下, 将返回第一页的数据, 并在返回值附带下一页的 token
`ActionData<GuildMemberProfileResp>`	`getGuildMemberProfile(java.lang.String guildId, java.lang.String userId)` 单独获取频道成员信息
`ActionData<GuildMetaByGuestResp>`	`getGuildMetaByGuest(java.lang.String guildId)` 通过访客获取频道元数据
`ActionData<GetGuildMsgResp>`	`getGuildMsg(java.lang.String guildMsgId, boolean noCache)` 获取频道消息
`ActionData<GuildServiceProfileResp>`	`getGuildServiceProfile()` 获取频道系统内 BOT 的资料
`ActionData<ClientsResp>`	`getOnlineClients(boolean noCache)` 获取当前账号在线客户端列表
`ActionList<UnidirectionalFriendListResp>`	`getUnidirectionalFriendList()` 获取单向好友列表
`ActionData<VersionInfoResp>`	`getVersionInfo()` 获取版本信息
`ActionData<WordSlicesResp>`	`getWordSlices(java.lang.String content)` 获取中文分词
`ActionData<OcrResp>`	`ocrImage(java.lang.String image)` 图片 OCR
`ActionData<MsgId>`	`sendForwardMsg(WholeMessageEvent event, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> msg)` 发送合并转发
`ActionData<MsgId>`	`sendGroupForwardMsg(long groupId, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> msg)` 发送合并转发 (群)
`ActionRaw`	`sendGroupNotice(long groupId, java.lang.String content)` 发送群公告
`ActionRaw`	`sendGroupSign(long groupId)` 群打卡
`ActionData<GuildMsgId>`	`sendGuildMsg(java.lang.String guildId, java.lang.String channelId, java.lang.String msg)` 发送信息到子频道
`ActionData<MsgId>`	`sendPrivateForwardMsg(long userId, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> msg)` 发送合并转发 (私聊)
`ActionRaw`	`setBotProfile(java.lang.String nickname, java.lang.String company, java.lang.String email, java.lang.String college, java.lang.String personalNote)` 设置机器人账号资料
`ActionRaw`	`setEssenceMsg(int msgId)` 设置精华消息
`ActionRaw`	`setGroupPortrait(long groupId, java.lang.String file, int cache)` 设置群头像目前这个API在登录一段时间后因cookie失效而失效, 请考虑后使用
`ActionRaw`	`setGroupSpecialTitle(long groupId, long userId, java.lang.String specialTitle, int duration)` 设置群组专属头衔
`ActionRaw`	`uploadGroupFile(long groupId, java.lang.String file, java.lang.String name)` 上传群文件在不提供 folder 参数的情况下默认上传到根目录只能上传本地文件, 需要上传 http 文件的话请先下载到本地
`ActionRaw`	`uploadGroupFile(long groupId, java.lang.String file, java.lang.String name, java.lang.String folder)` 上传群文件在不提供 folder 参数的情况下默认上传到根目录只能上传本地文件, 需要上传 http 文件的话请先下载到本地
`ActionRaw`	`uploadPrivateFile(long userId, java.lang.String file, java.lang.String name)` 私聊发送文件

- 方法详细资料
  - getGuildMemberList
```
ActionData<GuildMemberListResp> getGuildMemberList(java.lang.String guildId,
                                                   java.lang.String nextToken)
```
    获取频道成员列表由于频道人数较多(数万), 请尽量不要全量拉取成员列表, 这将会导致严重的性能问题尽量使用 getGuildMemberProfile 接口代替全量拉取 nextToken 为空的情况下, 将返回第一页的数据, 并在返回值附带下一页的 token
    
    参数:
    
    guildId - 频道ID
    
    nextToken - 翻页Token
    
    返回:
    
    result ActionData of GuildMemberListResp
  - sendGuildMsg
```
ActionData<GuildMsgId> sendGuildMsg(java.lang.String guildId,
                                    java.lang.String channelId,
                                    java.lang.String msg)
```
    发送信息到子频道
    
    参数:
    
    guildId - 频道 ID
    
    channelId - 子频道 ID
    
    msg - 要发送的内容
    
    返回:
    
    result ActionData of GuildMsgId
  - getGuildMsg
```
ActionData<GetGuildMsgResp> getGuildMsg(java.lang.String guildMsgId,
                                        boolean noCache)
```
    获取频道消息
    
    参数:
    
    guildMsgId - 频道 ID
    
    noCache - 是否使用缓存
    
    返回:
    
    result ActionData of GetGuildMsgResp
  - getGuildServiceProfile
```
ActionData<GuildServiceProfileResp> getGuildServiceProfile()
```
    获取频道系统内 BOT 的资料
    
    返回:
    
    result ActionData of GuildServiceProfileResp
  - getGuildList
```
ActionList<GuildListResp> getGuildList()
```
    获取频道列表
    
    返回:
    
    result ActionList of GuildListResp
  - getGuildMetaByGuest
```
ActionData<GuildMetaByGuestResp> getGuildMetaByGuest(java.lang.String guildId)
```
    通过访客获取频道元数据
    
    参数:
    
    guildId - 频道 ID
    
    返回:
    
    result ActionData of GuildMetaByGuestResp
  - getGuildChannelList
```
ActionList<ChannelInfoResp> getGuildChannelList(java.lang.String guildId,
                                                boolean noCache)
```
    获取子频道列表
    
    参数:
    
    guildId - 频道 ID
    
    noCache - 是否无视缓存
    
    返回:
    
    result ActionList of ChannelInfoResp
  - getGuildMemberProfile
```
ActionData<GuildMemberProfileResp> getGuildMemberProfile(java.lang.String guildId,
                                                         java.lang.String userId)
```
    单独获取频道成员信息
    
    参数:
    
    guildId - 频道ID
    
    userId - 用户ID
    
    返回:
    
    result ActionData of GuildMemberProfileResp
  - setGroupSpecialTitle
```
ActionRaw setGroupSpecialTitle(long groupId,
                               long userId,
                               java.lang.String specialTitle,
                               int duration)
```
    设置群组专属头衔
    
    参数:
    
    groupId - 群号
    
    userId - 要设置的 QQ 号
    
    specialTitle - 专属头衔，不填或空字符串表示删除专属头衔
    
    duration - 专属头衔有效期，单位秒，-1 表示永久，不过此项似乎没有效果，可能是只有某些特殊的时间长度有效，有待测试
    
    返回:
    
    result ActionRaw
  - deleteFriend
```
ActionRaw deleteFriend(long friendId)
```
    删除好友
    
    参数:
    
    friendId - 好友 QQ 号
    
    返回:
    
    result ActionRaw
  - setGroupPortrait
```
ActionRaw setGroupPortrait(long groupId,
                           java.lang.String file,
                           int cache)
```
    设置群头像目前这个API在登录一段时间后因cookie失效而失效, 请考虑后使用
    
    参数:
    
    groupId - 群号
    
    file - 图片文件名（支持绝对路径，网络URL，Base64编码）
    
    cache - 表示是否使用已缓存的文件（通过网络URL发送时有效, 1表示使用缓存, 0关闭关闭缓存, 默认为1）
    
    返回:
    
    result ActionRaw
  - checkUrlSafely
```
ActionData<CheckUrlSafelyResp> checkUrlSafely(java.lang.String url)
```
    检查链接安全性安全等级, 1: 安全 2: 未知 3: 危险
    
    参数:
    
    url - 需要检查的链接
    
    返回:
    
    result ActionData of CheckUrlSafelyResp
  - sendGroupNotice
```
ActionRaw sendGroupNotice(long groupId,
                          java.lang.String content)
```
    发送群公告
    
    参数:
    
    groupId - 群号
    
    content - 公告内容
    
    返回:
    
    result ActionRaw
  - getGroupAtAllRemain
```
ActionData<GroupAtAllRemainResp> getGroupAtAllRemain(long groupId)
```
    获取群 @全体成员剩余次数
    
    参数:
    
    groupId - 群号
    
    返回:
    
    result ActionData of GroupAtAllRemainResp
  - uploadGroupFile
```
ActionRaw uploadGroupFile(long groupId,
                          java.lang.String file,
                          java.lang.String name,
                          java.lang.String folder)
```
    上传群文件在不提供 folder 参数的情况下默认上传到根目录只能上传本地文件, 需要上传 http 文件的话请先下载到本地
    
    参数:
    
    groupId - 群号
    
    file - 本地文件路径
    
    name - 储存名称
    
    folder - 父目录ID
    
    返回:
    
    result ActionRaw
  - uploadGroupFile
```
ActionRaw uploadGroupFile(long groupId,
                          java.lang.String file,
                          java.lang.String name)
```
    上传群文件在不提供 folder 参数的情况下默认上传到根目录只能上传本地文件, 需要上传 http 文件的话请先下载到本地
    
    参数:
    
    groupId - 群号
    
    file - 本地文件路径
    
    name - 储存名称
    
    返回:
    
    result ActionRaw
  - downloadFile
```
ActionData<DownloadFileResp> downloadFile(java.lang.String url,
                                          int threadCount,
                                          java.lang.String headers)
```
    调用 go cq http 下载文件
    
    参数:
    
    url - 链接地址
    
    threadCount - 下载线程数
    
    headers - 自定义请求头
    
    返回:
    
    result ActionData of DownloadFileResp
  - downloadFile
```
ActionData<DownloadFileResp> downloadFile(java.lang.String url)
```
    调用 go cq http 下载文件
    
    参数:
    
    url - 链接地址
    
    返回:
    
    result ActionData of DownloadFileResp
  - sendGroupForwardMsg
```
ActionData<MsgId> sendGroupForwardMsg(long groupId,
                                      java.util.List<java.util.Map<java.lang.String,java.lang.Object>> msg)
```
    发送合并转发 (群)
    
    参数:
    
    groupId - 群号
    
    msg - 自定义转发消息 (可使用 ShiroUtils.generateForwardMsg() 方法创建) 参考文档
    
    返回:
    
    result ActionRaw
  - getGroupRootFiles
```
ActionData<GroupFilesResp> getGroupRootFiles(long groupId)
```
    获取群根目录文件列表
    
    参数:
    
    groupId - 群号
    
    返回:
    
    result ActionData of GroupFilesResp
  - getGroupFilesByFolder
```
ActionData<GroupFilesResp> getGroupFilesByFolder(long groupId,
                                                 java.lang.String folderId)
```
    获取群子目录文件列表
    
    参数:
    
    groupId - 群号
    
    folderId - 文件夹ID 参考 Folder 对象
    
    返回:
    
    result ActionData of GroupFilesResp
  - getEssenceMsgList
```
ActionList<EssenceMsgResp> getEssenceMsgList(long groupId)
```
    获取精华消息列表
    
    参数:
    
    groupId - 群号
    
    返回:
    
    result ActionList of EssenceMsgResp
  - setEssenceMsg
```
ActionRaw setEssenceMsg(int msgId)
```
    设置精华消息
    
    参数:
    
    msgId - 消息 ID
    
    返回:
    
    result ActionRaw
  - deleteEssenceMsg
```
ActionRaw deleteEssenceMsg(int msgId)
```
    移出精华消息
    
    参数:
    
    msgId - 消息 ID
    
    返回:
    
    result ActionRaw
  - setBotProfile
```
ActionRaw setBotProfile(java.lang.String nickname,
                        java.lang.String company,
                        java.lang.String email,
                        java.lang.String college,
                        java.lang.String personalNote)
```
    设置机器人账号资料
    
    参数:
    
    nickname - 昵称
    
    company - 公司
    
    email - 邮箱
    
    college - 学校
    
    personalNote - 个性签名
    
    返回:
    
    result ActionRaw
  - sendPrivateForwardMsg
```
ActionData<MsgId> sendPrivateForwardMsg(long userId,
                                        java.util.List<java.util.Map<java.lang.String,java.lang.Object>> msg)
```
    发送合并转发 (私聊)
    
    参数:
    
    userId - 目标用户
    
    msg - 自定义转发消息 (可使用 ShiroUtils.generateForwardMsg() 方法创建) 参考文档
    
    返回:
    
    result ActionRaw
  - sendForwardMsg
```
ActionData<MsgId> sendForwardMsg(WholeMessageEvent event,
                                 java.util.List<java.util.Map<java.lang.String,java.lang.Object>> msg)
```
    发送合并转发
    
    参数:
    
    event - 事件
    
    msg - 自定义转发消息 (可使用 ShiroUtils.generateForwardMsg() 方法创建) 参考文档
    
    返回:
    
    result ActionRaw
  - getWordSlices
```
ActionData<WordSlicesResp> getWordSlices(java.lang.String content)
```
    获取中文分词
    
    参数:
    
    content - 内容
    
    返回:
    
    result ActionData of WordSlicesResp
  - getOnlineClients
```
ActionData<ClientsResp> getOnlineClients(boolean noCache)
```
    获取当前账号在线客户端列表
    
    参数:
    
    noCache - 是否无视缓存
    
    返回:
    
    result ActionData of ClientsResp
  - ocrImage
```
ActionData<OcrResp> ocrImage(java.lang.String image)
```
    图片 OCR
    
    参数:
    
    image - 图片ID
    
    返回:
    
    result ActionData of OcrResp
  - uploadPrivateFile
```
ActionRaw uploadPrivateFile(long userId,
                            java.lang.String file,
                            java.lang.String name)
```
    私聊发送文件
    
    参数:
    
    userId - 目标用户
    
    file - 本地文件路径
    
    name - 文件名
    
    返回:
    
    result ActionRaw
  - sendGroupSign
```
ActionRaw sendGroupSign(long groupId)
```
    群打卡
    
    参数:
    
    groupId - 群号
    
    返回:
    
    result ActionRaw
  - deleteUnidirectionalFriend
```
ActionRaw deleteUnidirectionalFriend(long userId)
```
    删除单向好友
    
    参数:
    
    userId - QQ号
    
    返回:
    
    result ActionRaw
  - getUnidirectionalFriendList
```
ActionList<UnidirectionalFriendListResp> getUnidirectionalFriendList()
```
    获取单向好友列表
    
    返回:
    
    result ActionList of UnidirectionalFriendListResp
  - getGroupFileUrl
```
ActionData<UrlResp> getGroupFileUrl(long groupId,
                                    java.lang.String fileId,
                                    int busId)
```
    获取群文件资源链接
    
    参数:
    
    groupId - 群号
    
    fileId - 文件ID
    
    busId - 文件类型
    
    返回:
    
    result ActionData of UrlResp
  - createGroupFileFolder
```
ActionRaw createGroupFileFolder(long groupId,
                                java.lang.String folderName)
```
    创建群文件文件夹
    
    参数:
    
    groupId - 群号
    
    folderName - 文件夹名
    
    返回:
    
    result ActionRaw
  - deleteGroupFileFolder
```
ActionRaw deleteGroupFileFolder(long groupId,
                                java.lang.String folderId)
```
    删除群文件文件夹
    
    参数:
    
    groupId - 群号
    
    folderId - 文件夹ID
    
    返回:
    
    result ActionRaw
  - deleteGroupFile
```
ActionRaw deleteGroupFile(long groupId,
                          java.lang.String fileId,
                          int busId)
```
    删除群文件
    
    参数:
    
    groupId - 群号
    
    fileId - 文件ID
    
    busId - 文件类型
    
    返回:
    
    result ActionRaw
  - getGroupMemberList
```
ActionList<GroupMemberInfoResp> getGroupMemberList(long groupId,
                                                   boolean noCache)
```
    获取群成员列表
    
    参数:
    
    groupId - 群号
    
    noCache - 是否无视缓存
    
    返回:
    
    result ActionList of GroupMemberInfoResp
  - getVersionInfo
```
ActionData<VersionInfoResp> getVersionInfo()
```
    获取版本信息
    
    返回:
    
    result ActionList of VersionInfoResp

接口 GoCQHTTPExtend

方法概要

方法详细资料

getGuildMemberList

sendGuildMsg

getGuildMsg

getGuildServiceProfile

getGuildList

getGuildMetaByGuest

getGuildChannelList

getGuildMemberProfile

setGroupSpecialTitle

deleteFriend

setGroupPortrait

checkUrlSafely

sendGroupNotice

getGroupAtAllRemain

uploadGroupFile

uploadGroupFile

downloadFile

downloadFile

sendGroupForwardMsg

getGroupRootFiles

getGroupFilesByFolder

getEssenceMsgList

setEssenceMsg

deleteEssenceMsg

setBotProfile

sendPrivateForwardMsg

sendForwardMsg

getWordSlices

getOnlineClients

ocrImage

uploadPrivateFile

sendGroupSign

deleteUnidirectionalFriend

getUnidirectionalFriendList

getGroupFileUrl

createGroupFileFolder

deleteGroupFileFolder

deleteGroupFile

getGroupMemberList

getVersionInfo