Dokumentacja API

Pełna dokumentacja API do integracji Hanc.AI z Twoimi aplikacjami. Zarządzaj agentami, pobieraj dane połączeń, wykonuj połączenia i obsługuj każdą część platformy programowo.

---

Szybki przegląd

Base URL	https://api.hanc.ai
Uwierzytelnianie	Klucz API przez nagłówek x-api-key
Format	JSON

Wygeneruj klucz API z Integration → API Keys w dashboardzie. Możesz mieć maksymalnie 3 klucze na użytkownika — szczegóły setupu, uprawnień i wskazówek bezpieczeństwa w sekcji API Keys w Integracjach.

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

---

Dostępne endpointy

Połączenia

Akcja	Metoda	Endpoint
Lista połączeń	GET	/v1/call/list
Szczegóły połączenia (transkrypcja, sentyment, podsumowanie)	GET	/v1/call/:id
Analityka ogólna (metryki według daty/agenta)	GET	/v1/call/general-metrics
Analityka dzienna	GET	/v1/call/daily-metrics
Statystyki sentymentu	GET	/v1/call/sentiment-stats
Rozbicie kosztów	GET	/v1/call/costs-breakdown
Eksport połączeń (CSV)	GET	/v1/call/list/export
Eksport kosztów (CSV)	GET	/v1/call/costs-breakdown/export
Wykonaj połączenie telefoniczne	POST	/v1/call/make-phone-call
Wykonaj połączenie web	POST	/v1/call/make-web-call

Agenci

Akcja	Metoda	Endpoint
Lista agentów	GET	/v1/agent/list
Szczegóły agenta	GET	/v1/agent/:id
Utwórz agenta	POST	/v1/agent
Zaktualizuj agenta	PATCH	/v1/agent/:id
Usuń agenta	DELETE	/v1/agent/:id
Statystyki połączeń agenta	GET	/v1/agent/:id/call-stats
Lista szablonów agentów	GET	/v1/agent/agent_template/list

Akcje agenta:

Akcja	Metoda	Endpoint
Lista akcji	GET	/v1/agent/:id/actions
Dodaj akcję	POST	/v1/agent/:id/actions
Zaktualizuj akcję	PATCH	/v1/agent/:id/actions/:actionId
Usuń akcję	DELETE	/v1/agent/:id/actions/:actionId

Narzędzia agenta:

Akcja	Metoda	Endpoint
Lista narzędzi	GET	/v1/agent/:id/tools
Dodaj narzędzie	POST	/v1/agent/:id/tools
Zaktualizuj narzędzie	PATCH	/v1/agent/:id/tools/:toolId
Usuń narzędzie	DELETE	/v1/agent/:id/tools/:toolId

Baza wiedzy

Akcja	Metoda	Endpoint
Lista baz wiedzy	GET	/v1/knowledge-base/list
Utwórz bazę wiedzy	POST	/v1/knowledge-base
Wgraj plik(i)	POST	/v1/knowledge-base/:id/file(s)
Usuń plik	DELETE	/v1/knowledge-base/:id/file
Przypisz agentów	PUT	/v1/knowledge-base/:id/agents

Numery telefonów

Akcja	Metoda	Endpoint
Lista numerów	GET	/v1/phone-number/list
Dostępne numery (według kraju)	GET	/v1/phone-number/available
Kup numer	POST	/v1/phone-number/buy
Importuj numer	POST	/v1/phone-number/import
Podłącz do SIP	PATCH	/v1/phone-number/connect-to-sip

Głosy

Akcja	Metoda	Endpoint
Lista głosów	GET	/v1/voice/list

Filtruj według języka: GET /v1/voice/list?language=de

Subskrypcja

Akcja	Metoda	Endpoint
Szczegóły subskrypcji	GET	/v1/subscription
Skonfiguruj auto top-up	PATCH	/v1/subscription/auto-top-up
Ustaw kwotę top-up	PATCH	/v1/subscription/top-up-amount

Klienci

Akcja	Metoda	Endpoint
Lista klientów	GET	/v1/customer/list
Szczegóły klienta	GET	/v1/customer/:id
Utwórz klienta	POST	/v1/customer
Zaktualizuj klienta	PATCH	/v1/customer/:id
Usuń klienta	DELETE	/v1/customer/:id

Workspace'y

Akcja	Metoda	Endpoint
Operacje na workspace	GET/POST/PATCH/DELETE	/v1/workspaces/*
Zaproś członka	POST	/v1/workspaces/:id/invite-member
Usuń członka	DELETE	/v1/workspaces/:id/invite-member

---

Co nie jest dostępne przez API

Niektóre operacje są dostępne tylko przez dashboard:

Funkcja	Powód
Zarządzanie kluczami API	Bezpieczeństwo — klucze nie mogą tworzyć innych kluczy
Konfiguracja numeru telefonu	Wymaga interaktywnej konfiguracji
Integracja z Google Calendar	Wymaga interaktywnej autoryzacji
Rozliczenia i płatności	Zarządzane przez dashboard

---

Potrzebujesz pomocy?

Skontaktuj się z naszym zespołem wsparcia pod adresem support@hanc.ai w sprawie pytań związanych z API.