Přeskočit na hlavní obsah

API Reference

Kompletní dokumentace API pro integraci Hanc.AI do vašich aplikací. Spravujte agenty, načítejte data hovorů, uskutečňujte hovory a obsluhujte každou část platformy programaticky.


Rychlý přehled

Base URLhttps://api.hanc.ai
AutentizaceAPI klíč přes hlavičku x-api-key
FormátJSON

API klíč vygenerujte v dashboardu v Integration → API Keys. Můžete mít až 3 klíče na uživatele — viz sekce API Keys v Integracích pro nastavení, oprávnění a bezpečnostní pokyny.

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

Dostupné endpointy

Hovory

AkceMetodaEndpoint
Seznam hovorůGET/v1/call/list
Detaily hovoru (přepis, sentiment, shrnutí)GET/v1/call/:id
Obecná analytika (metriky podle data/agenta)GET/v1/call/general-metrics
Denní analytikaGET/v1/call/daily-metrics
Statistiky sentimentuGET/v1/call/sentiment-stats
Rozpis nákladůGET/v1/call/costs-breakdown
Export hovorů (CSV)GET/v1/call/list/export
Export nákladů (CSV)GET/v1/call/costs-breakdown/export
Uskutečnit telefonní hovorPOST/v1/call/make-phone-call
Uskutečnit webový hovorPOST/v1/call/make-web-call

Agenti

AkceMetodaEndpoint
Seznam agentůGET/v1/agent/list
Detaily agentaGET/v1/agent/:id
Vytvořit agentaPOST/v1/agent
Aktualizovat agentaPATCH/v1/agent/:id
Smazat agentaDELETE/v1/agent/:id
Statistiky hovorů agentaGET/v1/agent/:id/call-stats
Seznam šablon agentůGET/v1/agent/agent_template/list

Akce agenta:

AkceMetodaEndpoint
Seznam akcíGET/v1/agent/:id/actions
Přidat akciPOST/v1/agent/:id/actions
Aktualizovat akciPATCH/v1/agent/:id/actions/:actionId
Smazat akciDELETE/v1/agent/:id/actions/:actionId

Nástroje agenta:

AkceMetodaEndpoint
Seznam nástrojůGET/v1/agent/:id/tools
Přidat nástrojPOST/v1/agent/:id/tools
Aktualizovat nástrojPATCH/v1/agent/:id/tools/:toolId
Smazat nástrojDELETE/v1/agent/:id/tools/:toolId

Znalostní báze

AkceMetodaEndpoint
Seznam znalostních bázíGET/v1/knowledge-base/list
Vytvořit znalostní báziPOST/v1/knowledge-base
Nahrát soubor(y)POST/v1/knowledge-base/:id/file(s)
Smazat souborDELETE/v1/knowledge-base/:id/file
Přiřadit agentyPUT/v1/knowledge-base/:id/agents

Telefonní čísla

AkceMetodaEndpoint
Seznam číselGET/v1/phone-number/list
Dostupná čísla (podle země)GET/v1/phone-number/available
Koupit čísloPOST/v1/phone-number/buy
Importovat čísloPOST/v1/phone-number/import
Připojit k SIPPATCH/v1/phone-number/connect-to-sip

Hlasy

AkceMetodaEndpoint
Seznam hlasůGET/v1/voice/list

Filtr podle jazyka: GET /v1/voice/list?language=de

Předplatné

AkceMetodaEndpoint
Detaily předplatnéhoGET/v1/subscription
Konfigurace automatického dobíjeníPATCH/v1/subscription/auto-top-up
Nastavit částku dobitíPATCH/v1/subscription/top-up-amount

Zákazníci

AkceMetodaEndpoint
Seznam zákazníkůGET/v1/customer/list
Detaily zákazníkaGET/v1/customer/:id
Vytvořit zákazníkaPOST/v1/customer
Aktualizovat zákazníkaPATCH/v1/customer/:id
Smazat zákazníkaDELETE/v1/customer/:id

Pracovní prostory

AkceMetodaEndpoint
Operace s pracovním prostoremGET/POST/PATCH/DELETE/v1/workspaces/*
Pozvat členaPOST/v1/workspaces/:id/invite-member
Odebrat členaDELETE/v1/workspaces/:id/invite-member

Co není dostupné přes API

Některé operace jsou dostupné pouze přes dashboard:

FunkceDůvod
Správa API klíčůBezpečnost — klíče nemohou vytvářet další klíče
Nastavení telefonního číslaVyžaduje interaktivní nastavení
Integrace Google CalendarVyžaduje interaktivní autorizaci
Fakturace a platbySpravováno přes dashboard

Potřebujete pomoc?

Kontaktujte náš tým podpory na support@hanc.ai pro otázky související s API.