Tham chiếu API

Tài khoản

Liệt kê tài khoản

Liệt kê các tài khoản nhà cung cấp trong workspace hiện tại. Trạng thái xác thực được expose qua nhóm Authentication.

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

Kênh được hỗ trợ

all

Trước khi gọi

Dùng X-Api-Key của workspace sở hữu tài nguyên trên máy chủ. Thay mọi giá trị mẫu trước khi chạy.

Tham số yêu cầu

Tiêu đề

X-Api-Key
stringbắt buộc

API key của không gian làm việc. Không gian làm việc được xác định từ tiêu đề này.

Tham số truy vấn

limit
integer

Số tài khoản tối đa mỗi trang, từ 1 đến 100; mặc định là 20 nếu bỏ qua. Giá trị không hợp lệ hoặc truyền lặp tham số limit sẽ trả về 400 invalid_request (numeric_code=10000). Có thể thay đổi giá trị ở các trang tiếp theo.

minimum: 1 · maximum: 100

cursor
string

Con trỏ mờ của danh sách tài khoản. Bỏ qua hoặc truyền chuỗi rỗng để đọc trang đầu; truyền nguyên data.next_cursor của phản hồi trước cho trang tiếp theo. Chỉ dùng được trong workspace đã cấp con trỏ. cursor không hợp lệ, truyền lặp hoặc dùng khác workspace sẽ trả về 400 invalid_request (numeric_code=10000).

Nội dung yêu cầu

Điểm cuối này không cần nội dung JSON.

Hiểu kết quả

Đọc tài khoản từ data.items. Nếu data.has_more=true, gửi nguyên data.next_cursor vào cursor để lấy trang tiếp theo. Trạng thái xác thực cần truy vấn riêng qua API xác thực.

Phản hồi 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
  }
}

Nội dung phản hồi

provider_profile
object

Hồ sơ do nhà cung cấp báo cáo, ví dụ display_name. Bị bỏ qua trước khi tài khoản được xác thực.

id
string

Định danh opaque của tài khoản trên kênh đã kết nối. Với WhatsApp, đây có thể là canonical LID không có hậu tố thiết bị.

device_id
integer

Số thiết bị đăng nhập tùy chọn trong chi tiết tài khoản WhatsApp khi xác định được phiên hiện tại. Có thể thay đổi sau khi xác thực lại và không phải mã thiết bị cố định.

minimum: 0 · maximum: 65535

phone
string

Số điện thoại đã chuẩn hóa, bỏ khoảng trắng, gạch nối và dấu + đầu.

username
string

username do provider báo cáo, nếu có.

display_name
string

Tên hiển thị của tài khoản; với WhatsApp, tên này được tạo bằng cách ưu tiên BusinessName và dùng PushName làm giá trị dự phòng.

push_name
string

PushName hiện được đặt trên tài khoản WhatsApp; các provider khác không định nghĩa ngữ nghĩa cho trường này.

business_name
string

WhatsApp BusinessName; trường này bị bỏ qua khi provider không trả về giá trị.

first_name
string

Tên do provider báo cáo, nếu có.

last_name
string

Họ do provider báo cáo, nếu có.

avatar_url
string

URL avatar tài khoản do provider báo cáo.

bio
string

Tiểu sử hoặc trạng thái tài khoản do provider báo cáo.

platform
string

Định danh nền tảng đăng nhập do WhatsApp báo cáo khi ghép nối. Hãy coi đây là chuỗi opaque và chấp nhận giá trị chưa biết; các provider khác không định nghĩa ý nghĩa của trường này. Trường này khác với device_platform.

billing
object

Chu kỳ đã trả chỉ tài khoản ví; không suy ra đã mua từ số dư.

period_start_at
string

Bắt đầu chu kỳ đã trả từ máy chủ.

format: date-time

period_end_at
string

Kết thúc chu kỳ đã trả từ máy chủ.

format: date-time

amount_minor
integer

Số tiền máy chủ cố định theo cent USD; xử lý số nguyên chính xác.

