Hopp til hovedinnhold

Endepunkter for meldinger

Meldingsmodulen håndterer sanntidssamtaler, chatmeldinger, push-varsler, levering av SMS og e-post, WebSocket-tilkoblinger, private meldinger, registrering av enheter og leverandører for tekstmeldinger. Den gir kommunikasjonslaget som brukes på tvers av alle ChurchApps-applikasjoner, både for direktesendingschat og for asynkrone varsler.

Basisbane: /messaging

Samtaler​

Basisbane: /messaging/conversations

MetodeStiAutentiseringTillatelseBeskrivelse
GET/timeline/ids?ids=JWT—Laster samtaler etter kommaseparerte id-er, med første og siste meldinger
GET/messages/:contentType/:contentIdJWT—Laster samtaler for innhold med paginerte meldinger (?page=&limit=)
GET/postsJWT—Henter innleggsamtaler for den innloggede brukerens grupper
GET/posts/group/:groupIdJWT—Henter innleggsamtaler for en bestemt gruppe
GET/notes/feed?section=&limit=&before=JWT—Nyeste notater på tvers av alle poster, for siden Notater i B1 Admin. section er people, groups, events eller workflows (400 ellers). limit er 25 som standard (maks 100). before er markøren fra forrige side. Hvert notat må fortsatt oppfylle regelen for sin egen type (tillatelsen People Edit / konfidensielle notater, ledere av gruppen, arrangementsseere, seere av arbeidsflytkort), så kallere ser bare notater de ville kunne åpne. Notatteksten kuttes til 300 tegn
GET/current/:churchId/:contentType/:contentIdOffentlig—Henter eller oppretter gjeldende samtale for innhold (dekrypterer contentId automatisk)
GET/:churchId/:contentType/:contentIdOffentlig—Laster samtaler etter innholdstype og id
GET/:churchId/:idOffentlig—Laster én samtale etter id
POST/JWT—Oppretter eller oppdaterer samtaler (batch)
POST/startJWT—Starter en ny samtale med en innledende kommentarmelding
DELETE/:churchId/:idJWT—Sletter en samtale

Tilgangskontroll for personnotater​

Samtaler med contentType: "person" (fanen Notater på en personpost) eller contentType: "personConfidential" (seksjonen Konfidensielle notater) er låst på alle lese- og skrivestier, også på de ellers offentlige rutene ovenfor, som returnerer 401 for disse innholdstypene. person krever tillatelsen People / Edit i MembershipApi. personConfidential krever People / View Confidential Notes. For API-nøkler med omfang gir people:write begge handlingene (brukeren bak nøkkelen må fortsatt ha den underliggende rolletillatelsen).

Tilgangskontroll for gruppe- og arrangementsnotater​

To andre innholdstyper for notater er låst på samme måte, på alle lese- og skrivestier (også på de offentlige rutene ovenfor), og er aldri åpne for anonym posting:

  • groupNote (contentId = gruppe-id) -- strømmen Ledernotater på en gruppe. Bare den gruppens ledere (leaderGroupIds i JWT-en) kan lese eller legge inn. Ingen ansatt-tillatelse gir tilgang, heller ikke content.edit og gruppemedlemstillatelsene.
  • eventNote (contentId = arrangements-id) -- notatene på et kalenderarrangement. Ansatte med content.edit eller Calendars / Admin kan alltid lese og legge inn. Ellers følger tilgangen arrangementets notesViewRole (lesing) og notesPostRole (posting): staff (standard, brukes når feltet er null) gir ingen andre tilgang, leaders gir tilgang til lederne av arrangementets gruppe, og members gir tilgang til medlemmene og lederne i arrangementets gruppe. Et arrangement uten groupId er bare for ansatte.

Tilgangskontroll for notater på arbeidsflytkort​

Samtaler med contentType: "workflowCard" (notatene på et arbeidsflytkort, der contentId er kortets oppgave-id) kan bare leses og skrives av noen som kan åpne kortet: en bruker med tillatelsen DoingApi Tasks / View, eller personen eller gruppen kortet er tildelt, opprettet av eller handler om. Alle andre får 401 på alle lesestier, også på de offentlige rutene ovenfor. En kortsamtale knyttes til kortet selv med POST /doing/tasks/:id/conversation (body { "conversationId": "..." }; den første samtalen som knyttes, vinner). Det kan kortets redaktører og den tildelte personen kalle.

Eksempel: starte en samtale​

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"
}

Meldinger​

