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 créer un compte ici.

Notre URL de base pour toutes requêtes 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 Erreur dans la liste de contacts
-6 Erreur JSON
-7 Erreur de données
-8 Votre campagne est actuellement modérée
-99 Erreur inconnue

Quelques mots à propos du 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.

L’expéditeur peut être modifié dans la limite de 11 caractères. Cette personnalisation ne doit pas contenir de caractères spéciaux. Attention lorsque vous personnalisez l’expéditeur, vous rendez impossible toute possibilité de réponse. Il est également possible de personnaliser le sender vers la Suisse, mais impossible de le faire pour la Belgique.

Il existe deux types de SMS : Alerte et Promotionnel.
Le SMS Promotionnel est conçu pour des offres commerciales, ventes privées, cadeaux, événements commerciaux, etc. Les SMS promotionnels sont autorisés uniquement entre 8h et 22h du lundi au samedi et sont interdits le dimanche et les jours fériés. Il faut absolument proposer aux destinataires un mode de désabonnement pour ce type de SMS car il s’agit d’offres commerciales. Si vous personnalisez l’expéditeur, la mention STOP s’ajoutera obligatoirement à la fin de votre message.
Etant donné que cette mention comprend 16 caractères, il vous restera alors 144 caractères pour ce type de SMS avec l’expéditeur modifié.
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 la mention STOP pour les SMS alertes car il n’y a pas de portée commerciale derrière.

Le choix du SMS promotionnel ou du SMS alerte vous appartient, nous vous remercions de bien vouloir respecter ces règles.