Listar los faxes recibidos

Listar los faxes recibidos

Utilice una cuenta habilitada de la API de MultiTEL a través de HTTPS, con sus credenciales y restricciones de IP configuradas. Este punto de acceso lista los faxes recibidos que pertenecen a la cuenta autenticada. No envía faxes ni descarga sus documentos.

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode page=1 \
  --data-urlencode limit=25 \
  --data-urlencode date_from=2026-10-01 \
  --data-urlencode date_to=2026-10-02 \
  https://api.multitel.net/v3/fax_inbox

Los límites de fecha son inclusivos y utilizan la interpretación de fechas del servidor de la API, no una zona horaria solicitada por el usuario. Las cadenas de fecha no válidas pueden ignorarse en lugar de rechazarse; valídelas antes de enviarlas. Si no se aplican filtros de fecha, el controlador no impone ningún intervalo de fechas predeterminado. Los resultados se ordenan por hora de recepción, con los más recientes primero. El punto de acceso no ofrece una instantánea estable entre páginas: las nuevas llegadas pueden desplazar registros de una página a otra.

Consultar la página del buzón

Consulte el resultado HTTP y el campo status.code del contenido JSON. Los fallos en otras partes de la API pueden utilizar una estructura de error JSON incluso cuando el estado HTTP es 200. Una respuesta correcta contiene response.faxes y response.pagination. Este ejemplo utiliza valores ficticios.

{
  "status": {"code": 200, "msg": ""},
  "response": {
    "faxes": [{
      "id": 12,
      "hash": "c20ad4d76fe97759aa27a0c99bff6710",
      "from_number": "+12125550123",
      "to_number": "+12125550124",
      "remote_station_id": "Example sender",
      "pages": 2,
      "cost": 0.05,
      "received_at": "2026-10-01 12:00:00",
      "received_timestamp": 1790856000,
      "status": "success",
      "status_text": "OK",
      "emailed": "yes",
      "viewed": false
    }],
    "pagination": {"page": 1, "limit": 25, "total": 1, "total_pages": 1}
  }
}

id es el identificador numérico del registro del buzón de entrada. hash es su representación MD5 para el flujo heredado de documentos entrantes; no es un identificador de tarea de send_fax ni una credencial de autorización. No lo utilice con fax_status para consultar faxes salientes.

received_timestamp es la marca de tiempo Unix almacenada. received_at es una marca de tiempo con el formato del servidor y sin desplazamiento de zona horaria, o null si no hay una hora de recepción registrada; utilice el valor Unix al mostrar las horas en su propia zona horaria. cost es un número JSON, no una cotización de precio ni una prueba de que se haya efectuado un cobro independiente.

status es success únicamente cuando el código de estado almacenado es cero; los demás valores se convierten en failed. status_text contiene el mensaje de procesamiento almacenado, con OK o Failed como valor alternativo. emailed conserva el valor almacenado en lugar de un valor booleano. viewed es un valor booleano. No deduzca que el correo electrónico se ha entregado correctamente basándose únicamente en el estado del fax.

Gestionar listas vacías y cambiantes

Un buzón vacío devuelve un arreglo faxes vacío, total con valor 0 y total_pages con valor 0. Una página posterior a la última también puede devolver un arreglo vacío. Detenga la consulta según los campos de paginación en lugar de suponer que existe al menos una página. No se ofrece ningún cursor ni una ordenación secundaria por identificador de registro. Conserve los identificadores de registro al conciliar páginas con registros coincidentes.

Acceso a los documentos y privacidad

Las entradas del buzón contienen metadatos privados de telefonía y documentos. Restrinja el acceso en su aplicación y evite registrar respuestas completas. Listar los documentos no los marca como vistos. Utilice fax_file para descargar documentos entrantes mediante el mecanismo de compatibilidad; tenga en cuenta que marca un registro entrante existente como visto incluso si su archivo no está disponible. También puede acceder a los documentos desde el buzón de entrada del portal. No se ha establecido ninguna garantía de conservación de archivos.