MobileSphere ha desarrollado y desplegado una solución API para la plataforma Slybroadcast con el fin de facilitar la integración de su solución para proveedores de terceros. Todas las transacciones requieren información específica que indique al gateway que la transacción es auténtica y que ha sido enviada para su procesamiento con el conocimiento del cliente. La API puede manejar todos los pasos necesarios en el proceso de transacción segura — recopilación de datos, envío de datos y entrega de archivos de audio al buzón de voz — manteniendo el proceso prácticamente transparente para el usuario final. Vea nuestra API en Postman aquí.
Todas las solicitudes deben enviarse como un formulario usando el método POST. Para recibir respuestas en JSON, publique en la URL a continuación, salvo que se indique lo contrario.
https://www.slybroadcast.com/gateway/vmb.json.php Otros Aspectos| 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. |
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"
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.
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.
Respuesta JSON
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'.
La información de su campaña se devolverá en formato JSON como se muestra a continuación:
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'.
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.
Respuesta JSON
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.
Respuestas posibles en JSON:
Para solicitar el número de créditos de mensajes restantes en su cuenta, se deben usar los siguientes parámetros:
Respuestas JSON
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:
Respuestas JSON
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:
Respuestas JSON
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.
Se devolverá el nombre de archivo del sistema junto con el nombre de archivo creado por usted y la fecha/hora de creación.
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.
Se devolverá una de las siguientes respuestas:
¿Correcciones? Envíenos un correo a support@slybroadcast.com.