Class Group

Readonlyfs

Readonlygid

[unscopables]

• get [unscopables](): {
      c: boolean;
  }

• Returns {
      c: boolean;
  }

  • c: boolean

all_muted

• get all_muted(): boolean

• 是否全员禁言

  Returns boolean

client

• get client(): Client

• 返回所属的客户端对象

  Returns Client

dm

• get dm(): boolean

• Returns boolean

group_id

• get group_id(): number

• gid 的别名

  Returns number

info

• get info(): undefined | GroupInfo

• 群资料

  Returns undefined | GroupInfo

is_admin

• get is_admin(): boolean

• 我是否是管理

  Returns boolean

is_owner

• get is_owner(): boolean

• 我是否是群主

  Returns boolean

mute_left

• get mute_left(): number

• 我的禁言剩余时间

  Returns number

name

• get name(): undefined | string

• 群名

  Returns undefined | string

target

• get target(): number

• Returns number

uid

• get uid(): undefined | string

• 对方uid

  Returns undefined | string

addEssence

• addEssence(seq, rand): Promise<string>

• 添加精华消息

  Parameters

  • seq: number

    消息序号
  • rand: number

    消息的随机值

  Returns Promise<string>

allowAnony

• allowAnony(yes?): Promise<boolean>

• 允许/禁止匿名

  Parameters

  • yes: boolean = true

  Returns Promise<boolean>

announce

• announce(content): Promise<boolean>

• 发送简易群公告

  Parameters

  • content: string

  Returns Promise<boolean>

delReaction

• delReaction(seq, id, type?): Promise<any>

• 删除表情表态，参考（https://bot.q.qq.com/wiki/develop/api-v2/openapi/emoji/model.html#EmojiType）

  Parameters

  • seq: number

    消息序号
  • id: string

    表情ID
  • type: number = 1

    表情类型 EmojiType

  Returns Promise<any>

getAnonyInfo

• getAnonyInfo(): Promise<Omit<Anonymous, "flag">>

• 获取自己的匿名情报

  Returns Promise<Omit<Anonymous, "flag">>

getAtAllRemainder

• getAtAllRemainder(): Promise<number>

• 获取 @全体成员 的剩余次数

  Returns Promise<number>

getAvatarUrl

• getAvatarUrl(size?, history?): string

• 获取群头像url

  Parameters

  • size:
        | 0
        | 40
        | 100
        | 140 = 0

    头像大小，默认0
  • history: number = 0

    历史头像记录，默认0，若要获取历史群头像则填写1,2,3...

  Returns string

  头像的url地址

getChatHistory

• getChatHistory(seq?, cnt?): Promise<GroupMessage[]>

• 获取seq之前的cnt条聊天记录，默认从最后一条发言往前，cnt默认20不能超过20

  Parameters

  • seq: number = 0

    消息序号，默认为0，表示从最后一条发言往前
  • cnt: number = 20

    聊天记录条数，默认20，超过20按20处理(nt版本不限制数量)

  Returns Promise<GroupMessage[]>

  群聊消息列表，服务器记录不足cnt条则返回能获取到的最多消息记录

getFileUrl

• getFileUrl(fid): Promise<string>

• 获取群文件下载地址

  Parameters

  • fid: string

    文件id

  Returns Promise<string>

getForwardMsg

• getForwardMsg(resid, fileName?): Promise<ForwardMessage[]>

• 下载并解析合并转发

  Parameters

  • resid: string
  • fileName: string = "MultiMsg"

  Returns Promise<ForwardMessage[]>

getGroupNTPicRkey

• getGroupNTPicRkey(): Promise<string>

• 获取QQNT群图rkey

  Returns Promise<string>

  Deprecated

getGroupNTPicURL

• getGroupNTPicURL(imgInfo, gid): Promise<null | string>

• 获取QQNT群图URL

  Parameters

  • imgInfo: any
  • gid: undefined | number

  Returns Promise<null | string>

