Zum Hauptinhalt springen

API-Referenz

Vollständige API-Dokumentation für die Integration von Hanc.AI in Ihre Anwendungen. Verwalten Sie Agenten, rufen Sie Anrufdaten ab, starten Sie Anrufe und steuern Sie jeden Teil der Plattform programmatisch.


Kurzübersicht

Basis-URLhttps://api.hanc.ai
AuthentifizierungAPI-Key per x-api-key-Header
FormatJSON

Erzeugen Sie einen API-Key unter Integration → API Keys im Dashboard. Sie können bis zu 3 Keys pro Benutzer haben — Setup, Berechtigungen und Sicherheitshinweise finden Sie im API-Keys-Abschnitt in Integrationen.

curl -X GET "https://api.hanc.ai/v1/agent/list" \
-H "x-api-key: YOUR_API_KEY"

Verfügbare Endpoints

Anrufe

AktionMethodeEndpoint
Anrufe auflistenGET/v1/call/list
Anrufdetails (Transkript, Sentiment, Zusammenfassung)GET/v1/call/:id
Allgemeine Analytik (Metriken nach Datum/Agent)GET/v1/call/general-metrics
Tages-AnalytikGET/v1/call/daily-metrics
Sentiment-StatistikenGET/v1/call/sentiment-stats
KostenaufschlüsselungGET/v1/call/costs-breakdown
Anrufe exportieren (CSV)GET/v1/call/list/export
Kosten exportieren (CSV)GET/v1/call/costs-breakdown/export
Telefonanruf startenPOST/v1/call/make-phone-call
Web-Call startenPOST/v1/call/make-web-call

Agenten

AktionMethodeEndpoint
Agenten auflistenGET/v1/agent/list
Agent-DetailsGET/v1/agent/:id
Agent erstellenPOST/v1/agent
Agent aktualisierenPATCH/v1/agent/:id
Agent löschenDELETE/v1/agent/:id
Anrufstatistik eines AgentenGET/v1/agent/:id/call-stats
Agent-Templates auflistenGET/v1/agent/agent_template/list

Agent Actions:

AktionMethodeEndpoint
Aktionen auflistenGET/v1/agent/:id/actions
Aktion hinzufügenPOST/v1/agent/:id/actions
Aktion aktualisierenPATCH/v1/agent/:id/actions/:actionId
Aktion löschenDELETE/v1/agent/:id/actions/:actionId

Agent Tools:

AktionMethodeEndpoint
Tools auflistenGET/v1/agent/:id/tools
Tool hinzufügenPOST/v1/agent/:id/tools
Tool aktualisierenPATCH/v1/agent/:id/tools/:toolId
Tool löschenDELETE/v1/agent/:id/tools/:toolId

Knowledge Base

AktionMethodeEndpoint
Knowledge Bases auflistenGET/v1/knowledge-base/list
Knowledge Base erstellenPOST/v1/knowledge-base
Datei(en) hochladenPOST/v1/knowledge-base/:id/file(s)
Datei löschenDELETE/v1/knowledge-base/:id/file
Agenten zuweisenPUT/v1/knowledge-base/:id/agents

Telefonnummern

AktionMethodeEndpoint
Nummern auflistenGET/v1/phone-number/list
Verfügbare Nummern (nach Land)GET/v1/phone-number/available
Nummer kaufenPOST/v1/phone-number/buy
Nummer importierenPOST/v1/phone-number/import
Mit SIP verbindenPATCH/v1/phone-number/connect-to-sip

Stimmen

AktionMethodeEndpoint
Stimmen auflistenGET/v1/voice/list

Nach Sprache filtern: GET /v1/voice/list?language=de

Abonnement

AktionMethodeEndpoint
Abonnement-DetailsGET/v1/subscription
Auto-Top-up konfigurierenPATCH/v1/subscription/auto-top-up
Top-up-Betrag festlegenPATCH/v1/subscription/top-up-amount

Kunden

AktionMethodeEndpoint
Kunden auflistenGET/v1/customer/list
KundendetailsGET/v1/customer/:id
Kunde erstellenPOST/v1/customer
Kunde aktualisierenPATCH/v1/customer/:id
Kunde löschenDELETE/v1/customer/:id

Workspaces

AktionMethodeEndpoint
Workspace-OperationenGET/POST/PATCH/DELETE/v1/workspaces/*
Mitglied einladenPOST/v1/workspaces/:id/invite-member
Mitglied entfernenDELETE/v1/workspaces/:id/invite-member

Was nicht über die API verfügbar ist

Einige Operationen sind nur über das Dashboard verfügbar:

FeatureGrund
API-Key-VerwaltungSicherheit — Keys können keine weiteren Keys erstellen
Telefonnummern-EinrichtungErfordert interaktive Einrichtung
Google-Calendar-IntegrationErfordert interaktive Autorisierung
Abrechnung & ZahlungenÜber das Dashboard verwaltet

Brauchen Sie Hilfe?

Kontaktieren Sie unser Support-Team unter support@hanc.ai für API-bezogene Fragen.