公开 API 列表

字数

6673 字

阅读时间

32 分钟

注意

需要注意的是并非所有的API都是已实现的
将在后续注明各适配器的支持情况

API 名称	备注
`logger`	打印当前 Bot 的专属日志
`sendMsg`	发送消息
`sendLongMsg`	发送长消息
`sendForwardMsg`	发送合并转发消息
`recallMsg`	撤回消息，返回值不值得信任
`getAvatarUrl`	获取头像 URL
`getGroupAvatarUrl`	获取群头像 URL
`getMsg`	获取消息
`getHistoryMsg`	获取历史消息
`getForwardMsg`	获取合并转发消息
`getGroupHighlights`	获取群精华消息
`createResId`	构造资源 ID，不发送消息
`setGgroupHighlights`	设置或取消群精华消息
`sendLike`	发送好友赞
`groupKickMember`	群踢人，支持理由与拒绝再次申请选项
`setGroupMute`	禁言群成员
`setGroupAllMute`	设置全员禁言
`setGroupAdmin`	设置或取消群管理员
`setGroupMemberCard`	设置群名片
`setGroupName`	设置群名
`setGroupQuit`	退出群组或解散群
`setGroupMemberTitle`	设置群专属头衔，仅群主可用
`getStrangerInfo`	获取陌生人信息
`getFriendList`	获取好友列表
`getGroupInfo`	获取群信息
`getGroupList`	获取群列表
`getGroupMemberInfo`	获取群成员信息
`getGroupMemberList`	获取群成员列表
`getGroupHonor`	获取群荣誉信息
`setFriendApplyResult`	设置好友请求结果
`setGroupApplyResult`	设置加入群请求结果
`setInvitedJoinGroupResult`	设置群邀请结果
`setMsgReaction`	设置消息表情回应
`uploadFile`	上传群文件或私聊文件
`downloadFile`	下载文件到协议端本地
`createGroupFolder`	创建群文件夹
`renameGroupFolder`	重命名群文件夹
`delGroupFolder`	删除群文件夹
`uploadGroupFile`	上传群文件
`delGroupFile`	删除群文件
`getGroupFileSystemInfo`	获取群文件系统信息
`getGroupFileList`	获取群文件夹下文件列表
`setGroupRemark`	设置群备注
`getNotJoinedGroupInfo`	获取陌生群信息
`getAtAllCount`	获取全体艾特剩余次数
`getGroupMuteList`	获取群被禁言用户列表
`pokeUser`	戳一戳用户
`getCookies`	获取 Cookies
`getCredentials`	获取相关接口凭证
`getCSRFToken`	获取 CSRF Token
`getHttpCookies`	获取 HTTP Cookies

调用示例

提示

调用方式一共有两种，一种是在被动事件中调用，一种是主动调用

被动事件中调用

温馨提示

以上所有API都可以通过e.bot进行调用

import karin
 from 'node-karin'

export const api
 = karin
.command
(/^api$/, async (e
) => {
  const result
 = await e
.bot
.getAvatarUrl
(e
.userId
)
  // => 你的头像链接为: https://q.qlogo.cn/headimg_dl?dst_uin=1072411694&spec=100
  await e
.reply
(`你的头像链接为: ${result
}`)
  return true
}, { name
: '调用api测试' })

主动调用

温馨提示

以上所有API都可以通过获取到的bot对象进行调用

import karin
 from 'node-karin'

const selfId
 = '123456789' // bot的id
const bot
 = karin
.getBot
(selfId
) // 注意可能是`null`，请自行处理
const result
 = await bot
.getAvatarUrl
(selfId
)
// => 你的头像链接为: https://q.qlogo.cn/headimg_dl?dst_uin=123456789&spec=100

API 参数和调用

注意

这里的调用示例默认使用e.bot进行调用
只展示调用Api的方式，请自行替代到上方的调用示例中
返回值: 均使用result进行展示

`logger`

打印当前 Bot 的专属日志

