API анықтамасы

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

Төмендегі әр бөлім сізге HTTP әдісі мен жолын, параметрлерді (жол, сұрау және дене), іске қосуға дайын мысал сұранысын және репрезентативті мысал жауабын береді, осылайша сіз payload пішіндерін болжамай-ақ біріктіре аласыз.

Жылдам шолу


Базалық URL	`https://api.hanc.ai`
Нұсқа префиксі	Барлық маршруттар `/v1` префиксімен басталады
Аутентификация	`x-api-key` тақырыбы арқылы API кілті
Формат	JSON (сұраныс және жауап)

Басқару тақтасындағы Integration → API Keys бөлімінен API кілтін жасаңыз. Бір пайдаланушыда 3 кілтке дейін болуы мүмкін — баптау, рұқсаттар және қауіпсіздік бойынша нұсқаулық үшін Интеграциялардағы API кілттері бөлімін қараңыз.

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

Аутентификация

Кілтіңізді әрбір сұраныста x-api-key тақырыбында жіберіңіз:

x-api-key: YOUR_API_KEY

Кілт оны иеленетін пайдаланушыға сәйкестендіріледі және әрбір сұраныс автоматты түрде сол пайдаланушыға шектеледі — сіз ешқашан пайдаланушы идентификаторын бермейсіз. Жоқ немесе жарамсыз кілт 401 Unauthorized / 403 Forbidden арқылы қабылданбайды.

кеңес

Кілттерді сервер жағында сақтаңыз. API кілтін браузерге, мобильді қолданбаға немесе соңғы пайдаланушы тексере алатын кез келген клиентке ешқашан енгізбеңіз. Егер кілт ағып кетсе, оны Integration → API Keys бөлімінде жойып, жаңасын шығарыңыз.

Келісімдер

Бірнеше ереже бүкіл API бойынша қолданылады. Оларды бір рет оқу сізге түзету уақытын үнемдейді:

