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 de que iniciou sessão com êxito na API. Para obter instruções adicionais, consulte o nosso guia aqui.
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, „self“ é utilizado como ID de utilizador para representar a identificação única do utilizador com sessão iniciada:
Depois de o ficheiro ser carregado com sucesso, receberá um caminho que conduz à localização temporária do ficheiro em Fax.Plus.
Depois de concluídos os carregamentos, 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": "",
}
Depois de o fax ser agendado com sucesso, receberá um ID da caixa de saída. Este ID pode ser utilizado para fazer alterações ao fax ou eliminá-lo antes de ser efetivamente enviado.
Nota: Na nossa API, os faxes estão associados a vários IDs. Este desenho existe porque a transmissão de fax funciona de forma assíncrona. Em concreto, um fax de saída é identificado por dois IDs distintos: o ID da caixa de saída, que serve até o fax ser enviado com sucesso, e o ID do fax, que passa a ser o identificador definitivo do fax depois de ter sido transmitido com êxito.
Depois de agendar o fax, pode acompanhar o respetivo estado consultando a lista de faxes na caixa de saída ou na categoria de enviados.
Em alternativa, pode configurar um servidor HTTP e utilizar um webhook. Isto fará com que seja enviada uma mensagem HTTP quando o fax for enviado com sucesso 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 de Definições do seu painel.
- No separador Integrações, encontre a caixa de WebHooks.
- Encontre Faxes recebidos e Faxes recebidos. Clique em Gerir para modificar o Webhook.
Depois de configurar o Webhook, receberá a seguinte notificação quando 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 indica-lhe a hora de transmissão, o êxito da transmissão do fax (através do campo „status“) e fornece-lhe o ID único do fax. Este ID do fax pode ser utilizado para obter o ficheiro do fax ou obter um relatório de confirmação do fax.