Langkau ke kandungan utama
REST API Awam

Kuasa moderasi,
boleh dipanggil daripada kod anda

Sambungkan Telm ke dalam sistem anda sendiri: semak sebarang teks dengan enjin anti-spam produksi, urus tetapan dan peraturan kumpulan daripada kod, baca jurnal keputusan dan analitik — semuanya melalui REST API yang kemas dengan kunci yang anda kawal.

  • REST v1 yang stabil
  • Semakan spam pada setiap pelan
  • Webhook disertakan
$Kod andatk_live_…Kunci API andaEnjin TelmKumpulan anda

Panggilan pertama anda dalam 30 saat

Tiada kerumitan SDK: panggilan HTTPS dengan kunci anda sudah memadai.

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

Satu permintaan, satu verdik daripada enjin produksi — berserta skor dan sebab-sebab yang dicetuskan. Respons tiba dalam masa kurang daripada satu saat untuk semakan berasaskan peraturan.

Apa yang boleh dilakukan oleh API

Semakan spam & pengguna

Jalankan sebarang teks melalui enjin yang sama yang melindungi kumpulan Telm — panggilan tunggal, kelompok sehingga 20, dan penyaringan pengguna terhadap CAS serta set data milik Telm sendiri.

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

Kumpulan & tetapan

Baca dan patch tetapan perlindungan, urus peraturan moderasi tersuai dan senarai putih — untuk satu kumpulan atau seluruh armada.

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

Jurnal & analitik

Baca setiap keputusan enjin berserta verdik, skor dan peraturan yang dicetuskan, tarik siri analitik harian, dan jejaki penggunaan kuota anda sendiri.

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

Pengurusan webhook

Cipta dan urus titik akhir webhook, hantar ping ujian dan periksa sejarah penghantaran — sepenuhnya melalui API.

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

Had yang jujur, tercetak pada kotak

PelanPanggilan sehariHad kadarAkses API
Free10060/minSemakan spam
Basic1 00060/minSemakan spam
Pro10 000600/minAPI penuh + webhook
Business50 0001 800/minAPI penuh + webhook

Had dikenakan bagi setiap akaun, bukan bagi setiap kunci. Setiap respons membawa pengepala X-Quota-Limit, X-Quota-Used dan X-Quota-Reset, dan apabila had dicapai ia memulangkan 429 yang kemas dengan Retry-After — tiada kejutan.

Kunci yang dibina sebagaimana yang sepatutnya

Dipapar sekali, disimpan dalam bentuk hash

Kunci penuh muncul tepat sekali sahaja, semasa dicipta. Telm hanya menyimpan hash — tiada sesiapa, termasuk kami, boleh membaca semula kunci anda.

Skop baca/tulis

Kunci membawa skop baca dan tulis. Berikan skrip pelaporan anda kunci baca sahaja — ia secara fizikal tidak boleh mengubah sebarang tetapan.

Pembatalan serta-merta

Batalkan mana-mana kunci daripada papan pemuka dan ia berhenti berfungsi dengan serta-merta. Suis pemati bagi setiap akaun boleh membekukan semua akses API sekali gus.

API penuh pada Pro dan Business

API penuh dan webhook disertakan dalam Pro dan Business. Semakan spam tersedia pada setiap pelan — termasuk Free — dalam had kuota harian.

Enjin yang sama, kini di bawah kawalan anda

API awam mendedahkan enjin moderasi yang sama yang menjalankan bot Telm — bukan tiruan yang dipermudah. POST satu teks ke /spam/check dan ia melalui saluran yang sama seperti yang digunakan oleh kumpulan anda: isyarat reputasi, peraturan, dan secara pilihan pengelas AI. Ini bermakna anda boleh membenamkan pertimbangan Telm di mana-mana sahaja: borang sokongan, bot anda sendiri, ruangan komen, atau alat dalaman.

Selain semakan, API menguruskan kumpulan anda sebagai kod. Baca dan patch tetapan perlindungan, cipta peraturan moderasi, kekalkan senarai putih — operasi yang sama seperti papan pemuka, tetapi boleh diskrip. Agensi yang mengendalikan berpuluh-puluh komuniti boleh melancarkan perubahan dasar dengan satu gelung dan bukannya berpuluh-puluh klik.

Sejarah ialah keutamaan utama: titik akhir jurnal memulangkan setiap keputusan yang dibuat oleh enjin — verdik, skor, peraturan mana yang dicetuskan, tindakan yang diambil — dengan penomboran kursor yang dibina untuk pengarkiban. Digabungkan dengan titik akhir analitik, anda boleh membina arkib pematuhan, papan pemuka dalaman atau pemberitahuan amaran berdasarkan data sebenar kumpulan anda.

Pengesahan sengaja dibuat membosankan: kunci bearer yang dicipta dalam papan pemuka anda, dipaparkan sekali sahaja, disimpan dalam bentuk hash, dengan skop baca/tulis dan pembatalan serta-merta. Setiap respons membawa pengepala kuota supaya integrasi anda sentiasa tahu kedudukannya.

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.

Bersedia untuk bermula?

Mula melindungi komuniti anda hari ini. Pelan percuma tersedia.