Справочник по API
Используйте BeeCastly на основе нашего полнофункционального REST API. Управляйте контактами, отправляйте сообщения, создавайте кампании и программно настраивайте веб-перехватчики.
Базовый URL
https://beecastly.com/apiВсе конечные точки API относятся к этому базовому URL-адресу. Запросы должны включать действительный ключ API или токен JWT.
Быстрый старт
curl -X GET https://beecastly.com/api/contacts \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "x-tenant-id: YOUR_TENANT_ID" \ -H "Content-Type: application/json"
Аутентификация
Все запросы требуют аутентификации через один из:
- Ключ API — передача заголовка Authorization: Bearer YOUR_API_KEY.
- Токен JWT — получен из POST /auth/login.
Кроме того, укажите свой идентификатор клиента: x-tenant-id: YOUR_TENANT_ID.
Конечные точки API
Аутентификация
Вход, регистрация, ключи API, токены JWT
Контакты
CRUD-операции, теги, сегменты, настраиваемые поля
Сообщения
Отправьте WhatsApp, электронную почту, SMS. Получить разговоры
Кампании
Создавайте, планируйте и отслеживайте кампании
Вебхуки
Подписки на события, полезная нагрузка, проверка
Боты
Сеансы, сообщения и обучающие данные AI-ботов
Формат ответа
Все ответы имеют единый формат JSON:
// Success
{
"success": true,
"data": { ... }
}
// Error
{
"success": false,
"error": "Error message description"
}Ограничения ставок
Уровень бесплатного пользования: 100 запросов в минуту.
Уровень Pro: 1000 запросов в минуту.
Предприятие: пользовательские ограничения
Заголовки ограничения скорости включаются в каждый ответ: X-RateLimit-Remaining.