API Fax.Plus предлагает эффективное решение для получения информации и файлов принятых факсов участников вашей команды при условии, что они занимают более низкое положение в иерархической структуре команды.
Примечание: убедитесь, что вы завершили процесс первоначальной аутентификации и успешно вошли в API. Дополнительные инструкции приведены в нашем руководстве здесь.
Перед тем как продолжить, убедитесь, что нужный участник команды занимает подчинённую позицию по отношению к пользователю API в иерархической структуре команды. Как показано на скриншотах ниже, учётная запись Test Admin может беспрепятственно подключаться к API, что предоставляет доступ к важной информации и файлам fax, принадлежащим Test Member.
Чтобы получить список всех участников организации, отправьте HTTP-запрос GET на следующий URL: https://restapi.fax.plus/v3/accounts/.
Убедитесь, что в запрос включены следующие заголовки:
-
- Content-Type:
multipart/form-data - Authorization:
Bearer [access token] - x-fax-clientid:
[client ID]
- Content-Type:
Вы получите доступ к данным участника, включая UID (User ID), который будет включён в полученные данные.
https://restapi.fax.plus/v3/accounts/[member user ID]/faxes?category=inbox.
Убедитесь, что в запрос включены следующие заголовки:
-
- Authorization:
Bearer [access token]
- Authorization:
-
- x-fax-clientid:
[client ID]
- x-fax-clientid:
ID fax можно получить из ответа.
Примечание: рекомендуем настроить отдельный webhook для события «fax_received», который не только предоставит вам ID fax из события, но и даст дополнительную информацию. Подробнее об этом можно узнать в дополнительных материалах. Дополнительную информацию см. в нашем руководстве здесь.
Чтобы получить файлы fax, отправьте HTTP-запрос GET на следующий URL:
https://restapi.fax.plus/v3/accounts/[member user ID]/files/[fax ID]?format=pdf.
Убедитесь, что в запрос включены следующие заголовки:
-
- Authorization:
Bearer [access token] - x-fax-clientid:
[client ID]
- Authorization: