要使用 API 发送 fax，您首先需要上传所需的文件，然后准备这些文件用于 fax 传输，并安排其发送。
安排好您的 fax 传输后，您可以搭建一个 HTTP 服务器并利用 webhook 机制。此方法可确保在 fax 传输成功和传输失败时都会发送 HTTP 消息。
注意：请确保您已完成初始身份验证流程，并成功登录 API。如需更多说明，请参阅我们的指南此处。
要上传文件，请向以下网址发起 HTTP POST 请求：https://restapi.fax.plus/v3/accounts/[user ID]/files?format=[file format, 'pdf' or 'tiff']
请确保在请求中包含以下标头：
-
- Content-Type:
multipart/form-data
- Content-Type:
-
- Authorization:
Bearer [access token]
- Authorization:
-
- x-fax-clientid:
[client ID]
- x-fax-clientid:
请求正文：
{
"fax_file": [file]
}
在以下示例中，“self”被用作用户 ID，用来表示当前登录用户的唯一标识：
文件上传成功后，您将会获得该文件在 Fax.Plus 上的临时存储路径。
上传完成后，您就可以开始准备发送传真。要启动该流程，请向以下网址发起 HTTP POST 请求：
https://restapi.fax.plus/v3/accounts/[user ID]/outbox
请确保在请求中包含以下标头：
-
- Authorization:
Bearer [access token]
- x-fax-clientid:
[client ID]
- Authorization:
请求正文：
{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}
传真安排成功后，您将获得一个 Outbox ID。该 ID 可用于在传真实际发送之前对其进行修改或删除。
注意：在我们的 API 中，传真会关联多个 ID。这样设计的原因是传真传输是异步操作。具体而言，一份发出的传真会有两个不同的 ID：Outbox ID，在传真成功发送之前起作用；以及 Fax ID，在传真成功传输之后成为该传真的最终标识符。
安排传真后，您可以通过查看位于发件箱或已发送类别中的传真列表来监控其状态。
此外，您也可以选择搭建一个 HTTP 服务器并使用 webhook。这样，当传真成功发送或发送失败时，将会触发发送一条 HTTP 消息。
请按照以下步骤设置 Webhook：
- 登录您的 Fax.Plus 账户，然后进入仪表板上的设置 部分。
- 在Integrations标签下，找到 WebHooks 方框。
- 找到Incoming Faxes和Incoming Faxes。点击Manage以修改 Webhook。
设置 Webhook 后，一旦发出的传真被处理完毕，您将收到如下通知：
{
"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"
}
}