Hướng dẫn sử dụng API Agent/Queue Management

HƯỚNG DẪN SỬ DỤNG API

I. AGENT / QUEUE

1. Tổng quan

Mọi request đều yêu cầu xác thực bằng tham số hash được tính từ appSecret. Tham khảo tài liệu chính để biết thêm chi tiết về cơ chế xác thực.

Base URL: https://openapi.antbuddy.com/oapi/v1

📌 Xác thực: Tất cả request phải kèm tham số hash. Thứ tự ghép chuỗi khác nhau theo từng API — xem chi tiết tại mỗi phần bên dưới.

2. Lấy danh sách queue của Agent

API 01 | Lấy danh sách queue của agent Kiểm tra agent đang thuộc queue nào

2.1. Thông tin chung

Endpoint	GET /agent_in_queue
Method	GET
Mô tả	Lấy danh sách các queue mà agent đang tham gia.

2.2. Query Parameters

Tên tham số	Kiểu dữ liệu	Bắt buộc	Mô tả
appId	String	✓	Định danh 3rd party
domain	String	✓	Domain của công ty
email	String	✓	Email của agent thuộc công ty
agentId	String	✓	ID của agent cần kiểm tra
hash	String	✓	sha256(appId + domain + email + agentId + appSecret)

2.3. Response

HTTP 200 — Thành công:

Trường	Kiểu dữ liệu	Mô tả
queues	Array	Danh sách các queue mà agent đang tham gia

Ví dụ response body:

{

"queues": [

"q_001",

"q_002",

"..."

]

}

3. Thêm / Xóa Agent khỏi queue

API 02 | Thêm / Xóa agent khỏi queue Cập nhật thành viên của một queue

3.1. Thông tin chung

Endpoint	POST /update_agent_to_queue
Method	POST
Content-Type	application/json
Mô tả	Thêm hoặc xóa một agent khỏi queue chỉ định.

3.2. Request Headers

Header	Kiểu	Mô tả
x-auth-app-id	String	Định danh 3rd party
x-auth-app-hash	String	sha256(appId + appSecret)

3.3. Request Body

Tên tham số	Kiểu dữ liệu	Bắt buộc	Mô tả
agentId	String	✓	ID của agent cần cập nhật
queueId	String	✓	ID của queue mục tiêu
action	String	✓	"add" — thêm agent vào queue | "remove" — xóa agent khỏi queue
email	String	✓	Email của agent thuộc công ty
domain	String	✓	Domain công ty

Ví dụ: request body — Thêm agent vào queue:

{

"agentId": "agent_001",

"queueId": "q_001",

"action": "add"

}

Ví dụ request body — Xóa agent khỏi queue:

{

"agentId": "agent_001",

"queueId": "q_001",

"action": "remove"

}

3.6. Response

📌 Lưu ý về action: Giá trị action chỉ chấp nhận đúng 2 chuỗi: "add" (thêm) hoặc "remove" (xóa). Sử dụng sai giá trị sẽ trả về HTTP 400.

4. Chuyển trạng thái ready cho agent

API 03 | Chuyển trạng thái ready cho agent Chuyển trạng thái ready cho agent khi agent đang warp_up

4.1. Thông tin chung

Endpoint	POST /set_ready
Method	POST
Content-Type	application/json
Mô tả	Chuyển trạng thái ready cho agent khi agent đang warp_up.

4.2. Request Headers

Header	Kiểu	Mô tả
x-auth-app-id	String	Định danh 3rd party
x-auth-app-hash	String	sha256(appId + appSecret)

4.3. Request Body

Tên tham số	Kiểu dữ liệu	Bắt buộc	Mô tả
agentId	String	✓	ID của agent cần cập nhật
email	String	✓	Email của agent thuộc công ty
domain	String	✓	Domain công ty

4.4. Response

Status	Kết quả
200	Thành công
400	Thất bại

5. Chuyển trạng thái(pause/resume)

API 04 | Chuyển trạng thái pause/resume cho agent

5.1. Thông tin chung

Endpoint	/change_status
Method	POST
Content-Type	application/json
Mô tả	Chuyển trạng thái pause/resume cho agent

5.2. Request Headers

Header	Kiểu	Mô tả
x-auth-app-id	String	Định danh 3rd party
x-auth-app-hash	String	sha256(appId + appSecret)

5.3. Request Body

Tên tham số	Kiểu dữ liệu	Bắt buộc	Mô tả
agentId	String	✓	ID của agent cần cập nhật
email	String	✓	Email của agent thuộc công ty
domain	String	✓	Domain công ty
status	String	✓	pause(Tạm dừng)/ resume(hủy tạm dừng)

5.4. Response

Status	Kết quả
200	Thành công
500	Thất bại

II. Cấu hình số

1. Thay đổi brand gọi ra cho agent

API 01 | Thay đổi brand gọi ra cho agent

1.1. Thông tin chung

Endpoint	/change_brand
Method	POST
Content-Type	application/json
Mô tả	Thay đổi brand gọi ra cho agent

1.2. Request Headers

Header	Kiểu	Mô tả
x-auth-app-id	String	Định danh 3rd party
x-auth-app-hash	String	sha256(appId + appSecret)

1.3. Request Body

Tên tham số	Kiểu dữ liệu	Bắt buộc	Mô tả
agentId	String	✓	ID của agent cần cập nhật
email	String	✓	Email của agent thuộc công ty
domain	String	✓	Domain công ty
brandName	String	✓	Brand name (“BrandVoice”/”BrandDefault”)

1.4. Response

Status	Kết quả
200	Thành công
500	Thất bại