参数	类型	描述	备注
`level`	`string`	日志等级	`all` `trace` `debug` `mark` `info` `warn` `error` `fatal`
`...args`	`any[]`	日志内容

调用示例返回值

const result
 = await e
.bot
.logger
('info', '这是一条info日志')

// 此接口无返回值

`sendMsg`

发送消息

参数	类型	描述	备注
`contact`	`Contact`	目标信息	`e.contact` 或手动构建
`elements`	`Array<Element>`	消息元素	注意是数组
`retryCount`	`number`	重试次数	可选

调用示例返回值

const result
 = await e
.bot
.sendMsg
(e
.contact
, elements
)

/** 发送消息后返回的结果 */
export interface SendMsgResults {
  /** @deprecated 已废弃 请使用 `messageId` */
  message_id: string
  /** 消息ID */
  messageId: string
  /** 消息发送时间戳 */
  messageTime: number
  /** 原始结果 一般是Object、Array */
  rawData: object | Array<any>
}

`sendLongMsg`

发送长消息

参数	类型	描述	备注
`contact`	`Contact`	目标信息	`e.contact` 或手动构建
`resId`	`string`	资源 ID

调用示例返回值

const resId
 = 'abcdefg'
const result
 = await e
.bot
.sendLongMsg
(e
.contact
, resId
)

/** 发送消息后返回的结果 */
export interface SendMsgResults {
  /** @deprecated 已废弃 请使用 `messageId` */
  message_id: string;
  /** 消息ID */
  messageId: string;
  /** 消息发送时间戳 */
  messageTime: number;
  /** 原始结果 一般是Object、Array */
  rawData: object | Array<any>;
}

`sendForwardMsg`

发送合并转发消息

参数	类型	描述	备注
`contact`	`Contact`	目标信息	`e.contact` 或手动构建
`elements`	`Array<Element>`	消息元素

调用示例返回值

const list
 = [segment.text
('1'), segment.text
('2'), segment.text
('3')]
const elements
 = common.makeForward
(list
, e
.selfId
, e
.bot
.account
.name
)
const result
 = await e
.bot
.sendForwardMsg
(e
.contact
, elements
)

{
  /** 消息ID */
  messageId: string
}

`recallMsg`

撤回消息，返回值不值得信任

参数	类型	描述	备注
`contact`	`Contact`	目标信息	`e.contact` 或手动构建
`messageId`	`string`	消息 ID

调用示例返回值

const messageId
 = '123456789'
const result
 = await e
.bot
.recallMsg
(e
.contact
, messageId
)

// 返回值为boolean类型 此接口的返回值不值得信任

`getAvatarUrl`

获取头像 URL

参数	类型	描述	备注
`userId`	`string`	用户 ID
`size`	`number`	头像大小	默认`0`

调用示例返回值

const userId
 = '123456'
const result
 = await e
.bot
.getAvatarUrl
(userId
)

// 返回值为string类型

`getGroupAvatarUrl`

获取群头像 URL

参数	类型	描述	备注
`groupId`	`string`	群号
`size`	`number`	头像大小	默认`0`
`history`	`number`	历史头像	默认`0`

调用示例返回值

const result
 = await e
.bot
.getGroupAvatarUrl
(e
.groupId
, size
, history
)

// 返回值为string类型

`getMsg`

获取消息

参数	类型	描述	备注
`contact`	`Contact`	目标信息	`e.contact` 或手动构建
`messageId`	`string`	消息 ID

调用示例返回值

const result
 = await e
.bot
.getMsg
(e
.contact
, e
.messageId
)

/** 基本消息返回值结构 */
export interface MessageResponse {
  /** 消息发送时间 */
  time
: number
  /** 消息ID */
  messageId
: string
  /** 消息序列号 */
  messageSeq
: number
  /** 消息来源目标信息 */
  contact
: Contact
 // 与传入的contact相同
  /** 消息发送者 */
  sender
: GroupSender // 请查看发送者结构
  /** 消息元素 */
  elements
: Array
<ElementTypes
>
}
// 关于ElementTypes类型请自行查看`segment`文档

