บัญชี

รายชื่อบัญชี

แสดงบัญชีของผู้ให้บริการใน พื้นที่ทำงานปัจจุบัน สถานะการยืนยันตัวตนของบัญชีอยู่ใน จุดเชื่อมต่อ กลุ่ม Authentication

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

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

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

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

ส่วนหัว

X-Api-Key

stringจำเป็น

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

พารามิเตอร์ Query

limit

integer

จำนวนบัญชีสูงสุดต่อหน้า ตั้งแต่ 1 ถึง 100 ค่าเริ่มต้นคือ 20 เมื่อละไว้ ค่าที่ไม่ถูกต้องหรือการส่ง limit ซ้ำจะคืน 400 invalid_request (numeric_code=10000) สามารถปรับค่านี้เมื่อขอหน้าถัดไปได้

minimum: 1 · maximum: 100

cursor

string

เคอร์เซอร์แบบ opaque สำหรับรายการบัญชี ละไว้หรือส่งสตริงว่างเพื่ออ่านหน้าแรก สำหรับหน้าถัดไปให้ส่ง data.next_cursor จากการตอบกลับก่อนหน้าโดยไม่แก้ไข ใช้ได้เฉพาะ workspace ที่ออกเคอร์เซอร์นั้น การส่ง cursor ที่ไม่ถูกต้อง ส่งซ้ำ หรือใช้ข้าม workspace จะคืน 400 invalid_request (numeric_code=10000)

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

จุดเชื่อมต่อนี้ไม่ต้องใช้เนื้อหา JSON

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

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

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

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "items": [
      {
        "id": "acc_example",
        "name": "Telegram Production",
        "provider": "telegram",
        "region": "global",
        "status": "active",
        "runtime_status": "running",
        "auth_mode": "qrcode",
        "capabilities": [
          "send_message",
          "receive_message"
        ],
        "metadata": {
          "env": "production"
        },
        "provider_account_ref": "provider-side-identifier",
        "provider_profile": {
          "id": "778899",
          "phone": "8600000000000",
          "username": "production_bot",
          "display_name": "Production Bot",
          "first_name": "Production",
          "last_name": "Bot",
          "avatar_url": "https://example.com/avatar.jpg",
          "bio": "Customer support"
        }
      }
    ],
    "has_more": false
  }
}

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

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

has_more

boolean

ระบุว่ารายการบัญชียังมีหน้าถัดไปหรือไม่

next_cursor

string

เคอร์เซอร์แบบ opaque สำหรับหน้าถัดไปของรายการบัญชี คืนค่าเฉพาะเมื่อ has_more=true ให้ส่งกลับเป็น cursor โดยไม่แก้ไขเพื่ออ่านหน้าถัดไป ฟิลด์นี้จะถูกละไว้ในหน้าสุดท้าย

การตอบกลับ

200

200 OK

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

400

Bad Request

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

401

Unauthorized

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

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 ยังใช้งานอยู่