minimum: 1 · format: int64

currency
string

Chỉ USD.

operation_id
string

Mã công khai từ billing.operation_id hoặc phản hồi xóa; dùng nguyên trong workspace cũ.

state
string

Trạng thái thanh toán hay thao tác không chứng minh xác thực, trực tuyến hoặc ghi có hoàn tiền.

enum: ACTIVE, DELETING, DELETED, COMPENSATED, REVIEW

id
string

Định danh tài khoản duy nhất (acc_...). Dùng trong các route theo phạm vi tài khoản.

name
string

Tên tài khoản dễ đọc.

provider
string

Mã định danh kênh. Dùng nguyên giá trị API trả về trong các lần gọi sau; xem enum bên dưới để biết giá trị của API này.

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

region
string

Khu vực đầu ra mạng mặc định được chọn cho tài khoản.

status
string

Trạng thái vòng đời của tài khoản, ví dụ active.

runtime_status
string

Trạng thái runtime đã chuẩn hoá: một trong unknown, starting, running, stopping, stopped, reconnecting, disconnected hoặc error.

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

auth_mode
string

Luồng xác thực mà tài khoản dùng: code, qrcode hoặc session. TikTok hỗ trợ qrcode và session nhưng không hỗ trợ chuyển đổi giữa hai chế độ ngay trên tài khoản hiện có.

capabilities[]
string[]

Các năng lực được bật cho tài khoản, ví dụ send_message và receive_message.

metadata
object

Nhãn môi trường của riêng bạn được lưu trên tài khoản.

provider_account_ref
string

Định danh phía nhà cung cấp mà bạn có thể gắn để liên kết tài khoản với hệ thống của riêng mình.

proxy
object

Proxy do khách hàng cấu hình rõ ràng; không trả về thông tin xác thực đầu ra mặc định của nền tảng.

has_more
boolean

Danh sách tài khoản có còn trang tiếp theo hay không.

next_cursor
string

Con trỏ mờ cho trang tiếp theo của danh sách tài khoản, chỉ trả về khi has_more=true. Truyền nguyên giá trị làm cursor cho trang tiếp theo; trường này được bỏ qua ở trang cuối.

Phản hồi

200

200 OK

Yêu cầu thành công. Xem ví dụ nội dung phản hồi.

400

Bad Request

Body, đường dẫn hoặc tham số yêu cầu không hợp lệ.

401

Unauthorized

Header X-Api-Key thiếu hoặc không hợp lệ.

403

Forbidden

Yêu cầu đã được nhận diện nhưng thao tác không được phép.

404

Not Found

Không tìm thấy tài nguyên được yêu cầu. Kiểm tra error.code cùng với thao tác hiện tại.

500

Internal Server Error

Dịch vụ gặp lỗi không mong muốn.

Khi yêu cầu thất bại

Kiểm tra HTTP và error.code/numeric_code, giữ request_id. Sửa tham số, tiếp tục xác thực hoặc kiểm tra runtime tùy nguyên nhân. Xác nhận kết quả cũ trước khi thử lại thao tác gửi hoặc ghi. Tham chiếu mã lỗi

Đọc trạng thái HTTP, error.code và error.numeric_code theo thao tác đang gọi. Mã số có kiểu chuỗi. Giữ request_id để chẩn đoán; đây không phải khóa chống lặp hay mã tác vụ.

invalid_request · 10000 · 400

Kiểm tra JSON và các trường bắt buộc.

Xử lý và thử lại: Sửa tham số theo thao tác và điều kiện của kênh rồi mới gọi lại. Lặp lại yêu cầu sai y nguyên không khắc phục lỗi.

JSON minh họa; message thay đổi theo nguyên nhân thực tế · 400 · 10000
{
  "request_id": "req_example",
  "error": {
    "code": "invalid_request",
    "numeric_code": "10000",
    "message": "Invalid request parameters"
  }
}
invalid_target_workspace · 11003 · 400

Đích ghi đè workspace trống hoặc sai định dạng. Bỏ tiêu đề ghi đè và dùng API Key thuộc workspace đích.

