Documentation de référence de l'API

• HTML

  |

  JSON

  
  Mise à jour le 2 juin 2026
  
  Pour commencer
  

  MobileSphere a développé et déployé une solution d'API pour la plateforme slybroadcast afin de faciliter l'intégration de sa solution par des prestataires tiers. Chaque transaction exige des informations précises qui indiquent à la passerelle que la transaction est authentique et qu'elle a été soumise en connaissance de cause par le client. L'API prend en charge toutes les étapes du processus de transaction sécurisé — collecte des données, envoi des données et remise du fichier audio sur la messagerie vocale — tout en restant pratiquement transparente pour l'utilisateur final. Consultez notre API sur Postman ici.

  Toutes les requêtes doivent être envoyées sous forme de formulaire, avec la méthode POST. Envoyez-les à l'URL ci-dessous, sauf indication contraire :
  https://www.mobile-sphere.com/gateway/vmb.php

  Votre hébergeur doit prendre en charge un langage de script côté serveur ou CGI, tel qu'ASP, PHP, Perl ou JSP. Pour recevoir le statut de chaque appel, MobileSphere utilise un webhook. Les exemples ci-dessous utilisent la méthode de formulaire HTTP POST. Vous pouvez indiquer une URL vers laquelle chaque statut d'appel sera publié automatiquement. Cette possibilité reste toutefois facultative.
  c_dispo_url="https://www.yoursite.com/results"
  *Vous devez accuser réception de chaque statut d'appel en renvoyant 'OK' si vous utilisez c_dispo_url.
  
  Autres points importants
  IMPORTANT 1 : toutes les valeurs contenant une URL doivent être encodées.
  IMPORTANT 2 : les noms de fichiers audio sont sensibles à la casse. « Meeting1 » et « meeting1 » correspondent à deux fichiers différents.
  IMPORTANT 3 : toutes les campagnes sont envoyées à l'heure de l'Est (Eastern Time) et utilisent le format 24 heures. (YYYY-MM-DD HH:MM:SS)
  Exemple : 31 décembre 2055 à 17h00 = "2055-12-31 17:00:00"
  IMPORTANT 4 : TLSv1.1 ou TLSv1.2 doit être utilisé. Nous n'acceptons pas TLSv1.
  
  
  

Nom du champ	Type	Exemple de valeur	Définition
c_uid	Texte	test@slybroadcast.com	Adresse e-mail de connexion. Obligatoire pour chaque requête.
c_password	Mot de passe	xxxxxxxx	Mot de passe. Obligatoire pour chaque requête.
c_record_audio	Texte	My First Message	Nom du fichier audio tel qu'il apparaît dans votre compte. *Sensible à la casse. Non requis si c_url est fourni.
c_url	Texte	http://www.yourwebsite.com/MeetingReminder.wav	Pour envoyer une campagne avec votre propre fichier audio, utilisez c_url. Vous devez préciser le type de fichier utilisé (fichiers WAV, Mp3 ou M4a uniquement) à l'aide de c_audio. Les fichiers audio doivent durer plus de cinq secondes.
c_audio	Texte	wav	Type de fichier audio (WAV, Mp3 ou M4a). Requis uniquement si c_url est utilisé.
c_phone	Texte	6173999980,6173999981	Numéros de téléphone destinataires. Maximum : 10,000 par envoi.
c_callerID	Texte	6173999982	Identifiant d'appel (Caller ID) de la campagne. Il s'affichera dans la boîte vocale du destinataire. Doit être un numéro de téléphone valide.
c_date	Texte	now	Date et heure de remise, à l'heure de l'Est. YYYY-MM-DD HH:MM:SS *Le format 24 heures est obligatoire. Exemple : 17h00 = 17:00:00
c_title	Texte	My First Broadcast	Nom ou titre de la campagne. (Facultatif). Le Session ID doit être utilisé pour demander des résultats ou des statuts.
mobile_only	Masqué	1	En envoyant 1, la campagne sera diffusée uniquement vers des numéros mobiles. (Facultatif).

