Bien commencer

Cette documentation vous indiquera comment envoyer des sms, importer des listes de contacts ou gérer vos comptes à travers notre API. Afin de pouvoir l'utiliser, vous devez d'abord avoir un compte. Vous pouvez vous enregistrer ici. Une fois votre compte créé, nous conseillons de vous connecter à la plateforme pour mettre en place une alerte solde. Cette alerte vous permettra de recevoir un mail ou un SMS lorsque votre crédit de SMS atteindra le seuil critique que vous aurez défini (exemple : 10, 100, 500 SMS).

Notre URL de base pour toute requête est https://api.smsup.ch

Authentification

Une fois que vous avez créé un compte et un token API, vous pouvez vous authentifier à travers le header HTTP Authorization de la façon suivante


Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMTY1NiIsImlhdCI6MTUxOTEyMDg2NX0.ZnGgbDC0OI3hPm2UXyl4rxU9JlpMTMBcTJT8RVgJbtQ
        
    

Content-Types

Notre API supporte les Content-Types application/json et application/xml. Vous pouvez spécifier un Content-Type à travers le header Accept du protocol HTTP. Par défaut, notre API attend et retourne du XML.


Accept: application/json
        
      

Status de requête

Voici une liste des status de requête que notre API peut envoyer :

status Description
1 OK
-1 Erreur d'authentification
-2 Erreur XML
-3 Pas assez de crédits
-4 Delai de date incorrect
-5 Ressource non trouvée
-6 Erreur JSON
-7 Erreur de données
-8 Votre campagne est actuellement modérée
-99 Erreur inconnue

Quelques mots à propos du SMS

Combien de caractères compte un SMS ?

Un SMS compte 160 caractères, il s’agit des normes internationales. Dans les 160 caractères sont comptabilisés les espaces, la ponctuation, les lettres, les chiffres et les caractères spéciaux. Vous n’êtes cependant pas restreint à ces 160 caractères, vous pouvez très bien envoyer un message plus long mais cela sera comptabilisé, 1 SMS par tranche de 153 caractères.

Quels sont les caractères autorisés dans un SMS ?

Les caractères autorisés sont ceux définis dans la table d'encodage standard GSM-7. A l'heure actuelle, nous n'autorisons pas les caractères UTF-8, ni les tables nationales alternatives.

Quels sont les deux types de SMS professionnels ?

Bien qu’il n’y ait techniquement qu’un seul SMS, il existe une distinction séparant deux types de SMS selon leur usage et législation : le SMS d’alerte et le SMS promotionnel.
Le SMS Promotionnel est conçu pour des offres commerciales, ventes privées, cadeaux, événements commerciaux, etc. Il est autorisé uniquement entre 8h et 20h du lundi au samedi et est interdit le dimanche et les jours fériés. Pour ce type de SMS, il est obligatoire de proposer aux destinataires un mode de désabonnement car il s’agit d’offres commerciales.
Le SMS Alert est conçu pour des réunions, rassemblements, alertes météo, urgences, transactions financières, etc. Étant donné qu’il s’agit de SMS informatifs et non de SMS commerciaux, ils ne sont pas soumis à la même réglementation. Les SMS alertes peuvent être envoyés tous les jours et à toutes heures. Il n’est pas obligatoire de mettre une mention STOP pour les alertes par sms car ils n’ont pas de portée commerciale.

Le choix du SMS promotionnel ou du SMS alerte vous appartient, nous vous remercions de bien vouloir respecter ces règles. Si vous n’êtes pas sûr du type d’envoi de sms que vous souhaitez réaliser, n’hésitez pas à contacter notre service client qui sera ravi de vous aider. Sachez qu’en cas de problème dû à un non-respect de la règlementation, si vous envoyez par exemple des sms marketing comme des sms transactionnels sans mention STOP, vous serez tenu pour responsable.

Comment fonctionne le désabonnement