`getHistoryMsg`

获取历史消息

参数	类型	描述	备注
`contact`	`Contact`	目标信息	`e.contact` 或手动构建
`startMsgId`	`string`	起始消息
`count`	`number`	消息数量	默认`1`

调用示例返回值

const startMsgId
 = '123456789'
const count
 = 10
const result
 = await e
.bot
.getHistoryMsg
(e
.contact
, startMsgId
, count
)

// 此处反面返回值结构为数组`MessageResponse`
Array
<MessageResponse>

`getForwardMsg`

获取合并转发消息 暂时无法使用

参数	类型	描述	备注
`resId`	`string`	资源 ID

调用示例返回值

const resId
 = 'abcdefg'
const result
 = await e
.bot
.getForwardMsg
(resId
)

// 接口返回值错误，接口暂时无法使用

`getGroupHighlights`

获取群精华消息

参数	类型	描述
`groupId`	`string`	群 ID
`page`	`number`	页码
`pageSize`	`number`	每页数量

调用示例返回值

const result
 = await e
.bot
.getGroupHighlights
(groupId
, page
, pageSize
)

/** 获取精华消息返回值结构 */
export interface GetGroupHighlightsResponse {
  /** 群ID */
  groupId: string
  /** 消息发送者ID */
  senderId: string
  /** 发送者昵称 */
  senderName: string
  /** 操作者ID */
  operatorId: string
  /** 操作者昵称 */
  operatorName: string
  /** 操作时间 */
  operationTime: number
  /** 消息发送时间 */
  messageTime: number
  /** 消息ID */
  messageId: string
  /** 消息序列号 */
  messageSeq: number
  /** 被设置的精华消息元素文本 */
  jsonElements: string
}

// 返回值为 `Array<GetGroupHighlightsResponse>`

`createResId`

构造资源 ID，不发送消息

参数	类型	描述	备注
`contact`	`Contact`	目标信息	`e.contact` 或手动构建
`elements`	`Array<NodeElementType>`	消息元素

调用示例返回值

const result
 = await e
.bot
.createResId
(e
.contact
, elements
)

// 返回值为string类型

`setGgroupHighlights`

设置或取消群精华消息

参数	类型	描述	备注
`groupId`	`string`	群 ID
`messageId`	`string`	消息 ID
`create`	`boolean`	是否创建	默认`true`

调用示例返回值

const result
 = await e
.bot
.setGgroupHighlights
(groupId
, messageId
, create
)

// 返回值为boolean类型 此接口的返回值不值得信任

`sendLike`

发送好友赞

参数	类型	描述	备注
`targetId`	`string`	目标 ID
`count`	`number`	赞的次数	默认`10`

调用示例返回值

const result
 = await e
.bot
.sendLike
(targetId
, count
)

// 返回值为boolean类型 此接口的返回值不值得信任

`groupKickMember`

群踢人

参数	类型	描述	备注
`groupId`	`string`	群 ID
`targetId`	`string`	目标 ID
`rejectAddRequest`	`boolean`	拒绝再次申请	默认`false`
`kickReason`	`string`	踢出原因	可选

调用示例返回值

const result
 = await e
.bot
.groupKickMember
(groupId
, targetId
, rejectAddRequest
, kickReason
)

// 返回值为boolean类型 此接口的返回值不值得信任

`setGroupMute`

禁言群成员

参数	类型	描述	备注
`groupId`	`string`	群 ID
`targetId`	`string`	目标 ID
`duration`	`number`	禁言时长	单位:秒

调用示例返回值

const result
 = await e
.bot
.setGroupMute
(groupId
, targetId
, duration
)

// 返回值为boolean类型 此接口的返回值不值得信任

`setGroupAllMute`

设置全员禁言