Нұсқа префиксі — әрбір жол /v1 префиксінен басталады (мысалы, https://api.hanc.ai/v1/agent/list).
Идентификаторлар — Mongo ObjectId — кез келген :id (және :agentActionId, :agentToolId т.б.) 24 таңбалы он алтылық жол болуы керек. Қате пішімделген идентификаторлар 400 Bad Request қайтарады.
Белгісіз дене өрістері алынып тасталады — API сұраныс денелерін тексереді және танымайтын қасиеттерді үнсіз алып тастайды, сондықтан өріс атауындағы қате сақталудың орнына еленбейді.
Күндер — аналитика/экспорт соңғы нүктелері (endpoint) date_from / date_to мәндерін YYYY-MM-DD пішімінде қабылдайды. date_to сол күннің соңына дейін қоса есептеледі.
Массив сұрау параметрлері — сүзгі бірнеше мәнді қабылдайтын жерде (мысалы, agent_ids, direction), кілтті қайталауға (?direction=inbound&direction=outbound) немесе үтірмен бөлуге (?direction=inbound,outbound) болады.
Жауаптардағы уақыт белгілері ISO‑8601 жолы ретінде көрсетілмесе, эпохалық миллисекундтарда беріледі.

Соңғы нүктелер индексі

Қолжетімді барлық нәрсенің жылдам картасы. Әрқайсысы бойынша егжей-тегжейлі құжаттама төменде.

Қоңыраулар

Әрекет	Method	Endpoint
Қоңырауларды тізімдеу	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`

Агенттер

Әрекет	Method	Endpoint
Агенттерді тізімдеу	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/:agentActionId`
Әрекетті жою	DELETE	`/v1/agent/:id/actions/:agentActionId`
Құралдарды тізімдеу	GET	`/v1/agent/:id/tools`
Құрал қосу	POST	`/v1/agent/:id/tools`
Құралды жаңарту	PATCH	`/v1/agent/:id/tools/:agentToolId`
Құралды жою	DELETE	`/v1/agent/:id/tools/:agentToolId`

Білім базасы

Әрекет	Method	Endpoint
Білім базаларын тізімдеу	GET	`/v1/knowledge-base/list`
Жасау (алғашқы файлмен)	POST	`/v1/knowledge-base`
Бір файл қосу	POST	`/v1/knowledge-base/:id/file`
Бірнеше файл қосу	POST	`/v1/knowledge-base/:id/files`
Файл(дар)ды жою	DELETE	`/v1/knowledge-base/:id/file`
Агенттерді тағайындау	PUT	`/v1/knowledge-base/:id/agents`

Телефон нөмірлері

Әрекет	Method	Endpoint
Нөмірлерді тізімдеу	GET	`/v1/phone-number/list`
Қолжетімді нөмірлер (ел бойынша)	GET	`/v1/phone-number/available`
Нөмір сатып алу	POST	`/v1/phone-number/buy`
Twilio-дан импорттау	POST	`/v1/phone-number/import-twilio`
SIP-ке қосу	PATCH	`/v1/phone-number/connect-to-sip`

Дауыстар · Жазылым · Клиенттер · Жұмыс кеңістіктері

Әрекет	Method	Endpoint
Дауыстарды тізімдеу	GET	`/v1/voice/list`
Жазылым мәліметтері	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	`/v1/workspaces/list`
Жұмыс кеңістігін жасау	POST	`/v1/workspaces`
Жұмыс кеңістігінің мәліметтері	GET	`/v1/workspaces/:id`
Жұмыс кеңістігін жаңарту	PATCH	`/v1/workspaces/:id`
Жұмыс кеңістігін жою	DELETE	`/v1/workspaces/:id`
Мүшені шақыру	POST	`/v1/workspaces/:workspace_id/invite-member`
Мүшені жою	DELETE	`/v1/workspaces/:workspace_id/remove-member`

Қоңыраулар

Дауыстық қоңырауларды басқарыңыз және талдаңыз: қоңырауларды тізімдеу және тексеру (транскрипт, көңіл-күй, қорытынды), жиынтық көрсеткіштерді алу, CSV есептерін экспорттау және шығыс телефон мен веб-қоңырауларды жасау.

Қоңырауларды тізімдеу

GET /v1/call/list

Сүзу, сұрыптау және беттеу арқылы тіркелгіңіздің қоңырауларын тізімдеңіз.

Сұрау параметрлері

Name	Type	Required	Description
`agent_ids`	string[]	No	Бір немесе бірнеше агент идентификаторы бойынша сүзу (қайталаңыз немесе үтірмен бөліңіз).
`agent_id`	string	No	Жалғыз агент бойынша сүзу (ескі; `agent_ids` артық көріңіз).
`direction`	enum[]	No	`inbound` және/немесе `outbound`.
`call_status`	enum[]	No	`started`, `success`, `failed`, `pending`.
`call_type`	enum[]	No	`phone`, `web`.
`customer_id`	string	No	Клиент бойынша сүзу.
`workspace_id`	string	No	Жұмыс кеңістігі бойынша сүзу.
`date_from` / `date_to`	string	No	Ауқым сүзгісі (`YYYY-MM-DD`).
`sort_order`	enum	No	`asc` немесе `desc`.
`limit`	number	No	Қайтарылатын нәтижелердің ең көп саны.
`skip`	number	No	Өткізіп жіберілетін нәтижелер (беттеу ығысуы).

Мысал сұраныс

curl -G "https://api.hanc.ai/v1/call/list" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "agent_ids=507f1f77bcf86cd799439042" \
  --data-urlencode "direction=inbound" \
  --data-urlencode "sort_order=desc" \
  --data-urlencode "limit=10"

Мысал жауап — 200 OK

[
  {
    "_id": "507f1f77bcf86cd799439011",
    "call_type": "phone",
    "agent_id": "507f1f77bcf86cd799439042",
    "agent_name": "Customer Support Agent",
    "call_status": "success",
    "call_from": "+12345678900",
    "call_to": "+12345678911",
    "direction": "inbound",
    "start_timestamp": 1703302407333,
    "end_timestamp": 1703302428855,
    "recording_url": "https://recordings.example.com/12345",
    "disconnection_reason": "user_hangup",
    "sentiment": { "sentiment": "positive", "explanation": "Friendly, helpful tone." },
    "call_summary": "Customer issue resolved.",
    "task_achieved": true
  }
]

Қоңырау мәліметтерін алу

GET /v1/call/:id

Бір қоңыраудың толық мәліметтерін алыңыз — транскрипт, көңіл-күй, қорытынды, несиелер және өнімділік көрсеткіштері.

Жол параметрлері

Name	Type	Required	Description
`id`	string	Yes	Қоңыраудың идентификаторы.

Мысал сұраныс

curl "https://api.hanc.ai/v1/call/507f1f77bcf86cd799439011" \
  -H "x-api-key: YOUR_API_KEY"

Мысал жауап — 200 OK

{
  "_id": "507f1f77bcf86cd799439011",
  "call_type": "phone",
  "agent_id": "507f1f77bcf86cd799439042",
  "agent_name": "Customer Support Agent",
  "call_status": "success",
  "call_from": "+12345678900",
  "call_to": "+12345678911",
  "direction": "inbound",
  "start_timestamp": 1703302407333,
  "end_timestamp": 1703302428855,
  "recording_url": "https://recordings.example.com/12345",
  "transcription": [
    { "speaker": "agent", "content": "Hello, how can I help?", "timestamp": 1703302407333 },
    { "speaker": "user", "content": "I need help with my order.", "timestamp": 1703302410000 }
  ],
  "sentiment": { "sentiment": "positive", "explanation": "Friendly, helpful tone." },
  "call_summary": "Customer issue resolved.",
  "task_achieved": true,
  "call_credits_details": {
    "phone_call_credits": 1,
    "web_call_credits": 0,
    "text_message_credits": 0,
    "call_forwarding_credits": 0
  }
}

Егер қоңырау жоқ болса немесе сіздің тіркелгіңізге тиесілі болмаса, 404 қайтарады.

Жалпы көрсеткіштер

GET /v1/call/general-metrics

Күндер ауқымы бойынша жиынтық сомалар (қоңырау саны, жалпы және орташа ұзақтық).

Сұрау параметрлері

Name	Type	Required	Description
`date_from`	string	Yes	Бастау күні (`YYYY-MM-DD`).
`date_to`	string	Yes	Аяқтау күні (`YYYY-MM-DD`, қоса алғанда).
`agent_id` / `agent_ids`	string(s)	No	Бір немесе бірнеше агентпен шектеу.
`customer_id`	string	No	Клиент бойынша сүзу.
`workspace_id`	string	No	Жұмыс кеңістігі бойынша сүзу.
`direction` / `call_status` / `call_type`	enum[]	No	Қоңырауларды тізімдеу бөліміндегі сол сүзгілер.

date_from немесе date_to көрсетілмесе, 400 Bad Request қайтарады.

Мысал сұраныс

curl -G "https://api.hanc.ai/v1/call/general-metrics" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "date_from=2026-05-01" \
  --data-urlencode "date_to=2026-05-31"

Мысал жауап — 200 OK

{ "total_calls": 128, "total_duration": 45230, "average_duration": 353 }

Күнделікті көрсеткіштер

GET /v1/call/daily-metrics

Күндер ауқымы бойынша күніне шаққандағы жалпы қоңырау ұзақтығы — трендтерді диаграммалау үшін тамаша.

Сұрау параметрлері — Жалпы көрсеткіштер бөліміндегідей (date_from/date_to міндетті, оған қоса қосымша агент/клиент/жұмыс кеңістігі/бағыт/күй/түр сүзгілері).

Мысал сұраныс

curl -G "https://api.hanc.ai/v1/call/daily-metrics" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "date_from=2026-05-01" \
  --data-urlencode "date_to=2026-05-07"

Мысал жауап — 200 OK

[
  { "date": "2026-05-01", "total_duration": 5400 },
  { "date": "2026-05-02", "total_duration": 7320 },
  { "date": "2026-05-03", "total_duration": 0 }
]

Көңіл-күй статистикасы

GET /v1/call/sentiment-stats

Бір агент үшін күндер ауқымы бойынша көңіл-күй бойынша қоңыраулар саны.

Сұрау параметрлері

Name	Type	Required	Description
`agent_id`	string	Yes	Есеп берілетін агент.
`date_from`	string	Yes	Бастау күні.
`date_to`	string	Yes	Аяқтау күні (қоса алғанда).

Мысал сұраныс

curl -G "https://api.hanc.ai/v1/call/sentiment-stats" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "agent_id=507f1f77bcf86cd799439042" \
  --data-urlencode "date_from=2026-05-01" \
  --data-urlencode "date_to=2026-05-31"

Мысал жауап — 200 OK

{ "positive": 84, "negative": 12, "neutral": 32 }

Шығындарды бөлу

GET /v1/call/costs-breakdown

Пайдаланушы, агент немесе жұмыс кеңістігі бойынша топтастырылған шығын/пайдалану бөлінісі (қоңыраулар, минуттар, несиелер, токендер, әр модель бойынша егжей-тегжей).

Сұрау параметрлері

Name	Type	Required	Description
`date_from`	string	Yes	Бастау күні.
`date_to`	string	Yes	Аяқтау күні (қоса алғанда).
`group_by`	enum	No	`user` (әдепкі), `agent` немесе `workspace`.
`customer_id`	string	No	Клиент бойынша сүзу (агенттік қатынасы).
`workspace_id`	string	No	Жұмыс кеңістігі бойынша сүзу.

Мысал сұраныс

curl -G "https://api.hanc.ai/v1/call/costs-breakdown" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "date_from=2026-05-01" \
  --data-urlencode "date_to=2026-05-31" \
  --data-urlencode "group_by=agent"

Мысал жауап — 200 OK

{
  "breakdown": [
    {
      "agent_id": "507f1f77bcf86cd799439042",
      "agent_name": "Customer Support Agent",
      "total_calls": 64,
      "total_duration_minutes": 380,
      "credits": { "phone_call": 60, "web_call": 4, "text_message": 0, "call_forwarding": 1, "total": 65 },
      "tokens": { "input": 920000, "output": 120000, "total": 1040000 }
    }
  ],
  "totals": { "total_calls": 64, "total_duration_minutes": 380, "total_credits": 65, "total_tokens": 1040000 },
  "period": { "from": 1746057600000, "to": 1748735999999 }
}

Қоңырауларды экспорттау (CSV)

GET /v1/call/list/export

Күндер ауқымындағы әрбір қоңырауды CSV файлы ретінде жүктеп алыңыз (әр қоңырау, әр модель бойынша токен егжей-тегжейімен).

Сұрау параметрлері

Name	Type	Required	Description
`date_from`	string	Yes	Бастау күні.
`date_to`	string	Yes	Аяқтау күні (қоса алғанда).

Жауап — CSV файлы (Content-Type: text/csv), call-details_<date_from>_<date_to>.csv деп аталған тіркеме ретінде беріледі.

Мысал сұраныс

curl -G "https://api.hanc.ai/v1/call/list/export" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "date_from=2026-05-01" \
  --data-urlencode "date_to=2026-05-31" \
  -o call-details.csv

Шығындарды экспорттау (CSV)

GET /v1/call/costs-breakdown/export

Шығындарды бөлуді CSV файлы ретінде жүктеп алыңыз.

Сұрау параметрлері — Шығындарды бөлу бөліміндегідей (date_from/date_to міндетті; қосымша group_by, customer_id, workspace_id).

Жауап — costs-breakdown_<date_from>_<date_to>.csv деп берілетін CSV файлы.

Мысал сұраныс

curl -G "https://api.hanc.ai/v1/call/costs-breakdown/export" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "date_from=2026-05-01" \
  --data-urlencode "date_to=2026-05-31" \
  --data-urlencode "group_by=agent" \
  -o costs-breakdown.csv

Телефон қоңырауын жасау

POST /v1/call/make-phone-call

Агенттеріңіздің бірінен шығыс телефон қоңырауын жасаңыз.

Сұраныс денесі

Field	Type	Required	Description
`agent_id`	string	Yes	Қоңырауды жасайтын агент.
`from_number`	string	Yes	E.164 пішіміндегі қоңырау шалушының идентификаторы (мысалы, `+1234567890`).
`to_number`	string	Yes	Алушының телефон нөмірі.
`custom_data`	object	No	Қоңырауға тіркелген еркін деректер.
`dynamic_context`	object	No	Әңгімеге берілетін контекст (мысалы, клиенттің аты).

Мысал сұраныс

curl -X POST "https://api.hanc.ai/v1/call/make-phone-call" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "507f1f77bcf86cd799439042",
    "from_number": "+1234567890",
    "to_number": "+19876543210",
    "dynamic_context": { "customer_name": "Jane", "order_id": "12345" }
  }'

