メインコンテンツまでスキップ

タスク管理 API

このページでは、TikMatrix でタスクを管理するための利用可能なすべての API エンドポイントについて説明します。

タスクの作成​

1つまたは複数のデバイスまたはユーザー名用の新しいタスクを作成します。

  • エンドポイント： POST /api/v1/task
  • Content-Type： application/json

リクエストパラメータ​

API はタスク作成の2つのモードをサポートしています：

モード 1：デバイスベース - serials を使用してデバイス用のタスクを作成 モード 2：ユーザー名ベース - usernames を使用して特定のアカウント用のタスクを直接作成

パラメータ型必須説明
serialsstring[]条件付きデバイスシリアル番号の配列（usernames が提供されていない場合は必須）
usernamesstring[]条件付きタスクを作成するユーザー名の配列（serials が提供されていない場合は必須）。提供された場合、これらのアカウント用にタスクが直接作成されます。
script_namestringはい実行するスクリプトの名前
script_configobjectはいスクリプトの設定パラメータ（スクリプト固有のドキュメントを参照）
enable_multi_accountbooleanいいえマルチアカウントモードを有効にする（デフォルト：false）。デバイスベースモードでのみ適用。
start_timestringいいえ"HH:MM" 形式のスケジュールされた開始時刻

サポートされているスクリプト​

スクリプト名説明ドキュメント
postTikTok/Instagram に動画または画像を公開投稿スクリプト設定
followユーザーをフォローまたはアンフォローフォロースクリプト設定

例​

curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "serials": ["device_serial_1"],
    "script_name": "post",
    "script_config": {
      "content_type": 0,
      "captions": "新しい動画をチェック！#バイラル #fyp",
      "material_list": ["C:/Videos/video1.mp4"],
      "upload_wait_time": 60
    }
  }'

詳細な script_config パラメータとその他の例については、投稿スクリプト設定 および フォロースクリプト設定 を参照してください。

レスポンス​

{
  "code": 0,
  "message": "success",
  "data": {
    "task_ids": [101, 102],
    "created_count": 2
  }
}

タスクのリスト​

オプションのフィルタを使用してタスクをクエリします。

  • エンドポイント： GET /api/v1/task
パラメータ型必須説明
statusintegerいいえステータスでフィルタ（0=pending、1=running、2=completed、3=failed）
serialstringいいえデバイスシリアルでフィルタ
script_namestringいいえスクリプト名でフィルタ
sourcestringいいえソースでフィルタ（"ui" または "api"）
pageintegerいいえページ番号（デフォルト：1）
page_sizeintegerいいえページあたりのアイテム数（デフォルト：20、最大：100）

タスクの詳細を取得​

特定のタスクに関する詳細情報を取得します。

  • エンドポイント： GET /api/v1/task/{task_id}

タスクの削除​

タスクを削除します。タスクが実行中の場合、最初に停止されます。

  • エンドポイント： DELETE /api/v1/task/{task_id}

タスクの一括削除​

複数のタスクを一度に削除します。実行中のタスクは最初に停止されます。

  • エンドポイント： DELETE /api/v1/task/batch
  • ボディ： { "task_ids": [1, 2, 3] }

タスクの停止​

実行中のタスクを停止します。

  • エンドポイント： POST /api/v1/task/{task_id}/stop

失敗したタスクの再試行​

失敗したタスクを再試行します。

  • エンドポイント： POST /api/v1/task/{task_id}/retry

すべての失敗したタスクの再試行​

すべての失敗したタスクを一度に再試行します。

  • エンドポイント： POST /api/v1/task/retry-all

タスク統計の取得​

すべてのタスクに関する統計を取得します。

  • エンドポイント： GET /api/v1/task/stats
  • レスポンス： total、pending、running、completed、failed のカウントを返します。

API ライセンスの確認​

ライセンスが API アクセスをサポートしているか確認します。

  • エンドポイント： GET /api/v1/license/check
  • 注意： Starter プランはエラーコード 40301 を返します。Pro、Team、Business プランは API アクセスがあります。