← เอกสารอ้างอิง API
บัญชีPOST

สร้างบัญชี

สร้างบัญชีของผู้ให้บริการ รองรับ provider เช่น telegram, whatsapp, twitter, line, zalo และเลือก auth_mode = code, qrcode หรือ session ตามขั้นตอน เมื่อ provider ที่เลือกร่วมกับ auth_mode จำเป็นต้องใช้หมายเลขโทรศัพท์ (เช่น WhatsApp กับ auth_mode=code) ต้องระบุหมายเลขผ่าน provider_data.phone ที่ขั้นตอนนี้ — ระบบจะเก็บค่าไว้ในบัญชีและส่งซ้ำให้อัตโนมัติในขั้นยืนยันตัวตนถัด ๆ ไป

https://api.unifyport.ai/v1/accounts

ส่วนหัว

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

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

Content-Type
stringจำเป็น

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

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

จุดเชื่อมต่อนี้ไม่มีพารามิเตอร์ใน path

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

name
stringจำเป็น

ชื่อบัญชีที่อ่านได้

provider
stringจำเป็น

ตัวระบุของ provider เช่น telegram, whatsapp, line หรือ zalo

region
stringจำเป็น

ภูมิภาคของผู้ให้บริการที่ใช้ในการจัดสรร เลือกภูมิภาคที่รายงานว่า allocatable: true จาก รายชื่อภูมิภาคของผู้ให้บริการ

auth_mode
string

flow การยืนยัน: code, qrcode หรือ session

provider_data
object

config เฉพาะของผู้ให้บริการ อย่าให้ค่า secret หลุดเข้า log

metadata
object

metadata ฝั่งแพลตฟอร์มสำหรับ label สภาพแวดล้อม

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

id
string

ตัวระบุบัญชีที่ไม่ซ้ำ (acc_...) ใช้ใน route ที่อิงกับบัญชี

name
string

ชื่อบัญชีที่อ่านได้

provider
string

ตัวระบุของ provider เช่น telegram, whatsapp, line, twitter หรือ zalo

region
string

ภูมิภาคของผู้ให้บริการที่บัญชีถูกจัดสรรไว้

status
string

สถานะ lifecycle ของบัญชี เช่น active

runtime_status
string

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

auth_mode
string

flow การยืนยันตัวตนที่บัญชีใช้: code, qrcode หรือ session

capabilities
string[]

ความสามารถที่เปิดใช้สำหรับบัญชี เช่น send_message และ receive_message

provider_account_ref
string

ตัวระบุฝั่งผู้ให้บริการที่คุณแนบได้เพื่อเชื่อมโยงบัญชีกับระบบของคุณเอง

การตอบกลับ

201
201 Created

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

400
Bad Request

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

401
Unauthorized

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

409
Conflict

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

500
Internal Server Error

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

คำขอ

curl -X POST https://api.unifyport.ai/v1/accounts \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Telegram Production",
  "provider": "telegram",
  "region": "global",
  "status": "active",
  "auth_mode": "qrcode",
  "capabilities": ["send_message", "receive_message"],
  "provider_data": {},
  "metadata": {
    "env": "production"
  },
  "provider_account_ref": "provider-side-identifier"
}'

การตอบกลับ

{
  "data": {
    "id": "acc_example",
    "name": "Telegram Production",
    "provider": "telegram",
    "region": "global",
    "status": "active",
    "runtime_status": "stopped",
    "auth_mode": "qrcode",
    "capabilities": ["send_message", "receive_message"],
    "provider_account_ref": "provider-side-identifier"
  }
}