Skip to content

@koishijs/plugin-adapter-qq

QQ 和 QQ 频道官方机器人适配器。

接入方法

  1. 前往 QQ 开放平台 注册账号
  2. 登陆进入 机器人管理后台 并创建官方机器人
  3. 创建完成后,在「开发设置」界面获取机器人三项基本数据 [id, token, key]
  4. 将上面的基本数据作为机器人配置项即可使用

机器人选项

config.id

  • 类型: string

机器人 id。

config.key

  • 类型: string

机器人密钥,管理端又称呼为 secret。

config.token

  • 类型: string

机器人 token。

config.type

  • 类型: 'private' | 'public'

是否为公域机器人。

config.sandbox

  • 类型: boolean
  • 默认值: true

是否开启沙盒。

config.endpoint

  • 类型: string
  • 默认值: 'https://api.sgroup.qq.com/'

要请求的 API 网址。

config.authType

  • 类型: 'bot' | 'bearer'
  • 默认值: 'bot'

验证方式。

内部接口

TIP

关于内部接口的使用方式,请参见 访问内部接口

QQ 群和频道有着不同的机器人接口,因此我们提供了两套内部 API。

群 (含私聊)

对应的平台名称为 qq

  • internal.acknowledgeInteraction()
  • internal.sendFileGuild()
  • internal.sendFilePrivate()
  • internal.sendMessage()
  • internal.sendPrivateMessage()

频道 (含私聊)

对应的平台名称为 qqguild

  • internal.addGuildMemberRole()
  • internal.createDMS()
  • internal.createGuildApiPermissionDemand()
  • internal.createGuildAnnounce()
  • internal.createGuildChannel()
  • internal.createGuildRole()
  • internal.createPinsMessage()
  • internal.createPost()
  • internal.createSchedule()
  • internal.createReaction()
  • internal.deleteChannel()
  • internal.deleteDM()
  • internal.deleteMessage()
  • internal.deleteReaction()
  • internal.getChannel()
  • internal.getChannelMemberPermissions()
  • internal.getChannelOnlineNums()
  • internal.getChannelRole()
  • internal.getChannels()
  • internal.getGuild()
  • internal.getGuildApiPermissions()
  • internal.getGuildMember()
  • internal.getGuildMembers()
  • internal.getGuildRoleMembers()
  • internal.getGuildRoles()
  • internal.getGuilds()
  • internal.getMe()
  • internal.getMessage()
  • internal.getMessageSetting()
  • internal.getPinsMessage()
  • internal.getSchedule()
  • internal.getSchedules()
  • internal.getReactions()
  • internal.getThread()
  • internal.listThreads()
  • internal.modifyChannel()
  • internal.modifyChannelMemberPermissions()
  • internal.modifyChannelRole()
  • internal.modifyGuildRole()
  • internal.modifySchedule()
  • internal.muteGuild()
  • internal.muteGuildMember()
  • internal.muteGuildMembers()
  • internal.removeGuildAnnounce()
  • internal.removeGuildMember()
  • internal.removeGuildMemberRole()
  • internal.removeGuildRole()
  • internal.removePinsMessage()
  • internal.removePost()
  • internal.removeSchedule()
  • internal.sendDM()
  • internal.sendMessage()