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

Обновление списка скриптов\nTask API теперь включает follow_back и scrape_users; repost работает на TikTok/Threads, а message — только на Threads. Подробности см. на локализованных страницах скриптов.\n:::

На этой странице описаны все доступные API endpoint'ы для управления задачами в TikMatrix.

Создание задачи

Создайте новую задачу для одного или нескольких устройств или имён пользователей.

Endpoint: 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` или `threads`). Используется только TikMatrix Pro; в сборках для одной платформы игнорируется.

Поддерживаемые скрипты

Название скрипта	Описание	Документация
post	Публикация видео или изображений в TikTok/Instagram	Конфигурация скрипта Post
follow	Подписаться или отписаться от пользователей	Конфигурация скрипта Follow
unfollow	Отписаться от пользователей	Конфигурация скрипта Unfollow
account_warmup	Прогрев аккаунтов	Конфигурация скрипта Account Warmup
comment	Комментировать публикации	Конфигурация скрипта Comment
login	Войти в аккаунт	Конфигурация скрипта входа
profile	Обновить профиль	Конфигурация скрипта профиля
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": "Посмотрите моё новое видео! #популярное #рекомендации",
      "material_list": ["C:/Videos/video1.mp4"],
      "upload_wait_time": 60
    }
  }'

Оставить приложение открытым после задачи

По умолчанию целевое приложение принудительно останавливается по завершении задачи, чтобы соответствовать поведению программы и освобождать ресурсы устройства. Передайте "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
  }'

Подробные параметры script_config и дополнительные примеры см. в разделе Конфигурация скрипта Post.

Ответ

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

Список задач

Запрос задач с опциональными фильтрами.

Endpoint: GET /api/v1/task

Параметр	Тип	Обязательно	Описание
status	integer	Нет	Фильтр по статусу (0=pending, 1=running, 2=completed, 3=failed)
serial	string	Нет	Фильтр по серийному номеру устройства
script_name	string	Нет	Фильтр по имени скрипта
source	string	Нет	Фильтр по источнику ("ui" или "api")
page	integer	Нет	Номер страницы (по умолчанию: 1)
page_size	integer	Нет	Количество элементов на странице (по умолчанию: 20, макс: 100)

Детали задачи

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

Endpoint: GET /api/v1/task/{task_id}

Удалить задачу

Удаляет задачу. Если задача выполняется, сначала будет произведена попытка её остановить.

Endpoint: DELETE /api/v1/task/{task_id}

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

Удаляет несколько задач одновременно. Выполняющиеся задачи будут остановлены перед удалением.

Endpoint: DELETE /api/v1/task/batch
Тело запроса: { "task_ids": [1, 2, 3] }

Остановить задачу

Останавливает выполняющуюся задачу.

Endpoint: POST /api/v1/task/{task_id}/stop

Повтор попытки для неудачных задач

Повторно запустить одну неудачную задачу.

Endpoint: POST /api/v1/task/{task_id}/retry

Повторить все неудачные задачи

Запустить повторно все задачи, находящиеся в состоянии failed.

Endpoint: POST /api/v1/task/retry-all

Статистика задач

Получить статистику по всем задачам.

Endpoint: GET /api/v1/task/stats
Ответ: Возвращает количество total, pending, running, completed и failed.

Проверка лицензии для API

Проверить, поддерживает ли лицензия доступ к API.

Endpoint: GET /api/v1/license/check
Примечание: План Starter вернёт код ошибки 40301. Доступ предоставлен для Pro, Team и Business.

Создание задачи​

Параметры запроса​

Поддерживаемые скрипты​

Пример​

Оставить приложение открытым после задачи​

Ответ​

Список задач​

Детали задачи​

Удалить задачу​

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

Остановить задачу​

Повтор попытки для неудачных задач​

Повторить все неудачные задачи​

Статистика задач​

Проверка лицензии для API​