Nom du champ	Type	Exemple de valeur	Définition
c_option	Masqué	callstatus	À utiliser pour demander le statut d'appel d'un seul numéro de téléphone dans une campagne slybroadcast. Le Session ID et c_phone doivent être inclus.
c_option	Masqué	campaign_result	À utiliser pour demander les résultats d'appel de chaque numéro de téléphone d'une même campagne. Le Session ID doit être inclus.
c_option	Masqué	pause	La campagne sera mise en pause. Le Session ID doit être inclus.
c_option	Masqué	run	À utiliser pour reprendre une campagne actuellement en pause. Le Session ID doit être inclus.
c_option	Masqué	cancel	Utilisez ce paramètre pour annuler une campagne programmée. Le Session ID doit être inclus.
c_option	Masqué	stop	Avec ce paramètre, les campagnes actuellement en cours seront arrêtées. Une campagne arrêtée ne peut pas être relancée. Le Session ID doit être inclus.
c_option	Masqué	do_not_dial	À utiliser pour ajouter des numéros de téléphone à la Do Not Dial List de votre compte. Les numéros figurant sur cette liste ne recevront jamais de messages vocaux envoyés depuis votre compte.
c_option	Masqué	remove_do_not_dial	Pour retirer des numéros de téléphone de la Do Not Dial List de votre compte, utilisez ce paramètre.
c_option	Masqué	campaign_by_date	Pour consulter tous les Session ID d'une date précise. Le paramètre date doit être inclus, au format YYYY-MM-DD.

Nom du champ	Type	Exemple de valeur	Définition
c_method	Texte	get_audio_list	À utiliser pour consulter la liste complète de vos fichiers audio. Les envois doivent être adressés à l'URL : https://www.mobile-sphere.com/gateway/vmb.aflist.php
c_method	Texte	get_audio_list_with_duration	À utiliser pour consulter la liste complète de vos fichiers audio avec leur durée, en secondes. Les envois doivent être adressés à l'URL : https://www.mobile-sphere.com/gateway/vmb.aflist.php

Nom du champ	Type	Exemple de valeur	Définition
session_id	Texte	2103524120	Créé automatiquement par le système lors de la création d'une campagne.
c_dispo_url	Texte	https://www.yoursite.com/results	URL qui recevra les notifications de statut d'appel. (Facultatif) Vous devez accuser réception de chaque statut d'appel en renvoyant 'OK'.
c_sys_audio_name	Texte	r18904b140407197964.wav	À utiliser UNIQUEMENT si vous envoyez le nom système de votre fichier audio. Non requis si c_url ou c_record_audio est fourni.
c_endtime	Texte	2019-12-31 15:30:00	La campagne s'arrêtera à l'heure indiquée, qu'elle soit terminée ou non. YYYY-MM-DD HH:MM:SS
remain_message	Texte	1	La réponse indiquera le nombre de crédits de messages restants sur votre compte. Les crédits en attente correspondent aux messages programmés qui se trouvent encore dans votre file d'attente.

Voici un exemple de campagne envoyée avec succès via un formulaire HTML, avec la méthode POST. Nous renvoyons un accusé de réception 'OK' en cas de réussite. Sinon, nous renvoyons un message d'erreur indiquant les variables manquantes.

IMPORTANT : toutes les campagnes sont envoyées à l'heure de l'Est (Eastern Time) et utilisent le format 24 heures. (YYYY-MM-DD HH:MM:SS)
Exemple : 31 décembre 2019 à 17h00 = "2019-12-31 17:00:00"

<form action="https://www.mobile-sphere.com/gateway/vmb.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="hidden" name="c_callerID" value="6173999980"> <input type="text" name="c_phone" value="6173999981,6173999982,6173999983"> <input type="hidden" name="c_date" value="2019-12-31 17:00:00"> <!-- Pour utiliser un fichier audio présent dans votre compte, incluez : --> <!-- Les noms de fichiers audio sont sensibles à la casse --> <input type="text" name="c_record_audio" value="My First Voice Message"> <!--Pour envoyer UNIQUEMENT vers des numéros mobiles, saisissez la valeur 1--> <input type="hidden" name="mobile_only" value="1"> <input type="submit" value="submit"> </form>

