メインコンテンツへスキップ
公開REST API

モデレーションの力を、
コードから呼び出す

Telmを自分のシステムに組み込みましょう。本番のアンチスパムエンジンで任意のテキストをチェックし、グループ設定とルールをコードから管理し、判定ジャーナルと分析を読み取れます——すべて、あなたが管理するキーで動くクリーンなREST API経由で。

  • 安定版REST v1
  • 全プランでスパムチェック
  • ウェブフック込み
$あなたのコードtk_live_…あなたのAPIキーTelmエンジンあなたのグループ

最初の呼び出しは30秒で

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

1リクエストで、本番エンジンから1つの判定を——スコアと、発火した理由とともに。ルールベースのチェックなら、レスポンスは1秒を大きく下回って届きます。

APIでできること

スパムとユーザーのチェック

Telmのグループを守るのと同じエンジンに任意のテキストを通せます——単発の呼び出し、最大20件のバッチ、そしてCASおよびTelm独自のデータセットに対するユーザースクリーニング。

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

グループと設定

保護設定の読み取りと更新、カスタムモデレーションルールとホワイトリストの管理を——1つのグループでも、多数のグループ群でも行えます。

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

ジャーナルと分析

エンジンの各判定を、判定結果・スコア・発火したルールとともに読み取り、日次の分析データ系列を取得し、自分のクォータ使用量を追跡できます。

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

ウェブフックの管理

ウェブフックのエンドポイントを作成・管理し、テストpingを送信し、配信履歴を確認できます——すべてAPI経由で。

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

箱に刷り込まれた、正直な上限

プラン1日あたりの呼び出しレート制限APIアクセス
Free10060/minスパムチェック
Pro10 000600/minフルAPI+ウェブフック
Business50 0001 800/minフルAPI+ウェブフック

上限はキー単位ではなくアカウント単位で適用されます。すべてのレスポンスに X-Quota-Limit、X-Quota-Used、X-Quota-Reset ヘッダーが載り、上限に達すると Retry-After 付きのクリーンな429が返ります——不意打ちはありません。

あるべき姿で作られたキー

表示は一度、保存はハッシュ

完全なキーが表示されるのは作成時のちょうど一度だけ。Telmが保存するのはハッシュのみで、私たちを含め誰もあなたのキーを読み戻せません。

read/write のスコープ

キーはreadとwriteのスコープを持ちます。レポート用スクリプトにはread-onlyキーを渡せば、物理的にどの設定も変更できません。

即時失効

ダッシュボードから任意のキーを失効させれば、直ちに使えなくなります。アカウント単位のキルスイッチで、すべてのAPIアクセスを一度に凍結することも可能です。

フルAPIはProとBusinessに

フルAPIとウェブフックはProとBusinessに含まれます。スパムチェックは全プラン——Freeを含む——で、日次クォータの範囲内で利用できます。

同じエンジンを、いまあなたの手の内に

公開APIは、Telmのボットを動かしているのと同じモデレーションエンジンをそのまま公開します——簡略化した模造品ではありません。/spam/check にテキストをPOSTすると、あなたのグループが使っているのと同一のパイプラインを通ります——レピュテーションのシグナル、ルール、そしてオプションでAI分類器。つまりTelmの判断をどこにでも組み込めるということです——サポートフォーム、自作のボット、コメント欄、社内ツールに。

チェックにとどまらず、APIはあなたのグループをコードとして管理します。保護設定の読み取りと更新、モデレーションルールの作成、ホワイトリストの保守——ダッシュボードと同じ操作を、スクリプト化して行えます。数十のコミュニティを運営する代理店なら、数十回のクリックではなく1つのループでポリシー変更を展開できます。

履歴も一級市民です。ジャーナルのエンドポイントは、エンジンが下したすべての判定——判定結果、スコア、発火したルール、実行されたアクション——を、アーカイブ向けに設計されたカーソルページネーションとともに返します。分析エンドポイントと組み合わせれば、グループの実データの上にコンプライアンス用アーカイブ、社内ダッシュボード、アラートを構築できます。

認証はあえて退屈に作ってあります。ダッシュボードで作成するbearerキーは、一度だけ表示され、ハッシュ化して保存され、read/write のスコープと即時失効を備えます。すべてのレスポンスにクォータ用ヘッダーが載るので、連携先は自分の状況をつねに把握できます。

よくある質問

API アクセスが含まれるのはどのプランですか?

スパムチェック(/spam/check)は、Free を含むすべてのプランで 1 日のクォータの範囲内で利用できます。グループ設定、ルール、ジャーナル、分析、ユーザースクリーニング、Webhook を含むフル API は、Pro と Business に含まれます。

リクエストの上限は?

プラン別の 1 日のクォータは、Free 100 回、Pro 10,000 回、Business 50,000 回です。レート制限は、Free が毎分 60 リクエスト、Pro が 600、Business が 1,800 です。すべてのレスポンスに X-Quota-Limit、X-Quota-Used、X-Quota-Reset ヘッダーが含まれます。

API キーはどうやって取得しますか?

ダッシュボードの Settings → API & Webhooks で取得できます。キーが表示されるのは作成時の一度だけで、保存されるのはハッシュのみです。有効なキーは最大 10 個まで持つことができ、読み取り専用に制限したり、いつでも即座に失効させたりできます。

API から AI 分類器を使えますか?

はい、Pro と Business で使えます。/spam/check リクエストに include_ai を追加すると、AI チェックごとに別枠の 1 日の API 枠を消費します(Pro 1,000 回、Business 10,000 回)。Free では、API によるスパムチェックはルールのみで行われます。この枠は API 呼び出しにのみ適用され、Telegram グループ内の AI モデレーションはすべてのプランに含まれています。

OpenAPI 仕様はありますか?

はい。機械可読な OpenAPI 3.1 の完全な仕様を開発者向けドキュメントとあわせて公開しているので、クライアントの生成や各種ツールへの組み込みに使えます。

始める準備はできましたか?

今日からコミュニティを保護しましょう。無料プランあり。