Довідник API

Повна документація API для інтеграції Hanc.AI у ваші застосунки. Керуйте агентами, отримуйте дані про дзвінки, здійснюйте дзвінки та керуйте будь-якою частиною платформи програмно.

---

Швидкий огляд

Базовий URL	https://api.hanc.ai
Автентифікація	API-ключ через заголовок x-api-key
Формат	JSON

Згенеруйте API-ключ у розділі Integration → API Keys на дашборді. Ви можете мати до 3 ключів на користувача — див. розділ API Keys в Інтеграціях для налаштування, дозволів та рекомендацій з безпеки.

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
Зробити web-дзвінок	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

Дії агента:

Дія	Метод	Ендпоінт
Список дій	GET	/v1/agent/:id/actions
Додати дію	POST	/v1/agent/:id/actions
Оновити дію	PATCH	/v1/agent/:id/actions/:actionId
Видалити дію	DELETE	/v1/agent/:id/actions/:actionId

Інструменти агента:

Дія	Метод	Ендпоінт
Список інструментів	GET	/v1/agent/:id/tools
Додати інструмент	POST	/v1/agent/:id/tools
Оновити інструмент	PATCH	/v1/agent/:id/tools/:toolId
Видалити інструмент	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

Робочі простори

Дія	Метод	Ендпоінт
Операції з робочим простором	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.