# @bitbasti/chat-adapter-webex 中文文档

规范地址：https://npmcn.com/package/%40bitbasti/chat-adapter-webex/

版本：0\.1\.0
npm 元数据更新时间：2026-03-02T21:17:26.315Z
中文译文更新时间：2026-11-08T04:00:45.648Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40bitbasti/chat-adapter-webex
原文对照：https://npmcn.com/package/%40bitbasti/chat-adapter-webex/?lang=original
项目主页：https://github.com/SebastianBodza/chat-adapter-webex#readme
源码仓库：https://github.com/SebastianBodza/chat-adapter-webex

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

- 包体积（解压后）：183 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：chat ^4\.15\.0
- 首次发布：2026-03-02T21:17:25.732Z
- 最新版本发布：2026-03-02T21:17:26.137Z
- 近 30 天下载量：32715（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 1 个）

## 中文简介

Chat SDK 的 Webex 适配器

## 安装

```sh
npm install @bitbasti/chat-adapter-webex
```

也可以使用：`pnpm add @bitbasti/chat-adapter-webex`、`yarn add @bitbasti/chat-adapter-webex`、`bun add @bitbasti/chat-adapter-webex`

## README

# @bitbasti/聊天适应器-webex

[![npm version](https://img.shields.io/npm/v/@bitbasti/chat-adapter-webex)](https://www.npmjs.com/package/@bitbasti/chat-adapter-webex) [![npm downloads](https://img.shields.io/npm/dm/@bitbasti/chat-adapter-webex)](https://www.npmjs.com/package/@bitbasti/chat-adapter-webex)

社区 Webex 适配器 [聊天SDK](https://chat-sdk.dev/docs)。 。 。 .

## 安装

```bash
npm install chat @bitbasti/chat-adapter-webex
```

## 使用量

```ts
import { Chat } from "chat";
import { createWebexAdapter } from "@bitbasti/chat-adapter-webex";

const bot = new Chat({
  userName: "mybot",
  adapters: {
    webex: createWebexAdapter({
      botToken: process.env.WEBEX_BOT_TOKEN!,
      webhookSecret: process.env.WEBEX_WEBHOOK_SECRET,
    }),
  },
});

bot.onNewMention(async (thread, message) => {
  await thread.post(`Hello from Webex! You said: ${message.text}`);
});
```

## 环境变量

| 变量 | 需求 | 说明 |
| --- | --- | --- |
| `WEBEX_BOT_TOKEN` | 对 | 来自 Webex 开发者门户网站的瓶式访问令牌 |
| `WEBEX_WEBHOOK_SECRET` | 建议 | 用于 Webhook 签名验证的共享秘密 |
| `WEBEX_BASE_URL` | 没有 | 覆盖 Webex API 基础 URL( 默认 ): `https://webexapis.com/v1`(中文(简体) ) |
| `WEBEX_BOT_USERNAME` | 没有 | 覆盖机器人显示名称 |

## 配置

| 选项 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `botToken` | `string` | `WEBEX_BOT_TOKEN` | Bot 访问令牌 |
| `webhookSecret` | `string` | `WEBEX_WEBHOOK_SECRET` | 用于验证 Webhook 签名的共享秘密 |
| `baseUrl` | `string` | `"https://webexapis.com/v1"` | Webex API 基础 URL |
| `userName` | `string` | `"webex-bot"` | 瓶子显示名( 在初始化时被瓶子的 Webex 配置所覆盖) |
| `botUserId` | `string` | 自动检测通过 `/people/me` | 机器人的Webex人名标识(将 `/people/me` 电话(如果提供) |
| `logger` | `Logger` | `ConsoleLogger` | 自定义日志实例 |

## 平台设置

1.  转到 [Webex 开发者门户](https://developer.webex.com/) 并签入.
2.  导航到 **我的 Webex 应用程序** → **创建新 App** → **创建瓶**。 。 。 .
3.  填写机器人名称、用户名和图标,然后单击 **添加瓶**。 。 。 .
4.  复制 **装瓶访问托肯** - 这是你的 `WEBEX_BOT_TOKEN`。安全存储;只显示一次.
5.  创建指向服务器的 Webhook :
    -   **目标 URL:** `https://your-domain.com/api/webhooks/webex`
    -   **资源 :** `messages` | **事件 :** `created`
    -   **资源 :** `attachmentActions` | **事件 :** `created`
    -   **秘诀 :** 随机字符串——这是您的 `WEBEX_WEBHOOK_SECRET`
6.  在 Webex 空间中添加机器人并提及以验证整合.

> 见 [Webex 网络用户指南](https://developer.webex.com/docs/webhooks) 详情请查看webhook注册.

## 特征

-   提及和模式
-   通过Markdown的丰富文本(粗体、斜体、代码、链接)
-   适应卡(按钮、选择、收音机选择、字段、部分)
-   模块(带有提交/关闭动作的窗体卡)
-   文件上传( 每封信单文件)
-   线程支持( 基于父目录的线程)
-   Webhook 签名验证(HMAC-SHA1)

### 限制

-   反应不支持 Webex bot 令牌—— `addReaction` 编号 : `removeReaction` 掷出 `NotImplementedError`
-   Webex 通讯API 中没有打字指标
-   每个信件只支持一个文件上传
-   无法在同一信件中合并卡片和文件上传

## 许可证

麻省理工学院

## 常见问题

### @bitbasti/chat-adapter-webex 是什么？

Chat SDK 的 Webex 适配器

### 如何安装 @bitbasti/chat-adapter-webex？

在项目目录运行 npm install @bitbasti/chat-adapter-webex，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：chat（^4\.15\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @bitbasti/chat-adapter-webex 支持 TypeScript 吗？

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

### @bitbasti/chat-adapter-webex 支持 ESM 还是 CommonJS？

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

### @bitbasti/chat-adapter-webex 可以商用吗？

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

### @bitbasti/chat-adapter-webex 的下载量有多少？

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

### @bitbasti/chat-adapter-webex 还在维护吗？

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