# Envoyer

Fuseau horaire

Nous utilisons le fuseau horaire d'Europe Centrale (Paris) : UTC+1 en heure d'hiver / UTC+2 en heure d'été

# Envoyer un RCS

Dispositions légales

Rappels

En cas de non-respect de ces dispositions légales, les sanctions pénales peuvent être lourdes. L’opérateur a la possibilité de tracer les numéros litigieux ou contestables. L'opérateur pourra, sans preuve de justificatifs de bonne foi, appliquer une pénalité dont le montant maximum est de 1000 Euros HT par manquement, multiplié par le nombre de cas constatés.

# URL à appeler

[POST] https://www.spot-hit.fr/api/envoyer/rcs

# Liste des paramètres RCS de l'API

Paramètre	Description
key	Votre clé API d'identification
media_id	l'id de votre média créé avec l'outil media RCS
agent_id	l'identifiant unique de votre agent RCS, récupérer la liste des agents disponibles
contact_groups	Liste des id de groupes de destinataires (tableau) Ne pas utiliser avec le paramètre `custom_list`
ou
custom_list	Liste de numéros de vos destinataires (tableau) Ne pas utiliser avec le paramètre `contact_groups`
fallback_message	Message de repli qui sera envoyé aux destinataires non compatibles RCS. Si non renseigné, le message de repli sera automatiquement généré avec le début du RCS, limité à 160 caractères moins la mention STOP forcée, soit 145 caractères. Nous vous conseillons d'inclure dans votre message une expérience similaire sous forme de lien. Vous trouverez son URL dans le panneau des informations de votre média au format suivant rcs.site/000000. Attention : Les caractères `, ^, €, }, {, [, ~, ]` et `\` comptent doubles. Message de repli personnalisé : {Nom de la colonne}, exemple : {Nom} Pour rappel, afin de respecter les obligations légales de la CNIL, il est impératif d'inclure une mention de désinscription (STOP au 36200) si elle n'est pas forcée.
fallback_sender	Optionnel 11 caractères maximum (espaces inclus) En savoir plus sur les règles à respecter Si vide, l'expéditeur de votre message de repli sera un numéro court à 5 chiffres auquel 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 iPhones 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 marque également dans le corps du message. International Cette fonctionnalité n'est pas encore supportée.
date	Optionnel Date d'envoi du message (format yyyy-mm-dd hh:mm:ss) Si aucune date n'est entrée ou si celle-ci précède la date actuelle, le message sera envoyé immédiatement.
campaign_title	Optionnel Cette information non visible par les destinataires vous permet d’identifier votre campagne (maximum 50 caractères).
timezone	Optionnel Permet de modifier le fuseau horaire. Par défaut : Europe/Paris

# Tableau des erreurs

Accéder au tableau des erreurs

# Envoyer un SMS

Dispositions légales

Nous vous rappelons que les horaires d’envois des messages marketing en France Métropolitaine sont encadrés par la CNIL, et ne sont autorisés que du lundi au samedi de 8h00 à 22h00 hors jours fériés.
Par conséquent les envois de messages marketing programmés pendant les créneaux interdits seront reportés à l'ouverture du prochain créneau autorisé.

Rappels

En cas de non-respect de ces dispositions légales, les sanctions pénales peuvent être lourdes. L’opérateur a la possibilité de tracer les numéros litigieux ou contestables.
L'opérateur pourra, sans preuve de justificatifs de bonne foi, appliquer une pénalité dont le montant maximum est de 1000 Euros HT par manquement, multiplié par le nombre de cas constatés.

# URL à appeler

https://www.spot-hit.fr/api/envoyer/sms