getMemberMap

• getMemberMap(no_cache?): Promise<Map<number, MemberInfo>>

• 获取群员列表

  Parameters

  • no_cache: boolean = false

  Returns Promise<Map<number, MemberInfo>>

getMuteMemberList

• getMuteMemberList(): Promise<(null | {
      uin: null | number;
      unMuteTime: null | string;
  })[]>

• 获取群内被禁言人

  Returns Promise<(null | {
      uin: null | number;
      unMuteTime: null | string;
  })[]>

getNTPicInfobyFileid

• getNTPicInfobyFileid(fileid): Promise<{
      appid: any;
      expires: any;
      md5: any;
      size: any;
      time: any;
      uin: any;
  }>

• 通过fileid获取图片信息

  Parameters

  • fileid: string

  Returns Promise<{
      appid: any;
      expires: any;
      md5: any;
      size: any;
      time: any;
      uin: any;
  }>

getNTPicRkey

• getNTPicRkey(): Promise<any>

• 获取QQNT图片rkey

  Returns Promise<any>

getNTPicURLbyFileid

• getNTPicURLbyFileid(fileid): Promise<string>

• 通过fileid获取QQNT图片URL

  Parameters

  • fileid: string

  Returns Promise<string>

getNTPicURLbyFileidApi

• getNTPicURLbyFileidApi(fileid): Promise<{
      data: string;
      result: number;
  }>

• 通过fileid获取图片url

  Parameters

  • fileid: string

  Returns Promise<{
      data: string;
      result: number;
  }>

getNTVideoUrl

• getNTVideoUrl(elem): Promise<null | string>

• Parameters

  • elem: VideoElem

  Returns Promise<null | string>

getOffNTPicRkey

• getOffNTPicRkey(): Promise<string>

• 获取QQNT私聊图rkey

  Returns Promise<string>

  Deprecated

getOffNTPicURL

• getOffNTPicURL(imgInfo, uid): Promise<null | string>

• 获取QQNT私聊图URL

  Parameters

  • imgInfo: any
  • uid: any

  Returns Promise<null | string>

getPttUrl

• getPttUrl(elem): Promise<undefined | null | string>

• Parameters

  • elem: PttElem

  Returns Promise<undefined | null | string>

getShareJson

• getShareJson(): Promise<any>

• 获取群分享JSON

  Returns Promise<any>

getVideoUrl

• getVideoUrl(elem, md5?): Promise<null | string>

• 获取视频下载地址

  Parameters

  • elem: string | VideoElem
  • md5: string | Buffer = ""

  Returns Promise<null | string>

invite

• invite(uin): Promise<boolean>

• 邀请好友入群

  Parameters

  • uin: number

    好友账号

  Returns Promise<boolean>

kickMember

• kickMember(uin, msg?, block?): Promise<boolean>

• 踢出此群，use Member.kick

  Parameters

  • uin: number

    群员账号
  • Optionalmsg: string
  • block: boolean = false

    是否屏蔽群员

  Returns Promise<boolean>

  Todo

  未知参数

makeForwardMsg

• makeForwardMsg(msglist): Promise<JsonElem>

• 制作一条合并转发消息以备发送（制作一次可以到处发） 需要注意的是，好友图片和群图片的内部格式不一样，对着群制作的转发消息中的图片，发给好友可能会裂图，反过来也一样 支持4层套娃转发（PC仅显示3层）

  Parameters

  • msglist: Forwardable | Forwardable[]

  Returns Promise<JsonElem>

markRead

• markRead(seq?): Promise<void>

• 标记seq之前的消息为已读

  Parameters

  • seq: number = 0

    消息序号，默认为0，表示标记所有消息

  Returns Promise<void>

muteAll

• muteAll(yes?): Promise<boolean>

• 全员禁言

  Parameters

  • yes: boolean = true

  Returns Promise<boolean>

muteAnony

