Giới thiệu

VBot Open API cung cấp các endpoint cho phép tích hợp hệ thống bên thứ ba với nền tảng VBot — bao gồm thành viên, hotline, lịch sử cuộc gọi và gọi tự động.

Thông tin chung

Thuộc tính	Giá trị
Base URL (Prod)	https://open-api-h01.vbot.vn/v3.0
Base URL (Staging)	https://open-api-staging.vbot.vn/v3.0
Content-Type	application/json
X-API-Key	token-open-api

Phạm vi tài liệu

Tài liệu mô tả chi tiết quy trình và chức năng nghiệp vụ cho các nhóm API sau:

Nhóm	Mô tả
Quản lý thành viên	Quản lý thành viên, tài khoản SDK và SIP
Nhóm & Hotline	Quản lý nhóm thành viên và hotline
Lịch sử cuộc gọi	Tra cứu lịch sử cuộc gọi, file ghi âm, phiên cuộc gọi
Gọi tự động	Chiến dịch gọi, gọi xác nhận, lịch sử gọi campaign, trường tùy chỉnh, template kịch bản
SDK	Token, log, thông tin cuộc gọi, lịch sử gọi SDK
Khác	Thống kê dự án, OneSME, Webhook SMS

Response format chuẩn

Tất cả API đều trả về response theo cấu trúc JSON dưới đây:

{
  "error": 0,
  "message": "success",
  "data": "..."
}

Tham số	Kiểu	Mô tả
error	Int	Mã lỗi (0: Thành công, khác 0: Có lỗi)
message	String	Thông tin chi tiết
data	Any	Dữ liệu trả về

Lưu ý

Response không còn trả về trường status. Sử dụng trường error để kiểm tra kết quả: error = 0 là thành công, giá trị khác 0 là có lỗi (xem bảng mã lỗi bên dưới).

Danh sách mã lỗi

Mã lỗi	Mô tả
-1	Sai tham số
0	Thành công
401	Không có quyền truy cập
403	Không có quyền thực hiện
404	Không tìm thấy tài nguyên
409	Dữ liệu đã tồn tại
500	Lỗi hệ thống