Chuyên viên

Các thông tin cần thiết để tích hợp nền tảng CareSoft vào môi trường làm việc của bạn.

Giao diện cấu hình chuyên viên hệ thống CareSoft

Chuyên viên trên hệ thống CareSoft tương đương với một nhân viên nghiệp vụ ở môi trường doanh nghiệp thực tế.

Lưu ý: Danh sách chuyên viên sẽ thay đổi khi doanh nghiệp tăng, giảm số lượng thuê bao hoặc chuyển phòng ban. Cần thiết lập cơ chế tự đồng bộ lại hàng tuần để đảm bảo thông tin chính xác.

Gợi ý: Sử dụng email của nhân viên hoặc số điện thoại của nhân viên trong doanh nghiệp để làm key liên kết thông tin sau đó lưu danh sách này trên CSDL của doanh nghiệp, đặt lịch mỗi ngày quét lại danh sách này 1 lần để đồng bộ thông tin để đảm bảo thông tin giữa CRM/ERP của khách hàng luôn đồng nhất với các tài khoản thuê bao trên CareSoft.

Lấy danh sách Agents

GET {{domain}}/api/v1/agents

Lấy danh sách các chuyên viên của 1 domain trên hệ thống CareSoft

Headers

Name	Type	Description
* *		Thông tin xác thực chung

200: OK Thành công

Ví dụ điển hình

{
    "code": "ok",
    "agents": [
        {
            "id": 142928097,
            "username": "Sample",
            "email": "[e-mail]",
            "phone_no": "0336842288",
            "agent_id": "50007",
            "created_at": "2022-07-08 09:48:41",
            "updated_at": "2022-08-08 17:42:08",
            "group_id": 12153,
            "group_name": "Default Group",
            "role_id": 1,
            "login_status": "AVAILABLE",
            "call_status": "AVAILABLE"
        }
        ]
}

Cấu trúc kết quả

401: Unauthorized Sai API Token hoặc không cung cấp API Token

500: Internal Server Error Lỗi chung

422: Unprocessable Entity Thiếu thông tin đầu vào (một số trường hợp)

404: Not Found Không tìm thấy tài nguyên, Lỗi này kiểm tra lại API Url xem chính xác hay chưa

Ví dụ điển hình khi triệu gọi API CareSoft qua curl: Bạn cũng có thể áp dụng để tạo Api call trên ứng dụng của bạn hoặc trên ứng dụng Postman

curl

curl 
--location 'https://api.caresoft.vn/{{domain}}/api/v1/agents' \
--header 'Authorization: Bearer {{apiToken}}' \
--header 'Content-Type: application/json'

postman

Một số trường hợp điển hình của trạng thái chuyên viên

1, Trạng thái online 3 kênh thoại/chat/ticket của 1 agent khi dùng api lấy danh sách chuyên viên

            {
            "id": 63203703,
            "username": "Đặng Phương Thu Thảo",
            "email": "thut***@gmail.com",
            "phone_no": "08***8",
            "agent_id": "5045",
            "created_at": "2021-08-25 15:17:20",
            "updated_at": "2025-10-15 11:31:52",
            "group_id": 15257,
            "group_name": "Không xóa bộ phận cũ đi nhé",
            "role_id": 1,
            "call_status": "AVAILABLE",
            "ticket_status": "AVAILABLE",
            "chat_status": "AVAILABLE"
            }

2, Trạng thái offline thoại/chat/ticket của 1 agent khi dùng api lấy danh sách chuyên viên

         {
        "id": 63203703,
        "username": "Đặng Phương Thu Thảo",
        "email": "thut***@gmail.com",
        "phone_no": "08***8",
        "agent_id": "5045",
        "created_at": "2021-08-25 15:17:20",
        "updated_at": "2025-10-15 11:31:52",
        "group_id": 15257,
        "group_name": "Không xóa bộ phận cũ đi nhé",
        "role_id": 1,
        "call_status": "NOT AVAILABLE",
        "ticket_status": "NOT AVAILABLE",
        "chat_status": "NOT AVAILABLE"
        }

3, Trạng thái online ticket của 1 agent và offline thoại/chat của agent đó khi dùng api lấy danh sách chuyên viên

    {
        "id": 63203703,
        "username": "Đặng Phương Thu Thảo",
        "email": "thut***@gmail.com",
        "phone_no": "08***8",
        "agent_id": "5045",
        "created_at": "2021-08-25 15:17:20",
        "updated_at": "2025-10-15 11:31:52",
        "group_id": 15257,
        "group_name": "Không xóa bộ phận cũ đi nhé",
        "role_id": 1,
        "call_status": "NOT AVAILABLE",
        "ticket_status": "AVAILABLE",
        "chat_status": "NOT AVAILABLE"
        }

4, Đăng xuất

• Thông tin agent khi dùng api lấy danh sách chuyên và agent đó đăng xuất là chọn logout tất cả các thiết bị

 {
        "id": 63203703,
        "username": "Đặng Phương Thu Thảo",
        "email": "thut***@gmail.com",
        "phone_no": "08***8",
        "agent_id": "5045",
        "created_at": "2021-08-25 15:17:20",
        "updated_at": "2025-10-15 11:31:52",
        "group_id": 15257,
        "group_name": "Không xóa bộ phận cũ đi nhé",
        "role_id": 1,
        "call_status": "LOGOUT",
        "ticket_status": "LOGOUT",
        "chat_status": "LOGOUT"
        }

• Trường hợp thể hiện 3 trạng thái đăng nhập đăng xuất logout của các tham số

  • Chọn nghe gọi qua app và đăng xuất web

  • Online trạng thái thoại/ticket và offline chat

{
        "id": 63203703,
        "username": "Đặng Phương Thu Thảo",
        "email": "thut***@gmail.com",
        "phone_no": "08***8",
        "agent_id": "5045",
        "created_at": "2021-08-25 15:17:20",
        "updated_at": "2025-10-15 11:31:52",
        "group_id": 15257,
        "group_name": "Không xóa bộ phận cũ đi nhé",
        "role_id": 1,
        "call_status": "AVAILABLE",
        "ticket_status": "LOGOUT",
        "chat_status": "NOT AVAILABLE"
        }