Configuration des rappels d’opérations

  • Mis à jour le Jul 28, 2025
  • Publié le Nov 18, 2024
  • 10 Minute(s) lue(s)
Prev Next

Java SDK .NET SDK REST API APEX SDK

Java SDK

Pour télécharger l’exemple de code complet, consultez notre site Code Share .

En définissant un calendrier de rappel, un expéditeur peut choisir quand et à quelle fréquence informer un signataire d’une signature en attente, en plus de la notification initiale envoyée au moment où la transaction est envoyée pour signature. En d’autres termes, en supposant que la transaction n’est pas encore terminée, un nombre personnalisable de notifications peut être envoyé avec un intervalle spécifié entre chacune d’elles pour rappeler à votre signataire qu’une signature est requise.

Les e-mails de rappel sont envoyés à l’aide d’une tâche cron, qui est déclenchée toutes les heures à xx :30. Cela signifie que si l’envoi d’un rappel est prévu à 7h26, il sera envoyé dans le cadre de la tâche cron à 7h30.

Création d’un calendrier de rappel

Pour créer un objet ReminderSchedule , vous devez transmettre votre objet packageId en tant que paramètre au ReminderScheduleBuilder, ainsi que les paramètres adaptés à vos besoins.

Comme vous avez besoin d’un packageId pour définir votre calendrier de rappel, vous devrez le faire APRÈS avoir créé la transaction, mais AVANT de l’envoyer. Donc, si vous utilisez la méthode createAndSendPackage() pour envoyer vos paquets, vous devrez la diviser.

Notez ce qui suit :

  • withDaysUntilFirstReminder() : Cette méthode vous permet d’attendre un certain nombre de jours avant d’envoyer le premier rappel. Cela n’affectera pas la notification initiale envoyée au moment où votre transaction est envoyée pour signature.

  • withDaysBetweenReminders() : Cette méthode définit la fréquence de vos rappels.

  • withNumberOfRepetitions() : Cette méthode définit le nombre de rappels que OneSpan Sign enverra à vos signataires, avec un maximum de 5 rappels.

Une fois que vous avez créé votre objet ReminderTime , utilisez le service de rappel OneSpan Sign pour créer votre calendrier de rappel. Pour ce faire, le code suivant :

 ReminderSchedule reminderScheduleToCreate = ReminderScheduleBuilder.forPackageWithId(packageId)   .withDaysUntilFirstReminder(1)   .withDaysBetweenReminders(1)   .withNumberOfRepetitions(5)   .build();   eslClient.getReminderService().createReminderScheduleForPackage(reminderScheduleToCreate);

Mise à jour d’un calendrier de rappel

Une fois que vous avez envoyé votre transaction pour signature, vous pouvez mettre à jour votre calendrier de rappel. Pour ce faire, créez un nouvel objet ReminderSchedule à l’aide de différents paramètres, puis utilisez à nouveau le service de rappel OneSpan Sign pour mettre à jour votre calendrier de rappel. Pour ce faire, le code suivant :

eslClient.getReminderService().updateReminderScheduleForPackage(reminderScheduleToUpdate) ;

Récupération d’un calendrier de rappel

Vous pouvez également récupérer votre objet ReminderSchedule en appelant le service de rappel OneSpan Sign. En faisant cela, vous recevrez également tous les rappels qui ont été envoyés à vos signataires, sous forme de liste. Pour ce faire, le code suivant :

 ReminderSchedule reminderSchedule = client.getReminderService().getReminderScheduleForPackage(packageId);   List<Reminder> reminders = reminderSchedule.getReminders();   for (Reminder reminder : reminders) {   System.out.println(reminder.getSentDate());   }

Suppression d’un calendrier de rappel

Pour supprimer votre calendrier de rappel, vous utilisez de nouveau le service de rappel OneSpan Sign. Pour ce faire, le code suivant :

 eslClient.getReminderService().clearReminderScheduleForPackage(packageId);

Résultats

Voici un exemple de ce que vous pouvez vous attendre à voir une fois que vous avez exécuté votre code.

Voici un exemple d’e-mail de rappel qui sera envoyé à vos signataires :

Voici un exemple de ce à quoi ressemble la liste des rappels :

Kit de développement logiciel (SDK) .NET

