Довідник Chat API

Автентифікація

Кожен запит автентифікується за допомогою ключа API вашого робочого простору, який надсилається в заголовку X-API-Key (або в параметрі api_key). Ключі мають вигляд ck_live_.... Ставтеся до ключа як до пароля - будь-хто, хто ним володіє, може надсилати повідомлення, що тарифікуються на ваш робочий простір. Змінюйте його будь-коли в розділі Налаштування -> Доступ до API; попередній ключ одразу перестає працювати.

Надсилання повідомлення

POST https://chatixy.com/api/v1/chat

curl https://chatixy.com/api/v1/chat \
  -H "X-API-Key: ck_live_YOUR_KEY" \
  -F "message=How do I reset my password?"

Параметри:

• message (рядок) - повідомлення відвідувача. Обов'язкове, якщо не додано files.
• ticket_id (рядок, необов'язково) - продовження наявної розмови. Опустіть, щоб почати нову.
• visitor_email / visitor_name (рядок, необов'язково) - додати контактні дані до звернення.
• files (multipart, необов'язково) - вкладення відвідувача. Потрібен план із завантаженням файлів.

Відповідь

Виклик повертає 202 Accepted, щойно повідомлення збережено; відповідь ШІ генерується асинхронно.

{
  "status": { "code": 202, "message": "Message received and being processed" },
  "data": {
    "ticket_id": 1234,
    "ticket_number": "T-1234",
    "id": "<visitor_hash>",
    "processing": true
  }
}

Передайте data.ticket_id назад як ticket_id у наступному виклику, щоб продовжити розмову. Щоб отримати відповідь ШІ, підпишіться через WebSocket (ActionCable) на канал, прив'язаний до data.id - той самий хеш відвідувача, який використовує вбудований віджет.

Читання звернень

Отримуйте тикети та їхні повідомлення з тим самим X-API-Key. Кожна кінцева точка читання обмежена вашим робочим простором і доступна в плані Business.

• GET /api/v1/chat/tickets - список тикетів, спочатку найновіші. Параметри запиту: status, limit (максимум 100), offset. Повертає tickets і pagination.
• GET /api/v1/chat/tickets/:id - один тикет.
• GET /api/v1/chat/tickets/:id/messages - повідомлення тикета за порядком, кожне з role, content та attachments.

curl https://chatixy.com/api/v1/chat/tickets \
  -H "X-API-Key: ck_live_YOUR_KEY"

Обмеження частоти та квота

Запити обмежені приблизно 20 на хвилину на ключ (і на IP). Кожна згенерована відповідь також витрачає місячний ліміт повідомлень вашого плану; щойно його вичерпано, кінцева точка повертає 200 з data.limit_reached: true замість генерації відповіді.

Помилки

• 401 - ключ API не надано.
• 404 - ключ не відповідає жодному робочому простору (наприклад, після зміни).
• 403 plan_upgrade_required - робочий простір не на плані Business.
• 403 - підписка неактивна або запит надійшов із домену, не дозволеного налаштуваннями віджета.
• 422 - повідомлення відсутнє (і файли не додано).