# @hanzofc/baileys 中文文档

规范地址：https://npmcn.com/package/%40hanzofc/baileys/

版本：7\.2\.2
npm 元数据更新时间：2026-10-24T10:59:37.913Z
中文译文更新时间：2026-11-17T18:29:55.082Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40hanzofc/baileys
原文对照：https://npmcn.com/package/%40hanzofc/baileys/?lang=original
项目主页：https://github.com/harissfx/Baileys3
源码仓库：https://github.com/harissfx/Baileys3

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：9 MB，461 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：11 个
- peer 依赖：jimp ^1\.6\.1，sharp \*，audio-decode ^2\.1\.3，link-preview-js ^3\.0\.0
- 首次发布：2026-09-28T13:42:13.248Z
- 最新版本发布：2026-10-24T10:59:37.745Z
- 近 30 天下载量：4556（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

一个定制的WhiskeySockets/Baileys分叉,为WhisApp自动化提供了额外的修正和修改.

## 安装

```sh
npm install @hanzofc/baileys
```

也可以使用：`pnpm add @hanzofc/baileys`、`yarn add @hanzofc/baileys`、`bun add @hanzofc/baileys`

## README

# @hanzofc/baileys (英语)

![Baileys logo](https://raw.githubusercontent.com/WhiskeySockets/Baileys/refs/heads/master/Media/logo.png)

一个定制的Baileys分叉,带有额外的修饰,修改和改良.

  

 [![npm version](https://img.shields.io/npm/v/@hanzofc/baileys.svg)](https://www.npmjs.com/package/@hanzofc/baileys)[![GitHub stars](https://img.shields.io/github/stars/harissfx/Baileys3.svg) ](https://github.com/harissfx/Baileys3)[![license](https://img.shields.io/github/license/harissfx/Baileys3.svg)](https://github.com/harissfx/Baileys3)

> \[大 这个项目是 **已修改叉 [威士忌/饼干](https://github.com/WhiskeySockets/Baileys)**。 。 。 .
> 
> 贝利斯最初的项目及其上游捐款者记入以下。 此分叉独立维护并发布为 `@hanzofc/baileys`。 。 。 .

## 关于

`@hanzofc/baileys` 是一个定制的叉 **贝利**,用于通过WebSockets与WhatsApp Web互动的 TypeScript 库.

这个分叉与上游项目分开维护,包含作者用于WhatsApp自动化项目的额外修正,修改和更改.

### 特征

-   WhatsApp 网络套接字连接
-   多设备支持
-   类型脚本支持
-   认证状态管理
-   信件发送和接收
-   集团管理
-   媒体信息
-   交互式消息( 按钮、 列表、 本地流和所需的 `biz` 节点)
-   存在最新情况
-   联系和概况信息
-   基于活动的架构
-   额外消息类型:产品、订单、付款请求、事件、相册、民意测验结果、组状态、组成员标签
-   `richMenu` 财务报告和审定财务报表 `sendHtml` 帮助者
-   丰富的消息帮助者 : `sendTable`, (中文(简体) ), `sendList`, (中文(简体) ), `sendCodeBlock`, (中文(简体) ), `sendLatex`
-   WhatsApp 用户名管理 (英语)`checkUsername`, (中文(简体) ), `setUsername`, (中文(简体) ), `findUserByUsername`, (...) (中文(简体) )
-   已恢复 `makeInMemoryStore` 和可选 `makeCacheManagerStore`
-   `useSqliteAuthState` (单文件 SQLite 认证存储)
-   精细接力选项( E)`isSecret`, (中文(简体) ), `protected`, (中文(简体) ), `me`(中文(简体) )
-   本叉所维持的其他修正和修改

## 与上游的差异

此分叉基于 [威士忌/饼干](https://github.com/WhiskeySockets/Baileys) `7.0.0-rc14` (与上游承诺相比) `0af2386`,"广告WIN HYBRID代替已退休的WIN32网络子平台". 图书馆里的其他东西都像上游一样.

| 区域 | 上游 | 这个叉子 |
| --- | --- | --- |
| 软件包名称 | `baileys` | `@hanzofc/baileys` |
| 版本 | `7.0.0-rc14` | `7.1.0` |
| Auth 状态 | `useMultiFileAuthState` | 添加数 `useSqliteAuthState` (需要节点22.5+) |
| `sendMessage` 内容 | 标准内容类型 | 添加数 `productMessage`, (中文(简体) ), `orderMessage`, (中文(简体) ), `requestPaymentMessage`, (中文(简体) ), `eventMessage`, (中文(简体) ), `albumMessage`, (中文(简体) ), `pollResultMessage`, (中文(简体) ), `groupStatus`, (中文(简体) ), `groupLabel` |
| 额外套接字方法 | \- 说吧 | `richMenu(jid, content)`, (中文(简体) ), `sendHtml(jid, html)`, (中文(简体) ), `sendTable`, (中文(简体) ), `sendList`, (中文(简体) ), `sendCodeBlock`, (中文(简体) ), `sendLatex` |
| 用户名 API | \- 说吧 | `checkUsername`, (中文(简体) ), `checkUsernameMulti`, (中文(简体) ), `setUsername`, (中文(简体) ), `deleteUsername`, (中文(简体) ), `getMyUsername`, (中文(简体) ), `getUsernameRecommendations`, (中文(简体) ), `setUsernamePin`, (中文(简体) ), `findUserByUsername`, (中文(简体) ), `fetchContactUsernames` |
| 存储 | 上游删除 | `makeInMemoryStore` 财务报告和审定财务报表 `makeCacheManagerStore` 再次导出 |
| 用户 | \- 说吧 | `message-composer` 帮助者( e)`tokenizeCode`, (中文(简体) ), `generateTableContent`, (中文(简体) ), `generateCodeBlockContent`, (中文(简体) ), `generateLatexContent`,从 `Utils` |
| 交互式消息 | 按原样发送 | 添加数 `biz` 编号 : `native_flow` 编号 : `bot` 按钮、列表和本地流程的自动节点 |
| `relayMessage` 选项 | `participant` (重试重发) | 重试重命名为 `participants`· ; `participant` 现在表示“只接收者”;添加 `isSecret`, (中文(简体) ), `protected`, (中文(简体) ), `me` |
| 客户端平台 | `WEB`,或 `ANDROID` 如果浏览器名称包含“ android ” | 永远 `MACOS` |
| 连接时 | 没有额外的 | 自动遵循通讯 JID `AUTO_FOLLOW_NEWSLETTER_JIDS` |
| 普罗托布夫 | 上游定义 | 添加数 `BloksWidget` 改为 `WAProto` |
| 构建输出 | \- 说吧 | 明确使用无害环境管理进口 `.js` 扩展 |

> \[尖叫声\] 其中一些变化会影响行为或公共API. 在从上游升级之前阅读以下各节.

### 所需资源

-   20或更新的节点(由 `engine-requirements.js` 安装时)
-   节点js 22.5 或 更新的,只有使用 `useSqliteAuthState` (它依赖于内置的) `node:sqlite` 模块)

### 打破/ 行为改变

**重试重命名的再发送选项 .** 上游通过 `{ participant: { jid, count } }` 改为 `relayMessage` 当解密失败后重发时。 在这个分叉中,选项是 `participants`。 。 。 . `participant: { jid }` (无) `count`现在只针对接受者。 如果你打电话 `relayMessage` 直接使用旧形状,更新代码.

**客户端平台总是 `MACOS`。 。 。 .** 上游选择 `WEB` (或 `ANDROID` 何时 `browser[1]` 包含"android"). 这叉子总是做广告 `MACOS` 在客户有效载荷.

**通讯自动跟随.** 在第一个 `connection: 'open'`,套接字调用 `newsletterFollow` 每个 JID 输入 `AUTO_FOLLOW_NEWSLETTER_JIDS` (定义于 `src/Socket/index.ts`。错误被忽略。 目前没有配置选项: 禁用它、 清空源中的数组并重建 .

## 在7.1.0中什么是新来的

与 `7.0.1` (上次 npm 发布):

### 已添加

-   **丰富的信件助手** (单位:千美元)`src/Utils/message-composer.ts`,显示在套接字上 :
    -   `sock.sendTable(jid, title, headers, rows, quoted?, options?)`
    -   `sock.sendList(jid, title, items, quoted?, options?)`
    -   `sock.sendCodeBlock(jid, code, quoted?, { language, title, footer })` javaScript/ TypeScript 和 Python 的内置语法符号化
    -   `sock.sendLatex(jid, quoted?, { text, expressions, headerText, footer })`
-   **用户名 API** (单位:千美元)`src/Socket/username.ts`),以新的通用软件为基础 `w:mex` 查询帮助器( e)`src/Socket/mex.ts`:
    -   `checkUsername`, (中文(简体) ), `checkUsernameMulti`, (中文(简体) ), `setUsername`, (中文(简体) ), `deleteUsername`, (中文(简体) ), `getMyUsername`
    -   `getUsernameRecommendations`, (中文(简体) ), `setUsernamePin`, (中文(简体) ), `findUserByUsername`, (中文(简体) ), `fetchContactUsernames`
    -   这个 `USERNAME_QUERY_IDS`, (中文(简体) ), `USERNAME_CHECK_RESULT` 财务报告和审定财务报表 `USERNAME_SOURCE` 常量导出.
-   **恢复存储模块**数字 : `makeInMemoryStore`, (中文(简体) ), `makeOrderedDictionary`, (中文(简体) ), `ObjectRepository`, (中文(简体) ), `KeyedDB`选择 `makeCacheManagerStore` (需求数) `npm install cache-manager`) (中文(简体) ).
-   新的测试套件和类型申报 `node:sqlite`。 。 。 .

### 已更改

-   `Utils` 财务报告和审定财务报表 `Store` 索引文件现在再导出新模块(`message-composer`,存储助手.
-   这个 `lib/` 根据更新的构建输出重新生成 `src/`。 。 。 .
-   依赖性和 `resolutions` 块被刷新( 中转包的安全修正, 如 `tar`, (中文(简体) ), `minimatch`, (中文(简体) ), `glob`, (中文(简体) ), `handlebars`, (中文(简体) ), `markdown-it`, (中文(简体) ), `picomatch`, (中文(简体) ), `socks`) (中文(简体) ).

### 页:1

> \[尖叫声\] 用户名操作使用 WhatsApp `w:mex` 图表QL 查询 ID 。 这些ID是从特定的WhatsApp客户端版本获取的,可以不经通知而更改,因此在WhatsApp更新后,一个呼叫可能会开始失败.
> 
> 喜欢 `richMenu` 财务报告和审定财务报表 `sendHtml`,丰富的消息帮助者依赖于没有记录的WhatsApp客户端行为,并可能使不同或停止工作.

### 实例

```ts
// Table
await sock.sendTable(jid, 'Prices', ['Item', 'Price'], [
    ['Coffee', '10.000'],
    ['Tea', '8.000']
])

// Code block
await sock.sendCodeBlock(jid, 'console.log("hello")', undefined, {
    language: 'javascript',
    title: 'Example'
})

// Username
const result = await sock.checkUsername('my.username')
if (result.available) await sock.setUsername('my.username')
```

## 安装

从 npm 直接安装软件包 :

```bash
npm install @hanzofc/baileys
```

使用线条 :

```bash
yarn add @hanzofc/baileys
```

使用 pnpm :

```bash
pnpm add @hanzofc/baileys
```

### 现有项目 `baileys`

如果您的项目已经使用 :

```ts
import makeWASocket from 'baileys'
```

您可以使用 npm 化名安装此分叉 :

```bash
npm install baileys@npm:@hanzofc/baileys
```

允许使用 `baileys` 继续工作而不改变项目中的每个导入.

## 使用量

```ts
import makeWASocket from '@hanzofc/baileys'

const sock = makeWASocket({
    // options
})
```

如果您使用 npm 化名安装了软件包 :

```bash
npm install baileys@npm:@hanzofc/baileys
```

您可以继续使用 :

```ts
import makeWASocket from 'baileys'
```

## 认证

贝利斯使用认证状态来存储重新连接WhatsApp所需的证书.

常用的设置是使用 `useMultiFileAuthState`数字 :

```ts
import makeWASocket, {
    DisconnectReason,
    useMultiFileAuthState
} from '@hanzofc/baileys'

const { state, saveCreds } = await useMultiFileAuthState('auth_info_baileys')

const sock = makeWASocket({
    auth: state
})

sock.ev.on('creds.update', saveCreds)
```

认证文件一般不应承诺给Git.

添加您的认证目录到 `.gitignore`数字 :

```gitignore
auth_info_baileys/
```

### SQLite 认证状态

作为许多JSON文件的替代品,整个认证状态可以存储在一个单一的SQLite数据库中:

```ts
import makeWASocket, { useSqliteAuthState } from '@hanzofc/baileys'

const { state, saveCreds, close } = await useSqliteAuthState('./auth')

const sock = makeWASocket({ auth: state })

sock.ev.on('creds.update', saveCreds)
```

注释:

-   要求节点22.5+(内建) `node:sqlite`) (中文(简体) ). 在旧版本上,它扔 你应该使用 `useMultiFileAuthState` 换句话说.
-   第一个论点是: `.db` 编号 : `.sqlite` 编号 : `.sqlite3` 文件路径或文件夹。 对于文件夹,文件是 `auth.db` 除非你设定 `fileName`。 。 。 .
-   迁移已有的 `useMultiFileAuthState` 文件夹, 通过 `migrateFromFolder`。只有在数据库尚未获得证书时才使用.
-   打电话 `close()` 当你关闭插座时.

```ts
const { state, saveCreds } = await useSqliteAuthState('./auth', {
    fileName: 'auth.db',
    migrateFromFolder: './auth_info_baileys'
})
```

添加数据库到 `.gitignore` 还:

```gitignore
auth/
```

## 连接处理

您可以使用 `connection.update`数字 :

```ts
sock.ev.on('connection.update', (update) => {
    const { connection, lastDisconnect } = update

    if (connection === 'close') {
        console.log('connection closed')

        const shouldReconnect =
            (lastDisconnect?.error as any)?.output?.statusCode !== DisconnectReason.loggedOut

        if (shouldReconnect) {
            // reconnect
        }
    }

    if (connection === 'open') {
        console.log('connected')
    }
})
```

## 发送信件

### 文本

```ts
await sock.sendMessage(jid, {
    text: 'Hello World!'
})
```

### 图像

```ts
await sock.sendMessage(jid, {
    image: { url: './image.jpg' },
    caption: 'Hello!'
})
```

### 视频

```ts
await sock.sendMessage(jid, {
    video: { url: './video.mp4' },
    caption: 'Hello!'
})
```

### 音频

```ts
await sock.sendMessage(jid, {
    audio: { url: './audio.mp3' },
    mimetype: 'audio/mpeg'
})
```

### 文档

```ts
await sock.sendMessage(jid, {
    document: { url: './document.pdf' },
    mimetype: 'application/pdf',
    fileName: 'document.pdf'
})
```

### 贴纸

```ts
await sock.sendMessage(jid, {
    sticker: { url: './sticker.webp' }
})
```

## 正在回复信件

发送回复时可以引用信件 :

```ts
await sock.sendMessage(
    jid,
    {
        text: 'This is a reply'
    },
    {
        quoted: message
    }
)
```

## 信件事件

接收消息可以通过 `messages.upsert`数字 :

```ts
sock.ev.on('messages.upsert', async ({ messages }) => {
    for (const message of messages) {
        console.log(message)
    }
})
```

例如:

```ts
sock.ev.on('messages.upsert', async ({ messages }) => {
    const msg = messages[0]

    if (!msg.message) return

    console.log(msg.message)
})
```

## 组

### 获取组元数据

```ts
const metadata = await sock.groupMetadata(jid)

console.log(metadata)
```

### 创建组

```ts
const group = await sock.groupCreate('My Group', [
    '1234567890@s.whatsapp.net'
])
```

### 添加参与者

```ts
await sock.groupParticipantsUpdate(
    jid,
    ['1234567890@s.whatsapp.net'],
    'add'
)
```

### 删除参与者

```ts
await sock.groupParticipantsUpdate(
    jid,
    ['1234567890@s.whatsapp.net'],
    'remove'
)
```

### 推动参与者

```ts
await sock.groupParticipantsUpdate(
    jid,
    ['1234567890@s.whatsapp.net'],
    'promote'
)
```

### D. 发 言人

```ts
await sock.groupParticipantsUpdate(
    jid,
    ['1234567890@s.whatsapp.net'],
    'demote'
)
```

## 出席情况

可用下列方法更新存在:

```ts
await sock.sendPresenceUpdate('available', jid)
```

现有存在值包括:

```text
available
unavailable
composing
recording
paused
```

例如:

```ts
await sock.sendPresenceUpdate('composing', jid)

await new Promise(resolve => setTimeout(resolve, 2000))

await sock.sendPresenceUpdate('paused', jid)
```

## 联系人

您可以请求WhatsApp用户的信息 :

```ts
const result = await sock.onWhatsApp('1234567890')
console.log(result)
```

## 配置图

```ts
const profilePicture = await sock.profilePictureUrl(
    jid,
    'image'
)

console.log(profilePicture)
```

根据账户和隐私设置,配置图可能无法提供.

## 存在最新情况

您可以订阅存在更新 :

```ts
sock.ev.on('presence.update', (update) => {
    console.log(update)
})
```

## 打字指标

要表示机器人在打字:

```ts
await sock.sendPresenceUpdate('composing', jid)
```

停止打字 :

```ts
await sock.sendPresenceUpdate('paused', jid)
```

## 读取收据

信件可以标记为:

```ts
await sock.readMessages([
    message.key
])
```

## 反应

发送对消息的反应 :

```ts
await sock.sendMessage(
    jid,
    {
        react: {
            text: '👍',
            key: message.key
        }
    }
)
```

删除一个反应 :

```ts
await sock.sendMessage(
    jid,
    {
        react: {
            text: '',
            key: message.key
        }
    }
)
```

## 删除信件

对于可以删除的信件:

```ts
await sock.sendMessage(
    jid,
    {
        delete: message.key
    }
)
```

## 编辑信件

根据消息类型和支持的WhatsApp功能:

```ts
await sock.sendMessage(
    jid,
    {
        text: 'Edited message',
        edit: message.key
    }
)
```

## 转发信件

可用适当的信件结构传送信件 :

```ts
await sock.sendMessage(
    jid,
    {
        forward: message
    }
)
```

具体结构可能因消息类型和贝利斯版本而异.

## 媒体

Bairis支持发送不同类型的媒体,包括:

-   图像
-   视频
-   音频
-   文档
-   贴纸

示例

```ts
await sock.sendMessage(jid, {
    image: {
        url: './image.jpg'
    },
    caption: 'Example image'
})
```

对于远程媒体:

```ts
await sock.sendMessage(jid, {
    image: {
        url: 'https://example.com/image.jpg'
    }
})
```

## 下载媒体

利用图书馆提供的媒体下载设施,可从收到的新闻中下载媒体.

示例

```ts
import {
    downloadMediaMessage
} from '@hanzofc/baileys'

const buffer = await downloadMediaMessage(
    message,
    'buffer',
    {}
)
```

准确的下载选项取决于消息类型和库版本.

## 交互式信件

按钮、列表信件和本地流程信件通过 `sendMessage` 和往常一样 这个叉子添加了 `biz` (和,为私人聊天, `bot`)二进制节点需要它们来渲染,所以不需要通过 `additionalNodes` 你自己来.

对特定交互式格式的支持随着WhatsApp更新协议而改变. 检查当前支持的结构的导出类型 .

### 丰富的菜单

`richMenu` 发送快速补真按钮或一发旋转卡片,并带有可选的图像头和开放-URL页脚:

```ts
await sock.richMenu(jid, {
    header: { title: 'Menu', image: { url: 'https://example.com/banner.png' } },
    body: { title: 'Choose one', buttons: ['Option 1', 'Option 2'] },
    footer: { text: 'Open website', url: 'https://example.com' }
})
```

木马/一行牌:

```ts
await sock.richMenu(jid, {
    body: {
        carousel: true, // or row: true
        cards: [
            { title: 'Card 1', buttons: ['Select'] },
            { title: 'Card 2', buttons: ['Select'] }
        ]
    }
})
```

### HTML 语言

```ts
await sock.sendHtml(jid, '<h1>Hello</h1>')
```

> \[注\] `richMenu` 财务报告和审定财务报表 `sendHtml` 依赖没有正式文件记录的WhatsApp客户端行为,因此在WhatsApp更新后,他们可能停止工作或做出不同的修改.

## 特殊信件

这些内容类型由 `sendMessage` 在此分叉中,上游无法使用。 从内容对象中自动检测到它们.

### 产品

```ts
await sock.sendMessage(jid, {
    productMessage: {
        title: 'Product name',
        description: 'Description',
        thumbnail: { url: './product.jpg' },
        productId: '123',
        retailerId: 'shop',
        url: 'https://example.com',
        body: 'Body text',
        footer: 'Footer text',
        priceAmount1000: 25000000,
        currencyCode: 'IDR',
        buttons: []
    }
})
```

### 顺序

```ts
await sock.sendMessage(jid, {
    orderMessage: {
        orderTitle: 'Order #1',
        message: 'Thanks for your order',
        totalAmount1000: 50000000,
        totalCurrencyCode: 'IDR',
        itemCount: 2,
        thumbnail: { url: './order.jpg' }
    }
})
```

### 付款请求

```ts
await sock.sendMessage(jid, {
    requestPaymentMessage: {
        amount: 10000000, // amount x 1000
        currency: 'IDR',  // default: IDR
        from: '1234567890@s.whatsapp.net',
        note: 'Payment note'
    }
})
```

### 活动

```ts
await sock.sendMessage(jid, {
    eventMessage: {
        name: 'Meetup',
        description: 'Monthly meetup',
        startTime: 1790000000,
        endTime: 1790003600,
        location: { degreesLatitude: -7.25, degreesLongitude: 112.75, name: 'Surabaya' }
    }
})
```

### 专辑

```ts
await sock.sendMessage(jid, {
    albumMessage: [
        { image: { url: './1.jpg' }, caption: 'First' },
        { image: { url: './2.jpg' } },
        { video: { url: './3.mp4' } }
    ]
})
```

### 投票结果

```ts
await sock.sendMessage(jid, {
    pollResultMessage: {
        name: 'Favorite color?',
        options: [
            { optionName: 'Red', optionVoteCount: 10 },
            { optionName: 'Blue', optionVoteCount: 7 }
        ]
    }
})
```

### 组状态和组成员标签

```ts
// post a status inside a group
await sock.sendMessage(groupJid, {
    groupStatus: { image: { url: './status.jpg' }, caption: 'Hello group' }
})

// set your member label in a group (max. 30 characters)
await sock.sendMessage(groupJid, {
    groupLabel: 'Admin'
})
```

`groupLabel` 仅与组 JID 工作(`@g.us`) (中文(简体) ).

> \[注\] 这些有效载荷是通过观测到的WhatsApp行为手工构造的. 此处显示的字段名称以外的字段名称可见于 `src/Types/Message.ts` 财务报告和审定财务报表 `src/Socket/special-messages.ts`。 。 。 .

## 中继选项

`relayMessage` 接受控制哪些设备接收消息的额外选项 :

| 选项 | 效果 |
| --- | --- |
| `participant: { jid }` | 只发送到目标自己的设备,跳过自己的设备 |
| `participants: { jid, count }` | 重试重发给单个参与者( 在解密失败后使用) |
| `isSecret: true` | 只发送到目标的主要设备 |
| `protected: true` | 发送到除目标连接( 二级) 设备以外的所有设备 |
| `me: true` | 只发送到您的设备 |

`isSecret`, (中文(简体) ), `protected`, (中文(简体) ), `me` 财务报告和审定财务报表 `participant` 添加 `device_fanout: 'false'` 并且对团体或状态广播没有任何影响.

```ts
await sock.relayMessage(jid, message, {
    messageId,
    isSecret: true
})
```

## 活动

贝利斯采用以事件为基础的建筑.

共同活动包括:

```text
connection.update
creds.update
messages.upsert
messages.update
messages.delete
messages.reaction
chats.upsert
chats.update
chats.delete
contacts.upsert
contacts.update
presence.update
groups.upsert
groups.update
group-participants.update
```

示例

```ts
sock.ev.on('messages.upsert', ({ messages }) => {
    console.log(messages)
})
```

## 事件缓冲

对于同时进行多个操作的应用程序,贝利斯通过其事件系统提供事件缓冲机制.

这有助于防止在短时间内收到多起相关事件时进行不必要的处理.

参考当前支持的行为在此寄存器中导出的事件类型和执行 .

## 类型脚本

此软件包以 TypeScript 来写 .

示例

```ts
import makeWASocket, {
    WASocket,
    proto
} from '@hanzofc/baileys'

const sock: WASocket = makeWASocket({})
```

通过导出类型可以获取信件结构 :

```ts
import { proto } from '@hanzofc/baileys'

const message: proto.IWebMessageInfo = {}
```

现有类型在释放之间可能会有变化.

## 配置

使用软件包导出选项可以配置套接字 .

示例

```ts
const sock = makeWASocket({
    auth: state,
    printQRInTerminal: false
})
```

对于目前所支持的选项的完整列表,请参见此寄存器中的TypeScript定义和源代码.

## 日志

贝利使用 `pino` 用于伐木.

示例

```ts
import pino from 'pino'

const logger = pino({
    level: 'silent'
})

const sock = makeWASocket({
    logger
})
```

促进发展:

```ts
const logger = pino({
    level: 'debug'
})
```

## 代理服务器

代理配置依赖于连接执行和支持的套接字选项.

如果您需要代理支持, 请使用当前释放所支持的适当代理或连接选项配置套接字 .

## QR 代码

取决于认证设置和应用程序,在连接新账户时可能需要显示QR代码.

准确的QR处理取决于所使用的版本和认证配置.

示例

```ts
sock.ev.on('connection.update', ({ qr }) => {
    if (qr) {
        console.log('QR:', qr)
    }
})
```

您可以使用QR-代码库在终端或应用程序中显示QR.

## 配对代码

在被支持的地方,可以使用配对代码认证,而不是扫描一个QR代码.

示例

```ts
const phoneNumber = '1234567890'

const code = await sock.requestPairingCode(phoneNumber)

console.log(code)
```

电话号码应以国际格式提供,不包含 `+`,空格,或其他格式化字符.

示例

```text
6281234567890
```

配对代码的可用性和行为可能随着WhatsApp和Baileys的更新而改变.

## 多设备

贝利斯支持WhatsApp的多设备架构.

认证证书是在当地存储的,这样应用程序就可以重新连接,而无需反复对帐.

总是保护您的认证证书 .

不发布或共享 :

```text
creds.json
session files
authentication keys
app-state keys
```

## 警卫

将您的 WhatsApp 认证文件视为敏感证书 .

不许 :

-   上传认证文件到 GitHub .
-   与其他人共享认证文件.
-   将认证文件放入公共网络目录中.
-   在日志中包含认证证书 .
-   提交 `.env` 包含机密的文件.

一个典型 `.gitignore` 可以包括:

```gitignore
auth_info_baileys/
.env
node_modules/
```

## WhatsApp 兼容性

贝利斯通过WhatsApp Web协议与WhatsApp通信.

WhatsApp可以随时改变其协议,消息结构,认证机制等行为.

由于这个原因,相容性可能在不通知的情况下改变.

如果某东西在WhatsApp-side更改后停止工作,可能需要新的放行或代码修改.

## 版本

这个分叉沿用了它自己的npm发行版本,同时仍然以上游贝利斯代码库为基础.

目前来源基于上游 `7.0.0-rc14`。叉子自己的版本(`7.0.0`)不匹配上游的版本编号,所以这里较高的数字并不意味着它包含更新的上游变化. 这个 `CHANGELOG.md` 文件仍然只包含上游 `7.0.0-rc14` 标题.

当前软件包 :

```text
@hanzofc/baileys
```

示例

```bash
npm install @hanzofc/baileys@7.0.0
```

用于使用 `baileys` 别名 :

```bash
npm install baileys@npm:@hanzofc/baileys@7.0.0
```

### 发布模式

GitHub 上保留了源变化:

```text
https://github.com/harissfx/Baileys3
```

已公布的新闻稿见npm:

```text
https://www.npmjs.com/package/@hanzofc/baileys
```

GitHub 承诺不会自动更改已经发布的 npm 版本 .

## 发展

清除仓库 :

```bash
git clone https://github.com/harissfx/Baileys3.git
```

输入目录 :

```bash
cd Baileys3
```

安装依赖性 :

```bash
npm install
```

构建工程 :

```bash
npm run build
```

可用脚本检查 :

```bash
npm run
```

## 使用本地仓库

如果您正在针对本地源开发, 而不是发布 npm 软件包, 您可以使用本地依赖 :

```json
{
    "dependencies": {
        "baileys": "file:./Baileys3"
    }
}
```

这在发布 npm 版本前的测试更改时有用.

为了正常生产,建议安装已公布的软件包:

```bash
npm install @hanzofc/baileys
```

## 捐款

欢迎提问、错误报告和调取请求.

在打开一个问题之前,请检查这个问题是否由:

-   WhatsApp- side 变化
-   认证/会话问题
-   依赖性问题
-   配置问题
-   此分叉特有的错误

报告错误时,包括:

-   节点.js 版本
-   软件包版本
-   操作系统
-   相关错误消息
-   尽可能少复制

不包括认证证书或私有WhatsApp会话文件.

## 上游

该项目的基础是: **贝利**,最初由上游项目贡献者开发和维护.

上游仓库 :

[https://github.com/ 惠克索克特斯/贝利斯](https://github.com/WhiskeySockets/Baileys)

上游文档:

[https://baileys.wiki (英语)](https://baileys.wiki/)

这个叉子并不自称是贝利斯的官方存放地.

对于上游特有问题,文献,或变化,指上游项目.

## 贷项

特别感谢最初的贝利斯项目的贡献者和维护者.

如果没有上游贝利社区的工作,这一分叉就不会存在.

原始项目 :

[https://github.com/ 惠克索克特斯/贝利斯](https://github.com/WhiskeySockets/Baileys)

此叉子中新增功能的部分部分从其他贝利叉口被移植:

-   `wbails` (贝利2号) `@qwerty-xcv/baileys`: 特殊消息类型
-   `@poucode/baileys`数字 : `biz` 编号 : `native_flow` 交互式信息和产品信息的节点
-   `@vansnowi/baileys`数字 : `richMenu`, (中文(简体) ), `sendHtml`, (中文(简体) ), `useSqliteAuthState`
-   `pou-code` / Bairis-main: 丰富的信件作曲家,用户名 (`w:mex`API,缓存管理商店

## 免责声明

这个项目是一个独立的分叉,不隶属于WhatsApp,得到其认可或正式支持.

WhatsApp是Meta平台股份有限公司的商标.

负责地使用这个图书馆,遵守适用的法律,条例以及WhatsApp的术语和政策.

这种分叉的维护者不负责账户限制,禁令,数据丢失,或使用这种软件所产生的其他后果.

## 文档

关于详细的API信息、示例和导出类型,参见:

-   此寄存器
-   源代码
-   类型脚本定义
-   上游贝利文件(适用时)

上游文档:

[https://baileys.wiki (英语)](https://baileys.wiki/)

## 许可证

这个项目保留了上游贝利斯项目的许可条件.

见寄存器的 `LICENSE` 用于完整许可证文本的文件.

原项目的著作权公告和归属公告,必须按规定予以保存.

* * *

**@hanzofc/baileys (英语)**

贝利斯的定制叉子.

GitHub : (中文(简体) ) [https://github.com/harissfx/Baileys3 页面存档备份,存于互联网档案馆](https://github.com/harissfx/Baileys3)

npm: https://www.npmjs.com/package/@hanzofc/baileys 页面存档备份,存于互联网档案馆

## 常见问题

### @hanzofc/baileys 是什么？

一个定制的WhiskeySockets/Baileys分叉,为WhisApp自动化提供了额外的修正和修改\.

### 如何安装 @hanzofc/baileys？

在项目目录运行 npm install @hanzofc/baileys，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：sharp（\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @hanzofc/baileys 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @hanzofc/baileys 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @hanzofc/baileys 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @hanzofc/baileys 可以商用吗？

@hanzofc/baileys 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @hanzofc/baileys 的下载量有多少？

根据 npm 官方下载统计，@hanzofc/baileys 在 2026/10/17 – 2026/11/15 这 30 天内被下载 4,556 次，日均约 152 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @hanzofc/baileys 还在维护吗？

最新版本 7\.2\.2 发布于 2026/10/24（24 天前）；至今共发布 7 个版本，其中过去 12 个月发布了 7 个；首次发布于 2026/09/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