Pour télécharger l’exemple de code complet, consultez notre site Code Share .

En définissant un calendrier de rappel, un expéditeur peut choisir quand et à quelle fréquence informer un signataire d’une signature en attente, en plus de la notification initiale envoyée au moment où la transaction est envoyée pour signature. En d’autres termes, en supposant que la transaction n’est pas encore terminée, un nombre personnalisable de notifications peut être envoyé avec un intervalle spécifié entre chacune d’elles pour rappeler à votre signataire qu’une signature est requise.

Les e-mails de rappel sont envoyés à l’aide d’une tâche cron, qui est déclenchée toutes les heures à xx :30. Cela signifie que si l’envoi d’un rappel est prévu à 7h26, il sera envoyé dans le cadre de la tâche cron à 7h30.

Création d’un calendrier de rappel

Pour créer un objet ReminderSchedule , vous devez transmettre votre objet packageId en tant que paramètre au ReminderScheduleBuilder, ainsi que les paramètres adaptés à vos besoins.

Comme vous avez besoin d’un packageId pour définir votre calendrier de rappel, vous devrez le faire APRÈS avoir créé la transaction, mais AVANT de l’envoyer. Donc, si vous utilisez la méthode createAndSendPackage() pour envoyer vos paquets, vous devrez la diviser.

Notez ce qui suit :

  • withDaysUntilFirstReminder() : Cette méthode vous permet d’attendre un certain nombre de jours avant d’envoyer le premier rappel. Cela n’affectera pas la notification initiale envoyée au moment où votre transaction est envoyée pour signature.

  • withDaysBetweenReminders() : Cette méthode définit la fréquence de vos rappels.

  • withNumberOfRepetitions() : Cette méthode définit le nombre de rappels que OneSpan Sign enverra à vos signataires, avec un maximum de 5 rappels.

Une fois que vous avez créé votre objet ReminderTime , utilisez le service de rappel OneSpan Sign pour créer votre calendrier de rappel. Pour ce faire, le code suivant :

 ReminderSchedule reminderScheduleToCreate = ReminderScheduleBuilder.ForPackageWithId(packageId)   .WithDaysUntilFirstReminder(1)   .WithDaysBetweenReminders(1)   .WithNumberOfRepetitions(5)   .Build();   eslClient.ReminderService.CreateReminderScheduleForPackage(reminderScheduleToCreate);

Mise à jour d’un calendrier de rappel

Une fois que vous avez envoyé votre transaction pour signature, vous pouvez mettre à jour votre calendrier de rappel. Pour ce faire, créez un nouvel objet ReminderSchedule à l’aide de différents paramètres, puis utilisez à nouveau le service de rappel OneSpan Sign pour mettre à jour votre calendrier de rappel. Pour ce faire, le code suivant :

 eslClient.ReminderService.UpdateReminderScheduleForPackage(reminderScheduleToUpdate);

Récupération d’un calendrier de rappel

Vous pouvez également récupérer votre objet ReminderSchedule en appelant le service de rappel OneSpan Sign. En faisant cela, vous recevrez également tous les rappels qui ont été envoyés à vos signataires, sous forme de liste. Pour ce faire, le code suivant :

 ReminderSchedule createdReminderSchedule = eslClient.ReminderService.GetReminderScheduleForPackage(packageId);   List<Reminder> reminders = createdReminderSchedule.Reminders;   foreach (Reminder reminder in reminders)   {   Debug.WriteLine(reminder.SentDate);   }

Suppression d’un calendrier de rappel

Pour supprimer votre calendrier de rappel, vous utilisez de nouveau le service de rappel OneSpan Sign. Pour ce faire, le code suivant :

 eslClient.ReminderService.ClearReminderScheduleForPackage(packageId);

Résultats

Voici un exemple de ce que vous pouvez vous attendre à voir une fois que vous avez exécuté votre code.

Voici un exemple d’e-mail de rappel qui sera envoyé à vos signataires :

Voici un exemple de ce à quoi ressemble la liste des rappels :

REST API

Pour télécharger l’exemple de code complet, consultez notre site Code Share .