Pour envoyer une campagne avec votre propre fichier audio, utilisez c_url. Vous devez préciser le type de fichier utilisé (fichiers .WAV, .Mp3 ou .M4a uniquement) à l'aide de c_audio. Les fichiers audio doivent durer plus de cinq secondes.

<form action="https://www.mobile-sphere.com/gateway/vmb.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="hidden" name="c_callerID" value="6173999980"> <input type="text" name="c_phone" value="6173999981,6173999982,6173999983"> <input type="hidden" name="c_date" value="2019-12-31 17:00:00"> <!--Si vous utilisez un fichier audio accessible depuis une URL, utilisez c_url et indiquez l'extension du fichier--> <input type="text" name="c_url" value="http://www.yourwebsite.com/MeetingReminder.wav"> <input type="text" name="c_audio" value="wav"> <input type="submit" value="submit"> </form>

Pour définir une heure de fin pour votre campagne, utilisez c_endtime. En indiquant une heure de fin, votre campagne ne se poursuivra pas au-delà de l'heure choisie, quel que soit son pourcentage d'avancement.

<form action="https://www.mobile-sphere.com/gateway/vmb.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="hidden" name="c_callerID" value="6173999980"> <input type="text" name="c_phone" value="6173999981,6173999982,6173999983"> <input type="hidden" name="c_date" value="now"> <!--Pour définir une heure de fin, incluez c_endtime--> <input type="text" name="c_endtime" value="2018-02-01 20:00:00"> <input type="submit" value="submit"> </form>

Les données suivantes seront renvoyées si la campagne est bien reçue.

OK session_id=9377466671 number of phone=1

Si votre campagne échoue, l'un des motifs d'échec suivants vous sera communiqué au format ci-dessous :

"Session ID" | "Call To" | "Status" | "Reason for Failure" | "Delivery Time" | "Carrier" 9145797854 | 6173999984 | Failure | Unable to Detect Voice Mail | 2017-12-31 17:00:32 | Paetec "Caller ID blocked" "Unable to Detect Voice Mail" "VM may be full or not setup" "Not Covered" "Voicemail Busy" "Incompatible" "Insufficient Funds" "Voicemail Service Not Provided" "Call To & Caller ID cannot match" "Bad Audio" "Audio File Duration Too Short" "Audio Duration Too Short"

Vous pouvez indiquer une URL vers laquelle chaque statut d'appel sera publié automatiquement grâce à c_dispo_url . Cette possibilité reste toutefois facultative.
*Vous devez accuser réception de chaque statut d'appel en renvoyant 'OK'.

<form action="https://www.mobile-sphere.com/gateway/vmb.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="hidden" name="c_callerID" value="6173999980"> <input type="text" name="c_phone" value="6173999981,6173999982,6173999983"> <input type="hidden" name="c_date" value="now"> <!-- Pour recevoir automatiquement les statuts d'appel sur votre propre URL, incluez : --> <input type="text" name="c_dispo_url" value="http://www.yoursite.com/mystatus.php"> <input type="submit" value="submit"> </form>

Les informations de votre campagne vous seront renvoyées au format suivant :

"Session ID" | "Call To" | "Status" | "Reason for Failure" | "Delivery Time" | "Carrier" 9145797854 | 6173999981 | OK | | 2017-12-31 17:00:00 | verizon wireless 9145797854 | 6173999982 | OK | | 2017-12-31 17:00:04 | verizon wireless 9145797854 | 6173999983 | Failure | Do Not Dial List Removed | | | 9145797854 | 6173999984 | Failure | Unable to Detect VM | 2017-12-31 17:00:32 | Paetec 9145797854 | 6173999985 | Failure | VM may be full or not setup | 2017-12-31 17:00:34 | TMobile

Voici un exemple de code PHP permettant de traiter le retour de statut. *Vous devez accuser réception de chaque statut d'appel en renvoyant 'OK'.

