# @sadikkhan02/adapter-twilio 中文文档

规范地址：https://npmcn.com/package/%40sadikkhan02/adapter-twilio/

版本：1\.0\.0
npm 元数据更新时间：2026-11-02T08:19:57.365Z
中文译文更新时间：2026-11-02T10:22:59.457Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40sadikkhan02/adapter-twilio
原文对照：https://npmcn.com/package/%40sadikkhan02/adapter-twilio/?lang=original

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

- 包体积（解压后）：58 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：0 个
- peer 依赖：twilio \>=4\.0\.0，@sadikkhan02/notifykit ^1\.0\.0
- 首次发布：2026-11-02T08:19:00.796Z
- 最新版本发布：2026-11-02T08:19:57.192Z
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

Twilio短信提供商适配器为NotifyKit

## 安装

```sh
npm install @sadikkhan02/adapter-twilio
```

也可以使用：`pnpm add @sadikkhan02/adapter-twilio`、`yarn add @sadikkhan02/adapter-twilio`、`bun add @sadikkhan02/adapter-twilio`

## README

# `@sadikkhan02/adapter-twilio`

> 使用Twilio消息传递API的NotifyKit的全局SMS适配器。

这个包通过Twilio为NotifyKit提供企业短信传输。它实现了 `SmsProvider` 接口，支持字母数字发送者和消息服务sid，标准化E.164电话号码，并遵循 `@sadikkhan02/test-utils` 合同的测试。

* * *

## 安装

```bash
npm install @sadikkhan02/notifykit @sadikkhan02/adapter-twilio twilio
```

> **注意：** `twilio` 被声明为外部对等依赖，以允许消费者控制SDK版本绑定和连接重用。

* * *

## 配置

### 环境变量

| 变量 | 要求 | 描述 |
| :-- | :-- | :-- |
| `TWILIO_ACCOUNT_SID` | **是** | Twilio帐户SID (`AC...`） |
| `TWILIO_AUTH_TOKEN` | **是** | Twilio授权令牌 |
| `TWILIO_FROM` | 可选的\* | E.164格式的默认发送人电话号码。 `+15555550100`） |
| `TWILIO_MESSAGING_SERVICE_SID` | 可选的\* | Twilio消息服务SID (`MG...`)进行自动发送人池 |

_\*要么 `TWILIO_FROM` 或者 `TWILIO_MESSAGING_SERVICE_SID` 必须配置（或在选项中提供）。_

* * *

## 使用

```typescript
import { createNotifier } from '@sadikkhan02/notifykit';
import { TwilioSmsProvider } from '@sadikkhan02/adapter-twilio';

const smsProvider = new TwilioSmsProvider({
  accountSid: process.env.TWILIO_ACCOUNT_SID!,
  authToken: process.env.TWILIO_AUTH_TOKEN!,
  from: process.env.TWILIO_FROM, // e.g. +15555550100
  // messagingServiceSid: process.env.TWILIO_MESSAGING_SERVICE_SID,
});

const notifier = createNotifier({
  providers: {
    sms: {
      type: 'twilio',
      adapter: smsProvider,
      from: process.env.TWILIO_FROM,
    },
  },
});

// Register SMS template
notifier.registerTemplate(
  'otp-verification',
  'Your verification code is {{otp}}. Valid for 5 minutes. Do not share this code.',
);

// Enqueue SMS (returns immediately with jobId)
const { jobId } = await notifier.notify({
  to: { phone: '+15555550199' }, // E.164 required
  channels: ['sms'],
  template: 'otp-verification',
  data: { otp: '482910' },
});

// Start processing SMS queue
notifier.startWorker({ channels: ['sms'], concurrency: 5 });
```

* * *

## 错误分类和恢复

Twilio适配器将结构化的Twilio错误代码直接映射为标准化的 `ProviderResult` 对象:

| Twilio错误码 | 原因 | `retryable` | BullMQ行动 |
| :-- | :-- | :-- | :-- |
| `20429` | 超过速率限制/并发限制 | `true` | 以指数回退重试 |
| `30001` | 队列溢出 | `true` | 以指数回退重试 |
| `30008` | 未知载波故障/暂态网络 | `true` | 以指数回退重试 |
| `30010` | 无法联系到运营商/暂时不可用 | `true` | 以指数回退重试 |
| `20003` | 身份验证失败（无效的帐户SID /令牌） | `false` | 直接路由到DLQ（不重试） |
| `21211` | 无效的电话号码格式 | `false` | 直接路由到DLQ（不重试） |
| `21614` | 目标号码为座机/无法接收短信 | `false` | 直接路由到DLQ（不重试） |
| `21408` | 拒绝权限/未启用区域 | `false` | 直接路由到DLQ（不重试） |

### 监管通知和承运人成本

> \[!警告) 通过Twilio发送短信会产生每段运营商费用和转接费。 在美国，通过10位长代码（10DLC）发送的流量需要获得A2P批准的10DLC品牌和活动注册。未注册的流量受到严格的运营商过滤、节流或非交付费用的限制。

* * *

## 许可证

麻省理工学院

## 常见问题

### @sadikkhan02/adapter-twilio 是什么？

Twilio短信提供商适配器为NotifyKit

### 如何安装 @sadikkhan02/adapter-twilio？

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

### @sadikkhan02/adapter-twilio 支持 TypeScript 吗？

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

### @sadikkhan02/adapter-twilio 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @sadikkhan02/adapter-twilio 需要什么版本的 Node\.js？

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

### @sadikkhan02/adapter-twilio 可以商用吗？

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

### @sadikkhan02/adapter-twilio 还在维护吗？

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