Différences

Ci-dessous, les différences entre deux révisions de la page.

--- index [2019/01/22 10:55]
novadmin
+++ index [2022/05/24 16:50] (Version actuelle)
novadmin
@@ Ligne 18: / Ligne 18: @@
 {{::status-sms.jpg|}}
 \\ \\
-==== 2.1 Modèles de SMS ====
+==== 2.2 Modèles de SMS ====
 Les modèles de SMS peuvent être utiles pour créer un SMS et le réutiliser plusieurs fois lors des créations de campagnes.
 Un modèle de SMS peut être créé en cliquant sur le bouton "Ajouter" ou durant la création de campagnes en sauvegardant le message en tant que modèle dans l’édition du contenu du message.\\
@@ Ligne 111: / Ligne 111: @@
 le pictogramme {{::export-stats.jpg}} et les statistiques du jour, si disponibles, s’affichent en cliquant sur la date.
+{{:capture.jpg?400|}}
 ==== 5.2 Listes ====
@@ Ligne 219: / Ligne 221: @@
 \\ \\
 ===== 1. PREAMBULE =====
-L'interface HTTP SmsPush permet l'envoi de SMS à l'unité ou en masse par appel d'une requête http.\\ \\
+L'interface HTTP FASTSMS permet l'envoi de SMS à l'unité ou en masse par appel d'une requête http.\\ \\
 \\ \\
 Avec l'API d'envoi, vous disposez des fonctionnalités suivantes :\\ \\
@@ Ligne 230: / Ligne 232: @@
 Les sms sont acheminés via des connexions directes aux opérateurs.
 \\ \\