参数	类型	描述	备注
`groupId`	`string`	群 ID
`isBan`	`boolean`	是否禁言

调用示例返回值

const result
 = await e
.bot
.setGroupAllMute
(groupId
, isBan
)

// 返回值为boolean类型 此接口的返回值不值得信任

`setGroupAdmin`

设置或取消群管理员

参数	类型	描述
`groupId`	`string`	群 ID
`targetId`	`string`	目标 ID
`isAdmin`	`boolean`	是否管理员

调用示例返回值

const result
 = await e
.bot
.setGroupAdmin
(groupId
, targetId
, isAdmin
)

// 返回值为boolean类型 此接口的返回值不值得信任

`setGroupMemberCard`

设置群名片

参数	类型	描述
`groupId`	`string`	群 ID
`targetId`	`string`	目标 ID
`card`	`string`	群名片

调用示例返回值

const result
 = await e
.bot
.setGroupMemberCard
(groupId
, targetId
, card
)

// 返回值为boolean类型 此接口的返回值不值得信任

`setGroupName`

设置群名

参数	类型	描述	备注
`groupId`	`string`	群 ID
`groupName`	`string`	群名

调用示例返回值

const result
 = await e
.bot
.setGroupName
(groupId
, groupName
)

// 返回值为boolean类型 此接口的返回值不值得信任

`setGroupQuit`

退出群组

参数	类型	描述	备注
`groupId`	`string`	群 ID
`isDismiss`	`boolean`	是否解散

调用示例返回值

const result
 = await e
.bot
.setGroupQuit
(groupId
, isDismiss
)

// 返回值为boolean类型 此接口的返回值不值得信任

`setGroupMemberTitle`

设置群专属头衔

参数	类型	描述
`groupId`	`string`	群 ID
`targetId`	`string`	目标 ID
`title`	`string`	专属头衔

调用示例返回值

const result
 = await e
.bot
.setGroupMemberTitle
(groupId
, targetId
, title
)

// 返回值为boolean类型 此接口的返回值不值得信任

`getStrangerInfo`

获取陌生人信息

参数	类型	描述	备注
`targetId`	`string`	用户 ID

调用示例返回值

const result
 = await e
.bot
.getStrangerInfo
(targetId
)

/**
 * 用户信息结构
 * @description 此接口仅可保证返回user_id、nick这两个字段
 */
export interface UserInfo {
  /** 用户ID */
  userId: string
  /** 名称 */
  nick: string
  /** 用户UID */
  uid: string
  /** 用户UIN */
  uin: string
  /** qid */
  qid?: string
  /** 备注 */
  remark?: string
  /** 用户等级 */
  level?: number
  /** 生日 */
  birthday?: string
  /** 登录天数 */
  loginDay?: number
  /** 点赞数 */
  likeCount?: number
  /** 学校是否已核实 */
  isSchoolVerified?: boolean
  /** 年龄 */
  age?: number
  /** 性别 */
  sex?: SexEnum
  /** 好莱坞/腾讯视频会员 */
  hollywoodVip?: boolean
  /** QQ会员 */
  qqVip?: boolean
  /** QQ超级会员 */
  qqSvip?: boolean
  /** 大会员 */
  bigVip?: boolean
  /** 是否已经赞过 */
  isLike?: boolean
  [key: string]: any
}

`getFriendList`

获取好友列表

参数	类型	描述	备注
`refresh`	`boolean`	是否刷新好友列表	可选

调用示例返回值

const result
 = await e
.bot
.getFriendList
(refresh
)

// 返回值为`API-getStrangerInfo`的数组结构
// 比如`API-getStrangerInfo`的返回值是UserInfo，那么此处的返回值就是`Array<UserInfo>`

`getGroupInfo`

获取群信息

参数	类型	描述	备注
`groupId`	`string`	群 ID
`noCache`	`boolean`	是否刷新缓存	可选

调用示例返回值

const result
 = await e
.bot
.getGroupInfo
(groupId
, noCache
)

