Baixar um fax da caixa de entrada ou de saída

Escolher um documento de entrada ou de saída

Este ponto de acesso de compatibilidade recupera um documento de fax pertencente à sua conta. Use uma conta habilitada da API da MultiTEL por HTTPS, com as credenciais e restrições de IP configuradas. Ele não envia nem reenvia um fax.

Esses valores devem ser incluídos no caminho. A rota é /v3/fax_file/{type}/{id}, e não fax_download com segmentos adicionais no caminho. O hash de entrada não é o ID numérico do registro nem o ID de uma tarefa de saída. Copie o identificador da listagem da caixa correspondente; ele não substitui a autenticação.

Baixar um fax recebido

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_file/inbound/c20ad4d76fe97759aa27a0c99bff6710

O hash do exemplo representa o registro fictício 12 da caixa de entrada. Obtenha seu próprio valor em fax_inbox. Baixar um registro de entrada existente o marca como visualizado. Isso ocorre antes da verificação de disponibilidade do arquivo, portanto um erro de arquivo indisponível ainda pode deixar viewed definido como true. Não use este ponto de acesso apenas para verificar se um fax recebido existe caso queira manter seu estado de visualização inalterado.

O componente que processa a solicitação dá preferência a um PDF armazenado. Caso contrário, usa o TIFF armazenado e tenta convertê-lo em PDF quando o conversor está disponível. Se a conversão estiver indisponível ou gerar uma exceção tratada, retorna o TIFF em seu lugar. Sempre examine o Content-Type retornado em vez de presumir que se trata de um PDF.

Baixar um fax de saída

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_file/outbound/0123456789abcdef0123456789abcdef

Use o uuid de fax_outbox. Este download de compatibilidade dá preferência a um objeto binário PDF armazenado, depois a um objeto binário TIFF e, em seguida, a um arquivo PDF, arquivo TIFF ou arquivo de origem original disponível. Sua ordem de preferência difere daquela aplicada atualmente aos faxes de saída por fax_download ao processar as solicitações. Para novas integrações que usam send_fax, use esse fluxo de download atual com seu parâmetro job_id.

Um arquivo de origem original pode ser retornado como application/octet-stream em vez de PDF ou TIFF. O nome do arquivo anexo pode manter a extensão do arquivo de origem. O download de saída de compatibilidade não marca um registro da caixa de entrada como visualizado, não altera o estado da tarefa nem cria uma transmissão.

Tratar bytes e erros separadamente

Quando a solicitação é bem-sucedida, são retornados os bytes brutos do documento com os cabeçalhos Content-Type, Content-Disposition para anexo e Content-Length. Não se trata de um envelope JSON com dados em Base64. Salve os cabeçalhos e os bytes separadamente como mostrado, examine o tipo da resposta e só então atribua um nome adequado ao arquivo ou o processe. Uma extensão de origem permitida não garante um documento válido ou convertido.

O código 400 da API significa que falta um valor obrigatório no caminho ou que type é inválido. O código 404 da API significa que o registro pertencente à conta ou seu arquivo está indisponível. Os erros usam o envelope habitual JSON de status/response e podem usar HTTP 200. Verifique o Content-Type da resposta e o campo status.code do JSON para que o corpo de um erro não seja aberto como documento.

Privacidade e disponibilidade

O conteúdo dos faxes pode conter informações sensíveis. Armazene os arquivos baixados apenas em locais aos quais os destinatários pretendidos possam ter acesso e evite incluir todos os bytes do documento nos registros de atividade. Um registro na caixa não garante que seu arquivo continuará disponível. Não foi estabelecido nenhum prazo de retenção de arquivos nem garantia de compatibilidade com todos os documentos históricos armazenados.