MobileSphere ha desarrollado y implementado una solución API para la plataforma Slybroadcast con el fin de facilitar la integración de su solución a proveedores externos. 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 del archivo de audio al buzón de voz — manteniendo el proceso prácticamente transparente para el usuario final. Consulta nuestra API en Postman aquí.
Todas las solicitudes deben enviarse como un formulario utilizando el método POST. Envía al URL que aparece a continuación, a menos que se indique lo contrario:
https://www.mobile-sphere.com/gateway/vmb.php
Nombre del campo | Tipo | Valor de ejemplo | Definición |
---|---|---|---|
c_uid | Texto | test@slybroadcast.com | Dirección de correo electrónico de inicio de sesión. Requerido para cada solicitud. |
c_password | Contraseña | xxxxxxxx | Contraseña. Requerido para cada solicitud. |
c_record_audio | Texto | Mi Primer Mensaje | Nombre del archivo de audio tal como aparece en tu cuenta. *Sensible a mayúsculas y minúsculas. No es obligatorio si se proporciona c_url. |
c_url | Texto | http://www.yourwebsite.com/MeetingReminder.wav | Para enviar una campaña usando tu propio archivo de audio, utiliza c_url. Debes indicar el tipo de archivo que estás usando (solo archivos WAV, Mp3 o M4a) con c_audio. Los archivos de audio deben tener más de cinco segundos de duración. |
c_audio | Texto | wav | Tipo de archivo de audio (WAV, Mp3 o M4a). Requerido solo si se utiliza c_url. |
c_phone | Texto | 6173999980,6173999981 | Números de teléfono de destino. Máximo: 10,000 por envío. |
c_callerID | Texto | 6173999982 | ID de llamada de la campaña. Este número aparecerá en el buzón de voz del destinatario. Debe ser un número de teléfono válido. |
c_date | Texto | now | Fecha/hora de entrega en hora del Este. Formato: AAAA-MM-DD HH:MM:SS *Debe usarse el formato de 24 horas. Ejemplo: 5:00 p.m. = 17:00:00 |
c_title | Texto | Mi Primera Transmisión | Nombre o título de la campaña. (Opcional). El ID de sesión 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 | Usar al solicitar el estado de llamada de un número de teléfono en una campaña de slybroadcast. El ID de sesión y c_phone deben incluirse. |
c_option | Oculto | campaign_result | Usar al solicitar los resultados de llamada para cada número de teléfono en una sola campaña. El ID de sesión debe incluirse. |
c_option | Oculto | pause | La campaña será pausada. El ID de sesión debe incluirse. |
c_option | Oculto | run | Usar para reanudar una campaña que actualmente está pausada. El ID de sesión debe incluirse. |
c_option | Oculto | cancel | Usar este parámetro al cancelar una campaña programada. El ID de sesión debe incluirse. |
c_option | Oculto | stop | Al usar este parámetro, las campañas que estén en ejecución se detendrán. Las campañas detenidas no pueden reiniciarse. El ID de sesión debe incluirse. |
c_option | Oculto | do_not_dial | Usar esto para agregar números de teléfono a la Lista de No Llamar de tu cuenta. Todos los números incluidos en esta lista nunca recibirán mensajes de voz enviados desde tu cuenta. |
c_option | Oculto | remove_do_not_dial | Para eliminar números de teléfono de la Lista de No Llamar de tu cuenta, usa este parámetro. |
c_option | Oculto | campaign_by_date | Para ver todos los ID de sesión de una fecha específica. Formato: AAAA-MM-DD. |
Nombre del Campo | Tipo | Valor de Ejemplo | Definición |
---|---|---|---|
c_method | Texto | get_audio_list | Usar para ver la lista completa de tus archivos de audio. Las solicitudes deben realizarse en la siguiente URL: https://www.mobile-sphere.com/gateway/vmb.aflist.php |
c_method | Texto | get_audio_list_with_duration | Usar para ver la lista completa de tus archivos de audio con su duración, en segundos. Las solicitudes deben realizarse en la siguiente URL: https://www.mobile-sphere.com/gateway/vmb.aflist.php |
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á las notificaciones de estado de las llamadas. (Opcional) Debes confirmar 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 del archivo de audio del sistema. No es necesario si se proporciona c_url o c_record_audio. |
c_endtime | Texto | 2019-12-31 15:30:00 | La campaña se detendrá en el momento indicado, independientemente de si ha sido completada. Formato: YYYY-MM-DD HH:MM:SS |
remain_message | Texto | 1 | La respuesta incluirá los créditos de mensajes restantes en tu cuenta. Los créditos de mensajes pendientes son mensajes programados para ser entregados y que están en tu cola. |
A continuación se muestra un ejemplo de una campaña exitosa enviada a través de un formulario HTML, utilizando el método POST. Devolveremos un reconocimiento 'OK' si tiene éxito. De lo contrario, enviaremos un mensaje de error indicando las variables faltantes.
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:00 pm = "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 solamente) con c_audio. Los archivos de audio deben tener más de cinco segundos.
Para establecer un Tiempo de Finalización para 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 finalización.
Los siguientes datos se devolverán si una campaña se recibe correctamente.
Los usuarios pueden proporcionar una URL a la que se publicará 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 el siguiente formato:
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'.
Puede solicitar el estado de su campaña actual utilizando los parámetros a continuación. Las campañas programadas para el futuro incluyen hasta 90 días adelante.
Su estado se devolverá en el siguiente formato:
Para solicitar los resultados de llamadas de cada número en una campaña, se deben incluir los siguientes parámetros. Asegúrese de que el session_id sea el recibido en respuesta al envío inicial de su campaña.
Su estado se devolverá en el siguiente formato:
Para pausar temporalmente una campaña en ejecución o reanudar una campaña previamente pausada, debe incluir el session_id de la campaña recibido en la respuesta a su envío inicial. Devolveremos 'OK' o un error si no se encuentra el session_id.
Respuestas posibles incluyen:
Para cancelar una campaña en ejecución o programada, debe incluir el session_id de la campaña recibido en la respuesta a su envío inicial. Devolveremos 'OK' o un error si no se encuentra el session_id.
*Una vez que una campaña es cancelada, no puede ser reiniciada.
Para solicitar la cantidad de créditos de mensajes restantes en su cuenta, se deben usar los siguientes campos. La respuesta incluirá los créditos de mensajes restantes en su cuenta. Los créditos pendientes son mensajes programados para ser enviados y están en su cola.
Los siguientes datos serán devueltos:
Con la función Lista de No Marcar, puede agregar o eliminar números de teléfono que no desea incluir en sus campañas de slybroadcast. Agregar un número a esta lista garantiza que el destinatario no recibirá mensajes de voz enviados desde su cuenta de slybroadcast.
Para agregar o eliminar números de su Lista de No Marcar personal, se deben usar los siguientes parámetros:
Para obtener una lista completa de los archivos de audio en su cuenta, publique en la URL:
https://www.mobile-sphere.com/gateway/vmb.aflist.php
Use get_audio_list_with_duration para incluir la duración de cada archivo de audio, en segundos.
Devolveremos el nombre del archivo de nuestro sistema junto con su nombre de archivo personalizado y la fecha/hora de creación.
Para descargar un archivo de audio haciendo referencia al nombre de 5 dígitos asignado al grabar mediante el Centro de Grabación Slybroadcast o nuestro nombre de sistema, publique en la URL:
https://www.mobile-sphere.com/gateway/vmb.dla.php
Si hace referencia a nuestro nombre de archivo del sistema, use c_sys_audio_name.
¿Correcciones? Envíenos un correo a support@slybroadcast.com.