# @alipeople/sendon-sdk-typescript 中文文档

规范地址：https://npmcn.com/package/%40alipeople/sendon-sdk-typescript/

版本：1\.0\.6
npm 元数据更新时间：2026-08-27T06:03:49.042Z
中文译文更新时间：2026-11-06T02:26:27.647Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40alipeople/sendon-sdk-typescript
原文对照：https://npmcn.com/package/%40alipeople/sendon-sdk-typescript/?lang=original

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

- 包体积（解压后）：1.7 MB，59 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2025-02-14T07:30:06.584Z
- 最新版本发布：2026-08-27T06:03:48.859Z
- 近 30 天下载量：6429（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：22（近 12 个月 2 个）

## 中文简介

@alipeople/sendon-sdk-typescript的 OpenAPI 客户端

## 安装

```sh
npm install @alipeople/sendon-sdk-typescript
```

也可以使用：`pnpm add @alipeople/sendon-sdk-typescript`、`yarn add @alipeople/sendon-sdk-typescript`、`bun add @alipeople/sendon-sdk-typescript`

## README

# 类型脚本的 sendon SDK

[![npm version](https://img.shields.io/npm/v/@alipeople/sendon-sdk-typescript)](https://www.npmjs.com/package/@alipeople/sendon-sdk-typescript) [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://npmcn.com/package/%40alipeople/sendon-sdk-typescript/LICENSE) [![TypeScript](https://img.shields.io/badge/TypeScript-5.1+-blue)](https://www.typescriptlang.org/) [![Axios](https://img.shields.io/badge/Axios-1.6+-green)](https://axios-http.com/)

**企业级信息SDK,与多个信息渠道无缝集成**

[安装](https://npmcn.com/package/%40alipeople/sendon-sdk-typescript/#readme-installation) 二. 支助 [快速启动](https://npmcn.com/package/%40alipeople/sendon-sdk-typescript/#readme-quick-start) 二. 支助 [特征](https://npmcn.com/package/%40alipeople/sendon-sdk-typescript/#readme-features) 二. 支助 [API 参考](https://npmcn.com/package/%40alipeople/sendon-sdk-typescript/#readme-api-reference) 二. 支助 [支助](https://npmcn.com/package/%40alipeople/sendon-sdk-typescript/#readme-support)

* * *

## \* 安装

```bash
npm install @alipeople/sendon-sdk-typescript
```

或与雅恩:

```bash
yarn add @alipeople/sendon-sdk-typescript
```

## QQ 快速启动

```typescript
import { Sendon } from '@alipeople/sendon-sdk-typescript';

// Initialize the SDK
const sendon = new Sendon({
  id: 'your-api-id',
  apikey: 'your-api-key',
  debug: false // Optional: Enable debug mode for detailed logging
});

// Send an SMS message
const result = await sendon.sms.send({
  from: '01012345678',
  to: ['01087654321'],
  message: 'Hello, World!'
});
```

## \* 特性

### 📱 **短信服务**

完成有企业等级可靠性的短消息/LMS/MMS通讯能力.

-   **短信/LMS通讯**: 发送短而长的短信
-   **MMS 支助**: 有图像的丰富的媒体信息
-   **批量发送**: 高效地向多个收件人发送消息
-   **计划交付**: 为最佳时间安排信件
-   **交付报告**: 实时状态跟踪和报告
-   **图像管理**: 上传并管理 MMS 图像

### 💬 **卡考服务**

AlimTalk 和 BrandMessage 的综合Kakao Business Message 集成.

-   **阿利姆演讲**: 基于模板的信息消息
-   **白话**: 有各种模板的丰富的促销信息
    -   文本、 图像、 宽度、 宽度项目列表和卡卢塞尔种子格式
-   **模板管理**: 创建、更新和管理信件模板
-   **发送配置管理**: 处理多发件人配置文件
-   **审查系统**: 模板审查请求和状态跟踪
-   **批量通讯**: 高效发送给多个收件人

### 🎯 **区域支助事务处**

下一代富通通信服务增强移动信息.

-   **丰富的媒体支持**: 交互式卡片、旋转木马和按钮
-   **标记信件**:自定义品牌和样式
-   **CSV 上传**: 通过 CSV 进行批量接收管理
-   **高级分析**: 详细消息性能跟踪
-   **后退选项**: 自动回落到短消息/ MMS

### 🚫 **联系人处**

邮件控制屏蔽列表管理.

-   **块状管理**: 从块列表中添加并删除数字
-   **多渠道支持**: 横跨短消息频道和Kakao频道的区块编号
-   **块类型过滤**: 不同的屏蔽类别
-   **日期范围查询**: 按日期范围搜索块列表
-   **缓冲支持**: 大块列表的有效处理

### 📤 **发件人服务**

发件人号码管理和验证.

-   **编号**: 查看所有已注册的发件人号码
-   **缓冲支持**: 通过多发件人号码浏览
-   **数量**: 经核实的发送者号码管理

### 💳 **支付服务**

支付历史和交易跟踪.

-   **支付历史**: 查看详细的支付交易日志
-   **日期范围过滤**: 按日期范围分列的搜索付款
-   **交易细节**: 获取特定付款信息
-   **缓冲支持**:通过付款记录导航

### 💰 **点服务**

信息成本计算和点追踪.

-   **费用计算**: 获取消息发送成本
-   **点列表**: 查看可用点和余额
-   **用法跟踪**: 监测点消耗

## API 参考

### 初始化

```typescript
const sendon = new Sendon({
  id: string,        // Your API ID
  apikey: string,    // Your API Key
  debug?: boolean    // Enable debug logging (optional)
});
```

### 短信服务

```typescript
// Send SMS/LMS/MMS
await sendon.sms.send({
  from: string,
  to: string[],
  message: string,
  subject?: string,  // For LMS/MMS
  images?: File[]    // For MMS
});

// Cancel scheduled message
await sendon.sms.cancel(groupId);

// Get message status
await sendon.sms.find(groupId);
```

### 卡考服务

```typescript
// Send AlimTalk
await sendon.kakao.sendAlimTalk({
  sendProfileId: string,
  templateCode: string,
  messages: MessageData[]
});

// Send BrandMessage
await sendon.kakao.sendBrandMessage({
  sendProfileId: string,
  templateCode: string,
  messages: MessageData[]
});

// Template Management
await sendon.kakao.createTemplate(sendProfileId, templateData);
await sendon.kakao.getTemplates(sendProfileId, query);
await sendon.kakao.updateTemplate(sendProfileId, templateId, templateData);
```

### 区域支助事务处

```typescript
// Send RCS message
await sendon.rcs.send({
  messageType: 'SMS' | 'LMS' | 'MMS' | 'RCS',
  from: string,
  messages: RcsMessageData[]
});

// Get CSV upload URL
await sendon.rcs.createCsvUploadUrl();
```

### 联系人服务( 列表)

```typescript
// Create blocklist entry
await sendon.contacts.createBlocklist({
  phoneNumbers: ['01012345678'],
  blockType: 'SMS',
  senderNumber: '0212345678'
});

// Get blocklist
await sendon.contacts.getBlocklist({
  blockType: ['SMS', 'KAKAO'],
  limit: 100
});

// Delete from blocklist
await sendon.contacts.deleteBlocklist(blocklistId);
```

### 支付服务

```typescript
// Get payment history
await sendon.payment.getPaymentHistories({
  startDate: new Date('2024-01-01'),
  endDate: new Date('2024-12-31'),
  page: 1,
  limit: 20
});

// Get payment detail
await sendon.payment.getPaymentHistoryDetail(historyId);
```

### 点服务

```typescript
// Get message costs
await sendon.point.getCost();

// List available points
await sendon.point.listPoints();
```

### 发件人服务

```typescript
// List registered sender numbers
await sendon.sender.listUserNumbers(page, limit);
```

## • 警卫

-   **安全认证**: API 密钥认证
-   **数据加密**: 所有通过 HTTPS 传输的数据
-   **限制费率**: 内置速率限制处理
-   **处理错误**: 全面错误管理

## 绩效

-   **最佳击打**: 高效的大宗业务
-   **连接集合**: 可重用 HTTP 连接
-   **Async/等待支持**: 现代同步模式
-   **脚本原生类型**: 完全类型安全和IntelliSense

## 发展

这个SDK是用:

-   **类型脚本 5.1+** 类型安全
-   **阿克索斯语Name** hTTP 客户端
-   **OpenAPI 生成器** aPI 一致性
-   **维特** 测试

## 许可证

这个项目根据麻省理工学院的许可证获得许可.

## ++ 辅助

如需技术支持和查询,请与我们的支助小组联系或访问我们的文件门户.

* * *

**Alipeople 与 .**

## 常见问题

### @alipeople/sendon-sdk-typescript 是什么？

@alipeople/sendon-sdk-typescript的 OpenAPI 客户端

### 如何安装 @alipeople/sendon-sdk-typescript？

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

### @alipeople/sendon-sdk-typescript 支持 TypeScript 吗？

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

### @alipeople/sendon-sdk-typescript 支持 ESM 还是 CommonJS？

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

### @alipeople/sendon-sdk-typescript 可以商用吗？

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

### @alipeople/sendon-sdk-typescript 的下载量有多少？

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

### @alipeople/sendon-sdk-typescript 还在维护吗？

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