Référence API
Documentation API complète pour intégrer Hanc.AI à vos applications. Gérez les agents, récupérez les données d'appel, passez des appels et pilotez toutes les parties de la plateforme par programme.
Vue d'ensemble rapide
| URL de base | https://api.hanc.ai |
| Authentification | Clé API via l'en-tête x-api-key |
| Format | JSON |
Générez une clé API depuis Intégration → Clés API dans le tableau de bord. Vous pouvez avoir jusqu'à 3 clés par utilisateur — voir la section Clés API dans Intégrations pour la configuration, les permissions et les conseils de sécurité.
curl -X GET "https://api.hanc.ai/v1/agent/list" \
-H "x-api-key: YOUR_API_KEY"
Endpoints disponibles
Appels
| Action | Méthode | Endpoint |
|---|---|---|
| Lister les appels | GET | /v1/call/list |
| Détails d'appel (transcription, sentiment, résumé) | GET | /v1/call/:id |
| Analytique générale (métriques par date/agent) | GET | /v1/call/general-metrics |
| Analytique quotidienne | GET | /v1/call/daily-metrics |
| Statistiques de sentiment | GET | /v1/call/sentiment-stats |
| Répartition des coûts | GET | /v1/call/costs-breakdown |
| Export des appels (CSV) | GET | /v1/call/list/export |
| Export des coûts (CSV) | GET | /v1/call/costs-breakdown/export |
| Passer un appel téléphonique | POST | /v1/call/make-phone-call |
| Passer un appel web | POST | /v1/call/make-web-call |
Agents
| Action | Méthode | Endpoint |
|---|---|---|
| Lister les agents | GET | /v1/agent/list |
| Détails d'agent | GET | /v1/agent/:id |
| Créer un agent | POST | /v1/agent |
| Mettre à jour un agent | PATCH | /v1/agent/:id |
| Supprimer un agent | DELETE | /v1/agent/:id |
| Statistiques d'appel d'un agent | GET | /v1/agent/:id/call-stats |
| Lister les modèles d'agent | GET | /v1/agent/agent_template/list |
Actions d'agent :
| Action | Méthode | Endpoint |
|---|---|---|
| Lister les actions | GET | /v1/agent/:id/actions |
| Ajouter une action | POST | /v1/agent/:id/actions |
| Mettre à jour une action | PATCH | /v1/agent/:id/actions/:actionId |
| Supprimer une action | DELETE | /v1/agent/:id/actions/:actionId |
Outils d'agent :
| Action | Méthode | Endpoint |
|---|---|---|
| Lister les outils | GET | /v1/agent/:id/tools |
| Ajouter un outil | POST | /v1/agent/:id/tools |
| Mettre à jour un outil | PATCH | /v1/agent/:id/tools/:toolId |
| Supprimer un outil | DELETE | /v1/agent/:id/tools/:toolId |
Base de connaissances
| Action | Méthode | Endpoint |
|---|---|---|
| Lister les bases de connaissances | GET | /v1/knowledge-base/list |
| Créer une base de connaissances | POST | /v1/knowledge-base |
| Uploader un/des fichier(s) | POST | /v1/knowledge-base/:id/file(s) |
| Supprimer un fichier | DELETE | /v1/knowledge-base/:id/file |
| Assigner des agents | PUT | /v1/knowledge-base/:id/agents |
Numéros de téléphone
| Action | Méthode | Endpoint |
|---|---|---|
| Lister les numéros | GET | /v1/phone-number/list |
| Numéros disponibles (par pays) | GET | /v1/phone-number/available |
| Acheter un numéro | POST | /v1/phone-number/buy |
| Importer un numéro | POST | /v1/phone-number/import |
| Connecter au SIP | PATCH | /v1/phone-number/connect-to-sip |
Voix
| Action | Méthode | Endpoint |
|---|---|---|
| Lister les voix | GET | /v1/voice/list |
Filtrer par langue : GET /v1/voice/list?language=de
Abonnement
| Action | Méthode | Endpoint |
|---|---|---|
| Détails d'abonnement | GET | /v1/subscription |
| Configurer le rechargement automatique | PATCH | /v1/subscription/auto-top-up |
| Définir le montant de rechargement | PATCH | /v1/subscription/top-up-amount |
Clients
| Action | Méthode | Endpoint |
|---|---|---|
| Lister les clients | GET | /v1/customer/list |
| Détails client | GET | /v1/customer/:id |
| Créer un client | POST | /v1/customer |
| Mettre à jour un client | PATCH | /v1/customer/:id |
| Supprimer un client | DELETE | /v1/customer/:id |
Espaces de travail
| Action | Méthode | Endpoint |
|---|---|---|
| Opérations sur les espaces de travail | GET/POST/PATCH/DELETE | /v1/workspaces/* |
| Inviter un membre | POST | /v1/workspaces/:id/invite-member |
| Retirer un membre | DELETE | /v1/workspaces/:id/invite-member |
Ce qui n'est pas disponible via l'API
Certaines opérations ne sont disponibles que via le tableau de bord :
| Fonctionnalité | Raison |
|---|---|
| Gestion des clés API | Sécurité — les clés ne peuvent pas créer d'autres clés |
| Configuration des numéros de téléphone | Nécessite une configuration interactive |
| Intégration Google Calendar | Nécessite une autorisation interactive |
| Facturation et paiements | Gérés via le tableau de bord |
Besoin d'aide ?
Contactez notre équipe support à support@hanc.ai pour les questions liées à l'API.