API Merci Facteur /sendCourrier : Valider l'envoi d'un courrier vers un ou plusieurs destinataires

Base URL API Merci Facteur https://www.merci-facteur.com/api/1.2/prod/service

Endpoint API Merci Facteur https://www.merci-facteur.com/api/1.2/prod/service/sendCourrier

← Retour à la liste des endpoints de l'API Merci Facteur

POST /sendCourrier — Valider l'envoi d'un courrier vers un ou plusieurs destinataires

ATTENTION, cette opération génère un courrier qui sera débité de votre compte, imprimé et posté. Pour effectuer vos tests d'intégration, n'hésitez pas à contacter notre service client pour ouvrir un compte "Sandbox".

Paramètres

Nom	In	Type	Description
`ww-service-id`	header	string	Votre service Id
`ww-access-token`	header	string	Un access token valide

Request body

Request body requis

application/x-www-form-urlencoded

Propriété Type Description

idUser integer user ID de l'utilisateur qui envoi le courrier

modeEnvoi string Mode d'envoi du courrier : suivi, lrar, lrare, ou normal pour les envois papier. ere_otp_mail ou ere_otp_sms pour les recommandés électroniques.

adress object Les Id des adresses d'expéditeur et de destinataire (1 expéditeur, 1 ou plusieurs destinataires). OU directement les adresses dans un objet si vous ne souhaitez pas utiliser le carnet d'adresses (plus d'infos ici : https://github.com/MerciFacteur/Merci-facteur-API#format-des-adresses-lors-de-lenvoi-dun-courrier-).

Propriété	Type	Description
`exp`	string	Indiquez ici l'id de l'expéditeur OU un object contenant directement l'adresse de l'expéditeur.
`dest`	array<string>	Indiquez ici un tableau avec les ID des destinataires OU un tableau d'objects contenant directement les adresses des destinataires.

dateEnvoi string Date d'envoi souhaitée du courrier. Si vide ou non spécifié, l'envoi sera fait le jour même (ou le jour ouvrable suivant). Doit être au format AAAA-MM-JJ et doit être une date non passée.

designation string Facultatif, 50 caractères maximum, la designation sera reprise sur votre interface Merci facteur pro dans le listing de vos courriers afin de faciliter vos recherches. Pour les envois recommandés élécroniques (ERE) la designation sera présente dans l'email envoyé à votre destinataire

anonymize object Facultatif, permet de demander la suppression d\'éléments du courrier un certain délai (en nombre de jours) après l\'impression du courrier. A utiliser si vous ne souhaitez pas que les données des courriers soient conservées sur les serveurs de Merci Facteur. Exemple de valeur : {"delay":15,"target":["content","exp","dest"]} (plus d\'infos ici : https://github.com/MerciFacteur/Merci-facteur-API/#anonymisation)

Propriété	Type	Description
`delay`	integer	Délai en nombre de jours (min. 1, max. 400) à compter de l'impression, après lesquels vous souhaitez que l'anonymisation ai lieu.
`target`	array<string>	Indiquez dans un tableau les éléments à anonymiser/supprimer : ["content","exp","dest"].
Items: Valeurs autorisées : `exp`, `dest`, `content`

content object Contenu du courrier à envoyer

Propriété Type Description

letter object Définition du contenu de la lettre, envoyer une chaine vide si pas de lettre dans ce courrier (='')

Propriété	Type	Description
`files`	array<string>	vide, ou tableau du/des url fichier(s) (PDF pour les lettres, JPEG pour les photos) à envoyer

`base64files`	array<string>	vide, ou tableau du/des fichier(s) (PDF pour les lettres, JPEG pour les photos) à envoyer, convertis en base64

`final_filename`	string	Facultatif, maximum 50 caractères, vous pouvez spécifier le nom de fichier que vous souhaitez pour votre lettre. Ne mettez pas d''extension, '.pdf' sera ajouté à la fin. Il sera visible dans votre interface Merci facteur Pro pour faciliter vos recherches. Dans le cas d'envois recommandés électroniques (ERE), ce nom de fichier sera visible par le destinataire.
`print_sides`	string	rectoverso si vous souhaitez une impression recto/verso, ou recto si vous souhaitez une impression recto simple, ou distinctrectoverso si vous souhaitez une impression recto/verso et que nous insérions une page blanche après les fichiers au nombre de pages impair.

photo object Définition de photos, envoyer une chaine vide si pas de photo dans ce courrier (='')

Propriété	Type	Description
`files`	array<string>	vide, ou tableau du/des url fichier(s) (PDF pour les lettres, JPEG pour les photos) à envoyer

`base64files`	array<string>	vide, ou tableau du/des fichier(s) (PDF pour les lettres, JPEG pour les photos) à envoyer, convertis en base64

`tokenLibrary`	string	vide, ou token contenant les photos à envoyer (token retourné par /uploadFile)

card object Définition du contenu de la carte, envoyer une chaine vide si pas de carte dans ce courrier (='')

Propriété Type Description

format string Format de la carte : postcard, naked-postcard, classic, folded, large, large-a4

visuel object Informations concernant le visuel de la carte

Propriété	Type	Description
`type`	string	Type de visuel : customimg ou base64
`value`	string	Si type=customimg, alors value=url de l'image du visuel. Si type=base64, alors value=fichier de l'image du visuel converti en base64. (voir spécifications de l'image dans la documentation)

text object Informations concernant le texte de la carte

Propriété	Type	Description
`type`	string	Type de visuel : html (code html), base64 (image), customimg (image)
`value`	string	Si type=html, alors value=html contenant le texte à imprimer sur le dos la carte. Si type=base64, alors value=une base64 contenant une image à imprimer sur le dos de la carte. Si type=customimg, alors value=une URL d'une image à imprimer sur le dos de la carte.

coin string Type de coins de la carte (arrondi ou carre)

papier string Type de papier de la carte (classic, nacre ou creation)

Réponses

HTTP 200 — Objet contenant le résumé des envois qui ont été validés

application/json

Propriété Type Description

success boolean true si HTTP 200, sinon false

error string le code d'erreur en cas d'erreur

envoi_id array<integer> L'Id de cet envoi

price object Détail du montant facturé

Propriété Type Description

total object

Propriété	Type	Description
`ht`	string	Montant total HT
`ttc`	string	Montant total TTC

detail object

Propriété	Type	Description
`affranchissement`	string	Montant total de l'affranchissement (ht, tva=0)
`letter`	string	Montant total du contenu lettres (ht, tva=tx standard)
`card`	string	Montant total du contenu cartes (ht, tva=tx standard)

resume object Résumé du contenu de l'envoi

Propriété	Type	Description
`nb_dest`	integer	Nombre de destinataires (= nombre de courriers générés)
`nb_page`	integer	Nombre de page(s) décomptées(s) par destinataire

account object Etat de votre compte après cet envoi

Propriété Type Description

pages object Nombre de pages envoyées dans le mois

Propriété	Type	Description
`thisMonth`	integer	Nombre de pages envoyées ce mois-ci.
`maxMonth`	integer	Nombre maximum de pages que vous pouvez envoyer ce mois-ci.

HTTP 400 — Erreur (code d'erreur dans l'entête)

application/json

Propriété Type Description

success boolean true si HTTP 200, sinon false

error object Objet contenant les infos de l'erreur.

Propriété	Type	Description
`code`	string	le code d'erreur en cas d'erreur
`text`	string	le message d'erreur correspondant

HTTP 401 — Erreur authentification (code d'erreur dans l'entête : token invalide ou expiré, service-id incorrecte, IP non autorisée)

application/json

Propriété Type Description

success boolean true si HTTP 200, sinon false

error object Objet contenant les infos de l'erreur.

Propriété	Type	Description
`code`	string	le code d'erreur en cas d'erreur
`text`	string	le message d'erreur correspondant