Nombre del Campo Tipo Valor de Ejemplo Definición
c_uid Texto test@slybroadcast.com Correo electrónico de inicio de sesión. Requerido para cada solicitud.
c_password Contraseña xxxxxxxx Contraseña. Requerido para cada solicitud.
c_method Texto new_campaign Requerido al enviar una campaña de Slybroadcast.
c_record_audio Texto Mi Primer Mensaje Nombre del archivo de audio tal como aparece en su cuenta. *Distingue mayúsculas de minúsculas. No requerido si se proporciona c_url.
c_url Texto http://www.suwebsite.com/RecordatorioReunion.wav Para enviar una campaña usando su propio archivo de audio, use c_url. Debe indicar el tipo de archivo que está usando (solo WAV, Mp3 o M4a) con c_audio. Los archivos de audio deben tener más de cinco segundos.
c_audio Texto wav Tipo de archivo de audio (WAV, Mp3 o M4a). Requerido solo si se usa c_url.
c_phone Texto 6173999980,6173999981 Números de teléfono de destino. Máx.: 10,000 por envío. *No requerido si se proporciona c_listid.
c_listid Texto 94454 ID de la lista asociada a cada lista subida al sitio web. Use c_method=get_phone_list para obtener la lista de IDs. *No requerido si se proporciona c_phone.
c_callerID Texto 6173999982 ID de la campaña. Aparecerá en el buzón de voz del destinatario.
c_date Texto now Fecha/Hora de entrega en hora del Este. AAAA-MM-DD HH:MM:SS *Debe usar formato de 24 horas.
Ejemplo: 5:00pm = 17:00:00
c_title Texto Mi Primera Campaña Nombre o título de la campaña. (Opcional). El Session ID debe usarse al solicitar resultados o estados.
mobile_only Oculto 1 Al enviar 1, la campaña se enviará solo a números móviles. (Opcional).

Nombre del Campo Tipo Valor de Ejemplo Definición
c_option Oculto callstatus Se usa al solicitar el estado de llamada de un número de teléfono en una campaña de Slybroadcast. Debe incluirse Session ID y c_phone.
c_option Oculto campaign_result Se usa al solicitar los resultados de llamada de cada número de teléfono en una campaña única. Debe incluirse Session ID.
c_option Oculto pause La campaña será pausada. Debe incluirse Session ID.
c_option Oculto run Se usa para reanudar una campaña que está actualmente pausada. Debe incluirse Session ID.
c_option Oculto cancel Se usa este parámetro al cancelar una campaña programada. Debe incluirse Session ID.
c_option Oculto stop Al usar este parámetro, las campañas que estén actualmente en ejecución se detendrán.
Las campañas detenidas no pueden reiniciarse. Debe incluirse Session ID.
c_option Oculto do_not_dial Se usa al agregar números telefónicos a la Lista de No Llamar de su cuenta.
Todos los números incluidos en esta lista nunca recibirán mensajes de voz enviados desde su cuenta.
c_option Oculto remove_do_not_dial Se usa este parámetro para eliminar números telefónicos de la Lista de No Llamar de su cuenta.
c_option Oculto campaign_by_date Se usa para ver todos los Session ID de una fecha específica. Formato: AAAA-MM-DD.

Nombre del Campo Tipo Valor de Ejemplo Definición
c_method Texto get_audio_list Se usa para ver la lista completa de archivos de audio. Las solicitudes deben enviarse a la URL:
https://www.slybroadcast.com/gateway/vmb.json.php
c_method Texto get_audio_list_with_duration Se usa para ver la lista completa de archivos de audio con su duración. La duración se indica en segundos. Las solicitudes deben enviarse a la URL:
https://www.slybroadcast.com/gateway/vmb.json.php
c_method Texto get_phone_list Se usa para recuperar la lista completa de listas de números de teléfono subidas al sitio web, junto con sus IDs específicos.

Nombre del Campo Tipo Valor de Ejemplo Definición
session_id Texto 2103524120 Creado automáticamente por el sistema al crear una campaña.
c_dispo_url Texto https://www.yoursite.com/results URL que recibirá los postbacks del estado de llamadas. (Opcional)
Debe reconocer la recepción de cada estado de llamada devolviendo 'OK'.
c_sys_audio_name Texto r18904b140407197964.wav Usar SOLO si se envía el nombre de archivo del sistema de su audio. No requerido si se proporciona c_url o c_record_audio.
c_endtime Texto 2019-12-31 15:30:00 La campaña se detendrá a la hora indicada, independientemente de su porcentaje de completitud. Formato: AAAA-MM-DD HH:MM:SS
remain_message Texto 1 La respuesta incluirá los créditos de mensajes restantes en su cuenta. Los créditos de mensajes pendientes son mensajes programados para entregarse y están en su cola.

