เอกสารอ้างอิง API

การเชื่อมต่อบัญชี

รีเฟรชสถานะ runtime

ซิงก์สถานะ runtime ล่าสุดของผู้ให้บริการสำหรับบัญชี runtime_status รับเฉพาะค่ามาตรฐานของแพลตฟอร์ม: unknown, starting, running, stopping, stopped, reconnecting, disconnected, error ส่วน label เฉพาะของผู้ให้บริการจะถูก normalize ให้อยู่ในชุดค่านี้ก่อนคืนกลับ

POSThttps://api.unifyport.ai/v1/accounts/{account_id}/runtime/refresh

ช่องทางที่รองรับ

all

ก่อนเรียกใช้

ใช้ X-Api-Key ของ workspace เจ้าของทรัพยากรบนเซิร์ฟเวอร์ แทนค่าตัวอย่างทั้งหมดก่อนเรียกใช้

ตรวจสถานะการยืนยันตัวตนและ runtime ปัจจุบัน แล้วเลือกคำสั่งตามเป้าหมาย การเริ่ม หยุด รีเฟรช และเชื่อมต่อใหม่มีจุดประสงค์ต่างกัน การออฟไลน์เพียงอย่างเดียวไม่ได้หมายความว่าต้องยืนยันตัวตนใหม่

ที่มาของพารามิเตอร์
account_id
รับ data.id จากการสร้างหรือค้นหาบัญชี รหัสเป็นของ workspace ที่ระบุด้วย X-Api-Key ดูบัญชี

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

ส่วนหัว

X-Api-Key
stringจำเป็น

API key ของพื้นที่ทำงาน ระบบจะระบุพื้นที่ทำงานจากส่วนหัวนี้

Content-Type
stringจำเป็น

ใช้ application/json เมื่อต้องส่งเนื้อหาของคำขอเป็น JSON

พารามิเตอร์ใน path

account_id
stringจำเป็น

ตัวระบุที่ใช้ใน route ของ runtime

เนื้อหาของคำขอ

จุดเชื่อมต่อนี้รับออบเจ็กต์ JSON ว่าง โปรดส่ง {} ตามตัวอย่างคำขอ

ทำความเข้าใจผลลัพธ์

อ่าน runtime_status ที่รีเฟรชเพื่อทราบการเชื่อมต่อปัจจุบัน รีเฟรชสำเร็จไม่ได้หมายความว่าออนไลน์ เลือกคำสั่งถัดไปตามสถานะและคำแนะนำยืนยันตัวตนที่ส่งกลับ

การตอบกลับ 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "account_id": "acc_example",
    "runtime_status": "running"
  }
}

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

account_id
string

บัญชีของผู้ให้บริการที่การตอบกลับนี้อ้างถึง

provider
string

รหัสช่องทาง ใช้ค่าที่ API ส่งกลับโดยไม่แก้ไขในการเรียกครั้งต่อไป ดูค่าที่ API นี้คืนได้จาก enum ด้านล่าง

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp-protocol

action
string

การดำเนินการที่ร้องขอในการเรียกครั้งนี้

enum: refresh_status, start, stop, reconnect

operation_status
string

สถานะว่าการดำเนินการ runtime ได้รับการยอมรับหรือเสร็จสิ้น

runtime_status
string

สถานะ runtime ที่ปรับเป็นมาตรฐาน หนึ่งในค่า unknown, starting, running, stopping, stopped, reconnecting, disconnected หรือ error

enum: unknown, starting, running, stopping, stopped, reconnecting, disconnected, error

runtime_error
string

ข้อผิดพลาด runtime ของ provider เมื่อดำเนินการไม่สำเร็จ

auth_required
boolean

เมื่อเป็น true ให้ดำเนินขั้นตอนอนุญาตของช่องทางต่อ จะส่งค่านี้เมื่อช่องทางให้ข้อมูลสำหรับอนุญาต หรือมีขั้นตอนที่ยืนยันแล้วแต่ยังไม่เสร็จเท่านั้น การไม่มีฟิลด์หรือเป็น false ไม่ได้แปลว่าออนไลน์ ให้ดู runtime_status และอย่าอนุมานว่าต้องอนุญาตใหม่จาก disconnected เพียงอย่างเดียว API runtime ไม่ส่ง code, qrcode, auth_payload หรือ provider_data ให้ขอข้อมูลจาก API อนุญาตของช่องทาง

auth_status
string

สถานะอนุญาตที่อาจมี เช่น pending, awaiting_qr_scan หรือ passkey_required จะส่งเมื่อมีข้อมูลสำหรับอนุญาตหรือขั้นตอนที่ยืนยันแล้วว่ายังดำเนินอยู่ ทำตามคู่มือช่องทางเพื่อดำเนินการต่อ ดูสถานะและข้อมูลทั้งหมดจาก API อนุญาต และดูการเชื่อมต่อจาก runtime_status

การตอบกลับ

200

200 OK

คำขอสำเร็จ ดูตัวอย่างเนื้อหาตอบกลับด้านบน

400

Bad Request

เนื้อหาของคำขอ path หรือพารามิเตอร์ไม่ถูกต้อง

401

Unauthorized

ส่วนหัว X-Api-Key หายไปหรือไม่ถูกต้อง

409

Conflict

การดำเนินการขัดแย้งกับบัญชีของผู้ให้บริการหรือทรัพยากรที่มีอยู่

500

Internal Server Error

บริการพบข้อผิดพลาดที่ไม่คาดคิด

502

Bad Gateway

อะแดปเตอร์หรือ upstream provider ไม่สามารถทำรายการให้เสร็จได้

เมื่อคำขอล้มเหลว

ตรวจ HTTP, error.code/numeric_code และสถานะปัจจุบัน เก็บ request_id ตรวจคำสั่งและการรองรับของช่องทาง ทำขั้นตอนยืนยันตัวตนต่อเมื่อมีคำแนะนำชัดเจนว่าต้องทำ และตรวจสถานะก่อนลองใหม่ อ้างอิงรหัสข้อผิดพลาด

invalid_request · 10000 · 400
ตรวจฟิลด์บังคับ รูปแบบ และเงื่อนไขช่องทาง แล้วแก้คำขอ
missing_api_key · 11000 · 401
ตรวจ X-Api-Key และว่า workspace ยังใช้งานอยู่
invalid_api_key · 11001 · 401
ตรวจ X-Api-Key และว่า workspace ยังใช้งานอยู่
provider_not_ready · 30009 · 409
ตรวจ HTTP, error.code/numeric_code และสถานะปัจจุบัน เก็บ request_id ตรวจคำสั่งและการรองรับของช่องทาง ทำขั้นตอนยืนยันตัวตนต่อเมื่อมีคำแนะนำชัดเจนว่าต้องทำ และตรวจสถานะก่อนลองใหม่