OA 办公系统
公文、审批单据在流程结束后自动传真给对方单位。
开放 API 集成
传真服务器提供标准 HTTP 接口，业务系统在流程结束后可直接发起传真并回查结果，无需人工再走一遍传真机。
Integration
可对接的企业系统
只要业务系统能发起 HTTP 请求，就可以调用传真服务器的接口。
ERP 系统
采购订单、发货通知审核通过后自动发送给供应商或客户。
MES 制造系统
生产工单、质量异常单据自动传真至相关协作方。
CRM 客户系统
报价单、合同确认函按客户档案中的传真号发送。
WMS 仓储系统
出入库单据、发货清单自动传真给承运方。
自研业务系统
任何能发起 HTTP 请求的系统都可以接入。
Flow
集成调用流程
- 1后台创建接口密钥
在传真服务器管理后台生成 API Key，并授予发送权限。
- 2业务系统调用接口
流程结束后携带密钥提交传真任务，附带文件与收件方号码。
- 3服务器排队发送
任务进入队列，由空闲传真端口拨号发送，失败按设定次数重试。
- 4回查发送结果
业务系统按任务编号查询状态，把发送结果写回自己的单据。
Endpoints
接口一览
以下为集成接口的主要能力说明，完整的接口文档在实施阶段随产品提供。
POST
/api/integration/v1/faxes提交传真任务以 multipart/form-data 提交，files 为传真附件，recipients 为收件方 JSON 数组。提交成功后返回任务编号，任务进入发送队列。
GET
/api/integration/v1/faxes查询传真任务列表支持 page、pageSize、folder 参数分页查询任务及其状态。
GET
/api/integration/v1/faxes/{id}查询任务详情按任务编号查询单个传真任务的详细状态与发送结果。
提交传真的主要参数
| 参数 | 类型 | 说明 |
|---|---|---|
subject | 字符串 | 传真主题，可选 |
recipients | JSON 数组 | 收件方列表，元素含 faxNumber（传真号码）、extension（对方分机号，可选）、contactName、company 等 |
files | 文件 | 传真附件，可上传多个，支持 PDF、Word、Excel、图片等格式 |
priority | 整数 | 任务优先级，可选 |
scheduledAt | 时间 | 定时发送时间，可选，不填则立即排队 |
maxRetries | 整数 | 失败重试次数，默认 3 |
resolution | 整数 | 传真分辨率，默认 200 |
pageSize | 字符串 | 纸张规格，默认 A4 |
请求示例
# 提交一份传真给对方 8001 分机
curl -X POST https://fax.company.local/api/integration/v1/faxes \
-H "X-Api-Key: <接口密钥>" \
-H "Idempotency-Key: PO-20260105-001" \
-F "subject=采购订单确认函" \
-F 'recipients=[{"faxNumber":"075582991104","extension":"8001"}]' \
-F "files=@PO-20260105.pdf"
# 响应
{ "id": 10286, "status": "queued" }Notes
集成设计要点
API Key 鉴权
通过请求头 X-Api-Key 携带接口密钥，密钥在后台创建与管理，可随时停用。
幂等提交
请求头带 Idempotency-Key 时，重复提交同一标识不会产生重复传真，避免网络重试导致重发。
调用日志
接口调用记录方法、路径、状态码、耗时与来源 IP，便于排查对接问题。
状态可回查
业务系统可按任务编号轮询发送结果，把状态写回自己的单据。
需要与贵公司的业务系统对接？
告诉我们要对接的系统类型与业务流程，我们可以提供接口文档与联调支持。