# Ré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
[
["id"]["numero"]["message"]["date_envoi"]["source_id"]
...
]
# Correspondance
| Eléments | Description |
|---|---|
| [id] | Identifiant unique |
| [numéro] | 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 |
# Listes des STOP
# URL à appeler
https://www.spot-hit.fr/api/stops
# Paramètres
| Paramètre | Description |
|---|---|
| key | Votre clé API d'identification |
# Résultats
[
["id"]["numero"]["date_envoi"]["source_id"]
...
]
# Correspondance
| Eléments | Description |
|---|---|
| [id] | Identifiant unique |
| [numéro] | 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 ou emails | Tableau des numeros numeros[0]=+33600000001 numeros[1]=+33100000002 Tableau des emails emails[0][email protected] emails[1][email protected] |
# Résultats
| Résultat | Description |
|---|---|
{resultat: X} | resultat = X = Nombre de numéros ajoutés succè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 |
| 100 | Ip non autorisée |
# 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 (opens new window)
# 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 (opens new window)
# Paramètres (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 |