Начало работы

API sem.chat позволяет программно управлять беседами, отправлять сообщения и получать доступ к аналитике. Для каждого запроса необходима аутентификация с помощью ключа API.

Базовый URL

https://api.sem.chat/v1

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

Добавляйте ключ API в заголовок Authorization каждого запроса:

Authorization: Bearer your_api_key_here

Беседы

Список бесед

GET /conversations

Получите список всех бесед вашей учётной записи.

Параметр Тип Описание
limit integer Количество результатов (не более 100)
offset integer Количество результатов для пропуска
строка статуса Фильтровать по статусу: активный, закрытый, ожидающий

Получить разговор

GET /conversations/{id}

Получить подробную информацию о конкретном разговоре, включая все сообщения.

Создать разговор

POST /conversations

Программно начните новую беседу.

Сообщения

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

POST /conversations/{id}/messages

Отправьте сообщение в существующую беседу.

// Пример тела запроса { "content": "Hello, how can I help you today?", "sender": "agent" }

Вебхуки

Настройте вебхуки, чтобы получать уведомления о событиях бесед в реальном времени.

Доступные события

Событие Описание
conversation.started Начата новая беседа
message.received Получено новое сообщение от посетителя
conversation.closed Беседа закрыта
lead.captured Получены контактные данные

Ограничения запросов

Количество запросов API ограничено для справедливого использования:

План Ограничение скорости
Триал 100 запросов/час
Про 1000 запросов/час
Бизнес 10 000 запросов/час

Спланируйте безопасную API-интеграцию

По документации API определите минимальный набор данных и прав для конкретного сценария. Храните учетные данные только в серверном хранилище секретов, никогда в браузерном коде, открытом репозитории, снимках экрана или сообщениях поддержки. Разделяйте разработку и продакшн, проверяйте входные данные, корректно обрабатывайте лимиты и повторные запросы и не записывайте чувствительные данные клиентов. Протестируйте просроченные ключи, дубли событий, сетевые сбои и безопасный откат. Назначьте ответственных за ротацию и инциденты и регулярно удаляйте ненужные права.