Lister les fax reçus

Utilisez un compte API MultiTEL activé via HTTPS, avec les identifiants et les restrictions d’adresses IP configurés pour ce compte. Ce point de terminaison liste les fax reçus appartenant au compte authentifié. Il n’envoie aucun fax et ne télécharge pas le document associé.

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

Paramètres de requête de la boîte de réception
Paramètre	Obligatoire	Signification
`page`	Non	Numéro de page, à partir de 1. Valeur par défaut : 1.
`limit`	Non	Nombre d’enregistrements par page. Valeur par défaut : 25 ; maximum : 100. Utilisez un entier strictement positif.
`search`	Non	Effectue une recherche dans le numéro de l’expéditeur, le numéro de fax destinataire et l’identifiant de la station distante. Les espaces en début et en fin sont supprimés. La sensibilité à la casse dépend des règles de classement de la base de données.
`date_from`	Non	Inclut les fax à partir du début de cette journée, selon l’heure locale du serveur. Utilisez le format YYYY-MM-DD.
`date_to`	Non	Inclut les fax jusqu’à la fin de cette journée, selon l’heure locale du serveur. Utilisez le format YYYY-MM-DD.

Les bornes de dates sont inclusives et suivent l’interprétation des dates du serveur API, et non un fuseau horaire demandé par l’utilisateur. Les chaînes de dates non valides peuvent être ignorées plutôt que rejetées ; vérifiez leur validité avant de les envoyer. En l’absence de filtres de dates, le gestionnaire n’impose aucune période par défaut. Les résultats sont classés par date et heure de réception, des plus récents aux plus anciens. Ce point de terminaison ne fournit pas d’instantané stable entre les pages : de nouvelles réceptions peuvent déplacer des enregistrements d’une page à une autre.

Consulter une page de la boîte de réception

Examinez le résultat HTTP et le champ status.code du contenu JSON. Ailleurs dans l’API, les échecs peuvent être signalés dans une enveloppe d’erreur JSON, même lorsque le statut HTTP est 200. Une réponse réussie contient response.faxes et response.pagination. Cet exemple utilise des valeurs fictives.

{
  "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 est l’identifiant numérique de l’enregistrement dans la boîte de réception. hash est sa représentation MD5 pour l’ancien processus de gestion des documents entrants ; ce n’est ni un identifiant de tâche send_fax ni un justificatif d’autorisation. Ne l’utilisez pas avec le point de terminaison fax_status destiné aux envois.

received_timestamp est l’horodatage Unix enregistré. received_at est un horodatage formaté par le serveur sans décalage de fuseau horaire, ou null si aucune date et heure de réception n’est enregistrée ; utilisez la valeur Unix pour afficher les heures dans votre propre fuseau horaire. cost est un nombre JSON, et non un devis ni la preuve d’un débit distinct effectué.

status vaut success uniquement lorsque le code de statut enregistré est égal à zéro ; les autres valeurs donnent failed. status_text contient le message de traitement enregistré, avec OK ou Failed comme valeur de repli. emailed conserve la valeur enregistrée plutôt qu’une valeur booléenne. viewed est une valeur booléenne. Ne déduisez pas la bonne livraison du courriel à partir du seul statut du fax.

Gérer les listes vides et les listes qui évoluent

Une boîte de réception vide renvoie un tableau faxes vide, total à 0 et total_pages à 0. Une page située au-delà de la dernière page peut également renvoyer un tableau vide. Déterminez quand arrêter la lecture à partir des champs de pagination, sans supposer qu’il existe au moins une page. Aucun curseur ni tri secondaire par identifiant d’enregistrement n’est exposé. Conservez les identifiants d’enregistrement pour rapprocher les résultats de pages qui se chevauchent.

Accès aux documents et confidentialité

Les entrées de la boîte de réception contiennent des métadonnées privées relatives aux communications téléphoniques et aux documents. Limitez les accès dans votre application et évitez de consigner les réponses complètes dans les journaux. L’affichage de la liste ne marque pas un document comme consulté. Utilisez fax_file pour télécharger un document entrant via le mécanisme de compatibilité ; celui-ci marque un enregistrement entrant existant comme consulté même si son fichier est indisponible. La boîte de réception du portail permet également d’accéder aux documents. Aucune garantie de conservation des fichiers n’a été établie.