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 [2019/02/07 08:53] novadmin |
index [2022/05/24 16:50] (Version actuelle) novadmin |
||
---|---|---|---|
Ligne 18: | Ligne 18: | ||
{{::status-sms.jpg|}} | {{::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. | 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.\\ | 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. | 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 ==== | ==== 5.2 Listes ==== | ||
Ligne 232: | 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 241: | 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.\\ \\ |
\\ \\ | \\ \\ | ||
+ | |||
+ | **#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. DESCRIPTION DES CONNECTEURS D’ENVOIS ===== | ||
==== 3.1. Compte d'envoi ==== | ==== 3.1. Compte d'envoi ==== | ||
Ligne 414: | 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 |
+ | * 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> | <code>http://sms.mycompany.com?push_id=<push_id>&ret_id=<ret_id>&to=<to>&text=<text>&status=<status></code> | ||
Ligne 509: | 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 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.\\ \\ | En cas de timeout de votre url, il y a 2 tentatives de ré-émission à intervalle d'une minute chacune.\\ \\ | ||
Ligne 535: | 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 ===== | ||
Ligne 626: | Ligne 669: | ||
==== 9.1 Description du service MailtoSMS qui fonctionne en lien avec l’API SMS ==== | ==== 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.\\ | 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 ==== | ==== 9.2 Format de l’e-mail ==== | ||
Ligne 649: | Ligne 692: | ||
* Message : texte du SMS | * Message : texte du SMS | ||
* ;*+-/;/ : délimiteur de fin de la chaîne utile au traitement | * ;*+-/;/ : 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 ==== | ==== 9.3 Format du message et de la signature ==== | ||
Ligne 658: | 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. | 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 |