Мысал жауап — 201 Created

{
  "_id": "507f1f77bcf86cd799439011",
  "call_type": "phone",
  "agent_id": "507f1f77bcf86cd799439042",
  "call_status": "started",
  "call_from": "+1234567890",
  "call_to": "+19876543210",
  "direction": "outbound",
  "start_timestamp": 1703302407333
}

Веб-қоңырау жасау

POST /v1/call/make-web-call

Агенттеріңіздің бірі үшін браузер/WebRTC қоңырау сеансын жасаңыз.

Сұраныс денесі

Field	Type	Required	Description
`agent_id`	string	Yes	Веб-қоңырауды өңдейтін агент.
`custom_data`	object	No	Қоңырауға тіркелген еркін деректер.
`dynamic_context`	object	No	Әңгімеге берілетін контекст.

Мысал сұраныс

curl -X POST "https://api.hanc.ai/v1/call/make-web-call" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "agent_id": "507f1f77bcf86cd799439042", "dynamic_context": { "topic": "billing" } }'

Мысал жауап — 201 Created

{
  "_id": "507f1f77bcf86cd799439077",
  "call_type": "web",
  "agent_id": "507f1f77bcf86cd799439042",
  "call_status": "started",
  "start_timestamp": 1703302407333
}

Агенттер

Дауыстық агенттерді, олардың әрекеттерін (қоңырау кезінде не істейтіні — электрондық пошта/SMS/WhatsApp жіберу, API-ге қоңырау шалу) және олардың құралдарын (RAG іздеу, кездесуге жазылу, қоңырауды қайта бағыттау, күнтізбе/CRM интеграциялары сияқты мүмкіндіктер) жасаңыз және басқарыңыз.

Агенттерді тізімдеу

GET /v1/agent/list

Тіркелгіңізге тиесілі барлық агенттерді қайтарады.

Сұрау параметрлері

Name	Type	Required	Description
`customer_id`	string	No	Клиентпен шектеу.
`workspace_id`	string	No	Жұмыс кеңістігімен шектеу.

Мысал сұраныс

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

Мысал жауап — 200 OK

[
  {
    "_id": "60d21b4667d0d8992e610c85",
    "agent_name": "Customer Support Agent",
    "llm_id": "60d21b4667d0d8992e610c86",
    "voice": { "voice_id": "60d21b4667d0d8992e610c87" },
    "interruption_sensitivity": 1.0,
    "call_settings": { "language": "en-US", "sentiment_analysis": false, "call_summary": false },
    "status": "active",
    "workspace_id": "60d21b4667d0d8992e610c87",
    "knowledge_base": ["60d21b4667d0d8992e610c89"]
  }
]

