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_method Texte new_campaign Obligatoire pour lancer une campagne slybroadcast.
c_record_audio Texte My First Message Nom du fichier audio tel qu'il apparaît dans votre compte. *Sensible à la casse. Inutile si c_url est fourni.
c_url Texte http://www.yourwebsite.com/MeetingReminder.wav Pour lancer une campagne avec votre propre fichier audio, utilisez c_url. Vous devez préciser le format du fichier utilisé (WAV, Mp3 ou M4a uniquement) avec c_audio. Les fichiers audio doivent durer plus de cinq secondes.
c_audio Texte wav Format du fichier audio (WAV, Mp3 ou M4a). Obligatoire uniquement si c_url est utilisé.
c_phone Texte 6173999980,6173999981 Numéros de téléphone destinataires. Maximum : 10,000 par envoi.*Inutile si c_listid est fourni.
c_listid Texte 94454 Identifiant associé à chaque liste importée sur le site. Utilisez c_method=get_phone_list pour obtenir la liste des identifiants. *Inutile si c_phone est fourni.
c_callerID Texte 6173999982 Numéro d'appelant (Caller ID) de la campagne. Il s'affichera dans la messagerie vocale du destinataire.
c_date Texte now Date et heure de remise, à l'heure de l'Est. AAAA-MM-JJ HH:MM:SS *Le format 24 heures est obligatoire.
Exemple : 17h00 = 17:00:00
c_title Texte My First Broadcast Nom ou intitulé de la campagne. (Facultatif). L'identifiant de session doit être utilisé pour demander les résultats ou les statuts.
mobile_only Masqué 1 En envoyant 1, la campagne ne sera diffusée que vers les 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 dans une campagne slybroadcast. L'identifiant de session et c_phone doivent être inclus.
c_option Masqué campaign_result À utiliser pour demander les résultats d'appel de chaque numéro d'une même campagne. L'identifiant de session doit être inclus.
c_option Masqué pause La campagne sera mise en pause. L'identifiant de session doit être inclus.
c_option Masqué run À utiliser pour relancer une campagne actuellement en pause. L'identifiant de session doit être inclus.
c_option Masqué cancel Utilisez ce paramètre pour annuler une campagne programmée. L'identifiant de session doit être inclus.
c_option Masqué stop Avec ce paramètre, les campagnes en cours de diffusion seront arrêtées.
Une campagne arrêtée ne peut pas être relancée. L'identifiant de session doit être inclus.
c_option Masqué do_not_dial À utiliser pour ajouter des numéros de téléphone à la liste des numéros à ne pas appeler (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 Utilisez ce paramètre pour retirer des numéros de la liste des numéros à ne pas appeler (Do Not Dial List) de votre compte.
c_option Masqué campaign_by_date Pour consulter tous les identifiants de session d'une date précise. Le paramètre date doit être inclus au format AAAA-MM-JJ.

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 requêtes doivent être envoyées à l'URL :
https://www.slybroadcast.com/gateway/vmb.json.php
c_method Texte get_audio_list_with_duration À utiliser pour consulter la liste complète de vos fichiers audio avec leur durée, exprimée en secondes. Les requêtes doivent être envoyées à l'URL :
https://www.slybroadcast.com/gateway/vmb.json.php
c_method Texte get_phone_list À utiliser pour récupérer la liste complète de vos listes de numéros importées sur le site, avec leurs identifiants respectifs.

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 transmettez le nom système de votre fichier audio. Inutile 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. AAAA-MM-JJ 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 et encore dans votre file d'envoi.

ENVOYER UNE CAMPAGNE SLYBROADCAST

Voici un exemple d'envoi de campagne réussi, avec la méthode POST. Nous renvoyons un accusé de réception « OK » en cas de succès. Sinon, nous renvoyons un message d'erreur indiquant les variables manquantes.

L'URL de base de tous les appels d'API, sauf mention contraire, est https://www.slybroadcast.com/gateway/vmb.json.php

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

<form action="https://www.slybroadcast.com/gateway/vmb.json.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_method" value="new_campaign"> <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 visible dans votre compte, ajoutez : --> <!-- Les noms de fichiers audio sont sensibles à la casse --> <input type="text" name="c_record_audio" value="My First Voice Message"> <!-- Pour n'envoyer qu'aux numéros mobiles, indiquez value = 1 --> <input type="hidden" name="mobile_only" value="1"> <input type="submit" value="submit"> </form>

Pour lancer une campagne avec votre propre fichier audio, utilisez c_url. Vous devez préciser le format du fichier utilisé (fichiers .WAV, .Mp3 ou .M4a uniquement) avec c_audio. Les fichiers audio doivent durer plus de cinq secondes.

<form action="https://www.slybroadcast.com/gateway/vmb.json.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_method" value="new_campaign"> <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 le fichier audio est 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 précisant une heure de fin, votre campagne ne se poursuivra pas au-delà de l'heure choisie, quel que soit son taux d'avancement.

<form action="https://www.slybroadcast.com/gateway/vmb.json.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_method" value="new_campaign"> <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, ajoutez c_endtime --> <input type="text" name="c_endtime" value="2018-02-01 20:00:00"> <input type="submit" value="submit"> </form>

Réponse JSON

{ "new_campaign": "OK", "session_id": "2103524120", "number_of_phone": 2, }, OU { "ERROR":"c_uid: required; c_password: required; c_option or c_method required; " }

RÉSULTATS D'APPEL RENVOYÉS VERS UNE URL

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

<form action="https://www.slybroadcast.com/gateway/vmb.json.php" method="post"> <input type="text" name="c_uid" value="admin@slybroadcast.com"> <input type="password" name="c_password" value=""> <input type="password" name="c_method" value="new_campaign"> <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, ajoutez : --> <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 JSON ci-dessous :

[{ "campaign id": "2103524120", "destination": "6173999980", "dial status": "OK", "fail reason": "", "delivery time": "2018-05-01 15:12:38", "carrier": "AT&T"}, {"campaign id": "2103524120", "destination": "6173999981", "dial status": "Failure", "fail reason": "Landline Removed", "delivery time": "2018-05-01 15:12:51", "carrier": "Comcast"}]

Voici un exemple de code PHP pour traiter la notification retour. *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"'; // Découpez les données en 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"; ?>

RÉSULTATS D'UNE CAMPAGNE TERMINÉE

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

<form action="https://www.slybroadcast.com/gateway/vmb.json.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>

Réponse JSON

[{ "campaign id": "9145797854", "destination": "6173999944", "dial status": "OK", "fail reason": "", "delivery time": "2018-05-01 15:12:38", "carrier": "AT&T"}, {"campaign id": "9145797854", "destination": "6173999945", "dial status": "Failure", "fail reason": "Landline Removed", "delivery time": "2018-05-01 15:12:51", "carrier": "Comcast"}]

Si votre campagne échoue, l'une des raisons d'échec suivantes vous sera indiquée dans le format ci-dessous :

{"campaign id": "9145797854", "destination": "6173999945", "dial status": "Failure", "fail reason": "Caller ID blocked", "delivery time": "2018-05-01 15:12:51", "carrier": "Comcast"}] "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"

