# @agentphone/chat-sdk-adapter 中文文档

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

版本：0\.1\.0
npm 元数据更新时间：2026-05-28T16:35:41.637Z
中文译文更新时间：2026-11-05T18:39:34.654Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40agentphone/chat-sdk-adapter
原文对照：https://npmcn.com/package/%40agentphone/chat-sdk-adapter/?lang=original
项目主页：https://agentphone.to/
源码仓库：https://github.com/AgentPhone-AI/chat-sdk-adapter

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

- 包体积（解压后）：53.7 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：1 个
- peer 依赖：chat ^4\.20\.0
- 首次发布：2026-05-28T16:35:40.834Z
- 最新版本发布：2026-05-28T16:35:41.310Z
- 近 30 天下载量：58837（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 1 个）

## 中文简介

Chat SDK的AgentPhone适配器——短消息,MMS,iMessage和语音

## 安装

```sh
npm install @agentphone/chat-sdk-adapter
```

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

## README

# @ agentphone/chat-sdk-适应器

[代理电话](https://agentphone.to/) 用于 [聊天SDK](https://chat-sdk.dev/) ——第一个配有SMS,MMS,iMessage,和语音调用支持的适配器.

## 特征

| 特性 | 简讯 | 管理事务 | iMessage 图像 | 语音 |
| --- | --- | --- | --- | --- |
| 发送信件 | 对 | 对 | 对 | —— 说 |
| 接收信件 | 对 | 对 | 对 | —— 说 |
| 媒体附件 | —— 说 | 对 | 对 | —— 说 |
| 反应 | —— 说 | —— 说 | 对 | —— 说 |
| 电话记录 | —— 说 | —— 说 | —— 说 | 对 |
| 调用摘要 | —— 说 | —— 说 | —— 说 | 对 |

## 安装

```bash
npm install @agentphone/chat-sdk-adapter chat
```

## 快开始

```typescript
import { Chat } from "chat";
import { createAgentPhoneAdapter } from "@agentphone/chat-sdk-adapter";

const chat = new Chat({
  adapter: createAgentPhoneAdapter({
    apiKey: process.env.AGENTPHONE_API_KEY,
    agentId: process.env.AGENTPHONE_AGENT_ID,
    webhookSecret: process.env.AGENTPHONE_WEBHOOK_SECRET,
  }),

  onNewMention: async ({ message, reply }) => {
    // Handles SMS, MMS, iMessage, and voice call transcripts
    await reply(`Got your message: ${message.text}`);
  },
});

// In your HTTP server (Express, Hono, Next.js, etc.)
app.post("/webhook/agentphone", (req) => chat.webhooks.agentphone(req));
```

## 配置

| 选项 | 新闻 var | 需求 | 说明 |
| --- | --- | --- | --- |
| `apiKey` | `AGENTPHONE_API_KEY` | 对 | 您的代理 Phone API 密钥 |
| `agentId` | `AGENTPHONE_AGENT_ID` | 对 | 发送信件的代理ID |
| `webhookSecret` | `AGENTPHONE_WEBHOOK_SECRET` | 没有 | HMAC-SHA256 网签秘密 |
| `apiUrl` | —— 说 | 没有 | API 基础 URL( 默认 ): `https://api.agentphone.ai`(中文(简体) ) |
| `userName` | `BOT_USERNAME` | 没有 | 瓶子显示名( 默认 ): `"bot"`(中文(简体) ) |

## Webhook活动

适配器处理来自AgentPhone的三种webhook事件类型:

-   **`agent.message`** ——入站短信,MS,或iMessage. 路由到 `onNewMention`。 。 。 .
-   **`agent.call_ended`** ——语音通话完成并配有完整笔录和摘要. 路由到 `onNewMention` 作为包含笔录的信息.
-   **`agent.reaction`** ——iMessage回扣反应(爱,如出一辙等). 路由到 `onReaction`。 。 。 .

## Webhook 校验

所有AgentPhone Webhooks都与HMAC-SHA256签约. 设定 `webhookSecret` 能够进行核查。 适配器检查:

1.  `X-Webhook-Signature` 标题与 HMAC 相匹配 `{timestamp}.{body}`
2.  `X-Webhook-Timestamp` 在5分钟内( 重放保护)

## iMessage 反应

AgentPhone是唯一支持iMessage反应的Chat SDK适配器:

```typescript
// Send a tapback reaction
await adapter.addReaction(threadId, messageId, "love");
// Supported: love, like, dislike, laugh, emphasize, question
// Custom emoji also supported on newer devices: "🔥", "😂", etc.
```

## 链接

-   [代理 Phone 文件](https://docs.agentphone.to/)
-   [聊天 SDK 文件](https://chat-sdk.dev/)
-   [GitHub 图像](https://github.com/AgentPhone-AI/chat-sdk-adapter)

## 常见问题

### @agentphone/chat-sdk-adapter 是什么？

Chat SDK的AgentPhone适配器——短消息,MMS,iMessage和语音

### 如何安装 @agentphone/chat-sdk-adapter？

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

### @agentphone/chat-sdk-adapter 支持 TypeScript 吗？

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

### @agentphone/chat-sdk-adapter 支持 ESM 还是 CommonJS？

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

### @agentphone/chat-sdk-adapter 需要什么版本的 Node\.js？

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

### @agentphone/chat-sdk-adapter 可以商用吗？

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

### @agentphone/chat-sdk-adapter 的下载量有多少？

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

### @agentphone/chat-sdk-adapter 还在维护吗？

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