Skip to content

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 quản lý khách hàng, thành viên, hotline, lịch sử cuộc gọi và gọi tự động.

Thông tin chung

Thuộc tínhGiá trị
Base URLhttps://open-api.vbot.vn/v2.0
Content-Typeapplication/json
AuthenticationBearer Token

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ómMô tả
Quản lý khách hàngThêm, sửa, xóa khách hàng và các thông tin liên quan (trạng thái, kiểu, nhóm, trường tùy chỉnh)
Quản lý thành viênQuản lý thành viên, tài khoản SDK và SIP
Nhóm & HotlineQuản lý nhóm thành viên và hotline
Lịch sử cuộc gọiTra cứu lịch sử cuộc gọi, file ghi âm
Gọi tự độngChiế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
SDKToken, log, thông tin cuộc gọi, lịch sử gọi SDK
KhácThố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:

json
{
  "error": 0,
  "message": "success",
  "data": "..."
}
Tham sốKiểuMô tả
errorIntMã lỗi (0: Thành công, khác 0: Có lỗi)
messageStringThông tin chi tiết
dataAnyDữ 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ỗiMô tả
-1Sai tham số
0Thành công
401Không có quyền truy cập
403Không có quyền thực hiện
404Không tìm thấy tài nguyên
409Dữ liệu đã tồn tại
500Lỗi hệ thống