/**
 * 群信息结构
 * @description 此接口仅可保证返回group_id这个字段
 */
export interface GroupInfo {
  /** 群ID */
  groupId: string
  /** 群名称 */
  groupName?: string
  /** 群主ID */
  owner?: string
  /** 群备注 */
  groupRemark?: string
  /** 群管理员ID列表 */
  admins?: Array<string>
  /** 最大成员数 */
  maxMemberCount?: number
  /** 当前成员数 */
  memberCount?: number
  /** 群描述 */
  groupDesc?: string
}

`getGroupList`

获取群列表

参数	类型	描述	备注
`refresh`	`boolean`	是否刷新群列表	可选

调用示例返回值

const result
 = await e
.bot
.getGroupList
(refresh
)

// 返回值为`API-getGroupInfo`的数组结构
// 比如`API-getGroupInfo`的返回值是GroupInfo，那么此处的返回值就是`Array<GroupInfo>`

`getGroupMemberInfo`

获取群成员信息

参数	类型	描述	备注
`groupId`	`string`	群 ID
`targetId`	`string`	目标用户 ID
`refresh`	`boolean`	是否刷新缓存	可选

调用示例返回值

const result
 = await e
.bot
.getGroupMemberInfo
(groupId
, targetId
, refresh
)

/**
 * 群成员信息
 * @description 此接口仅可保证返回user_id这个字段
 */
export interface GroupMemberInfo {
  /** 用户ID */
  userId: string
  /** 用户角色 */
  role?: RoleEnum
  /** 用户昵称 */
  nick?: string
  /** 年龄 */
  age?: number
  /** 群内头衔 */
  uniqueTitle?: string
  /** 群名片 */
  card?: string
  /** 加群时间 */
  joinTime?: number
  /** 最后活跃时间 */
  lastActiveTime?: number
  /** 用户等级 */
  level?: number
  /** 禁言时间 */
  shutUpTime?: number
  /** 距离 */
  distance?: number
  /** 荣誉列表 */
  honors?: Array<number>
  /** 是否好友 */
  unfriendly?: boolean
}

`getGroupMemberList`

获取群成员列表

参数	类型	描述	备注
`groupId`	`string`	群 ID
`refresh`	`boolean`	是否刷新缓存	可选

调用示例返回值

const result
 = await e
.bot
.getGroupMemberList
(groupId
, refresh
)

// 返回值为`API-getGroupMemberInfo`的数组结构
// 比如`API-getGroupMemberInfo`的返回值是GroupMemberInfo，那么此处的返回值就是`Array<GroupMemberInfo>`

`getGroupHonor`

获取群荣誉信息

参数	类型	描述	备注
`groupId`	`string`	群 ID

调用示例返回值

const result
 = await e
.bot
.getGroupHonor
(groupId
)

/**
 * 群荣誉信息
 * @description 此接口仅可在QQ协议端中使用
 */
export interface QQGroupHonorInfo {
  /** 荣誉成员ID */
  userId: string
  /** 荣誉成员昵称 */
  nick: string
  /** 荣誉名称 */
  honorName: string
  /** 荣誉图标url */
  avatar: string
  /** 荣誉id */
  id: number
  /** 荣誉描述 */
  description: string
}
// 返回值为`Array<QQGroupHonorInfo>`

`setFriendApplyResult`

设置好友请求结果

参数	类型	描述	备注
`requestId`	`string`	请求事件 ID
`isApprove`	`boolean`	是否同意
`remark`	`string`	好友备注	可选

调用示例返回值

const result
 = await e
.bot
.setFriendApplyResult
(requestId
, isApprove
, remark
)

// 返回值为boolean类型 此接口的返回值不值得信任

`setGroupApplyResult`

设置申请加入群请求结果

参数	类型	描述	备注
`requestId`	`string`	请求事件 ID
`isApprove`	`boolean`	是否同意
`denyReason`	`string`	拒绝理由	可选