//$postback = '"campaign_id"|"destination"|"dispoCode"|"dispoText"|"delivery_time"|"carrier"'; $postback = '"2324444455"|"6173999980"|"OK"|""|"2018-01-10 10:00:00"|"landline"'; // Analysez les données pour les répartir dans des variables, comme ci-dessous : list($campaign_id, $destination, $dispo_Code, $dispo_Text, $delivery_time, $carrier) = explode("|", $postback, 6); // Les variables apparaîtront entourées de ' " ' : echo $campaign_id.",".$destination; // Affichera : "2324444455","6173999980" //Pour supprimer les ' " ', utilisez : $campaign_id = str_replace('"', '', $campaign_id); $destination = str_replace('"', '', $destination); echo $campaign_id.",".$destination."\n"; //Affichera : 2324444455,6173999980 // Enregistrez vos données, puis renvoyez un 'OK' : echo "OK"; ?>

Vous pouvez demander le statut de votre campagne en cours à l'aide des paramètres ci-dessous. Les campagnes programmées sont prises en compte jusqu'à 90 jours à l'avance.

<form action="https://www.mobile-sphere.com/gateway/vmb.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="text" name="c_option" value="campaign_reports"> <!-- Pour récupérer les statuts de toutes les campagnes en cours, incluez :--> <input type="text" name="c_ctype" value="running"> <!-- Pour récupérer les statuts de toutes les campagnes en pause, incluez :--> <input type="text" name="c_ctype" value="paused"> </form>

Votre statut vous sera renvoyé au format suivant :

"Session ID" | "Total Numbers" | "Delivery Time" | "Status" | 9145797854 | 2500 | 2017-03-31 10:00:00 | paused 9145797854 | 2 | 2017-03-31 10:02:04 | running

Pour obtenir les résultats d'appel de chaque numéro de téléphone d'une même campagne, les paramètres suivants doivent être inclus. Assurez-vous que le session_id est bien celui reçu en réponse à l'envoi initial de votre campagne.

<form action="https://www.mobile-sphere.com/gateway/vmb.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="text" name="c_option" value="campaign_result"> <input type="text" name="session_id" value="9145797854"> <input type="submit" value="submit"> </form>

Votre statut vous sera renvoyé au format suivant :

"Session ID" | "Call To" | "Status" | "Reason for Failure" | "Delivery Time" | "Carrier" 9145797854 | 6173999981 | OK | | 2017-12-31 17:00:00 | verizon wireless 9145797854 | 6173999982 | OK | | 2017-12-31 17:00:04 | verizon wireless 9145797854 | 6173999983 | Failure | Do Not Dial List Removed | | | 9145797854 | 6173999984 | Failure | Unable to Detect VM | 2017-12-31 17:00:32 | Paetec

Pour mettre en pause temporairement une campagne en cours ou reprendre une campagne précédemment mise en pause, vous devez inclure le session_id de la campagne, reçu en réponse à votre campagne initiale. Nous renverrons un 'OK', ou une erreur si le session_id est introuvable.

<form action="https://www.mobile-sphere.com/gateway/vmb.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="text" name="session_id" value="9145797854"> <!-- Pour mettre en pause une campagne en cours, incluez :--> <input type="text" name="c_option" value="pause"> <!-- Pour reprendre une campagne précédemment mise en pause, incluez :--> <input type="text" name="c_option" value="run"> <input type="submit" value="submit"> </form>

Les réponses possibles sont notamment :

OK 9145797854 <session_id> was paused OK 9145797854 <session_id> resumed ERROR 9145797854 <session_id> invalid or not found

Pour annuler une campagne en cours ou une campagne programmée, vous devez inclure le session_id de la campagne, reçu en réponse à votre campagne initiale. Nous renverrons un 'OK', ou une erreur si le session_id est introuvable.
*Une fois annulée, une campagne ne peut plus être relancée.

<form action="https://www.mobile-sphere.com/gateway/vmb.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="text" name="session_id" value="9145797854"> <!-- Pour annuler une campagne en cours ou programmée, incluez :--> <input type="text" name="c_option" value="stop"> <input type="submit" value="submit"> </form>

