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

การอนุญาตบัญชี

เริ่มยืนยันด้วยรหัส

เริ่มยืนยันตัวตนด้วยหมายเลขที่บันทึกไว้ สำหรับ WhatsApp ให้กรอก data.verify_code บนโทรศัพท์ ไม่ต้องส่งไปยัง /auth/code สำหรับ Telegram ให้ส่งรหัสที่ได้รับไปยัง /auth/code และเรียก /auth/password เมื่อมีการขอรหัสผ่านเพิ่มเติม awaiting_code ไม่ได้หมายถึงยืนยันตัวตนสำเร็จ

POSThttps://api.unifyport.ai/v1/accounts/{account_id}/auth/start

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

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

ที่มาของพารามิเตอร์
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 ของ authentication

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

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

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

อ่านฟิลด์ตอบกลับและสถานะ HTTP ตามเอกสาร 204 สำเร็จไม่มีเนื้อหา ใช้ X-Request-Id เพื่อตรวจสอบ ขั้นตอนต่อไปอยู่ในการทำงานที่เกี่ยวข้อง

การตอบกลับ 200 · WhatsApp

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "provider": "whatsapp",
    "action": "start_auth",
    "status": "awaiting_code",
    "auth_status": "awaiting_code",
    "verify_code": "ABCD-EFGH"
  }
}

การตอบกลับ 200 · Telegram

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "provider": "telegram",
    "action": "start_auth",
    "status": "awaiting_code",
    "auth_status": "awaiting_code",
    "auth_payload": {
      "type": "code"
    }
  }
}

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

provider
string

ช่องทางสำหรับการยืนยันตัวตนครั้งนี้

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

action
string

การดำเนินการยืนยันตัวตนที่ร้องขอ: start_auth

enum: start_auth

status
string

สถานะปัจจุบัน awaiting_code คือรอผู้ใช้ดำเนินการ authorized คือยืนยันตัวตนเสร็จสมบูรณ์

auth_status
string

สถานะมาตรฐานของขั้นตอนปัจจุบัน โดยทั่วไปตรงกับ status

verify_code
string

รหัสจับคู่ WhatsApp ด้วยหมายเลขโทรศัพท์ อยู่ใต้ data โดยตรง ให้ผู้ใช้กรอกบนโทรศัพท์ ไม่ต้องส่งไปยัง /auth/code และไม่รับประกันเวลาหมดอายุ

auth_payload
object

ข้อมูลแนะนำตามช่องทาง Telegram อาจส่ง type=code แต่ไม่รวมรหัสที่ผู้ใช้ได้รับ

type
string

ประเภทข้อมูลแนะนำ เป็น code สำหรับขั้นตอนรหัสของ Telegram

การตอบกลับ

200

200 · WhatsApp

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

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 แล้วแก้พารามิเตอร์ ยืนยันตัวตนต่อ หรือตรวจ runtime ตามสาเหตุ ตรวจผลครั้งก่อนก่อนส่งหรือเขียนซ้ำ อ้างอิงรหัสข้อผิดพลาด

invalid_request · 10000 · 400
ตรวจฟิลด์บังคับ รูปแบบ และเงื่อนไขช่องทาง แล้วแก้คำขอ
invalid_api_key · 11001 · 401
ตรวจ X-Api-Key และว่า workspace ยังใช้งานอยู่