Basisbane: /messaging/messages

MetodeStiAutentiseringTillatelseBeskrivelse
GET/conversation/:conversationIdJWT—Laster alle meldinger i en samtale
GET/catchup/:churchId/:conversationIdOffentlig—Laster alle meldinger i en samtale (offentlig innhenting for direktechat)
GET/:churchId/:idOffentlig—Laster én melding etter id
POST/JWT—Lagrer meldinger (batch). Sender sanntidsoppdateringer og utløser varsler. Å oppdatere en eksisterende melding krever at du er forfatteren eller har content.edit. Den lagrede forfatteren kan aldri endres
POST/sendOffentlig—Sender meldinger (batch, offentlig). Sender sanntidsoppdateringer via WebSocket og utløser varsler
POST/setCalloutJWT—(utgått) Kringkaster en fremhevet melding i sanntid. Ingen aktiv klient; chatten i direktesendingen viser ikke lenger fremhevinger
DELETE/:churchId/:idJWT—Sletter en melding og kringkaster slettingen i sanntid. Se Moderering av meldinger

Moderering av meldinger​

Å slette en melding er tillatt for:

  • forfatteren av meldingen;
  • ansatte med content.edit (hvor som helst i menigheten);
  • gruppeledere, for samtaler med contentType group eller groupAnnouncement der contentId er en gruppe de leder (leaderGroupIds i JWT-en).

Personnotatsamtaler (person / personConfidential) modereres aldri av ledere. De bruker i stedet tillatelsene for notater (people.edit, people.viewConfidentialNotes).

Ledere får bare slette, ikke redigere. Å skrive om et annet medlems melding er fortsatt begrenset til forfatteren og ansatte med content.edit.

Eksempel: sende en melding​

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 meldinger​

Basisbane: /messaging/privatemessages

MetodeStiAutentiseringTillatelseBeskrivelse
GET/JWT—Laster alle private meldinger for den innloggede brukeren (inkluderer siste melding per samtale, og markerer alle som lest)
GET/existing/:personIdJWT—Finner en eksisterende privat samtale med en bestemt person
GET/:idJWT—Laster en privat melding etter id (fjerner varselet hvis meldingen er adressert til den innloggede brukeren)
POST/JWT—Sender private meldinger (batch). Utløser push-varsel til mottakeren

Varsler​

Basisbane: /messaging/notifications

MetodeStiAutentiseringTillatelseBeskrivelse
GET/unreadCountJWT—Henter antall uleste varsler for den innloggede brukeren
GET/myJWT—Laster alle varsler for den innloggede brukeren (markerer alle som lest)
GET/tmpEmailOffentlig—Utløser den daglige e-postoppsummeringen av varsler (feilsøkings-/cron-endepunkt)
GET/:churchId/person/:personIdJWT—Laster varsler for en bestemt person
GET/:churchId/:idJWT—Laster et varsel etter id
POST/JWT—Oppretter eller oppdaterer varsler (batch)
POST/createJWT—Oppretter varsler for flere personer. Body: { peopleIds, contentType, contentId, message, link }
POST/markRead/:churchId/:personIdJWT—Markerer alle varsler for en person som lest
POST/sendTestJWT—Sender et testvarsel. Body: { personId, title }
POST/pingOffentlig—Oppretter et varsel fra en ekstern utløser. Body: { personId, churchId, contentType, contentId, message, triggeredByPersonId }
DELETE/:churchId/:idJWT—Sletter et varsel
GET/groupPreview/:groupIdJWTgroupMembers.editTeller hvor mange av gruppens medlemmer et push-varsel ville nå
GET/churchPreviewJWTcontent.editTeller hvor mange personer et push til alle med appen ville nå
POST/group/sendJWTgroupMembers.editSender et push til gruppens medlemmer nå

Eksempel: opprette varsler​

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"
}

Planlagte varsler​

Basisbane: /messaging/scheduledNotifications

Push-varsler som planlegges på forhånd. audience er church (alle med appen; krever content.edit) eller group (krever groupMembers.edit og en groupId). Tittelen er begrenset til 80 tegn og meldingen til 240. En rad som er forfalt, sendes av 1-minuttstimeren.

