Vai al contenuto principale

Messaging Endpoints

The Messaging module manages real-Ora conversations, chat messages, push notifications, SMS/email delivery, WebSocket connections, private messaging, device registration, and texting providers. It provides the communication layer used across all ChurchApps applications for both live streaming chat and asynchronous notifications.

Base path: /messaging

Conversations​

Base path: /messaging/conversations

MethodPathAuthPermessoDescription
GET/timeline/ids?ids=JWT—Load conversations by comma-separated IDs with first/last messages
GET/messages/:contentType/:contentIdJWT—Load conversations for content with paginated messages (?page=&limit=)
GET/postsJWT—Get post-Digita conversations for the current Utente's Gruppi
GET/posts/Gruppo/:groupIdJWT—Get post-Digita conversations for a specific Gruppo
GET/current/:churchId/:contentType/:contentIdPublic—Get or Crea the current conversation for content (auto-decrypts contentId)
GET/:churchId/:contentType/:contentIdPublic—Load conversations by content Digita and ID
GET/:churchId/:idPublic—Load a single conversation by ID
POST/JWT—Crea or update conversations (batch)
POST/startJWT—Start a new conversation with an initial comment message
Elimina/:churchId/:idJWT—Elimina a conversation

Person notes access control​

Conversations with contentType: "person" (the Notes tab on a person record) or contentType: "personConfidential" (the Confidential Notes section) are gated on every read and write path, including the otherwise-public routes above, which return 401 for these content types. person requires the MembershipApi People / Modifica Permesso; personConfidential requires People / Visualizza Confidential Notes. For scoped API keys, people:write carries both actions (the key's Utente must still hold the underlying Ruolo Permesso).

Example: Start a Conversation​

POST /messaging/conversations/start
Authorization: Bearer <token>

{
"groupId": "group-123",
"contentType": "group",
"contentId": "group-123",
"title": "Weekly Discussion",
"comment": "Welcome to this week's discussion thread!"
}
{
"id": "conv-456",
"churchId": "church-789",
"contentType": "group",
"contentId": "group-123",
"title": "Weekly Discussion",
"dateCreated": "2026-02-17T10:00:00.000Z",
"visibility": "public",
"allowAnonymousPosts": false,
"groupId": "group-123"
}

Messages​

Base path: /messaging/messages

MethodPathAuthPermessoDescription
GET/conversation/:conversationIdJWT—Load all messages for a conversation
GET/catchup/:churchId/:conversationIdPublic—Load all messages for a conversation (public catchup for live chat)
GET/:churchId/:idPublic—Load a single message by ID
POST/JWT—Salva messages (batch). Sends real-Ora updates and triggers notifications. Updating an existing message requires being its author or holding content.Modifica; the stored author is never reassignable
POST/sendPublic—Send messages (batch, public). Sends real-Ora updates via WebSocket and triggers notifications
POST/setCalloutJWT—(legacy) Broadcast a callout message in real Ora. No Attivo client; live stream chat No longer renders callouts
Elimina/:churchId/:idJWT—Elimina a message and broadcast the deletion in real Ora. See Message moderation

Message moderation​

Deleting a message is allowed for:

  • the message's author;
  • Staff with content.Modifica (anywhere in the church);
  • Gruppo leaders, for conversations with a contentType of Gruppo or groupAnnouncement whose contentId is a Gruppo they lead (leaderGroupIds on the JWT).

Person-note conversations (person / personConfidential) are never leader-moderated — they use the notes Permessi (people.Modifica, people.viewConfidentialNotes) instead.

Leaders get Elimina only, not Modifica: rewriting another Membro's message stays restricted Per the author and content.Modifica Staff.

Example: Send a Message​

POST /messaging/messages/send

[
{
"churchId": "church-789",
"conversationId": "conv-456",
"personId": "person-123",
"displayName": "John Smith",
"content": "Hello everyone!",
"messageType": "comment"
}
]
[
{
"id": "msg-001",
"churchId": "church-789",
"conversationId": "conv-456",
"personId": "person-123",
"displayName": "John Smith",
"timeSent": "2026-02-17T10:05:00.000Z",
"content": "Hello everyone!",
"messageType": "comment"
}
]

Private Messages​

Base path: /messaging/privatemessages

MethodPathAuthPermessoDescription
GET/JWT—Load all private messages for the current Utente (includes last message per conversation, marks all as read)
GET/existing/:personIdJWT—Trova an existing private conversation with a specific person
GET/:idJWT—Load a private message by ID (clears notification if addressed Per current Utente)
POST/JWT—Send private messages (batch). Triggers push notification Per recipient

Notifications​

Base path: /messaging/notifications

MethodPathAuthPermessoDescription
GET/unreadCountJWT—Get unread notification count for the current Utente
GET/myJWT—Load all notifications for the current Utente (marks all as read)
GET/tmpEmailPublic—Trigger daily email notification digest (debug/cron endpoint)
GET/:churchId/person/:personIdJWT—Load notifications for a specific person
GET/:churchId/:idJWT—Load a notification by ID
POST/JWT—Crea or update notifications (batch)
POST/CreaJWT—Crea notifications for multiple people. Body: { peopleIds, contentType, contentId, message, link }
POST/markRead/:churchId/:personIdJWT—Mark all notifications as read for a person
POST/sendTestJWT—Send a test push notification. Body: { personId, title }
POST/pingPublic—Crea a notification from an external trigger. Body: { personId, churchId, contentType, contentId, message, triggeredByPersonId }
Elimina/:churchId/:idJWT—Elimina a notification

Example: Crea Notifications​

POST /messaging/notifications/create
Authorization: Bearer <token>

{
"peopleIds": ["person-123", "person-456"],
"contentType": "group",
"contentId": "group-789",
"message": "New event posted in your group",
"link": "/groups/group-789"
}

Notification Preferences​

Base path: /messaging/notificationpreferences

Extends standard CRUD. The base class provides POST / (Crea or update, No Permesso Obbligatorio).

MethodPathAuthPermessoDescription
POST/JWT—Crea or update notification preferences (from CRUD base class)
GET/myJWT—Load notification preferences for the current Utente (auto-creates defaults if none exist)

Connections​

Base path: /messaging/connections

Manages WebSocket/real-Ora connections for chat, Gruppo conversations, private messages, and live streaming. See Real-time Architecture for the end-Per-end protocol.

MethodPathAuthPermessoDescription
GET/:churchId/:conversationIdPublic—Load all connections for a conversation
POST/Public—Register connections (batch). Triggers an Frequenza broadcast on the conversation. Body items: { churchId, conversationId, socketId, displayName?, personId? }
POST/setNamePublic—Update the display name for a connection by socket ID. Body: { socketId, name }
Elimina/:churchId/:conversationId/:socketIdPublic—Drop a connection from a conversation. Triggers an Frequenza broadcast
POST/tmpSendAlertPublic—Send a notification alert Per a person's connections. Body: { churchId, personId }

Devices​

Base path: /messaging/devices

Manages device registration for push notifications and content pairing (e.g., Lessons app on TV displays).

MethodPathAuthPermessoDescription
POST/enrollJWT—Enroll or update a device (mobile push registration). Matches by FCM token or device ID
POST/enrollAnonPublic—Enroll an anonymous device and generate a 4-character pairing code
POST/Public—Salva devices (batch)
GET/pair/:pairingCodeJWT—Pair a device using its pairing code. Facoltativo ?contentType=&contentId= Per assign content
GET/status/:deviceIdPublic—Check pairing status of a device
GET/:churchIdJWT—Load all devices for a church
GET/:churchId/person/:personIdJWT—Load all devices for a person
GET/:churchId/:idJWT—Load a device by ID
Elimina/:churchId/:idJWT—Elimina a device

Example: Enroll a Device​

POST /messaging/devices/enroll
Authorization: Bearer <token>

{
"fcmToken": "firebase-token-abc123",
"appName": "B1Mobile",
"label": "John's iPhone",
"deviceInfo": "iOS 17, iPhone 15"
}
{
"id": "device-001",
"churchId": "church-789",
"fcmToken": "firebase-token-abc123",
"appName": "B1Mobile",
"label": "John's iPhone",
"registrationDate": "2026-02-17T10:00:00.000Z",
"lastActiveDate": "2026-02-17T10:00:00.000Z"
}

Device Contents​

Base path: /messaging/devicecontents

Manages content assignments for paired devices (e.g., which lesson is displayed on a TV).

MethodPathAuthPermessoDescription
GET/deviceId/:deviceIdJWT—Load content assignments for a device
POST/JWT—Salva device content assignments (batch)
Elimina/:idJWT—Elimina a device content assignment

Texting​

Base path: /messaging/texting

Manages SMS texting providers, Gruppo text messaging, and delivery tracking.

MethodPathAuthPermessoDescription
GET/providersJWT—Load texting providers for the church (credentials are masked)
GET/preview/:groupIdJWT—Preview recipients for a Gruppo text (eligible, opted-out, No-phone counts)
GET/sentJWT—Load all sent text message records for the church
GET/sent/:id/detailsJWT—Load a sent text with per-recipient delivery logs
POST/providersJWT—Salva texting providers (batch). Encrypts API credentials
POST/sendJWT—Send an SMS Per all eligible Membri of a Gruppo. Body: { groupId, message }
POST/sendPersonJWT—Send an SMS Per a single person. Body: { personId, phoneNumber, message }
Elimina/providers/:idJWT—Elimina a texting provider

Example: Send Gruppo Text​

POST /messaging/texting/send
Authorization: Bearer <token>

{
"groupId": "group-123",
"message": "Reminder: Service starts at 10 AM this Sunday!"
}
{
"totalMembers": 50,
"recipientCount": 42,
"successCount": 40,
"failCount": 2,
"optedOutCount": 5,
"noPhoneCount": 3
}

Email Templates​

Base path: /messaging/emailTemplates

Manages reusable email templates and sending templated emails Per Gruppi.

MethodPathAuthPermessoDescription
GET/JWT—Load all email templates for the church
GET/:idJWT—Load a single email template by ID
GET/preview/:groupIdJWT—Preview email delivery for a Gruppo (eligible recipient count, Membri with No email)
POST/JWT—Crea or update email templates (batch)
POST/sendJWT—Send a templated email Per all Membri of a Gruppo. Body: { groupId, subject, htmlContent }
Elimina/:idJWT—Elimina an email template

Example: Send Email Per Gruppo​

POST /messaging/emailTemplates/send
Authorization: Bearer <token>

{
"groupId": "group-123",
"subject": "This Week's Update - `{{churchName}}`",
"htmlContent": "<p>Hello `{{firstName}}`,</p><p>Here's what's happening this week...</p>"
}
{
"totalMembers": 50,
"recipientCount": 45,
"successCount": 44,
"failCount": 1,
"noEmailCount": 5
}

Supported merge fields: {{firstName}}, {{lastName}}, {{displayName}}, {{email}}, {{churchName}}

Blocked IPs​

Base path: /messaging/blockedips

(legacy) IP-blocking for live streaming chat. The B1App client No longer calls POST / — IP blocking was removed in the unified-delivery migration. The /clear route is still invoked server-Per-server by StreamingServiceController when streaming Servizi are saved.

MethodPathAuthPermessoDescription
POST/JWT—(legacy) Salva blocked IPs (batch). No Attivo client
POST/clearJWT—Clear all blocked IPs for specific Servizi. Body: [{ serviceId, churchId }]

Delivery Logs​

Base path: /messaging/deliverylogs

Tracks delivery status for sent messages (SMS, push notifications, email).

MethodPathAuthPermessoDescription
GET/content/:contentType/:contentIdJWT—Load delivery logs by content Digita and ID
GET/person/:personIdJWT—Load delivery logs for a person. Facoltativo ?startDate=&endDate= filters
GET/recentJWT—Load recent delivery logs for the church. Facoltativo ?limit= (default 100)
GET/:idJWT—Load a delivery log by ID

Pagine Correlate​