• muteAnony(flag, duration?): Promise<void>

• 禁言匿名群员，默认1800秒

  Parameters

  • flag: string
  • duration: number = 1800

  Returns Promise<void>

muteMember

• muteMember(uin, duration?): Promise<void>

• 禁言群员，use Member.mute

  Parameters

  • uin: number

    群员账号
  • duration: number = 600

    禁言时长（秒），默认600

  Returns Promise<void>

pickMember

• pickMember(uin, strict?): Member

• 获取群员实例

  Parameters

  • uin: number

    群员账号
  • strict: boolean = false

    严格模式，若群员不存在会抛出异常

  Returns Member

pokeMember

• pokeMember(uin): Promise<boolean>

• 戳一戳

  Parameters

  • uin: number

    群员账号

  Returns Promise<boolean>

quit

• quit(): Promise<boolean>

• 退群，若为群主则解散该群

  Returns Promise<boolean>

recallMsg

• recallMsg(msg): Promise<boolean>

• 撤回消息

  Parameters

  • msg: GroupMessage

  Returns Promise<boolean>
• recallMsg(msgid): Promise<boolean>

• Parameters

  • msgid: string

  Returns Promise<boolean>

• recallMsg(seq, rand, pktnum?): Promise<boolean>

• Parameters

  • seq: number
  • rand: number
  • Optionalpktnum: number

  Returns Promise<boolean>

• recallMsg(param, rand, pktnum): Promise<boolean>

• 撤回消息，cqhttp方法用

  Parameters

  • param: number
  • rand: number
  • pktnum: number

  Returns Promise<boolean>
• recallMsg(message_id): Promise<boolean>

• 撤回消息

  Parameters

  • message_id: string

    消息id

  Returns Promise<boolean>
• recallMsg(message): Promise<boolean>

• 撤回消息

  Parameters

  • message: GroupMessage

    群聊消息对象

  Returns Promise<boolean>

removeEssence

• removeEssence(seq, rand): Promise<string>

• 移除精华消息

  Parameters

  • seq: number

    消息序号
  • rand: number

    消息的随机值

  Returns Promise<string>

renew

• renew(): Promise<GroupInfo>

• 强制刷新群资料

  Returns Promise<GroupInfo>

sendFile

• sendFile(file, pid?, name?, callback?): Promise<GfsFileStat>

• 发送一个文件

  Parameters

  • file: string | Buffer | Uint8Array

    string表示从该本地文件路径上传，Buffer表示直接上传这段内容
  • pid: string = "/"

    上传的目标目录id，默认根目录
  • Optionalname: string

    上传的文件名，file为Buffer时，若留空则自动以md5命名
  • Optionalcallback: ((percentage: string) => void)

    监控上传进度的回调函数，拥有一个"百分比进度"的参数

    • • (percentage): void

      • Parameters

        • percentage: string

        Returns void

  Returns Promise<GfsFileStat>

  上传的文件属性

sendMsg

• sendMsg(content, source?, anony?): Promise<MessageRet>

• 发送一条消息

  Parameters

  • content: Sendable

    消息内容
  • Optionalsource: Quotable

    引用回复的消息
  • anony: boolean | Omit<Anonymous, "flag"> = false

    是否匿名

  Returns Promise<MessageRet>

setAdmin

• setAdmin(uin, yes?): Promise<boolean>

• 设置管理员，use Member.setAdmin

  Parameters

  • uin: number

    群员账号
  • yes: boolean = true

    是否设为管理员

  Returns Promise<boolean>

setAvatar

• setAvatar(file): Promise<void>

• 设置群头像

  Parameters

  • file: string | Buffer | Readable

  Returns Promise<void>

setCard

• setCard(uin, card?): Promise<boolean>

• 设置名片，use Member.setCard

  Parameters

  • uin: number

    群员账号
  • card: string = ""

    名片

  Returns Promise<boolean>

setGroupJoinType

