Documentation détaillée
Généralités
Authentification
Étapes de création d'un envoi e-mail
Étapes de création d'un envoi SMS
Nouveautés
administration du compte
contacts
abonnements
consentements
groupes d'intérêts
intérêts
champs
imports - mapping
imports de contacts
variables
ciblages
lois ciblages
critères ciblages
plannings
e-mail - adresses d'expéditeurs
e-mail - adresses de réponses
e-mail - liens de messages
e-mail - messages
e-mail - envois
e-mail - envois transactionnels
e-mail - A/B test
sms - expéditeurs
sms - messages
exports - mappings
exports - colonnes
exports - filtres
exports
statistiques
hébergement
webhooks
connexions distantes
consentements - dépréciées
imports de contacts - dépréciées
Powered by Stoplight
post

/sms/sendings/transactional

Crée un envoi SMS transactionnel immédiat ou différé, pour un destinataire unique présent ou pas dans votre base de contacts.

Par défaut, l’option des envois transactionnels SMS n’est pas activée sur les comptes Campaign. Rapprochez-vous de votre référent commercial pour demander son activation.

Un envoi SMS transactionnel est constitué des 5 éléments suivants :

  • 1 type d’envoi (*) : TransactionalMarketing pour une communication à but marketing (recommandations produits, offres promotionnelles etc.) ou TransactionalService pour un envoi de service (renouvellement de mot de passe, confirmation de commande etc.)
  • 1 contact (*) constitué par :
    • les champs de la clé d’unicité (*) du compte (souvent l’e-mail) pour identifier le contact (voir “exemple simple” dans la section Request Body ci-dessous). Si le contact n’existe pas, il sera créé automatiquement dans la base de contacts mais non accessible via le moteur de recherche s’il a fait seulement l’objet d’envois transactionnels de service TransactionalService.
    • le champ du numéro de mobile (*) du compte (ID = 44), obligatoire si le contact n’est pas déjà présent en base ou si son numéro de mobile n’est pas renseigné, avec plusieurs formats possibles :
    • les champs optionnels de la base de contacts utilisés pour la personnalisation des messages (voir “exemple avec personnalisation” dans la section Request Body ci-dessous). Si le contact est présent dans la base, ses informations seront mises à jour, sinon elles seront ajoutées.
  • les propriétés du message SMS constituées par :
    • Name (*) : le nom du message SMS (256 caractères maximum). S’il n’est pas existant sur votre compte, il sera créé automatiquement avec l’ensemble des autres propriétés du message. S’il est déjà présent, ses propriétés existantes seront récupérées par défaut et éventuellement mises à jour avec les nouvelles informations transmises dans cette méthode.
    • CultureName : la langue du message SMS (exemple : fr-FR ou en-EN etc.).
    • SenderID (*) : l’identifiant de l’expéditeur du du message SMS.
    • ForceHttp : force le tracking http non sécurisé (True/False).
  • le contenu du message SMS MessageContent avec :
    • SourceCode (*) : le contenu texte du message SMS (voir “exemple avec création d’un message” dans la section Request Body ci-dessous).
  • Date et heure de planification de l’envoi : ScheduleDate au format ISO 8601. Vous pouvez décaler un envoi SMS transactionnel jusqu’à maximum J+3 aprés l’appel à cette méthode. Si ScheduleDate n’est pas passé en entrée de cette méthode, l’envoi transactionnel sera déclenché immédiatement. La personalisation du message SMS est réalisée avec les informations du contact enregistrées en base au moment de l’envoi.

(*) : paramètres obligatoires et nécessaires à l’envoi transactionnel

L’API permet différents usages :

  • envoyer un message SMS existant : utiliser un message SMS préalablement paramétré sur la plateforme. Si tous les paramètres obligatoires (*) sont déjà renseignés dans le message SMS, vous pouvez générer l’envoi en spécifiant seulement le nom exact du message dans le paramètre Name. Consulter la méthode de récupération du contenu d’un message SMS pour récupérer le nombre de caractères GSM ou le nombre d’unités SMS que représentera votre message lors d’un envoi.
  • envoyer un message complet : envoyer directement toutes les propriétés du message SMS ainsi que son contenu texte en entrée de la méthode. Votre message sera créé, sauvegardé et réutilisable pour de prochains envois. Pour cela, spécifier un nouveau nom de message en entrée de la méthode et ajouter tous les paramètres nécessaires à l’envoi dans le corps de la requête. A noter, si vous créez un nouveau message SMS dans le cadre d’un envoi transactionnel horodaté, celui-ci sera expédié et/ou personnalisé avec les informations du contact adressé au moment de l’envoi, et non à la création du message.

Conseils et bonnes pratiques

Selon le règlement de la CNIL, l’envoi de SMS transactionnels n’est pas soumis à une plage horaire d’adressage particulière.

Pour personnaliser votre message SMS, vous pouvez intégrer dans votre contenu des variables de champs de contacts qui seront automatiquement interprétées et remplacées par le système au moment de l’envoi par les données en base (voir “exemple avec création d’un message” dans la section Request Body ci-dessous). Vous pouvez personnaliser votre message SMS avec les informations contenues dans les champs du contact.

Le STOP SMS est facultatif dans le cadre d’envois transactionnels SMS. Toutefois, si votre message intègre une notion marketing (recommandations produits, offres promotionnelles, etc.), il est fortement recommandé de conserver cette méthode de désabonnement. Cette bonne pratique vous assurera une meilleure délivrabilité et une meilleure expérience utilisateur pour vos contacts qui auront le choix de ne plus recevoir ce type de communication s’ils le désirent.

Tous les nouveaux contacts qui feront l’objet d’un envoi SMS transactionnel de type TransactionalMarketing seront enregistrés dans la base de contacts et seront adressables dans de futurs envois (envoi SMS marketing groupés et/ou transactionnels). En revanche, les nouveaux contacts qui feront l’objet d’un envoi transactionnel de type TransactionalService ne seront pas visibles dans la base de contacts et ne pourront pas être réutilisés depuis la plateforme pour de futurs envois marketing.

Il est recommandé de réutiliser, autant que possible, les mêmes messages SMS afin de pouvoir bénéficier des statistiques agrégées dans vos rapports d’envois SMS transactionnels.

En cas de succès, la méthode renverra une chaîne de caractères Result correspondant à l’identifiant unique de l’envoi transactionnel TransactionID (GUID de longueur fixe de 36 caractères avec des tirets) qu’il est fortement recommandé de stocker car nécessaire à la récupération des propriétés de l’envoi SMS transactionnel.

Dernière mise à jour : Février 2021

Authorization

apiKey - X-API-Key

Request Parameters

1 Query Parameter
1 Header

Request Body

4 Examples
Schema
object

Sending management

TransactionalSending
object

TransactionalSmsSending

Responses

Success

Schema
object

PostResult

ID
integer
2 validations

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
X-API-Key