MetodeStiAutentiseringTillatelseBeskrivelse
GET/JWTgroupMembers.edit eller content.editLister planlagte og nylige varsler for menigheten
POST/JWTavhengig av målgruppeOppretter et planlagt varsel, eller oppdaterer et når id er satt. Body: { id?, audience, groupId?, title, message, link?, imageUrl?, sendAt }. Å oppdatere et varsel som ikke lenger venter, gir 409
POST/:id/sendNowJWTavhengig av målgruppeSender et ventende varsel nå. Gir 409 hvis det allerede er sendt, kansellert eller er under sending
DELETE/:idJWTavhengig av målgruppeKansellerer et ventende varsel, eller fjerner et sendt, mislykket eller kansellert varsel fra listen. Gir 409 mens det sendes
DELETE/JWTgroupMembers.edit eller content.editFjerner alle sendte, mislykkede og kansellerte varsler for målgruppene brukeren kan sende til. Returnerer { deleted }

Varselinnstillinger​

Basisbane: /messaging/notificationpreferences

MetodeStiAutentiseringTillatelseBeskrivelse
GET/categoriesJWT—Lister varselkategorier med standard- og tillatte kanaler
GET/myJWT—Laster varselinnstillingene for den innloggede brukeren (oppretter standardverdier automatisk hvis ingen finnes)
POST/JWT—Lagrer den innloggede brukerens innstillinger. Body: én eller flere av allowPush, allowSms, emailFrequency, masterMute, quietHoursStart, quietHoursEnd, timeZone, maxPushPerDay, pluss valgfri overrides: [{ categoryKey, channel, optedIn }] (channel kan være push, email, in_app eller sms. Låste kategorier ignoreres). allowSms er medlemmets samtykke til påminnelser som tekst. Et eldre body med en liste av rader godtas fortsatt

Tilkoblinger​

Basisbane: /messaging/connections

Administrerer WebSocket-/sanntidstilkoblinger for chat, gruppesamtaler, private meldinger og direktesending. Se Sanntidsarkitektur for hele protokollen fra start til slutt.

MetodeStiAutentiseringTillatelseBeskrivelse
GET/:churchId/:conversationIdOffentlig—Laster alle tilkoblinger for en samtale
POST/Offentlig—Registrerer tilkoblinger (batch). Utløser en oppmøtekringkasting i samtalen. Elementer i body: { churchId, conversationId, socketId, displayName?, personId? }
POST/setNameOffentlig—Oppdaterer visningsnavnet for en tilkobling etter socket-id. Body: { socketId, name }
DELETE/:churchId/:conversationId/:socketIdOffentlig—Fjerner en tilkobling fra en samtale. Utløser en oppmøtekringkasting
POST/tmpSendAlertOffentlig—Sender et varsel til alle tilkoblingene til en person. Body: { churchId, personId }

Enheter​

Basisbane: /messaging/devices

Administrerer registrering av enheter for push-varsler og innholdskobling (f.eks. appen Lessons på TV-skjermer).

MetodeStiAutentiseringTillatelseBeskrivelse
POST/enrollJWT—Registrerer eller oppdaterer en enhet (registrering for mobil push). Matcher på FCM-token eller enhets-id
POST/enrollAnonOffentlig—Registrerer en anonym enhet og genererer en paringskode på 4 tegn
POST/Offentlig—Lagrer enheter (batch)
GET/pair/:pairingCodeJWT—Parer en enhet med paringskoden. Valgfritt ?contentType=&contentId= for å tildele innhold
GET/status/:deviceIdOffentlig—Sjekker paringsstatus for en enhet
GET/:churchIdJWT—Laster alle enheter for en menighet
GET/:churchId/person/:personIdJWT—Laster alle enheter for en person
GET/:churchId/:idJWT—Laster en enhet etter id
DELETE/:churchId/:idJWT—Sletter en enhet

Eksempel: registrere en enhet​

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

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

Innhold på enheter​

Basisbane: /messaging/devicecontents

Administrerer innholdstildelinger for parede enheter (f.eks. hvilken leksjon som vises på en TV).

MetodeStiAutentiseringTillatelseBeskrivelse
GET/deviceId/:deviceIdJWT—Laster innholdstildelinger for en enhet
POST/JWT—Lagrer innholdstildelinger for enheter (batch)
DELETE/:idJWT—Sletter en innholdstildeling for en enhet

Tekstmeldinger​

Basisbane: /messaging/texting

Administrerer leverandører for SMS, gruppetekstmeldinger og sporing av levering.