Агентті алу

GET /v1/agent/:id

Жалғыз агентті қайтарады.

Жол параметрлері

Name	Type	Required	Description
`id`	string	Yes	Агент идентификаторы.

Мысал сұраныс

curl "https://api.hanc.ai/v1/agent/60d21b4667d0d8992e610c85" \
  -H "x-api-key: YOUR_API_KEY"

Агент нысанын қайтарады (Агенттерді тізімдеу бөлімінің бір элементімен бірдей пішінде) немесе табылмаса 404.

Агент жасау

POST /v1/agent

Жаңа агент жасаңыз. Тек agent_name мен llm_id міндетті — қалғанының бәрі қосымша және орынды әдепкі мәндерге қайтады.

Сұрау параметрлері — жаңа агентті байланыстыру үшін қосымша customer_id, workspace_id.

Сұраныс денесі

Field	Type	Required	Description
`agent_name`	string	Yes	Көрсету аты.
`llm_id`	string	Yes	Агентті қамтамасыз ететін LLM идентификаторы.
`voice`	object	No	`{ "voice_id": "<id>" }`.
`interruption_sensitivity`	number	No	Үзілгенде агенттің қаншалықты оңай тоқтайтыны (мысалы, `0.5`).
`call_settings`	object	No	Тіл, еске салғыштар, үнсіздік уақыты, көңіл-күй талдауы, қоңырау қорытындысы, `max_call_duration_minutes` (1–15).
`data_retrieval`	object[]	No	Агент қоңырау кезінде жинайтын өрістер.
`webhook_url`	string	No	Агент оқиғалары туралы хабарланатын URL.
`is_data_collection_active`	boolean	No	Деректерді жинау формасын қосу.

Мысал сұраныс

curl -X POST "https://api.hanc.ai/v1/agent" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_name": "Customer Support Agent",
    "llm_id": "507f1f77bcf86cd799439033",
    "voice": { "voice_id": "507f1f77bcf86cd799439035" },
    "interruption_sensitivity": 0.5,
    "call_settings": { "language": "en-US", "max_call_duration_minutes": 10 }
  }'

Мысал жауап — 201 Created (жасалған агент нысаны).

Агентті жаңарту

PATCH /v1/agent/:id

Агентті ішінара жаңартыңыз. Барлық дене өрістері қосымша — тек өзгерткіңіз келетінін жіберіңіз.

Жол параметрлері — id (агент идентификаторы).

Сұраныс денесі — жасау өрістерінің кез келген жиынтығы, оған қоса folder, status (мысалы, active), is_customer_memory_active, widget_settings, callback_settings. call_settings ішінде recording_enabled, stt_languages (4-ке дейін BCP‑47 коды) және max_call_duration_minutes де орнатуға болады.

Мысал сұраныс

curl -X PATCH "https://api.hanc.ai/v1/agent/60d21b4667d0d8992e610c85" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "agent_name": "Support Agent v2", "call_settings": { "language": "en-GB", "recording_enabled": false } }'

Мысал жауап — 200 OK (жаңартылған агент нысаны).

Агентті жою

DELETE /v1/agent/:id

Агентті жойыңыз.

Мысал сұраныс

curl -X DELETE "https://api.hanc.ai/v1/agent/60d21b4667d0d8992e610c85" \
  -H "x-api-key: YOUR_API_KEY"

Мысал жауап — 204 No Content (бос дене).

Агент қоңырау статистикасы

GET /v1/agent/:id/call-stats

Бір агент үшін күндер ауқымы бойынша күніне шаққандағы қоңыраулар саны.

Жол параметрлері — id (агент идентификаторы).

Сұрау параметрлері

Name	Type	Required	Description
`date_from`	string	Yes	Бастау күні (`YYYY-MM-DD`).
`date_to`	string	Yes	Аяқтау күні (`YYYY-MM-DD`).

Мысал сұраныс

curl -G "https://api.hanc.ai/v1/agent/60d21b4667d0d8992e610c85/call-stats" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "date_from=2026-05-01" \
  --data-urlencode "date_to=2026-05-31"

Мысал жауап — 200 OK

[
  { "date": "2026-05-28", "total_calls": 10 },
  { "date": "2026-05-29", "total_calls": 4 }
]

Агент үлгілерін тізімдеу

GET /v1/agent/agent_template/list

Клондай алатын алдын ала жасалған агент үлгілерінің каталогын қайтарады. Параметрлері жоқ.

Мысал сұраныс

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

Мысал жауап — 200 OK

[
  {
    "_id": "60d21b4667d0d8992e610c85",
    "icon_url": "https://example.com/icon.png",
    "description": "A ready-made receptionist agent.",
    "agent": { "agent_name": "Receptionist", "call_settings": { "language": "en-US" } },
    "llm": { "model": "gpt-4o-mini", "begin_message": "Hello, how can I assist you today?" }
  }
]

Агент әрекеттері

Әрекеттер — агенттің қоңырау кезінде орындайтын нәрселері. Қолдау көрсетілетін action_type мәндері: send_email, send_sms, send_whatsapp, api_call. settings нысанының пішіні түрге байланысты.

Әрекеттерді тізімдеу

GET /v1/agent/:id/actions

curl "https://api.hanc.ai/v1/agent/60d21b4667d0d8992e610c85/actions" \
  -H "x-api-key: YOUR_API_KEY"

Әрекет нысандарының массивін қайтарады.

Әрекет қосу

POST /v1/agent/:id/actions

Сұраныс денесі

Field	Type	Required	Description
`action_type`	enum	Yes	`send_email`, `send_sms`, `send_whatsapp` немесе `api_call`.
`settings`	object	Yes	Түрге тән конфигурация.
`is_active`	boolean	No	Әдепкі мәні `true`.

Мысал сұраныс

curl -X POST "https://api.hanc.ai/v1/agent/60d21b4667d0d8992e610c85/actions" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action_type": "send_email",
    "settings": {
      "name": "Welcome Email",
      "subject": "Welcome!",
      "message": "Thank you for joining us.",
      "direct_recipients": ["user@example.com"]
    }
  }'

Мысал жауап — 201 Created

{
  "_id": "60f5b1a8d1b9f7c1d0c0a6c6",
  "agent_id": "60d21b4667d0d8992e610c85",
  "action_type": "send_email",
  "settings": { "name": "Welcome Email", "subject": "Welcome!", "message": "Thank you for joining us.", "direct_recipients": ["user@example.com"] },
  "is_active": true
}

