Utilize HTTPS e autenticação HTTP Basic com credenciais de API aprovadas. Mantenha as credenciais no servidor da sua aplicação. Estes endpoints do Hosted PBX utilizam /hpbx/ em api.multitel.net; não insira /v3. Verifique tanto o resultado HTTP como o estado da aplicação na resposta JSON.
Ler registos de fax
curl --request POST --user "USERNAME:PASSWORD" \
"https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"Substitua o código de cobrança pelo código do seu PBX. Os registros retornados incluem hora do fax, sentido da comunicação, origem, destino, status de entrega, tentativas, erros e contagem de páginas. A entrega ainda pode estar pendente quando uma solicitação de envio é aceita.
Parâmetros de envio
O endpoint de envio é POST /hpbx/fax/send/{billing_code}. O envio é uma ação efetiva. Prepare o arquivo e o destino autorizado pela conta antes de enviar; não repita um envio incerto às cegas.
| Campo | Significado |
|---|---|
| number | Número de fax de destino. |
| cidnum | Identificador de chamador aprovado para o remetente. |
| schedule | Horário de envio agendado, quando utilizado. |
| faxquality / pagesize / pagerotate | Opções de qualidade, tamanho de papel e rotação suportadas. |
| statusemail | Endereço autorizado para notificações de entrega. |
| deleteaftersend | Indica se o ficheiro carregado e armazenado deve ser removido após o envio. |
| filename | A referência de documento esperada por este fluxo de fax; não é um caminho de arquivo local arbitrário. |
Acompanhar a conclusão
Após o envio, verifique o estado, as tentativas e o erro do registo do fax. Confirme a entrega em vez de interpretar a aceitação como entrega. A referência de fax do portal documenta o seu fluxo atual de carregamento e envio; os seus caminhos e a autenticação são independentes do endpoint acima.