Skip to main content
GET
https://app.famulor.de
/
api
/
user
/
conversations
curl -X GET "https://app.famulor.de/api/user/conversations?type=whatsapp&per_page=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "data": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "assistant_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "assistant_name": "Support Assistent",
      "type": "widget",
      "variables": {
        "user_name": "Jane Smith",
        "plan": "premium"
      },
      "message_count": 12,
      "total_cost": 0.0045,
      "ai_enabled": true,
      "created_at": "2025-01-25 14:30:00",
      "updated_at": "2025-01-25 14:45:22"
    },
    {
      "id": "8d0f7780-8536-51ef-055c-f18fd2g01bf8",
      "assistant_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "assistant_name": "Support Assistent",
      "type": "whatsapp",
      "variables": null,
      "message_count": 8,
      "total_cost": 0.0032,
      "ai_enabled": true,
      "created_at": "2025-01-25 10:15:00",
      "updated_at": "2025-01-25 10:28:45",
      "whatsapp_sender": {
        "name": "Acme Corp Support",
        "phone": "+14155551234"
      },
      "customer": {
        "name": "John Doe",
        "phone": "+14155559876"
      }
    },
    {
      "id": "9e1g8891-9647-62fg-166d-g29ge3h12cg9",
      "assistant_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "assistant_name": "Support Assistent",
      "type": "api",
      "variables": {
        "lead_id": "12345",
        "source": "website"
      },
      "external_identifier": "crm-lead-12345",
      "message_count": 5,
      "total_cost": 0.0021,
      "ai_enabled": true,
      "created_at": "2025-01-25 09:00:00",
      "updated_at": "2025-01-25 09:15:30"
    }
  ],
  "path": "https://app.famulor.de/api/user/conversations",
  "per_page": 15,
  "next_cursor": "eyJpZCI6MTAwLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",
  "prev_cursor": null
}
Dieser Endpunkt gibt eine Cursor-paginierte Liste von Konversationen zurück, die den Assistenten des authentifizierten Benutzers gehören. Verwenden Sie dies, um den Konversationsverlauf anzuzeigen, nach Typ zu filtern oder eine Integration mit Ihrem CRM durchzuführen.
Dieser Endpunkt verwendet Cursor-basierte Paginierung für eine bessere Performance bei großen Datensätzen. Verwenden Sie next_cursor und prev_cursor, um zwischen den Seiten zu navigieren.

​
Query-Parameter

​
type
string
Filtert Konversationen nach Typ. Mögliche Werte: test, widget, whatsapp, api
​
assistant_id
integer
Filtert Konversationen nach Assistenten-ID (muss dem authentifizierten Benutzer gehören)
​
customer_phone
string
Filtert Konversationen nach der Telefonnummer des Kunden (exakte Übereinstimmung). Nützlich, um alle Gespräche mit einem bestimmten Kunden zu finden.
​
whatsapp_sender_phone
string
Filtert Konversationen nach der WhatsApp-Absendernummer (exakte Übereinstimmung). Nützlich, um alle Gespräche von einer bestimmten WhatsApp-Business-Nummer zu finden.
​
external_identifier
string
Filtert Konversationen nach einer externen Kennung. Nützlich, um Konversationen zu finden, die mit Datensätzen in Ihrem externen System verknüpft sind.
​
per_page
integer
Anzahl der Konversationen pro Seite (1-100, Standard: 15)
​
cursor
string
Cursor für die Paginierung. Verwenden Sie next_cursor oder prev_cursor aus einer vorherigen Antwort.

​
Antwort-Felder

