FoyerDevelopers

Generated · Live registry

messages tools

21 tools in this domain, generated from the running registry.

All tool domains

messages.anhang_lesen

read-only

Read what a guest attached to a message: a photo comes back as an image (long side 1568 px), a voice message as its transcript, a PDF as its text with page count, a video only as metadata. A scanned PDF is read by OCR on first access; if that takes longer than ~40 s the answer is empty with a `hinweis` that it is still running — ask again in a minute or two, the text is stored. Get the attachment id from the `attachments` array of `messages.listByStay` / `inbox.list_by_stay`. Only message attachments of this property — check-in ID photos are not reachable here.

Input parameters

FieldTypeRequiredNotes
attachmentIdstringyes

Output fields

One of 4 shapes, depending on the outcome:

Shape 1

FieldTypeRequiredNotes
artliteralyesOne of: foto
mimeTypestringyes
breitenumberyes
hoehenumberyes
nachrichtobjectyes
nachricht.idstringyes
nachricht.textstring · nullableyes
nachricht.gesendetAmstringyes
bildobjectyes
bild.datastringyes
bild.mimeTypeliteralyesOne of: image/jpeg

Shape 2

FieldTypeRequiredNotes
artliteralyesOne of: sprachnachricht
abschriftstring · nullableyes
hinweisstringno
nachrichtobjectyes
nachricht.idstringyes
nachricht.textstring · nullableyes
nachricht.gesendetAmstringyes

Shape 3

FieldTypeRequiredNotes
artliteralyesOne of: dokument
dateinamestring · nullableyes
seitennumber · nullableyes
textstringyes
gekuerztbooleanyes
quelleenum · nullableyesOne of: textebene, texterkennung
verfahrenstringno
hinweisstringno
nachrichtobjectyes
nachricht.idstringyes
nachricht.textstring · nullableyes
nachricht.gesendetAmstringyes

Shape 4

FieldTypeRequiredNotes
artliteralyesOne of: video
hinweisstringyes
nachrichtobjectyes
nachricht.idstringyes
nachricht.textstring · nullableyes
nachricht.gesendetAmstringyes

messages.anrufe

read-only

Calls belonging to this stay, for the timeline in the thread. Read-only query.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
startedAtstringyes
durationSecnumber · nullableyes
summarystring · nullableyes
outcomestring · nullableyes
quelleenumyesOne of: bot, anlage
richtungnumber · nullableyes
nummerstring · nullableyes
rueckrufStatusstring · nullableyes
waNummerstring · nullableyes

messages.antwortUebersetzen

writes

Translates your own reply into the guest's language; nothing is sent or stored. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
textstringyes

Output fields

FieldTypeRequiredNotes
textstringyes
zielstringyes

messages.ereignisse

read-only

What happened to the booking — booking, payments, extras, cancellation, changes, online check-in, guest-portal requests — as rows for the thread. Read-only query.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
artenumyesOne of: buchung, upsell_bezahlt, upsell_erstattet, zahlung, erstattung, storno, datum_geaendert, zimmer_geaendert, preis_geaendert, online_checkin, portal_wunsch, rechnung_verschickt, bewertung
zeitstringyes
betragCentsnumber · nullableyes
waehrungstringyes
angabenobjectyes
rohobjectno

messages.erledigtSetzen

writes

Mark a conversation as done (or undo that): it needs no further reply, e.g. because the guest only wrote "Danke" (thanks) or the question was settled by phone. It disappears from "Unbeantwortet" (Unanswered) (inbox, handover, `inbox.list_unanswered`) and shows no waiting time UNTIL the next message arrives, at which point it reopens by itself. In the UI: swipe left. `geaendert: false` means "was already that way", not an error. Every change is recorded in audit_log. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
conversationIdstringyes
erledigtbooleanyes

Output fields

FieldTypeRequiredNotes
erledigtbooleanyes
geaendertbooleanyes

messages.faden

read-only

Reads a message thread by conversationId, even if it is not assigned to a booking: header (channel, platform, sender name, phone number, last message, stayId if present) and all sent messages including attachments in chronological order. Drafts are not included. Any signed-in role. Read-only; a foreign or unknown id yields NOT_FOUND.

