Skip to main content
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 WhatsApp-Nachricht mithilfe eines vorab freigegebenen Templates. Template-Nachrichten sind erforderlich, um eine Konversation mit einem Nutzer erstmals zu starten oder um ihn außerhalb des 24-Stunden-Messaging-Fensters zu kontaktieren.
Dieser Endpunkt ist auf 5 Anfragen pro Sekunde pro Benutzer begrenzt.

Anfrage-Body

integer
erforderlich
Die ID des WhatsApp-Senders, von dem gesendet werden soll (erhalten über WhatsApp-Sender abrufen)
integer
erforderlich
Die ID des zu verwendenden Nachrichtentemplates (erhalten über WhatsApp-Templates abrufen)
string
erforderlich
Die Telefonnummer des Empfängers im internationalen Format (z.B. +1234567890)
string
Der Name des Empfängers, max. 255 Zeichen (für Konversations-Tracking und CRM-Zwecke)
object
Key-Value-Paare für Template-Variablen. Keys müssen den Variablennamen aus dem Template entsprechen. Wenn das Template Variablen {{1}}, {{2}} usw. hat, gib sie als {\"1\": \"value1\", \"2\": \"value2\"} oder mit den benannten Keys aus dem variables-Array des Templates an.

Antwort-Felder

boolean
Ob die Nachricht erfolgreich gesendet wurde
integer
Die ID der (neuen oder bestehenden) Konversation, die mit dieser Nachricht verknüpft ist
integer
Die ID des Konversations-Nachrichteneintrags
integer
Die ID des WhatsApp-Nachrichteneintrags
string
Die Twilio Message SID zur Sendungsverfolgung
string
Der initiale Zustellstatus der Nachricht (z.B. queued, sent)

Fehler-Antworten

Hinweise

  • Template-Nachrichten müssen freigegebene Templates verwenden. Templates mit dem Status pending oder rejected schlagen fehl.
  • Der Sender muss online sein. Offline-Sender können keine Nachrichten versenden.
  • Message costs are automatically deducted from your account balance (credits for tenant users, minutes for direct users).
  • After sending a template message, a 24-hour messaging window opens. During this window, you can send freeform messages without needing a template.
  • Besteht bereits eine Konversation mit dem Empfänger, wird die Nachricht der bestehenden Konversation hinzugefügt.
  • Rate limit: 5 requests per second per user.