API

Bot API インデックス

このページは API ディレクトリです。以下の JWT メソッドにはパラメータ/戻り値が含まれています。ランタイムメソッドについてはトピックを開いてください。「呼び出し方法」を参照して認証ヘッダーを確認してください。

呼び出し方法

クイックスタート : 適用 → 承認 → Bot Token をコピーします。
認証 : コンソール API はアカウント JWT を使用します。ランタイム API は Authorization: Bearer sbot_…。
API プレフィックスのように https://api.musuwa.com/api/v1 （ゲートウェイを使用してください。ここに SDK baseUrl をポイントします）。
Node SDK / Java SDK HTTP をラップします。または curl で呼び出します。

# Runtime (Bot Token)
curl -X POST "$API/bots/sendMessage" \
  -H "Authorization: Bearer $SOCHAT_BOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"chat_id":"<chat_id>","text":"hello"}'

# Console (account JWT)
curl -X GET "$API/bots/my" \
  -H "Authorization: Bearer $SOCHAT_USER_JWT"

Webhook の検証とポーリング： Webhook · ポーリング · ファイル。

開発者コンソールAPI (JWT)

アプリケーション、トークン、ウェブフック、配信 — 各エントリはパラメータ/戻り値をリストします; 認証はアカウントJWTです。

POST/api/v1/bots/applications

JWT

applicationsボットアプリケーションを提出

作成アプリケーションを提出; 承認後にのみトークンが発行されます。

認証: Authorization: Bearer <account JWT> (コンソールログイン; sbot_ トークンではありません)
必須: name (≤100), username (小文字で始まり、a-z0-9_、3–64、ユニーク)
Optional: description, avatar (https URL), scopes[] (default send/receive)
Returns: bot object with review_status=pending

GET/api/v1/bots/my

JWT

my私のボットを一覧表示

サインインしたアカウントのボットを一覧表示（レビュー/実行状況、トークンプレフィックス）。

認証: アカウント JWT
Returns: { items: [{ id, name, username, review_status, status, has_token, token_prefix, … }] }

GET/api/v1/bots/my/:id

JWT

:idボットの詳細

承認後の最初の読み取りで one_time_token が返される場合があります（読み取り後に破棄され、Redis TTL 7日）。

パス: id
返されるもの: プロフィール、編集された webhook、command_menus、has_token / token_prefix
含まれる場合があります one_time_token (一度表示され、その後破棄されます—すぐに保存してください)

PATCH/api/v1/bots/my/:id

JWT

:idボットプロファイルを更新

承認後に名前、アバター、説明、リンク、インライン/友達/プライバシー設定を更新します。

パス: id; review_status=approved の場合のみ
オプションのボディ: name, avatar, description, short_description, about, cover_url, links, contact
オプション: supports_inline_queries, friend_request_mode, group_privacy, …
username は自己編集不可; 更新されたボットを返します

POST/api/v1/bots/my/:id/webhook

JWT

webhookWebhookを設定

アカウントJWTでHTTPS Webhookを登録します（Bot Tokenは不要です）。

パス: id
必須: url (https; SSRFチェック済み)
配信に強く必要: secret_token
Optional: allowed_updates[], allowed_ips[], max_connections, drop_pending_updates
Sets delivery_mode=webhook; equivalent Token API: POST /bots/setWebhook

DELETE/api/v1/bots/my/:id/webhook

JWT

webhookWebhookを削除

Webhookを削除します; 配信モードはポーリング（getUpdates）になります。

パス: id
オプション: drop_pending_updates
返されるもの delivery_mode=polling; その後 POST /bots/getUpdates を使用します

GET/api/v1/bots/my/:id/deliveries

JWT

deliveries配信ログ

失敗した/デッドレターを含むページネートされたWebhook配信ステータス。

パス: id
クエリ: page (デフォルト 1), limit (1–100, デフォルト 20)
返されるもの: { items, pagination } 配信ステータスフィールド付き

POST/api/v1/bots/my/:id/regenerate-token

JWT

regenerate-tokenトークンを再生成

古いトークンは即座に無効になり、`one_time_token`が一度だけ表示されます。

パス: id; 承認されたボットが必要です
返却: { bot_id, one_time_token, token_prefix } — すぐに保存してください

GET/api/v1/bots/my/:id/metrics

JWT

metricsボットメトリクス

開発者コンソールの最近のコールボリューム、エラー、およびクォータの概要。

パスパラメータ: id (ボットID)
返却: メトリクスサマリーオブジェクト（フィールドはコンソールと共に進化します）

POST/api/v1/bots/my/:id/deliveries/:deliveryId/retry

JWT

retry配信を再試行

失敗した（または再試行可能な）Webhook配信を手動で再試行します。

パスパラメータ: id (ボットID), deliveryId (配信IDまたはupdate_id)
返却: 更新された配信ステータス

トピック別のランタイムAPI

パラメータ/戻り値のためにトピックを開きます。すべてAuthorization: Bearer sbot_…を必要とします。

プロフィールボットのプロフィールとコマンドメニューを読み取り、更新します。15 メソッド Webhook / ロングポーリングsetWebhook は getUpdates と競合します; ローカルポーリングの前に webhook を削除します。4 メソッド メッセージを送信するテキスト、メディア、位置情報、および関連する送信方法。16 メソッド 編集/削除/転送ボットが送信したメッセージを編集または削除; 転送およびコピー。5 メソッド ファイルfile_id を取得するためにアップロードし、その後 send* と共に使用します。3 メソッド インタラクティブ / インラインモードインラインキーボード、コールバック、およびインラインクエリ。2 メソッド チャットを読み取るチャットとメンバー情報を読み取る; ボットはアクティブな参加者である必要があります。5 メソッド チャットを書くチャットプロファイルとピンを更新する; 通常は管理者権限が必要です。6 メソッド ガバナンスキック、バン、アンバン（グループ管理者が必要です）。3 メソッド オーケストレーション仮想メンバーオーケストレーションAPI。2 メソッド