可编程 Fax API

借助对开发者友好的 REST API,构建安全的 fax 工作流

通过 Fax.Plus API,将安全的 fax 功能直接集成到您的软件中。发送和接收 fax、跟踪送达情况、管理号码,并借助 Webhook 实现工作流自动化。

API fax
深受构建关键文档工作流的团队信赖
联合国3MIBM空中客车eset
Politico 标志飞利浦Roche 标志哈佛

专为开发者打造的 fax API

借助 REST API、SDK、清晰的文档以及可用于生产环境的开发者工具,将 fax 功能直接构建到您的应用程序中。几分钟内即可通过 API 发送第一份 fax,随后借助团队所需的可视性和支持,自信地扩展至大批量的工作流。

  • 通过 REST API 或受支持的 SDK,以编程方式发送和接收 fax。

  • 借助实时状态更新、确认数据和详细的错误代码,跟踪 fax 状态与送达情况。

  • 随着您的应用程序或组织规模扩大,直接通过 API 购买和管理 fax 号码。

  • 借助 Webhook 构建事件驱动的工作流,并通过日志、重放、签名事件和可配置的端点监控事件送达情况。

  • 使用 OAuth 2.0 或个人访问令牌(PAT),安全地控制 API 访问。

1const axios = require('axios');
2const OutboxApiFp = require('@alohi/faxplus-api').OutboxApiFp;
3const Configuration = require('@alohi/faxplus-api').Configuration;
4
5const config = new Configuration({
6    accessToken: accessToken,
7    basePath: 'https://restapi.fax.plus/v3',
8    // Header required only when using the OAuth2 token scheme
9    baseOptions: {
10        headers: {
11          "x-fax-clientid": clientId,
12        }
13    }
14});
15
16async function sendFax() {
17    const reqParams = {
18        "userId": '13d8z73c',
19        "payloadOutbox": {
20            "comment": {
21                "tags": [
22                    "tag1",
23                    "tag2"
24                ],
25                "text": "text comment"
26            },
27            "files": [
28                "filetosend.pdf"
29            ],
30            "from": "+12345667",
31            "options": {
32                "enhancement": true,
33                "retry": {
34                    "count": 2,
35                    "delay": 15
36                }
37            },
38            "send_time": "2000-01-01 01:02:03 +0000",
39            "to": [
40                "+12345688",
41                "+12345699"
42            ],
43            "return_ids": true
44        }
45    }
46    const req = await OutboxApiFp(config).sendFax(reqParams);
47    const resp = await req(axios);
48}
49
50sendFax()
from faxplus import ApiClient, OutboxApi, OutboxComment, RetryOptions, OutboxOptions, OutboxCoverPage, PayloadOutbox
from faxplus.configuration import Configuration

outbox_comment = OutboxComment(tags=['tag1', 'tag2'],
    text='text comment')

retry_options = RetryOptions(count=2, delay=15)

outbox_options = OutboxOptions(enhancement=True, retry=retry_options)

outbox_cover_page = OutboxCoverPage()

payload_outbox = PayloadOutbox(from='+12345667',
    to=['+12345688', '+12345699'],
    files=['filetosend.pdf'],
    comment=outbox_comment,
    options=outbox_options,
    send_time='2000-01-01 01:02:03 +0000',
    return_ids=True,
    cover_page=outbox_cover_page)

conf = Configuration()
conf.access_token = access_token
# header_name and header_value required only when using the OAuth2 token scheme
api_client = ApiClient(header_name='x-fax-clientid', header_value=client_id, configuration=conf)
api = OutboxApi(api_client)
resp = api.send_fax(
    user_id='13d8z73c',
    body=payload_outbox
)
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    // The x-fax-clientid header is required only when using the OAuth2 token scheme
    'x-fax-clientid' => '{client ID}',
);

$client = new GuzzleHttp\Client();

// Define array of request body.
$request_body = ...;  // See request body example

