Ga naar hoofdinhoud
Publieke REST API

Moderatiekracht,
aanroepbaar vanuit je code

Koppel Telm aan je eigen systemen: controleer willekeurige tekst met de productie-antispamengine, beheer groepsinstellingen en regels vanuit code, lees het beslissingsjournaal en de analytics — allemaal via een strakke REST API met sleutels die jij beheert.

  • Stabiele REST v1
  • Spamcontrole in elk plan
  • Webhooks inbegrepen
$Jouw codetk_live_…Jouw API-sleutelTelm-engineJouw groep

Je eerste aanroep in 30 seconden

Geen SDK-poespas: een HTTPS-aanroep met je sleutel is alles wat nodig is.

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

Eén aanvraag, één oordeel uit de productie-engine — met een score en de redenen die afgingen. Bij op regels gebaseerde controles komt de respons ruim binnen een seconde.

Wat de API kan

Spam- & gebruikerscontroles

Stuur willekeurige tekst door dezelfde engine die Telm-groepen beschermt — losse aanroepen, batches tot 20 en gebruikerscontrole tegen CAS plus Telms eigen dataset.

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

Groepen & instellingen

Lees en patch beveiligingsinstellingen, beheer eigen moderatieregels en de whitelist — voor één groep of een hele vloot.

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

Journaal & analytics

Lees elke engine-beslissing met oordeel, score en geactiveerde regels, haal dagelijkse analyse-reeksen op en houd je eigen quotaverbruik bij.

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

Webhooks-beheer

Maak en beheer webhook-endpoints, stuur test-pings en bekijk de afleverhistorie — helemaal via de API.

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

Eerlijke limieten, gewoon op de verpakking

PlanAanroepen per dagRate limitAPI-toegang
Free10060/minSpamcontrole
Basic1 00060/minSpamcontrole
Pro10 000600/minVolledige API + webhooks
Business50 0001 800/minVolledige API + webhooks

Limieten gelden per account, niet per sleutel. Elke respons draagt de headers X-Quota-Limit, X-Quota-Used en X-Quota-Reset, en bij het bereiken van een limiet komt een nette 429 met Retry-After terug — geen verrassingen.

Sleutels zoals ze horen te zijn

Eén keer getoond, gehasht opgeslagen

De volledige sleutel verschijnt precies één keer, bij het aanmaken. Telm slaat alleen een hash op — niemand, ook wij niet, kan je sleutel teruglezen.

Lees-/schrijfscopes

Sleutels dragen lees- en schrijfscopes. Geef je rapportagescript een alleen-lezen sleutel — die kan fysiek geen enkele instelling wijzigen.

Directe intrekking

Trek een willekeurige sleutel in vanuit het dashboard en die stopt onmiddellijk met werken. Een kill switch per account kan alle API-toegang in één keer bevriezen.

Volledige API in Pro en Business

De volledige API en webhooks zijn inbegrepen in Pro en Business. Spamcontrole is beschikbaar in elk plan — ook in Free — binnen de dagelijkse quota.

Dezelfde engine, nu onder jouw controle

De publieke API stelt dezelfde moderatie-engine beschikbaar die de bot van Telm aandrijft — geen versimpelde imitatie. POST een tekst naar /spam/check en die doorloopt exact dezelfde pipeline als je groepen gebruiken: reputatiesignalen, regels en optioneel de AI-classificatie. Zo kun je het oordeel van Telm overal inbouwen: een supportformulier, je eigen bot, een reactiesectie, een intern tool.

Naast controles beheert de API je groepen als code. Beveiligingsinstellingen lezen en patchen, moderatieregels aanmaken, whitelists onderhouden — dezelfde handelingen als in het dashboard, maar scriptbaar. Bureaus met tientallen community's rollen een beleidswijziging uit met één loop in plaats van tientallen klikken.

Historie is eersteklas: het journaal-endpoint geeft elke beslissing van de engine terug — oordeel, score, welke regels afgingen, welke actie volgde — met cursor-paginering die gemaakt is voor archivering. Samen met het analytics-endpoint bouw je compliance-archieven, interne dashboards of alerting bovenop de echte data van je groep.

Authenticatie is bewust saai: bearer-sleutels die je in je dashboard aanmaakt, één keer getoond, gehasht opgeslagen, met lees-/schrijfscopes en directe intrekking. Elke respons draagt quota-headers, zodat je integratie altijd weet waar ze aan toe is.

Veelgestelde vragen

Welke plannen bevatten API-toegang?

Spamcontrole (/spam/check) werkt in elk plan, ook in Free, binnen de dagelijkse quota. De volledige API — groepsinstellingen, regels, journaal, analytics, gebruikerscontrole en webhooks — is inbegrepen in Pro en Business.

Wat zijn de aanvraaglimieten?

Dagelijkse quota per plan: Free 100, Basic 1.000, Pro 10.000, Business 50.000 aanroepen. Rate limits: 60 aanvragen per minuut bij Free en Basic, 600 bij Pro, 1.800 bij Business. Elke respons bevat de headers X-Quota-Limit, X-Quota-Used en X-Quota-Reset.

Hoe krijg ik een API-sleutel?

In het dashboard onder Instellingen → API & Webhooks. De sleutel wordt bij het aanmaken één keer getoond — alleen de hash ervan wordt opgeslagen. Je kunt maximaal 10 actieve sleutels aanhouden, ze beperken tot alleen-lezen en elke sleutel direct intrekken.

Kan de AI-classificatie via de API worden gebruikt?

Ja — geef include_ai mee in /spam/check en de respons voegt het AI-oordeel toe. AI-controles putten uit een aparte dagelijkse AI-quota die beschikbaar is in Pro en Business.

Is er een OpenAPI-specificatie?

Ja, de volledige machineleesbare OpenAPI 3.1-specificatie wordt samen met de ontwikkelaarsdocumentatie gepubliceerd, zodat je clients kunt genereren of ze in je tooling kunt inpluggen.

Waar teams dit gebruiken

Echte communitytypen waar deze functie het zware werk doet.

Klaar om te beginnen?

Begin vandaag nog met het beschermen van je community. Gratis plan beschikbaar.