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 trê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": "[email protected]",
            "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ả

STT	Tên trường	Ghi chú	Kiểu dữ liệu
1	code	Trạng thái kết quả api: - ok: Có kết quả - errors: Lỗi	String
2	agents	Mảng dữ liệu danh sách chuyên viên	Array []
3	agents.id	ID người dùng trên toàn hệ thống	Int
4	agents.username	Họ tên	String
5	agents.email	Email của chuyên viên	Email
6	agents.phone_no	Số điện thoại của chuyên viên	String
7	agents.agent_id	Mã Ipphone của chuyên viên	Int
8	agents.updated_at	Ngày cập nhật dữ liệu	DateTime
9	agents.created_at	Ngày tạo	DateTime
10	agents.login_status	Trạng thái đăng nhập có các giá trị AVAILABLE: Đang đăng nhập NOTAVAILABLE: Không đăng nhập	String
11	agents.call_status	Trạng thái thoại có các giá trị AVAILABLE: Đang đăng nhập NOTAVAILABLE: Không đăng nhập	String
12	agents.group_id	ID phòng ban của chuyên viên (*)	Int
13	agents.group_name	Tên phòng ban	String
14	agents.role_id	Vai trò của chuyên viên Trong đó: 1: Admin 2: Chuyên viên 4: Supper 5: Sub Admin 6: Máy nhánh (ext) 7: Mobile 8: Chuyên viên QA 9: Qa lead	Int

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

Cấu trúc kết quả

STT	Tên trường	Ghi chú
1	code	Trạng thái: - errors: Lỗi
2	message	Authorization header is either missing or incorrect

Ví dụ điển hình

{
    "code": "errors",
    "message": "Authorization header is either missing or incorrect"
}

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

Cấu hình api token trên postman