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

สร้างบัญชี

สร้างบัญชี provider โดยต้องระบุ auth_mode เป็น qrcode, code หรือ session หากคู่ provider + auth_mode ต้องใช้หมายเลขโทรศัพท์ ให้ส่ง 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, twitter, zalo หรือ tiktok

enum: telegram, whatsapp, line, twitter, zalo, tiktok, x, x_client, twitter_client

region
stringจำเป็น

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

minLength: 1

status
string

สถานะทางธุรกิจของบัญชี เช่น active หรือ inactive

runtime_status
string

สถานะ runtime ที่ร้องขอ เมื่อ provider รองรับการเปลี่ยนผ่านการตั้งค่าบัญชี

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

auth_mode
stringจำเป็น

ต้องระบุเมื่อสร้างบัญชี: qrcode, code หรือ session

enum: qrcode, code, session

capabilities[]
string[]

สำหรับ PATCH ให้ละไว้เพื่อคงค่า ส่ง [] เพื่อล้าง และห้ามส่ง null

metadata
object

สำหรับ PATCH ให้ละไว้เพื่อคงค่า ส่ง {} เพื่อล้าง และห้ามส่ง null

provider_account_ref
string

ตัวตนบัญชีฝั่ง provider ซึ่งโดยปกติจะมีค่าหลังการยืนยันตัวตน

provider_data
object

สำหรับ PATCH ให้ละไว้เพื่อคงค่า ส่ง {} เพื่อล้าง และห้ามส่ง null ห้ามบันทึก secret ลง log

proxy
object

การตั้งค่า proxy ขาออกแบบเลือกสำหรับบัญชีนี้

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

id
string

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

name
string

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

provider
string

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

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

region
string

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

status
string

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

runtime_status
string

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

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

auth_mode
string

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

capabilities[]
string[]

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

metadata
object

label สภาพแวดล้อมของคุณเองที่เก็บไว้บนบัญชี

provider_account_ref
string

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

proxy
object

การตั้งค่า proxy ขาออกของบัญชี เมื่อมีการกำหนดไว้

provider_profile
object

โปรไฟล์ที่ผู้ให้บริการรายงาน เช่น display_name จะถูกละไว้ก่อนที่บัญชีจะยืนยันตัวตน

id
string

ตัวระบุแบบ opaque ของบัญชีในช่องทางที่เชื่อมต่อ สำหรับ WhatsApp อาจเป็น canonical LID ที่ไม่มี suffix ของอุปกรณ์

phone
string

หมายเลขโทรศัพท์ที่ normalize แล้ว ไม่มีช่องว่าง ขีด หรือเครื่องหมาย + นำหน้า

username
string

username ที่ provider รายงาน ถ้ามี

display_name
string

ชื่อแสดงผลของบัญชี สำหรับ WhatsApp จะสร้างโดยให้ BusinessName มาก่อนและใช้ PushName เป็นค่าทดแทน

push_name
string

PushName ที่ตั้งอยู่บนบัญชี WhatsApp ปัจจุบัน provider อื่นไม่ได้กำหนดความหมายของฟิลด์นี้

business_name
string

WhatsApp BusinessName; จะละฟิลด์นี้เมื่อ provider ไม่ส่งค่ากลับมา

first_name
string

ชื่อที่ provider รายงาน ถ้ามี

last_name
string

นามสกุลที่ provider รายงาน ถ้ามี

avatar_url
string

URL รูปประจำบัญชีที่ provider รายงาน

bio
string

ประวัติหรือข้อความสถานะที่ provider รายงาน

platform
string

ตัวระบุแพลตฟอร์มการเข้าสู่ระบบที่ WhatsApp รายงานระหว่างการจับคู่ ให้ถือเป็นสตริงทึบและรองรับค่าที่ไม่รู้จัก provider อื่นไม่ได้กำหนดความหมายของฟิลด์นี้ และฟิลด์นี้ต่างจาก device_platform

การตอบกลับ

201
201 Created

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

400
Bad Request

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

401
Unauthorized

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

409
Conflict

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

500
Internal Server Error

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

503
Service Unavailable

บริการ backend ที่จำเป็นไม่พร้อมใช้งานชั่วคราว

คำขอ

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