Điều kiện: Áp dụng khi yêu cầu có tiêu đề X-Workspace-Id để ghi đè workspace.

Xử lý và thử lại: Sửa tham số theo thao tác và điều kiện của kênh rồi mới gọi lại. Lặp lại yêu cầu sai y nguyên không khắc phục lỗi.

JSON minh họa; message thay đổi theo nguyên nhân thực tế · 400 · 11003
{
  "request_id": "req_example",
  "error": {
    "code": "invalid_target_workspace",
    "numeric_code": "11003",
    "message": "Invalid target workspace"
  }
}
invalid_api_key · 11001 · 401

Kiểm tra API Key có đúng và được bật hay không.

Xử lý và thử lại: Giữ request_id và mã lỗi có cấu trúc; kiểm tra thao tác hiện tại trước khi chọn hành động tiếp theo.

JSON minh họa; message thay đổi theo nguyên nhân thực tế · 401 · 11001
{
  "request_id": "req_example",
  "error": {
    "code": "invalid_api_key",
    "numeric_code": "11001",
    "message": "Invalid API key"
  }
}
missing_api_key · 11000 · 401

Thêm tiêu đề X-Api-Key.

Xử lý và thử lại: Giữ request_id và mã lỗi có cấu trúc; kiểm tra thao tác hiện tại trước khi chọn hành động tiếp theo.

Ví dụ · 401 · 11000
{
  "request_id": "req_xxx",
  "error": {
    "code": "missing_api_key",
    "numeric_code": "11000",
    "message": "Missing X-Api-Key header"
  }
}
workspace_override_forbidden · 11002 · 403

Yêu cầu cố ghi đè workspace mà API Key không được phép dùng. Bỏ tiêu đề ghi đè và dùng API Key thuộc workspace đích.

Điều kiện: Áp dụng khi yêu cầu có tiêu đề X-Workspace-Id để ghi đè workspace.

Xử lý và thử lại: Giữ request_id và mã lỗi có cấu trúc; kiểm tra thao tác hiện tại trước khi chọn hành động tiếp theo.

JSON minh họa; message thay đổi theo nguyên nhân thực tế · 403 · 11002
{
  "request_id": "req_example",
  "error": {
    "code": "workspace_override_forbidden",
    "numeric_code": "11002",
    "message": "Workspace override is not allowed"
  }
}
target_workspace_not_found · 11004 · 404

Không tìm thấy workspace được ghi đè hoặc workspace không khả dụng. Kiểm tra chủ sở hữu, bỏ tiêu đề ghi đè và dùng API Key của workspace đích; gọi lặp không cấp thêm quyền.

Điều kiện: Áp dụng khi yêu cầu có tiêu đề X-Workspace-Id để ghi đè workspace.

Xử lý và thử lại: Kiểm tra mã đích, chủ sở hữu tài nguyên và workspace hiện tại. Không coi đích đã xác nhận thiếu hoặc không truy cập được là lỗi dịch vụ tạm thời để tự thử lại.

JSON minh họa; message thay đổi theo nguyên nhân thực tế · 404 · 11004
{
  "request_id": "req_example",
  "error": {
    "code": "target_workspace_not_found",
    "numeric_code": "11004",
    "message": "Target workspace not found"
  }
}
list_accounts_failed · 20000 · 500

Liệt kê tài khoản: dịch vụ không tạo được kết quả truy vấn hợp lệ.

Xử lý và thử lại: Giữ request_id, kiểm tra mã định danh và quyền truy cập của tài khoản. Chỉ thử đọc lại sau khi kiểm tra nguyên nhân; truy vấn thất bại không chứng minh dữ liệu rỗng hay không tồn tại.

JSON minh họa; message thay đổi theo nguyên nhân thực tế · 500 · 20000
{
  "request_id": "req_example",
  "error": {
    "code": "list_accounts_failed",
    "numeric_code": "20000",
    "message": "Failed to list accounts"
  }
}