मुख्य सामग्री पर जाएँ
Public REST API

मॉडरेशन की ताक़त,
आपके कोड से कॉल करने योग्य

Telm को अपने सिस्टम में जोड़ें: प्रोडक्शन एंटी-स्पैम इंजन से किसी भी टेक्स्ट को चेक करें, कोड से ग्रुप सेटिंग्स और नियम मैनेज करें, फ़ैसलों का जर्नल और एनालिटिक्स पढ़ें — सब कुछ एक साफ़-सुथरे REST API के ज़रिए, उन keys के साथ जिन्हें आप नियंत्रित करते हैं।

  • स्थिर REST v1
  • हर प्लान पर स्पैम चेक
  • Webhooks शामिल
$आपका कोडtk_live_…आपकी API keyTelm इंजनआपका ग्रुप

30 सेकंड में आपकी पहली कॉल

कोई SDK ताम-झाम नहीं: आपकी key के साथ एक 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

ग्रुप और सेटिंग्स

प्रोटेक्शन सेटिंग्स पढ़ें और patch करें, कस्टम मॉडरेशन नियम और whitelist मैनेज करें — एक ग्रुप के लिए या पूरे बेड़े के लिए।

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

जर्नल और एनालिटिक्स

इंजन के हर फ़ैसले को वर्डिक्ट, स्कोर और ट्रिगर हुए नियमों के साथ पढ़ें, रोज़ाना की एनालिटिक्स सीरीज़ खींचें और अपने कोटा उपयोग को ट्रैक करें।

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

Webhooks मैनेजमेंट

webhook एंडपॉइंट बनाएँ और मैनेज करें, टेस्ट पिंग भेजें और डिलीवरी हिस्ट्री जाँचें — पूरी तरह API के ज़रिए।

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

ईमानदार सीमाएँ, खुलकर बताई गईं

प्लानप्रति दिन कॉलरेट लिमिटAPI एक्सेस
Free10060/minस्पैम चेक
Basic1 00060/minस्पैम चेक
Pro10 000600/minपूरा API + webhooks
Business50 0001 800/minपूरा API + webhooks

सीमाएँ प्रति अकाउंट लागू होती हैं, प्रति key नहीं। हर रिस्पॉन्स में X-Quota-Limit, X-Quota-Used और X-Quota-Reset हेडर होते हैं, और सीमा पर पहुँचने पर एक साफ़ 429 Retry-After के साथ लौटता है — कोई हैरानी नहीं।

जैसी बननी चाहिए वैसी keys

एक बार दिखाई, हैश करके संग्रहीत

पूरी key ठीक एक बार दिखती है, बनाते समय। Telm सिर्फ़ एक हैश संग्रहीत करता है — कोई भी, हम सहित, आपकी key वापस नहीं पढ़ सकता।

read/write स्कोप

keys में read और write स्कोप होते हैं। अपनी रिपोर्टिंग स्क्रिप्ट को एक read-only key दें — वह भौतिक रूप से किसी सेटिंग को बदल ही नहीं सकती।

तुरंत रद्दीकरण

डैशबोर्ड से किसी भी key को रद्द करें और वह तुरंत काम करना बंद कर देती है। प्रति-अकाउंट किल स्विच एक ही बार में सारी API एक्सेस फ़्रीज़ कर सकता है।

Pro और Business पर पूरा API

पूरा API और webhooks Pro और Business में शामिल हैं। स्पैम चेकिंग हर प्लान पर उपलब्ध है — Free सहित — रोज़ाना कोटा के भीतर।

वही इंजन, अब आपके नियंत्रण में

पब्लिक API वही मॉडरेशन इंजन उजागर करता है जो Telm का बॉट चलाता है — कोई सरलीकृत नक़ल नहीं। किसी टेक्स्ट को /spam/check पर POST करें और वह उसी पाइपलाइन से गुज़रता है जो आपके ग्रुप इस्तेमाल करते हैं: रेपुटेशन सिग्नल, नियम, और वैकल्पिक रूप से AI क्लासिफ़ायर। इसका मतलब है कि आप Telm के फ़ैसले को कहीं भी जोड़ सकते हैं: एक सपोर्ट फ़ॉर्म, अपना बॉट, एक कमेंट सेक्शन, एक इंटरनल टूल।

चेक से आगे, API आपके ग्रुपों को कोड की तरह मैनेज करता है। प्रोटेक्शन सेटिंग्स पढ़ें और patch करें, मॉडरेशन नियम बनाएँ, whitelist बनाए रखें — डैशबोर्ड जैसे ही ऑपरेशन, पर स्क्रिप्ट-योग्य। दर्जनों समुदाय चलाने वाली एजेंसियाँ दर्जनों क्लिक के बजाय एक लूप से पॉलिसी बदलाव रोल आउट कर सकती हैं।

हिस्ट्री प्रथम-श्रेणी की है: जर्नल एंडपॉइंट इंजन के हर फ़ैसले को लौटाता है — वर्डिक्ट, स्कोर, कौन-से नियम चले, क्या कार्रवाई हुई — आर्काइविंग के लिए बने कर्सर पेजिनेशन के साथ। एनालिटिक्स एंडपॉइंट के साथ मिलाकर आप अपने ग्रुप के असली डेटा पर कम्प्लायंस आर्काइव, इंटरनल डैशबोर्ड या अलर्टिंग बना सकते हैं।

ऑथेंटिकेशन जानबूझकर उबाऊ है: आपके डैशबोर्ड में बनी bearer keys, एक बार दिखाई जातीं, हैश करके संग्रहीत, read/write स्कोप और तुरंत रद्दीकरण के साथ। हर रिस्पॉन्स में कोटा हेडर होते हैं ताकि आपका इंटीग्रेशन हमेशा जाने कि वह कहाँ खड़ा है।

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.

शुरू करने के लिए तैयार हैं?

आज ही अपने समुदाय की सुरक्षा शुरू करें। मुफ्त प्लान उपलब्ध है।