try {
    $response = $client->request('POST','https://restapi.fax.plus/v3/accounts/{user_id}/outbox', array(
        'headers' => $headers,
        'json' => $request_body,
        )
    );
    print_r($response->getBody()->getContents());
 }
 catch (GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        // The x-fax-clientid header is required only when using the OAuth2 token scheme
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        "x-fax-clientid": []string{"YOUR CLIENT_ID"}
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://restapi.fax.plus/v3/accounts/{user_id}/outbox", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
复制代码

将 fax 功能构建到应用程序中所需的一切

在您自己的应用程序中发送和接收 fax、管理号码、跟踪送达情况、配置 Webhook、获取确认报告,并实现 fax 工作流自动化。同一套 API 可用于医疗平台、CRM、ERP、内部工具以及嵌入式 fax 体验。

fax API 工作流集成图标

可集成到任何工作流

使用标准 REST API 和对开发者友好的 SDK,将 fax 集成到 EHR 和 EMR 系统、CRM、ERP、患者门户、移动应用、内部工具或 cloud 平台中。

可靠的 fax 基础设施图标

可靠的 fax 基础设施

在专为生产环境设计的基础设施上运行 fax 工作流,具备全球路由、自动错误处理和高弹性的多 cloud 架构,可支持大批量的 fax 运营。

fax API 企业级安全图标

企业级安全保障

通过加密、访问控制、可配置的身份验证以及灵活的数据驻留选项保护敏感数据。Fax.Plus 为在严格安全和合规要求下运营的组织提供支持。

可扩展的 fax API 集成图标

无需重构集成即可扩展

无需更改底层集成,即可提升 fax 量、用户数和号码数。Fax.Plus 可支持不断增长的工作负载,同时让定价和用量更易于规划和管理。

fax 号码管理图标

以编程方式管理 fax 号码

通过 API 购买、分配和管理 fax 号码。通过一个集中式集成,支持多个团队、办公室、应用程序和地区。

fax API 开发者支持图标

开发者资源与支持

借助详尽的 API 文档、SDK、代码示例和实施指南进行构建。对于更复杂的工作流,Fax.Plus 团队可提供集成、故障排查、迁移和扩展方面的支持。

按您的生产需求进行构建
需要大批量的 fax 发送、定制基础设施、沙盒访问,或为复杂集成获取支持?请与我们的团队沟通您的工作流和部署需求。

Webhook

专为生产环境打造的企业级 Webhook

接收事件只是运行可靠集成的一部分。Fax.Plus 让您的团队能够查看 Webhook 的投递情况,提供排查故障的工具,还支持重放遗漏的事件,无需重建您的工作流。

查看 Webhook 文档 →

投递日志

查看每个 Webhook 事件、投递尝试和状态。

自助重放

重放失败的事件,或恢复所选时间段内的活动。

签名 Webhook

在处理事件之前,验证事件确实来自 Fax.Plus。

事件目录和架构

依据清晰的事件定义和负载架构来构建和调试集成。

失败提醒

在遗漏的事件引发更大的下游问题之前,及时发现 Webhook 投递问题。

按号码过滤

配置每个 Webhook 端点应接收哪些 fax 号码和事件。

三步恢复遗漏的 Webhook 事件

当下游端点遗漏某个事件时,Fax.Plus 为您的团队提供了一种简单的方式,来查看发生了什么并恢复工作流。

1

查看失败情况

投递失败的 Webhook 会显示在投递日志中,因此您的团队可以快速发现某个事件未能送达目的地。

2

检查投递详情

查看受影响的事件、投递尝试、时间戳和状态,在采取行动之前先了解发生了什么。

3

重放并恢复

待您的端点准备就绪后,重放遗漏的事件,使下游工作流恢复同步。

在运行由 Webhook 驱动的 fax 工作流时,充分考虑安全与合规要求。Fax.Plus 保护传输中和静态存储的数据,支持访问控制和可审计性,并为受监管的组织提供企业级安全选项。

GDPR 标志CCPA 标志ISO 27001 标志AICPA SOC-2 标志HIPAA 标志PHIPA 标志

受到各行各业组织的信赖

医疗健康

将安全的 fax 嵌入 EHR 和 EMR 系统、患者门户、临床工作流及医疗应用程序中。

使用 Fax.Plus API 的医疗保健企业

IT

通过 API 和 Webhook,将 fax 连接到内部系统、cloud 平台、自动化工作流和企业应用程序。

使用 Fax.Plus API 的 IT 企业

法律

将安全的文档传输集成到案件管理系统和法律工作流中。

使用 Fax.Plus API 的法律行业企业

金融服务

在安全性、可审计性和运营管控至关重要的受监管金融工作流中构建 fax 功能。

使用 Fax.Plus API 的金融服务企业

教育

我们为合作伙伴提供多功能的安全平台,在确保合规性和易用性的同时,便于远程管理。
使用 Fax.Plus API 的教育机构

房地产

我们的解决方案为房地产行业的客户确保房产交易顺畅无阻,并实现高效的文档管理。
使用 Fax.Plus API 的房地产企业

获取本地 fax 号码,或转入您自己的号码

从众多国家中获取本地 fax 号码,在线收发 fax。
想把现有的 fax 号码转到 Fax.Plus?我们让这一切变得很简单,只需填写号码转入申请表即可开始。零停机,即使在迁移期间,fax 也能持续收发。
‍

就您的集成需求咨询我们的 API 团队

我们的团队可以协助您确定沙盒访问、大批量定价以及集成所需的定制 API 需求。

箭头

申请访问沙盒环境

箭头

获取定制大批量套餐的价格详情。

箭头

预约 Fax.Plus 演示。

箭头

了解适合您团队的使用场景。

箭头

协助您完成迁移流程。

大批量,大优惠
fax 发送越多,节省越多!享受极具竞争力的价格和专属的批量折扣。无隐藏费用,只有实实在在的优惠。

继续即表示您同意 Alohi 条款。

谢谢!我们已收到您的提交!
哎呀!提交表单时出了点问题。

常见问题

什么是 Fax.Plus API?我可以用它构建什么?

导航栏箭头

借助 Fax.Plus API,您可以通过编程方式发送和接收 fax、跟踪送达情况、管理 fax 号码,并通过 Webhook 实现工作流自动化。它可以将 fax 与 CRM、EHR/EMR 系统、ERP、内部工具和嵌入式应用连接起来。

哪个套餐包含 Fax.Plus API?它能否支持大批量的工作流?

导航栏箭头

Fax.Plus API 包含在 Enterprise 套餐中,专为生产环境设计,可支持大批量 fax 工作流。如果您需要更大的发送量、沙盒访问权限或定制基础设施,请联系销售团队。

在哪里可以找到 Fax.Plus API 文档?

导航栏箭头

请查阅公开的 API 文档了解端点和实现细节,并通过 Fax.Plus 帮助中心获取设置指南和操作教程。

什么是 Fax.Plus Webhook?当投递失败时它们有何帮助?

导航栏箭头

Webhook 会将 fax 事件通知发送到您的应用。投递日志会显示事件是否已到达您的端点;待端点准备就绪后,可以重放遗漏或失败的事件。

Fax.Plus Webhook 如何保障安全并进行配置?

导航栏箭头

签名的 Webhook 事件可让您的应用在处理负载之前验证其真实性。您还可以通过可配置的端点和按号码过滤来控制路由。

Fax.Plus API 是否支持符合 HIPAA 要求的医疗工作流?

导航栏箭头

支持。在 Enterprise 套餐中,启用 Advanced Security Controls 并签署 BAA 后,Fax.Plus 可以支持符合 HIPAA 要求的 API 工作流。

探索更多 fax 方式

无论您的 fax 需要接入哪种系统,从 ERP 和 EHR 平台到销售团队每天使用的 CRM,下方都有直接的接入方式。您也可以借助企业级合规能力扩展规模。

发送您的第一份 fax。

创建免费开发者账户,通过 REST 或 Webhook 连接,几分钟内即可发送您的第一份 fax。