Vai al contenuto principale
API REST pubblica

La potenza della moderazione,
richiamabile dal tuo codice

Collega Telm ai tuoi sistemi: controlla qualsiasi testo con il motore anti-spam di produzione, gestisci le impostazioni e le regole dei gruppi da codice, leggi il registro delle decisioni e le analisi — tutto tramite una pulita API REST con chiavi che controlli tu.

  • REST v1 stabile
  • Controllo spam su ogni piano
  • Webhook inclusi
$Il tuo codicetk_live_…La tua chiave APIMotore TelmIl tuo gruppo

La tua prima chiamata in 30 secondi

Nessuna cerimonia di SDK: basta una chiamata HTTPS con la tua chiave.

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"]
}

Una richiesta, un verdetto dal motore di produzione — con un punteggio e le ragioni che si sono attivate. La risposta arriva in ben meno di un secondo per i controlli basati su regole.

Cosa può fare l'API

Controlli su spam e utenti

Fai passare qualsiasi testo attraverso lo stesso motore che protegge i gruppi Telm — chiamate singole, batch fino a 20 e screening degli utenti su CAS più il dataset proprietario di Telm.

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

Gruppi e impostazioni

Leggi e modifica le impostazioni di protezione, gestisci le regole di moderazione personalizzate e la whitelist — per un gruppo o per una flotta di gruppi.

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

Registro e analisi

Leggi ogni decisione del motore con verdetto, punteggio e regole attivate, estrai le serie analitiche giornaliere e monitora il consumo della tua quota.

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

Gestione webhook

Crea e gestisci gli endpoint webhook, invia ping di prova e ispeziona lo storico delle consegne — interamente tramite API.

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

Limiti onesti, stampati sulla scatola

PianoChiamate al giornoLimite di frequenzaAccesso API
Free10060/minControllo spam
Basic1 00060/minControllo spam
Pro10 000600/minAPI completa + webhook
Business50 0001 800/minAPI completa + webhook

I limiti si applicano per account, non per chiave. Ogni risposta porta con sé le intestazioni X-Quota-Limit, X-Quota-Used e X-Quota-Reset, e il raggiungimento di un limite restituisce un pulito 429 con Retry-After — nessuna sorpresa.

Chiavi costruite come si deve

Mostrata una volta, memorizzata come hash

La chiave completa appare esattamente una volta, alla creazione. Telm ne memorizza solo un hash — nessuno, noi compresi, può rileggere la tua chiave.

Ambiti di lettura/scrittura

Le chiavi portano ambiti di lettura e scrittura. Dai al tuo script di reportistica una chiave di sola lettura — non potrà fisicamente modificare alcuna impostazione.

Revoca immediata

Revoca una qualsiasi chiave dalla dashboard e smette di funzionare immediatamente. Un kill switch a livello di account può congelare tutto l'accesso API in una volta sola.

API completa su Pro e Business

L'API completa e i webhook sono inclusi in Pro e Business. Il controllo spam è disponibile su ogni piano — incluso Free — entro la quota giornaliera.

Lo stesso motore, ora sotto il tuo controllo

L'API pubblica espone lo stesso motore di moderazione che fa girare il bot di Telm — non un'imitazione semplificata. Invia in POST un testo a /spam/check e passerà attraverso la pipeline identica che usano i tuoi gruppi: segnali di reputazione, regole e, facoltativamente, il classificatore IA. Questo significa che puoi incorporare il giudizio di Telm ovunque: un modulo di supporto, il tuo bot, una sezione commenti, uno strumento interno.

Oltre ai controlli, l'API gestisce i tuoi gruppi come codice. Leggi e modifica le impostazioni di protezione, crea regole di moderazione, mantieni le whitelist — le stesse operazioni della dashboard, ma programmabili. Le agenzie che gestiscono decine di community possono applicare un cambio di policy con un solo ciclo invece di decine di clic.

Lo storico è di prima classe: l'endpoint del registro restituisce ogni decisione presa dal motore — verdetto, punteggio, quali regole si sono attivate, quale azione è stata eseguita — con paginazione a cursore pensata per l'archiviazione. Combinato con l'endpoint di analisi puoi costruire archivi di conformità, dashboard interne o sistemi di alert sui dati reali del tuo gruppo.

L'autenticazione è volutamente noiosa: chiavi bearer create nella tua dashboard, mostrate una sola volta, memorizzate come hash, con ambiti (lettura/scrittura) e revoca immediata. Ogni risposta porta con sé le intestazioni di quota, così la tua integrazione sa sempre a che punto si trova.

Frequently asked questions

Which plans include API access?

Spam checking (/spam/check) works on every plan, including Free, within the daily quota. The full API — group settings, rules, journal, analytics, user screening and webhooks — is included in Pro and Business.

What are the request limits?

Daily quotas by plan: Free 100, Basic 1,000, Pro 10,000, Business 50,000 calls. Rate limits: 60 requests per minute on Free and Basic, 600 on Pro, 1,800 on Business. Every response includes X-Quota-Limit, X-Quota-Used and X-Quota-Reset headers.

How do I get an API key?

In the dashboard under Settings → API & Webhooks. The key is shown once at creation — only its hash is stored. You can hold up to 10 active keys, scope them to read-only, and revoke any of them instantly.

Can the AI classifier be used through the API?

AI checks consume the plan’s separate daily AI quota: Basic 100, Pro 1,000, Business 10,000 (Free has none).

Is there an OpenAPI specification?

Yes, the full machine-readable OpenAPI 3.1 spec is published alongside the developer documentation, so you can generate clients or plug it into your tooling.

Dove i team usano questa funzionalità:Gruppi AziendaliGruppi Supporto TecnicoCommunity Crypto

Pronto per iniziare?

Inizia a proteggere la tua community oggi. Piano gratuito disponibile.