Input parameters

FieldTypeRequiredNotes
conversationIdstringyes

Output fields

FieldTypeRequiredNotes
kopfobjectyes
kopf.conversationIdstringyes
kopf.stayIdstring · nullableyes
kopf.exConversationIdstring · nullableyes
kopf.platformstring · nullableyes
kopf.kanalstring · nullableyes
kopf.namestring · nullableyes
kopf.telefonstring · nullableyes
kopf.lastMessageAtstring · nullableyes
nachrichtenarray of objectyes
nachrichten.idstringyes
nachrichten.tenantIdstringyes
nachrichten.conversationIdstringyes
nachrichten.channelenumyesOne of: whatsapp, email, hospitable, voice, channex, beds24
nachrichten.directionenumyesOne of: inbound, outbound
nachrichten.senderstring · nullableyes
nachrichten.bodystring · nullableyes
nachrichten.languageDetectedstring · nullableyes
nachrichten.aiLayerenum · nullableyesOne of: rule, llm, manual, escalated, auto_received
nachrichten.aiConfidencestring · nullableyesDecimal as string — numeric column, not an IEEE-754 double
nachrichten.aiReplyToMessageIdstring · nullableyes
nachrichten.attachmentUrlstring · nullableyes
nachrichten.attachmentKindenum · nullableyesOne of: audio, image, file
nachrichten.externalMessageIdstring · nullableyes
nachrichten.sentReferenceIdstring · nullableyes
nachrichten.externalThreadRefsarray of string · nullableyes
nachrichten.subjectstring · nullableyes
nachrichten.bodyHtmlstring · nullableyes
nachrichten.stateenumyesOne of: draft, sent
nachrichten.sentAtstringyes
nachrichten.providerNamestring · nullableyes
nachrichten.providerSourcestring · nullableyes
nachrichten.deliveryStatusenumyesOne of: queued, sent, beobachtet, provider_acked, delivered, read, failed, sync_unknown
nachrichten.lastReconciledAtstring · nullableyes
nachrichten.invoiceRequestedbooleanyes
nachrichten.attachmentsarray of objectyes
nachrichten.reaktionstring · nullableno
nachrichten.reaktionAtstring · nullableno
nachrichten.antwortAufWamidstring · nullableno
nachrichten.antwortAufTextstring · nullableno
nachrichten.sprachestring · nullableno
nachrichten.automatischbooleanno
nachrichten.regelNamestring · nullableno
nachrichten.restOffenarray of string · nullableno
nachrichten.kiUrteilobjectno

messages.fadenAntworten

writes

Replies to a thread WITHOUT a booking, via WhatsApp. Optional `antwortAufId` (a WhatsApp message of this thread): the reply then goes out as a quote; otherwise `antwort_ziel_ungueltig` is returned and nothing is sent. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
conversationIdstringyes
bodystringyes
antwortAufIdstringno
bildobjectno
bild.base64stringyes
bild.namestringno

Output fields

FieldTypeRequiredNotes
messageIdstringyes
externalMessageIdstring · nullableyes

messages.fadenVorschlag

read-only

Which booking does this unassigned thread belong to? A suggestion, not an action. Read-only query.

Input parameters

FieldTypeRequiredNotes
conversationIdstringyes

Output fields

FieldTypeRequiredNotes
stayIdstring · nullableyes
guestNamestring · nullableyes
roomstring · nullableyes
checkInstring · nullableyes
grundstring · nullableyes

messages.fadenZuordnen

writes

Attaches the unassigned thread to a booking: the visible click that follows the suggestion. Sets ONLY `conversations.stay_id`. Messages stay where they are; the booking page now reads all threads of a stay and labels them by channel, so the WhatsApp history appears alongside the channel's history instead of replacing it. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
conversationIdstringyes
stayIdstring · nullableyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

messages.kanalVorschau

read-only

Via which channel a reply would go out right now, shown at the reply field. Same choice as when sending (`ermittleKanal`); creates nothing. Read-only query.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

