# Hướng dẫn sử dụng API Agent/Queue Management ## 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](https://docs.antbuddy.com/huong-dan-tich-hop-api-team-technical-api-integration-guide-technical-team/antring/su-dung-api-use-api) để biết thêm chi tiết về cơ chế xác thực. Base URL: | 📌 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 | ### 6. Lấy thông tin status agent \|

API 05 | Lấy thông tin status agent

Kiểm tra agent đang thuộc queue nào

| \| -------------------------------------------------------------------------------------- | #### 6.1. Thông tin chung | Endpoint | GET /agent\_status | | -------- | ----------------------------------------------- | | Method | GET | | Mô tả | Lấy danh sách các queue mà agent đang tham gia. | #### 6.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) | #### 6.3. Response HTTP 200 — Thành công: | Trường | Kiểu dữ liệu | Mô tả | | ------ | ------------ | ---------------------- | | data | obj | Thông tin status agent | Ví dụ response body: { "data": { "timestamp": 63946291085, "status": "logged\_out", "id": "8d8f05ae55abfb7ef1dc1851c18d7293::63946291085", "agent\_id": "8d8f05ae55abfb7ef1dc1851c18d7293", "start\_idle\_time": 0, "idle\_time": 0, "queues": \[ "0410da52e82cfb821de4c35985a6764a" ], "waiting\_calls": \[] }, "modified\_at": "2026-05-18T03:44:00.554Z" } ## 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 | ### 2. Lấy danh sách chặn | API 02 \| Lấy danh sách số điện thoại đã chặn | | ----------------------------------------------- | #### 2.1. Thông tin chung | Endpoint | /blacklist | | ------------ | ----------------------------------- | | Method | GET | | Content-Type | application/json | | Mô tả | Lấy danh sách số điện thoại đã chặn | #### 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 | | 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ả | | ------ | ------------ | ------------------------ | | data | obj | Thông tin danh sách chặn | Ví dụ response body: { "name": "Danh sách chặn", "numbers": { "0357663431": {} }, "id": "92d802ed42735224bbdfc0be71a60d14" } ### 3.Thêm/xóa số điện thoại danh sách chặn | API 03 \| Thêm/xóa số điện thoại vào/ra danh sách chặn | | -------------------------------------------------------- | #### 3.1. Thông tin chung | Endpoint | /updateBlacklist | | ------------ | -------------------------------------------- | | Method | POST | | Content-Type | application/json | | Mô tả | Thêm/xóa số điện thoại vào/ra danh sách chặn | #### 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ả | | ----------- | ------------ | -------- | ----------------------------- | | action | String | ✓ | add/remove để thêm hoặc xóa. | | listId | String | ✓ | ID của danh sách cần cập nhật | | email | String | ✓ | Email của agent thuộc công ty | | domain | String | ✓ | Domain công ty | | numbers | Array | ✓ | Số cần chặn/xóa chặn | #### 3.4. Response | Status | Kết quả | | ------ | ---------- | | 200 | Thành công | | 500 | Thất bại | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.antbuddy.com/huong-dan-tich-hop-api-team-technical-api-integration-guide-technical-team/antring/huong-dan-su-dung-api-agent-queue-management.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.