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
Statut 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. Ce statut ne signifie pas que votre SMS ne partira pas, au contraire. Il vous indique juste que votre campagne est en train d'être modérée et devrait partir très vite. Il est donc inutile d'appliquer un mécanisme de retry au risque d'envoyer des doublons. |
| -99 | Erreur inconnue |
Anti-Fraude et anti-flood
Notre API dispose d'un filtre anti-fraude et d'un filtre anti-flood.
Si une de vos campagnes passe par le anti-fraude, elle sera soumise à une validation manuelle de la part de notre équipe. En cas de contenu frauduleux, nous nous reservons le droit de refuser votre campagne, dans ce cas, elle ne sera pas envoyé et les crédits vous seront remboursés.
Notre API dispose d'un filtre anti-flood. Il s'agit d'un nombre maximum de SMS envoyé sur un même numéro de téléphone sur 1 heure. Il existe deux limites : le nombre de SMS envoyé sur un numéro de téléphone et le nombre de SMS envoyé avec le même contenu sur un numéro de téléphone. Si vous dépassez ces limites, nous bloquerons l'envoi de SMS sur ce numéro pendant 1 heure, aucun crédit ne vous sera décompté.