API定义列表
此处会列举 API 模块 中、 love.forte.simbot.qguild.api 包下定义的所有 QQGuildApi 实现。
群管理
以下 API 位于 love.forte.simbot.qguild.api.group。 平台权限或网络请求失败时抛出相应异常;核心组件中的操作入口参见 群聊 QGGroup。
GetGroupInfoApi
查询指定 QQ 群的基本信息,返回 GroupInfo ,包括群名称、简介、分类、标签和成员人数。
GetGroupBotStateApi
查询机器人在指定群内的 GroupBotState ,包括群成员 OpenID、角色、加入时间、 主动消息开关和消息接收设置。
GetGroupJoinRequestListApi
按游标查询入群申请,返回 GroupJoinRequestPage。 申请中包含申请 ID、成员 OpenID、昵称、申请时间、来源和验证信息等字段。
ApproveGroupJoinRequestApi
审批指定成员的入群申请。请求中可携带申请 ID、接受或拒绝结果、拒绝理由, 以及拒绝时是否加入群黑名单的设置。
GetGroupMuteSettingApi
查询群禁言信息,返回 GroupMuteSetting ,包含全员禁言模式、定时规则、周期规则和成员单独禁言记录。
SetGroupMuteSettingApi
提交成员禁言设置,成员禁言变更使用 SetMemberMuteState 表示,支持增加、更新和解除。 核心组件的 setMemberMutes(...) 提供批量操作入口。
群成员管理 API
以下接口位于 love.forte.simbot.qguild.api.group。 核心组件的查询、移除和黑名单操作参见 群成员管理。
GetGroupMemberListApi
查询成员列表,返回 GroupMemberPage。 createFlow(groupOpenid) { requestData(client, token) } 返回按游标翻页的冷流。
GetGroupMemberInfoApi
按群及成员 ID 查询 GroupMemberInfo。
BatchRemoveGroupMembersApi
一次移除 1~20 个成员,可使用 addToMemberBlacklist 请求同时拉黑,返回 GroupMembersRemoveResult。
GetGroupMemberBlacklistApi
查询 GroupBlacklistPage ,可指定 cursor 和 limit (默认 20,最大 100)。 也提供自动分页的冷流 createFlow ,用来查询黑名单用户列表 GroupBlacklistUser。
ModifyGroupMemberBlacklistApi
通过 ModifyGroupMemberBlacklistOp.ADD/DEL 添加或移出黑名单,单次 1~20 个成员。 添加要求目标用户已不在群内。 返回 GroupBlacklistModifyResult.failOpenids ,保留部分失败信息。
批量接口在构建时校验非空白群/成员 ID 和非空列表,数量上限由服务端校验。请求成功与所有目标均成功应根据响应分别判断。
入群自动审批 API
以下 API 位于 love.forte.simbot.qguild.api.group ,用于管理机器人创建的跨群自动审批策略。 相关模型位于 love.forte.simbot.qguild.model.group。
GetGroupJoinApprovalStrategyListApi
查询生效中的策略列表,返回 GroupJoinApprovalStrategyPage ,按创建时间倒序排列。 支持 cursor/limit 查询参数及自动分页冷流 createFlow。
CreateGroupJoinApprovalStrategyApi
创建策略,群 OpenID 列表与 QQ 群号列表二选一,返回 GroupJoinApprovalStrategyCreated。 请求模型 GroupJoinApprovalStrategyCreate 提供 Java builder 和 Kotlin DSL。 每个机器人最多创建 20 个策略,每个策略最多关联 100 个群;仅在机器人具有群管理员身份的群中生效。
ModifyGroupJoinApprovalStrategyApi
使用 GroupJoinApprovalStrategyModify 修改启用状态、过期时间、关联群或备注,返回 GroupJoinApprovalStrategyModified。 关联群操作使用 GroupJoinApprovalStrategyGroupAction ,群标识形式须与创建时一致。
DeleteGroupJoinApprovalStrategyApi
删除指定策略,返回 Unit。
ExecuteGroupJoinApprovalStrategyApi
对策略关联的全部群执行全量扫描,自动通过匹配白名单的入群申请。 官方说明异步执行、约 10 分钟完成;请求成功返回 Unit ,表示服务端已接受请求。
ModifyGroupJoinApprovalStrategyWhitelistApi
使用 GroupJoinApprovalStrategyOp.ADD/DEL 新增或删除白名单 QQ 号码,返回 GroupJoinApprovalStrategyWhitelistModified。 号码使用字符串,单次最多 10000 个,策略白名单上限 10 万。返回号码数为估算值。
启用状态使用 Boolean 映射官方 on/off ,时间使用 kotlin.time.Instant。 可选请求字段为 null 时省略,群号请求与响应统一使用字符串。 构建时仅校验必要下限与群标识组合,数量和长度上限由服务端校验。
按游标查询:
准备创建请求。 client 与 token 的准备方式参见 API。
阻塞风格:
异步风格:
响应式风格:持有 core 的 QGBot 时,可直接使用生成的 executeDataReactive。 此入口及响应式桥接均为实验性 API。
仅使用 API 模块时,可直接使用 ApiRequests.requestDataReactive 。请求在订阅时发起。
以上 Java 示例使用 java.util.List、 love.forte.simbot.qguild.api.ApiRequests, 以及 api.group 中的请求类型和 model.group 中的模型类型。响应式示例另需 Reactor 的 Mono。
其他 API
- GatewayApis
love.forte.simbot.qguild.api.GatewayApis获取网关信息。
通过
Normal或Shared的形式根据bot信息获取使用 Websocket 接入时间通知的链接。- Normal
love.forte.simbot.qguild.api.Normal获取通用 WSS 接入点
love.forte.simbot.qguild.api.Shared获取带分片 WSS 接入点
- CreateAnnouncesApi
love.forte.simbot.qguild.api.announces.CreateAnnouncesApi机器人设置消息为指定子频道公告。
- DeleteAnnouncesApi
love.forte.simbot.qguild.api.announces.DeleteAnnouncesApi机器人删除指定子频道公告
- DemandApiPermissionApi
love.forte.simbot.qguild.api.apipermission.DemandApiPermissionApi用于创建 API 接口权限授权链接,该链接指向
guild_id对应的频道 。需要注意,私信场景中,当需要查询私信来源频道的权限时,应使用
src_guild_id,即 message 中的src_guild_id每天只能在一个频道内发
3条(默认值)频道权限授权链接。- GetApiPermissionListApi
love.forte.simbot.qguild.api.apipermission.GetApiPermissionListApi用于获取机器人在频道
guild_id内可以使用的权限列表。- GetAppAccessTokenApi
love.forte.simbot.qguild.api.app.GetAppAccessTokenApi这个API似乎是一个特殊的API,它有自己的HTTP URL:
https://bots.qq.com/app/getAppAccessToken, 使用时需要专门处理。- CreateChannelApi
love.forte.simbot.qguild.api.channel.CreateChannelApi用于在
guild_id指定的频道下创建一个子频道。要求操作人具有管理频道的权限,如果是机器人,则需要将机器人设置为管理员。
创建成功后,返回创建成功的子频道对象,同时会触发一个频道创建的事件通知。
- DeleteChannelApi
love.forte.simbot.qguild.api.channel.DeleteChannelApi用于删除
channel_id指定的子频道。要求操作人具有
管理子频道的权限,如果是机器人,则需要将机器人设置为管理员。修改成功后,会触发子频道删除事件。
注意
子频道的删除是无法撤回的,一旦删除,将无法恢复。
- GetChannelApi
love.forte.simbot.qguild.api.channel.GetChannelApi- GetChannelOnlineNumsApi
love.forte.simbot.qguild.api.channel.GetChannelOnlineNumsApi用于查询音视频/直播子频道 channel_id 的在线成员数。
- GetGuildChannelListApi
love.forte.simbot.qguild.api.channel.GetGuildChannelListApi用于获取
guild_id指定的频道下的子频道列表。- ModifyChannelApi
love.forte.simbot.qguild.api.channel.ModifyChannelApi用于修改
channel_id指定的子频道的信息。要求操作人具有
管理子频道的权限,如果是机器人,则需要将机器人设置为管理员。修改成功后,会触发子频道更新事件。
- GetChannelMemberPermissionsApi
love.forte.simbot.qguild.api.channel.permissions.GetChannelMemberPermissionsApi用于获取 子频道
channel_id下用户user_id的权限。获取子频道用户权限。
要求操作人具有管理子频道的权限,如果是机器人,则需要将机器人设置为管理员。
- GetChannelRolePermissionsApi
love.forte.simbot.qguild.api.channel.permissions.GetChannelRolePermissionsApi用于获取子频道
channel_id下身份组role_id的权限。要求操作人具有管理子频道的权限,如果是机器人,则需要将机器人设置为管理员。
- ModifyChannelMemberPermissionsApi
love.forte.simbot.qguild.api.channel.permissions.ModifyChannelMemberPermissionsApi用于修改子频道
channel_id下用户user_id的权限。要求操作人具有
管理子频道的权限,如果是机器人,则需要将机器人设置为管理员。参数包括
add和remove两个字段,分别表示授予的权限以及删除的权限。 要授予用户权限即把add对应位置 1,删除用户权限即把remove对应位置 1。当两个字段同一位都为 1,表现为删除权限。本接口不支持修改
可管理子频道权限。
- ModifyChannelRolePermissionsApi
love.forte.simbot.qguild.api.channel.permissions.ModifyChannelRolePermissionsApi用于修改子频道
channel_id下身份组role_id的权限。要求操作人具有管理子频道的权限,如果是机器人,则需要将机器人设置为管理员。
参数包括
add和remove两个字段,分别表示授予的权限以及删除的权限。 要授予身份组权限即把add对应位置 1,删除身份组权限即把remove对应位置 1。当两个字段同一位都为 1,表现为删除权限。本接口不支持修改
可管理子频道权限。
- AddPinsMessageApi
love.forte.simbot.qguild.api.channel.pins.AddPinsMessageApi用于添加子频道
channel_id内的精华消息。精华消息在一个子频道内最多只能创建
20条。只有可见的消息才能被设置为精华消息。
接口返回对象中
message_ids为当前请求后子频道内所有精华消息message_id数组。
- DeletePinsMessageApi
love.forte.simbot.qguild.api.channel.pins.DeletePinsMessageApi用于删除子频道
channel_id下指定message_id的精华消息。删除子频道内全部精华消息,请将
message_id设置为 [all]DELETE_ALL_MESSAGE_ID。
- GetPinsMessageApi
love.forte.simbot.qguild.api.channel.pins.GetPinsMessageApi用于获取子频道
channel_id内的精华消息。- CreateScheduleApi
love.forte.simbot.qguild.api.channel.schedules.CreateScheduleApi用于在
channel_id指定的日程子频道下创建一个日程。要求操作人具有
管理频道的权限,如果是机器人,则需要将机器人设置为管理员。创建成功后,返回创建成功的日程对象。
创建操作频次限制
单个管理员每天限
10次。单个频道每天
100次。
- DeleteScheduleApi
love.forte.simbot.qguild.api.channel.schedules.DeleteScheduleApi用于修改日程子频道
channel_id下schedule_id指定的日程的详情。要求操作人具有
管理频道的权限,如果是机器人,则需要将机器人设置为管理员。
- GetScheduleApi
love.forte.simbot.qguild.api.channel.schedules.GetScheduleApi获取日程子频道
channel_id下schedule_id指定的的日程的详情。- GetScheduleListApi
love.forte.simbot.qguild.api.channel.schedules.GetScheduleListApi用于获取
channel_id指定的子频道中当天的日程列表。若带了参数
since,则返回在since对应当天的日程列表;若未带参数since,则默认返回今天的日程列表。
- ModifyScheduleApi
love.forte.simbot.qguild.api.channel.schedules.ModifyScheduleApi用于修改日程子频道
channel_id下schedule_id指定的日程的详情。要求操作人具有
管理频道的权限,如果是机器人,则需要将机器人设置为管理员。
- UploadGroupFilesApi
love.forte.simbot.qguild.api.files.UploadGroupFilesApi- UploadUserFilesApi
love.forte.simbot.qguild.api.files.UploadUserFilesApi- DeleteThreadApi
love.forte.simbot.qguild.api.forum.DeleteThreadApi该接口用于删除指定子频道下的某个帖子。
- GetThreadApi
love.forte.simbot.qguild.api.forum.GetThreadApi该接口用于获取子频道下的帖子详情。
- GetThreadListApi
love.forte.simbot.qguild.api.forum.GetThreadListApi该接口用于获取子频道下的帖子列表。
- PublishThreadApi
love.forte.simbot.qguild.api.forum.PublishThreadApi- GetGuildApi
love.forte.simbot.qguild.api.guild.GetGuildApi用于获取
guildId指定的频道的详情。- MuteAllApi
love.forte.simbot.qguild.api.guild.mute.MuteAllApi用于将频道的全体成员(非管理员)禁言。
需要使用的
token对应的用户具备管理员权限。如果是机器人,要求被添加为管理员。 该接口同样可用于解除禁言,将mute_end_timestamp或mute_seconds传值为字符串'0'即可。- MuteMemberApi
love.forte.simbot.qguild.api.guild.mute.MuteMemberApi用于禁言频道
guild_id下的成员user_id。需要使用的
token对应的用户具备管理员权限。如果是机器人,要求被添加为管理员。 该接口同样可用于解除禁言,将mute_end_timestamp或mute_seconds传值为字符串'0'即可。- MuteMultiMemberApi
love.forte.simbot.qguild.api.guild.mute.MuteMultiMemberApi用于将频道的指定批量成员(非管理员)禁言。
需要使用的
token对应的用户具备管理员权限。如果是机器人,要求被添加为管理员。 该接口同样可用于批量解除禁言,将mute_end_timestamp或mute_seconds传值为字符串'0'即可,及需要批量解除禁言的成员的user_id列表user_ids'。- DeleteMemberApi
love.forte.simbot.qguild.api.member.DeleteMemberApi用于删除 guild_id 指定的频道下的成员 user_id。
需要使用的 token 对应的用户具备踢人权限。如果是机器人,要求被添加为管理员。
操作成功后,会触发频道成员删除事件。
无法移除身份为管理员的成员
- GetGuildMemberListApi
love.forte.simbot.qguild.api.member.GetGuildMemberListApi用于获取 guild_id 指定的频道中所有成员的详情列表,支持分页。
有关返回结果的说明
在每次翻页的过程中,可能会返回上一次请求已经返回过的
member信息,需要调用方自己根据user id来进行去重。每次返回的
member数量与limit不一定完全相等。翻页请使用最后一个member的user id作为下一次请求的after参数,直到回包为空,拉取结束。
- GetGuildRoleMemberListApi
love.forte.simbot.qguild.api.member.GetGuildRoleMemberListApi用于获取
guild_id频道中指定role_id身份组下所有成员的详情列表,支持分页。有关返回结果的说明
每次返回的member数量与limit不一定完全相等。特定管理身份组下的成员可能存在一次性返回全部的情况
- GetMemberApi
love.forte.simbot.qguild.api.member.GetMemberApi用于获取
guild_id指定的频道中user_id对应成员的详细信息。- DeleteMessageApi
love.forte.simbot.qguild.api.message.DeleteMessageApi用于撤回子频道
channel_id下的消息message_id。管理员可以撤回普通成员的消息。
频道主可以撤回所有人的消息。
- DeleteChannelMessageApi
love.forte.simbot.qguild.api.message.DeleteChannelMessageApi用于撤回子频道
channel_id下的消息message_id。管理员可以撤回普通成员的消息。
频道主可以撤回所有人的消息。
可选参数
hidetip用于控制是否隐藏提示小灰条。
自
5.0起提供。原DeleteMessageApi保留用于兼容已有代码。- GetMessageApi
love.forte.simbot.qguild.api.message.GetMessageApi用于获取子频道
channel_id下的消息message_id的详情。- MessageSendApi
love.forte.simbot.qguild.api.message.MessageSendApi用于向
channel_id指定的子频道发送消息。要求操作人在该子频道具有
发送消息的权限。主动消息在频道主或管理设置了情况下,按设置的数量进行限频。在未设置的情况遵循如下限制:
主动推送消息,默认每天往每个子频道可推送的消息数是
20条,超过会被限制。主动推送消息在每个频道中,每天可以往
2个子频道推送消息。超过后会被限制。不论主动消息还是被动消息,在一个子频道中,每
1s只能发送5条消息。被动回复消息有效期为
5分钟。超时会报错。发送消息接口要求机器人接口需要连接到 websocket 上保持在线状态
有关主动消息审核,可以通过 Intents 中审核事件
MESSAGE_AUDIT返回 MessageAudited 对象获取结果。
主动消息与被动消息
主动消息:发送消息时,未填充
msg_id/event_id字段的消息。被动消息:发送消息时,填充了
msg_id/event_id字段的消息。msg_id和event_id两个字段任意填一个即为被动消息。 接口使用此msg_id/event_id拉取用户的消息或事件,同时判断用户消息或事件的发送时间,如果超过被动消息回复时效,将会不允许发送该消息。
更多参考 文档
发送 ARK 模板消息
通过指定
ark字段发送模板消息。要求操作人在该子频道具有发送消息和 对应
ARK 模板的权限。调用前需要先申请消息模板,这一步会得到一个模板
id,在请求时填在ark.template_id上。发送成功之后,会触发一个创建消息的事件。
可用模板参考可用模板。
更多参考 文档
发送引用消息
只支持引用机器人自己发送到的消息以及用户@机器人产生的消息。
发送成功之后,会触发一个创建消息的事件。
不能单独发送引用消息,引用消息需要和其他消息类型组合发送,参数请见发送消息。
更多参考 文档
发送含有消息按钮组件的消息
通过指定
keyboard字段发送带按钮的消息,支持keyboard 模版和自定义 keyboard两种请求格式。要求操作人在该子频道具有
发送消息和对应消息按钮组件的权限。请求参数
keyboard 模版和自定义 keyboard只能单一传值。keyboard 模版调用前需要先申请消息按钮组件模板,这一步会得到一个模板 id,在请求时填在
keyboard字段上。申请消息按钮组件模板需要提供响应的 json,具体格式参考 InlineKeyboard。
仅
markdown消息支持消息按钮。
自
4.4.0起,群聊和单聊消息发送体使用MessageKeyboards表示消息按钮内容。 它支持content.rows[].buttons[]形式的多行、多按钮结构,并在请求 JSON 中继续序列化为官方的keyboard字段。 旧的MessageKeyboard入口只能表达单个按钮,已废弃;组件消息元素中对应使用QGKeyboards。val keyboards = MessageKeyboards { content { row { button { renderData("确认", visitedLabel = "已确认", style = 1) action { type = 1 data = "confirm" unsupportTips = "当前客户端暂不支持" permissionAllAccessible() } } } row { addButton(MessageKeyboard.create("template-id")) } } }var keyboards = MessageKeyboards.create(List.of( MessageKeyboard.create("template-a"), MessageKeyboard.create("template-b") )); var groupApi = GroupMessageSendApi.createMarkdown( "群ID", "请选择", keyboards ); var userApi = UserMessageSendApi.createMarkdown( "用户openid", "请选择", keyboards );更多参考 文档
内嵌格式
利用
content字段发送内嵌格式的消息。内嵌格式仅在
content中会生效,在Ark和Embed中不生效。为了区分是文本还是内嵌格式,消息抄送和发送会对消息内容进行相关的转义。
转义内容
源字符
转义后
&&<<>>可参考使用
ContentTextDecoder和ContentTextEncoder消息审核
当响应结果为上述错误码时,请求实体对象结果的API时会抛出
MessageAuditedException异常并携带相关的对象信息。详见文档 发送消息 中的相关描述以及
MessageAuditedException的文档描述。更多参考 文档
- CreateDmsApi
love.forte.simbot.qguild.api.message.direct.CreateDmsApi用于机器人和在同一个频道内的成员创建私信会话。
机器人和用户存在共同频道才能创建私信会话。 创建成功后,返回创建成功的频道
id,子频道id和创建时间。参数
字段名
类型
描述
recipient_idstring接收者 id
source_guild_idstring源频道 id
- DeleteDmsApi
love.forte.simbot.qguild.api.message.direct.DeleteDmsApi用于撤回私信频道
guild_id中message_id指定的私信消息。只能用于撤回机器人自己发送的私信。- DmsSendApi
love.forte.simbot.qguild.api.message.direct.DmsSendApi接口
POST /dms/{guild_id}/messages功能描述
用于发送私信消息,前提是已经创建了私信会话。
私信的
guild_id在创建私信会话时以及私信消息事件中获取。私信场景下,每个机器人每天可以对一个用户发
2条主动消息。私信场景下,每个机器人每天累计可以发
200条主动消息。私信场景下,被动消息没有条数限制。
参数
和 [发送消息]
MessageSendApi参数一致。返回
和 [发送消息]
MessageSendApi返回一致。- GroupMessageSendApi
love.forte.simbot.qguild.api.message.group.GroupMessageSendApi- GroupMessageDeleteApi
love.forte.simbot.qguild.api.message.group.GroupMessageDeleteApi用于撤回群
group_openid中的消息message_id。发送超过两分钟的消息不可撤回。 群管理员可撤回机器人自身和普通群成员的消息;普通成员只能撤回机器人自身发送的消息。love.forte.simbot.qguild.api.menu.GetCustomMenuApi获取 C2C 单聊窗口底部当前生效的全局自定义菜单。返回结果包含菜单版本;从未设置菜单时菜单内容为空。
love.forte.simbot.qguild.api.menu.ModifyCustomMenuApi整体覆盖当前 C2C 自定义菜单配置,并返回更新后的菜单版本。组件不会在本地校验菜单类型与字段组合。
- CreateCommandPanelApi
love.forte.simbot.qguild.api.panel.CreateCommandPanelApi创建一个在指定会话场景中生效的指令面板。创建结果只返回新面板 ID。
- DeleteCommandPanelApi
love.forte.simbot.qguild.api.panel.DeleteCommandPanelApi根据
panel_id删除指令面板。- GetCommandPanelApi
love.forte.simbot.qguild.api.panel.GetCommandPanelApi根据
panel_id获取指令面板详情。- GetCommandPanelListApi
love.forte.simbot.qguild.api.panel.GetCommandPanelListApi按
scope查询指令面板列表,支持使用cursor和limit分页。首次请求不传游标,后续请求使用响应中的next_cursor。limit默认 20,最大 50。- ModifyCommandPanelApi
love.forte.simbot.qguild.api.panel.ModifyCommandPanelApi整体覆盖面板元素与备注,不修改面板关联对象,并返回更新后的面板版本。
- ModifyCommandPanelTargetApi
love.forte.simbot.qguild.api.panel.ModifyCommandPanelTargetApi向指令面板添加或删除关联的 C2C 用户或 QQ 群目标。操作类型使用
add或del。- InteractionResponseApi
love.forte.simbot.qguild.api.interaction.InteractionResponseApi用于回应
INTERACTION_CREATE互动事件,例如消息按钮或自定义菜单操作回调。响应码常量:
CODE_SUCCESS: 成功CODE_FAILED: 操作失败CODE_FREQUENT: 操作频繁CODE_DUPLICATE: 重复操作CODE_NO_PERMISSION: 没有权限CODE_ADMIN_ONLY: 仅管理员操作
val api = InteractionResponseApi.create( interactionId = "互动事件ID", code = InteractionResponseApi.CODE_SUCCESS )var api = InteractionResponseApi.create( "互动事件ID", InteractionResponseApi.CODE_SUCCESS );- GetMessageSettingApi
love.forte.simbot.qguild.api.message.setting.GetMessageSettingApi用于获取机器人在频道
guild_id内的消息频率设置。- UserMessageSendApi
love.forte.simbot.qguild.api.message.user.UserMessageSendApi单独发动消息给用户。
- UserMessageDeleteApi
love.forte.simbot.qguild.api.message.user.UserMessageDeleteApi用于撤回机器人发送给用户
user_openid的消息message_id。发送超过两分钟的消息不可撤回。- AddMemberRoleApi
love.forte.simbot.qguild.api.role.AddMemberRoleApi用于将频道
guild_id下的用户user_id添加到身份组role_id。需要使用的
token对应的用户具备增加身份组成员权限。如果是机器人,要求被添加为管理员。如果要增加的身份组
ID是 [5-子频道管理员]love.forte.simbot.qguild.model.Role.DEFAULT_ID_CHANNEL_ADMIN, 需要增加channel对象来指定具体是哪个子频道。
- CreateGuildRoleApi
love.forte.simbot.qguild.api.role.CreateGuildRoleApi用于在
guild_id指定的频道下创建一个身份组。需要使用的
token对应的用户具备创建身份组权限。如果是机器人,要求被添加为管理员。参数为非必填,但至少需要传其中之一,默认为空或 0。
- DeleteGuildRoleApi
love.forte.simbot.qguild.api.role.DeleteGuildRoleApi用于删除频道
guild_id下role_id对应的身份组。需要使用的
token对应的用户具备删除身份组权限。如果是机器人,要求被添加为管理员。- GetGuildRoleListApi
love.forte.simbot.qguild.api.role.GetGuildRoleListApi用于获取
guild_id指定的频道下的身份组列表。- ModifyGuildRoleApi
love.forte.simbot.qguild.api.role.ModifyGuildRoleApi用于修改频道
guild_id下role_id指定的身份组。需要使用的
token对应的用户具备修改身份组权限。如果是机器人,要求被添加为管理员。接口会修改传入的字段,不传入的默认不会修改,至少要传入一个参数。
- RemoveMemberRoleApi
love.forte.simbot.qguild.api.role.RemoveMemberRoleApi用于将 用户
user_id从 频道guild_id的role_id身份组中移除。需要使用的
token对应的用户具备删除身份组成员权限。如果是机器人,要求被添加为管理员。如果要删除的身份组
ID是 [5-子频道管理员]love.forte.simbot.qguild.model.Role.DEFAULT_ID_CHANNEL_ADMIN, 需要增加channel对象来指定具体是哪个子频道。
- GetBotGuildListApi
love.forte.simbot.qguild.api.user.GetBotGuildListApi用于获取当前用户(机器人)所加入的频道列表,支持分页。
当
HTTP Authorization中填入Bot Token是获取机器人的数据,填入Bearer Token则获取用户的数据。- GetBotInfoApi
love.forte.simbot.qguild.api.user.GetBotInfoApi用于获取当前用户(机器人)详情。
由于
GetBotInfoApi本身为object类型, 因此ApiDescription由内部对象Description提供而不是伴生对象。GetBotInfoApi得到的User中,User.isBot始终为true。