Class MiraiApiHttp

constructor

• new MiraiApiHttp(mirai, axios): MiraiApiHttp

• Parameters

  • mirai: Mirai
  • axios: AxiosStatic

  Returns MiraiApiHttp

axios

command

file

http

logger

mirai

qq

resp

sessionKey

setting

verified

ws

about

• about(): Promise<About>

• 使用此方法获取插件的信息，如版本号

  Returns Promise<About>

  Example

  data.data: { "version": "v1.0.0" }
  Copy

all

• all(callback): void

• 监听该接口，插件将推送 Bot 收到的消息和事件

  Parameters

  • callback: ((data: ChatMessage | Event) => any)

    回调函数

    • • (data): any

      • Parameters

        • data: ChatMessage | Event

        Returns any

  Returns void

bind

• bind(qq): Promise<BaseResponse>

• 使用此方法校验并激活你的Session，同时将Session与一个已登录的Bot绑定

  Parameters

  • qq: number

  Returns Promise<BaseResponse>

botProfile

• botProfile(): Promise<UserProfile>

• 此接口获取 session 绑定 bot 的详细资料

  Returns Promise<UserProfile>

event

• event(callback): void

• 监听该接口，插件将推送 Bot 收到的事件

  Parameters

  • callback: ((event: Event) => any)

    回调函数

    • • (event): any

      • Parameters

        • event: Event

        Returns any

  Returns void

fetchLatestMessage

• fetchLatestMessage(count?): Promise<FetchMessage>

• 使用此方法获取 bot 接收到的最新消息和最新各类事件(会从 MiraiApiHttp 消息记录中删除)

  Parameters

  • count: number = 10

    获取消息和事件的数量

  Returns Promise<FetchMessage>

fetchMessage

• fetchMessage(count?): Promise<FetchMessage>

• 使用此方法获取 bot 接收到的最老消息和最老各类事件(会从 MiraiApiHttp 消息记录中删除)

  Parameters

  • count: number = 10

    获取消息和事件的数量

  Returns Promise<FetchMessage>

  Example

  { code: 0, data: [] }
  Copy

friendList

• friendList(): Promise<FriendList>

• 获取 bot 的好友列表

  Returns Promise<FriendList>

friendProfile

• friendProfile(target): Promise<UserProfile>

• 此接口获取好友的详细资料

  Parameters

  • target: number

    好友 QQ 号

  Returns Promise<UserProfile>

groupConfig

• groupConfig(target, config?): Promise<Config.GroupConfig | BaseResponse>

• 传入 config 时，修改群设置 未传入 config 时，获取群设置

  Parameters

  • target: number

    指定群的群号
  • Optionalconfig: Config.GroupConfig

    群设置

  Returns Promise<Config.GroupConfig | BaseResponse>

groupList

• groupList(): Promise<GroupList>

• 获取 bot 的群列表

  Returns Promise<GroupList>

handleStatusCode

• handleStatusCode(): Promise<void>

• 拦截 mirai 错误信息

  Returns Promise<void>

kick

• kick(target, memberId, msg?): Promise<BaseResponse>

• 移除群成员

  Parameters

  • target: number

    指定群的群号
  • memberId: number

    指定群员QQ号
  • msg: string = '您已被移出群聊'

    信息

  Returns Promise<BaseResponse>

managers

• managers(): Promise<number[]>

• 获取 Mangers

  Returns Promise<number[]>

memberInfo

• memberInfo(target, memberId, info?): Promise<Config.MemberInfo | BaseResponse>

• 传入 info 时，修改群员资料 未传入 info 时，获取群员资料

  Parameters

  • target: number

    指定群的群号
  • memberId: number

    群员QQ号
  • Optionalinfo: Config.MemberInfo

    群员资料

  Returns Promise<Config.MemberInfo | BaseResponse>

memberList

• memberList(target): Promise<MemberList>

• 获取 BOT 的群成员列表

  Parameters

  • target: number

    指定群的群号

  Returns Promise<MemberList>

memberProfile

• memberProfile(target, memberId): Promise<UserProfile>

• 此接口获取群成员的消息资料

  Parameters

  • target: number

    指定群的群号
  • memberId: number

    群成员 QQ 号

  Returns Promise<UserProfile>

message

• message(callback): void

• 监听该接口，插件将推送 Bot 收到的消息

  Parameters

  • callback: ((msg: ChatMessage) => any)

    回调函数

    • • (msg): any

      • Parameters

        • msg: ChatMessage

        Returns any

  Returns void

messageFromId

• messageFromId(messageId, target): Promise<ChatMessage | MessageFromId>

• 通过 messageId 获取一条被缓存的消息

  Parameters

  • messageId: number

    获取消息的 messageId
  • target: number

    好友 ID 或 群 ID

  Returns Promise<ChatMessage | MessageFromId>

mute

• mute(target, memberId, time?): Promise<BaseResponse>

• 指定群禁言指定群员

  Parameters

  • target: number

    指定群的群号
  • memberId: number

    指定群员QQ号
  • time: number = 60

    禁言时长，单位为秒，最多30天，默认为 60 秒

  Returns Promise<BaseResponse>

muteAll

• muteAll(target): Promise<BaseResponse>

• 指定群进行全体禁言

  Parameters

  • target: number

    指定群的群号

  Returns Promise<BaseResponse>

peekLatestMessage

• peekLatestMessage(count?): Promise<FetchMessage>

• 使用此方法获取 bot 接收到的最老消息和最老各类事件(不会从 MiraiApiHttp 消息记录中删除)

  Parameters

  • count: number = 10

    获取消息和事件的数量

  Returns Promise<FetchMessage>