# Liste des paramètres SMS de l'API

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} Pour rappel, afin de respecter les obligations légales de la CNIL, il est impératif d'inclure une mention de désinscription. Afin que votre campagne soit validée, il vous faut inclure la mention « STOP au 36200 » dans votre message.
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) En savoir plus sur les règles à respecter 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 9 SMS concaténés (soit 1377 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 (Vous 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 50 caractères).
destinataires_type `all` `groupe` `datas`	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 : `["+33600000001" => ["nom" => "Nom 1", "prenom" => "Prénom 1"], "+33600000002" => ["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

# Tableau des erreurs

Accéder au tableau des erreurs

# Envoyer un MMS

Dispositions légales

Rappels

En cas de non-respect de ces dispositions légales, les sanctions pénales peuvent être lourdes. L’opérateur a la possibilité de tracer les numéros litigieux ou contestables.
L'opérateur pourra, sans preuve de justificatifs de bonne foi, appliquer une pénalité dont le montant maximum est de 1000 Euros HT par manquement, multiplié par le nombre de cas constatés.

# URL à appeler

https://www.spot-hit.fr/api/envoyer/mms

# Liste des paramètres MMS de l'API

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 50 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

# Tableau des erreurs

Accéder au tableau des erreurs

# 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 suivant : PNG, GIF, JPG ou JPEG (5 mo maximum)

Recommendations pour les GIFs animés

Si vous souhaitez utiliser un gif animé, nous vous conseillons fortement de le réduire de votre côté à l'aide d'un logiciel spécialisé (tel que Photoshop) avant de l'uploader.
Bien que notre système soit capable de réduire un gif animé, le résultat sera souvent d'une qualité bien inférieure à ce que vous pourrez obtenir de cette façon.

# 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 email de l'API

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.
fichiers	Optionnel Liste d'id de fichiers (tableau ou séparé par une virgule) 5 maximum. Vous pouvez retrouver les ids des catégories de la médiathèque : "Mes Fichiers", "Fichiers partagés", "Mes fichiers privés" En survolant les fichiers avec la souris.
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.
alternatif	Optionnel Le texte alternatif améliore votre délivrabilité et permet aux destinataires d’avoir un aperçu du contenu si le HTML est désactivé sur la messagerie. Vous pouvez écrire une version uniquement texte et sans variable de votre e-mail.
timezone	Optionnel Permet de modifier le fuseau horaire. Par défaut : Europe/Paris

# Tableau des erreurs

Accéder au tableau des erreurs

# Importer une pièce jointe

# URL à appeler

https://www.spot-hit.fr/api/email/upload

# Paramètres

Paramètre	Description
key	Votre clé API d'identification
fichier	Fichier que vous souhaitez importer. Formats acceptés : 'pdf', 'doc', 'docx', 'odt', 'xls', 'xlsx', 'csv', 'txt' (5Mb maximum)
private	Optionnel Si égal à "1", permet que le fichier soit enregistré dans "Mes fichiers privés" plutôt que dans "Mes fichiers"

# Résultats

Résultat	Description
`{"success":true,"file":"1234"}`	success = true = Elément importé avec succès file = identifiant de votre fichier
`{"success":false,"msg":"Message erreur."}`	success = false = Elément non importé msg = message d'erreur

# Envoyer un Message Vocal

Dispositions légales

Nous vous rappelons que les horaires d’envois du démarchage téléphonique marketing en France Métropolitaine sont encadrés par la CNIL, et ne sont autorisés que :
- du lundi au samedi de 8h00 à 20h00 hors jours fériés pour le direct répondeur.
- du lundi au vendredi de 10h00 à 13h00 et de 14h00 à 20h00 hors jours fériés pour le vocal au décroché.

Rappels

Par conséquent les envois de messages marketing programmés pendant les créneaux interdits seront reportés à l'ouverture du prochain créneau autorisé.
En cas de non-respect de ces dispositions légales, les sanctions pénales peuvent être lourdes. L’opérateur a la possibilité de tracer les numéros litigieux ou contestables.
L'opérateur pourra, sans preuve de justificatifs de bonne foi, appliquer une pénalité dont le montant maximum est de 1000 Euros HT par manquement, multiplié par le nombre de cas constatés.

# URL à appeler

https://www.spot-hit.fr/api/envoyer/vocal

# Liste des paramètres envoi message vocal de l'API

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 ou via le serveur vocal en appelant le 01 81 90 40 00 (direct_repondeur) ou le 01 81 90 50 05 (appels)
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 »
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 50 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

# Tableau des erreurs

Accéder au tableau des erreurs

# 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) avec une durée entre 15 et 55 secondes

# Résultats

Résultat	Description
`{"success":true,"file":"1234","duree":30}`	success = true = Elément importé avec succès file = identifiant de votre fichier duree = durée du fichier en secondes
`{"success":false,"msg":"Message erreur."}`	success = false = Elément non importé msg = message d'erreur

# 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 50 caractères)
timezone	Optionnel Permet de modifier le fuseau horaire. Par défaut : Europe/Paris

# Tableau des erreurs

Accéder au tableau des erreurs

# 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

← Fonctionnement Erreurs →