# @alohi/faxplus-api 中文文档

规范地址：https://npmcn.com/package/%40alohi/faxplus-api/

版本：3\.0\.5
npm 元数据更新时间：2026-01-28T17:58:36.055Z
中文译文更新时间：2026-11-05T21:42:30.524Z
软件包许可：未声明

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

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

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

- 包体积（解压后）：372 kB，158 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2021-07-02T14:31:27.455Z
- 最新版本发布：2024-10-14T09:55:16.279Z
- 近 30 天下载量：25519（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

传真加的 API 客户端

## 安装

```sh
npm install @alohi/faxplus-api
```

也可以使用：`pnpm add @alohi/faxplus-api`、`yarn add @alohi/faxplus-api`、`bun add @alohi/faxplus-api`

## README

# 传真 加 Java 脚本 SDK

#### 由第三方开发商和组织从自己的软件中发送和接收传真 应用.

[![NPM version](https://img.shields.io/npm/v/@alohi/faxplus-api?style=flat-square)](https://www.npmjs.com/package/@alohi/faxplus-api) ![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat-square)

[API 文件 3.0.5](https://apidoc.fax.plus/) 二. 支助 [内容](https://www.fax.plus/) 二. 支助 [帮助中心](https://www.fax.plus/help/) 二. 支助 [联系我们](https://www.fax.plus/contact-us/)

-   还包括类型脚本定义
-   仅可供 [企业](https://www.fax.plus/pricing/) 客户

## 安装

```
// with npm
npm install @alohi/faxplus-api

// with yarn
yarn add @alohi/faxplus-api
```

## 开始

示例用法:

```js
const axios = require('axios');
const Configuration = require('@alohi/faxplus-api').Configuration;
const FaxesApiFp = require('@alohi/faxplus-api').FaxesApiFp;
const FilesApiFp = require('@alohi/faxplus-api').FilesApiFp;

const accessToken = "YOUR_ACCESS_TOKEN"
const configuration = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
});

// Get the first entry in the corporate member's inbox
const request = await FaxesApiFp(configuration).listFaxes({userId: "self"});

const response = await request(axios);

const cdrId = response.data.data.records[0].id;

// Upload file
const request = await FilesApiFp(configuration).uploadFile("self",
  fs.createReadStream("./test/sample.pdf")
);

const response = await request(axios);

// Send fax

```

## 文档

访问 API 的完整引用 [传真](https://apidoc.fax.plus/)。 。 。 .

## 作者

2023 Alohi(瑞士日内瓦) - [Alohi.com (英语)](https://alohi.com/)

## 常见问题

### @alohi/faxplus-api 是什么？

传真加的 API 客户端

### 如何安装 @alohi/faxplus-api？

在项目目录运行 npm install @alohi/faxplus-api，或使用 pnpm add / yarn add / bun add。

### @alohi/faxplus-api 支持 TypeScript 吗？

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

### @alohi/faxplus-api 支持 ESM 还是 CommonJS？

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

### @alohi/faxplus-api 可以商用吗？

@alohi/faxplus-api 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @alohi/faxplus-api 的下载量有多少？

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

### @alohi/faxplus-api 还在维护吗？

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