Fournir un moyen de désabonnement est obligatoire pour les envois de sms publicitaires et optionnel pour les SMS d’alertes. En Suisse, vous pouvez simplement ajouter un lien de désabonnement à la fin de chaque message. Les destinataires pourront ainsi facilement se désabonner en cliquant sur ce lien. En France, si l’expéditeur du SMS n’est pas personnalisé, un numéro à 5 chiffres sera affiché comme expéditeur lors de la réception du sms. Les destinataires pourront ainsi répondre directement « STOP » à ce numéro, c'est pourquoi une mention STOP n’est pas ajoutée automatiquement. Dans le cas où l’expéditeur est personnalisé, une mention STOP s’ajoutera obligatoirement à la fin du message pour que le destinataire puisse se désabonner (exemple : 'STOP SMS au 36173'). Il est important de noter que chaque pays possède ses propres règles concernant l'expéditeur, n'hésitez donc pas à nous contacter pour tout savoir sur le pays vers lequel vous voulez envoyer. Avec la mise en place du nouveau règlement européen sur la protection des données personnelles, le RGPD, assurez-vous de n’envoyer vos campagnes sms marketing qu’à des clients ayant donné leur consentement explicite pour les recevoir et de toujours fournir un moyen de désabonnement. Dans tous les cas, vous pouvez utiliser la balise <-stop-> pour insérer un message (ou lien selon le pays) de désabonnement. Notre API se chargera de convertir la balise automatiquement.

Comment fonctionne la réponse aux envois de SMS ?

Pour recevoir les réponses, vous ne devez pas personnaliser l'expéditeur. Par ailleurs, les réponses ne sont pas disponibles dans tous les pays. Elles sont par exemple disponibles en France, en Belgique, et en Suisse. Si les réponses sont autorisées dans le pays vers lequel vous envoyez, vous pouvez créer un webhook pour les recevoir.

Comment fonctionne la personnalisation d'expéditeur ?

Comme énoncé plus tôt, chaque pays possède ses propres règles. Par exemple, pour la France et la Suisse, l'expéditeur peut contenir jusqu'à 11 caractères alphanumeriques (aucun caractère spécial autorisé). Souvenez-vous que si l'expéditeur est personnalisé, vos contacts ne peuvent pas répondre. L'expéditeur ne peut pas être personnalisé pour la Belgique. Pour la Suisse, un expéditeur par défaut se mettra automatiquement s'il n’est pas personnalisé, afin de pouvoir recevoir les réponses. Il est également bon de noter que certains modèles de téléphones comme les iPhones sont connus pour ne pas être capable d'afficher correctement les senders de 3 caractères et moins.

A quoi servent les liens courts ?

Ajouter une URL à votre message peut être pratique mais prendrait bien trop de caractères. Les liens courts vous permettent d'insérer votre lien de 18 à 20 caractères. De plus, cela vous permet également de suivre les clics afin que vous puissiez savoir quand et à quel rythme vos contacts cliquent.

Quel format les numéros des contacts doivent-ils avoir lorsqu’une liste est créée ?

Lorsqu’une liste de contacts est créée, les numéros doivent être intégrés au format international E.164 (exemple: 41781234567). Attention tout sms envoyé est facturé par les opérateurs, une liste mise à jour vous permettra d’éviter des dépenses inutiles. Pensez donc à supprimer les faux numéros (numéros trop courts ou trop longs) mais également les numéros que ne sont plus attribués.

Combien de temps les données sont-elles conservées ?

Nous permettons à nos clients de choisir la durée de conservations de leurs données. Il est donc possible de personnaliser la durée de conservation des messages, des campagnes, des listes de contacts et des sondages sur notre plateforme ou à travers l'API. Que vous choisissiez ou non de personnaliser la conservation de vos données, sachez que nous ne pouvons les conserver indéfiniment : un délai maximum est dans tous les cas imposé. Pensez donc à supprimer les faux numéros (numéros trop courts ou trop longs) mais également les numéros que ne sont plus attribués.