Saltar al contenido principal

Puntos Finales de Mensajería

El módulo de Mensajería gestiona conversaciones en tiempo real, mensajes de chat, notificaciones push, entrega de SMS/correo electrónico, conexiones WebSocket, mensajería privada, registro de dispositivos y proveedores de mensajería de texto. Proporciona la capa de comunicación utilizada en todas las aplicaciones ChurchApps para chat de transmisión en vivo y notificaciones asincrónicas.

Ruta base: /messaging

Conversaciones

Ruta base: /messaging/conversations

MétodoRutaAuthPermisoDescripción
GET/timeline/ids?ids=JWTCargar conversaciones por IDs separados por comas
GET/messages/:contentType/:contentIdJWTCargar conversaciones para contenido con mensajes paginados
GET/postsJWTObtener conversaciones de tipo publicación para los grupos del usuario actual
GET/:churchId/:contentType/:contentIdPublicCargar conversaciones por tipo de contenido e ID
GET/:churchId/:idPublicCargar una sola conversación por ID
POST/JWTCrear o actualizar conversaciones (lote)
POST/startJWTComenzar una nueva conversación con un mensaje de comentario inicial
DELETE/:churchId/:idJWTEliminar una conversación

Mensajes

Ruta base: /messaging/messages

MétodoRutaAuthPermisoDescripción
GET/conversation/:conversationIdJWTCargar todos los mensajes para una conversación
GET/:churchId/:idPublicCargar un solo mensaje por ID
POST/JWTGuardar mensajes (lote). Envía actualizaciones en tiempo real
POST/sendPublicEnviar mensajes (lote, público). Envía actualizaciones en tiempo real
DELETE/:churchId/:idJWTEliminar un mensaje

Mensajes Privados

Ruta base: /messaging/privatemessages

MétodoRutaAuthPermisoDescripción
GET/JWTCargar todos los mensajes privados para el usuario actual
GET/existing/:personIdJWTEncontrar una conversación privada existente con una persona específica
GET/:idJWTCargar un mensaje privado por ID
POST/JWTEnviar mensajes privados (lote). Dispara notificación push al destinatario

Notificaciones

Ruta base: /messaging/notifications

MétodoRutaAuthPermisoDescripción
GET/unreadCountJWTObtener conteo de notificaciones no leídas para el usuario actual
GET/myJWTCargar todas las notificaciones para el usuario actual
GET/:churchId/person/:personIdJWTCargar notificaciones para una persona específica
GET/:churchId/:idJWTCargar una notificación por ID
POST/JWTCrear o actualizar notificaciones (lote)
POST/createJWTCrear notificaciones para múltiples personas
POST/sendTestJWTEnviar una notificación push de prueba
POST/pingPublicCrear una notificación desde un activador externo
DELETE/:churchId/:idJWTEliminar una notificación

Dispositivos

Ruta base: /messaging/devices

Gestiona el registro de dispositivos para notificaciones push y emparejamiento de contenido.

MétodoRutaAuthPermisoDescripción
POST/enrollJWTInscribir o actualizar un dispositivo (registro de push móvil)
POST/enrollAnonPublicInscribir un dispositivo anónimo y generar código de emparejamiento de 4 caracteres
POST/PublicGuardar dispositivos (lote)
GET/pair/:pairingCodeJWTEmparejar un dispositivo usando su código de emparejamiento
GET/status/:deviceIdPublicVerificar estado de emparejamiento de un dispositivo
GET/:churchIdJWTCargar todos los dispositivos para una iglesia
GET/:churchId/person/:personIdJWTCargar todos los dispositivos para una persona
GET/:churchId/:idJWTCargar un dispositivo por ID
DELETE/:churchId/:idJWTEliminar un dispositivo

Plantillas de Correo Electrónico

Ruta base: /messaging/emailTemplates

Gestiona plantillas de correo electrónico reutilizables y envío de correos electrónicos basados en plantillas a grupos.

MétodoRutaAuthPermisoDescripción
GET/JWTCargar todas las plantillas de correo electrónico para la iglesia
GET/:idJWTCargar una plantilla de correo electrónico única por ID
GET/preview/:groupIdJWTVista previa de entrega de correo electrónico para un grupo
POST/JWTCrear o actualizar plantillas de correo electrónico (lote)
POST/sendJWTEnviar correo electrónico basado en plantilla a todos los miembros de un grupo
DELETE/:idJWTEliminar una plantilla de correo electrónico

Páginas Relacionadas