মূল বিষয়বস্তুতে যান
পাবলিক REST API

মডারেশনের শক্তি,
আপনার কোড থেকে কলযোগ্য

Telm-কে আপনার নিজের সিস্টেমে যুক্ত করুন: প্রোডাকশন অ্যান্টি-স্প্যাম ইঞ্জিন দিয়ে যেকোনো টেক্সট যাচাই করুন, কোড থেকে গ্রুপ সেটিংস ও নিয়ম পরিচালনা করুন, সিদ্ধান্তের জার্নাল ও অ্যানালিটিক্স পড়ুন — সবই একটি পরিচ্ছন্ন REST API-এর মাধ্যমে, আপনার নিয়ন্ত্রণে থাকা কী দিয়ে।

  • স্থিতিশীল REST v1
  • প্রতিটি প্ল্যানে স্প্যাম যাচাই
  • webhooks অন্তর্ভুক্ত
$আপনার কোডtk_live_…আপনার API কীTelm ইঞ্জিনআপনার গ্রুপ

৩০ সেকেন্ডে আপনার প্রথম কল

কোনো 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 গ্রুপগুলোকে সুরক্ষিত রাখে, ঠিক সেই ইঞ্জিনের ভেতর দিয়ে যেকোনো টেক্সট চালান — একক কল, ২০ পর্যন্ত ব্যাচ, এবং 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

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

সীমা প্রযোজ্য হয় প্রতি অ্যাকাউন্টে, প্রতি কী-তে নয়। প্রতিটি রেসপন্স X-Quota-Limit, X-Quota-Used এবং X-Quota-Reset হেডার বহন করে, এবং সীমায় পৌঁছালে Retry-After সহ একটি পরিষ্কার 429 ফেরত আসে — কোনো চমক নেই।

যেমন হওয়া উচিত ঠিক তেমন কী

একবার দেখানো, হ্যাশ করে সংরক্ষিত

সম্পূর্ণ কী ঠিক একবারই দেখা যায়, তৈরির সময়। Telm শুধু একটি হ্যাশ সংরক্ষণ করে — আমরা সহ কেউই আপনার কী আবার পড়তে পারে না।

Read/write স্কোপ

কী read এবং write স্কোপ বহন করে। আপনার রিপোর্টিং স্ক্রিপ্টকে একটি read-only কী দিন — এটি প্রযুক্তিগতভাবেই কোনো সেটিংস পরিবর্তন করতে পারবে না।

তাৎক্ষণিক প্রত্যাহার

ড্যাশবোর্ড থেকে যেকোনো কী প্রত্যাহার করুন এবং তা সঙ্গে সঙ্গে কাজ করা বন্ধ করে দেয়। একটি প্রতি-অ্যাকাউন্ট কিল সুইচ একবারে সমস্ত API অ্যাক্সেস স্তব্ধ করে দিতে পারে।

Pro এবং Business-এ সম্পূর্ণ API

সম্পূর্ণ API এবং webhooks Pro এবং Business-এ অন্তর্ভুক্ত। স্প্যাম যাচাই প্রতিটি প্ল্যানে উপলব্ধ — Free সহ — দৈনিক কোটার মধ্যে।

সেই একই ইঞ্জিন, এখন আপনার নিয়ন্ত্রণে

পাবলিক API সেই একই মডারেশন ইঞ্জিন উন্মুক্ত করে যা Telm-এর বট চালায় — কোনো সরলীকৃত নকল নয়। /spam/check-এ একটি টেক্সট POST করুন এবং তা আপনার গ্রুপগুলো যে অভিন্ন পাইপলাইন ব্যবহার করে তার ভেতর দিয়েই যায়: রেপুটেশন সিগন্যাল, নিয়ম এবং ঐচ্ছিকভাবে AI ক্লাসিফায়ার। এর মানে আপনি Telm-এর বিচারকে যেকোনো জায়গায় বসাতে পারেন: একটি সাপোর্ট ফর্ম, আপনার নিজের বট, একটি কমেন্ট সেকশন, একটি অভ্যন্তরীণ টুল।

যাচাইয়ের বাইরেও, API আপনার গ্রুপগুলোকে কোড হিসেবে পরিচালনা করে। সুরক্ষা সেটিংস পড়ুন ও প্যাচ করুন, মডারেশন নিয়ম তৈরি করুন, হোয়াইটলিস্ট বজায় রাখুন — ড্যাশবোর্ডের মতোই একই কাজ, কিন্তু স্ক্রিপ্ট করার উপযোগী। কয়েক ডজন কমিউনিটি চালানো এজেন্সিগুলো কয়েক ডজন ক্লিকের বদলে একটিমাত্র লুপে পলিসি পরিবর্তন রোল আউট করতে পারে।

ইতিহাস এখানে প্রথম শ্রেণির নাগরিক: জার্নাল এন্ডপয়েন্ট ইঞ্জিনের নেওয়া প্রতিটি সিদ্ধান্ত ফেরত দেয় — রায়, স্কোর, কোন নিয়মগুলো সক্রিয় হয়েছে, কী পদক্ষেপ নেওয়া হয়েছে — আর্কাইভিংয়ের জন্য তৈরি কার্সর পেজিনেশন সহ। অ্যানালিটিক্স এন্ডপয়েন্টের সঙ্গে মিলিয়ে আপনি আপনার গ্রুপের প্রকৃত ডেটার উপর কমপ্লায়েন্স আর্কাইভ, অভ্যন্তরীণ ড্যাশবোর্ড বা অ্যালার্টিং তৈরি করতে পারেন।

অথেন্টিকেশন ইচ্ছাকৃতভাবেই নিরুত্তেজ: আপনার ড্যাশবোর্ডে তৈরি bearer কী, একবারই দেখানো হয়, হ্যাশ করে সংরক্ষণ করা হয়, 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.

শুরু করতে প্রস্তুত?

আজই আপনার কমিউনিটি রক্ষা করা শুরু করুন। বিনামূল্যে প্ল্যান উপলব্ধ।