Développement & intégration API

Configurer les relances par e-mail

Via notre API Yousign, il est possible de définir un message de relance différent en fonction s'il s'agit d'une relance manuelle depuis l'interface Yousign ou bien s'il s'agit d'une relance automatique (programmée périodiquement).

Pour cela, il convient de bien préciser les 2 notions liées aux "reminders" :

  • Les relances manuelles :
    • Pour définir les relances manuelles, il convient de préciser la configuration des e-mails ("config" > "email") avec le tableau de paramètres "reminder.executed".
    • Soit la configuration suivante : "config" > "email" > "reminder.executed"
  • Les relances automatiques :
    • Pour les relances automatiques, cela se trouve directement dans la partie "reminders" (en-dessous de "config" > "email") avec la définition de la fréquence et du nombre d'itérations qu'il y aura, suivi de la même façon du tableau de paramètres "reminder.executed".
    • Soit la configuration suivante : "config" > "reminders" > "reminder.executed"

Voyons ensemble un exemple concret :


config: {
    "email": {
        "procedure.finished": [
            {
                "subject": "Félicitations, la procédure de signature est terminée !",
                "message": "Bonjour,<br /><br />Nous vous informons que vos documents sont désormais signés.<br /><br />{{ components.button(\"Accéder aux documents\", url) }}<br /><br />Le Centre d'aide Yousign",
                "to": [
                    "@creator",
                    "@members.auto"
                ],
                "fromName": "@creator"
            }
        ],
        "member.started": [
            {
                "subject": "Yousign - Vous êtes invité à signer des documents",
                "message": "Bonjour,<br />Vous trouverez ci-dessous le lien permettant de signer vos documents.<br /><br />{{ components.button(\"Accéder aux documents\", url) }}<br /><br />Le Centre d'aide Yousign",
                "to": [
                    "@member"
                ],
                "fromName": "@creator"
            }
        ],
        "reminder.executed": [
            {
                "subject": "Relance (manuelle) Yousign - Rappel de signature des documents",
                "message": "Bonjour,<br><br>Vous n'avez toujours pas signé vos documents.<br /><br />{{ components.button(\"Accéder aux documents\", url) }}<br /><br />Le Centre d'aide Yousign",
                "to": [
                    "@members.auto"
                ],
                "fromName": "@creator"
            }
        ]
    },
    reminders: [
        {
            interval: 5,
            limit: 3,
            config: {
                email: {
                    'reminder.executed': [
                        {
                            "subject": "Relance (automatique) Yousign - Rappel de signature des documents",
                            "message": "Bonjour,<br><br>Vous n'avez toujours pas signé vos documents.<br /><br />{{ components.button(\"Accéder aux documents\", url) }}<br /><br />Le Centre d'aide Yousign",
                            "to": [
                                "@members.auto"
                            ],
                            "fromName": "@creator"
                        }
                    ]
                }
            }
        },
    ]
}

Vous pouvez facilement distinguer les relances manuelles des relances automatique à l'aide de l'objet de l'e-mail envoyé ("subject").

Cet article vous a-t-il été utile ?
Utilisateurs qui ont trouvé cela utile : 0 sur 0