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

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

适用于 Enterprise 套餐。

所有成员。

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

注意:请确保您已完成初始身份验证流程,并已成功登录 API。更多说明请参阅我们的指南。

第 1 步:获取您的团队成员列表

在继续之前,请确认目标团队成员在团队层级结构中的职位低于 API 用户。如下方截图所示,Test Admin 的账户可以顺利连接到 API,从而获取属于 Test Member 的关键信息和 fax 文件。

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

 

要获取所有企业成员的列表,请向以下 URL 发起 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 就变得十分简便。为此,只需向以下 URL 发起 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 中的文件,您可以通过访问以下 URL 发起 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 人觉得有帮助
本部分的更多文章