Aller au contenu principal

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 basehttps://api.hanc.ai
AuthentificationClé API via l'en-tête x-api-key
FormatJSON

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

ActionMéthodeEndpoint
Lister les appelsGET/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 quotidienneGET/v1/call/daily-metrics
Statistiques de sentimentGET/v1/call/sentiment-stats
Répartition des coûtsGET/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éphoniquePOST/v1/call/make-phone-call
Passer un appel webPOST/v1/call/make-web-call

Agents

ActionMéthodeEndpoint
Lister les agentsGET/v1/agent/list
Détails d'agentGET/v1/agent/:id
Créer un agentPOST/v1/agent
Mettre à jour un agentPATCH/v1/agent/:id
Supprimer un agentDELETE/v1/agent/:id
Statistiques d'appel d'un agentGET/v1/agent/:id/call-stats
Lister les modèles d'agentGET/v1/agent/agent_template/list

Actions d'agent :

ActionMéthodeEndpoint
Lister les actionsGET/v1/agent/:id/actions
Ajouter une actionPOST/v1/agent/:id/actions
Mettre à jour une actionPATCH/v1/agent/:id/actions/:actionId
Supprimer une actionDELETE/v1/agent/:id/actions/:actionId

Outils d'agent :

ActionMéthodeEndpoint
Lister les outilsGET/v1/agent/:id/tools
Ajouter un outilPOST/v1/agent/:id/tools
Mettre à jour un outilPATCH/v1/agent/:id/tools/:toolId
Supprimer un outilDELETE/v1/agent/:id/tools/:toolId

Base de connaissances

ActionMéthodeEndpoint
Lister les bases de connaissancesGET/v1/knowledge-base/list
Créer une base de connaissancesPOST/v1/knowledge-base
Uploader un/des fichier(s)POST/v1/knowledge-base/:id/file(s)
Supprimer un fichierDELETE/v1/knowledge-base/:id/file
Assigner des agentsPUT/v1/knowledge-base/:id/agents

Numéros de téléphone

ActionMéthodeEndpoint
Lister les numérosGET/v1/phone-number/list
Numéros disponibles (par pays)GET/v1/phone-number/available
Acheter un numéroPOST/v1/phone-number/buy
Importer un numéroPOST/v1/phone-number/import
Connecter au SIPPATCH/v1/phone-number/connect-to-sip

Voix

ActionMéthodeEndpoint
Lister les voixGET/v1/voice/list

Filtrer par langue : GET /v1/voice/list?language=de

Abonnement

ActionMéthodeEndpoint
Détails d'abonnementGET/v1/subscription
Configurer le rechargement automatiquePATCH/v1/subscription/auto-top-up
Définir le montant de rechargementPATCH/v1/subscription/top-up-amount

Clients

ActionMéthodeEndpoint
Lister les clientsGET/v1/customer/list
Détails clientGET/v1/customer/:id
Créer un clientPOST/v1/customer
Mettre à jour un clientPATCH/v1/customer/:id
Supprimer un clientDELETE/v1/customer/:id

Espaces de travail

ActionMéthodeEndpoint
Opérations sur les espaces de travailGET/POST/PATCH/DELETE/v1/workspaces/*
Inviter un membrePOST/v1/workspaces/:id/invite-member
Retirer un membreDELETE/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 APISécurité — les clés ne peuvent pas créer d'autres clés
Configuration des numéros de téléphoneNécessite une configuration interactive
Intégration Google CalendarNécessite une autorisation interactive
Facturation et paiementsGérés via le tableau de bord

Besoin d'aide ?

Contactez notre équipe support à support@hanc.ai pour les questions liées à l'API.