Descargar un fax de la bandeja de entrada o de salida

Elegir un documento entrante o saliente

Este punto de acceso de compatibilidad recupera un documento de fax perteneciente a su cuenta. Utilice una cuenta habilitada de la API de MultiTEL a través de HTTPS, con sus credenciales y restricciones de IP configuradas. No envía ni reenvía ningún fax.

Estos valores deben incluirse en la ruta. La ruta es /v3/fax_file/{type}/{id}, y no fax_download con segmentos de ruta adicionales. El hash del fax entrante no es el ID numérico del registro ni el ID de un trabajo saliente. Copie el identificador del listado de la bandeja correspondiente; este no sustituye a la autenticación.

Descargar un fax recibido

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

El hash del ejemplo representa el registro ficticio 12 de la bandeja de entrada. Obtenga su propio valor de fax_inbox. Al descargar un registro entrante existente, este se marca como visto. Esto ocurre antes de comprobar la disponibilidad del archivo, por lo que un error de archivo no disponible puede dejar igualmente viewed establecido en true. No utilice este punto de acceso únicamente para comprobar si existe un fax recibido si desea que su estado de visualización permanezca sin cambios.

El componente que procesa la solicitud da preferencia a un PDF almacenado. En su defecto, utiliza el TIFF almacenado e intenta convertirlo a PDF cuando el conversor está disponible. Si la conversión no está disponible o genera una excepción que el componente captura, devuelve el TIFF en su lugar. Examine siempre el Content-Type devuelto en vez de dar por supuesto que se trata de un PDF.

Descargar un fax saliente

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

Utilice el uuid de fax_outbox. Esta descarga de compatibilidad da preferencia a un objeto binario PDF almacenado, después a un objeto binario TIFF y, a continuación, a un archivo PDF, un archivo TIFF o el archivo de origen original que esté disponible. Su orden de preferencia difiere del que aplica actualmente a los faxes salientes fax_download al procesar las solicitudes. Para las nuevas integraciones que utilicen send_fax, utilice ese flujo de descarga actual con su parámetro job_id.

Un archivo de origen original puede devolverse como application/octet-stream en lugar de PDF o TIFF. El nombre del archivo adjunto puede conservar la extensión del archivo de origen. La descarga saliente de compatibilidad no marca ningún registro de la bandeja de entrada como visto, no cambia el estado del trabajo ni crea una transmisión.

Gestionar los bytes y los errores por separado

Si la solicitud se completa correctamente, se devuelven los bytes sin procesar del documento con las cabeceras Content-Type, Content-Disposition para archivo adjunto y Content-Length. No se trata de un contenedor JSON con datos en Base64. Guarde las cabeceras y los bytes por separado como se muestra, examine el tipo de respuesta y, solo entonces, asigne un nombre adecuado al archivo o procéselo. Que la extensión del archivo de origen esté permitida no garantiza que el documento sea válido o esté convertido.

El código 400 de la API significa que falta un valor obligatorio de la ruta o que type no es válido. El código 404 de la API significa que el registro perteneciente a la cuenta o su archivo no está disponible. Los errores utilizan el contenedor habitual JSON de status/response y pueden utilizar HTTP 200. Compruebe el Content-Type de la respuesta y el campo status.code del JSON para evitar abrir el cuerpo de un error como si fuera un documento.

Privacidad y disponibilidad

El contenido de los faxes puede incluir información confidencial. Guarde los archivos descargados únicamente en ubicaciones a las que puedan acceder los destinatarios previstos y evite incluir todos los bytes del documento en los registros de actividad. La existencia de un registro en una bandeja no garantiza que su archivo siga estando disponible. No se ha establecido ningún plazo de conservación de archivos ni se garantiza la compatibilidad con todos los documentos históricos almacenados.