บัญชี

อัปเดตบัญชี

อัปเดตบัญชีบางส่วน ฟิลด์ที่ละไว้คงค่าเดิม ห้ามส่ง null และส่ง array หรือ object ว่างเพื่อล้างฟิลด์นั้น identity ซ้ำคืน 409 duplicate_provider_account

PATCHhttps://api.unifyport.ai/v1/accounts/{account_id}

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

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

ที่มาของพารามิเตอร์

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

คำขอ

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

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

ส่วนหัว

X-Api-Key

stringจำเป็น

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

Content-Type

stringจำเป็น

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

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

account_id

stringจำเป็น

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

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

name

string

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

provider

string

ตัวระบุ provider สำหรับลูกค้า: telegram, whatsapp, whatsapp-protocol, line, twitter, zalo หรือ tiktok

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp-protocol, 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 เมื่อสร้างบัญชี Telegram ฟิลด์ api_id และ api_hash เป็นทางเลือก หากไม่ได้ระบุข้อมูลรับรองแอปของคุณเอง แพลตฟอร์มจะใช้ข้อมูลรับรองแอปเริ่มต้น หากใช้แอปของคุณเอง ให้ระบุค่าทั้งสองจากแอป Telegram เดียวกันในรูปแบบสตริง

proxy

object

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

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

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

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

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "id": "acc_example",
    "name": "Telegram Production",
    "provider": "telegram",
    "status": "active",
    "auth_mode": "code"
  }
}

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

id

string

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

name

string

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

provider

string

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

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

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

การตอบกลับ

200

200 OK

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

400

Bad Request

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

401

Unauthorized

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

409

Conflict

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

500

Internal Server Error

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

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

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

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