Pour connaître le nombre de crédits de messages restants sur votre compte, les champs suivants doivent être utilisés. La réponse indiquera le nombre de crédits de messages restants sur votre compte. Les crédits en attente correspondent aux messages programmés qui se trouvent encore dans votre file d'attente.

<form action="https://www.mobile-sphere.com/gateway/vmb.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="text" name="remain_message" value="1"> <input type="submit" value="submit"> </form>

Les données suivantes seront renvoyées :

remaining messages=200 pending messages=0

Grâce à la fonctionnalité Do Not Dial List, vous pouvez ajouter ou retirer les numéros de téléphone que vous ne souhaitez pas inclure dans vos campagnes slybroadcast. Ajouter un numéro à cette liste garantit que le destinataire ne recevra aucun message vocal envoyé depuis votre compte slybroadcast.

Pour ajouter ou retirer des numéros de téléphone de votre Do Not Dial List personnelle, les paramètres ci-dessous doivent être utilisés :

<form action="https://www.mobile-sphere.com/gateway/vmb.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <!-- Ajouter des numéros à la Do Not Dial List --> <input type="text" name="c_option" value="do_not_dial"> <input type="text" name="c_phone" value="6173999980,6173999981"> <!-- Retirer des numéros de la Do Not Dial List --> <input type="text" name="c_option" value="remove_do_not_dial"> <input type="text" name="c_phone" value="6173999980"> </form>

Pour récupérer la liste complète des fichiers audio de votre compte, envoyez votre requête à l'URL :
https://www.mobile-sphere.com/gateway/vmb.aflist.php

Utilisez get_audio_list_with_duration pour inclure la durée de chaque fichier audio, en secondes.

<form action="https://www.mobile-sphere.com/gateway/vmb.aflist.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="text" name="c_method" value="get_audio_list"> <input type="submit" value="submit"> </form>

Nous renvoyons le nom de fichier de notre système, accompagné du nom de fichier que vous avez créé ainsi que de la date et de l'heure de création.

"System File Name" | "Self Created Audio File Name" | "Time Created" r18032b404759888.wav | My First Slybroadcast Recording | 2018-01-01 15:03:00

Pour télécharger un fichier audio en référençant le nom à 5 chiffres attribué lors de l'enregistrement via le Slybroadcast Recording Center, ou notre nom système, envoyez votre requête à l'URL :
https://www.mobile-sphere.com/gateway/vmb.dla.php

<form action="https://www.mobile-sphere.com/gateway/vmb.dla.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="text" name="c_audio_code" value="55555"> </form>

Si vous référencez le nom de fichier de notre système, utilisez c_sys_audio_name.

<form action="https://www.mobile-sphere.com/gateway/vmb.dla.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="text" name="c_sys_audio_name" value="r18094b4047197888.wav"> </form>

• Détails de l'intégration
  Zapier automatise vos tâches les plus fastidieuses en connectant slybroadcast à plus de 750 outils professionnels, dont Slack, MailChimp, Gmail et Trello. Il suffit de créer des automatisations appelées Zaps pour qu'elles prennent en charge vos tâches répétitives. Aucune compétence en code n'est nécessaire. Créez un compte Zapier gratuit pour profiter de ces Zaps automatisés très populaires :
  
  
  
  Comment connecter slybroadcast à Zapier ?
  
  1. Connectez-vous à votre compte Zapier.
  2. Rendez-vous dans « Connected Accounts » depuis la barre de menu supérieure.
  3. Cliquez ensuite sur « Connect new account » et recherchez « slybroadcast »
  4. Utilisez vos identifiants pour connecter votre compte slybroadcast à Zapier.
  5. Une fois cette étape terminée, vous pouvez créer votre première automatisation ! Utilisez un Zap prêt à l'emploi ou créez le vôtre avec l'éditeur de Zaps. Créer un Zap ne demande aucune connaissance en programmation et vous êtes guidé pas à pas tout au long de la configuration.
  6. Besoin d'inspiration ? Découvrez tout ce qu'il est possible de faire avec slybroadcast et Zapier.
  
  

Une correction à signaler ? Écrivez-nous à support@slybroadcast.com.