Bien commencer avec notre API SMS
Bienvenue chez SMSFactor ! Cette documentation vous indiquera comment envoyer des SMS, importer des listes de contacts ou gérer vos comptes à travers notre API. Suivez le guide pour une intégration API SMS rapide et efficace !
Dans cette documentation, retrouvez toutes les fonctionnalités phares de notre API d'envoi de SMS :
- webhooks pour récupérer et stocker les données liées à vos envois ;
- simulation d’envois pour tester vos configurations et automatisations ;
- insertion de liens courts tracés pour informer ou générer du trafic ;
- réception des réponses SMS et des accusés de réception ;
- gestion automatique des désabonnements.
A noter : Notre URL de base pour toute requête est https://api.smsfactor.com
1. Créez un compte SMSFactor
Afin de pouvoir utiliser notre API d’envoi de SMS, vous devez d'abord avoir un compte.
Vous pouvez vous enregistrer ici.
2. Configurez votre compte
Une fois votre compte créé, quelques manipulations sont nécessaires pour vous permettre de faire vos premiers envois de SMS par API. Voici un détail des manipulations dont vous pourriez avoir besoin.
| Manipulation | Type de manipulation | Fonctionnement |
|---|---|---|
| Création de votre token API | OBLIGATOIRE | Afin de pouvoir vous authentifier, il vous faut en premier lieu créer un token API unique. |
| Achat de crédits | OBLIGATOIRE | Afin de pouvoir faire vos premiers envois, il vous faut vous munir d’un pack SMS, à acheter directement sur la plateforme SMSFactor. |
| Configuration de la facturation mensuelle | RECOMMANDE | Si vous estimez un volume mensuel d’envoi de SMS supérieur à 3000 SMS, n’hésitez pas à nous contacter pour bénéficier de la facturation mensuelle. |
| Enregistrement de votre/vos expéditeurs | RECOMMANDE | Dépendant du pays vers lequel vous prévoyez de faire vos envois, l’enregistrement d’expéditeur peut-être obligatoire. Vous trouverez les règles relatives ici. |
| Configuration d’une alerte solde | RECOMMANDE | 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). |
| Renseignement du numéro de TVA | SI NECESSAIRE | Action nécessaire si vous opérez dans un pays de l’union européenne. Afin de pouvoir accéder à l’achat de crédits SMS, ajoutez votre numéro de TVA à votre compte (si applicable dans votre pays). |
| Création de vos sous-comptes | SI NECESSAIRE | Si besoin, vous pouvez créer des sous-comptes qui auront leurs propres crédits SMS. |
| Demande d’autorisation d’envoi à l’international | SI NECESSAIRE | Si vous avez besoin d’envoyer des SMS dans un autre pays que celui depuis lequel vous avez créé votre compte, il vous faut effectuer une demande d’autorisation d’envoi à l’international. |
3. Authentifiez-vous
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
4. Sélectionnez votre content type
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
5. Faites un test d’envoi de SMS par API
Grâce à nos exemples de code, faites un envoi test en quelques clics pour vérifier que la connexion est bien établie et que votre outil est prêt à utiliser notre API SMS
Choisissez votre ligne de code à copier coller :
Vous pouvez également utiliser nos SDKs pour une mise en place éclair :
6. Configurez toutes les fonctionnalités dont vous avez besoin
Afin de pouvoir tirer profit de toutes les possibilités offertes par l’envoi de SMS via API, sélectionnez les fonctionnalités qui vous sont nécessaire !
De l’envoi de SMS à la mise en place de webhooks en passant par la gestion des listes de contacts et la facturation... Tout est simplifié grâce à notre documentation API !
Voici une liste de certaines fonctionnalités clés que vous pourrez retrouver dans notre documentation :
- Envoi de messages : configurez l’envoi de messages unitaires, de campagnes avec ou sans liste, ajoutez des liens courts tracés et simulez vos envois.
- Campagnes : gérez l’historique, la programmation, les STOPs, les NPAIs et les réponses de vos campagnes.
- Listes : créez, nettoyez, récupérez et supprimez vos listes. gérez également votre blacklist et votre liste de NPAI.
- Webhooks : récupérez par API vos accusés réception, réponses, STOPs, cliqueurs et votre alerte solde.
7. Familiarisez-vous avec les statuts de requête
Pour un suivi précis de vos envois de SMS par API, prenez connaissance des différents statuts de requête que notre API SMS peut vous 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 |
8. Familiarisez-vous avec nos systèmes anti -fraude anti-flood
Notre API dispose d'un filtre anti-fraude et d'un filtre anti-flood.
Si une de vos campagnes passe par l'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ée.
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é.