Початок роботи

sem.chat API дозволяє вам програмно керувати розмовами, надсилати повідомлення та отримувати доступ аналітика. Усі API запити вимагають автентифікації за допомогою API ключа.

Базова URL

https://api.sem.chat/v1

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

Включіть свій API ключ у заголовок авторизації всіх запитів:

Authorization: Bearer your_api_key_here

Розмови

Список розмов

ОТРИМАТИ /розмови

Отримайте список усіх розмов для вашого account.

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

Отримати розмову

GET /conversations/{id}

Отримати деталі певної розмови, включаючи всі повідомлення.

Створити розмову

POST /conversations

Почати нову розмову програмно.

Повідомлення

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

POST /conversations/{id}/messages

Надіслати повідомлення до наявної розмови.

// Example request body { "content": "Hello, how can I help you today?", "sender": "agent" }

Вебхуки

Налаштувати вебхуки для отримання сповіщень у реальному часі про події розмов.

Доступні події

Подія Опис
conversation.started Було розпочато нову бесіду
message.received Отримано нове повідомлення від відвідувача
conversation.closed Розмову закрито
lead.captured Контактну інформацію зібрано

Обмеження швидкості

API запити обмежені забезпечити справедливе використання:

План Ліміт тарифів
Пробна версія 100 запитів/годину
Pro 1000 запитів/годину
Бізнес 10 000 запитів/годину

Сплануйте безпечну API-інтеграцію

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