如何使用 API发送传真？

更新 2024年12月26日 11:21

谁可以使用此功能？

Enterprise Plan

所有成员。

若要使用 API 发送传真，您首先需要上传您所需的文件，然后是准备这些文件传真和安排传送时间。

一旦您的传真被排定，您可以实现一个 HTTP 服务器并杠杆一个 webhook 机制。这种办法确保在成功传真传输和在传输失败的情况下发送HTTP信息。

备注: 请确保您已经完成初始认证进程并成功登录到 API。 For additional instructions, refer to our guide here.

第 1 步：上传要传真的文件

若要上传一个文件，请向 URL 发起一个 HTTP POST 请求： https://restapi.fax.plus/v3/accounts/[user ID]/files?格式=[file form, 'pdf' 或 'tiff']

请确保在您的请求中包含以下标题：

- 内容类型：
```
多部分/表格数据
```

- 授权：
```
持有者[访问令牌]
```

- x-fax-clientid:
```
[客户 ID]
```

主体：

own
"fax_file": [file]
}

‍

在下面的示例中，"自己"被用作用户ID来代表当前登录用户的独特身份：

FAX.PLUS-Send-Fax-API-2.png

FAX.PLUS-Send-Fax-API-3.png

一旦文件成功上传，您将收到通往Fax.Plus文件临时位置的路径。

第 2 步：使用 API 发送传真。

上传完成后，您可以开始准备您的传真，发送若要启动进程，请对以下URL执行HTTP POST 请求：
https://restapi.fax。 lus/v3/account/[user ID]/outbox

请确保在您的请求中包含以下标题：

- 授权：
```
持有者[访问令牌]
```
- x-fax-clientid:
```
[客户 ID]
```

请求正文：

{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}

FAX.PLUS-Send-Fax-API-4.png

在成功排定传真时间后，您将收到发件箱ID。此ID可以用于修改或删除传真，然后才能发送。

备注: 传真与我们的 API 关联多个ID。这种设计之所以存在，是因为传真传输运行异步操作。具体而言，将用两个不同的ID标明发出的传真号码：发件箱ID，它在传真成功发送之前起到了作用。和传真ID，它在成功传送后成为传真的确定标识符。

第 3 步：使用 webhooks 来检查您发送的传真状态

After scheduling the fax, you can monitor its status by reviewing the list of faxes located in the outbox or the sent category.

或者，您可以选择建立一个 HTTP 服务器并使用Webhook。这将在传真发送成功或发送失败时触发要发送的HTTP消息。

按照这些步骤来设置 Webhook:

登录到您的 Fax.Plus 帐户，然后去 Profile在您的仪表板上。
Under the tab for Integrations, find the box for Web Hooks.
Find Incoming Faxes and Incoming Faxes. Click on Manage to modify the 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"
}
}

此消息将为您提供传输时间指明传真传输成功(通过"status"字段)，并向您提供独特的传真ID。 This fax ID can be utilized to retrieve the fax file or obtain a fax confirmation report.

Need Support?