# Suivi

# 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 de la campagne
produit	Canal de la campagne (sms,vocal,email,mms,fax)

# Résultats

Erreur :

# Correspondance

# Tableau des erreurs

Numéro	Description
1	ID non valide
2	Une campagne en création ou en cours d'envoi
3	Aucune campagne avec cet ID n'a été trouvée pour ce compte

# 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 (opens new window)

# 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 le produit est de type sms, vocal, fax, mms)
email	Optionnel Email du destinataire (uniquement si le produit est de type email)
statut	Statut du message SMS 0 = En attente Le SMS est en attente d'envoi, généralement il concerne une campagne programmée 1 = Livré Le SMS a bien été livré sur un mobile allumé. Avec 95% de taux de lecture moyen (étude Médiamétrie AFMM), il est fort probable qu'il soit également lu par le destinataire dans les minutes qui suivent la réception 2 = Envoyé Le SMS a bien été envoyé sur un numéro valide, mais le mobile est pour l’instant injoignable (éteint, pas de réseau, SIM pleine...). Durant 48h, les opérateurs essayent de livrer à nouveau le SMS sur le mobile. Si ce dernier reste injoignable après ce délai, le statut se transformera en « expiré » 3 = En cours Le SMS est en cours d'envoi, ce statut évoluera rapidement 4 = Echec Le SMS a expiré, car le mobile du destinataire reste injoignable après 48h. Le numéro de téléphone est annoncé valide par les opérateurs, si le mobile est de nouveau joignable lors des prochaines campagnes le SMS sera correctement reçu 5 = Expiré Le SMS n'a pas pu être délivré, car le numéro est annoncé inaccessible par les opérateurs (Les statuts 1, 4 et 5 sont définitifs.) Statut du message Email 0 = En attente L'email est en attente d'envoi. (Généralement il concerne une campagne programmée) 2 = Envoyé L'email a bien été envoyé vers une adresse valide, mais n'a pas encore été ouvert 3 = Cliqué Le destinataire a cliqué sur un lien présent dans l'email. (Les prévisualisations et les désinscriptions ne sont pas prises en compte) 4 = Erreur Il s'agit d'un problème temporaire comme une boite de réception pleine ou un problème d'acheminement ou d'un problème permanent comme une adresse invalide 5 = Bloqué L'adresse a été bloquée préventivement car cet email n'a aucune chance d'arriver en boîte de réception 6 = Spam L'email a été bloqué par un système de protection installé sur l'adresse du destinataire (MailInBlack, ALTOSPAM, ...) 7 = Desabonné Le destinataire de l'email est présent dans votre liste d'exclusion 8 = Ouvert Le destinaire a ouvert l'email
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	Optionnel Liste des liens cliqués (uniquement si le produit est de type email
produit	Le produit de votre message (email, sms, vocal, mms, fax)
bounce_category	Optionnel Catégorie du bounce (uniquement si message de type e-mail et qu'il y a un bounce)

# Liste des message

# 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é (sms, email, mms, vocal)
destinataires	Optionnel si égal à "1", ajoute la liste des destinataires dans le retour sinon la liste est vide Par défaut = 0
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

{
    [[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 message à modifier
product	Produit de la campagne

# Résultats

Résultat	Description
`{resultat: true}`	resultat = true = Elément modifié avec succès
`{resultat: false, erreurs: [1,2]}`	resultat = false = Erreur lors de la modification erreurs = Liste des erreurs rencontrées

# 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

← Erreurs Modèles →