Public API v1
Tham chiếu API
Mọi endpoint theo nhóm, kèm tham số, body và lệnh curl.
Gọi từ xa qua địa chỉ Internet ở Cài đặt → Internet & Đám mây (dịch vụ “Nhân viên và API”).
Hệ thống4Kiểm tra sống, thông tin key, thông tin máy chủ.GETendpointTài khoản10Tài khoản Zalo, Facebook, Telegram trên máy: danh sách, trạng thái, kết nối, proxy.GETPOSTPUTPATCHendpointChat44Hội thoại và tin nhắn mọi kênh: đọc, tìm, gửi, thu hồi, reaction, ghim, đã đọc.GETPATCHDELETEPOSTPUTendpointMedia13Upload file để gửi, tải file đính kèm, thư viện media.GETPOSTDELETEPATCHendpointNhãn & tin nhanh30Nhãn hội thoại (local), tin nhắn nhanh, sticker.GETPOSTPATCHDELETEPUTendpointNhóm38Nhóm chat: thông tin, thành viên, đổi tên, link mời.GETPOSTPATCHDELETEPUTendpointDanh bạ19Bạn bè, lời mời kết bạn, tra cứu người dùng.GETPOSTDELETEPUTendpointDanh mục sản phẩm8GETPOSTDELETEPATCHendpointCRM13Khách hàng, tag CRM, ghi chú, chiến dịch gửi tin.GETPATCHPOSTDELETEendpointChiến dịch15GETPOSTPATCHDELETEendpointWorkflow16Workflow tự động hoá: đọc, sửa, bật/tắt, chạy, sự kiện trigger.api.GETPOSTPUTPATCHDELETEendpointTích hợp9Kết nối POS, vận chuyển, thanh toán: gọi action của adapter.GETPOSTPATCHDELETEendpointERP49Công việc, dự án, lịch, ghi chú, chấm công, nghỉ phép, thông báo.GETPOSTPATCHDELETEendpointAI9Trợ lý AI: chat, gợi ý trả lời, thống kê sử dụng.GETPOSTendpointBáo cáo1Báo cáo tổng quan, lượng tin, giờ cao điểm, chiến dịch, workflow.GETendpointNhân viên13Quản lý nhân viên, quyền module, phân tài khoản.GETPOSTPATCHDELETEPUTendpointSự kiện3Nhận sự kiện realtime: Socket.IO, SSE, polling.GETendpointWebhook8Đăng ký webhook outbound có chữ ký HMAC.GETPOSTPATCHDELETEendpointPlugin5Route do plugin đăng ký và thông tin plugin.GETPOSTPUTPATCHDELETEendpoint
Mã lỗi
| Code | HTTP | Mô tả |
|---|---|---|
UNAUTHORIZED | 401 | Thiếu key, key sai, key bị thu hồi hoặc hết hạn |
FORBIDDEN_SCOPE | 403 | Key thiếu scope cần cho endpoint |
FORBIDDEN_ACCOUNT | 403 | Key không được cấp tài khoản này |
FORBIDDEN_IP | 403 | IP gọi không nằm trong danh sách cho phép của key |
FORBIDDEN_ERP | 403 | Vai trò ERP của key không đủ quyền |
NOT_FOUND | 404 | Không tìm thấy endpoint hoặc dữ liệu |
METHOD_NOT_ALLOWED | 405 | Sai HTTP method |
VALIDATION_ERROR | 400 | Tham số không hợp lệ (xem details) |
INVALID_JSON | 400 | Body không phải JSON hợp lệ |
PAYLOAD_TOO_LARGE | 413 | Body vượt giới hạn |
CONFLICT | 409 | Xung đột trạng thái |
ACCOUNT_OFFLINE | 409 | Tài khoản chưa kết nối |
CHANNEL_UNSUPPORTED | 422 | Kênh của tài khoản không hỗ trợ thao tác này |
RATE_LIMITED | 429 | Vượt giới hạn tốc độ do bạn tự đặt cho key |
AUTH_BLOCKED | 429 | IP bị tạm chặn vì gửi quá nhiều key sai |
UPSTREAM_ERROR | 502 | Zalo/Facebook/Telegram hoặc handler nội bộ trả lỗi |
NOT_IMPLEMENTED | 501 | Thiếu kênh IPC tương ứng |
API_DISABLED | 503 | API đang tắt trong Cài đặt |
TIMEOUT | 504 | Xử lý quá thời gian cho phép |
PLUGIN_ERROR | 502 | Route/node của plugin trả lỗi |
PLUGIN_DISABLED | 404 | Plugin chưa cài hoặc đang tắt |
INTERNAL_ERROR | 500 | Lỗi không mong đợi |
Danh mục scope
| Scope | Mô tả |
|---|---|
accounts:read | Tài khoản · Xem danh sách tài khoản và trạng thái |
accounts:manage | Tài khoản · Kết nối, ngắt kết nối, đổi proxy |
chat:read | Chat · Đọc hội thoại, tin nhắn, nhãn, tin nhanh |
chat:send | Chat · Gửi tin, file, sticker, reaction, typing |
chat:manage | Chat · Đánh dấu đọc, thu hồi, ghim, gán nhãn, quản lý nhóm |
contacts:read | Danh bạ · Xem bạn bè, lời mời, tra cứu người dùng |
contacts:write | Danh bạ · Gửi/chấp nhận/từ chối lời mời, xoá bạn |
crm:read | CRM · Xem khách hàng, tag, ghi chú, chiến dịch |
crm:write | CRM · Sửa khách hàng, tag, ghi chú, chiến dịch |
campaigns:run | CRM · Chạy/dừng chiến dịch |
workflow:read | Workflow · Xem workflow và lịch sử chạy |
workflow:write | Workflow · Tạo, sửa, bật/tắt, xoá workflow |
workflow:run | Workflow · Chạy workflow, bắn sự kiện trigger.api |
integrations:read | Tích hợp · Xem tích hợp (không lộ credential) |
integrations:execute | Tích hợp · Gọi action của tích hợp (POS, vận chuyển...) |
integrations:manage | Tích hợp · Thêm, sửa credential, bật/tắt, xoá tích hợp |
erp:read | ERP · Xem công việc, dự án, lịch, ghi chú, nhân sự |
erp:write | ERP · Tạo/sửa công việc, dự án, lịch, ghi chú |
ai:use | AI · Chat với trợ lý AI, gợi ý trả lời |
ai:manage | AI · Quản lý trợ lý AI, xem thống kê sử dụng |
media:read | Media · Tải file đính kèm, thư viện media |
media:write | Media · Upload file, quản lý thư viện media |
analytics:read | Báo cáo · Xem báo cáo |
events:subscribe | Sự kiện · Nhận sự kiện realtime (Socket.IO, SSE, polling) |
webhooks:manage | Sự kiện · Quản lý webhook subscription của key này |
employees:manage | Quản trị · Quản lý nhân viên, quyền, phân tài khoản |
settings:read | Quản trị · Đọc cài đặt (danh sách cho phép) |
settings:write | Quản trị · Ghi cài đặt (danh sách cho phép) |
plugins:manage | Quản trị · Quản lý ứng dụng (plugin) |
admin | Quản trị · Toàn quyền (mọi scope ở trên) |