​
data
array
​
next_cursor
string
Cursor zum Abrufen der nächsten Seite mit Ergebnissen. Übergeben Sie dies als Parameter cursor in Ihrer nächsten Anfrage. null, wenn keine weiteren Ergebnisse vorliegen.
​
prev_cursor
string
Cursor zum Abrufen der vorherigen Ergebnisseite. null, wenn dies die erste Seite ist.
​
per_page
integer
Anzahl der Elemente pro Seite
curl -X GET "https://app.famulor.de/api/user/conversations?type=whatsapp&per_page=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "data": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "assistant_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "assistant_name": "Support Assistent",
      "type": "widget",
      "variables": {
        "user_name": "Jane Smith",
        "plan": "premium"
      },
      "message_count": 12,
      "total_cost": 0.0045,
      "ai_enabled": true,
      "created_at": "2025-01-25 14:30:00",
      "updated_at": "2025-01-25 14:45:22"
    },
    {
      "id": "8d0f7780-8536-51ef-055c-f18fd2g01bf8",
      "assistant_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "assistant_name": "Support Assistent",
      "type": "whatsapp",
      "variables": null,
      "message_count": 8,
      "total_cost": 0.0032,
      "ai_enabled": true,
      "created_at": "2025-01-25 10:15:00",
      "updated_at": "2025-01-25 10:28:45",
      "whatsapp_sender": {
        "name": "Acme Corp Support",
        "phone": "+14155551234"
      },
      "customer": {
        "name": "John Doe",
        "phone": "+14155559876"
      }
    },
    {
      "id": "9e1g8891-9647-62fg-166d-g29ge3h12cg9",
      "assistant_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "assistant_name": "Support Assistent",
      "type": "api",
      "variables": {
        "lead_id": "12345",
        "source": "website"
      },
      "external_identifier": "crm-lead-12345",
      "message_count": 5,
      "total_cost": 0.0021,
      "ai_enabled": true,
      "created_at": "2025-01-25 09:00:00",
      "updated_at": "2025-01-25 09:15:30"
    }
  ],
  "path": "https://app.famulor.de/api/user/conversations",
  "per_page": 15,
  "next_cursor": "eyJpZCI6MTAwLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",
  "prev_cursor": null
}

​
Konversationstypen

TypBeschreibung
testInterne Testgespräche aus dem Assistenten-Testinterface
widgetKonversationen aus dem Web-Chat-Widget
whatsappWhatsApp-Business-Konversationen
apiPer API erstellte Konversationen

​
Filter-Parameter

Alle Filterparameter verwenden indizierte Spalten für eine effiziente Abfrage:
ParameterBeschreibungAnwendungsfall
typeNach Konversationstyp filternNur WhatsApp- oder Widget-Konversationen abrufen
assistant_idNach spezifischem Assistenten filternGespräche für einen einzelnen Assistenten anzeigen
customer_phoneNach Kundentelefonnummer filternAlle Gespräche mit einem bestimmten Kunden finden
whatsapp_sender_phoneNach WhatsApp-Absendernummer filternAlle Gespräche von einer Unternehmensnummer finden
external_identifierNach Ihrer externen ID filternKonversationen mit Ihren CRM-Datensätzen verknüpfen

​
WhatsApp-Konversationsdetails

Für WhatsApp-Konversationen enthält die Antwort zusätzliche Felder:
  • whatsapp_sender: Die Business-WhatsApp-Nummer, die das Gespräch geführt hat (Name und Telefonnummer Ihres WhatsApp-Absenders)
  • customer: Der Kunde, der das Gespräch initiiert oder empfangen hat (dessen Name und Telefonnummer)
Diese Felder sind nur bei Konversationen vom Typ whatsapp vorhanden und helfen Ihnen, die beteiligten Parteien zu identifizieren, wenn Sie eine Integration mit Ihren CRM- oder Support-Systemen vornehmen.

​
API-Konversationsdetails

Für über die API erstellte Konversationen können Sie beim Erstellen der Konversation einen external_identifier festlegen. Diese Kennung wird in der Antwort zurückgegeben und kann für Folgendes verwendet werden:
  • Verknüpfung von Konversationen mit Ihren CRM-Leads oder -Kontakten
  • Nachverfolgung von Konversationen über Ihre internen Systeme hinweg
  • Filterung von Konversationen nach Ihrer externen Referenz

​
Anwendungsfälle

  • Analyse-Dashboard: Anzeige von Konversationsmetriken und Trends
  • CRM-Integration: Synchronisierung von Konversationsdaten mit Ihrer Kundendatenbank unter Verwendung von external_identifier
  • Kundensuche: Finden aller Konversationen mit einem bestimmten Kunden über customer_phone
  • Qualitätsüberwachung: Überprüfung des Konversationsvolumens nach Typ und Assistent
  • Abrechnungsprüfung: Verfolgung der Konversationskosten in Ihrem Unternehmen