Transmisión
Nota: el endpoint Iniciar transmisión solo puede usarse para comenzar a transmitir desde un dispositivo Kaleo Connect. Este endpoint no puede usarse para iniciar transmisión desde un navegador web. Todos los demás endpoints de transmisión controlan tanto navegadores como dispositivos Kaleo Connect.
Obtener estado de transmisión
Leer la sesión actual y la configuración compartida de la iglesia. Todos los campos están presentes, incluso cuando está inactivo.
Parámetros de ruta
churchIdEl ID de tu iglesia. Cópialo desde la página API (en Integraciones) en tu panel de control.
Obtener estado de transmisión › Respuestas
Éxito
streamingtrue durante una sesión activa, incluyendo inicio, reconexiones y cierre. No confirma que el audio esté llegando.
sessionIdID de sesión actual; null mientras está inactivo.
startedAtHora de inicio de la sesión actual; null mientras está inactivo.
deadlineAtHora de detención automática; null mientras está inactivo o si no hay fecha límite registrada.
speakerLanguageCódigo de idioma del orador actual; null mientras está inactivo.
targetLanguagesCódigos de idiomas de traducción actuales; vacío mientras está inactivo.
voiceVoz de traducción, incluso mientras está inactivo.
visibletrue muestra subtítulos; false los oculta. También aplica mientras está inactivo.
publisherDispositivo Kaleo Connect o navegador que envía audio; null mientras está inactivo.
phaseEtapa de la sesión; inactivo significa que no hay sesión activa.
Valores predeterminados de la iglesia para el próximo inicio manual. Las anulaciones de sesión activa no cambian estos valores.
Iniciar transmisión
Inicia la transmisión en un dispositivo Kaleo Connect usando la configuración guardada. El cuerpo opcional puede seleccionar un deviceId y anular configuraciones para esta sesión. Sin deviceId, Kaleo selecciona la fuente de audio predeterminada configurada en la página Kaleo Connect (en Integraciones) en tu panel de control si hay múltiples dispositivos con capacidad de audio disponibles, o el único dispositivo fuente de audio disponible si solo hay uno.
Parámetros de ruta
churchIdEl ID de tu iglesia. Cópialo desde la página API (en Integraciones) en tu panel de control.
Iniciar transmisión › Cuerpo de la solicitud opcional
deviceIdID opcional del dispositivo fuente de audio desde GET /devices. Anula el predeterminado de la iglesia para esta sesión. Si se omite, usa la fuente de audio predeterminada guardada o el único dispositivo emparejado con capacidad de audio; múltiples dispositivos sin un predeterminado requieren selección. El dispositivo seleccionado debe estar listo.
Configuraciones solo para esta sesión. Los campos omitidos usan los valores predeterminados guardados.
Iniciar transmisión › Respuestas
Éxito
streamingtrue durante una sesión activa, incluyendo inicio, reconexiones y cierre. No confirma que el audio esté llegando.
sessionIdID de sesión actual; null mientras está inactivo.
startedAtHora de inicio de la sesión actual; null mientras está inactivo.
deadlineAtHora de detención automática; null mientras está inactivo o si no hay fecha límite registrada.
speakerLanguageCódigo de idioma del orador actual; null mientras está inactivo.
targetLanguagesCódigos de idiomas de traducción actuales; vacío mientras está inactivo.
voiceVoz de traducción, incluso mientras está inactivo.
visibletrue muestra subtítulos; false los oculta. También aplica mientras está inactivo.
publisherDispositivo Kaleo Connect o navegador que envía audio; null mientras está inactivo.
phaseEtapa de la sesión; inactivo significa que no hay sesión activa.
Valores predeterminados de la iglesia para el próximo inicio manual. Las anulaciones de sesión activa no cambian estos valores.
Detener transmisión
Detiene la sesión de transmisión actual. No se necesita cuerpo en la solicitud.
Parámetros de ruta
churchIdEl ID de tu iglesia. Cópialo desde la página API (en Integraciones) en tu panel de control.
Detener transmisión › Respuestas
Éxito
streamingtrue durante una sesión activa, incluyendo inicio, reconexiones y cierre. No confirma que el audio esté llegando.
sessionIdID de sesión actual; null mientras está inactivo.
startedAtHora de inicio de la sesión actual; null mientras está inactivo.
deadlineAtHora de detención automática; null mientras está inactivo o si no hay fecha límite registrada.
speakerLanguageCódigo de idioma del orador actual; null mientras está inactivo.
targetLanguagesCódigos de idiomas de traducción actuales; vacío mientras está inactivo.
voiceVoz de traducción, incluso mientras está inactivo.
visibletrue muestra subtítulos; false los oculta. También aplica mientras está inactivo.
publisherDispositivo Kaleo Connect o navegador que envía audio; null mientras está inactivo.
phaseEtapa de la sesión; inactivo significa que no hay sesión activa.
Valores predeterminados de la iglesia para el próximo inicio manual. Las anulaciones de sesión activa no cambian estos valores.
Cambiar voz de traducción
Cambiar la voz de traducción mientras está inactivo o transmitiendo.
Parámetros de ruta
churchIdEl ID de tu iglesia. Cópialo desde la página API (en Integraciones) en tu panel de control.
Cambiar voz de traducción › Cuerpo de la solicitud
voiceVoz de traducción. Puede cambiarse mientras está inactivo o transmitiendo.
Cambiar voz de traducción › Respuestas
Éxito
streamingtrue durante una sesión activa, incluyendo inicio, reconexiones y cierre. No confirma que el audio esté llegando.
sessionIdID de sesión actual; null mientras está inactivo.
startedAtHora de inicio de la sesión actual; null mientras está inactivo.
deadlineAtHora de detención automática; null mientras está inactivo o si no hay fecha límite registrada.
speakerLanguageCódigo de idioma del orador actual; null mientras está inactivo.
targetLanguagesCódigos de idiomas de traducción actuales; vacío mientras está inactivo.
voiceVoz de traducción, incluso mientras está inactivo.
visibletrue muestra subtítulos; false los oculta. También aplica mientras está inactivo.
publisherDispositivo Kaleo Connect o navegador que envía audio; null mientras está inactivo.
phaseEtapa de la sesión; inactivo significa que no hay sesión activa.
Valores predeterminados de la iglesia para el próximo inicio manual. Las anulaciones de sesión activa no cambian estos valores.
Cambiar visibilidad
Mostrar u ocultar subtítulos mientras está inactivo o transmitiendo. Ocultar subtítulos no detiene la sesión.
Parámetros de ruta
churchIdEl ID de tu iglesia. Cópialo desde la página API (en Integraciones) en tu panel de control.
Cambiar visibilidad › Cuerpo de la solicitud
visibletrue muestra subtítulos; false los oculta mientras la transmisión continúa.
Cambiar visibilidad › Respuestas
Éxito
streamingtrue durante una sesión activa, incluyendo inicio, reconexiones y cierre. No confirma que el audio esté llegando.
sessionIdID de sesión actual; null mientras está inactivo.
startedAtHora de inicio de la sesión actual; null mientras está inactivo.
deadlineAtHora de detención automática; null mientras está inactivo o si no hay fecha límite registrada.
speakerLanguageCódigo de idioma del orador actual; null mientras está inactivo.
targetLanguagesCódigos de idiomas de traducción actuales; vacío mientras está inactivo.
voiceVoz de traducción, incluso mientras está inactivo.
visibletrue muestra subtítulos; false los oculta. También aplica mientras está inactivo.
publisherDispositivo Kaleo Connect o navegador que envía audio; null mientras está inactivo.
phaseEtapa de la sesión; inactivo significa que no hay sesión activa.
Valores predeterminados de la iglesia para el próximo inicio manual. Las anulaciones de sesión activa no cambian estos valores.
Borrar subtítulos
Borra el feed actual de subtítulos. No se necesita cuerpo en la solicitud.
Parámetros de ruta
churchIdEl ID de tu iglesia. Cópialo desde la página API (en Integraciones) en tu panel de control.
Borrar subtítulos › Respuestas
Éxito
streamingtrue durante una sesión activa, incluyendo inicio, reconexiones y cierre. No confirma que el audio esté llegando.
sessionIdID de sesión actual; null mientras está inactivo.
startedAtHora de inicio de la sesión actual; null mientras está inactivo.
deadlineAtHora de detención automática; null mientras está inactivo o si no hay fecha límite registrada.
speakerLanguageCódigo de idioma del orador actual; null mientras está inactivo.
targetLanguagesCódigos de idiomas de traducción actuales; vacío mientras está inactivo.
voiceVoz de traducción, incluso mientras está inactivo.
visibletrue muestra subtítulos; false los oculta. También aplica mientras está inactivo.
publisherDispositivo Kaleo Connect o navegador que envía audio; null mientras está inactivo.
phaseEtapa de la sesión; inactivo significa que no hay sesión activa.
Valores predeterminados de la iglesia para el próximo inicio manual. Las anulaciones de sesión activa no cambian estos valores.
Cambiar fecha límite de auto-detención
Establece la hora de auto-detención para una sesión activa. Devuelve el estado actualizado de transmisión.
Parámetros de ruta
churchIdEl ID de tu iglesia. Cópialo desde la página API (en Integraciones) en tu panel de control.
Cambiar fecha límite de auto-detención › Cuerpo de la solicitud
deadlineAtHora futura de auto-detención con Z o desplazamiento de zona horaria. No más tarde de seis horas después de startedAt.
Cambiar fecha límite de auto-detención › Respuestas
Éxito
streamingtrue durante una sesión activa, incluyendo inicio, reconexiones y cierre. No confirma que el audio esté llegando.
sessionIdID de sesión actual; null mientras está inactivo.
startedAtHora de inicio de la sesión actual; null mientras está inactivo.
deadlineAtHora de detención automática; null mientras está inactivo o si no hay fecha límite registrada.
speakerLanguageCódigo de idioma del orador actual; null mientras está inactivo.
targetLanguagesCódigos de idiomas de traducción actuales; vacío mientras está inactivo.
voiceVoz de traducción, incluso mientras está inactivo.
visibletrue muestra subtítulos; false los oculta. También aplica mientras está inactivo.
publisherDispositivo Kaleo Connect o navegador que envía audio; null mientras está inactivo.
phaseEtapa de la sesión; inactivo significa que no hay sesión activa.
Valores predeterminados de la iglesia para el próximo inicio manual. Las anulaciones de sesión activa no cambian estos valores.
Ajustar tiempo de auto-detención
Agregar o restar tiempo de auto-detención. Mientras está inactivo, cambia la duración para el próximo inicio manual. Mientras transmite, cambia la fecha límite actual. Cada solicitud aplica un ajuste separado.
Parámetros de ruta
churchIdEl ID de tu iglesia. Cópialo desde la página API (en Integraciones) en tu panel de control.
Ajustar tiempo de auto-detención › Cuerpo de la solicitud
deltaSecondsSegundos para agregar a la duración inactiva o fecha límite actual; valores negativos restan. No puede ser 0. Duración inactiva: 60–21600 segundos. Fecha límite en vivo: futura, dentro de seis horas de startedAt.
Ajustar tiempo de auto-detención › Respuestas
Éxito
streamingtrue durante una sesión activa, incluyendo inicio, reconexiones y cierre. No confirma que el audio esté llegando.
sessionIdID de sesión actual; null mientras está inactivo.
startedAtHora de inicio de la sesión actual; null mientras está inactivo.
deadlineAtHora de detención automática; null mientras está inactivo o si no hay fecha límite registrada.
speakerLanguageCódigo de idioma del orador actual; null mientras está inactivo.
targetLanguagesCódigos de idiomas de traducción actuales; vacío mientras está inactivo.
voiceVoz de traducción, incluso mientras está inactivo.
visibletrue muestra subtítulos; false los oculta. También aplica mientras está inactivo.
publisherDispositivo Kaleo Connect o navegador que envía audio; null mientras está inactivo.
phaseEtapa de la sesión; inactivo significa que no hay sesión activa.
Valores predeterminados de la iglesia para el próximo inicio manual. Las anulaciones de sesión activa no cambian estos valores.

