Zum Hauptinhalt springen
POST
Famulor 1.0 API (Legacy). Diese Seite gilt nur für Famulor 1.0 (app.famulor.de) und bleibt aus Kompatibilitätsgründen erhalten. Für die aktuelle Plattform nutze die Famulor 2.0 API-Referenz.
Dieser Endpunkt sendet eine Freiform- (Freitext-) WhatsApp-Nachricht an einen Empfänger. Im Gegensatz zu Template-Nachrichten kann der Inhalt beliebigen Text enthalten, er erfordert jedoch ein aktives 24-Stunden-Messaging-Fenster – der Empfänger muss innerhalb der letzten 24 Stunden eine Nachricht an deinen WhatsApp-Sender geschickt haben.
Freiform-Nachrichten können nur während eines aktiven 24-Stunden-Fensters gesendet werden. Wenn die Session abgelaufen ist, musst du zunächst eine Template-Nachricht senden, um die Konversation wieder zu starten. Verwende den Endpunkt Session-Status, um zu prüfen, ob eine Session aktiv ist.
Dieser Endpunkt ist auf 5 Requests pro Sekunde pro Benutzer rate-limitiert.

Anfrage-Body

integer
erforderlich
Die ID des WhatsApp-Senders, von dem gesendet werden soll (erhalten über WhatsApp-Sender abrufen)
string
erforderlich
Die Telefonnummer des Empfängers im internationalen Format (z.B. +1234567890)
string
erforderlich
Der zu sendende Nachrichteninhalt (max. 4096 Zeichen)

Antwort-Felder

boolean
Ob die Nachricht erfolgreich gesendet wurde
integer
Die ID der mit dieser Nachricht verknüpften Konversation
integer
Die ID des Konversations-Nachrichteneintrags
integer
Die ID des WhatsApp-Nachrichteneintrags
string
Die Nachrichtenkennung zur Sendungsverfolgung
object
Aktualisierter Session-Status nach dem Versand der Nachricht

Fehler-Antworten

24-Stunden-Nachrichtenfenster

WhatsApp setzt ein 24-Stunden-Nachrichtenfenster durch:
  1. Sobald ein Kunde eine Nachricht an deine WhatsApp-Business-Nummer schickt, öffnet sich ein 24-Stunden-Fenster.
  2. Innerhalb dieses Fensters kannst du Freiform-Nachrichten ohne Einschränkungen senden.
  3. After the window expires, you must use a template message to re-initiate the conversation.
  4. Jede neue Kundennachricht setzt den 24-Stunden-Timer zurück.
Use the Session Status endpoint to check whether a session is active before attempting to send a freeform message.

Hinweise

  • Die maximale Nachrichtenlänge beträgt 4.096 Zeichen (WhatsApp-Limit).
  • Der Sender muss online sein. Offline-Sender liefern einen 503-Fehler.
  • Message costs are automatically deducted from your account balance.
  • Rate limit: 5 requests per second per user.