Перейти к основному содержимому

API Reference

Полная документация API для интеграции Hanc.AI в ваши приложения. Управляйте агентами, забирайте данные звонков, инициируйте звонки и работайте со всеми возможностями платформы программно.


Краткий обзор

Base URLhttps://api.hanc.ai
АутентификацияAPI-ключ через заголовок x-api-key
ФорматJSON

Сгенерируйте API-ключ из Integration → API Keys в панели. На пользователя можно иметь до 3 ключей — см. раздел API Keys в Integrations для настройки, прав и рекомендаций по безопасности.

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

Доступные эндпоинты

Звонки

ДействиеМетодЭндпоинт
Список звонковGET/v1/call/list
Детали звонка (транскрипт, настроение, резюме)GET/v1/call/:id
Общая аналитика (метрики по датам/агентам)GET/v1/call/general-metrics
Ежедневная аналитикаGET/v1/call/daily-metrics
Статистика настроенийGET/v1/call/sentiment-stats
Разбивка стоимостиGET/v1/call/costs-breakdown
Экспорт звонков (CSV)GET/v1/call/list/export
Экспорт расходов (CSV)GET/v1/call/costs-breakdown/export
Сделать телефонный звонокPOST/v1/call/make-phone-call
Сделать веб-звонокPOST/v1/call/make-web-call

Агенты

ДействиеМетодЭндпоинт
Список агентовGET/v1/agent/list
Детали агентаGET/v1/agent/:id
Создать агентаPOST/v1/agent
Обновить агентаPATCH/v1/agent/:id
Удалить агентаDELETE/v1/agent/:id
Статистика звонков агентаGET/v1/agent/:id/call-stats
Список шаблонов агентовGET/v1/agent/agent_template/list

Actions агента:

ДействиеМетодЭндпоинт
Список actionsGET/v1/agent/:id/actions
Добавить actionPOST/v1/agent/:id/actions
Обновить actionPATCH/v1/agent/:id/actions/:actionId
Удалить actionDELETE/v1/agent/:id/actions/:actionId

Tools агента:

ДействиеМетодЭндпоинт
Список toolsGET/v1/agent/:id/tools
Добавить toolPOST/v1/agent/:id/tools
Обновить toolPATCH/v1/agent/:id/tools/:toolId
Удалить toolDELETE/v1/agent/:id/tools/:toolId

База знаний

ДействиеМетодЭндпоинт
Список баз знанийGET/v1/knowledge-base/list
Создать базу знанийPOST/v1/knowledge-base
Загрузить файл(ы)POST/v1/knowledge-base/:id/file(s)
Удалить файлDELETE/v1/knowledge-base/:id/file
Назначить агентовPUT/v1/knowledge-base/:id/agents

Телефонные номера

ДействиеМетодЭндпоинт
Список номеровGET/v1/phone-number/list
Доступные номера (по стране)GET/v1/phone-number/available
Купить номерPOST/v1/phone-number/buy
Импортировать номерPOST/v1/phone-number/import
Подключить к SIPPATCH/v1/phone-number/connect-to-sip

Голоса

ДействиеМетодЭндпоинт
Список голосовGET/v1/voice/list

Фильтр по языку: GET /v1/voice/list?language=de

Подписка

ДействиеМетодЭндпоинт
Детали подпискиGET/v1/subscription
Настройка автопополненияPATCH/v1/subscription/auto-top-up
Установить сумму пополненияPATCH/v1/subscription/top-up-amount

Клиенты

ДействиеМетодЭндпоинт
Список клиентовGET/v1/customer/list
Детали клиентаGET/v1/customer/:id
Создать клиентаPOST/v1/customer
Обновить клиентаPATCH/v1/customer/:id
Удалить клиентаDELETE/v1/customer/:id

Workspaces

ДействиеМетодЭндпоинт
Операции с workspaceGET/POST/PATCH/DELETE/v1/workspaces/*
Пригласить участникаPOST/v1/workspaces/:id/invite-member
Удалить участникаDELETE/v1/workspaces/:id/invite-member

Что недоступно через API

Некоторые операции доступны только через панель:

ВозможностьПричина
Управление API-ключамиБезопасность — ключи не могут создавать другие ключи
Настройка телефонных номеровТребует интерактивной настройки
Интеграция с Google CalendarТребует интерактивной авторизации
Биллинг и платежиУправляется через панель

Нужна помощь?

Свяжитесь с поддержкой по support@hanc.ai для вопросов по API.