Перейти к основному содержимому
Публичный REST API

Сила модерации —
вызываемая из вашего кода

Встройте Telm в свои системы: проверяйте любой текст боевым антиспам-движком, управляйте настройками и правилами групп из кода, читайте журнал решений и аналитику — всё через аккуратный REST API с ключами, которыми управляете вы.

  • Стабильный REST v1
  • Проверка спама на любом плане
  • Вебхуки включены
$Ваш кодtk_live_…Ваш API-ключДвижок TelmВаша группа

Первый вызов за 30 секунд

Никаких церемоний с SDK: достаточно HTTPS-запроса с вашим ключом.

spam-check.sh
$ curl -X POST https://api.telm.com/api/public/v1/spam/check \
    -H "Authorization: Bearer tk_live_..." \
    -d '{"text": "Earn $500/day from home!! DM me now"}'

// HTTP 200
{
  "verdict": "spam",
  "score": 97,
  "reasons": ["contact_flow", "money_lure"]
}

Один запрос — один вердикт от боевого движка, с оценкой и сработавшими причинами. Для проверок по правилам ответ приходит меньше чем за секунду.

Что умеет API

Проверки спама и пользователей

Прогоняйте любой текст через тот же движок, что защищает группы Telm, — одиночными вызовами, пачками до 20 штук, а пользователей проверяйте по CAS и собственному датасету Telm.

POST /spam/checkPOST /spam/check-batchPOST /users/check

Группы и настройки

Читайте и правьте настройки защиты, управляйте своими правилами модерации и белым списком — для одной группы или целого их парка.

GET/PATCH /groups/{id}/settingsCRUD /groups/{id}/rulesCRUD /groups/{id}/whitelist

Журнал и аналитика

Читайте каждое решение движка — с вердиктом, оценкой и сработавшими правилами, выгружайте ежедневные ряды аналитики и следите за расходом собственной квоты.

GET /groups/{id}/journalGET /groups/{id}/analyticsGET /usage

Управление вебхуками

Создавайте вебхук-эндпоинты и управляйте ими, отправляйте тестовые пинги и просматривайте историю доставок — целиком через API.

CRUD /webhooksPOST /webhooks/{id}/testGET /webhooks/{id}/deliveries

Честные лимиты — прямо на упаковке

ПланВызовов в деньОграничение частотыДоступ к API
Free10060/minПроверка спама
Basic1 00060/minПроверка спама
Pro10 000600/minПолный API + вебхуки
Business50 0001 800/minПолный API + вебхуки

Лимиты действуют на аккаунт, а не на ключ. В каждом ответе есть заголовки X-Quota-Limit, X-Quota-Used и X-Quota-Reset, а при достижении лимита приходит понятный 429 с Retry-After — без сюрпризов.

Ключи, сделанные как надо

Показан один раз, хранится хешем

Полный ключ появляется ровно один раз — при создании. Telm хранит только хеш: прочитать ваш ключ обратно не может никто, включая нас.

Scope на чтение/запись

У ключей есть scope на чтение и на запись. Дайте отчётному скрипту ключ только на чтение — он физически не сможет менять настройки.

Мгновенный отзыв

Отзовите любой ключ в дашборде — и он тут же перестаёт работать. Общий рубильник аккаунта разом замораживает весь доступ к API.

Полный API на Pro и Business

Полный API и вебхуки входят в Pro и Business. Проверка спама доступна на любом плане — включая Free — в пределах дневной квоты.

Тот же движок — теперь под вашим управлением

Публичный API открывает тот же движок модерации, на котором работает бот Telm, — а не его упрощённую имитацию. Отправьте текст в POST /spam/check, и он пройдёт по тому же конвейеру, что и в ваших группах: сигналы репутации, правила и, по желанию, AI-классификатор. Значит, вердикт Telm можно встроить куда угодно: в форму поддержки, в собственного бота, в раздел комментариев, во внутренний инструмент.

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

История здесь полноправна: эндпоинт журнала возвращает каждое решение движка — вердикт, оценку, сработавшие правила, принятое действие — с курсорной пагинацией, рассчитанной на архивирование. Вместе с эндпоинтом аналитики на реальных данных вашей группы можно строить архивы для комплаенса, внутренние дашборды или оповещения.

Аутентификация нарочито скучна: bearer-ключи создаются в дашборде, показываются один раз, хранятся в виде хеша, имеют scope на чтение/запись и мгновенно отзываются. В каждом ответе есть заголовки квоты, так что интеграция всегда знает, где находится.

Частые вопросы

На каких планах есть доступ к API?

Проверка спама (/spam/check) работает на любом плане, включая Free, в пределах дневной квоты. Полный API — настройки групп, правила, журнал, аналитика, проверка пользователей и вебхуки — входит в Pro и Business.

Какие лимиты на запросы?

Дневные квоты по планам: Free — 100, Basic — 1 000, Pro — 10 000, Business — 50 000 вызовов. Ограничения частоты: 60 запросов в минуту на Free и Basic, 600 на Pro, 1 800 на Business. В каждом ответе есть заголовки X-Quota-Limit, X-Quota-Used и X-Quota-Reset.

Как получить API-ключ?

В дашборде, в разделе «Настройки → API и вебхуки». Ключ показывается один раз при создании — хранится только его хеш. Можно держать до 10 активных ключей, ограничивать их доступом только на чтение и мгновенно отзывать любой из них.

Можно ли пользоваться AI-классификатором через API?

Проверки AI расходуют отдельную дневную AI-квоту тарифа: Basic 100, Pro 1 000, Business 10 000 (на Free квоты нет).

Есть ли спецификация OpenAPI?

Да, полная машиночитаемая спецификация OpenAPI 3.1 опубликована вместе с документацией для разработчиков — по ней можно сгенерировать клиентов или подключить её к своим инструментам.

Готовы начать?

Начните защищать своё сообщество сегодня. Доступен бесплатный тариф.