En définissant un calendrier de rappel, un expéditeur peut choisir quand et à quelle fréquence informer un signataire d’une signature en attente, en plus de la notification initiale envoyée au moment où la transaction est envoyée pour signature. En d’autres termes, en supposant que la transaction n’est pas encore terminée, un nombre personnalisable de notifications peut être envoyé avec un intervalle spécifié entre chacune d’elles pour rappeler à votre signataire qu’une signature est requise.

Les e-mails de rappel sont envoyés à l’aide d’une tâche cron, qui est déclenchée toutes les heures à xx :30. Cela signifie que si l’envoi d’un rappel est prévu à 7h26, il sera envoyé dans le cadre de la tâche cron à 7h30.

Vous pouvez créer un calendrier de relance en faisant la demande suivante :

Requête HTTP

POST /api/packages/{packageId}/reminders

En-têtes HTTP

Accept: application/json   
Content-Type: application/json   
Authorization: Basic api_key

Charge utile de la demande

 {
	"startInDaysDelay": 1,
	"repetitionsCount": 5,
	"intervalInDays": 1,
	"packageId": "{packageId}"
}

Pour une description complète de chaque champ, consultez le tableau Charge utile de la demande ci-dessous.

Charge utile de réponse

 {
	"startInDaysDelay": 1,
	"repetitionsCount": 5,
	"intervalInDays": 1,
	"reminders": [],
	"packageId": "{packageId}"
}

Pour créer un objet ReminderSchedule , vous devez transmettre votre objet packageId en tant que paramètre au ReminderScheduleBuilder, ainsi que les paramètres adaptés à vos besoins.

Notez ce qui suit :

  • startInDaysDelay : cet objet vous permet d’attendre un certain nombre de jours avant d’envoyer le premier rappel. Cela n’affectera pas la notification initiale envoyée au moment où vous avez envoyé votre transaction pour signature.

  • intervalInDays : Cet objet définit la fréquence de vos rappels.

  • repetitionsCount : Cet objet définit le nombre de rappels que OneSpan Sign enverra à vos signataires, avec un maximum de 5 rappels.

Pour définir un calendrier de rappel, votre colis doit être en DRAFT.

Mise à jour d’un calendrier de rappel

Une fois que vous avez envoyé votre transaction pour signature, vous pouvez mettre à jour votre calendrier de rappel en envoyant une requête PUT à l’URL de base, en utilisant différents paramètres.

Requête HTTP

PUT /api/packages/{packageId}/reminders

En-têtes HTTP

Accept: application/json   
Content-Type: application/json   
Authorization: Basic api_key

Charge utile de la demande

 {
	"startInDaysDelay": 2,
	"repetitionsCount": 5,
	"intervalInDays": 3,
	"packageId": "{packageId}"
}

Charge utile de réponse

 {
	"startInDaysDelay": 2,
	"repetitionsCount": 5,
	"intervalInDays": 3,
	"reminders": [],
	"packageId": "{packageId}"
}

Récupération d’un calendrier de rappel

Vous pouvez récupérer votre calendrier de rappel en envoyant une requête GET à l’URL de base. En faisant cela, vous recevrez également tous les rappels qui ont été envoyés à votre ou vos signataires.

Requête HTTP

GET /api/packages/{packageId}/reminders

En-têtes HTTP

Accept: application/json   
Content-Type: application/json   
Authorization: Basic api_key

Charge utile de réponse

{
	"packageId": "ebfcf18f-7bbc-4ff6-a5db-6352dbbfa9f6",
	"startInDaysDelay": 2,
	"repetitionsCount": 5,
	"intervalInDays": 2,
	"reminders": [{
		"sentDate": "2016-02-26T00:30:02Z",
		"date": "2016-02-25T16:53:13Z"
	}, {
		"sentDate": "2016-02-27T00:30:03Z",
		"date": "2016-02-26T16:53:13Z"
	}, {
		"sentDate": "2016-02-28T00:30:01Z",
		"date": "2016-02-27T16:53:13Z"
	}, {
		"sentDate": "2016-02-29T00:30:02Z",
		"date": "2016-02-28T16:53:13Z"
	}, {
		"sentDate": null,
		"date": "2016-02-29T16:53:13Z"
	}, {
		"sentDate": null,
		"date": "2016-03-01T16:53:13Z"
	}]
}

Suppression d’un calendrier de rappel

Pour supprimer votre calendrier de rappels, faites une demande DELETE :

Requête HTTP

