Как скачать факсы участника команды через API?

Кто может использовать эту функцию?

Доступно на Enterprise тарифе.

Все участники.

API Fax.Plus предлагает эффективное решение для получения информации и файлов принятых факсов участников вашей команды при условии, что они занимают более низкое положение в иерархической структуре команды.

Примечание: убедитесь, что вы завершили первоначальную аутентификацию и успешно авторизовались в API. Дополнительные инструкции приведены в нашем руководстве здесь.

Шаг 1. Получите список участников вашей команды

Прежде чем продолжить, убедитесь, что нужный участник команды занимает в иерархии команды более низкую позицию, чем пользователь API. Как показано на скриншотах ниже, аккаунт Test Admin может подключиться к API и получить доступ к важной информации и файлам fax участника Test Member.

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

 

Чтобы получить список всех корпоративных участников, отправьте HTTP GET-запрос по следующему URL: 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 (идентификатор пользователя).

Шаг 2. Откройте полученные fax участника вашей команды

Зная идентификатор пользователя участника, вы можете легко запросить его полученные fax. Для этого отправьте HTTP GET-запрос по следующему URL:
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 можно получить из ответа.

Примечание: рекомендуем настроить отдельный вебхук для события «fax_received». Он передаст не только идентификатор fax, но и дополнительные сведения. Подробнее об этом читайте в нашем руководстве здесь.

Шаг 3. Скачайте полученные 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]


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

Была ли эта статья полезной?
Пользователи, считающие этот материал полезным: 0 из 0
Другие статьи в этом разделе