Әрекетті жаңарту

PATCH /v1/agent/:id/actions/:agentActionId

Тіркелген әрекеттің settings және/немесе is_active мәнін жаңартыңыз. Екі дене өрісі де қосымша.

curl -X PATCH "https://api.hanc.ai/v1/agent/60d21b4667d0d8992e610c85/actions/60f5b1a8d1b9f7c1d0c0a6c6" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "is_active": false }'

Жаңартылған әрекет нысанымен 200 OK қайтарады.

Әрекетті жою

DELETE /v1/agent/:id/actions/:agentActionId

curl -X DELETE "https://api.hanc.ai/v1/agent/60d21b4667d0d8992e610c85/actions/60f5b1a8d1b9f7c1d0c0a6c6" \
  -H "x-api-key: YOUR_API_KEY"

204 No Content қайтарады.

Агент құралдары

Құралдар агентке қосымша мүмкіндіктер береді. Қолдау көрсетілетін tool_type мәндері: api_rag, appointment_booking, call_forwarding, end_call, google_calendar, outlook_calendar, etermin, resmio, hubspot_crm, agent_transfer, mcp. settings нысанының пішіні түрге байланысты.

etermin мен resmio — тікелей кездесу/брондау құралдары: агент қолжетімділікті тексереді және қосылған eTermin немесе resmio тіркелгісінде тікелей брондайды, қайта жоспарлайды немесе бас тартады. Екеуі де алдымен сәйкес интеграцияның тіркелгіде қосылуын талап етеді.

Құралдарды тізімдеу

GET /v1/agent/:id/tools

curl "https://api.hanc.ai/v1/agent/60d21b4667d0d8992e610c85/tools" \
  -H "x-api-key: YOUR_API_KEY"

Құрал нысандарының массивін қайтарады.

Құрал қосу

POST /v1/agent/:id/tools

Сұраныс денесі

Field	Type	Required	Description
`tool_type`	enum	Yes	Жоғарыдағы қолдау көрсетілетін құрал түрлерінің бірі.
`settings`	object	Yes	Түрге тән конфигурация.
`is_active`	boolean	No	Әдепкі мәні `true`.

Мысал сұраныс

curl -X POST "https://api.hanc.ai/v1/agent/60d21b4667d0d8992e610c85/tools" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool_type": "call_forwarding",
    "settings": { "name": "Transfer to human", "phone_number": "+1234567890" }
  }'

Мысал жауап — 201 Created

{
  "_id": "60f5b1a8d1b9f7c1d0c0a6c6",
  "agent_id": "60d21b4667d0d8992e610c85",
  "tool_type": "call_forwarding",
  "settings": { "name": "Transfer to human", "phone_number": "+1234567890" },
  "is_active": true
}

Құралды жаңарту

PATCH /v1/agent/:id/tools/:agentToolId

Тіркелген құралдың settings және/немесе is_active мәнін жаңартыңыз (екеуі де қосымша).

curl -X PATCH "https://api.hanc.ai/v1/agent/60d21b4667d0d8992e610c85/tools/60f5b1a8d1b9f7c1d0c0a6c6" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "is_active": false }'

Жаңартылған құрал нысанымен 200 OK қайтарады.

Құралды жою

DELETE /v1/agent/:id/tools/:agentToolId

curl -X DELETE "https://api.hanc.ai/v1/agent/60d21b4667d0d8992e610c85/tools/60f5b1a8d1b9f7c1d0c0a6c6" \
  -H "x-api-key: YOUR_API_KEY"

204 No Content қайтарады.

Білім базасы

Агенттеріңіз қоңырау кезінде іздей алатын құжаттарды жүктеңіз және әрбір білім базасын қай агенттердің пайдаланатынын басқарыңыз. Файл жүктеулері multipart/form-data пайдаланады.

Білім базаларын тізімдеу

GET /v1/knowledge-base/list

Сұрау параметрлері — қосымша customer_id, workspace_id.

curl "https://api.hanc.ai/v1/knowledge-base/list" \
  -H "x-api-key: YOUR_API_KEY"

Мысал жауап — 200 OK

[
  {
    "_id": "60d21b4667d0d8992e610c85",
    "knowledge_base_name": "Company Policies",
    "knowledge_base_description": "Refund, shipping and warranty policies.",
    "files": [
      { "_id": "60d21b4667d0d8992e610c90", "file_name": "policies.pdf", "file_size": 2048000, "uploaded_at": "2026-05-24T07:34:23.980Z" }
    ],
    "agent_names": ["Sales Agent", "Support Bot"]
  }
]

Білім базасын жасау

POST /v1/knowledge-base

Білім базасын оның алғашқы файлымен бірге жасаңыз. Бұл multipart/form-data сұранысы — тек денелі "жасау" жоқ.

Сұрау параметрлері — қосымша customer_id, workspace_id.

Форма өрістері

Field	Type	Required	Description
`file`	file	Yes	Алғашқы құжат (мысалы, PDF).
`name`	string	Yes	Білім базасының аты (1–100 таңба).
`description`	string	Yes	Сипаттама (1–300 таңба).
`folder`	string	No	Қалта/санат белгісі (0–50 таңба).

Мысал сұраныс

curl -X POST "https://api.hanc.ai/v1/knowledge-base" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@./policies.pdf" \
  -F "name=Company Policies" \
  -F "description=Refund, shipping and warranty policies." \
  -F "folder=Sales"

Мысал жауап — 200 OK (жасалған білім базасы, тізім элементімен бірдей пішінде).

Бір файл қосу

POST /v1/knowledge-base/:id/file

Бар білім базасына бір файл қосыңыз. Multipart өріс атауы: file.

curl -X POST "https://api.hanc.ai/v1/knowledge-base/60d21b4667d0d8992e610c85/file" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@./addendum.pdf"

Жаңартылған білім базасымен 200 OK қайтарады.

Бірнеше файл қосу

POST /v1/knowledge-base/:id/files

Бірнеше файлды бірден қосыңыз. Multipart өріс атауы: files (әр файл үшін қайталаңыз). Қосымша customer_id, workspace_id сұрау параметрлері.

curl -X POST "https://api.hanc.ai/v1/knowledge-base/60d21b4667d0d8992e610c85/files" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "files=@./doc1.pdf" \
  -F "files=@./doc2.pdf"

Жаңартылған білім базасымен 200 OK қайтарады.

