Différences
Ci-dessous, les différences entre deux révisions de la page.
Les deux révisions précédentes Révision précédente Prochaine révision | Révision précédente | ||
index [2021/05/04 15:17] novadmin [9.1 Description du service MailtoSMS qui fonctionne en lien avec l’API SMS] |
index [2022/05/24 16:50] (Version actuelle) novadmin |
||
---|---|---|---|
Ligne 234: | Ligne 234: | ||
Pour utiliser l'API, vous devez disposer d'un compte FastSMS (couple login/password) avec l'option API activée. Cette option est activée au préalable par Novadial. | Pour utiliser l'API, vous devez disposer d'un compte FastSMS (couple login/password) avec l'option API activée. Cette option est activée au préalable par Novadial. | ||
\\ \\ | \\ \\ | ||
- | Avec le même compte, vous accédez à l'extranet de gestion des campagnes qui permet de consulter les statistiques d'envoi et de télécharger les accusés de réception. | + | Avec un compte nominatif, vous accédez à l'extranet de gestion des campagnes qui permet de consulter les statistiques d'envoi et de télécharger les accusés de réception. |
\\ \\ | \\ \\ | ||
Nombre de caractères des SMS :\\ \\ | Nombre de caractères des SMS :\\ \\ | ||
Ligne 243: | Ligne 243: | ||
===== 2. PRE-REQUIS TECHNIQUES ===== | ===== 2. PRE-REQUIS TECHNIQUES ===== | ||
\\ \\ | \\ \\ | ||
- | Il est possible de restreindre l’accès au service SMS par adresse IP. Vous pouvez ainsi communiquer à Novadial votre ou vos adresses IP publiques afin que Novadial les autorise.\\ \\ | + | Il est nécessaire de restreindre l’accès au service SMS par adresse IP. Vous devez ainsi communiquer à Novadial votre ou vos adresses IP publiques afin que Novadial les autorise.\\ \\ |
\\ \\ | \\ \\ | ||
Ligne 425: | Ligne 425: | ||
=== 3.4.1 Au fil de l'eau, envoi sur l'url indiquée dans le paramètre ret_url === | === 3.4.1 Au fil de l'eau, envoi sur l'url indiquée dans le paramètre ret_url === | ||
\\ \\ | \\ \\ | ||
- | Notre serveur appelle l'url indiquée dans le paramètre ret_url à chaque changement d’état du SMS. Les IP à autoriser chez vous sont :\\ | + | Notre serveur appelle l'url indiquée dans le paramètre ret_url à chaque changement d’état du SMS. |
- | - 130.117.8.116\\ | + | Les IP à autoriser chez vous sont :\\ |
- | - 130.117.8.118\\ | + | Site Principal |
- | - 130.117.8.114\\ | + | * 109.3.194.192/27 |
- | - 149.7.0.131\\ | + | * 149.7.0.128/27 |
- | - 149.7.0.154\\ | + | |
- | - 149.7.0.155 | + | Site de secours |
- | - 149.7.0.141 | + | * 130.117.8.112/28 |
- | - 109.3.194.205 | + | * 130.117.9.128/28 |
- | \\ | + | * 85.90.54.192/28 |
\\ \\ | \\ \\ | ||
<code>http://sms.mycompany.com?push_id=<push_id>&ret_id=<ret_id>&to=<to>&text=<text>&status=<status></code> | <code>http://sms.mycompany.com?push_id=<push_id>&ret_id=<ret_id>&to=<to>&text=<text>&status=<status></code> | ||
Ligne 549: | Ligne 550: | ||
Le désabonnement du fichier d'envoi est sous la responsabilité de l'utilisateur de la plateforme d'envoi.\\ | Le désabonnement du fichier d'envoi est sous la responsabilité de l'utilisateur de la plateforme d'envoi.\\ | ||
Vous devez donc mettre en œuvre à votre niveau les procédures de désabonnement nécessaires (en utilisant l'url de réponse ou par tout autre canal de relation avec vos abonnés).\\ | Vous devez donc mettre en œuvre à votre niveau les procédures de désabonnement nécessaires (en utilisant l'url de réponse ou par tout autre canal de relation avec vos abonnés).\\ | ||
+ | |||
+ | * Récupération des réponses au format CSV | ||
+ | Pour récupérer les réponses (dont les STOP) correspondant à un envoi via l’API, il est nécessaire de faire un appel au webservice « answer » avec le ret_id du push. | ||
+ | Dans notre exemple avec https://fastsms.novadial.fr comme root url : | ||
+ | https://fastsms.novadial.fr/answer.php?accountid=fred&password=xpasswordx&ret_id=12345&start_date=2017-03-10 | ||
+ | |||
+ | Ce WebService est prévu pour être utilisé après une campagne pour en récupérer les STOPS. | ||
+ | Il peut être pénalisant si on cherche sur une plage de date trop importante. | ||
+ | Aussi dans tous les cas, la recherche ne s’effectue que sur les 40 derniers jours. | ||
+ | |||
+ | Paramètres | ||
+ | |||
+ | {{:capture_d_ecran_2022-05-24_164615.png?nolink&400|}} | ||
+ | |||
+ | Le fichier généré est au format CSV et contient les colonnes suivantes : | ||
+ | |||
+ | {{:capture_d_ecran_2022-05-24_164731.png?nolink&400|}} | ||
+ | |||
+ | * Récupération des réponses par url de retour | ||
+ | Si l’utilisateur répond au SMS (STOP), le contenu du SMS est renvoyé à l’url de gestion des retours, soit celle explicitement positionnée dans l’appel, soit celle configurée par défaut dans le BO du compte. | ||
+ | Dans notre exemple c’est http://myaddress.com/TreatMO.php | ||
+ | |||
+ | Donc cette url est appelé en http au format GET avec tous les paramètres positionnés par la plate-forme. | ||
+ | |||
+ | Ci-dessous les paramètres principaux, les plus utiles. | ||
+ | |||
+ | |||
+ | {{:capture_d_ecran_2022-05-24_165005.png?nolink&400|}} | ||
\\ \\ | \\ \\ | ||
===== 5. CONTROLE DU CREDIT RESTANT VIA API ===== | ===== 5. CONTROLE DU CREDIT RESTANT VIA API ===== |