Zum Hauptinhalt springen

API-Referenz

Die Endpunkte sind nach Ressource gruppiert. Jeder Endpunkt erfordert ein Bearer-JWT und ist auf die project_id des Tokens beschränkt.

Ressourcen​

RessourceBeschreibungReferenz
Authentifizierung & OnboardingLogin, Registrierung, Projektauswahl, Onboarding.Ansehen
LeadsCRM-Leads erstellen, importieren und verwalten; Opportunities & Pipelines.Ansehen
Aktivitäten (Timeline)Einheitliche Timeline für Anruf-/Notiz-/E-Mail-/benutzerdefinierte Aktivitäten.Ansehen
Benutzerdefinierte Felder & MetadatenBenutzerdefinierte Felder, Aktivitätstypen, Tags, Status, Ergebnisse.Ansehen
Smart ViewsGespeicherte, gefilterte Lead-Segmente.Ansehen
Power DialerAutomatisiertes und manuelles ausgehendes Wählen.Ansehen
Anrufe & TelefonieLive-Anrufe, Telefonnummern, Twilio-Bereitstellung, Terminal.Ansehen
Agenten & AssistentKI-Agenten, Vorlagen, Prompts, Terminvereinbarung.Ansehen
AufgabenFollow-up-Aufgaben / To-dos.Ansehen
JobsHintergrundarbeiten wie Anrufe planen.Ansehen
E-Mail & SMSDomains, Signaturen, Vorlagen, Dateien, SMS.Ansehen
Dashboards & BerichteDashboards, Widgets und Berichtswesen.Ansehen
WorkflowsAutomatisierungs-Workflows, Ausführungen, Auslöser, Secrets.Ansehen
Team & EinladungenTeammitglieder und Projekteinladungen.Ansehen
AbrechnungStripe-Abonnements, Checkout, Minutenguthaben.Ansehen
IntegrationenClose.io, Calendly, Synchronisierung & Import.Ansehen
API-KeysProgrammatische API-Keys.Ansehen
E-Mail-TrackingÖffentliche Öffnungs-/Klick-Tracking-Endpunkte.Ansehen
Über diese Referenz

Jede im Backend gemountete Route (backend-ki-caller/src/main.rs) ist auf den obigen Ressourcenseiten aufgeführt, gruppiert nach Ressource mit ihrer Methode und ihrem Pfad. Seiten wie Leads hinzufügen und Job erstellen ergänzen vollständige Anfrage-/Antwort-Details gemäß der Standard-Seitenvorlage; die übrigen Endpunkte werden nach und nach auf diese Tiefe erweitert. Automatisch generierte Schemata für einen Teil der Routen sind außerdem über die Swagger UI verfügbar (teilweise Abdeckung).

Seitenvorlage​

Jede Endpunktseite folgt derselben Struktur, damit die Referenz konsistent bleibt:

  1. Endpunkt — Methode + Pfad.
  2. Authentifizierung — sofern nicht anders angegeben immer Bearer-JWT.
  3. Request-Body — JSON-Schema mit einem Beispiel.
  4. Verhalten — Validierungsregeln und Nebeneffekte.
  5. Erfolgsantwort — Beispiel-Umschlag.
  6. Fehlerantworten — die für den Endpunkt spezifischen Fehler-Umschläge.