Файл(дар)ды жою

DELETE /v1/knowledge-base/:id/file

Идентификатор бойынша бір немесе бірнеше файлды жойыңыз. Жолы жекеше болса да, дене массив қабылдайды.

Сұраныс денесі

Field	Type	Required	Description
`file_ids`	string[]	Yes	Жойылатын файл идентификаторларының бос емес массиві.

curl -X DELETE "https://api.hanc.ai/v1/knowledge-base/60d21b4667d0d8992e610c85/file" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "file_ids": ["60c72b2f9b1e8b001c8e4d3a", "60c72b2f9b1e8b001c8e4d3b"] }'

200 OK қайтарады.

Агенттерді тағайындау

PUT /v1/knowledge-base/:id/agents

Осы білім базасын пайдаланатын агенттердің толық тізімін орнатыңыз (алмастырыңыз).

Сұраныс денесі

Field	Type	Required	Description
`agent_ids`	string[]	Yes	Осы білім базасын пайдалануы тиіс агент идентификаторлары.

curl -X PUT "https://api.hanc.ai/v1/knowledge-base/60d21b4667d0d8992e610c85/agents" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "agent_ids": ["60d21b4667d0d8992e610c85"] }'

200 OK қайтарады.

Телефон нөмірлері

Нөмірлеріңізді тізімдеңіз, сатып алуға болатын нөмірлерді табыңыз, біреуін сатып алыңыз, қосылған Twilio тіркелгісінен нөмірлерді импорттаңыз немесе нөмірді SIP транкіне қосыңыз.

Басқару тақтасында нөмірлерді сатып алу

Басқару тақтасында нөмір сатып алу осы соңғы нүктелер (endpoint) ұсынатыннан асып түседі. Дереу, қағазсыз нөмірлер Австрия, Германия, Швейцария, АҚШ және Канадада қолжетімді; басқа әрбір ел өзіңіздің реттеуші құжаттарыңызды жіберетін (және оларды кейінірек жалғастыру үшін жоба ретінде сақтауға болатын) бағыттаушы өзіндік қызмет ету ағынын пайдаланады. Сатып алу экраны жергілікті, мобильді, ұлттық және тегін түрлерін — оған қоса кеңейтілген нөмірлер (+€2/ай) мен WhatsApp қоңырау нөмірлерін ұсынады. BYO SIP — өндірушіден тәуелсіз (sipgate, Placetel, TENIOS, easybell, Zadarma, Telnyx, теңшелетін транктар — тек Twilio импортымен шектелмейді). Толық ағын үшін Телефон нөмірлері бөлімін қараңыз.

Телефон нөмірлерін тізімдеу

GET /v1/phone-number/list

Сұрау параметрлері — барлығы қосымша: inbound_agent_id, outbound_agent_id, customer_id, workspace_id (және user_id, әдепкі бойынша сіз).

curl "https://api.hanc.ai/v1/phone-number/list" \
  -H "x-api-key: YOUR_API_KEY"

Мысал жауап — 200 OK

[
  {
    "_id": "60d21b4667d0d8992e610c85",
    "phone_number": "+1234567890",
    "formatted_number": "+1 (234) 567-8900",
    "country": "US",
    "provider": "twilio",
    "status": "active",
    "inbound_agent_id": "64bfb7b3f3d9ab3f1e2c109c",
    "inbound_agent_name": "Receptionist"
  }
]

Қолжетімді нөмірлер

GET /v1/phone-number/available

Ел үшін сатып алуға болатын нөмірлерді тізімдеңіз.

Сұрау параметрлері

Name	Type	Required	Description
`country_code`	string	No	ISO ел коды (әдепкі `US`), мысалы, `DE`, `AT`, `CH`.
`area_code`	string	No	Сандық аймақ коды сүзгісі.

curl -G "https://api.hanc.ai/v1/phone-number/available" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "country_code=US" \
  --data-urlencode "area_code=415"

Мысал жауап — 200 OK

[
  { "phone_number": "+14155550100", "formatted_number": "+1 (415) 555-0100", "country": "US", "area_code": "415", "setup_fee": 2, "subscription": 2, "currency": "EUR" }
]

Нөмір сатып алу

POST /v1/phone-number/buy

Нақты нөмірді сатып алыңыз. Қосымша customer_id, workspace_id сұрау параметрлері.

Сұраныс денесі

Field	Type	Required	Description
`phone_number`	string	Yes	Сатып алынатын нөмір (E.164).
`country_code`	string	Yes	Нөмірдің елі (мысалы, `US`).

curl -X POST "https://api.hanc.ai/v1/phone-number/buy" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "phone_number": "+14155550100", "country_code": "US" }'

Мысал жауап — 200 OK

{
  "message": "Phone number purchased successfully!",
  "phone_number": { "_id": "507f1f77bcf86cd799439011", "phone_number": "+14155550100", "country": "US", "provider": "twilio", "status": "active" }
}

Twilio-дан импорттау

POST /v1/phone-number/import-twilio

Қосылған Twilio тіркелгісінен нөмірлерді импорттаңыз. Қосымша customer_id, workspace_id сұрау параметрлері.

Сұраныс денесі

Field	Type	Required	Description
`sid`	string	Yes	Twilio Account SID (`AC…`).

curl -X POST "https://api.hanc.ai/v1/phone-number/import-twilio" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" }'

Мысал жауап — 200 OK (импортталған телефон нөмірінің жазбасы).

SIP-ке қосу

PATCH /v1/phone-number/connect-to-sip

Бар нөмірді SIP транкіне қосыңыз.

Сұраныс денесі

Field	Type	Required	Description
`phone_number`	string	Yes	Қосылатын нөмір (E.164).

curl -X PATCH "https://api.hanc.ai/v1/phone-number/connect-to-sip" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "phone_number": "+1234567890" }'

200 OK (бос дене) қайтарады.

Дауыстар

Дауыстарды тізімдеу

GET /v1/voice/list

Қолжетімді дауыстарды тізімдеңіз. Тіл немесе провайдер бойынша сүзіңіз және клиенттің жеке клондарын қосыңыз.

Сұрау параметрлері

Name	Type	Required	Description
`language`	string	No	Тіл бойынша сүзу, мысалы, `?language=de`.
`provider`	string	No	`11-Labs`, `openai`, `qwen` немесе `azure`.
`customer_id`	string	No	Осы клиенттің жеке дауыс клондарын да қосу.

