Plusieurs destinataires

Envoyer le même message à plusieurs personnes en un seul appel. Chaque destinataire reçoit son propre lien et, si vous utilisez le SMS, son propre code ; un mot de passe éventuel est le même pour tous.

Prérequis

Un client configuré et vos identifiants chargés : voir Identifiants et environnements. L'envoi lui-même fonctionne comme pour un seul destinataire : voir Envoyer un message.

Exemple

Passez la liste des destinataires, puis parcourez la réponse : elle contient une réponse par destinataire, avec son propre statut et son numéro de suivi.

var recipients = new List<RecipientInfo>
{
    new RecipientInfo { Email = "destinataire1@example.com" },
    new RecipientInfo { Email = "destinataire2@example.com" },
    new RecipientInfo { Email = "destinataire3@example.com" }
};

var args = new MutliRecipientArgs(
    endPointUri: endpoint, serial: serial, user: apiUser, psw: apiPassword,
    recipients: recipients, message: message, subject: subject,
    password: null, filesList: null,
    sendMode: SendMethodEnum.onlyEmail, getBackHtml: false,
    showSubject: true, getNotify: false,   // pas de notification à chaque ouverture
    cultureID: "fr-CA", maximumOpenTime: 5, minutesExpiration: 10080);

var response = MessageHelper.MultiRecipientMessage(args);
if (response.Status != 200)
    throw new InvalidOperationException($"Envoi refusé, statut {response.Status}");

foreach (var ra in response.RecipientsAnswer)
{
    if (ra.Answer?.Status == 200)
        EnregistrerSuivi(ra.Recipient.Email, ra.Answer.TrackingID);   // votre propre fonction
    else
        SignalerEchec(ra.Recipient.Email, ra.Answer?.Status);         // votre propre fonction
}

recipients = [
    RecipientInfo(email="destinataire1@example.com"),
    RecipientInfo(email="destinataire2@example.com"),
    RecipientInfo(email="destinataire3@example.com"),
]

answer = MessageHelper.multi_recipient_message(
    api_client=client, sems_client=sems_client,
    serial=serial, api_user=api_user, api_password=api_password,
    recipients=recipients, message=message, subject=subject,
    get_back_html=False, get_notify=False,  # pas de notification à chaque ouverture
    culture_id="fr-CA", maximum_open_time=5,
)
if answer.status != 200:
    raise RuntimeError(f"Envoi refusé, statut {answer.status}")

for ra in answer.recipients_answer:
    if ra.answer and ra.answer.status == 200:
        enregistrer_suivi(ra.recipient.email, ra.answer.tracking_id)  # votre propre fonction
    else:
        signaler_echec(ra.recipient.email, ra.answer.status if ra.answer else None)

$recipients = [
    new RecipientInfo(email: 'destinataire1@example.com'),
    new RecipientInfo(email: 'destinataire2@example.com'),
    new RecipientInfo(email: 'destinataire3@example.com'),
];

$answer = MessageHelper::multiRecipientMessage(
    apiClient: $client, semsClient: $sems,
    serial: $serial, apiUser: $apiUser, apiPassword: $apiPassword,
    recipients: $recipients, message: $message, subject: $subject,
    getBackHtml: false, getNotify: false,   // pas de notification à chaque ouverture
    cultureId: 'fr-CA', maximumOpenTime: 5,
);
if ($answer->status !== 200) {
    throw new RuntimeException('Envoi refusé, statut ' . $answer->status);
}

foreach ($answer->recipientsAnswer as $ra) {
    if ($ra->answer !== null && $ra->answer->status === 200) {
        enregistrerSuivi($ra->recipient->email, $ra->answer->trackingId);   // votre propre fonction
    } else {
        signalerEchec($ra->recipient->email, $ra->answer->status ?? null);
    }
}

À savoir

Point	Détail
Un lien par destinataire	Chaque destinataire reçoit son propre lien, et son propre code s'il est envoyé par SMS.
Mot de passe	S'il y en a un (`password`), il est le même pour tous les destinataires.
Statut par destinataire	Vérifiez le statut global, puis celui de chaque destinataire : un envoi peut réussir pour certains et échouer pour d'autres.
Numéro de suivi	Conservez-le pour chaque destinataire : il sert à consulter les journaux ou à supprimer le message.
Notifications	Avec `getNotify` à true, vous êtes averti à chaque ouverture. Pour un envoi à beaucoup de destinataires, passez-le à false.

Attention

Ne journalisez pas les liens. Le lien remis à un destinataire donne accès au message : ne l'écrivez ni dans vos journaux ni dans une base de données. Gardez plutôt le numéro de suivi. L'adresse du destinataire est un renseignement personnel : protégez-la comme telle.

Erreurs fréquentes

Symptôme	Cause probable	Solution
Statut global 200, mais un destinataire n'a rien reçu	Échec pour ce destinataire seulement	Vérifiez son statut dans la réponse, puis son adresse.
Statut 400	Liste de destinataires vide, ou adresse invalide	Vérifiez la liste avant l'envoi.
Statut 401 ou 403	Identifiants ou licence	Voir Codes de statut.