调用示例返回值

const result
 = await e
.bot
.setGroupApplyResult
(requestId
, isApprove
, denyReason
)

// 返回值为boolean类型 此接口的返回值不值得信任

`setInvitedJoinGroupResult`

设置邀请加入群请求结果

参数	类型	描述	备注
`requestId`	`string`	请求事件 ID
`isApprove`	`boolean`	是否同意

调用示例返回值

const result
 = await e
.bot
.setInvitedJoinGroupResult
(requestId
, isApprove
)

// 返回值为boolean类型 此接口的返回值不值得信任

`setMsgReaction`

设置消息表情回应

参数	类型	描述	备注
`contact`	`Contact`	目标信息	`e.contact` 或手动构建
`messageId`	`string`	消息 ID
`faceId`	`number`	表情 ID
`isSet`	`boolean`	是否设置

调用示例返回值

const result
 = await e
.bot
.setMsgReaction
(e
.contact
, messageId
, faceId
, isSet
)

// 返回值为boolean类型 此接口的返回值不值得信任

`uploadFile`

上传群文件或私聊文件

参数	类型	描述	备注
`contact`	`Contact`	目标信息	`e.contact` 或手动构建
`file`	`string`	本地文件路径
`name`	`string`	文件名称
`folder`	`string`	父目录 ID	可选

调用示例返回值

const result
 = await e
.bot
.uploadFile
(e
.contact
, file
, name
, folder
)

// 返回值为boolean类型 此接口的返回值不值得信任

`downloadFile`

下载文件到协议端本地

参数	类型	描述	备注
`options`	`DownloadFileOptions`	下载选项	可选

调用示例返回值

const result
 = await e
.bot
.downloadFile
(options
)

/** 让协议端下载文件到协议端本地返回值结构 */
export interface DownloadFileResponse {
  /** 下载后文件的绝对路径 */
  filePath: string;
}

`createGroupFolder`

创建群文件夹

参数	类型	描述	备注
`groupId`	`string`	群号
`name`	`string`	文件夹名

调用示例返回值

const result
 = await e
.bot
.createGroupFolder
(groupId
, name
)

/** 创建群文件夹返回值结构 */
export interface CreateGroupFolderResponse {
  /** 文件夹ID */
  id: string
  /** 已使用空间 */
  usedSpace: string
}

`renameGroupFolder`

重命名群文件夹

参数	类型	描述
`groupId`	`string`	群号
`folderId`	`string`	文件夹 ID
`name`	`string`	文件夹名

调用示例返回值

const result
 = await e
.bot
.renameGroupFolder
(groupId
, folderId
, name
)

// 返回值为boolean类型 此接口的返回值不值得信任

`delGroupFolder`

删除群文件夹

参数	类型	描述	备注
`groupId`	`string`	群号
`folderId`	`string`	文件夹 ID

调用示例返回值

const result
 = await e
.bot
.delGroupFolder
(groupId
, folderId
)

// 返回值为boolean类型 此接口的返回值不值得信任

`uploadGroupFile`

上传群文件

参数	类型	描述	备注
`groupId`	`string`	群号
`file`	`string`	文件路径
`name`	`string`	文件名	可选

调用示例返回值

const result
 = await e
.bot
.uploadGroupFile
(groupId
, file
, name
)

// 返回值为boolean类型 此接口的返回值不值得信任

`delGroupFile`

删除群文件

参数	类型	描述
`groupId`	`string`	群号
`fileId`	`string`	文件 ID
`busId`	`number`	文件类型 ID

调用示例返回值

import { GroupMessage
 } from 'node-karin'
const e
 = {} as GroupMessage

const groupId
 = '123456789'
const fileId
 = '1234567890'
const busId
 = 1
const result
 = await e
.bot
.delGroupFile
(groupId
, fileId
, busId
)

// 返回值为boolean类型 此接口的返回值不值得信任

`getGroupFileSystemInfo`

