Envoyer un courrier recommandé eIDAS via l'API

Afin d’envoyer un courrier recommandé eIDAS via l’API, vous devez :

• avoir créé le compte expéditeur et vous assurer que celui-ci peut payer son envoi (moyen de paiement enregistré sur son compte, rattaché à un chef d’équipe qui possède un moyen de paiement, facturation globale via l’API).
• avoir l’identité de l’expéditeur vérifiée et pouvoir l’identifier pour faire son envoi
• avoir chargé au préalable les différents documents que l’on souhaite ajouter au courrier recommandé

1. Envoyer la LRE eIDAS

Vous avez la possibilité de créer des nouveaux courriers via la route /api/mail.

Les paramètres attendus sont les suivants :

• token : votre token
• id_user : l’identifiant utilisateur AR24 qui sera l’expéditeur du courrier recommandé
• eidas : 1 pour envoyer un courrier recommandé électronique, 0 pour un envoi recommandé électronique simple
• to_lastname : nom du destinataire
• to_firstname : prénom du destinataire
• to_email : adresse email du destinataire (Dans le cas d’un envoi à un particulier, assurez-vous d’avoir obtenu la clause d’accord au préalable de l’envoi à notifier le destinataire à cette adresse email)
• dest_statut : professionnel dans le cas d’un envoi à un professionnel, particulier sinon
• content : Texte du courrier recommandé, il accompagne les pièces jointes. Du code HTML/CSS peut-être utilisé pour mettre en forme ce contenu (Par exemple : « Bonjour,<br/>vous trouverez ci-joint les documents concernant notre échange.<br/>Bien à vous »)
• to_company (uniquement si dest_statut vaut professionnel) : nom de la société du destinataire

Des paramètres optionnels sont disponibles :

• attachment : tableau d’identifiants de pièce-jointes. Les identifiants sont obtenus après avoir chargé les documents sur le compte expéditeur (Par exemple : « attachment[0] »: »123″, puis un autre paramètre « attachment[1] »: »456″)
• otp : dans le cas où votre expéditeur possède les codes OTP, il peut transmettre le code OTP au moment de l’envoi (ce paramètre n’est pas nécessaire dans le cas où l’expéditeur s’est identifié via la route /user/auth_otp) Ce champ n’est pas non plus nécessaire dans le cas d’une identification avec un certificat RGS**. Sans moyen d’identification fourni lors de l’envoi (OTP, certificat ou identification via /user/auth_otp), celui-ci ne partira pas.
• custom_name_sender : complément d’information qui apparaîtra après le nom de l’expéditeur. Par exemple : « pour le compte d’AR24 », donnera comme nom d’expéditeur : « [Prenom_du_compte] [Nom_du_compte] pour le compte d’AR24 »
• ref_dossier : référence à ajouter à l’envoi pour retrouver plus facilement celui-ci dans la liste des envois
• ref_client : référence à ajouter à l’envoi pour retrouver plus facilement celui-ci dans la liste des envois
• ref_facturation : référence à ajouter à l’envoi pour retrouver plus facilement celui-ci dans la liste des envois (visible uniquement par l’expéditeur). Permettra de générer des récapitulatifs spécifiques.
• payment_slug : si l’expéditeur possède plusieurs moyen de paiement, identifiant du moyen de paiement à utiliser pour l’envoi (à récupérer dans les informations de l’utilisateur). Si non renseigné le moyen de paiement par défaut sera utilisé
• webhook : lien qu’AR24 appellera pour chaque changement de statut du courrier. En savoir plus
• id_group : utiliser un groupe de destinataires (dans ce cas les informations concernant le destinataire ne seront pas prises en compte)
• pre_notif : envoyer un mail au destinataire, avant la notification du courrier recommandé, pour lui rappeler que dans le cadre de ses échanges avec l’expéditeur il sera amené à recevoir des LRE acheminées par AR24

Vous obtenez alors un retour de notre API avec le statut SUCCESS et les informations du courrier recommandé que vous venez de nous transmettre (notamment l’identifiant du nouveau courrier recommandé). Dans le cas d’une erreur, vous retrouverez dans le retour une explication et un slug. Vous retrouverez dans notre documentation la liste des erreurs : https://developers.ar24.fr/doc/#post-send-a-simple-or-eidas-registered-mail

2. L’évolution de mon courrier

Voici la liste des statuts possibles :

• waiting : le recommandé a bien été pris en compte par AR24 et est en cours de traitement par notre service avant l’envoi à votre destinataire.
• sent : le recommandé a été acheminé dans la boite mail de votre destinataire.
• AR : le recommandé a été accusé de réception par votre destinataire qui a maintenant accès à son contenu et à l’identité de l’expéditeur. Le courrier reste accessible pour le destinataire et l’expéditeur reçoit la preuve d’AR.
• negligence : aucune action n’a été effectuée durant les 15 jours légaux d’ouverture du recommandé. Le courrier n’est alors plus accessible pour le destinataire et l’expéditeur reçoit la preuve de négligence.
• refused : le destinataire a refusé le recommandé et n’a alors pas accès à son contenu ni à l’identité de l’expéditeur. L’expéditeur reçoit la preuve de refus.
• bounced : lors de la tentative de dépôt du courrier dans la boite mail de votre destinataire, une erreur nous est retournée par la boite mail qui nous empêche de transmettre le courrier (boîte pleine, adresse inexistante …). Par analogie au courrier recommandé papier, il s’agit du PND (Pli Non Distribuable). Le courrier n’a pas été délivré et l’expéditeur reçoit une notification par email avec l’erreur rencontrée.
• error : le recommandé n’a pas été envoyé suite à un évènement technique rare, celui-ci n’est pas facturé et vous devrez recommencer votre envoi.
• to_valid (eidas) : le recommandé a bien été pris en compte par AR24 cependant l’authentification n’a pas abouti. Le courrier est donc conservé pendant 7 jours dans la liste d’attente et l’expéditeur doit effectuer une authentification pour valider l’envoi du courrier.
• not_valided (eidas) : le recommandé placé en liste d’attente a été refusé ou n’a pas été validé dans les 7 jours, et a donc été annulé (aucun envoi n’est fait, aucune facturation n’est appliquée sur ce courrier).
• user_choice_needed (optimal) : le destinataire doit choisir s’il préfère recevoir un recommandé papier ou électronique.