MetodeStiAutentiseringTillatelseBeskrivelse
GET/providersJWT—Laster leverandører for tekstmeldinger for menigheten (påloggingsdetaljer er maskert)
GET/statusJWT—{ enabled } -- om menigheten har en aktivert leverandør for tekstmeldinger. Alle innloggede brukere i menigheten; brukes til å vise alternativene Tekst bare når tekstmeldinger kan sendes
GET/inboundUrlJWTtexting.send eller settings.edit{ url } -- menighetens webhook-URL for innkommende meldinger (STOP), som limes inn hos leverandøren
POST/inbound/:churchId/:tokenOffentlig—Webhook for innkommende meldinger fra leverandøren. token er en HMAC av menighets-id-en. Et svar som er nøyaktig et stoppord (STOP, STOPALL, UNSUBSCRIBE, CANCEL, END, QUIT, OPTOUT, REVOKE) markerer alle matchende personer som optedOut og slår av deres allowSms. Returnerer { optedOut: <count> }. Andre svar returnerer { optedOut: 0 }
GET/preview/:groupIdJWT—Forhåndsviser mottakere for en gruppetekst (antall berettigede, avmeldte og uten telefon)
GET/sentJWT—Laster alle sendte tekstmeldinger for menigheten
GET/sent/:id/detailsJWT—Laster en sendt tekstmelding med leveringslogg per mottaker
POST/providersJWT—Lagrer leverandører for tekstmeldinger (batch). Krypterer API-påloggingsdetaljer
POST/sendJWT—Sender en SMS til alle berettigede medlemmer i en gruppe. Body: { groupId, message }. Flettefelt ({{firstName}}, {{lastName}}, {{displayName}}, {{churchName}}) løses per mottaker
POST/sendPersonJWT—Sender en SMS til én person. Body: { personId, phoneNumber, message }. Flettefelt løses, og det løste teksten er det som logges
DELETE/providers/:idJWT—Sletter en leverandør for tekstmeldinger

Eksempel: sende gruppetekst​

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
}

E-postmaler​

Basisbane: /messaging/emailTemplates

Administrerer gjenbrukbare e-postmaler og sending av malbaserte e-poster til grupper.

MetodeStiAutentiseringTillatelseBeskrivelse
GET/JWT—Laster alle e-postmaler for menigheten
GET/:idJWT—Laster én e-postmal etter id
GET/sendStatusJWTgroupMembers.edit eller tasks.adminMenighetens status for gruppe-e-post: { approved, paused, remaining, requested }. Dialogen Send e-post i B1Admin og handlingen Send e-post i arbeidsflyter bruker den for å varsle når e-post ikke kommer til å gå ut
POST/requestApprovalJWTgroupMembers.editBer støtte om å godkjenne menigheten for gruppe-e-post (høyst én gang per menighet per uke)
GET/preview/:groupIdJWT—Forhåndsviser e-postlevering for en gruppe (antall berettigede mottakere, medlemmer uten e-post)
POST/JWT—Oppretter eller oppdaterer e-postmaler (batch)
POST/sendJWT—Sender en malbasert e-post til alle medlemmene i en gruppe. Body: { groupId, subject, htmlContent }
DELETE/:idJWT—Sletter en e-postmal

Eksempel: sende e-post til en gruppe​

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
}

Støttede flettefelt: {{firstName}}, {{lastName}}, {{displayName}}, {{email}}, {{churchName}}

Blokkerte IP-adresser​

Basisbane: /messaging/blockedips

(utgått) IP-blokkering for chat i direktesending. B1App-klienten kaller ikke lenger POST / -- IP-blokkering ble fjernet i migreringen til samlet levering. Ruten /clear kalles fortsatt server-til-server av StreamingServiceController når direktesendingstjenester lagres.

MetodeStiAutentiseringTillatelseBeskrivelse
POST/JWT—(utgått) Lagrer blokkerte IP-adresser (batch). Ingen aktiv klient
POST/clearJWT—Fjerner alle blokkerte IP-adresser for bestemte tjenester. Body: [{ serviceId, churchId }]

Leveringslogger​

Basisbane: /messaging/deliverylogs

Sporer leveringsstatus for sendte meldinger (SMS, push-varsler, e-post).

MetodeStiAutentiseringTillatelseBeskrivelse
GET/content/:contentType/:contentIdJWT—Laster leveringslogger etter innholdstype og id
GET/person/:personIdJWT—Laster leveringslogger for en person. Valgfritt ?startDate=&endDate= for filtrering
GET/recentJWT—Laster nylige leveringslogger for menigheten. Valgfritt ?limit= (standard 100)
GET/:idJWT—Laster en leveringslogg etter id