API анықтамасы

Hanc.AI-ды қолданбаларыңызға интеграциялауға арналған толық API құжаттамасы. Агенттерді басқарыңыз, қоңырау деректерін алыңыз, қоңыраулар жасаңыз және платформаның әр бөлігін бағдарламалық түрде басқарыңыз.

---

Жылдам шолу

Базалық 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
Веб қоңырауын жасау	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 интеграциясы	Интерактивті авторизацияны талап етеді
Төлемдер мен есеп айырысулар	Дашборд арқылы басқарылады

---

Көмек керек пе?

API-ге қатысты сұрақтар үшін қолдау командамызға support@hanc.ai арқылы жүгініңіз.