API för uppgiftshantering

Den här sidan dokumenterar alla tillgängliga API-endpoints för hantering av uppgifter i TikMatrix.

Skapa uppgift

Skapa en ny uppgift för en eller flera enheter eller användarnamn.

• Endpoint: POST /api/v1/task
• Content-Type: application/json

Parametrar för begäran

API:et stöder två lägen för att skapa uppgifter:

Läge 1: Enhetsbaserat - Använd serials för att skapa uppgifter för enheter Läge 2: Användarnamnbaserat - Använd usernames för att skapa uppgifter direkt för specifika konton

Parameter	Typ	Krävs	Beskrivning
serials	string[]	Villkorligt	Array av enhetens serienummer (krävs om usernames inte anges)
usernames	string[]	Villkorligt	Array av användarnamn för att skapa uppgifter för (krävs om serials inte anges). När detta anges skapas uppgifter direkt för dessa konton.
script_name	string	Ja	Namnet på scriptet som ska köras
script_config	object	Ja	Konfigurationsparametrar för scriptet (se script-specifik dokumentation)
enable_multi_account	boolean	Nej	Aktivera multi-konto-läge (standard: false). Endast tillämpligt i enhetsbaserat läge.
start_time	string	Nej	Schemalagd starttid i "HH:MM"-format
close_app	boolean	Nej	Om mål-appen stängs (tvångsstoppas) när uppgiften är klar (standard: true). Sätt false för att låta appen fortsätta köra efter att uppgiften är klar.
platform	string	Nej	Målplattform (tiktok eller instagram). Används endast av TikMatrix Pro; ignoreras av enplattformsbyggen.

Stödda scripts

Script-namn	Beskrivning	Dokumentation
post	Publicera videos eller bilder till TikTok/Instagram	Konfiguration av post-script
follow	Följ eller sluta följa användare	Konfiguration av follow-script
unfollow	Sluta följa användare	Konfiguration av unfollow-script
account_warmup	Värm upp konton	Konfiguration av account warmup-script
comment	Kommentera inlägg	Konfiguration av comment-script
login	Logga in på konto	Konfiguration av login-script
profile	Uppdatera profil	Konfiguration av profil-script
match_account	Matcha konton på enhet	Konfiguration av kontomatchnings-script
like	Gilla inlägg	Konfiguration av like-script
view	Visa ett inlägg under en varaktighet	Konfiguration av view-script
favorite	Spara ett inlägg till favoriter	Konfiguration av favorite-script
repost	Dela om TikTok-videor	Konfiguration av repost-script
message	Skicka direktmeddelande	Konfiguration av message-script
follow_suggested	Följ föreslagna konton	Konfiguration av follow suggested-script

Exempel

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
    }
  }'

Hålla appen öppen efter uppgiften

Som standard tvångsstoppas mål-appen när uppgiften är klar, för att spegla appens beteende och frigöra enhetsresurser. Skicka "close_app": false för att låta appen fortsätta köra efter att uppgiften är klar — användbart för att kedja uppgifter eller granska resultatet på enheten:

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
  }'

För detaljerade script_config-parametrar och fler exempel, se Konfiguration av post-script och Konfiguration av follow-script.

Svar

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

Lista uppgifter

Fråga uppgifter med valfria filter.

• Endpoint: GET /api/v1/task

Parameter	Typ	Krävs	Beskrivning
status	integer	Nej	Filtrera efter status (0=pending, 1=running, 2=completed, 3=failed)
serial	string	Nej	Filtrera efter enhetens serienummer
script_name	string	Nej	Filtrera efter scriptnamn
source	string	Nej	Filtrera efter källa ("ui" eller "api")
page	integer	Nej	Sidnummer (standard: 1)
page_size	integer	Nej	Objekt per sida (standard: 20, max: 100)

Hämta uppgiftsdetaljer

Hämta detaljerad information om en specifik uppgift.

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

Ta bort uppgift

Ta bort en uppgift. Om uppgiften körs kommer den att stoppas först.

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

Batch-borttagning av uppgifter

Ta bort flera uppgifter samtidigt. Körande uppgifter kommer att stoppas först.

• Endpoint: DELETE /api/v1/task/batch
• Body: { "task_ids": [1, 2, 3] }

Stoppa uppgift

Stoppa en körande uppgift.

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

Försök igen med misslyckad uppgift

Försök igen med en misslyckad uppgift.

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

Försök igen med alla misslyckade uppgifter

Försök igen med alla misslyckade uppgifter samtidigt.

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

Hämta uppgiftsstatistik

Hämta statistik om alla uppgifter.

• Endpoint: GET /api/v1/task/stats
• Svar: Returnerar totalt, pending, running, completed och failed antal.

Kontrollera API-licens

Kontrollera om din licens stöder API-åtkomst.

• Endpoint: GET /api/v1/license/check
• Obs: Starter-planen returnerar felkod 40301. Pro, Team och Business-planer har API-åtkomst.