• setGroupJoinType(type, question?, answer?): Promise<undefined | boolean>

• 设置加群方式

  Parameters

  • type: string

    加群方式的类型。可选值包括：

    • "AnyOne"：允许任何人加群
    • "None"：不允许任何人加群
    • "requireAuth"：需要身份验证
    • "QAjoin"：需要回答问题并由管理员审核
    • "Correct"：正确回答问题
  • Optionalquestion: string

    在 type 为 "QAjoin" 或 "Correct" 时需要传入。问题的内容。
  • Optionalanswer: string

    在 type 为 "Correct" 时需要传入。正确回答的问题答案。

  Returns Promise<undefined | boolean>

setMessageRateLimit

• setMessageRateLimit(times): Promise<boolean>

• 设置发言限频

  Parameters

  • times: number

    每分钟发言次数

    • 10: 每分钟十条
    • 5: 每分钟五条
    • 0: 无限制

  Returns Promise<boolean>

setName

• setName(name): Promise<boolean>

• 设置群名

  Parameters

  • name: string

  Returns Promise<boolean>

setReaction

• setReaction(seq, id, type?): Promise<any>

• 添加表情表态，参考（https://bot.q.qq.com/wiki/develop/api-v2/openapi/emoji/model.html#EmojiType）

  Parameters

  • seq: number

    消息序号
  • id: string

    表情ID
  • type: number = 1

    表情类型 EmojiType

  Returns Promise<any>

setRemark

• setRemark(remark?): Promise<void>

• 设置群备注

  Parameters

  • remark: string = ""

  Returns Promise<void>

setScreenMemberMsg

• setScreenMemberMsg(member_id, isScreen?): Promise<boolean>

• 设置当前群成员消息屏蔽状态

  Parameters

  • member_id: number
  • OptionalisScreen: boolean

  Returns Promise<boolean>

setTitle

• setTitle(uin, title?, duration?): Promise<boolean>

• 设置头衔，use Member.setTitle

  Parameters

  • uin: number

    群员账号
  • title: string = ""

    头衔名
  • duration: number = -1

    持续时间，默认-1，表示永久

  Returns Promise<boolean>

shareMusic

• shareMusic(platform, id): Promise<void>

• 发送音乐分享

  Parameters

  • platform: MusicPlatform
  • id: string

  Returns Promise<void>

shareUrl

• shareUrl(content, config?): Promise<void>

• 发送网址分享

  Parameters

  • content: ShareContent
  • Optionalconfig: ShareConfig

  Returns Promise<void>

sign

• sign(): Promise<{
      result: number;
  }>

• 打卡

  Returns Promise<{
      result: number;
  }>

uploadImages

• uploadImages(_imgs): Promise<PromiseRejectedResult[]>

• 上传一批图片以备发送(无数量限制)，理论上传一次所有群和好友都能发

  Parameters

  • _imgs: Image[] | ImageElem[]

  Returns Promise<PromiseRejectedResult[]>

uploadLongMsg

• uploadLongMsg(content, source?, isNT?): Promise<LongMsgElem>

• Parameters

  • content: Sendable | Converter
  • Optionalsource: Quotable
  • isNT: undefined | boolean = ...

  Returns Promise<LongMsgElem>

uploadPtt

• uploadPtt(elem, transcoding?, brief?): Promise<PttElem>

• 上传一个语音以备发送(理论上传一次所有群和好友都能发)

  Parameters

  • elem: PttElem
  • transcoding: boolean = true
  • brief: string = ""

  Returns Promise<PttElem>

uploadVideo

• uploadVideo(elem): Promise<VideoElem>

• 上传一个视频以备发送(理论上传一次所有群和好友都能发)

  Parameters

  • elem: VideoElem

  Returns Promise<VideoElem>

Staticas

• as(this, gid, strict?): Group

• Parameters

  • this: Client
  • gid: number
  • strict: boolean = false

  Returns Group