curl -G "https://api.hanc.ai/v1/voice/list" \
  -H "x-api-key: YOUR_API_KEY" \
  --data-urlencode "language=de"

Мысал жауап — 200 OK

[
  {
    "_id": "60d21b4667d0d8992e610c85",
    "voice_id": "voice_12345",
    "name": "Emma",
    "gender": "female",
    "accent": "British",
    "languages": ["english", "spanish"],
    "provider": "11-Labs",
    "sample_url": "https://example.com/sample.mp3"
  }
]

Жазылым

Жазылым мәліметтері

GET /v1/subscription

Ағымдағы жазылымыңызды қайтарады, оның ішінде несие балансы мен толтыру баптаулары.

curl "https://api.hanc.ai/v1/subscription" \
  -H "x-api-key: YOUR_API_KEY"

Мысал жауап — 200 OK

{
  "_id": "507f191e810c19729de860ea",
  "payment_plan_id": "507f191e810c19729de860ec",
  "currency": "EUR",
  "package_credits": 1000,
  "package_credits_used": 100,
  "auto_top_up_enabled": false,
  "top_up_amount": 50,
  "extra_credits_payed": 1000,
  "extra_credits_used": 100,
  "billing_cycle": "monthly",
  "next_credit_reset": "2026-06-15T03:00:00.000Z",
  "is_cancelled": false
}

Жазылым жазбасы жоқ болса, 404 қайтарады.

Автоматты толтыруды теңшеу

PATCH /v1/subscription/auto-top-up

Автоматты несие толтыруды қосыңыз немесе өшіріңіз.

Сұраныс денесі

Field	Type	Required	Description
`enabled`	boolean	Yes	Автоматты толтыруды қосу немесе өшіру.
`amount`	number	No	Толтыру сомасы (20–1000). Қосу кезінде орнатыңыз.

curl -X PATCH "https://api.hanc.ai/v1/subscription/auto-top-up" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "enabled": true, "amount": 50 }'

Жаңартылған жазылыммен 200 OK қайтарады.

Толтыру сомасын орнату

PATCH /v1/subscription/top-up-amount

Теңшелген толтыру сомасын жаңартыңыз.

Сұраныс денесі

Field	Type	Required	Description
`top_up_amount`	number	Yes	Жаңа сома (1–100).

curl -X PATCH "https://api.hanc.ai/v1/subscription/top-up-amount" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "top_up_amount": 10 }'

Жаңартылған жазылыммен 200 OK қайтарады.

Клиенттер

Агенттігіңіздің астындағы клиенттерді басқарыңыз. Бұл соңғы нүктелер (endpoint) тіркелгіңіздің агенттікке тиесілі болуын талап етеді.

Клиенттерді тізімдеу

GET /v1/customer/list

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

Мысал жауап — 200 OK

[
  {
    "_id": "60d21b4667d0d8992e610c85",
    "email": "customer@example.com",
    "name": "John Doe",
    "account_status": "active",
    "agents_count": 3
  }
]

Клиент мәліметтері

GET /v1/customer/:id

curl "https://api.hanc.ai/v1/customer/60d21b4667d0d8992e610c85" \
  -H "x-api-key: YOUR_API_KEY"

Клиент нысанын, немесе табылмаса 404 қайтарады.

Клиент жасау

POST /v1/customer

Сұраныс денесі

Field	Type	Required	Description
`email`	string	Yes	Клиенттің кіру электрондық поштасы.
`initial_password`	string	Yes	Бастапқы құпия сөз (8–128 таңба).
`name`	string	Yes	Тіркелгі/компания аты.
`user_full_name`	string	Yes	Клиент пайдаланушысының толық аты.
`visibility`	object	No	Әр бөлім бойынша көріну жалаушалары.
`opt_out_promotions`	boolean	No	Клиентті жарнамалық хабарламалардан бас тарту.

curl -X POST "https://api.hanc.ai/v1/customer" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "customer@example.com",
    "initial_password": "Password123!",
    "name": "Acme Co.",
    "user_full_name": "John Doe"
  }'

Жаңа клиентпен 201 Created қайтарады. Электрондық пошта бұрыннан бар болса немесе тіркелгіңіз агенттіктің бөлігі болмаса, 400 қайтарады.

Клиентті жаңарту

PATCH /v1/customer/:id

Сұраныс денесі — барлығы қосымша: name, email, phone, address.

curl -X PATCH "https://api.hanc.ai/v1/customer/60d21b4667d0d8992e610c85" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Acme Corporation", "phone": "+1234567890" }'

Жаңартылған клиентпен 200 OK қайтарады.

Клиентті жою

DELETE /v1/customer/:id

curl -X DELETE "https://api.hanc.ai/v1/customer/60d21b4667d0d8992e610c85" \
  -H "x-api-key: YOUR_API_KEY"

Мысал жауап

{ "message": "Customer deleted successfully" }

Жұмыс кеңістіктері

Агенттерді, нөмірлерді және білім базаларын жұмыс кеңістіктеріне топтаңыз және олардың мүшелерін басқарыңыз.

Жұмыс кеңістіктерін тізімдеу

GET /v1/workspaces/list

Қосымша customer_id сұрау параметрі.

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

Мысал жауап — 200 OK

[
  {
    "_id": "64b1f2d2f3d92c5b8c5e1e22",
    "name": "Workspace A",
    "description": "For the A team.",
    "owner_user_id": "64b1f2d2f3d92c5b8c5e1e10",
    "members": [
      { "user_id": "64b1f2d2f3d92c5b8c5e1e11", "full_name": "John Doe", "email": "john.doe@example.com" }
    ]
  }
]

Жұмыс кеңістігін жасау

POST /v1/workspaces

Сұраныс денесі

Field	Type	Required	Description
`name`	string	Yes	Жұмыс кеңістігінің аты (2–100 таңба).
`description`	string	No	Сипаттама (0–500 таңба).

curl -X POST "https://api.hanc.ai/v1/workspaces" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Development Team", "description": "For the dev team." }'

Жұмыс кеңістігімен 201 Created қайтарады.

Жұмыс кеңістігінің мәліметтері

GET /v1/workspaces/:id

curl "https://api.hanc.ai/v1/workspaces/64b1f2d2f3d92c5b8c5e1e22" \
  -H "x-api-key: YOUR_API_KEY"

Жұмыс кеңістігі нысанын қайтарады.

Жұмыс кеңістігін жаңарту

PATCH /v1/workspaces/:id

Сұраныс денесі — name (2–100) және/немесе description (0–500).

