API จัดการงาน

หน้านี้รวบรวม endpoint ทั้งหมดสำหรับจัดการงานของ TikMatrix

สร้างงาน

สร้างงานใหม่สำหรับอุปกรณ์หรือบัญชีผู้ใช้หนึ่งรายการหรือหลายรายการ

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

พารามิเตอร์คำขอ

API รองรับการสร้างงาน 2 โหมด:

โหมด 1: โหมดอุปกรณ์ - ใช้ serials เพื่อสร้างงานให้เครื่องอุปกรณ์ โหมด 2: โหมด username - ใช้ usernames เพื่อสร้างงานให้บัญชีที่ระบุโดยตรง

พารามิเตอร์	ชนิด	จำเป็น	คำอธิบาย
serials	string[]	จำเป็นแบบมีเงื่อนไข	รายการ serial อุปกรณ์ (จำเป็นเมื่อไม่ส่ง `usernames`)
usernames	string[]	จำเป็นแบบมีเงื่อนไข	รายการ username (จำเป็นเมื่อไม่ส่ง `serials`) เมื่อส่งค่านี้ ระบบจะสร้างงานให้บัญชีเหล่านี้โดยตรง
script_name	string	ใช่	ชื่อสคริปต์ที่ต้องการรัน
script_config	object	ใช่	พารามิเตอร์การตั้งค่าของสคริปต์ (ดูเอกสารของแต่ละสคริปต์)
enable_multi_account	boolean	ไม่	เปิดโหมดหลายบัญชีหรือไม่ (ค่าเริ่มต้น: `false`) มีผลเฉพาะโหมดอุปกรณ์
start_time	string	ไม่	เวลาเริ่มงานตามกำหนด รูปแบบ `HH:MM`
close_app	boolean	ไม่	กำหนดว่าจะปิด (บังคับหยุด) แอปเป้าหมายหลังจากงานเสร็จหรือไม่ (ค่าเริ่มต้น: `true`) ตั้งเป็น `false` เพื่อให้แอปยังทำงานต่อหลังจากงานเสร็จ
platform	string	ไม่	แพลตฟอร์มเป้าหมาย (`tiktok` หรือ `instagram`) ใช้เฉพาะ TikMatrix Pro เท่านั้น รุ่นแพลตฟอร์มเดียวจะไม่สนใจค่านี้

สคริปต์ที่รองรับ

ชื่อสคริปต์	คำอธิบาย	เอกสาร
post	โพสต์วิดีโอหรือรูปภาพไปยัง TikTok/Instagram	การตั้งค่าสคริปต์โพสต์
follow	ติดตามผู้ใช้	การตั้งค่าสคริปต์ติดตาม
unfollow	เลิกติดตามผู้ใช้	การตั้งค่าสคริปต์เลิกติดตาม
account_warmup	วอร์มบัญชี	การตั้งค่าสคริปต์วอร์มบัญชี
comment	แสดงความคิดเห็นในโพสต์	การตั้งค่าสคริปต์คอมเมนต์
login	เข้าสู่ระบบบัญชี	การตั้งค่าสคริปต์เข้าสู่ระบบ
profile	อัปเดตโปรไฟล์	การตั้งค่าสคริปต์โปรไฟล์
match_account	จับคู่บัญชีในอุปกรณ์	การตั้งค่าสคริปต์จับคู่บัญชี
like	ให้ไลค์บนโพสต์	การตั้งค่าสคริปต์ไลค์
view	ดูโพสต์ในระยะเวลาที่กำหนด	การตั้งค่าสคริปต์ดู
favorite	บันทึกโพสต์ไปยังรายการโปรด	การตั้งค่าสคริปต์รายการโปรด
repost	แชร์วิดีโอ TikTok ใหม่	การตั้งค่าสคริปต์แชร์ใหม่
message	ส่งข้อความโดยตรง	การตั้งค่าสคริปต์ข้อความ
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	ไม่	กรองตาม serial อุปกรณ์
script_name	string	ไม่	กรองตามชื่อสคริปต์
source	string	ไม่	กรองตามแหล่งที่มา (`ui` หรือ `api`)
page	integer	ไม่	เลขหน้าผลลัพธ์ (ค่าเริ่มต้น: 1)
page_size	integer	ไม่	จำนวนรายการต่อหน้า (ค่าเริ่มต้น: 20, สูงสุด: 100)

ดูรายละเอียดงาน

ดึงรายละเอียดของงานตาม task_id

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

ลบงาน

ลบงาน หากงานกำลังรันอยู่ ระบบจะพยายามหยุดก่อน

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

ลบงานหลายรายการ

ลบหลายงานในครั้งเดียว โดยงานที่กำลังรันจะถูกหยุดก่อน

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

หยุดงาน

หยุดงานที่กำลังทำงานอยู่

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

ลองงานที่ล้มเหลวใหม่

ลองรันงานที่ล้มเหลวใหม่ 1 งาน

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

ลองงานที่ล้มเหลวทั้งหมดใหม่

ลองรันงานที่ล้มเหลวทั้งหมดใหม่ในครั้งเดียว

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

ดูสถิติงาน

ดูสถิติภาพรวมของงานทั้งหมด

Endpoint: GET /api/v1/task/stats
Response: จำนวน total, pending, running, completed, failed

ตรวจสอบสิทธิ์ API

ตรวจสอบว่าไลเซนส์ของคุณรองรับการใช้งาน API หรือไม่

Endpoint: GET /api/v1/license/check
หมายเหตุ: แผน Starter จะได้รหัสผิดพลาด 40301; แผน Pro/Team/Business สามารถใช้งาน API ได้

สร้างงาน​

พารามิเตอร์คำขอ​

สคริปต์ที่รองรับ​

ตัวอย่าง​

เปิดแอปค้างไว้หลังจบงาน​

การตอบกลับ​

แสดงรายการงาน​

ดูรายละเอียดงาน​

ลบงาน​

ลบงานหลายรายการ​

หยุดงาน​

ลองงานที่ล้มเหลวใหม่​

ลองงานที่ล้มเหลวทั้งหมดใหม่​

ดูสถิติงาน​

ตรวจสอบสิทธิ์ API​