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 URL | https://api.hanc.ai |
| Autentizace | API klíč přes hlavičku x-api-key |
| Formát | JSON |
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
| Akce | Metoda | Endpoint |
|---|---|---|
| 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í analytika | GET | /v1/call/daily-metrics |
| Statistiky sentimentu | GET | /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í hovor | POST | /v1/call/make-phone-call |
| Uskutečnit webový hovor | POST | /v1/call/make-web-call |
Agenti
| Akce | Metoda | Endpoint |
|---|---|---|
| Seznam agentů | GET | /v1/agent/list |
| Detaily agenta | GET | /v1/agent/:id |
| Vytvořit agenta | POST | /v1/agent |
| Aktualizovat agenta | PATCH | /v1/agent/:id |
| Smazat agenta | DELETE | /v1/agent/:id |
| Statistiky hovorů agenta | GET | /v1/agent/:id/call-stats |
| Seznam šablon agentů | GET | /v1/agent/agent_template/list |
Akce agenta:
| Akce | Metoda | Endpoint |
|---|---|---|
| Seznam akcí | GET | /v1/agent/:id/actions |
| Přidat akci | POST | /v1/agent/:id/actions |
| Aktualizovat akci | PATCH | /v1/agent/:id/actions/:actionId |
| Smazat akci | DELETE | /v1/agent/:id/actions/:actionId |
Nástroje agenta:
| Akce | Metoda | Endpoint |
|---|---|---|
| Seznam nástrojů | GET | /v1/agent/:id/tools |
| Přidat nástroj | POST | /v1/agent/:id/tools |
| Aktualizovat nástroj | PATCH | /v1/agent/:id/tools/:toolId |
| Smazat nástroj | DELETE | /v1/agent/:id/tools/:toolId |
Znalostní báze
| Akce | Metoda | Endpoint |
|---|---|---|
| Seznam znalostních bází | GET | /v1/knowledge-base/list |
| Vytvořit znalostní bázi | POST | /v1/knowledge-base |
| Nahrát soubor(y) | POST | /v1/knowledge-base/:id/file(s) |
| Smazat soubor | DELETE | /v1/knowledge-base/:id/file |
| Přiřadit agenty | PUT | /v1/knowledge-base/:id/agents |
Telefonní čísla
| Akce | Metoda | Endpoint |
|---|---|---|
| Seznam čísel | GET | /v1/phone-number/list |
| Dostupná čísla (podle země) | GET | /v1/phone-number/available |
| Koupit číslo | POST | /v1/phone-number/buy |
| Importovat číslo | POST | /v1/phone-number/import |
| Připojit k SIP | PATCH | /v1/phone-number/connect-to-sip |
Hlasy
| Akce | Metoda | Endpoint |
|---|---|---|
| Seznam hlasů | GET | /v1/voice/list |
Filtr podle jazyka: GET /v1/voice/list?language=de
Předplatné
| Akce | Metoda | Endpoint |
|---|---|---|
| Detaily předplatného | GET | /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
| Akce | Metoda | Endpoint |
|---|---|---|
| Seznam zákazníků | GET | /v1/customer/list |
| Detaily zákazníka | GET | /v1/customer/:id |
| Vytvořit zákazníka | POST | /v1/customer |
| Aktualizovat zákazníka | PATCH | /v1/customer/:id |
| Smazat zákazníka | DELETE | /v1/customer/:id |
Pracovní prostory
| Akce | Metoda | Endpoint |
|---|---|---|
| Operace s pracovním prostorem | GET/POST/PATCH/DELETE | /v1/workspaces/* |
| Pozvat člena | POST | /v1/workspaces/:id/invite-member |
| Odebrat člena | DELETE | /v1/workspaces/:id/invite-member |
Co není dostupné přes API
Některé operace jsou dostupné pouze přes dashboard:
| Funkce | Důvod |
|---|---|
| Správa API klíčů | Bezpečnost — klíče nemohou vytvářet další klíče |
| Nastavení telefonního čísla | Vyžaduje interaktivní nastavení |
| Integrace Google Calendar | Vyžaduje interaktivní autorizaci |
| Fakturace a platby | Spravováno přes dashboard |
Potřebujete pomoc?
Kontaktujte náš tým podpory na support@hanc.ai pro otázky související s API.