Como posso descarregar os faxes de um membro da equipa através da API?

Quem pode utilizar esta funcionalidade?

Disponível no plano Enterprise.

Todos os membros.

Fax.Plus API oferece uma solução poderosa para reunir de forma simples informações e ficheiros de fax recebidos dos membros da sua equipa, desde que estes ocupem uma posição hierárquica inferior na estrutura da equipa.

Nota: Certifique-se de que concluiu o processo de autenticação inicial e iniciou sessão com sucesso na API. Para instruções adicionais, consulte o nosso guia aqui.

Passo 1: Obter a lista dos membros da sua equipa

Antes de continuar, verifique se o membro da equipa pretendido ocupa uma posição subordinada ao utilizador da API dentro da estrutura hierárquica da equipa. Como ilustrado nas capturas de ecrã abaixo, a conta do Test Admin consegue ligar-se sem problemas à API, obtendo assim acesso a informações essenciais e a ficheiros de fax pertencentes ao Test Member.

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

Para obter a lista de todos os membros da empresa, inicie um pedido HTTP GET para o seguinte URL: https://restapi.fax.plus/v3/accounts/.

 

Certifique-se de que inclui os seguintes cabeçalhos no seu pedido:

    • 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

Terá a possibilidade de aceder aos detalhes do membro, incluindo o UID (ID do utilizador), que estará incluído nos dados obtidos.

Passo 2: Aceder aos faxes recebidos pelo membro da sua equipa
Depois de obter o ID de utilizador do membro, aceder aos seus faxes recebidos torna-se um processo simplificado. Para isso, basta iniciar um pedido HTTP GET para o seguinte URL:
https://restapi.fax.plus/v3/accounts/[member user ID]/faxes?category=inbox.

Certifique-se de que inclui os seguintes cabeçalhos no seu pedido:
    • Authorization: 
      Bearer [access token]
    • x-fax-clientid: 
      [client ID]

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

O ID do fax pode ser obtido a partir da resposta.

Nota: Poderá considerar configurar um webhook dedicado para o evento „fax_received“, que não só lhe fornecerá o ID do fax do evento, como também oferecerá informações adicionais. Aprofunde este tema explorando mais informações. Para mais informações, consulte o nosso guia aqui.

Passo 3: Descarregar os faxes recebidos pelo membro da sua equipa

Para obter os ficheiros do fax, pode iniciar um pedido HTTP GET acedendo ao seguinte URL:
https://restapi.fax.plus/v3/accounts/[member user ID]/files/[fax ID]?format=pdf.

 

Certifique-se de que inclui os seguintes cabeçalhos no seu pedido:

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


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

Este artigo foi útil?
0 de 0 acharam isto útil
More Articles in this section