-Pour utiliser l'API, vous devez disposer d'un compte SmsPush (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 :\\ \\
@@ Ligne 241: / Ligne 243: @@
 ===== 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.\\ \\
 \\ \\
+**#Whitelist IP**
+A l'inverse, pour les flux sortant concernent l’émission des SMS, vous pouvez vous aussi restreindre nos IP si vous le souhaitez:
+•             Si aucune restriction n’est mise en place sur les IPs sortantes : Les SMS partiront.
+•             Une restriction est mise en place chez vous : il faut ajouter les plages d’IP suivantes > 109.3.194.192/27 et 149.7.0.128/27
 ===== 3. DESCRIPTION DES CONNECTEURS D’ENVOIS =====
 ==== 3.1. Compte d'envoi ====
@@ Ligne 260: / Ligne 271: @@
 \\ \\
 Exemple :\\ \\
-[[https://smspush.novadial.fr/api?accountid=mycompany&password=mypassword&text=hello&route_type=G&to=0612345678|https://smspush.novadial.fr/api?accountid=mycompany&password=mypassword&text=hello&route_type=G&to=0612345678</nowiki>]]
+[[https://fastsms.novadial.fr/api?accountid=mycompany&password=mypassword&text=hello&route_type=G&to=0612345678|https://fastsms.novadial.fr/api?accountid=mycompany&password=mypassword&text=hello&route_type=G&to=0612345678</nowiki>]]
 \\ \\
 Paramètres optionnels :\\ \\
@@ Ligne 267: / Ligne 278: @@
   * ret_id : votre identifiant interne du SMS
 \\ \\
-[[https://smspush.novadial.fr/api?accountid=mycompany&password=mypassword&text=hello&sender=MYCOMPANY&route_type=G&ret_url=http://sms.mycompany.com&ret_id=101&to=0612345678|https://smspush.novadial.fr/api?accountid=mycompany&password=mypassword&text=hello&sender=MYCOMPANY&route_type=G&ret_url=http://sms.mycompany.com&ret_id=101&to=0612345678]]
+[[https://fastsms.novadial.fr/api?accountid=mycompany&password=mypassword&text=hello&sender=MYCOMPANY&route_type=G&ret_url=http://sms.mycompany.com&ret_id=101&to=0612345678|https://fastsms.novadial.fr/api?accountid=mycompany&password=mypassword&text=hello&sender=MYCOMPANY&route_type=G&ret_url=http://sms.mycompany.com&ret_id=101&to=0612345678]]
 \\ \\
 Le numéro de message “push_id” est renvoyé en réponse.\\ \\
@@ Ligne 274: / Ligne 285: @@
 ==== 3.3. Connecteurs d'envoi de masse (multi-destinataires) ====
 Méthode de soumission de l'envoi :\\ \\
-Le client envoie une requête HTTP en POST sur https://smspush.novadial.fr/api en passant comme argument une variable nommé « xml » contenant directement le fichier XML à traiter (xml=).\\ \\
+Le client envoie une requête HTTP en POST sur https://fastsms.novadial.fr/api en passant comme argument une variable nommé « xml » contenant directement le fichier XML à traiter (xml=).\\ \\
 En cas de succès, le résultat de requête contient l’identification unique du push “push_id” qui pourra être utilisé pour la récupération des statistiques.
 \\ \\
@@ Ligne 319: / Ligne 330: @@
 |stop_time	| heure de fin d’envoi de message, après cette heure les messages ne sont plus envoyés. Les envois reprennent le lendemain à start_time si la valeur est définie.|
 |sender	        | nom de l’émetteur (optionnel, 11 caractères alpha-numériques maxi, doit débuter par une lettre)  |
-|ret_model	| Précise si le contenu du message texte est une référence à un modèle ou bien un message complet (valeur Y pour yes ou N pour no). Si cette valeur est Y, il faut qu'un modèle soit défini dans l'interface SmsPush, et qu'on référence ce modèle par son nom.|
+|ret_model	| Précise si le contenu du message texte est une référence à un modèle ou bien un message complet (valeur Y pour yes ou N pour no). Si cette valeur est Y, il faut qu'un modèle soit défini dans l'interface FastSMS, et qu'on référence ce modèle par son nom.|
 \\ \\
 __Utilisation de "class_type"__
@@ Ligne 410: / Ligne 421: @@
 * au fil de l'eau, envoi sur l'url indiquée dans le paramètre ret_url\\ \\
 * par téléchargement sur l'extranet\\ \\
-* à la demande, par appel du web-service Smspush\\ \\
+* à la demande, par appel du web-service Fastsms\\ \\
 \\ \\
 === 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 : 149.7.0.131, 149.7.0.154 et 149.7.0.155.
+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 :\\
+Site Principal
+ * 109.3.194.192/27
+ * 149.7.0.128/27
+Site de secours
+ * 130.117.8.112/28
+ * 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>
@@ Ligne 437: / Ligne 458: @@
 Vous pouvez également consulter les statistiques quotidiennes d'envoi API et télécharger les accusés de réception sur l'extranet, rubrique “Statistiques”, sous-rubrique “Envois automatiques”.
 \\ \\
-Url de l'extranet : [[https://smspush.novadial.fr|https://smspush.novadial.fr]]
+Url de l'extranet : [[https://fastsms.novadial.fr|https://fastsms.novadial.fr]]
 \\ \\
 Statistiques dans les Envois automatiques
@@ Ligne 465: / Ligne 486: @@
   * ERROR_UNKNOWN=>16 (autres erreurs)
 \\ \\
-=== 3.4.3 A la demande, par appel du web-service Smspush ===
+=== 3.4.3 A la demande, par appel du web-service Fastsms ===
 Il est possible d’appeler l'API pour connaître le statut individuel d’un message. Cette fonctionnalité doit être réservée à un emploi ponctuel (pas d’appel récurent tant que l’accusé n’est pas disponible).\\
 \\ \\
-La requête se fait en appelant : <code>https://smspush.novadial.fr/status?id=<push_id></code>
+La requête se fait en appelant : <code>https://fastsms.novadial.fr/status?id=<push_id></code>
 \\ \\
 L’identifiant passé en paramètre est le push_id, renvoyé par le serveur dans la réponse quand il est sollicité pour l’envoi.
@@ Ligne 489: / Ligne 510: @@
 Exemple :\\
-https://smspush.novadial.fr/status?id=126427588 renvoie :\\
+https://fastsms.novadial.fr/status?id=126427588 renvoie :\\
 <nowiki>
 <statuses>
@@ Ligne 503: / Ligne 524: @@
 Les SMS MO de réponse peuvent vous être envoyés sur l'url de votre choix en GET. Cette url doit-être paramétrée à la création de votre compte. Elle peut contenir un début de chaine de paramètres.\\ \\
-Les IP à autoriser chez vous sont : 149.7.0.131, 149.7.0.154 et 149.7.0.155. \\ \\
+Les IP à autoriser chez vous sont : 149.7.0.131, 149.7.0.154, 149.7.0.155, 149.7.0.141 et 109.3.194.205. \\ \\
 En cas de timeout de votre url, il y a 2 tentatives de ré-émission à intervalle d'une minute chacune.\\ \\
@@ Ligne 529: / Ligne 550: @@
 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).\\
+  * 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 =====
@@ Ligne 534: / Ligne 583: @@
 Il est possible de contrôler le crédit restant via l'API avant d’envoyer le message.\\
-<code>https://smspush.novadial.fr/credits?accountid=mycompany&password=mypassword</code>
+<code>https://fastsms.novadial.fr/credits?accountid=mycompany&password=mypassword</code>
 \\
 La réponse est un contenu XML :\\
@@ Ligne 620: / Ligne 669: @@
 ==== 9.1 Description du service MailtoSMS qui fonctionne en lien avec l’API SMS ====
-La passerelle Mail2sms envoie par SMS le contenu d'un message routé par e-mail sur une adresse définie, en l’occurrence : mail2sms@novadial.mobi\\
+La passerelle Mail2sms envoie par SMS le contenu d'un message routé par e-mail sur une adresse définie par nos équipes lors de la création de votre compte\\
 Le contenu de l’e-mail doit respecter un format spécifique décrit ci-après. La passerelle utilise l'API d'envoi de masse standard pour l'envoi du SMS.\\
 \\ \\
-Pour utiliser le mailtosms en production, Novadial devra d’abord activer le service sur votre compte SMS.
+Pour utiliser le mailtosms en production, Novadial devra d’abord activer le service sur votre compte SMS et vous délivrer l'adresse email à laquelle il faudra envoyer votre message.
 \\ \\
 ==== 9.2 Format de l’e-mail ====
@@ Ligne 643: / Ligne 692: @@
   * Message : texte du SMS
   * ;*+-/;/   :  délimiteur de fin de la chaîne utile au traitement
-\\ \\
+\\
+Pour envoyer à plusieurs destinataires, les numéros doivent être séparés par une virgule dans la variable Phone.
+\\
 ==== 9.3 Format du message et de la signature ====
@@ Ligne 652: / Ligne 703: @@
 Notre support est disponible du lundi au vendredi de 9h à 12h et de 14h à 18h, vous pouvez envoyer un email directement à [[support@novadial.org]] qui créera automatiquement un ticket sur notre outil de support.
-Pour créer un compte et retrouver l'historique de vos demandes de supports, cliquez sur ce lien : https://prod.novadial.fr/tickets/account.php?do=create
+Si vous souhaitez créer un compte afin de retrouver l'historique de vos demandes de supports, cliquez sur ce lien : https://prod.novadial.fr/tickets/account.php?do=create