curl -X PATCH "https://api.hanc.ai/v1/workspaces/64b1f2d2f3d92c5b8c5e1e22" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Renamed Workspace" }'

Жаңартылған жұмыс кеңістігімен 200 OK қайтарады.

Жұмыс кеңістігін жою

DELETE /v1/workspaces/:id

curl -X DELETE "https://api.hanc.ai/v1/workspaces/64b1f2d2f3d92c5b8c5e1e22" \
  -H "x-api-key: YOUR_API_KEY"

Мысал жауап

{ "message": "Workspace deleted successfully" }

Мүшені шақыру

POST /v1/workspaces/:workspace_id/invite-member

Сұраныс денесі

Field	Type	Required	Description
`email`	string	Yes	Шақырылатын пайдаланушының электрондық поштасы.

curl -X POST "https://api.hanc.ai/v1/workspaces/64b1f2d2f3d92c5b8c5e1e22/invite-member" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "email": "teammate@example.com" }'

Жұмыс кеңістігімен 201 Created қайтарады (жаңа мүше members ішінде пайда болады).

Мүшені жою

DELETE /v1/workspaces/:workspace_id/remove-member

Сұраныс денесі

Field	Type	Required	Description
`email`	string	Yes	Жойылатын мүшенің электрондық поштасы.

curl -X DELETE "https://api.hanc.ai/v1/workspaces/64b1f2d2f3d92c5b8c5e1e22/remove-member" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "email": "teammate@example.com" }'

Жаңартылған жұмыс кеңістігімен 200 OK қайтарады.

API арқылы қолжетімді емес нәрсе

Кейбір операциялар тек басқару тақтасы арқылы қолжетімді:

Мүмкіндік	Себебі
API кілттерін басқару	Қауіпсіздік — кілттер басқа кілттерді жасай алмайды
Телефон нөмірін баптау	Интерактивті баптауды талап етеді
Google Calendar интеграциясы	Интерактивті авторизацияны талап етеді
Төлемдер мен есеп айырысу	Басқару тақтасы арқылы басқарылады

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

API-ге қатысты сұрақтар бойынша қолдау көрсету тобымызбен support@hanc.ai арқылы байланысыңыз.

Жылдам шолу​

Аутентификация​

Келісімдер​

Соңғы нүктелер индексі​

Қоңыраулар​

Агенттер​

Білім базасы​

Телефон нөмірлері​

Дауыстар · Жазылым · Клиенттер · Жұмыс кеңістіктері​

Қоңыраулар

Қоңырауларды тізімдеу​

Қоңырау мәліметтерін алу​

Жалпы көрсеткіштер​

Күнделікті көрсеткіштер​

Көңіл-күй статистикасы​

Шығындарды бөлу​

Қоңырауларды экспорттау (CSV)​

Шығындарды экспорттау (CSV)​

Телефон қоңырауын жасау​

Веб-қоңырау жасау​

Агенттер

Агенттерді тізімдеу​

Агентті алу​

Агент жасау​

Агентті жаңарту​

Агентті жою​

Агент қоңырау статистикасы​

Агент үлгілерін тізімдеу​

Агент әрекеттері​

Әрекеттерді тізімдеу​

Әрекет қосу​

Әрекетті жаңарту​

Әрекетті жою​

Агент құралдары​

Құралдарды тізімдеу​

Құрал қосу​

Құралды жаңарту​

Құралды жою​

Білім базасы

Білім базаларын тізімдеу​

Білім базасын жасау​

Бір файл қосу​

Бірнеше файл қосу​

Файл(дар)ды жою​

Агенттерді тағайындау​

Телефон нөмірлері

Телефон нөмірлерін тізімдеу​

Қолжетімді нөмірлер​

Нөмір сатып алу​

Twilio-дан импорттау​

SIP-ке қосу​

Дауыстар

Дауыстарды тізімдеу​

Жазылым

Жазылым мәліметтері​

Автоматты толтыруды теңшеу​

Толтыру сомасын орнату​

Клиенттер

Клиенттерді тізімдеу​

Клиент мәліметтері​

Клиент жасау​

Клиентті жаңарту​

Клиентті жою​

Жұмыс кеңістіктері

Жұмыс кеңістіктерін тізімдеу​

Жұмыс кеңістігін жасау​

Жұмыс кеңістігінің мәліметтері​

Жұмыс кеңістігін жаңарту​

Жұмыс кеңістігін жою​

Мүшені шақыру​

Мүшені жою​

API арқылы қолжетімді емес нәрсе​

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

Жылдам шолу

Аутентификация

Келісімдер

Соңғы нүктелер индексі

Қоңыраулар

Агенттер

Білім базасы

Телефон нөмірлері

Дауыстар · Жазылым · Клиенттер · Жұмыс кеңістіктері

Қоңырауларды тізімдеу

Қоңырау мәліметтерін алу

Жалпы көрсеткіштер

Күнделікті көрсеткіштер

Көңіл-күй статистикасы

Шығындарды бөлу

Қоңырауларды экспорттау (CSV)

Шығындарды экспорттау (CSV)

Телефон қоңырауын жасау

Веб-қоңырау жасау

Агенттерді тізімдеу

Агентті алу

Агент жасау

Агентті жаңарту

Агентті жою

Агент қоңырау статистикасы

Агент үлгілерін тізімдеу

Агент әрекеттері

Әрекеттерді тізімдеу

Әрекет қосу

Әрекетті жаңарту

Әрекетті жою

Агент құралдары

Құралдарды тізімдеу

Құрал қосу

Құралды жаңарту

Құралды жою

Білім базаларын тізімдеу

Білім базасын жасау

Бір файл қосу

Бірнеше файл қосу

Файл(дар)ды жою

Агенттерді тағайындау

Телефон нөмірлерін тізімдеу

Қолжетімді нөмірлер

Нөмір сатып алу

Twilio-дан импорттау

SIP-ке қосу

Дауыстарды тізімдеу

Жазылым мәліметтері

Автоматты толтыруды теңшеу

Толтыру сомасын орнату

Клиенттерді тізімдеу

Клиент мәліметтері

Клиент жасау

Клиентті жаңарту

Клиентті жою

Жұмыс кеңістіктерін тізімдеу

Жұмыс кеңістігін жасау

Жұмыс кеңістігінің мәліметтері

Жұмыс кеңістігін жаңарту

Жұмыс кеңістігін жою

Мүшені шақыру

Мүшені жою

API арқылы қолжетімді емес нәрсе

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