peekMessage

• peekMessage(count?): Promise<FetchMessage>

• 使用此方法获取 bot 接收到的最老消息和最老各类事件(不会从 MiraiApiHttp 消息记录中删除)

  Parameters

  • count: number = 10

    获取消息和事件的数量

  Returns Promise<FetchMessage>

quit

• quit(target): Promise<BaseResponse>

• 退出群聊

  Parameters

  • target: number

    群号 bot为该群群主时退出失败并返回code 10(无操作权限)

  Returns Promise<BaseResponse>

recall

• recall(params): Promise<BaseResponse>

• 撤回消息 使用此方法撤回指定消息。对于bot发送的消息，有2分钟时间限制。对于撤回群聊中群员的消息，需要有相应权限

  Parameters

  • params: ChatMessage | RecallParams

    { messageId, target }

  Returns Promise<BaseResponse>

  Desc

  mirai 更新强制需要 messageId + target

release

• release(qq?): Promise<BaseResponse>

• 使用此方式释放 session 及其相关资源（Bot不会被释放） 不使用的 Session 应当被释放，长时间（30分钟）未使用的 Session 将自动释放。 否则 Session 持续保存Bot收到的消息，将会导致内存泄露(开启websocket后将不会自动释放)

  Parameters

  • qq: number = ...

  Returns Promise<BaseResponse>

sendFriendMessage

• sendFriendMessage(messageChain, target, quote?): Promise<Api.Response.SendMessage>

• 使用此方法向指定好友发送消息

  Parameters

  • messageChain: string | MessageChain

    消息链，是一个消息对象构成的数组
  • target: number

    发送消息目标好友的 QQ 号
  • Optionalquote: number

    引用一条消息的messageId进行回复

  Returns Promise<Api.Response.SendMessage>

  messageId 一个Int类型属性，标识本条消息，用于撤回和引用回复

sendGroupMessage

• sendGroupMessage(messageChain, target, quote?): Promise<Api.Response.SendMessage>

• 使用此方法向指定群发送消息

  Parameters

  • messageChain: string | MessageChain

    消息链，是一个消息对象构成的数组
  • target: number

    发送消息目标群的群号
  • Optionalquote: number

    引用一条消息的messageId进行回复

  Returns Promise<Api.Response.SendMessage>

  messageId 一个Int类型属性，标识本条消息，用于撤回和引用回复

sendImageMessage

• sendImageMessage(urls, target?, qq?, group?): Promise<string[]>

• 使用此方法向指定对象（群或好友）发送图片消息 除非需要通过此手段获取imageId，否则不推荐使用该接口

  Parameters

  • urls: string[]

    是一个url字符串构成的数组
  • Optionaltarget: number

    发送对象的QQ号或群号，可能存在歧义
  • Optionalqq: number

    发送对象的QQ号
  • Optionalgroup: number

    发送对象的群号

  Returns Promise<string[]>

sendNudge

• sendNudge(target, subject, kind?): Promise<BaseResponse>

• 戳一戳

  Parameters

  • target: number

    戳一戳的目标, QQ号, 可以为 bot QQ号
  • subject: number

    戳一戳接受主体(上下文), 戳一戳信息会发送至该主体, 为群号/好友QQ号
  • kind: "Friend" | "Group" | "Stranger" = 'Group'

    上下文类型

  Returns Promise<BaseResponse>

sendTempMessage

• sendTempMessage(messageChain, qq, group, quote?): Promise<Api.Response.SendMessage>

• 发送临时会话消息

  Parameters

  • messageChain: string | MessageChain

    消息链，是一个消息对象构成的数组
  • qq: number

    临时会话对象QQ号
  • group: number

    临时会话群号
  • Optionalquote: number

    引用一条消息的messageId进行回复

  Returns Promise<Api.Response.SendMessage>

setEssence

• setEssence(target): Promise<BaseResponse>

• 设置群精华消息

  Parameters

  • target: number

    消息ID

  Returns Promise<BaseResponse>

unmute

• unmute(target, memberId): Promise<BaseResponse>

• 指定群解除群成员禁言

  Parameters

  • target: number

    指定群的群号
  • memberId: number

    指定群员QQ号

  Returns Promise<BaseResponse>

unmuteAll

• unmuteAll(target): Promise<BaseResponse>

• 指定群解除全体禁言

  Parameters

  • target: number

    指定群的群号

  Returns Promise<BaseResponse>

uploadFileAndSend

• uploadFileAndSend(type, target, path, file): Promise<any>

• 文件上传

  Parameters

  • type: "Group"

    当前仅支持 "Group"
  • target: number

    指定群的群号
  • path: string

    文件上传目录与名字
  • file: File

    文件内容

  Returns Promise<any>

uploadImage

• uploadImage(type, img): Promise<UploadImage>

• 使用此方法上传图片文件至服务器并返回 ImageId

  Parameters

  • type: "friend" | "group" | "temp"
  • img: File

    图片文件 fs.createReadStream(img)

  Returns Promise<UploadImage>

uploadVoice

• uploadVoice(type, voice): Promise<UploadVoice>

• 使用此方法上传语音文件至服务器并返回 VoiceId

  Parameters

  • type: "friend" | "group" | "temp"

    当前仅支持 "group"
  • voice: File

    语音文件 fs.createReadStream(voice)

  Returns Promise<UploadVoice>

verify

• verify(verifyKey?): Promise<Auth>

• 使用此方法验证你的身份，并返回一个会话

  Parameters

  • verifyKey: string = ...

  Returns Promise<Auth>