Como posso enviar um fax através da API?

Atualizado 15 de Setembro de 2026 08:10

Quem pode utilizar esta funcionalidade?

Disponível no plano Enterprise.

Todos os membros.

Para enviar um fax através da API, primeiro é necessário carregar os ficheiros pretendidos, seguido da preparação desses ficheiros para envio por fax e do agendamento da respetiva transmissão.

Assim que o fax estiver agendado, pode implementar um servidor HTTP e utilizar um mecanismo de webhook. Esta abordagem garante que uma mensagem HTTP é enviada tanto em caso de transmissão bem-sucedida do fax como em caso de falha na transmissão.

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

Passo 1: Carregar os ficheiros a enviar por fax

Para carregar um ficheiro, inicie um pedido HTTP POST para o seguinte URL: https://restapi.fax.plus/v3/accounts/[user ID]/files?format=[file format, 'pdf' or 'tiff']

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]
```

Para o corpo do pedido:

{
  "fax_file": [file]
}

‍

No exemplo seguinte, é utilizado „self“ como user ID para representar o identificador único do utilizador com sessão iniciada:

FAX.PLUS-Send-Fax-API-2.png

FAX.PLUS-Send-Fax-API-3.png

Assim que o ficheiro tiver sido carregado com êxito, receberá um caminho que leva à localização temporária do ficheiro em Fax.Plus.

Passo 2: Enviar um fax através da API

Assim que os carregamentos estiverem concluídos, pode começar a preparar o seu fax para envio. Para iniciar o processo, execute um pedido HTTP POST para o seguinte URL:
https://restapi.fax.plus/v3/accounts/[user ID]/outbox

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

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

Para o corpo do pedido:

{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}

FAX.PLUS-Send-Fax-API-4.png

Após o agendamento bem-sucedido do fax, receberá um Outbox ID. Este ID pode ser utilizado para efetuar alterações ou eliminar o fax antes de ser efetivamente enviado.

Nota: os faxes estão associados a vários IDs na nossa API. Esta conceção existe porque a transmissão de fax funciona de forma assíncrona. Especificamente, um fax de saída será identificado por dois IDs distintos: o Outbox ID, que serve o seu propósito até o fax ser enviado com êxito, e o Fax ID, que se torna o identificador definitivo do fax assim que este for transmitido com êxito.

Passo 3: Utilizar webhooks para verificar o estado do fax enviado

Após agendar o fax, pode monitorizar o seu estado consultando a lista de faxes localizada na caixa de saída ou na categoria de enviados.

Em alternativa, tem a opção de configurar um servidor HTTP e utilizar um webhook. Isto irá desencadear o envio de uma mensagem HTTP quando o fax for enviado com êxito ou se ocorrer uma falha no envio.

Siga estes passos para configurar o Webhook:

Inicie sessão na sua conta Fax.Plus e aceda à secção Definições no seu painel.
No separador Integrações, procure a caixa WebHooks.
Localize Faxes recebidos e Faxes recebidos. Clique em Gerir para modificar o Webhook.

Depois de configurar o Webhook, receberá a seguinte notificação assim que um fax de saída for processado:

{
"hook": {
"id": "",
"event": "fax_sent",
"event_time": "2022-12-09 15:50:00",
"target": "http://www.example.com/callback/fax_sent"
},
"data": {
"id": "",
"pages": 1,
"from": "",
"to": "",
"start_time": "2022-12-09 15:50:00",
"file": "",
"file_name": "fax-from-1xxxxxxxxxxxx",
"cost": 1,
"status": "success"
}
}

Esta mensagem fornecer-lhe-á a hora de transmissão, indicará o sucesso da transmissão do fax (através do campo „status“) e fornecer-lhe-á o ID único do fax. Este ID de fax pode ser utilizado para obter o ficheiro do fax ou obter um relatório de confirmação do fax.

Need Support?