METTRE EN PAUSE OU RELANCER VOTRE CAMPAGNE

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

<form action="https://www.slybroadcast.com/gateway/vmb.json.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, ajoutez :--> <input type="text" name="c_option" value="pause"> <!-- Pour relancer une campagne précédemment mise en pause, ajoutez :--> <input type="text" name="c_option" value="run"> <input type="submit" value="submit"> </form>

Les réponses JSON possibles sont les suivantes :

{"OK": "Campaign was paused."} OU {"ERROR": "Campaign was not paused."} OU {"OK": "Campaign was resumed."} OU {"ERROR": "Campaign was not resumed."}

CONSULTER VOS CRÉDITS RESTANTS

Pour connaître le nombre de crédits de messages restants sur votre compte, les paramètres ci-dessous doivent être utilisés.

<form action="https://www.slybroadcast.com/gateway/vmb.json.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>

Réponses JSON

[{"remaining_messages": 18246, "pending_messages": 0, }]

RÉCUPÉRER LES ID DE VOS LISTES DE NUMÉROS

Pour récupérer la liste complète de vos listes de numéros importées sur le site, avec leurs identifiants respectifs, les paramètres ci-dessous doivent être utilisés :

<form action="https://www.slybroadcast.com/gateway/vmb.json.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_phone_list"> </form>

Réponses JSON

[{"c_listid":"442178","list_name":"Office Numbers","number_of_phone":"54"}, {"c_listid":"107386","list_name":"Test","number_of_phone":"199"}] OU {"ERROR":"No phone list found."}

MISES À JOUR DE LA LISTE DE NUMÉROS À NE PAS APPELER

Grâce à la fonctionnalité Do Not Dial List (liste des numéros à ne pas appeler), vous pouvez ajouter ou retirer les numéros que vous ne souhaitez pas inclure dans vos campagnes slybroadcast. Ajouter un numéro à cette liste garantit que son titulaire ne recevra aucun message vocal envoyé depuis votre compte slybroadcast.

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

<form action="https://www.slybroadcast.com/gateway/vmb.json.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>

Réponses JSON

[{"OK": "2 phone numbers saved." }] OU [{"OK": "1 phone number(s) removed." }]

RÉCUPÉRER LA LISTE DE VOS FICHIERS AUDIO

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

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

<form action="https://www.slybroadcast.com/gateway/vmb.json.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 renverrons le nom système du fichier ainsi que le nom que vous lui avez donné et sa date et heure de création.

[{"c_sys_audio_name":"b9055b179205.wav","Audio file Title":"Test Message to Co-Workers","Create Date":"2018-01-09 11:44:39"}, {"c_sys_audio_name":"b9055b179709.wav","Audio file Title":"Customer Reminder 1","Create Date":"2017-09-28 13:11:10"}, {"c_sys_audio_name":"b9055b185998.wav","Audio file Title":"Holiday Special Event","Create Date":"2017-08-01 16:42:54"}]

SUPPRIMER UN FICHIER AUDIO

Pour supprimer un fichier audio de votre compte, envoyez votre requête à l'URL : https://www.slybroadcast.com/gateway/vmb.json.php

Le nom système du fichier doit être inclus.

*Si un fichier audio est actuellement programmé dans une campagne à venir, cette campagne se déroulera malgré tout. Vous devez supprimer la campagne pour empêcher son envoi.

<form action="https://www.slybroadcast.com/gateway/vmb.json.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="delete_audio"> <input type="text" name="c_sys_audio_name" value="b9055b179205.wav"> <input type="submit" value="submit"> </form>

Nous renverrons l'une des réponses suivantes.

[{"OK":"Audio File Delete"}] OU [{"ERROR":"Audio file not found."}]

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

Se connecter



Merci. Si un compte existe, un e-mail de réinitialisation du mot de passe vous sera envoyé.

Adresse e-mail
Mot de passe
Mot de passe oublié ?

Mot de passe oublié ?

Pas de souci. Saisissez votre adresse e-mail et nous vous enverrons un lien de réinitialisation.


Merci. Si un compte existe, un e-mail de réinitialisation du mot de passe vous sera envoyé.
Adresse e-mail