The whole object may be null.

FieldTypeRequiredNotes
kanalenumyesOne of: whatsapp, email, hospitable, voice, channex, beds24
plattformstring · nullableyes
waFensterZubooleanyes
fehltenum · nullableyesOne of: email, telefon

messages.kiUrteil

writes

The team's verdict on an AI reply: "good" or "bad", for "bad" optionally a short reason (at most 200 characters). A new verdict replaces the old one. The verdicts feed the evaluation of which replies the AI may send on its own in future. NOT_FOUND if the message is not an AI reply of this property. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
messageIdstringyes
urteilenumyesOne of: gut, schlecht
grundstringno

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

messages.listByStay

read-only

List all messages for a single stay's conversation thread.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
tenantIdstringyes
conversationIdstringyes
channelenumyesOne of: whatsapp, email, hospitable, voice, channex, beds24
directionenumyesOne of: inbound, outbound
senderstring · nullableyes
bodystring · nullableyes
languageDetectedstring · nullableyes
aiLayerenum · nullableyesOne of: rule, llm, manual, escalated, auto_received
aiConfidencestring · nullableyesDecimal as string — numeric column, not an IEEE-754 double
aiReplyToMessageIdstring · nullableyes
attachmentUrlstring · nullableyes
attachmentKindenum · nullableyesOne of: audio, image, file
externalMessageIdstring · nullableyes
sentReferenceIdstring · nullableyes
externalThreadRefsarray of string · nullableyes
subjectstring · nullableyes
bodyHtmlstring · nullableyes
stateenumyesOne of: draft, sent
sentAtstringyes
providerNamestring · nullableyes
providerSourcestring · nullableyes
deliveryStatusenumyesOne of: queued, sent, beobachtet, provider_acked, delivered, read, failed, sync_unknown
lastReconciledAtstring · nullableyes
invoiceRequestedbooleanyes
attachmentsarray of objectyes
attachments.idstringyes
attachments.messageIdstringyes
attachments.kindenumyesOne of: photo, audio, video, document
attachments.urlstringyes
attachments.mimeTypestring · nullableyes
attachments.sizeBytesinteger · nullableyes
attachments.seiteninteger · nullableno
attachments.textInhaltstring · nullableno
attachments.textQuelleenum · nullablenoOne of: textebene, texterkennung
reaktionstring · nullableno
reaktionAtstring · nullableno
antwortAufWamidstring · nullableno
antwortAufTextstring · nullableno
sprachestring · nullableno
automatischbooleanno
regelNamestring · nullableno
restOffenarray of string · nullableno
kiUrteilobjectno
kiUrteil.urteilenum · nullableyesOne of: gut, schlecht
kiUrteil.grundstring · nullableyes

messages.listConversations

read-only

List guest message conversations (inbox threads).

Input parameters

FieldTypeRequiredNotes
filterenumnoOne of: all, unanswered, alarme, vorschlaege — Default: "all"
kanalarray of enumno
aufenthaltenumnoOne of: anreisend, im_haus, abgereist
anreiseVonstringno
anreiseBisstringno
sprachearray of stringno
statusarray of enumno
searchstringno
limitintegernoDefault: 25
cursorstringno

Output fields

FieldTypeRequiredNotes
itemsarray of objectyes
items.conversationIdstringyes
items.stayIdstring · nullableyes
items.exConversationIdstring · nullableyes
items.externalRefstring · nullableyes
items.guestNamestringyes
items.channelenumyesOne of: whatsapp, email, hospitable, voice, channex, beds24
items.lastBodystring · nullableyes
items.lastAtstringyes
items.lastDirectionenumyesOne of: inbound, outbound
items.lastDeliveryStatusstring · nullableno
items.needsReplybooleanyes
items.wartetMinuteninteger · nullableno
items.erledigtbooleanno
items.ungelesenbooleanno
items.kiVorschlagbooleanno
items.kiVorschlagPruefenbooleanno
items.roomstring · nullableyes
items.stayStatusstring · nullableyes
items.platformstring · nullableyes
items.isInquirybooleanyes
items.hatAnrufbooleanyes
items.verlangtRueckrufbooleanyes
items.kanaelearray of stringno
items.einordnungobject · nullableyes
nextCursorstring · nullableyes

