# @figuro/chatwoot-sdk 中文文档

规范地址：https://npmcn.com/package/%40figuro/chatwoot-sdk/

版本：1\.1\.17
npm 元数据更新时间：2025-04-02T11:45:03.897Z
中文译文更新时间：2026-11-14T17:31:54.937Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40figuro/chatwoot-sdk
原文对照：https://npmcn.com/package/%40figuro/chatwoot-sdk/?lang=original
项目主页：https://github.com/figurolatam/chatwoot-sdk#readme
源码仓库：https://github.com/figurolatam/chatwoot-sdk

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

- 包体积（解压后）：279 kB，263 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2022-09-09T20:54:17.893Z
- 最新版本发布：2025-04-02T11:45:03.678Z
- 近 30 天下载量：16401（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 0 个）

## 中文简介

SDK代表JS/Typescript代表查特伍特.

## 安装

```sh
npm install @figuro/chatwoot-sdk
```

也可以使用：`pnpm add @figuro/chatwoot-sdk`、`yarn add @figuro/chatwoot-sdk`、`bun add @figuro/chatwoot-sdk`

## README

# Chatwoot API SDK 软件

[![npm (scoped)](https://img.shields.io/npm/v/@figuro/chatwoot-sdk)](https://www.npmjs.com/package/@figuro/chatwoot-sdk) ![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/figurolatam/chatwoot-sdk/npm-publish.yml?logo=github-actions) [![NPM](https://img.shields.io/npm/l/@figuro/chatwoot-sdk)](https://opensource.org/licenses/MIT)

Chatwoot SDK是一个JavaScript客户端,允许开发者连接到Chatwoot API. 在TypeScript的完全支持下,SDK为开发者提供了一个易于使用的界面,在程序上与Chatwoot平台互动.

SDK的构建在思想上简单化,只依靠Axios来获取高级数据的支持和相容性. 这意味着开发者可以享受一个轻而易举,高效的SDK,而无需额外的外相依赖性负担.

欲了解更多关于Chatwoot API的信息,请参见: [Chatwoot 的文档](https://www.chatwoot.com/developers/api/)。在那里,你会找到所有你需要开始的东西,包括详细的API参考文档,样本代码和教程.

## 安装

使用 **无**数字 :

```shell
npm i @figuro/chatwoot-sdk --save
```

使用 **线条**数字 :

```shell
yarn add @figuro/chatwoot-sdk
```

## 示例

```typescript
import ChatwootClient from "@figuro/chatwoot-sdk";

const client = new ChatwootClient({
    config: {
        basePath: "https://app.chatwoot.com",
        with_credentials: true,
        credentials: "include",
        token: "<YOUR_API_TOKEN_HERE>"
    }
});

client.messages.create({
    accountId: 1,
    conversationId: 8,
    data: {
        content: "Hello, World!"
    }
})
    .then(response => {
        console.log(response.sender?.name);
    })
    .catch(err => {
        console.error(err);
    });
```

虽然在Chatwoot上没有记录,但文件消息通过 `multipart/form-data`,为启用此选项,执行附件参数。 (请注意,内容缩短是为了简单起见,因而无效).

```typescript
client.messages.create({
    accountId: 1,
    conversationId: 8,
    data: {
        content: "Hello, World!",
        attachments: [
            {
                content: "iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAABmJLR0QA/...gUaFFSdABUVmZpaSnFk7kXiPwNOgbDxE5JKbEAAAAASUVORK5CYII=",
                encoding: "base64",
                filename: "test.png"
            }
        ]
    }
})
    .then(response => {
        console.log(response.sender?.name);
    })
    .catch(err => {
        console.error(err);
    });
```

## 文档

Chatwoot API 的全部文档可以找到 [Chatwoot 的文档](https://www.chatwoot.com/developers/api/)。 。 。 .

## 捐款

如果您愿意贡献, 请打开一个问题或拉 请求在这个寄存器。 我们很想听到你的消息!

## 许可证

这个SDK是依照 [MIT 许可证](https://opensource.org/licenses/MIT)。 。 。 .

## 支助

如果你有任何问题或需要帮助,请联系我们,在这个寄存处打开一个问题.

## 常见问题

### @figuro/chatwoot-sdk 是什么？

SDK代表JS/Typescript代表查特伍特\.

### 如何安装 @figuro/chatwoot-sdk？

在项目目录运行 npm install @figuro/chatwoot-sdk，或使用 pnpm add / yarn add / bun add。

### @figuro/chatwoot-sdk 支持 TypeScript 吗？

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

### @figuro/chatwoot-sdk 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @figuro/chatwoot-sdk 可以商用吗？

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

### @figuro/chatwoot-sdk 的下载量有多少？

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

### @figuro/chatwoot-sdk 还在维护吗？

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