Chat API

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

Все запросы к Chat API требуют API-ключа. Ключ передаётся в заголовке X-API-Key.

GET /v1/live-chat/admin/dialogs
X-API-Key: sk_live_abc123...
Content-Type: application/json

Создайте API-ключ в Панели управления → Чаты → Chat API → API-ключи.

Base URL

Все запросы отправляются на домен вашего пространства:

Например, для пространства sigmamotors:

Ошибки и коды ответов

Тело ошибки:

{
  "error": "invalid_api_key",
  "message": "API key is invalid or revoked"
}

Rate Limits

Заголовки ответа:

Диалоги

Получить список диалогов

// Ответ
{
  "dialogs": [
    {
      "id": "d1a2b3c4-...",
      "state": "operator",
      "guest_session": {
        "display_name": "Иван",
        "email": "ivan@example.com"
      },
      "created_at": "2026-03-15T10:00:00Z",
      "updated_at": "2026-03-15T10:05:00Z"
    }
  ],
  "total": 42,
  "page": 1,
  "limit": 20
}

Получить диалог по ID

Закрыть диалог

Принять диалог из очереди

Сообщения

Получить сообщения диалога

// Ответ
{
  "messages": [
    {
      "id": "msg-uuid-...",
      "content": "Здравствуйте! Интересует Changan UNI-K.",
      "sender_type": "guest",
      "created_at": "2026-03-15T10:01:00Z"
    }
  ]
}

Отправить сообщение

// Тело запроса
{
  "content": "Добрый день! Да, UNI-K в наличии."
}

Webhooks

Подпишитесь на события чатов, чтобы получать уведомления на ваш сервер в реальном времени.

Создать подписку

{
  "url": "https://your-server.com/webhook",
  "events": ["live_chat.message.created", "live_chat.dialog.closed"],
  "description": "CRM интеграция"
}

Список подписок

Удалить подписку

Тест подписки

Верификация подписи

Каждый webhook-запрос подписывается секретом. Проверяйте заголовок X-Webhook-Signature:

# HMAC-SHA256(secret, body)
X-Webhook-Signature: sha256=abc123...

// Пример проверки (Node.js)
const crypto = require('crypto');

function verify(body, signature, secret) {
  const expected = 'sha256=' +
    crypto.createHmac('sha256', secret)
      .update(body)
      .digest('hex');
  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(expected)
  );
}

Типы событий

Формат webhook-запроса:

{
  "event": "live_chat.message.created",
  "event_id": "evt-uuid-...",
  "timestamp": "2026-03-15T10:02:00Z",
  "data": {
    "dialog_id": "d1a2b3c4-...",
    "message": {
      "id": "msg-uuid-...",
      "content": "Здравствуйте!",
      "sender_type": "guest"
    }
  }
}