API Manajemen Tugas
Halaman ini mendokumentasikan semua endpoint API yang tersedia untuk mengelola tugas TikMatrix.
Membuat Tugas
Membuat tugas baru untuk satu atau beberapa perangkat atau username.
- Endpoint:
POST /api/v1/task - Content-Type:
application/json
Parameter Permintaan
API mendukung dua mode untuk membuat tugas:
Mode 1: Mode Perangkat - Gunakan serials untuk membuat tugas untuk perangkat
Mode 2: Mode Username - Gunakan usernames untuk langsung membuat tugas untuk akun tertentu
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| serials | string[] | Wajib bersyarat | Array nomor seri perangkat (wajib jika usernames tidak disediakan) |
| usernames | string[] | Wajib bersyarat | Array username (wajib jika serials tidak disediakan). Ketika parameter ini disediakan, tugas dibuat langsung untuk akun-akun ini. |
| script_name | string | Ya | Nama script yang akan dieksekusi |
| script_config | object | Ya | Parameter konfigurasi untuk script (lihat dokumentasi script terkait) |
| enable_multi_account | boolean | Tidak | Apakah mengaktifkan mode multi-akun (default: false). Hanya berlaku dalam mode perangkat. |
| start_time | string | Tidak | Waktu eksekusi terjadwal, format "HH:MM" |
| close_app | boolean | Tidak | Apakah aplikasi target ditutup (dihentikan paksa) setelah tugas selesai (default: true). Atur false untuk membiarkan aplikasi tetap berjalan setelah selesai. |
| platform | string | Tidak | Platform target (tiktok atau instagram). Hanya digunakan oleh TikMatrix Pro; diabaikan oleh build platform tunggal. |
Script yang Didukung
| Nama Script | Deskripsi | Dokumentasi |
|---|---|---|
| post | Posting video atau gambar ke TikTok/Instagram | Konfigurasi Script Post |
| follow | Mengikuti atau berhenti mengikuti pengguna | Konfigurasi Script Follow |
| unfollow | Berhenti mengikuti pengguna | Konfigurasi Script Unfollow |
| account_warmup | Memanaskan akun | Konfigurasi Script Account Warmup |
| comment | Komentar pada postingan | Konfigurasi Script Comment |
| login | Masuk ke akun | Konfigurasi Script Login |
| profile | Perbarui profil | Konfigurasi Script Profil |
| match_account | Cocokkan akun di perangkat | Konfigurasi Script Pencocokan Akun |
| like | Suka posting | Konfigurasi Script Like |
| view | Lihat posting untuk durasi tertentu | Konfigurasi Script View |
| favorite | Simpan posting ke Favorit | Konfigurasi Script Favorite |
| repost | Bagikan kembali video TikTok | Konfigurasi Script Repost |
| message | Kirim pesan langsung | Konfigurasi Script Message |
| follow_suggested | Ikuti akun yang disarankan | Konfigurasi Script Follow Suggested |
Contoh
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": "Lihat video baru saya! #trending #fyp",
"material_list": ["C:/Videos/video1.mp4"],
"upload_wait_time": 60
}
}'
Membiarkan aplikasi tetap terbuka setelah tugas
Secara default, aplikasi target dihentikan paksa saat tugas selesai, agar sesuai dengan perilaku aplikasi dan membebaskan sumber daya perangkat. Kirim "close_app": false untuk membiarkan aplikasi tetap berjalan setelah selesai — berguna untuk merangkai tugas atau memeriksa hasil di perangkat:
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
}'
Untuk parameter detail script_config dan lebih banyak contoh, lihat Konfigurasi Script Post.
Response
{
"code": 0,
"message": "success",
"data": {
"task_ids": [101, 102],
"created_count": 2
}
}
Daftar Tugas
Query tugas dengan kondisi filter opsional.
- Endpoint:
GET /api/v1/task
| Parameter | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| status | integer | Tidak | Filter berdasarkan status (0=pending, 1=running, 2=completed, 3=failed) |
| serial | string | Tidak | Filter berdasarkan nomor seri perangkat |
| script_name | string | Tidak | Filter berdasarkan nama script |
| source | string | Tidak | Filter berdasarkan sumber ("ui" atau "api") |
| page | integer | Tidak | Nomor halaman (default: 1) |
| page_size | integer | Tidak | Jumlah item per halaman (default: 20, maksimal: 100) |
Dapatkan Detail Tugas
Dapatkan informasi detail untuk tugas tertentu.
- Endpoint:
GET /api/v1/task/{task_id}
Hapus Tugas
Hapus tugas. Jika tugas sedang berjalan, akan mencoba menghentikannya terlebih dahulu.
- Endpoint:
DELETE /api/v1/task/{task_id}
Hapus Tugas Secara Batch
Hapus beberapa tugas sekaligus, tugas yang sedang berjalan akan dihentikan terlebih dahulu.
- Endpoint:
DELETE /api/v1/task/batch - Request Body:
{ "task_ids": [1, 2, 3] }
Hentikan Tugas
Hentikan tugas yang sedang berjalan.
- Endpoint:
POST /api/v1/task/{task_id}/stop
Coba Lagi Tugas yang Gagal
Coba lagi satu tugas yang gagal.
- Endpoint:
POST /api/v1/task/{task_id}/retry
Coba Lagi Semua Tugas yang Gagal
Coba lagi semua tugas yang gagal sekaligus.
- Endpoint:
POST /api/v1/task/retry-all
Dapatkan Statistik Tugas
Dapatkan data statistik keseluruhan tugas.
- Endpoint:
GET /api/v1/task/stats - Response: Mengembalikan jumlah total, pending, running, completed, failed.
Periksa Lisensi API
Periksa apakah lisensi Anda mendukung akses API.
- Endpoint:
GET /api/v1/license/check - Catatan: Paket Starter akan mengembalikan kode error 40301; paket Pro/Team/Business dapat mengakses API.