Para enviar um fax usando a API, você precisa primeiro fazer o upload dos arquivos requeridos. seguido da preparação dos arquivos para faxing e agendar sua transmissão.
Uma vez que seu fax estiver agendado, você poderá implementar um servidor HTTP e alavancar um mecanismo webhook. Esta abordagem garante que uma mensagem HTTP é enviada tanto após uma transmissão bem-sucedida de fax como em caso de falha de transmissão.
Note: Certifique-se de que você concluiu o processo de autenticação inicial e entrou com sucesso na API. Para obter instruções adicionais, consulte o nosso guia aqui.
Para enviar um arquivo, inicie uma solicitação HTTP POST para a seguinte URL: https://restapi.fax.plus/v3/accounts/[ID do usuário]/arquivos?format=[formato do arquivo, 'pdf' ou 'tiff']
Certifique-se de incluir os seguintes cabeçalhos na sua solicitação:
-
- Conteúdo-Tipo:
multipartes/formulários-dados
- Conteúdo-Tipo:
-
- Autorização:
Portador [token de acesso]
- Autorização:
-
- x-fax-clientid:
[ID do cliente]
- x-fax-clientid:
Pelo corpo:
{
"fax_file": [file]
}
No exemplo a seguir, "self" é utilizado como o ID do usuário para representar a identificação exclusiva do usuário logado atualmente:
Uma vez que o arquivo foi carregado com sucesso, você receberá um caminho que levará à localização temporária do arquivo no Fax.Plus.
Once the uploads are completed, you can begin preparing your fax for sending. Para iniciar o processo, execute uma solicitação HTTP POST para a seguinte URL:
https://restapi.fax. lus/v3/contas/[ID do usuário]/caixa de saída
Não esqueça de incluir os seguintes cabeçalhos na sua solicitação:
-
- Autorização:
Portador [token de acesso]
- x-fax-clientid:
[ID do cliente]
- Autorização:
Para o corpo do pedido:
{
"from": "",
"to": [
""
],
"files": [
""
],
"comentário": {
"text": ""
},
"send_time": "",
}
Após o agendamento do fax, você receberá um ID da Caixa de Saída. Este ID pode ser utilizado para fazer modificações ou excluir o fax antes que ele seja realmente enviado.
Note: Os eixos são associados a vários IDs com nossa API. Este projeto está em vigor porque a transmissão por fax opera de forma assíncrona. Especificamente, um fax de saída será identificado por dois IDs distintos: ID de caixa, que atende ao seu propósito até que o fax seja enviado com sucesso, e Fax ID, que se torna o identificador definitivo do fax uma vez que tenha sido transmitido com sucesso.
Depois de agendar o fax, você pode monitorar seu status analisando a lista de faxes localizados na caixa de saída ou na categoria enviada.
Como alternativa, você tem a opção de estabelecer um servidor HTTP e usar um webhook. Isto irá acionar uma mensagem HTTP a ser enviada quando o fax for enviado com sucesso ou se houver uma falha no envio.
Siga estas etapas para configurar o Webhook:
- Faça login na sua conta Fax.Plus e vá para a seção Perfilno seu painel.
- Sob a aba para Integrações, encontra a caixa para Web Hooks.
- Encontre Recebendo Faxes e Recebendo Faxes. Clique em Gerenciar para modificar o Webhook.
Depois de configurar o Webhook, você 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. om/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á o tempo de transmissão, indique o sucesso da transmissão por fax (através do campo "status") e lhe proporcione um fax único. Este ID de fax pode ser utilizado para recuperar o arquivo de fax ou obter um relatório de confirmação de fax.