获取群文件系统信息

参数	类型	描述	备注
`groupId`	`string`	群号

调用示例返回值

const result
 = await e
.bot
.getGroupFileSystemInfo
(groupId
)

/** 获取群文件系统信息返回值结构 */
export interface GetGroupFileSystemInfoResponse {
  /** 文件数量 */
  fileCount: number
  /** 文件夹数量 */
  totalCount: number
  /** 已使用空间 */
  usedSpace: number
  /** 总空间 */
  totalSpace: number
}

`getGroupFileList`

获取群文件夹下文件列表

参数	类型	描述	备注
`groupId`	`string`	群号
`folderId`	`string`	文件夹 ID	可选

调用示例返回值

const result
 = await e
.bot
.getGroupFileList
(groupId
, folderId
)

/** 获取群文件夹下文件列表返回值结构 */
export interface GetGroupFileListResponse {
  /** 文件列表 */
  files
: QQGroupFileInfo[]
  /** 文件夹列表 */
  folders
: QQGroupFolderInfo[]
}

`setGroupRemark`

设置群备注

参数	类型	描述	备注
`groupId`	`string`	群号
`remark`	`string`	新的备注

调用示例返回值

import { GroupMessage
 } from 'node-karin'
const e
 = {} as GroupMessage

const groupId
 = '123456789'
const remark
 = '测试备注群'
const result
 = await e
.bot
.setGroupRemark
(groupId
, remark
)

// 返回值为boolean类型 此接口的返回值不值得信任

`getNotJoinedGroupInfo`

获取陌生群信息

参数	类型	描述	备注
`groupId`	`string`	群号

调用示例返回值

import { GroupMessage
 } from 'node-karin'
const e
 = {} as GroupMessage

const groupId
 = '123456789'
const result
 = await e
.bot
.getNotJoinedGroupInfo
!(groupId
)

// 返回值与`API-getGroupInfo`相同

`getAtAllCount`

获取全体艾特剩余次数

参数	类型	描述	备注
`groupId`	`string`	群号

调用示例返回值

import { GroupMessage
 } from 'node-karin'
const e
 = {} as GroupMessage

const groupId
 = '123456789'
const result
 = await e
.bot
.getAtAllCount
(groupId
)

/** 获取at全体成员剩余次数返回值结构 */
export interface GetAtAllCountResponse {
  /** 是否允许at全体成员 */
  accessAtAll: boolean
  /** 全群剩余次数 */
  groupRemainCount: number
  /** 个人剩余次数 */
  userRremainCount: number
}

`getGroupMuteList`

获取群被禁言用户列表

参数	类型	描述	备注
`groupId`	`string`	群号

调用示例返回值

import { GroupMessage
 } from 'node-karin'
const e
 = {} as GroupMessage

const groupId
 = '123456789'
const result
 = await e
.bot
.getGroupMuteList
(groupId
)

/** 获取群被禁言用户列表返回值结构 */
export interface GetGroupMuteListResponse {
  /** 用户ID */
  userId: string
  /** 禁言时间 */
  muteTime: number
}

`pokeUser`

戳一戳用户

参数	类型	描述	备注
`contact`	`Contact`	目标信息	`e.contact` 或手动构建
`count`	`number`	戳一戳次数	可选

调用示例返回值

const result
 = await e
.bot
.pokeUser
(e
.contact
, count
)

// 返回值为boolean类型 此接口的返回值不值得信任

`getCookies`

获取 Cookies

参数	类型	描述	备注
`domain`	`string`	域名

调用示例返回值

const result
 = await e
.bot
.getCookies
(domain
)

{
  cookie: string
}

`getCredentials`

获取相关接口凭证

参数	类型	描述	备注
`domain`	`string`	域名

调用示例返回值

const result
 = await e
.bot
.getCredentials
(domain
)

{ cookies: string, csrf_token: number }

`getCSRFToken`

获取 CSRF Token

参数	类型	描述	备注
`domain`	`string`	域名

