API керування задачами

Ця сторінка документує всі доступні кінцеві точки API для керування задачами в TikMatrix.

Створити задачу

Створіть нову задачу для одного чи кількох пристроїв або імен користувачів.

• Кінцева точка: POST /api/v1/task
• Content-Type: application/json

Параметри запиту

API підтримує два режими для створення задач:

Режим 1: на основі пристрою — використовуйте serials, щоб створити задачі для пристроїв Режим 2: на основі імені користувача — використовуйте usernames, щоб створити задачі безпосередньо для конкретних акаунтів

Параметр	Тип	Обов'язковий	Опис
serials	string[]	Умовний	Масив серійних номерів пристроїв (обов'язковий, якщо не надано usernames)
usernames	string[]	Умовний	Масив імен користувачів, для яких створюються задачі (обов'язковий, якщо не надано serials). Якщо надано, задачі створюються безпосередньо для цих акаунтів.
script_name	string	Так	Назва скрипту для виконання
script_config	object	Так	Параметри конфігурації для скрипту (див. документацію конкретного скрипту)
enable_multi_account	boolean	Ні	Увімкнути режим кількох акаунтів (за замовчуванням: false). Застосовується лише в режимі на основі пристрою.
start_time	string	Ні	Запланований час початку у форматі «ГГ:ХХ»
close_app	boolean	Ні	Чи закривати (примусово зупиняти) цільовий застосунок після завершення задачі (за замовчуванням: true). Встановіть false, щоб залишити застосунок працювати після завершення задачі.
platform	string	Ні	Цільова платформа (tiktok або instagram). Використовується лише TikMatrix Pro; ігнорується збірками для однієї платформи.
force	boolean	Ні	Обходить захист готовності Auto WakeUp Agent (uiautomator) (за замовчуванням: false). Коли агент вимкнено в Налаштуваннях, створення задачі відхиляється з помилкою 40006, якщо force не встановлено на true — це відображає опцію «Продовжити все одно» в інтерфейсі десктопної програми.

Підтримувані скрипти

Назва скрипту	Опис	Документація
post	Опублікувати відео чи зображення в TikTok/Instagram	Конфігурація скрипту Post
follow	Підписатися або відписатися від користувачів	Конфігурація скрипту Follow
unfollow	Відписатися від користувачів	Конфігурація скрипту Unfollow
account_warmup	Прогріти акаунти	Конфігурація скрипту Account Warmup
comment	Опублікувати новий коментар до дописів	Конфігурація скрипту Comment
boost_comment	Вподобати / відповісти на наявні коментарі	Конфігурація скрипту Boost Comment (Reply)
login	Увійти в акаунт	Конфігурація скрипту Login
profile	Оновити профіль	Конфігурація скрипту Profile
match_account	Зіставити акаунти на пристрої	Конфігурація скрипту Match Account
like	Вподобати дописи	Конфігурація скрипту Like
view	Переглянути допис протягом певного часу	Конфігурація скрипту View
favorite	Зберегти допис в Обране	Конфігурація скрипту Favorite
repost	Репостити відео TikTok	Конфігурація скрипту Repost
message	Надіслати прямі повідомлення	Конфігурація скрипту Message
follow_suggested	Підписатися на рекомендовані акаунти	Конфігурація скрипту Follow Suggested

Приклад

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": "Check out my new video! #viral #fyp",
      "material_list": ["C:/Videos/video1.mp4"],
      "upload_wait_time": 60
    }
  }'

Детальні параметри script_config та більше прикладів див. у Конфігурації скрипту Post та Конфігурації скрипту Follow.

Залишення застосунку відкритим після задачі

За замовчуванням цільовий застосунок примусово зупиняється, коли задача завершується, — і щоб відобразити поведінку в самому застосунку, і щоб звільнити ресурси пристрою. Передайте "close_app": false, щоб залишити застосунок працювати після завершення задачі — корисно під час ланцюжка задач або перевірки результату на пристрої:

curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "serials": ["device_serial_1"],
    "script_name": "like",
    "script_config": {
      "target_post_url": "https://www.tiktok.com/@user/video/123"
    },
    "close_app": false
  }'

Відповідь

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

Auto WakeUp Agent вимкнено

Коли Auto WakeUp Agent вимкнено в Налаштуваннях, створення задачі відхиляється за замовчуванням — так само як попередження в інтерфейсі десктопної програми — оскільки створені задачі ніколи б не виконалися, доки агент не буде знову увімкнено:

curl -X POST http://localhost:50809/api/v1/task \
  -H "Content-Type: application/json" \
  -d '{
    "serials": ["device_serial_1"],
    "script_name": "like",
    "script_config": { "target_post_url": "https://www.tiktok.com/@user/video/123" }
  }'

{
  "code": 40006,
  "message": "uiautomator (Auto WakeUp Agent) is disabled: created tasks will not execute until it is re-enabled in Settings. Pass \"force\": true to create anyway.",
  "data": null
}

Передайте "force": true, щоб все одно створити задачі (еквівалент «Продовжити все одно» в інтерфейсі).

Список задач

Запитуйте задачі з необов'язковими фільтрами.

• Кінцева точка: GET /api/v1/task

Параметр	Тип	Обов'язковий	Опис
status	integer	Ні	Фільтр за статусом (0=очікує, 1=виконується, 2=завершено, 3=невдало)
serial	string	Ні	Фільтр за серійним номером пристрою
script_name	string	Ні	Фільтр за назвою скрипту
source	string	Ні	Фільтр за джерелом ("ui" або "api")
page	integer	Ні	Номер сторінки (за замовчуванням: 1)
page_size	integer	Ні	Елементів на сторінку (за замовчуванням: 20, максимум: 100)

Отримати деталі задачі

Отримайте детальну інформацію про конкретну задачу.

• Кінцева точка: GET /api/v1/task/{task_id}

Видалити задачу

Видаліть задачу. Якщо задача виконується, її спочатку буде зупинено.

• Кінцева точка: DELETE /api/v1/task/{task_id}

Масове видалення задач

Видаліть кілька задач одночасно. Задачі, що виконуються, будуть спочатку зупинені.

• Кінцева точка: DELETE /api/v1/task/batch
• Body: { "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
• Відповідь: повертає загальну кількість, кількість очікуваних, виконуваних, завершених і невдалих.

Перевірити ліцензію API

Перевірте, чи підтримує ваша ліцензія доступ до API.

• Кінцева точка: GET /api/v1/license/check
• Примітка: план Starter повертає код помилки 40301. Плани Pro, Team і Business мають доступ до API.