1Fonctionnement
Introduction
Notre API fonctionne sur le protocole HTTP(S), elle accepte des requêtes de type POST ou GET (encodées en UTF-8) et répond au format JSON. Elle est donc utilisable par tous langages capables d'effectuer une requête HTTP(S) et d'interpréter le JSON comme le PHP, ASP, Python, Java...
Pour utiliser le protocole sécurisé HTTPS, il vous suffit de modifier "http://" par "https://" dans l'adresse des pages appelées.
Important : Pour utiliser notre API envoi SMS vous devez avoir un compte client Spot-Hit (Créez un compte gratuitement). Le paramètre "key" doit être renseigné à chaque requête. Il correspond à une clé unique à récupérer sur votre compte (différente de votre mot de passe) : Récupérer ma clé API
Si vous rencontrez des problèmes lors de l'utilisation de cette API SMS, n'hésitez pas à nous contacter, vous serez mis en relation avec notre équipe technique.
Valeurs de retour
Après chaque requete effectuée, vous recevrez une réponse formatée en JSON sous le format suivant :
{resultat: [X], id: [identifiant unique de la campagne] ou erreurs: [numéro d'erreur]}Exemple de requete acceptée :
{resultat: 1, id: 1337}Exemple requete rejetée :
{resultat: 0, erreurs: 1,4,2}Exemple d'utilisation avec PHP (POST et GET)
Envoi d'un SMS avec la méthode HTTP POST (cURL doit être installé) :
<?php
// Données du message
$data = array(
'key' => 'fe01ce2a7fbac8fafaed7c982a04e229',
'destinataires' => '+33600000000',
'type' => 'premium',
'message' => 'Hello World !',
'expediteur' => 'Spot-Hit',
'date' => '',
);
// Initialisation de cURL avec l'URL à appeler
$ch = curl_init('https://www.spot-hit.fr/api/envoyer/sms');
// Paramètres cURL pour activer le POST et retour de la réponse
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, 1);
// Passage des données
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data, '', '&'));
// Appel de l'API Spot-Hit et récupération de la réponse dans la variable $responseJson
$responseJson = curl_exec($ch);
curl_close($ch);
// Conversion JSON en tableau avec json_decode (http://fr2.php.net/manual/fr/function.json-decode.php)
$responseArray = json_decode($responseJson, true);
// Si 'resultat' == 1, le message a été envoyé correctement
if ($responseArray['resultat']) {
echo 'Message envoyé avec succès ! Identifiant unique : '.$responseArray['id'].'';
} else {
echo 'Erreur(s) : '.$responseArray['erreurs'].'';
}
Envoi d'un SMS avec la méthode HTTP GET (file_get_contents) :
Attention : le nombre de caractères dans une URL est limitée, pour effectuer des envois à un nombre important de destinataires (> 100) ou avec d'autres contenus longs (par exemple un email html), vous devez utiliser la méthode POST mentionnée ci-dessus.
Le paramètre PHP allow_url_fopen doit être activé avec "1".
<?php
// Données du message
$data = array(
'key' => 'fe01ce2a7fbac8fafaed7c982a04e229',
'destinataires' => '+33600000000',
'type' => 'premium',
'message' => 'Hello World !',
'expediteur' => 'Spot-Hit',
'date' => '',
);
// Conversion des données en paramètre pour une URL
// http://fr2.php.net/manual/fr/function.urlencode.php
foreach ($data as $parametre => $valeur) {
$requete .= $parametre.'='.urlencode($valeur).'&';
}
// Appel de l'API Spot-Hit et récupération de la réponse dans la variable $responseJson
$responseJson = file_get_contents('https://www.spot-hit.fr/api/envoyer/sms?'.$requete);
// Conversion JSON en tableau avec json_decode
// http://fr2.php.net/manual/fr/function.json-decode.php
$responseArray = json_decode($responseJson, true);
// Si 'resultat' == 1, le message a été envoyé correctement
if ($responseArray['resultat']) {
echo 'Message envoyé avec succès ! Identifiant unique : '.$responseArray['id'];
} else {
echo 'Erreur(s) : '.$responseArray['erreurs'];
}
2Envoyer
Nous utilisons le fuseau horaire d'Europe Centrale (Paris) : UTC+1 en heure d'hiver / UTC+2 en heure d'été
Envoyer un SMS
URL à appeler : https://www.spot-hit.fr/api/envoyer/sms
Liste des paramètres de l'API SMS
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| message | Limité à 160 caractères (ou voir paramètre smslong). Attention : Les caractères |, ^, €, }, {, [, ~, ] et \ comptent doubles.Dans une requête de type GET, utiliser le caractère \n pour effectuer un retour à la ligne.Les caractères %0A, <br>, <br />, <br/> et \n sont automatiquement remplacés par un retour à la ligne.SMS Personnalisé : {Nom de la colonne}, exemple : {Nom} |
| destinataires | Liste de numéros de vos destinataires (tableau ou séparé par un retour à la ligne ou une virgule) ex : +33600000000,003360-00-00-00 , 6 00 00 00 00 |
| expediteur |
Optionnel 11 caractères maximum (espaces inclus) Si vide, l'expéditeur de votre SMS sera un numéro court à 5 chiffres auxquels vos destinataires peuvent répondre. L’expéditeur doit comporter un minimum de 3 caractères pour être personnalisé et ne doit pas commencer par plus de 3 chiffres consécutifs avant la première lettre. L'affichage de l'expéditeur dépend du type de téléphone. Par exemple, sur certains iPhone les espaces sont supprimés. Par ailleurs, les accents et caractères spéciaux ne sont jamais pris en compte. France métropolitaine L'opérateur NRJ Mobile ne prend pas en compte les expéditeurs personnalisés, ils seront automatiquement remplacés par un numéro court. Afin d'éviter toute confusion pour vos destinataires, il est préférable de préciser le nom de votre boutique également dans le corps du message. International Certains pays n'acceptent pas la personnalisation de l'expéditeur. Il est fortement conseillé de prendre contact avec nous afin de connaître les spécificités de chaque pays concerné. Les destinataires ne pourront pas répondre au SMS lors d'envois hors France & DOM-TOM. |
| date | Optionnel Date d'envoi du message (format timestamp) Si aucune date n'est entrée ou si celle-ci précède la date actuelle, le message sera envoyé immédiatement |
| smslong | Optionnel Si égal à "1", autorise l'envoi de SMS supérieur à 160 caractères. Un SMS vous sera facturé tous les 153 caractères. Exemple : pour un message de 300 caractères à 1000 destinataires, 2000 SMS vous seront débités. Maximum 5 SMS concaténés (soit 765 caractères). |
| smslongnbr | Optionnel Permet de vérifier la taille du SMS long envoyé. Vous devez envoyer le nombre de SMS concaténés comme valeur. Si notre compteur nous indique un nombre différent, votre message sera rejeté. |
| tronque | Optionnel Si égal à "1", tronque automatiquement le message à 160 caractères. |
| encodage | Optionnel si égal à "auto", conversion de votre message en UTF-8 (il est conseillé de convertir votre message en UTF-8 dans votre application cependant si votre message reste coupé après un caractère accentué, vous pouvez activer ce paramètre). si égal à "ucs2", conversion de votre message en unicode (cous pouvez utiliser des caractères supplémentaires comme « ê » qui n'est pas pris en compte en SMS standard, ainsi qu'inclure des emojis. Attention : Le nombre de caractères est limité à 70, et 67 en SMS Long.) |
| nom | Optionnel Cette information non visible par les destinataires vous permet d’identifier votre campagne (maximum 255 caractères). |
| destinataires_type | Optionnel Permet la sélection de contacts déjà enregistrés sur le compte client : « all » = sélection de tous les contacts du compte. « groupe » = sélection de tous les contacts des groupes fournis dans le champs « destinataires » (un tableau contenant les identifiants des groupes est requis) « datas » = permet d'ajouter des données personnalisées aux « destinataires » pour les utiliser dans votre message (exemple : "Bonjour {nom} {prenom}"), pour ce faire il faut que le champs « destinataires » soit un tableau de cette forme : array("+33600000001" => array("nom" => "Nom 1", "prenom" => "Prénom 1"), "+33600000002" => array("nom" => "Nom 2", "prenom" => "Prénom 2") ...) |
| url | Optionnel Adresse URL de votre serveur pour la réception en "push" des statuts après l'envoi. Vous devez déjà avoir une adresse paramétrée sur votre compte pour activer les retours "push". Si ce paramètre est renseigné, cette URL sera appelée pour cet envoi sinon l'adresse du compte est utilisée. |
| date_debut | Optionnel, obligatoire pour l'envoi échelonné Date de début d'envoi des messages (format timestamp) |
| date_fin | Optionnel, obligatoire pour l'envoi échelonné Date de fin d'envoi des messages (format timestamp) |
| creneaux | Optionnel, obligatoire pour l'envoi échelonné Heure(s) d'envois Tableau avec 8,9,10,11,12,13,14,15,16,17,18,19 La campagne sera fractionnée proportionnellement aux nombres de créneaux entre le jour et l'heure de démarrage, et le jour et l'heure de fin souhaitée. |
| creneaux_heure | Optionnel, obligatoire pour l'envoi échelonné 1,2,3,4 ou 6 Nombre d'envoi(s) par heure |
| jours | Optionnel, obligatoire pour l'envoi échelonné Tableau avec 1,2,3,4,5,6 Jours d'envoi (1 représentant lundi). Pas d'envoi le dimanche. |
| timezone |
Optionnel Permet de modifier le fuseau horaire. Par défaut : Europe/Paris |
Envoyer un MMS
URL à appeler : https://www.spot-hit.fr/api/envoyer/mms
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| fichier | Identifiant du visuel délivré grâce à l'API d'importation de visuel MMS |
| destinataires | Liste de numéros de vos destinataires (tableau ou séparé par un retour à la ligne ou une virgule) ex : +33100000000,003340-00-00-00 , 6 00 00 00 00 |
| sujet | Optionnel Sujet de votre MMS |
| message | Limité à 10000 caractères |
| date | Optionnel Date d'envoi du message (format timestamp) Si aucune date n'est entrée ou si celle-ci précède la date actuelle, le message sera envoyé immédiatement |
| destinataires_type | Optionnel Permet la sélection de contacts déjà enregistrés sur le compte client : « all » = sélection de tous les contacts du compte. « groupe » = sélection de tous les contacts du groupe id fournit dans le champs « destinataires » |
| nom | Optionnel Cette information non visible par les destinataires vous permet d’identifier votre campagne (maximum 255 caractères). |
| date_debut | Optionnel, obligatoire pour l'envoi échelonné Date de début d'envoi des messages (format timestamp) |
| date_fin | Optionnel, obligatoire pour l'envoi échelonné Date de fin d'envoi des messages (format timestamp) |
| creneaux | Optionnel, obligatoire pour l'envoi échelonné Heure(s) d'envois Tableau avec 8,9,10,11,12,13,14,15,16,17,18,19 La campagne sera fractionnée proportionnellement aux nombres de créneaux entre le jour et l'heure de démarrage, et le jour et l'heure de fin souhaitée. |
| creneaux_heure | Optionnel, obligatoire pour l'envoi échelonné 1,2,3,4 ou 6 Nombre d'envoi(s) par heure |
| jours | Optionnel, obligatoire pour l'envoi échelonné Tableau avec 1,2,3,4,5,6 Jours d'envoi (1 représentant lundi). Pas d'envoi le dimanche. |
| timezone |
Optionnel Permet de modifier le fuseau horaire. Par défaut : Europe/Paris |
Importer un visuel MMS
Votre image sera automatiquement réduite en taille afin de ne pas dépasser la taille maximum de 240ko.
La qualité peut être dégradée par cette réduction, il est important d’effectuer un envoi de MMS d’essai sur votre téléphone mobile avant de valider votre campagne.
URL à appeler : https://www.spot-hit.fr/api/mms/upload
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| fichier | Votre fichier au format PNG, GIF ou JPG (5 mo maximum) |
Résultats
| Résultat | Description |
|---|---|
| {"success":true,"file":"1234","pages":6} | success = true = Elément importé avec succès file = identifiant de votre fichier pages = nombre de pages de votre fichier |
| {"success":false,"msg":"Message erreur."} | success = false = Elément non importé msg = message d'erreur |
Envoyer un Email
URL à appeler : https://www.spot-hit.fr/api/envoyer/e-mail
Liste des paramètres de l'API email
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| sujet | Intitulé du mail qui sera affiché dans la boîte de réception de vos destinataires. |
| message | Contenu de votre email. (Format HTML) |
| destinataires | Liste d'emails de vos destinataires (tableau ou séparé par un retour à la ligne ou une virgule) |
| expediteur | Adresse d'expédition des emails. Attention pour une meilleure dérivabilité vous devez utiliser un domaine référencé sur Spot-Hit. Par défaut nous mettons à votre disposition le domaine sh-mail.fr. Exemple : [email protected] |
| nom_expediteur | S'affiche en complément de l'adresse email d'expédition, corresponds à l'affichage de votre Nom et Prénom lorsque vous envoyez un email personnel. |
| email_reponse | Optionnel Email de redirection des réponses. |
| date | Optionnel Date d'envoi du message (format timestamp) Si aucune date n'est entrée ou si celle-ci précède la date actuelle, le message sera envoyé immédiatement |
| type_message | Optionnel Permet la sélection d'un template déjà enregistré sur le compte client : «creation» = sélection du template avec le template id fournit dans le champs « message » |
| destinataires_type | Optionnel Permet la sélection de contacts déjà enregistrés sur le compte client : « all » = sélection de tous les contacts du compte. « groupe » = sélection de tous les contacts du groupe id fournit dans le champs « destinataires » « datas » = permet d'ajouter des données personnalisées aux « destinataires » pour les utiliser dans votre message (exemple : "Bonjour {nom} {prenom}"), pour ce faire il faut que le champs « destinataires » soit un tableau de cette forme : array("[email protected]" => array("nom" => "Nom 1", "prenom" => "Prénom 1"), "[email protected]" => array("nom" => "Nom 2", "prenom" => "Prénom 2") ...) |
| nom | Optionnel Cette information non visible par les destinataires vous permet d’identifier votre campagne. |
| date_debut | Optionnel, obligatoire pour l'envoi échelonné Date de début d'envoi des messages (format timestamp) |
| date_fin | Optionnel, obligatoire pour l'envoi échelonné Date de fin d'envoi des messages (format timestamp) |
| creneaux | Optionnel, obligatoire pour l'envoi échelonné Heure(s) d'envois Tableau avec 8,9,10,11,12,13,14,15,16,17,18,19 La campagne sera fractionnée proportionnellement aux nombres de créneaux entre le jour et l'heure de démarrage, et le jour et l'heure de fin souhaitée. |
| creneaux_heure | Optionnel, obligatoire pour l'envoi échelonné 1,2,3,4 ou 6 Nombre d'envoi(s) par heure |
| jours | Optionnel, obligatoire pour l'envoi échelonné Tableau avec 1,2,3,4,5,6 Jours d'envoi (1 représentant lundi). Pas d'envoi le dimanche. |
| timezone |
Optionnel Permet de modifier le fuseau horaire. Par défaut : Europe/Paris |
Envoyer un Message Vocal
URL à appeler : https://www.spot-hit.fr/api/envoyer/vocal
Liste des paramètres de l'API envoi message vocal
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| type | Type de Message Vocal : "direct_repondeur" ou "appels" Direct Répondeur : message vocal déposé directement sur le répondeur sans faire sonner Appels : message diffusé au décroché d'un appel entrant vers les numéros destinataires |
| message | Identifiant du message audio délivré grâce à l'API d'importation de fichier audio |
| destinataires | Liste de numéros de vos destinataires (tableau ou séparé par un retour à la ligne ou une virgule) ex : +33100000000,003340-00-00-00 , 6 00 00 00 00 |
| expediteur | Optionnel Numéro de téléphone valide Si vide, l'expéditeur sera "Numéro inconnu" ou équivalent. |
| date | Optionnel Date d'envoi du message (format timestamp) Si aucune date n'est entrée ou si celle-ci précède la date actuelle, le message sera envoyé immédiatement |
| destinataires_type | optionnel Permet la sélection de contacts déjà enregistrés sur le compte client : « all » = sélection de tous les contacts du compte. « groupe » = sélection de tous les contacts du groupe id fournit dans le champs « destinataires » |
| texte | Optionnel Message texte à vocaliser (dans ce cas le paramètre "message" doit être vide) |
| voix | Optionnel Permet de choisir la voix utilisée lors de la vocalisation (paramètre texte). "Celine" et "Mathieu" Par défaut, la voix utilisée est : "Mathieu" |
| fixe | Optionnel (uniquement pour Appels) Si égal à "0", ignore les numéros de téléphones fixes. |
| detection_repondeur | Optionnel (uniquement pour Appels) Si égal à "1" et le cas où l'appel est décroché par un répondeur, ce paramètre permet d'activer le dépot sur répondeur. |
| reecoute | Optionnel (uniquement pour Appels) Si égal à "1" rajoute à la fin de votre message un choix permettant au destinataire de réécouter votre message. |
| mise_relation | Optionnel (uniquement pour Appels) Numéro de téléphone valide. Permet au destinataire d'être mis en relation avec le numéro spécifié. |
| boite_vocale | Optionnel (uniquement pour Appels) Si égal à "1", rajoute à la fin de votre message une boîte vocale permettant au destinataire de vous laisser un message. |
| stop | Optionnel (uniquement pour Appels) Si égal à "1", rajoute à la fin de votre message un choix permettant au destinataire de s'opposer à la réception de messages de votre part. |
| nom | Optionnel Cette information non visible par les destinataires vous permet d’identifier votre campagne (maximum 255 caractères). |
| url | Optionnel Adresse URL de votre serveur pour la réception en "push" des statuts après l'envoi. Vous devez déjà avoir une adresse paramétrée sur votre compte pour activer les retours "push". Si ce paramètre est renseigné, cette URL sera appelée pour cet envoi sinon l'adresse du compte est utilisée. |
| date_debut | Optionnel, obligatoire pour l'envoi échelonné Date de début d'envoi des messages (format timestamp) |
| date_fin | Optionnel, obligatoire pour l'envoi échelonné Date de fin d'envoi des messages (format timestamp) |
| creneaux | Optionnel, obligatoire pour l'envoi échelonné Heure(s) d'envois Tableau avec 8,9,10,11,12,13,14,15,16,17,18,19 La campagne sera fractionnée proportionnellement aux nombres de créneaux entre le jour et l'heure de démarrage, et le jour et l'heure de fin souhaitée. |
| creneaux_heure | Optionnel, obligatoire pour l'envoi échelonné 1,2,3,4 ou 6 Nombre d'envoi(s) par heure |
| jours | Optionnel, obligatoire pour l'envoi échelonné Tableau avec 1,2,3,4,5,6 Jours d'envoi (1 représentant lundi). Pas d'envoi le dimanche. |
| timezone |
Optionnel Permet de modifier le fuseau horaire. Par défaut : Europe/Paris |
Importer un fichier audio
URL à appeler : https://www.spot-hit.fr/api/vocal/upload
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| fichier | Votre fichier au format WAV, MP3 ou M4A (6 mo maximum) |
Résultats
| Résultat | Description |
|---|---|
| {"success":true,"file":"1234","pages":6} | success = true = Elément importé avec succès file = identifiant de votre fichier pages = nombre de pages de votre fichier |
| {"success":false,"msg":"Message erreur."} | success = false = Elément non importé msg = message d'erreur |
Attention !
Les fichiers importés ne seront conservés que 7 jours. Passé ce délai, ils seront automatiquement supprimés.
Envoyer un Fax
URL à appeler : https://www.spot-hit.fr/api/envoyer/fax
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| message | Identifiant du PDF délivré grâce à l'API d'importation de PDF |
| destinataires | Liste de numéros de vos destinataires (tableau ou séparé par un retour à la ligne ou une virgule) ex : +33100000000,003340-00-00-00 , 6 00 00 00 00 |
| expediteur | Optionnel Nom de l'expéditeur |
| date | Optionnel Date d'envoi du message (format timestamp) Si aucune date n'est entrée ou si celle-ci précède la date actuelle, le message sera envoyé immédiatement |
| destinataires_type | Optionnel Permet la sélection de contacts déjà enregistrés sur le compte client : « all » = sélection de tous les contacts du compte. « groupe » = sélection de tous les contacts du groupe id fournit dans le champs « destinataires » |
| nom | Optionnel Cette information non visible par les destinataires vous permet d’identifier votre campagne (maximum 255 caractères). |
| timezone |
Optionnel Permet de modifier le fuseau horaire. Par défaut : Europe/Paris |
Importer un PDF
URL à appeler : https://www.spot-hit.fr/api/pdf/upload
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| fichier | Votre fichier au format PDF (6 mo maximum) |
Résultats
| Résultat | Description |
|---|---|
| {"success":true,"file":"1234","pages":6} | success = true = Elément importé avec succès file = identifiant de votre fichier pages = nombre de pages de votre fichier |
| {"success":false,"msg":"Message erreur."} | success = false = Elément non importé msg = message d'erreur |
Liste des erreurs
| Code erreur | Description |
|---|---|
| 1 | Type de message non spécifié ou incorrect (paramètre "type") |
| 2 | Le message est vide |
| 3 | Le message contient plus de 160 caractères |
| 4 | Aucun destinataire valide n'est renseigné |
| 5 | Numéro interdit |
| 6 | Numéro de destinataire invalide |
| 7 | Votre compte n'a pas de formule définie |
| 8 | SMS | L'expéditeur est invalide. EMAIL | L'e-mail d'expédition est invalide. MMS | Le sujet contient plus de 16 caractères. |
| 9 | Le système a rencontré une erreur, merci de nous contacter. |
| 10 | Vous ne disposez pas d'assez de SMS pour effectuer cet envoi. |
| 11 | L'envoi des message est désactivé pour la démonstration. |
| 12 | Votre compte a été suspendu. Contactez-nous pour plus d'informations |
| 13, 14, 15 | Votre limite d'envoi paramétrée est atteinte. Contactez-nous pour plus d'informations. |
| 16 | Le paramètre "smslongnbr" n'est pas cohérent avec la taille du message envoyé. |
| 17 | L'expéditeur n'est pas autorisé. |
| 21 | Token invalide. Contactez-nous pour plus d'informations. |
| 22 | Durée du message non autorisée. Contactez-nous pour plus d'informations. |
| 23 | Aucune date variable valide n'a été trouvée dans votre liste de destinataires. |
| 24 | Votre campagne n'a pas été validée car il manque la mention « STOP » dans votre message. Pour rappel, afin de respecter les obligations légales de la CNIL, il est impératif d'inclure une mention de désinscription. Vous pouvez cliquer sur « Modifier la campagne » et cocher la mention STOP en bas du message. |
| 25 | Echelonnage : date de début vide |
| 26 | Echelonnage : date de fin vide |
| 27 | Echelonnage : date de début plus tard que date de fin |
| 28 | Echelonnage : aucun créneau disponible |
| 30 | Clé API non reconnue. |
| 45 | Ce produit n'est pas activé. |
| 50 | Le fuseau horaire spécifié n'est pas valide. |
| 51 | La date est déjà passé après calcule du fuseau horaire. |
| 52 | Vous avez atteint la limite maximale de 50 campagnes en brouillons. Si vous souhaitez en ajouter plus, merci de nous contacter. |
| 99 | Votre compte est suspendu. |
3Suivi
Liste des accusés de réception
URL à appeler : https://www.spot-hit.fr/api/dlr
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| id | ID du message |
Résultats
| Résultat |
|---|
| [ ["+33600000000","1","1323257035","1323257040", "178", "245645656", "20801"], ["+33600000000","1","1323257035","1323257040", "178", "245645656", "20801"] ... ] |
| {resultat: 0, id:, erreurs: "1"} |
Correspondance
| Eléments | Description |
|---|---|
| [numero] | Numéro du destinataire |
| [statut] | Statut du message : 1 = Envoyé et bien reçu 2 = Envoyé et non reçu 3 = En cours 4 = Echec 5 = Expiré (Les statuts 1, 4 et 5 sont définitifs.) |
| [date_emission] | Date d'émission du message (UNIX timestamp) |
| [date_mise_a_jour] | Date du dernier changement de statut du message (UNIX timestamp) |
| [statut_detaille] | Statut détaillé du message (disponible auprès de votre gestionnaire de compte. Non disponible en Low Cost). |
| [id_message] | Identifiant du message. |
| [operateur] | Code MCCMNC correspondant à l'opérateur du destinataire (non disponible en Low Cost). |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | ID non valide |
| 2 | Une campagne en création ou en cours d'envoi |
| 3 | Paramètre incorrect |
Réception (PUSH) des statuts
URL à appeler : Vous devez paramétrer sur votre compte l'adresse que notre plate-forme appellera à chaque changement de statut. Accès rapide aux paramètres
Paramètres (GET)
| Paramètre | Description |
|---|---|
| id_accuse | Identifiant unique du message pour ce numéro. |
| id_message | Identifiant commun en cas d'envoi d'un message groupé. |
| numero | Optionnel, numéro de téléphone du destinataire (uniquement si message de type SMS, Vocal, FAX). |
| Optionnel, email du destinataire (uniquement si message de type email). | |
| statut | Statut du message SMS : 0 = En attente 1 = Livré 2 = Envoyé 3 = En cours 4 = Echec 5 = Expiré (Les statuts 1 et 4 sont définitifs.) Statut du message Email : 0 = En attente 2 = Envoyé 3 = Cliqué 4 = Erreur 5 = Bloqué 6 = Spam 7 = Desabonné 8 = Ouvert |
| date_envoi | Date d'envoi du message (timestamp). |
| date_update | Date de dernière mise à jour du statut (timestamp). |
| statut_code | Statut détaillé de 0 à 9999 (détails à demander à votre gestionnaire de compte). |
| nom | Le nom ou l'identifiant personnel de votre message |
| liens | Liste des liens cliqués |
Liste des messages
URL à appeler : https://www.spot-hit.fr/api/campaign/list
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| date_start | Timestamp date de début de la sélection |
| date_end | Timestamp date de fin de la sélection. (Ecart max d'un an entre la date de début et date de fin) |
| product | Type de produit ciblé |
| limit | Optionnel, nombre de résultats maximum dans la sélection (max : 10 000) |
| start | Optionnel, point de départ de la séléction |
| id | Optionnel, sélection unique du message correspondant à l'identifiant fourni |
Résultats
| Résultat |
|---|
| [ [455]["Contenu du message"]["+33600000000,+33600000000"][2][15805646456][2]["Expéditeur"]["premium"][15805646456]["Ma campagne"] [55]["Contenu du message"]["+33600000000,+33600000000"][2][15805646456][2]["Expéditeur"]["premium"][15805646456]["Ma campagne 2"] ... ] |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Produit incorrect |
| 2 | Veuillez préciser une date de début |
| 3 | Veuillez préciser une date de fin |
| 4 | La période est supérieure à un an |
Correspondance
| Eléments | Description |
|---|---|
| [id] | Identifiant unique |
| [message] | Contenu du message |
| [liste_destinataires] | Liste des destinataires séparés par des virgules |
| [nbr_destinataires] | Nombre de destinataires |
| [date] | Timestamp date d'envoi |
| [statut] | Statut d'envoi du message [0 = Programmé, 1 = En cours, 2 = Envoyé , 3 = Echec] |
| [expediteur] | Expéditeur du message |
| [type] | Type de message |
| [date_ajout] | Timestamp date d'ajout |
| [nom] | Votre identifiant de message |
Modifier un message
URL à appeler : https://www.spot-hit.fr/api/campaign/edit
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| date | Nouvelle date d'envoi (timestamp) Si vide ou invalide = envoi immédiat |
| id | ID du contact à modifier |
| product | Produit de la campagne |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1} | resultat = 1 = Elément modifié avec succès |
| {resultat: 0, erreurs: [1,2]} | resultat = 0 = Erreur lors de la modification erreurs = Liste des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | ID non existant |
| 2 | Message déjà envoyé et donc non modifiable |
| 3 | Vous êtes sur un compte démo |
| 4 | Produit incorrect |
SUPPRIMER UN MESSAGE
URL à appeler : https://www.spot-hit.fr/api/campaign/delete
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| id | ID du message à supprimer |
| product | Produit du message |
Résultats
| Résultat | Description |
|---|---|
| {resultat: true} | resultat = true = Elément supprimé avec succès |
| {resultat: false, erreurs: [1,2] | resultat = false = Erreur lors de la suppression erreurs = Liste des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Vous ne pouvez pas supprimer cette campagne vocale, contactez le service client. |
| 2 | Le produit est inconnu, veuillez le vérifier |
| 3 | Erreur lors de la suppression de votre campagne. |
| 4 | Vous ne pouvez pas supprimer ce type de campagne, contactez le service technique pour plus d'informations. |
| 5 | Vous ne pouvez pas supprimer cette campagne car elle est envoyée, contactez le service technique pour plus d'informations. |
| 6 | ID non existant. |
4Modèles
Liste des modèles
URL à appeler : https://www.spot-hit.fr/api/sms/models
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
Résultats
| Résultat |
|---|
| [ [455]["Modèle 1"]["Exemple de modèle"] [575]["Modèle 2"]["Exemple de modèle"] ... ] |
Correspondance
| Eléments | Description |
|---|---|
| [id] | Identifiant unique |
| [nom] | Nom du modèle |
| [message] | Contenu du modèle |
Ajouter un modèle
URL à appeler : https://www.spot-hit.fr/api/sms/model/add
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| nom | Nom du modèle |
| message | Contenu du modèle SMS Personnalisé : {Nom du critère} |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1, id: 45498} | resultat = 1 = Elément ajouté avec succès. id = Identifiant unique de l'élément |
| {resultat: 0, erreurs: "1,2,3,4"} | resultat = 0 = Erreur lors de l'ajout. erreurs = Liste des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Le nom est vide |
| 2 | Le message contient plus de 160 caractères |
| 3 | Le message est vide |
| 4 | Le système a rencontré une erreur, merci de nous contacter |
Modifier un modèle
URL à appeler : https://www.spot-hit.fr/api/sms/model/edit
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| message | Contenu du modèle |
| id | Identifiant du modèle à modifier |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1} | resultat = 1 = Elément modifié avec succès |
| {resultat: 0, erreurs: "1,2,3,4"} | resultat = 0 = Erreur lors de la modification. erreurs = Liste des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Identifiant inexistant |
| 2 | Le message contient plus de 160 caractères |
| 3 | Le message est vide |
| 4 | Le système a rencontré une erreur, merci de nous contacter |
Supprimer un modèle
URL à appeler : https://www.spot-hit.fr/api/sms/model/delete
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| id | Identifiant de l'élement à supprimer |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1} | resultat = 1 = Elément supprimé avec succès |
| {resultat: 0, erreurs: "1,2"} | resultat = 0 = Erreur lors de la suppression. erreurs = Liste des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Identifiant inexistant |
| 2 | Le système a rencontré une erreur, merci de nous contacter |
5Médias
Liste des médias
URL à appeler : https://www.spot-hit.fr/api/medias/lister
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| output | Optionnel Permet de filtrer le type de média : 0 : Site Mobile 1 : Maquette Email 3 : Maquette importées |
| get-html | Optionnel Permet de récupérer le html de chaque maquette email |
Résultats
| Résultat |
|---|
|
[ {"id": 455,"thumbnail":"https://www.spot-hit.fr/uploads/outilmedia/thumbnails/no-thumbnail-available.png","output": 1,"name":"Modèle 1","date_creation": 1327843894,"date_update": 1327843894,"is_online": true }, {"id": 575,"thumbnail":"https://www.spot-hit.fr/uploads/outilmedia/thumbnails/no-thumbnail-available.png","output": 0,"name":"Modèle 2","date_creation": 1327843894,"date_update": 1327843894,"is_online": true }, ... ] |
Correspondance
| Eléments | Description |
|---|---|
| [id] | Identifiant unique |
| [thumbnail] | Url de l'icon |
| [output] | 0: Site mobile 1: Maquette email |
| [name] | Nom du média |
| [date_creation] | Date de création du média |
| [date_update] | Date de mise à jour du média |
| [is_online] | Site mobile en ligne ou pas |
Récupérer le html d'un média email
URL à appeler : https://www.spot-hit.fr/api/media/get-html
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| id | Id du média |
Résultats
| Résultat | Description |
|---|---|
| {"resultat": 1, "preview": "!DOCTYPE[...]"} | resultat = 1 = Html du média récupéré avec succès. preview = Html du contenu du média |
| {"resultat": false, "erreurs": "1,2"} | resultat = 0 = Erreur lors de la récupération du html du média. erreurs = Liste des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Ce n'est pas une maquette email |
| 2 | Cette maquette email n'existe pas. |
6Contacts
Liste des contacts
URL à appeler : https://www.spot-hit.fr/api/contacts/get
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| format | "json" (ou "html", non conseillé) |
| nbr | Le nombre maximum de contacts que vous souhaitez récupérer (ne pas renseigner pour prendre tous les contacts) |
| groupe | Renseigner l'ID d'un de vos groupes si vous souhaitez seulement cibler les contacts présent dans ce groupe |
Résultats
| Résultat |
|---|
|
{ "total":2, "colonnes":{"9696":"Prénom","9697":"Nom","27728":"Champs personnalisé"}, "donnees": [ {"id":"28577127","numero":"+33600000001","groupe":"30522","email":"[email protected]","fixe":"","fax":"","groupe_nom":"Groupe test","c_champs personnalise":"Contenu champs personnalisé""c_nom":"Nom 1""c_prenom":"Prénom 1"}, {"id":"28577128","numero":"+33600000002","groupe":"30522","email":"[email protected]","fixe":"","fax":"","groupe_nom":"Groupe test","c_champs personnalise":"Contenu champs personnalisé""c_nom":"Nom 2""c_prenom":"Prénom 2"} ... ] } |
Ajouter un contact
URL à appeler : https://www.spot-hit.fr/api/contacts/import
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| contacts |
Tableau des contacts contacts[0][nom]=Nom 1 contacts[0][prenom]=Prénom 1 contacts[0][mobile]=+33600000001 contacts[0][fixe]=+33100000001 contacts[0][fax]=+33200000001 contacts[0][email][email protected] contacts[0][custom_id]=123456 contacts[0][Champs+Personnalise]=Contenu champs personnalisé contacts[0][Champs+Personnalise+2]=Contenu champs personnalisé contacts[1][prenom]=Prénom 2 contacts[1][mobile]=+33600000002 contacts[1][fixe]=+33100000002 contacts[1][fax]=+33200000002 contacts[1][email][email protected] contacts[1][custom_id]=123457 contacts[1][Champs+Personnalise]=Contenu champs personnalisé contacts[1][Champs+Personnalise+2]=Contenu champs personnalisé |
| groupe_id | ID du groupe dans lequel doivent se situer les contacts Renseigner 0 si création d'un nouveau groupe |
| groupe_nom | Optionnel, nom du groupe à créer. groupe_id doit etre renseigné à 0 |
| remplacer_groupe | Défaut = 0, si égal à 1, remplace les contacts déjà présents dans le groupe |
| ajouter_autres_groupes | Défaut = 0, si égal à 1, ajoute les contacts même si ils sont déjà présents dans un autre groupe |
| supprimer_intenationaux | Défaut = 0, si égal à 1, supprime les numéros non Français |
| indicatif | Défaut = 33, (France), indicatif des numéros sans indicatif renseigné |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1, nbr_ajouts: 2, groupe: 1000, contacts_id: {123456478,132465464} | resultat = 1 = Elément ajouté avec succès nbr_ajouts = Nombre contacts ajoutés groupe = ID du groupe contacts_id = Liste d'id des contacts ajoutés |
| {resultat: 0, erreurs: "1,2"} | resultat = 0 = Erreur lors de l'import erreurs = Liste des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Impossible de créer le groupe ou groupe déjà existant |
| 2 | Contacts vides ou contacts illisibles |
Modifier un contact
URL à appeler : https://www.spot-hit.fr/api/contacts/edit-contact
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| id | ID du contact à modifier |
| colonnes | Tableau avec le nom de la colonne et de la valeur souhaité. Exemple de noms de colonnes : "mobile" "fixe" "email" "custom_id" "Champs+Personnalise" |
| custom_id | Mettre à 1 si l'id est personnalisé |
| groupe | Id du groupe afin de cibler l'id personnalisé |
Résultats
| Résultat | Description |
|---|---|
| {resultat: true, id : XXX, contact : {colonne : XXX} } | resultat = true = Elément supprimé avec succès |
| {resultat: false, erreurs: "Aucune colonne n'a été trouvé", code_erreurs: {1}} | resultat = false = Erreur lors de la mise à jour du contact. erreurs = Message d'erreur code_erreurs = Tableau des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Le contact n'a pas été trouvé |
| 2 | Aucune colonne n'a été trouvée |
| 3 | Aucun id n'a été renseigné. |
Modifier des contacts
URL à appeler : https://www.spot-hit.fr/api/contacts/edit-contacts
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| contacts | Tableau de contacts avec l'id en clé et en valeur un tableau avec le nom de la colonne et de la valeur souhaité. Si une colonne n'existe pas elle ne sera pas créée Exemple de noms de colonnes : "mobile" "fixe" "email" "custom_id" "Champs+Personnalise" |
| custom_id | Mettre à 1 si les ids sont personnalisés |
Résultats
| Résultat | Description |
|---|---|
| { 0: {resultat: true, id : XXX, contact : {colonne : XXX} } } | resultat = true = Elément supprimé avec succès |
| { 0: {resultat: false, erreurs: {1,2} } | resultat = false = Erreur lors de la mise à jour du contact. erreurs = Tableau des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | "Contacts" doit être un tableau |
| 2 | Aucune colonne n'a été trouvée |
| 3 | Aucun id n'a été renseigné. |
Supprimer un contact
URL à appeler : https://www.spot-hit.fr/api/contact/supprimer
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| id | Id du contact à supprimer |
| custom_id | Mettre à 1 si l'id utilisé est un id personnalisé |
| groupe | Id du groupe pour cibler l'id personnalisé |
Résultats
| Résultat | Description |
|---|---|
| {resultat: true} | resultat = true = Contact supprimé avec succès |
| {resultat: false, erreurs: {1,2} | resultat = false = Erreur lors de la suppression du contact. erreurs = Tableau des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Id vide ou non existante |
| 2 | Le système a rencontré une erreur, merci de nous contacter |
Supprimer plusieurs contacts
URL à appeler : https://www.spot-hit.fr/api/contacts/supprimer
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| ids | Id des contacts sous forme de tableau ou séparés par une virgule |
| custom_id | Mettre à 1 si les ids utilisés sont des ids personnalisés. (suppression dans tous les groupes) |
Résultats
| Résultat | Description |
|---|---|
| {resultat: true, contacts: {id: {'resultat' => true}}} | resultat = true = Contact supprimé avec succès contacts = Informations pour chaque contact |
| {resultat: false, contacts: {id: {'resultat' => false, 'erreurs' => {2}}}} | resultat = false = Erreur lors de la suppression du contact. contacts = Informations pour chaque contact erreurs = Tableau des erreurs rencontrées. |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Id vide ou non existante |
| 2 | Le système a rencontré une erreur, merci de nous contacter |
7Colonnes
Liste des colonnes
URL à appeler : https://www.spot-hit.fr/api/columns
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
Résultats
| Résultat |
|---|
| [ [455]["Critère 1"][1] [575]["Critère 2"][2] ... ] |
Correspondance
| Eléments | Description |
|---|---|
| [id] | Identifiant unique |
| [nom] | Nom du critère |
| [numero] | Numéro de classement des critères |
Ajouter un critère
URL à appeler : https://www.spot-hit.fr/api/column/add
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| nom | Nom du critère |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1, id: 45498} | resultat = 1 = Elément ajouté avec succès. id = Identifiant unique de l'élément |
| {resultat: 0, erreurs: "1,2,3,4"} | resultat = 0 = Erreur lors de l'ajout. erreurs = Liste des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Le nom est vide |
| 2 | Le nom contient plus de 11 caractères |
| 3 | Nombre de critères limité à 6 |
| 4 | Le système a rencontré une erreur, merci de nous contacter |
Modifier une colonne
URL à appeler : https://www.spot-hit.fr/api/column/edit
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| nom | Nom du critère |
| id | Identifiant du critère à modifier |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1} | resultat = 1 = Elément modifié avec succès |
| {resultat: 0, erreurs: "1,2,3,4"} | resultat = 0 = Erreur lors de la modification. erreurs = Liste des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Identifiant inexistant |
| 2 | Le nom est vide |
| 3 | Le nom contient plus de 11 caractères |
| 4 | Le système a rencontré une erreur, merci de nous contacter |
Supprimer une colonne
URL à appeler : https://www.spot-hit.fr/api/column/delete
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| id | Identifiant de l'élement à supprimer |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1} | resultat = 1 = Elément supprimé avec succès |
| {resultat: 0, erreurs: "1,2"} | resultat = 0 = Erreur lors de la suppression. erreurs = Liste des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Identifiant inexistant |
| 2 | Le système a rencontré une erreur, merci de nous contacter |
8Réponses
Liste des réponses
URL à appeler : https://www.spot-hit.fr/api/responses
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| date_debut | Optionnel, timestamp date de début de la sélection. (défaut : date création compte) |
| date_fin | Optionnel, timestamp date de fin de la sélection. (défaut : maintenant) |
| limit | Optionnel, nombre de résultats maximum dans la sélection. (max : 10 000) |
| start | Optionnel, point de départ de la séléction. |
| id | Optionnel, sélection unique du message correspondant à l'identifiant fourni. |
Résultats
| Résultat |
|---|
| [ ['id']['numero']['message']['date_envoi']['source_id'] ... ] |
Correspondance
| Eléments | Description |
|---|---|
| [id] | Identifiant unique |
| [numero] | Numéro de téléphone de l'émetteur |
| [message] | Contenu du message réponse |
| [date_envoi] | Timestamp date d'envoi de la réponse |
| [source_id] | Identifiant unique du message source |
Liste des STOP
URL à appeler : https://www.spot-hit.fr/api/stops
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
Résultats
| Résultat |
|---|
| [ ['id']['numero']['date_envoi']['source_id'] ... ] |
Correspondance
| Eléments | Description |
|---|---|
| [id] | Identifiant unique |
| [numero] | Numéro de téléphone de l'émetteur |
| [date_envoi] | Timestamp date d'envoi de la réponse |
| [source_id] | Identifiant unique du message source |
Ajouter des STOP
URL à appeler : https://www.spot-hit.fr/api/contacts/blacklist
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| numeros |
Tableau des numeros numeros[0]=+33600000001 numeros[1]=+33100000002 |
Résultats
| Résultat | Description |
|---|---|
| {resultat: X} | resultat = X = Nombre de numéros ajoutés |
| {resultat: 0, erreurs: "30"} | resultat = 0 = Erreur lors de l'ajout erreurs = Liste des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 30 | Clé API non reconnue. |
Réception (PUSH) des réponses
URL à appeler : Vous devez paramétrer sur votre compte l'adresse que notre plate-forme appellera à chaque réception d'une réponse à l'un de vos messages. Accès rapide aux paramètres
Paramètres (GET)
| Paramètre | Description |
|---|---|
| id | Identifiant unique |
| numero | Numéro de téléphone de l'émetteur |
| date | Timestamp date d'envoi de la réponse |
| message | Contenu du message réponse |
| source | Identifiant unique du message source |
Réception (PUSH) des STOP
URL à appeler : Vous devez paramétrer sur votre compte l'adresse que notre plate-forme appellera à chaque réception d'un STOP à l'un de vos messages. Accès rapide aux paramètres
PARAMETRES (GET)
| Paramètre | Description |
|---|---|
| id | Identifiant unique |
| numero | Numéro de téléphone de l'émetteur (peut-être vide si le champs email est renseigné) |
| Email de l'émetteur (peut-être vide si le champs numero est renseigné) | |
| date_envoi | Timestamp date d'envoi de la réponse |
| source_id | Identifiant unique du message source |
Réintégrer STOP
URL à appeler : https://www.spot-hit.fr/api/liste-exclusion/supprimer
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| numero | Numéro à réintégrer (peut-être vide si le champs email est renseigné) |
| Email à réintégrer (peut-être vide si le champs numero est renseigné) |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1} | resultat = 1 = Elément supprimé avec succès |
| {"resultat":0,"erreurs":[3]} | resultat = 0 = Erreur lors de la suppression. erreurs = Liste des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 0 | Le système a rencontré une erreur, merci de nous contacter |
| 1 | Paramètre vide |
| 2 | Paramètre incorrect |
| 3 | Numéro ou Email non présent |
9Groupes
Liste des groupes
URL à appeler : https://www.spot-hit.fr/api/groupe/lister
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
Résultats
| Résultat |
|---|
| [{"id":"1","commercant":"1","groupe":"Groupe 1","total":"10"},{"id":"2","commercant":"1","groupe":"Groupe 2","total":"25"}] |
Ajouter un groupe
URL à appeler : https://www.spot-hit.fr/api/groupe/creer
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| nom | Nom du groupe (100 caractères max) |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1, id: 45498} | resultat = 1 = Elément ajouté avec succès. id = Identifiant unique de l'élément |
| {resultat: 0, erreurs: "1,2"} | resultat = 0 = Erreur lors de l'ajout. erreurs = Liste des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Impossible de créer le groupe / Vérifier que le groupe soit unique |
| 2 | Le nom est vide ou contient plus de 100 caractères |
Renommer un groupe
URL à appeler : https://www.spot-hit.fr/api/groupe/renommer
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| nom | Nom du groupe (100 caractères max) |
| id | Identifiant du groupe à modifier |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1} | resultat = 1 = Elément modifié avec succès |
| {resultat: 0, erreurs: "1,2,3"} | resultat = 0 = Erreur lors de la modification. erreurs = Liste des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Impossible de renommer le groupe |
| 2 | Le nom est vide ou contient plus de 100 caractères |
| 3 | ID groupe non renseigné ou inexistant |
Supprimer un groupe
URL à appeler : https://www.spot-hit.fr/api/groupe/supprimer
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| id | Identifiant de l'élement à supprimer |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1} | resultat = 1 = Elément supprimé avec succès |
| {resultat: 0, erreurs: "1,2"} | resultat = 0 = Erreur lors de la suppression. erreurs = Liste des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Erreur lors de la suppression du groupe |
| 2 | ID groupe non renseigné ou inexistant |
10Comptes
Consultation du solde
URL à appeler : https://www.spot-hit.fr/api/credits
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
Résultats
| Résultat | Description |
|---|---|
| {resultat: true, pre_paye: false, post_paye: false, euros: "0", premium: "1000", lowcost: "1000", mms: "5", mobile: "50", fixe: "50", direct_classique: "50", direct_premium: "50", email: "100", vocalisation: "3600", fax: "100"} | Résultat de la requête + option pré-payée en euros + option post-payée + nombre de crédits restants (par type) sur votre compte (uniquement si l'option post-payée n'est pas activité). |
Consultation des statistiques par période
URL à appeler : https://www.spot-hit.fr/api/statistiques
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| date_debut | Optionnel, timestamp date de début de la sélection. (défaut : date du début du mois en cours) |
| date_fin | Optionnel, timestamp date de fin de la sélection. (défaut : maintenant) |
| sous_compte | Optionnel, booléen 1/0 pour prendre en compte la consommation des sous-comptes. (défaut : 0) |
Résultats
| Résultat |
|---|
| {resultat: true, statistiques:{"premium":0, "lowcost":0, "direct_classique":0, "direct_premium":0, "mobile":0,"fixe":0, "html":0, "fax":0, "hlr":0, "vocalisation":0, "mms":0, "courrier_gestion":{"affranchissement":0,"routage":0,"supplement":0},"pays":[]}} |
11Sous-comptes
Liste des sous-comptes
URL à appeler : https://www.spot-hit.fr/api/sous-compte/get
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
Résultats
| Résultat |
|---|
|
[ {"id":"1","email":"[email protected]","civilite":"M","nom":"Nom 1","prenom":"Prenom 1","nom_entreprise":"Entreprise 1","nom_commercial":"Nom commercial 1","adresse":"rue du test","ville":"Roanne","code_postal":"42300","pays":"France M\u00e9tropolitaine","date_inscription":"1327843894","api_cle":"lacleapidusouscompte","solde_premium":"0","solde_lowcost":"125","solde_email":"10","solde_fax":"10","solde_fixe":"10","solde_mobile":"10","solde_direct_repondeur":"10"} ... ] |
Ajouter un sous compte
URL à appeler : https://www.spot-hit.fr/api/sous-compte/add
Paramètres
| Paramètre | Description |
|---|---|
| civilite | (M, Mme) |
| nom | |
| prenom | |
| nom_entreprise | |
| nom_commercial | |
| raison | (entreprise, association, administration) |
| adresse | |
| code_postal | |
| ville | |
| telephone_personnel | |
| telephone_entreprise | |
| motdepasse | Votre mot de passe |
| confirmation | Confirmation de votre mot de passe |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1, id: 400045, key: 3c6e0b8a9c15224a8228b9a98ca1531d} | resultat = 1 = Elément ajouté avec succès id = identifiant unique du compte key = clé api du compte |
| {resultat: 0, erreur: "Votre erreur"} | resultat = 0 = Erreur lors de l'ajout. erreur = Votre erreur |
Modifier un sous compte
URL à appeler : https://www.spot-hit.fr/api/client/set
Paramètres
| Paramètre | Description |
|---|---|
| client | L'Identifiant unique du sous-compte |
| element | Elément que vous souhaitez modifier (nom, prenom, raison_sociale, nom_entreprise, nom_commercial, mot_de_passe, indicatif_defaut, email) |
| valeur | La nouvelle valeur que vous souhaitez lui attribuer |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1} | resultat = 1 = Elément modifié avec succès |
| {resultat: 0, erreur: [1,2]} | resultat = 0 = Erreur lors de la modification. erreurs = Tableau des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Elément non modifiable. |
| 2 | Valeur incorrecte/Email déjà utilisé. |
| 5 | Client introuvable/Pas la permission de modifier le client. |
| 99 | Erreur SQL. |
Récupérer la liste des éléments du sous-compte
URL à appeler : https://www.spot-hit.fr/api/client/get
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| id | L'Identifiant unique du compte |
| elements | Optionnel Eléments que vous souhaitez (first_name, last_name, civility, company_name, commercial_name, address, zip_code, city, country, email, business_phone, language, api_key) Syntaxe : ["first_name", "last_name", ...] |
Résultats
| Résultat | Description |
|---|---|
| {resultat: true, data: {"first_name": "John", "last_name": "Doe", ...}} | Tableau des données. |
| {resultat: false, erreurs: [1, 2, 3]} | resultat = false = Erreur lors de la récupération des données. erreurs = Tableau des erreurs rencontrées. |
Correspondance
| Eléments | Description |
|---|---|
| first_name | Prénom |
| last_name | Nom |
| civility | Civilité |
| company_name | Nom entreprise |
| commercial_name | Nom commercial |
| address | Adresse |
| zip_code | Code postal |
| city | Ville |
| country | Pays |
| business_phone | Téléphone entreprise |
| language | Langue |
| api_key | Clé API |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Valeur d'identifiant incorrecte. |
| 2 | Valeur elément (elements) incorrecte. |
| 3 | Compte introuvable. |
Desactiver un sous compte
URL à appeler : https://www.spot-hit.fr/api/sous-compte/desactiver
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| id | Identifiant unique du sous-compte |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1} | resultat = 1 = Elément désactivé avec succès |
| {resultat: 0, erreur: [1,2]} | resultat = 0 = Erreur lors de la désactivation. erreurs = Tableau des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Id manquant. |
| 2 | Client introuvable/Pas la permission de modifier le client. |
Transférer des crédits
URL à appeler : https://www.spot-hit.fr/api/sous-compte/transferer-credits
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| id_sous_compte | Identifiant du sous-compte |
| act | Type d'action : "credit" ou "debit" |
| type | Type de crédit : |
| credits | Nombre de crédits à transférer |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1} | resultat = 1 = Elément ajouté avec succès |
| {resultat: 0, message: "message d'erreur"} | resultat = 0 = Erreur lors du transfert. message = Message de l'erreur rencontrée |
Paramétrer URL Push
URL à appeler : https://www.spot-hit.fr/api/urls/edit
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| accuses | URL de réception des accusés de réception |
| stops | URL de réception des stops |
| reponses | URL de réception des réponses |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1} | resultat = 1 = Elément ajouté avec succès |
| {resultat: 0, erreurs: "1,2"} | resultat = 0 = Erreur lors de la modification. erreurs = Liste des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Erreur interne. |
Détail des campagnes
URL à appeler : https://www.spot-hit.fr/api/client/details_campagnes
Paramètres
| Paramètre | Description |
|---|---|
| format | json ou csv (par défaut json) |
| debut | Timestamp unix début sélection (par défaut le 1er du mois dernier) |
| fin | Timestamp unix fin sélection (par défaut le 31 du mois dernier) |
Modifier la facturation
URL à appeler : https://www.spot-hit.fr/api/billing/edit
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| id | ID du compte client |
| facturation | (0 = Pre-payé, 1 = Post-payé) |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1} | resultat = 1 = Elément ajouté avec succès |
| {resultat: 0, erreurs: "1,2"} | resultat = 0 = Erreur lors de la modification. erreurs = Liste des erreurs rencontrées |
Ajouter un client (Marque-blanche)
URL à appeler : https://www.spot-hit.fr/api/client/creer
Attention, vous devez remplacer https://www.spot-hit.fr par le domaine de votre marque blanche.
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| raison | Raison sociale du compte : "entreprise", "association" ou "administration" |
| nom_entreprise | Nom de l'entreprise du compte |
| adresse | Adresse du compte |
| code_postal | Code postal du compte |
| ville | Ville du compte |
| pays | Pays du compte |
| civilite | Civilité du compte : "M" ou "Mme" |
| nom | Nom du compte |
| prenom | Prénom du compte |
| Email du compte | |
| telephone_entreprise | Téléphone pro du compte |
| telephone_personnel | Téléphone perso du compte |
| mdp_decrypte | Le mot de passe décrypté |
| premium | Crédits SMS premium (défaut 0) |
| credit_email | Crédits email (défaut 0) |
| direct_classique | Crédits direct répondeur (défaut 0) |
| fixe | Minutes fixe (défaut 0) |
| mobile | Minutes mobile (défaut 0) |
| fax | Crédits fax (défaut 0) |
| valider_cgvu | Valider automatiquement les CGVU : 1 ou 0 |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1, id: 999} | resultat = 1 = Client ajouté avec succès + l'id du client |
| {resultat: 0, erreur: "Erreur en texte"} | resultat = 0 = Erreur lors de la modification. erreur = L'erreur rencontrée |
Regénérer une clé api
URL à appeler : https://www.spot-hit.fr/api/sous-compte/regenerer-cle-api
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| id | Id du sous compte à cibler |
Résultats
| Résultat | Description |
|---|---|
| {resultat: true, cle_api: "2d1a18835cadd5944030bxx"} | resultat = true = Clé api regénérée avec succès cle_api = nouvelle clé api |
| {resultat: false, erreurs: {1,2} | resultat = false = Erreur lors de la regénération de la clé api du sous compte. erreurs = Tableau des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Id vide ou sous compte inexistant |
| 2 | Le système a rencontré une erreur, merci de nous contacter |
Regénérer plusieurs clés api
URL à appeler : https://www.spot-hit.fr/api/sous-compte/regenerer-cle-apis
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| ids | Ids des sous compte à cibler sous forme de tableau ou séparés par une virgule |
Résultats
| Résultat | Description |
|---|---|
| {resultat: true, sub_accounts: {id: {resultat: true, cle_api: "2d1a18835cadd5944030bxx"}}} | resultat = true = Clé api regénérée avec succès sub_accounts = tableau des sous comptes cle_api = nouvelle clé api |
| {resultat: false, sub_accounts: {id: {resultat: false, erreurs: {1,2} }}} | resultat = false = Erreur lors de la regénération de la clé api du sous compte. sub_accounts = tableau des sous comptes erreurs = Tableau des erreurs rencontrées |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Id vide ou sous compte inexistant |
| 2 | Le système a rencontré une erreur, merci de nous contacter |
12Liens courts
Lister les liens courts
URL à appeler : https://www.spot-hit.fr/api/liens-courts/lister
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
Résultats
| Résultat |
|---|
| [ {"id":"1", "nom":"Redirection1", "is_online":false, "domaine_id":null, "sous_domaine":null, "extension":null, "url":null, "adresse_cible":"http:\/\/mon-site.fr"}, {"id":"2", "nom":"Redirection2", "is_online":true, "domaine_id":"1", "sous_domaine":"www", "extension":"promo", "url":"www.mon-site.fr\/promo", "adresse_cible":"http:\/\/mon-site.fr"} ] |
Ajouter un lien court
URL à appeler : https://www.spot-hit.fr/api/liens-courts/creer
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| adresse_cible | URL ciblée par le lien court |
| extension | Extension du lien court |
| nom | Optionnel, nom du lien court. (défaut : redirection) |
| domaine_id | Optionnel, id du nom de domaine à utiliser. (défaut : sm-s.fr) |
| sous_domaine | Optionnel, sous-domaine à utiliser. (défaut : aucun) |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1, id: 58489} | resultat = 1 = Elément ajouté avec succès id = identifiant du lien court |
| {resultat: 0, erreurs: 1} | resultat = 0 = Erreur lors de l'ajout. erreurs = Code de l'erreur rencontrée |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Erreur interne. |
| 2 | Pas la permission d'utiliser le domaine. |
| 3 | Extension déjà utilisée. |
| 4 | Adresse cible non renseignée. |
| 5 | Extension non renseignée. |
| 6 | Domaine non trouvé. |
Supprimer un lien court
URL à appeler : https://www.spot-hit.fr/api/liens-courts/supprimer
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| id | Identifiant de l'élement à supprimer |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1, id: 58489} | resultat = 1 = Elément supprimé avec succès id = identifiant du lien court |
| {resultat: 0, erreurs: 1} | resultat = 0 = Erreur lors de la suppression. erreurs = Code de l'erreur rencontrée |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Erreur lors de la supprimer du lien court. |
| 2 | ID du lien court non renseigné ou inexistant. |
Statistiques d'un lien court
URL à appeler : https://www.spot-hit.fr/api/liens-courts/statistiques
Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
| id | Identifiant de l'élement |
Résultats
| Résultat | Description |
|---|---|
| {resultat: 1, statistiques: {...}, cliqueurs: {...}} | resultat = 1 = Elément supprimé avec succès statistiques = toutes les statistiques disponibles du lien court cliqueurs = tous les cliqueurs du lien court |
| {resultat: 0, erreurs: 1} | resultat = 0 = Erreur lors de la récupération des statistiques. erreurs = Code de l'erreur rencontrée |
Tableau des erreurs
| Numéro | Description |
|---|---|
| 1 | Erreur interne. |
| 2 | ID du lien court non renseigné ou inexistant. |
13Annexes
Envoi d'un SMS par email
Fonctionnement
Vous devez envoyer les messages à l'adresse [email protected]. Ceux-ci doivent être envoyés depuis l'adresse email enregistrée en tant qu'identifiant du compte.
La syntaxe des paramètres est équivalente à celle de l'envoi de message par requête HTTP.
Rédaction de l'email :
- Sujet = Destinataire(s) du SMS.
- Contenu = Contenu du SMS.
- Nom de l'expéditeur = Expéditeur du SMS
Paramètres fixes à modifier avec votre gestionnaire de compte :
- Tronque (défaut = 1)
- SMSlong (défaut = 0)
- Mail confirmation d'envoi (défaut = 1)
- Mail en cas d'erreur (défaut = 1)
- Expéditeur (défaut = Nom de l'expéditeur du mail. Peut être fixé pour toujours être identique.)
Pour plus de souplesse, nous vous conseillons d'utiliser notre API HTTP.
Envoi d'un courrier par email
Envoi dématérialisé de vos courriers de gestions : factures, devis, relances, courrier de bienvenue...
Attention, cette méthode n'est pas utilisable pour vos courriers marketing en masse, vous devez utiliser l'interface en ligne.
Fonctionnement
Vous devez envoyer les messages à l'adresse [email protected]. Ceux-ci doivent être envoyés depuis l'adresse email enregistrée en tant qu'identifiant du compte (configuration spéciale possible, nous contacter).
- Impression d'un document (A4 80gr couleur), 2 plis et mise sous enveloppe à double fenêtre C6. (coût de 0.27€ HT, contactez-nous pour un volume supérieur à 1000 courriers par mois)
- Page(s) supplémentaire(s) : Un document peut comprendre jusqu'à 5 pages maximum par enveloppe (coût par page supplémentaire : 0.15€ HT, contactez-nous pour un volume supérieur à 1000 courriers par mois)
- Acheminement du courrier avec affranchissement Ecopli Grand Compte J+4 à 0.567€. (Affranchissement rapide (LG2, J+2) disponible sur demande avec un coût unitaire à 0.6€.)
- Dépôt en poste le jour même à 16h30 si réception des documents avant 15h00 (du lundi au vendredi).
- Produit disponible aujourd'hui uniquement pour les clients en facturation mensuelle (consommation visible en cliquant sur 'Afficher le détail' sur la page d'accueil de l’espace client)
Contraintes obligatoires sur la première page :
- Adresse du destinataire à placer sur la première page de manière standard (40mm du bord haut, 20mm du bord droit, taille max. de la zone adresse 100*45mm).
- Adresse de l'expéditeur à placer sur la première page de manière standard (20mm du bord haut, 10mm du bord gauche, taille max. de la zone adresse 90*35mm).
Rédaction de l'email :
- Expéditeur = Email de votre compte
- Destinataire = [email protected]
- Sujet = Champ libre non traité
- Pièce(s) jointe(s) = Un PDF par courrier à envoyer (max. 5 pages).
Envoi d'un fax par email
Fonctionnement
Vous devez envoyer les messages à l'adresse [email protected]. Ceux-ci doivent être envoyés depuis l'adresse email enregistrée en tant qu'identifiant du compte.
La syntaxe des paramètres est équivalente à celle de l'envoi de message par requête HTTP.
Rédaction de l'email :
- Sujet = Destinataire(s) du FAX.
- Pièce jointe = PDF du contenu du FAX (max. 10 pages).
- Nom de l'expéditeur = Expéditeur du FAX
Paramètres fixes à modifier avec votre gestionnaire de compte :
- Expéditeur (défaut = Nom de l'expéditeur du mail. Peut être fixé pour toujours être identique.)
Pour plus de souplesse, nous vous conseillons d'utiliser notre API HTTP.