Tài khoảnPOST

Tạo tài khoản

Tạo một tài khoản nhà cung cấp. Hỗ trợ telegram, whatsapp, twitter, line, zalo. Dùng auth_mode = code, qrcode hoặc session tùy luồng. Khi cặp provider và auth_mode đòi hỏi số điện thoại (ví dụ WhatsApp với auth_mode=code), số điện thoại phải được cung cấp ngay tại đây qua provider_data.phone — giá trị này được lưu trên tài khoản và tự động tái sử dụng cho các thao tác xác thực sau.

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

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.

Content-Type

stringbắt buộc

Dùng application/json khi gửi nội dung yêu cầu JSON.

Tham số đường dẫn

Điểm cuối này không có tham số đường dẫn.

Nội dung yêu cầu

name

stringbắt buộc

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

provider

stringbắt buộc

Mã định danh provider, ví dụ telegram, whatsapp, line hoặc zalo.

region

stringbắt buộc

Khu vực của nhà cung cấp dùng để phân bổ. Hãy chọn khu vực được báo cáo allocatable: true qua Liệt kê khu vực của nhà cung cấp.

auth_mode

string

Luồng xác thực: code, qrcode hoặc session.

provider_data

object

Cấu hình riêng của nhà cung cấp. Đừng để giá trị bí mật vào log.

metadata

object

Metadata nền tảng cho nhãn môi trường.

Nội dung phản hồi

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 provider, ví dụ telegram, whatsapp, line, twitter hoặc zalo.

region

string

Khu vực nhà cung cấp mà tài khoản được phân bổ tới.

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.

auth_mode

string

Luồng xác thực mà tài khoản dùng: code, qrcode hoặc session.

capabilities

string[]

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

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.

Phản hồi

201

201 Created

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ệ.

409

Conflict

Thao tác đang yêu cầu xung đột với tài khoản hoặc tài nguyên nhà cung cấp đã có.

500

Internal Server Error

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

Yêu cầu

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

Phản hồi

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