调用示例返回值

const result
 = await e
.bot
.getCSRFToken
(domain
)

{
  token: number
}

`getHttpCookies`

获取 HTTP Cookies

参数	类型	描述
`appid`	`string`	应用 ID
`daid`	`string`	DAID
`jumpUrl`	`string`	跳转 URL

调用示例返回值

const result
 = await e
.bot
.getHttpCookies
(appid
, daid
, jumpUrl
)

{
  token: number
}

`sendApi`

发送 API 请求 onebot11 专属

参数	类型	描述	备注
`action`	`string`	动作
`params`	`object`	请求参数
`time`	`number`	超时时间	可选默认 120s

js调用ts调用返回值

const result = await e.bot.sendApi(action, params, time)

// 多一个`!`...
const result
 = await e
.bot
.sendApi
!(action
, params
, time
)

// 返回值`karin`做了处理，协议如果返回请求成功，则会返回其中的`data`字段
// 如果请求失败，则`karin`会抛出异常

最后编辑于大约 1 个月前

查看完整历史

分享此页面

公开 API 列表 ​

调用示例 ​

被动事件中调用 ​

主动调用 ​

API 参数和调用 ​

logger ​

sendMsg ​

sendLongMsg ​

sendForwardMsg ​

recallMsg ​

getAvatarUrl ​

getGroupAvatarUrl ​

getMsg ​

getHistoryMsg ​

getForwardMsg ​

getGroupHighlights ​

createResId ​

setGgroupHighlights ​

sendLike ​

groupKickMember ​

setGroupMute ​

setGroupAllMute ​

setGroupAdmin ​

setGroupMemberCard ​

setGroupName ​

setGroupQuit ​

setGroupMemberTitle ​

getStrangerInfo ​

getFriendList ​

getGroupInfo ​

getGroupList ​

getGroupMemberInfo ​

getGroupMemberList ​

getGroupHonor ​

setFriendApplyResult ​

setGroupApplyResult ​

setInvitedJoinGroupResult ​

setMsgReaction ​

uploadFile ​

downloadFile ​

createGroupFolder ​

renameGroupFolder ​

delGroupFolder ​

uploadGroupFile ​

delGroupFile ​

getGroupFileSystemInfo ​

getGroupFileList ​

setGroupRemark ​

getNotJoinedGroupInfo ​

getAtAllCount ​

getGroupMuteList ​

pokeUser ​

getCookies ​

getCredentials ​

getCSRFToken ​

getHttpCookies ​

sendApi ​

公开 API 列表

调用示例

被动事件中调用

主动调用

API 参数和调用

`logger`

`sendMsg`

`sendLongMsg`

`sendForwardMsg`

`recallMsg`

`getAvatarUrl`

`getGroupAvatarUrl`

`getMsg`

`getHistoryMsg`

`getForwardMsg`

`getGroupHighlights`

`createResId`

`setGgroupHighlights`

`sendLike`

`groupKickMember`

`setGroupMute`

`setGroupAllMute`

`setGroupAdmin`

`setGroupMemberCard`

`setGroupName`

`setGroupQuit`

`setGroupMemberTitle`

`getStrangerInfo`

`getFriendList`

`getGroupInfo`

`getGroupList`

`getGroupMemberInfo`

`getGroupMemberList`

`getGroupHonor`

`setFriendApplyResult`

`setGroupApplyResult`

`setInvitedJoinGroupResult`

`setMsgReaction`

`uploadFile`

`downloadFile`

`createGroupFolder`

`renameGroupFolder`

`delGroupFolder`

`uploadGroupFile`

`delGroupFile`

`getGroupFileSystemInfo`

`getGroupFileList`

`setGroupRemark`

`getNotJoinedGroupInfo`

`getAtAllCount`

`getGroupMuteList`

`pokeUser`

`getCookies`

`getCredentials`

`getCSRFToken`

`getHttpCookies`

`sendApi`