ENVIANDO UNA CAMPAÑA DE SLYBROADCAST

A continuación se muestra un ejemplo de un envío de campaña exitoso, usando el método POST. Retornaremos un reconocimiento 'OK' si se realiza con éxito. De lo contrario, enviaremos un mensaje de error indicando las variables faltantes.

La URL base para todas las llamadas a la API, a menos que se indique lo contrario, es https://www.slybroadcast.com/gateway/vmb.json.php

IMPORTANTE: Todas las campañas se envían en Hora del Este y utilizan el reloj de 24 horas. (AAAA-MM-DD HH:MM:SS)
Ejemplo: 31 de diciembre de 2019 a las 5:00pm = "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"> <!-- Para usar un archivo de audio visible en su cuenta, incluir: --> <!-- Los nombres de archivos de audio son sensibles a mayúsculas y minúsculas --> <input type="text" name="c_record_audio" value="My First Voice Message"> <!-- Para enviar solo a números móviles, ingresar valor = 1 --> <input type="hidden" name="mobile_only" value="1"> <input type="submit" value="submit"> </form>

Para enviar una campaña usando su propio archivo de audio, use c_url. Debe designar el tipo de archivo que está utilizando (.WAV, .Mp3 o .M4a solo) con c_audio. Los archivos de audio deben ser mayores a cinco segundos.

<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 usa un archivo de audio desde una URL, usar c_url e incluir la extensión del archivo --> <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>


Para establecer un Tiempo de Finalización en su campaña, use c_endtime. Al insertar un Tiempo de Finalización, su campaña no se ejecutará más allá de la hora elegida, sin importar su porcentaje de completitud.

<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"> <!-- Si se establece un tiempo de finalización, incluir c_endtime --> <input type="text" name="c_endtime" value="2018-02-01 20:00:00"> <input type="submit" value="submit"> </form>

Respuesta JSON

{ "new_campaign": "OK", "session_id": "2103524120", "number_of_phone": 2, }, O { "ERROR":"c_uid: requerido; c_password: requerido; c_option o c_method requerido; " }

RESULTADOS DE LLAMADAS ENVIADOS A URL

Los usuarios pueden proporcionar una URL a la cual se enviará automáticamente el estado de cada llamada usando c_dispo_url. Sin embargo, esto es opcional.
*Los usuarios deben reconocer la recepción de cada estado de llamada devolviendo '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"> <!-- Para recibir automáticamente los estados de llamada en su propia URL, incluir: --> <input type="text" name="c_dispo_url" value="http://www.yoursite.com/mystatus.php"> <input type="submit" value="submit"> </form>

La información de su campaña se devolverá en formato JSON como se muestra a continuación:

[{ "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": "Línea fija eliminada", "delivery time": "2018-05-01 15:12:51", "carrier": "Comcast"}]

CÓDIGO PHP DE EJEMPLO PARA POSTBACK

A continuación se muestra un ejemplo de código PHP para manejar el postback. *Los usuarios deben reconocer la recepción de cada estado de llamada devolviendo 'OK'.

//$postback = '"campaign_id"|"destination"|"dispoCode"|"dispoText"|"delivery_time"|"carrier"'; $postback = '"2324444455"|"6173999980"|"OK"|""|"2018-01-10 10:00:00"|"landline"'; // Parsear los datos en variables como se muestra a continuación: list($campaign_id, $destination, $dispo_Code, $dispo_Text, $delivery_time, $carrier) = explode("|", $postback, 6); // Las variables aparecerán con ' " ' alrededor: echo $campaign_id.",".$destination; // Imprimirá: "2324444455","6173999980" // Para quitar las comillas usar: $campaign_id = str_replace('"', '', $campaign_id); $destination = str_replace('"', '', $destination); echo $campaign_id.",".$destination."\n"; // Imprimirá: 2324444455,6173999980 // Guardar sus datos y luego devolver un 'OK': echo "OK"; ?>

RESULTADOS DE CAMPAÑA COMPLETADA

Para solicitar los resultados de llamadas de cada número en una campaña, deben incluirse los parámetros a continuación. Asegúrese de que el session_id sea el recibido en la respuesta a su envío de campaña inicial.

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

