ChBot Hub API 説明

OPTIONS/api/{*rest}

/api/* のプリフライト用です。常に 200 OK を返します。

GET/api/devices

接続中のクライアント名を取得します。names は重複なし、文字列昇順です。

入力

なし。

出力

{
  "ok": true,
  "names": ["178e1", "bot"]
}

GET/api/device-display-names

接続中端末と、Hub が知っている表示名・ADB ID一覧を取得します。別名として GET /api/device_display_names も同じ処理です。ADB IDは、HubからADBトンネル経由で照会できたAndroidクライアントにだけ設定されます。

入力

なし。

出力

{
  "ok": true,
  "devices": [
    { "name": "178e1", "displayName": "端末A", "adbId": "R9XXXXXXXXX" },
    { "name": "bot", "displayName": null, "adbId": null }
  ],
  "displayNames": {
    "178e1": "端末A"
  },
  "adbIds": {
    "178e1": "R9XXXXXXXXX"
  }
}

POST/api/command

任意の端末コマンドを送ります。

リクエスト全体の形式

{
  "device": "送信先クライアント名",
  "command": "コマンド名",
  "timeoutMs": 15000,
  "payload": {
    "コマンドごとの入力名": "値"
  }
}

リクエストパラメータ

リクエスト例

{
  "device": "178e1",
  "command": "GET_ROOT_STATUS",
  "timeoutMs": 15000
}

成功レスポンス（HTTPレスポンス全体）

{
  "ok": true,
  "id": "20260812134800123",
  "device": "178e1",
  "command": "GET_ROOT_STATUS",
  "reply": {
    "rooted": false,
    "suAvailable": false,
    "suOutput": "",
    "signals": [],
    "note": "Root detection is heuristic and can be hidden by root-hiding tools."
  }
}

対応コマンド

GET_ROOT_STATUS の reply

GET/api/ip

端末の IP 情報を取得します。

クエリパラメータ

GET /api/ip?device=178e1&timeoutMs=15000

成功レスポンス（HTTPレスポンス全体）:

{
  "ok": true,
  "id": "20260812134800123",
  "device": "178e1",
  "reply": "..."
}

GET/api/battery

端末のバッテリー情報を取得します。

クエリパラメータ

GET /api/battery?device=178e1&timeoutMs=15000

成功レスポンス（HTTPレスポンス全体）:

{
  "ok": true,
  "id": "20260812134800123",
  "device": "178e1",
  "reply": "{\"level\":85,\"temperatureCelsius\":32.4,\"chargingStatus\":\"charging\"}"
}

/api/battery は reply を文字列のまま返します。/api/command に GET_BATTERY を指定した場合は、同じ端末応答がJSONとして読めれば reply はobjectになります。

POST/api/change_ip

端末の IP 変更処理を実行します。root端末では従来どおりアプリへコマンドを中継します。非root端末ではHubが対応するADB IDを使ってモバイルデータ通信をOFFにし、0.8秒後にONへ戻して、端末のモバイル回線から有効なIPアドレスを取得できるまで応答を待ちます。JSON body の値がある場合は body がクエリより優先されます。

JSON body パラメータ

{
  "device": "178e1",
  "timeoutMs": 90000
}

クエリ形式

POST /api/change_ip?device=178e1&timeoutMs=90000

成功レスポンス（HTTPレスポンス全体）:

{
  "ok": true,
  "id": "20260812134800123",
  "device": "178e1",
  "reply": "203.0.113.10"
}

非root端末でADB IDが未取得、モバイルデータ通信を切り替えられない、またはタイムアウトまでに有効なIPを取得できない場合はエラーを返します。WebSocket中継で受け付けた CHANGE_IP にも同じ分岐を適用します。

POST/api/post

端末へ POST コマンドを送り、端末側から指定 URL へ HTTP POST させます。

JSON body パラメータ

リクエスト例

{
  "device": "178e1",
  "url": "https://example.com",
  "headers": { "User-Agent": "..." },
  "body": "...",
  "timeoutMs": 20000,
  "mobile": true
}

成功レスポンス（HTTPレスポンス全体）:

{
  "ok": true,
  "id": "20260812134800123",
  "device": "178e1",
  "reply": {}
}

reply は JSON または文字列です。