API Reference
Полная документация API для интеграции Hanc.AI в ваши приложения. Управляйте агентами, забирайте данные звонков, инициируйте звонки и работайте со всеми возможностями платформы программно.
Краткий обзор
| Base URL | https://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 агента:
| Действие | Метод | Эндпоинт |
|---|---|---|
| Список actions | GET | /v1/agent/:id/actions |
| Добавить action | POST | /v1/agent/:id/actions |
| Обновить action | PATCH | /v1/agent/:id/actions/:actionId |
| Удалить action | DELETE | /v1/agent/:id/actions/:actionId |
Tools агента:
| Действие | Метод | Эндпоинт |
|---|---|---|
| Список tools | GET | /v1/agent/:id/tools |
| Добавить tool | POST | /v1/agent/:id/tools |
| Обновить tool | PATCH | /v1/agent/:id/tools/:toolId |
| Удалить tool | DELETE | /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 |
| Подключить к SIP | PATCH | /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
| Действие | Метод | Эндпоинт |
|---|---|---|
| Операции с workspace | GET/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.