messages.listUnconfirmed

read-only

outbound sends whose delivery is not yet confirmed. Surfaces the "Bestätigung fehlt" UI section. Cutoff is 30 minutes: fresh sends (<30min) are noisy because Postmark webhooks haven't had time to fire. Beyond that, anything still in sent / provider_acked / sync_unknown deserves operator attention. Read-only query.

Input parameters

FieldTypeRequiredNotes
limitintegernoDefault: 100

Output fields

FieldTypeRequiredNotes
itemsarray of objectyes
items.messageIdstringyes
items.conversationIdstringyes
items.channelenumyesOne of: whatsapp, email, hospitable, voice, channex, beds24
items.providerNamestring · nullableyes
items.deliveryStatusenumyesOne of: queued, sent, beobachtet, provider_acked, delivered, read, failed, sync_unknown
items.subjectstring · nullableyes
items.bodystring · nullableyes
items.externalMessageIdstring · nullableyes
items.sentAtstringyes
items.lastReconciledAtstring · nullableyes
countintegeryes
notCheckableCountintegeryes
notCheckableProvidersarray of stringyes

messages.markDelivered

writes

Operator marks a previously-unconfirmed message as verified-delivered. Used after the operator visually checked the provider's dashboard and confirmed the guest got it. Removes the row from "Bestätigung fehlt" without triggering a resend. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
messageIdstringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

messages.offeneKiVorschlaegeAnzahl

read-only

How many conversations have an open AI suggestion (draft awaiting approval): the counter for "Heute" (Today). Same rule as the badge and the "Vorschläge" (Suggestions) filter in the inbox, scoped to the tenant. Read-only query.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
anzahlintegeryes

messages.send

writesconfirm

Send a message to the guest on a reservation's conversation thread. This contacts the guest for real over the booking channel (Airbnb/Booking/email/WhatsApp). Optional `antwortAufId` (id of a WhatsApp message in this reservation's thread) sends it as a quoted reply when the message goes out over WhatsApp; otherwise rejected with `antwort_ziel_ungueltig` and nothing is sent. Requires confirmation.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes
bodystringyes
bildobjectno
bild.base64stringyes
bild.namestringno
antwortAufIdstringno

Output fields

FieldTypeRequiredNotes
messageIdstringyes

messages.uebersetzen

writes

Translates a guest message into German, once, then stored. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
messageIdstringyes

Output fields

FieldTypeRequiredNotes
textstringyes
quellestring · nullableyes

messages.uebersetzungAktiv

read-only

Is a translation service set up? Without one, the UI shows no buttons. Read-only query.

Input parameters

Returns object.

Output fields

FieldTypeRequiredNotes
aktivbooleanyes

messages.ungelesenSetzen

writes

Mark a conversation as unread (or back as read): its row in the inbox then appears in bold with a dot until someone opens the thread. The target is EXACTLY ONE of `conversationId` (one conversation) or `stayId` (all conversations of the booking, which is how the UI reports opening it). Per conversation, not per user. `geaendert` = number of conversations whose state changed; every change is recorded in audit_log. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
conversationIdstringno
stayIdstringno
ungelesenbooleanyes

Output fields

FieldTypeRequiredNotes
ungelesenbooleanyes
geaendertintegeryes

messages.whatsappVorlagen

read-only

WhatsApp templates of this stay for the thread: display only, alongside the messages, like the calls. Deliberately NOT `messages` rows, otherwise later rule messages would inherit WhatsApp as their channel. The text carries the codes, so it is available to operations roles only, like the queue. Read-only query.

Input parameters

FieldTypeRequiredNotes
stayIdstringyes

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
createdAtstringyes
raumstringyes
vorlagestringyes
textstring · nullableyes
statusstringyes
grundstring · nullableyes
zustellungstring · nullableyes
zustellFehlerstring · nullableyes
reaktionstring · nullableyes
aktuelleNummerstring · nullableyes
nachschickbarbooleanyes