API VOICE
Grâce à cette API, vous pouvez envoyer des messages vocaux enregistrés à vos différents contacts. Suivant les destinations, les messages peuvent être envoyés via des appels direct ou avec dépôt sur répondeur.
Inscription
Pour demander un accès envoyez un mail à support@mtarget.fr. avec comme sujet de mail "Demande d'accès à l'API de Push Vocal" et en précisant vos coordonnées :
- email du compte
- nom
- prénom
- nom de la société
- Siret
- numéro de téléphone mobile
Une fois vos accès demandés, nous vous fournirons des identifiants afin d'accéder à notre API en ligne et ainsi pouvoir programmer vos push vocaux, et récupérer vos statistiques.
Enregistrements
Les requêtes présentées ci-dessous vous permettent de traiter les messages audios que vous souhaitez déposer lors de vos campagnes.
Déposer un message audio
Cette requête vous permet de déposer un message audio, nécessaire avant de planifier un Push Vocal.
Ci-dessous un format de requête CURL pour envoyer le message :
curl -H "access-key:7xm8Dx2EiHZacblbgKiJ3cUwB49uIq2C" -X 'POST' -F 'audioFile=@/Path/to/file.wav' --url https://api-vms.mtarget.fr/api/Recording/post
Quelques informations à retenir :
- La durée minimale de tout message vocal est de 15 secondes. En dessous, le message ne sera pas distribué.
- Il n'y a pas de durée maximale, mais tout fichier audio dépassant 60 secondes sera surtaxé.
- Il est important de noter qu'au-delà de 35 secondes, l'impact du message sera moins efficace.
- La taille du fichier ne doit pas dépasser 15MB.
Content-Typeaudio/wav
Type de contenu.
access-key7xm8Dx2EiHZacblbgKiJ3cUwB49uIq2CClé d'accès à notre API fournie au moment de votre inscription.
BODYaudioFile
Fichier audio au format MP3 ou WAV que vous souhaitez envoyer.
Lister les informations liées à un message audio
Cette requête vous permet de récupérer les informations liées à un message audio.
Content-Typeapplication/json
Type de contenu.
access-keyOFAFhdezhj645oAAA78fFU78Z65FClé d'accès à notre API fournie au moment de votre inscription.
Récupérer les informations liées à tous vos messages audio
Cette requête liste les informations de tous les messages audio que vous avez déposé.
Content-Typeapplication/json
Type de contenu.
access-keyOFAFhdezhj645oAAA78fFU78Z65FClé d'accès à notre API fournie au moment de votre inscription.
Push Vocal
Les requêtes ci-dessous vous permettent d'envoyer ou programmer un Push Vocal en appelant directement un correspondant ou en déposant le message sur le répondeur de son opérateur.
Envoi ou planification d'un push vocal ou répondeur
Grâce à cette API, il est possible d'envoyer un message vocal à une liste de destinataire.
Contraintes techniques et recommandations :
- Il n'y a pas de blocage d'envoi hors tranches horaires réglementaires : "Il est de votre responsabilité d'être conforme à la législation en vigueur sur les horaires à respecter pour l'émission de campagnes à titre commercial."
- Une campagne commencée le jour J doit se terminer le jour J. Si la campagne est stoppée, quelle qu’en soit la raison, elle sera statuée comme TERMINEE à 00h00.
- Aucune limite n'est imposée quant au nombre de contacts par campagne. Cependant, une campagne ayant une durée de validité de 1 jour, il est nécessaire de veiller à ce que le nombre de contacts de votre fichier concorde avec les plages horaires définies. Il est recommandé de limiter la taille d'un fichier de contacts à 100 000 destinataires.
- Chaque fichier de contacts est soumis à des vérifications techniques automatiques avant le démarrage d’une campagne (notamment HLR). Il faut compter jusqu’à 15 minutes de vérification par tranche de 10 000 contacts. Afin d’assurer le bon déroulement des opérations dont le volume est conséquent, les campagnes de plus de 10 000 contacts doivent être préparées la veille.
Content-Typeapplication/json
Type de contenu.
access-keyOFAFhdezhj645oAAA78fFU78Z65FClé d'accès à notre API fournie au moment de votre inscription.
BODY{ "numbers": [
"+336XXXXXXXX",
"+336XXXXXXXX",
"+336XXXXXXXX",
"+336XXXXXXXX"
], [Obligatoire] Liste des numéros auxquels vous souhaitez envoyer vos campagnes : Max. 200000. Les campagnes contenant plus de 50000 numéros doivent être prévues au moins 24h à l'avance.
"countryIsoCode": "FRA",
[Obligatoire] Le code ISO-3 du pays vers lequel vous souhaitez envoyer votre campagne.
"pushOption": "1",
[Obligatoire]
1 : Push répondeur,
2 : Push en appel direct
Dépend du pays.
"programmationDatetime": "2021-01-01 12:00",
Si vous souhaitez programmer votre push, vous pouvez renseigner une heure d'envoi.
"recordingId": "81dc9bdb52d04dc20036dbd8313ed055",
[Obligatoire] Le recordingId qui vous a été délivré au moment où vous avez uploadé votre fichier.
"callerNumber": "+33XXXXXXXXX",
[Obligatoire] Ce numéro sera énoncé / apparaîtra sur l'écran de vos destinataires. Il peut être soumis à certaines contraintes suivant le pays de destination. Seuls les numéros géographiques (01, 02, 03, 04 et 05) et non géographiques (09) peuvent être utilisés comme numéro d'appelant. Il est impératif que ce numéro soit valide pour que la campagne puisse être envoyée.
"customPushId": "YourPersonalPushCustomId",
Identifiant unique à votre usage personnel seulement.
"callbackURL": "https://your-personal-callback-url.com/post",
Une URL de retour vers laquelle nous enverrons les statistiques globales de votre campagne une fois celle-ci terminée.
}
Récupérer les informations d'un Push
Cette API vous permet de récupérer les informations liées à un push.
Content-Typeapplication/json
Type de contenu.
access-keyOFAFhdezhj645oAAA78fFU78Z65FClé d'accès à notre API fournie au moment de votre inscription.
Statistiques
Les requêtes ci-dessous vous permettent de récupérer les statistiques de vos différents Push Vocaux.
Statistiques globales
Les statistiques globales de vos push. Elles sont alimentées à intervalles réguliers lorsque l'envoi du push a démarré.
Elles contiennent entre autres :
Le nombre de messages envoyés.
Le nombre de messages déposés.
Dans le cas d'un push répondeur, le nombre de dépôts de message échoués après le nombre maximum de tentatives.
Dans le cas d'un push direct, le nombre de messages écoutés à plus de 80%.
Content-Typeapplication/json
Type de contenu.
access-keyOFAFhdezhj645oAAA78fFU78Z65FClé d'accès à notre API fournie au moment de votre inscription.
Statistiques individuelles
Les statistiques individuelles de chaque message envoyé lors d'un push. Ces statistiques sont disponibles une fois le push terminé.
Elles contiennent entre autres :
Le numéro contacté.
Un des statuts suivant : UNALLOCATED_NUMBER, ANSWERED, ANSWERED_HANGUP, BUSY, FAILED, NO ANSWER, BLACKLISTED.
La durée du message déposé en millisecondes dans le cas d'un push répondeur, sinon la durée d'écoute du message par le correspondant pour un push direct.
Le nombre maximum de tentatives de contact.
Content-Typeapplication/json
Type de contenu.
access-keyOFAFhdezhj645oAAA78fFU78Z65FClé d'accès à notre API fournie au moment de votre inscription.
Envoi de stats à la fin de la campagne
Si vous nous indiquez une "callbackUrl" à l'envoi de votre Push, l'URL correspondante devra être prompt à recevoir une requête POST capable de traiter les paramètres ci-dessous. Cette requête vous parviendra une fois le Push terminé. Votre URL doit être certifiée et accessible via HTTPS.
Content-Typeapplication/json
Type de contenu
BODY{ "vocalPushId": "Kd366Xlibwh9IWIC3ZD4d8aDpc644mAW",
Identifiant unique du Push.
"customPushId": "YourCustomPushId",
Votre identifiant personnalisé associé à ce Push.
"sentMessages": 1000,
Le nombre de messages envoyés.
"postedMessages": 950,
Le nombre de messages déposés.
"failedAfterMaximumCallAttempt": 50,
Dans le cas d'un push répondeur, le nombre de dépôts de message échoués après le nombre maximum de tentatives.
"listened80PercentMessages": 800,
Dans le cas d'un push direct, le nombre de messages ayant été écoutés à plus de 80%.
}