传真 REST API 快速入门指南

传真仍然是一种普遍的、安全的文档传输方式，每年发送的传真数量达数十亿份。虽然它是医疗保健、政府、制造业和其他行业安全通信的基础，但传统的传真存在局限性，例如维护传真硬件、电话基础设施、缺乏安全性等。

OpenText 提供了一个 REST API，可以从您的后端应用程序自动执行传真发送，从而降低成本并安全地跟踪传入和传出的传真。例如，医疗保健应用程序可以与云传真集成，以发送和接收患者转诊、保险索赔和处方。在医疗保健领域之外，另一个常见示例是交易应用程序，需要通过传真向客户发送交易确认单。

本文档描述了如何使用 OpenText 消息传真 REST API 提交传真发送请求、检查传真状态和接收传真。

步骤 1

从您的销售工程师处获取 Fax2Mail 测试帐户和凭据。

第二步

API 身份验证。可以使用 HTTP Basic 身份验证或 OAUTH 2.0（暂定可用日期为 2021 年 10 月）。Basic 身份验证需要用户名和密码。本文档中的示例使用 Basic 身份验证。

步骤 3

以下是一个使用 curl 命令提交传真发送请求（包含文本文件）的示例。

curl -H "Content-Type: application/json" \
     -u <userid:password> \ 
     --data-binary "{
    \"destinations\": [
        {
            \"fax\": \"9999999999\"
        }
    ],
    \"documents\": [
        {
            \"name\": \"temp.txt\",
            \"type\": \"text\",
            \"data\": \"SGkgVGhlcmUsIFRoaXMgaXMgYSB0ZXN0IERvY3VtZW50Lg==\"
        }
    ]
}"  \
https://t2api.us.cloudmessaging.opentext.com/mra/v1/outbound/faxes

成功提交请求将返回 HTTP 200 响应代码以及一个作业 ID。以下是一个示例响应：

{
    "job_id": "xsi-1111111111"
}

步骤 4

检查传真发送请求的状态。可以通过状态 API 或 Webhook 检查状态。强烈建议使用 Webhook。传真状态模式对于 Webhook 和 API 都是相同的。在本示例中，我们将提供一个 curl 示例，用于通过状态 API 检查状态。

curl -u <userid:password> \

'https://t2api.us.cloudmessaging.opentext.com/mra/v1/outbound/faxes/status?job_id=xsi-1111111111'

成功提交状态 API 调用将返回 HTTP 200 响应代码以及如下所示的详细 JSON 状态。作业状态和交付尝试状态确认传真已成功发送到目的地。

{
    "job_id": "xsi-1111111111",
    "entry_time": "2020-05-08T03:35:05.000Z",
    "job_state": [
        "Complete",
        "Posted"
    ],
    "deliveries": [
        {
            "fax": "1234567890",
            "delivery_attempts": [
                {
                    "state": "Sent",
                    "first_attempt": "2020-05-08T03:35:07.000Z",
                    "delivery_time": "2020-05-08T03:35:34.000Z",
                    "delivery_sec": 8,
                    "pages_delivered": 1,
                    "baud_rate": 31200,
                    "rcsid": "011919164813456"
                }
            ]
        }
    ]
}

接下来，我们将描述如何使用 API 检索发送到您的传真号码的传真文档。请注意，传真文档可以使用 Webhook 传递，强烈建议使用 Webhook。Webhook 和状态 API 响应的模式相同。对于本示例，我们将提供一个 curl 示例，用于通过状态 API 检查状态。

以下是一个检索传真文档的示例 curl 命令。

curl -u <userid:password> \ 'https://t2api.us.cloudmessaging.opentext.com/mra/v1/inbound/documents/next'

成功检索文档请求将返回 HTTP 200 响应代码以及如下所示的接收传真的详细 JSON 描述。

{
    "doc_id": "eHNpcWEzfTh8MjM4f2MC0xMDQ5NDg3",
    "document_class": "Inbound Fax",
    "job_id": "xsi-2222222222",
    "user_id": "your id",
    "customer_reference_base64": "Y3VzdF9yZWZfZjJt",
    "billing_code_base64": "YmNfdGVzdF9h",
    "transaction_info": {
        "fax_mode": "STANDARD",
        "tsid": "011919164813456     ",
        "ani": "1234567890",
        "dnis": "1234567890",
        "call_date": "2020-05-08T03:48:22.000Z",
        "connect_time": 8,
        "baud_rate": 31200,
        "page_count": 1,
        "internal_fax_id": "fax1-005000421-20200507"
    },
    "document": {
        "type": "PDF",
        "name_base64": "ZmF4LTyMC0yMzQ4LnBkZg==",
        "data": "JVBERi0xLjIGyZWYKMTE2MAolJUVPRgo="
    }
}

成功检索文档后，应删除文档以释放空间。以下是一个删除文档的示例 curl 命令，它将返回 HTTP 响应代码 204。

curl -X DELETE \ 
     -u <userid:password> \
'https://t2api.us.cloudmessaging.opentext.com/mra/v1/inbound/documents/eHNpcWEzfDIwMDQ0NDcyMTh8MjM4fHFkb2MtcHVsbC0xMDQ5NDg3'

有关传真 REST API 的详细文档，请访问：

https://developer.opentext.com/apis/99b857ce-b749-4061-bc63-8a077e3a0818/Cloud%20Fax