Respuesta 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": "Línea fija eliminada", "delivery time": "2018-05-01 15:12:51", "carrier": "Comcast"}]

PAUSAR O REANUDAR SU CAMPAÑA

Para pausar temporalmente una campaña en curso o reanudar una campaña que se pausó previamente, debe incluir el session_id de la campaña recibido en la respuesta a su envío inicial. Retornaremos 'OK' o un error si no se encuentra el session_id.

<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"> <!-- Para pausar una campaña en ejecución incluir: --> <input type="text" name="c_option" value="pause"> <!-- Para reanudar una campaña previamente pausada incluir: --> <input type="text" name="c_option" value="run"> <input type="submit" value="submit"> </form>

Respuestas posibles en JSON:

{"OK": "La campaña fue pausada."} O {"ERROR": "La campaña no fue pausada."} O {"OK": "La campaña fue reanudada."} O {"ERROR": "La campaña no fue reanudada."}

SOLICITAR CRÉDITOS RESTANTES

Para solicitar el número de créditos de mensajes restantes en su cuenta, se deben usar los siguientes parámetros:

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

Respuestas JSON

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

OBTENER IDS DE LISTAS DE TELÉFONOS

Para obtener la lista completa de sus listas de números telefónicos subidas al sitio web junto con sus IDs específicos, se deben usar los siguientes parámetros:

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

Respuestas JSON

[{"c_listid":"442178","list_name":"Office Numbers","number_of_phone":"54"}, {"c_listid":"107386","list_name":"Test","number_of_phone":"199"}] O {"ERROR":"No se encontró ninguna lista de teléfonos."}

ACTUALIZACIONES DE LA LISTA NO LLAMAR

Con la función Lista No Llamar, puede agregar o eliminar números telefónicos que no desea incluir en sus campañas de Slybroadcast. Agregar un número a esta lista asegura que el destinatario no recibirá mensajes de voz enviados desde su cuenta.

Para agregar o eliminar números telefónicos de su Lista No Llamar personal, se deben usar los siguientes parámetros:

<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=""> <!-- Agregar números a la Lista No Llamar --> <input type="text" name="c_option" value="do_not_dial"> <input type="text" name="c_phone" value="6173999980,6173999981"> <!-- Eliminar números de la Lista No Llamar --> <input type="text" name="c_option" value="remove_do_not_dial"> <input type="text" name="c_phone" value="6173999980"> </form>

Respuestas JSON

[{"OK": "2 números de teléfono guardados."}] O [{"OK": "1 número de teléfono eliminado."}]

RECUPERAR LISTA DE ARCHIVOS DE AUDIO

Para recuperar la lista completa de archivos de audio en su cuenta, envíe un POST a la URL: https://www.slybroadcast.com/gateway/vmb.json.php

Use get_audio_list_with_duration para incluir la duración de cada archivo de audio, en segundos.

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

Se devolverá el nombre de archivo del sistema junto con el nombre de archivo creado por usted y la fecha/hora de creación.

[{"c_sys_audio_name":"b9055b179205.wav","Audio file Title":"Mensaje de prueba a compañeros","Create Date":"2018-01-09 11:44:39"}, {"c_sys_audio_name":"b9055b179709.wav","Audio file Title":"Recordatorio de cliente 1","Create Date":"2017-09-28 13:11:10"}, {"c_sys_audio_name":"b9055b185998.wav","Audio file Title":"Evento Especial de Vacaciones","Create Date":"2017-08-01 16:42:54"}]

ELIMINAR UN ARCHIVO DE AUDIO

Para eliminar un archivo de audio de su cuenta, envíe un POST a la URL: https://www.slybroadcast.com/gateway/vmb.json.php

Debe incluirse el nombre de archivo del sistema.

*Si un archivo de audio está programado para usarse en una campaña futura, la campaña se completará. Debe eliminar la campaña para detener su envío.

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

Se devolverá una de las siguientes respuestas:

[{"OK":"Archivo de audio eliminado"}] O [{"ERROR":"Archivo de audio no encontrado"}]

¿Correcciones? Envíenos un correo a support@slybroadcast.com.

Log In



Thank you! If an account is found, a password reset email will be sent.

Email Address
Password

Forgot Your Password?

No problem! Enter your email address and we'll send you a reset link.


Thank you! If an account is found, a password reset email will be sent.
Email Address