如何使用 API 下载团队成员的 fax?

哪些用户可以使用此功能?

适用于 Enterprise 套餐

所有成员。

Fax.Plus API 提供了一个强大的解决方案,可以无缝收集团队成员的信息和已接收的 fax 文件,前提是他们在团队的层级结构中处于较低的职位。

注意:请确保您已完成初始身份验证流程,并已成功登录 API。如需其他说明,请参阅我们的指南(点击此处)。

步骤 1:获取团队成员列表

在继续操作之前,请确认目标团队成员在团队的层级结构中位于该 API 用户的下级。如下方截图所示,测试管理员(Test Admin)的账户能够顺利连接到 API,从而获得访问测试成员(Test Member)关键信息和 fax 文件的权限。

FAX.PLUS-API-Member-Fax-Access-1.png

获取所有公司成员的列表,请向以下网址发起 HTTP GET 请求:https://restapi.fax.plus/v3/accounts/

 

请确保在请求中包含以下标头:

    • Content-Type: 
      multipart/form-data
    • Authorization: 
      Bearer [access token]
    • x-fax-clientid: 
      [client ID]
 
FAX.PLUS-API-Member-Fax-Access-2.png

FAX.PLUS-API-Member-Fax-Access-3.png

您将能够访问该成员的详细信息,包括其 UID(用户 ID),该信息将包含在获取到的数据中。

步骤 2:访问团队成员收到的 fax
获取该成员的用户 ID 后,访问其已接收的 fax就变得十分简便。只需向以下网址发起 HTTP GET 请求即可:
https://restapi.fax.plus/v3/accounts/[member user ID]/faxes?category=inbox

请确保在请求中包含以下标头:
    • Authorization: 
      Bearer [access token]
    • x-fax-clientid: 
      [client ID]

FAX.PLUS-API-Member-Fax-Access-4.png

fax ID 可从响应中获取。

注意:您可能需要考虑为“fax_received”事件设置专用的 webhook,这不仅能为您提供该事件的 fax ID,还能提供更多详细信息。如需深入了解,请查阅更多相关内容。有关更多信息,请参阅我们的指南

步骤 3:下载团队成员收到的 fax

获取 fax 文件,您可以通过访问以下网址发起 HTTP GET 请求:
https://restapi.fax.plus/v3/accounts/[member user ID]/files/[fax ID]?format=pdf

 

请确保在请求中包含以下标头:

    • Authorization: 
      Bearer [access token]
    • x-fax-clientid: 
      [client ID]


FAX.PLUS-API-Member-Fax-Access-5.png

这篇文章有帮助吗?
0 人中有 0 人觉得有帮助
More Articles in this section