要使用 API 发送 fax，您首先需要上传所需的文件，然后准备这些文件用于 fax 传输，并安排其发送。
安排好您的 fax 传输后，您可以搭建一个 HTTP 服务器并利用 webhook 机制。此方法可确保在 fax 传输成功和传输失败时都会发送 HTTP 消息。
注意：请确保 您已完成初始身份验证流程，并已成功登录 API。如需更多说明，请参阅此处的指南。
要上传文件，请向以下 URL 发起 HTTP POST 请求：https://restapi.fax.plus/v3/accounts/[user ID]/files?format=[file format, 'pdf' or 'tiff']
请确保在请求中包含以下请求头：
-
Content-Type:
multipart/form-data
-
Authorization:
Bearer [access token]
-
x-fax-clientid:
[client ID]
请求体：
{
"fax_file": [file]
}
在以下示例中，使用“self”作为用户 ID，代表当前已登录用户的唯一标识：
文件上传成功后，您将收到一个路径，指向该文件在 Fax.Plus 上的临时存放位置。
上传完成后，您就可以开始准备发送 fax。要启动该流程，请向以下 URL 发起 HTTP POST 请求：
https://restapi.fax.plus/v3/accounts/[user ID]/outbox
请确保在请求中包含以下请求头：
-
Authorization:
Bearer [access token] -
x-fax-clientid:
[client ID]
请求体：
{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}
fax 成功安排发送后，您将获得一个发件箱 ID（Outbox ID）。在 fax 实际发出之前，可以使用此 ID 对其进行修改或删除。
注意：在我们的 API 中，fax 会关联多个 ID。这样设计是因为 fax 传输是异步进行的。具体而言，一份外发 fax 将由两个不同的 ID 标识：发件箱 ID（Outbox ID）在 fax 成功发送之前一直有效，而 Fax ID 则在 fax 成功传输后成为该 fax 的最终标识符。
安排发送 fax 后，您可以通过查看发件箱或已发送分类中的 fax 列表来监控其状态。
或者，您也可以搭建一个 HTTP 服务器并使用 webhook。当 fax 发送成功或发送失败时，系统会触发并发送一条 HTTP 消息。
请按以下步骤设置 Webhook：
设置好 Webhook 后，外发 fax 处理完成时，您将收到如下通知：
{
"hook": {
"id": "",
"event": "fax_sent",
"event_time": "2022-12-09 15:50:00",
"target": "http://www.example.com/callback/fax_sent"
},
"data": {
"id": "",
"pages": 1,
"from": "",
"to": "",
"start_time": "2022-12-09 15:50:00",
"file": "",
"file_name": "fax-from-1xxxxxxxxxxxx",
"cost": 1,
"status": "success"
}
}此消息将告知您传输时间，通过“status”字段指明 fax 传输是否成功，并提供唯一的 Fax ID。该 Fax ID 可用于获取 fax 文件或获取 fax 确认报告。