Riferimento API
Documentazione API completa per integrare Hanc.AI nelle tue applicazioni. Gestisci agenti, recupera dati delle chiamate, effettua chiamate e opera ogni parte della piattaforma in modo programmatico.
Panoramica rapida
| URL base | https://api.hanc.ai |
| Autenticazione | Chiave API tramite header x-api-key |
| Formato | JSON |
Genera una chiave API da Integrazione → Chiavi API nella dashboard. Puoi avere fino a 3 chiavi per utente — vedi la sezione Chiavi API in Integrazioni per configurazione, permessi e linee guida di sicurezza.
curl -X GET "https://api.hanc.ai/v1/agent/list" \
-H "x-api-key: YOUR_API_KEY"
Endpoint disponibili
Chiamate
| Azione | Metodo | Endpoint |
|---|---|---|
| Elenco chiamate | GET | /v1/call/list |
| Dettagli chiamata (trascrizione, sentiment, riepilogo) | GET | /v1/call/:id |
| Analisi generali (metriche per data/agente) | GET | /v1/call/general-metrics |
| Analisi giornaliere | GET | /v1/call/daily-metrics |
| Statistiche di sentiment | GET | /v1/call/sentiment-stats |
| Ripartizione dei costi | GET | /v1/call/costs-breakdown |
| Esporta chiamate (CSV) | GET | /v1/call/list/export |
| Esporta costi (CSV) | GET | /v1/call/costs-breakdown/export |
| Effettua una chiamata telefonica | POST | /v1/call/make-phone-call |
| Effettua una chiamata web | POST | /v1/call/make-web-call |
Agenti
| Azione | Metodo | Endpoint |
|---|---|---|
| Elenco agenti | GET | /v1/agent/list |
| Dettagli agente | GET | /v1/agent/:id |
| Crea agente | POST | /v1/agent |
| Aggiorna agente | PATCH | /v1/agent/:id |
| Elimina agente | DELETE | /v1/agent/:id |
| Statistiche chiamate dell'agente | GET | /v1/agent/:id/call-stats |
| Elenco template di agenti | GET | /v1/agent/agent_template/list |
Azioni dell'agente:
| Azione | Metodo | Endpoint |
|---|---|---|
| Elenco azioni | GET | /v1/agent/:id/actions |
| Aggiungi azione | POST | /v1/agent/:id/actions |
| Aggiorna azione | PATCH | /v1/agent/:id/actions/:actionId |
| Elimina azione | DELETE | /v1/agent/:id/actions/:actionId |
Strumenti dell'agente:
| Azione | Metodo | Endpoint |
|---|---|---|
| Elenco strumenti | GET | /v1/agent/:id/tools |
| Aggiungi strumento | POST | /v1/agent/:id/tools |
| Aggiorna strumento | PATCH | /v1/agent/:id/tools/:toolId |
| Elimina strumento | DELETE | /v1/agent/:id/tools/:toolId |
Knowledge Base
| Azione | Metodo | Endpoint |
|---|---|---|
| Elenco knowledge base | GET | /v1/knowledge-base/list |
| Crea knowledge base | POST | /v1/knowledge-base |
| Carica file | POST | /v1/knowledge-base/:id/file(s) |
| Elimina file | DELETE | /v1/knowledge-base/:id/file |
| Assegna agenti | PUT | /v1/knowledge-base/:id/agents |
Numeri di telefono
| Azione | Metodo | Endpoint |
|---|---|---|
| Elenco numeri | GET | /v1/phone-number/list |
| Numeri disponibili (per paese) | GET | /v1/phone-number/available |
| Acquista un numero | POST | /v1/phone-number/buy |
| Importa numero | POST | /v1/phone-number/import |
| Collega a SIP | PATCH | /v1/phone-number/connect-to-sip |
Voci
| Azione | Metodo | Endpoint |
|---|---|---|
| Elenco voci | GET | /v1/voice/list |
Filtra per lingua: GET /v1/voice/list?language=de
Abbonamento
| Azione | Metodo | Endpoint |
|---|---|---|
| Dettagli abbonamento | GET | /v1/subscription |
| Configura ricarica automatica | PATCH | /v1/subscription/auto-top-up |
| Imposta importo di ricarica | PATCH | /v1/subscription/top-up-amount |
Clienti
| Azione | Metodo | Endpoint |
|---|---|---|
| Elenco clienti | GET | /v1/customer/list |
| Dettagli cliente | GET | /v1/customer/:id |
| Crea cliente | POST | /v1/customer |
| Aggiorna cliente | PATCH | /v1/customer/:id |
| Elimina cliente | DELETE | /v1/customer/:id |
Workspace
| Azione | Metodo | Endpoint |
|---|---|---|
| Operazioni sui workspace | GET/POST/PATCH/DELETE | /v1/workspaces/* |
| Invita membro | POST | /v1/workspaces/:id/invite-member |
| Rimuovi membro | DELETE | /v1/workspaces/:id/invite-member |
Cosa non è disponibile via API
Alcune operazioni sono disponibili solo tramite la dashboard:
| Funzionalità | Motivo |
|---|---|
| Gestione delle chiavi API | Sicurezza — le chiavi non possono crearne altre |
| Configurazione del numero di telefono | Richiede una configurazione interattiva |
| Integrazione Google Calendar | Richiede autorizzazione interattiva |
| Fatturazione e pagamenti | Gestiti tramite la dashboard |
Hai bisogno di aiuto?
Contatta il nostro team di supporto a support@hanc.ai per domande relative all'API.