Skip to main content

API จัดการงาน

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

สร้างงาน

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

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

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

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

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

พารามิเตอร์ชนิดจำเป็นคำอธิบาย
serialsstring[]จำเป็นแบบมีเงื่อนไขรายการ serial อุปกรณ์ (จำเป็นเมื่อไม่ส่ง usernames)
usernamesstring[]จำเป็นแบบมีเงื่อนไขรายการ username (จำเป็นเมื่อไม่ส่ง serials) เมื่อส่งค่านี้ ระบบจะสร้างงานให้บัญชีเหล่านี้โดยตรง
script_namestringใช่ชื่อสคริปต์ที่ต้องการรัน
script_configobjectใช่พารามิเตอร์การตั้งค่าของสคริปต์ (ดูเอกสารของแต่ละสคริปต์)
enable_multi_accountbooleanไม่เปิดโหมดหลายบัญชีหรือไม่ (ค่าเริ่มต้น: false) มีผลเฉพาะโหมดอุปกรณ์
start_timestringไม่เวลาเริ่มงานตามกำหนด รูปแบบ HH:MM

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

ชื่อสคริปต์คำอธิบายเอกสาร
postโพสต์วิดีโอหรือรูปภาพไปยัง TikTok/Instagramการตั้งค่าสคริปต์โพสต์
followติดตามผู้ใช้การตั้งค่าสคริปต์ติดตาม
unfollowเลิกติดตามผู้ใช้การตั้งค่าสคริปต์เลิกติดตาม
account_warmupวอร์มบัญชีการตั้งค่าสคริปต์วอร์มบัญชี
commentแสดงความคิดเห็นในโพสต์การตั้งค่าสคริปต์คอมเมนต์
loginเข้าสู่ระบบบัญชีการตั้งค่าสคริปต์เข้าสู่ระบบ
profileอัปเดตโปรไฟล์การตั้งค่าสคริปต์โปรไฟล์
match_accountจับคู่บัญชีในอุปกรณ์การตั้งค่าสคริปต์จับคู่บัญชี

ตัวอย่าง

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

สำหรับรายละเอียด script_config เพิ่มเติม โปรดดู การตั้งค่าสคริปต์ Post

การตอบกลับ

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

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

ค้นหารายการงานพร้อมเงื่อนไขกรองแบบเลือกได้

  • Endpoint: GET /api/v1/task
พารามิเตอร์ชนิดจำเป็นคำอธิบาย
statusintegerไม่กรองตามสถานะ (0=pending, 1=running, 2=completed, 3=failed)
serialstringไม่กรองตาม serial อุปกรณ์
script_namestringไม่กรองตามชื่อสคริปต์
sourcestringไม่กรองตามแหล่งที่มา (ui หรือ api)
pageintegerไม่เลขหน้าผลลัพธ์ (ค่าเริ่มต้น: 1)
page_sizeintegerไม่จำนวนรายการต่อหน้า (ค่าเริ่มต้น: 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 ได้