นำเข้าเวอร์ชัน Workflow

นำเข้าเวอร์ชัน Workflow

รองรับการอัปโหลดไฟล์ .flow เพื่อแทนที่การตั้งค่า Workflow ปัจจุบัน และบันทึกเป็นเวอร์ชันใหม่

อินเทอร์เฟซนี้ใช้ API Key ของ Workflow เป้าหมายในการยืนยันตัวตน และอนุญาตให้เรียกใช้ได้เฉพาะ Workflow ที่เปิดสิทธิ์การจัดการเวอร์ชันเท่านั้น

วิธีการร้องขอ

POST

URL สำหรับร้องขอ

https://api.${endpoint}/v1/workflow/version/import

การยืนยันตัวตนในการร้องขอ

ดูรายละเอียดได้ที่คำอธิบายวิธีการยืนยันตัวตนใน API Overview โปรดใช้ API Key ของ Workflow เป้าหมายเป็น token

การร้องขอ

ตัวอย่างการร้องขอ

curl -X POST 'https://api.${endpoint}/v1/workflow/version/import' \ -H 'Authorization: Bearer ${token}' \ -F 'file=@/path/to/workflow.flow' \ -F 'versionDesc=Update workflow nodes'
                      
                      curl -X POST 'https://api.${endpoint}/v1/workflow/version/import' \
  -H 'Authorization: Bearer ${token}' \
  -F 'file=@/path/to/workflow.flow' \
  -F 'versionDesc=Update workflow nodes'

                    
บล็อกโค้ดนี้ในหน้าต่างลอย

Header สำหรับร้องขอ

ฟิลด์ ประเภท คำอธิบาย
Authorization Bearer ${token} ใช้ API Key ของ Workflow เป้าหมายในการยืนยันตัวตนของการเรียกใช้
Content-Type multipart/form-data ฟอร์มสำหรับอัปโหลดไฟล์

พารามิเตอร์การร้องขอ (Form Data)

พารามิเตอร์ ประเภท คำอธิบาย required
file File ไฟล์ .flow true
versionDesc String คำอธิบายเวอร์ชัน false

การตอบกลับ

เนื้อหาการตอบกลับ

{ "code": 0, "message": "OK", "data": { "botId": "workflow-xxxx", "botType": "FLOW_AGENT", "version": "v2", "warning": null } }
                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "botId": "workflow-xxxx",
    "botType": "FLOW_AGENT",
    "version": "v2",
    "warning": null
  }
}

                    
บล็อกโค้ดนี้ในหน้าต่างลอย

การตอบกลับเมื่อสำเร็จ

ฟิลด์ ประเภท คำอธิบาย
botId String ID ของ Workflow เป้าหมาย
botType String ประเภท Bot
version String หมายเลขเวอร์ชันที่บันทึก และกลายเป็นเวอร์ชันปัจจุบันในเวลาเดียวกัน
warning String ข้อความเตือนในการนำเข้า หากไม่มีจะเป็น null

การตอบกลับเมื่อผิดพลาด

ฟิลด์ ประเภท คำอธิบาย
code int รหัสข้อผิดพลาด
message string ข้อความแสดงข้อผิดพลาด

รหัสสถานะ

รหัสสถานะ คำอธิบาย
200 สำเร็จ
400 พารามิเตอร์ไม่ถูกต้อง
401 ไม่ได้รับอนุญาต
403 สิทธิ์ไม่เพียงพอ หรือ API Key ยังไม่ได้เปิดสิทธิ์การจัดการเวอร์ชัน
429 คำขอถี่เกินไป
500 ข้อผิดพลาดของเซิร์ฟเวอร์