DELETE /api/packages/{packageId}/reminders

En-têtes HTTP

Accept: application/json   
Content-Type: application/json   
Authorization: Basic api_key

Résultats

Voici un exemple de ce que vous pouvez vous attendre à voir une fois que vous avez exécuté votre code.

Voici un exemple d’e-mail de rappel qui sera envoyé à vos signataires :

Tableau des données utiles de la demande

Propriété

Type

Modifiable

Obligatoire

Faire défaut

Exemples de valeurs

startInDaysDelay

entier

Oui

Non

n/a

1 / 2 / 3 ...

répétitionsCount

entier

Oui

Non

n/a

1 / 2 / 3 ...

intervalleInDays

entier

Oui

Non

n/a

1 / 2 / 3 ...

packageId

corde

Oui

Non

n/a

0ab0_b0jzotEqdXx9NJ-pzhJJ1c=

APEX SDK

Pour télécharger l’exemple de code complet, consultez notre site Code Share .

En définissant un calendrier de rappel, un expéditeur peut choisir quand et à quelle fréquence informer un signataire d’une signature en attente, en plus de la notification initiale envoyée au moment où la transaction est envoyée pour signature. En d’autres termes, en supposant que la transaction n’est pas encore terminée, un nombre personnalisable de notifications peut être envoyé avec un intervalle spécifié entre chacune d’elles pour rappeler à votre signataire qu’une signature est requise.

Les e-mails de rappel sont envoyés à l’aide d’une tâche cron, qui est déclenchée toutes les heures à xx :30. Cela signifie que si l’envoi d’un rappel est prévu à 7h26, il sera envoyé dans le cadre de la tâche cron à 7h30.

La fonction suivante vous permettra d’ajouter un calendrier de rappel à une transaction existante.

 public void createReminderScheduleForPackage(String packageId,Integer startInDaysDelay,Integer repetitionsCount,Integer intervalInDays)

Comme vous avez besoin d’un packageId pour définir votre calendrier de rappel, vous devrez le faire APRÈS avoir créé la transaction, mais AVANT de l’envoyer.

Notez ce qui suit :

  • startInDaysDelay : Ce paramètre vous permet d’attendre un certain nombre de jours avant d’envoyer le premier rappel. Cela n’affectera pas la notification initiale envoyée au moment où votre transaction est envoyée pour signature.

  • intervalInDays : Ce paramètre définit la fréquence de vos rappels.

  • repetitionsCount : Ce paramètre définit le nombre de rappels que OneSpan Sign enverra à vos signataires, avec un maximum de 5 rappels.

Mise à jour d’un calendrier de rappel

Une fois que vous avez envoyé votre transaction pour signature, vous pouvez mettre à jour votre calendrier de rappel. Pour ce faire, le code suivant :

 public void updateReminderScheduleForPackage(String packageId,Integer startInDaysDelay,Integer repetitionsCount,Integer intervalInDays)

Récupération d’un calendrier de rappel

Vous pouvez également récupérer votre ReminderSchedule . En faisant cela, vous recevrez également tous les rappels qui ont été envoyés à vos signataires, sous forme de liste. Pour ce faire, le code suivant :

 public TestReminders.ReminderSchedule getReminderScheduleForPackage(String packageId)

En faisant cela, vous recevrez également tous les rappels qui ont été envoyés à vos signataires, sous forme de liste.

 TestReminders.ReminderSchedule reminderSchedule = getReminderScheduleForPackage(packageId);   List reminders = reminderSchedule.reminders;   for(TestReminders.Reminder reminder: reminders){   System.Debug('set date: ' + reminder.date_x + '; sent date: ' + reminder.sentDate);   }

Suppression d’un calendrier de rappel

Pour supprimer votre calendrier de rappels, utilisez le code suivant :

 public void clearReminderScheduleForPackage(String packageId)

Résultats

Vous pouvez exécuter cette fonction dans Exécuter la fenêtre anonyme à partir de la Developer Console et saisir :

 new TestReminders().testReminders();

Voici un exemple de ce que vous pouvez vous attendre à voir une fois que vous avez exécuté votre code.

Voici un exemple d’e-mail de rappel qui sera envoyé à vos signataires :

Voici un exemple de ce à quoi ressemble la liste des rappels :