Chiến dịch

Lấy danh sách chiến dịch trên CareSoft

Danh sách các chiến dịch trên CareSoft

GET {{domain}}/api/v1/campaigns

API lấy danh sách các chiến dịch đang có. Dữ liệu được sắp xếp từ mới nhất đến cũ nhất (theo campaign_id)

Request Body

Name	Type	Description
created_since	DateTime	Thời điểm tạo bắt đầu từ mặc định từ ngày đầu tiên của năm
created_to	DateTime	Thời điểm tạo tới. Mặc định là thời điểm hiện tại
status	String	Trạng thái chiến dịch cho phép các giá trị: NEW: Mới RUNNING: Đang chạy PAUSE: Tạm dừng STOP: Kết thúc
page	Int	Trang số (mặc định 1)
count	Int	Số bản ghi trên trang (mặc định 500, tối đa 500)

200: OK Kết quả

Kết quả điển hình

{
    "code": "ok",
    "campaigns": [
        {
            "campaign_status": "FINISHED",
            "campaign_name": "Đồng bộ chi tiết chiến dịch ",
            "campaign_id": 81584,
            "start_time": "2024-09-28 00:00:00",
            "end_time": "2024-09-28 00:00:00",
            "created_at": "2024-09-28 00:05:19",
            "v_type": 1,
            "member_status": [
                {
                    "id": 349,
                    "description": "Chưa gửi",
                    "is_default": 1,
                    "campaign_id": 81584
                },
                {
                    "id": 350,
                    "description": "Đã gửi",
                    "is_default": 0,
                    "campaign_id": 81584
                },
                {
                    "id": 351,
                    "description": "Gửi lỗi",
                    "is_default": 0,
                    "campaign_id": 81584
                },
                {
                    "id": 352,
                    "description": "Gửi thành công",
                    "is_default": 0,
                    "campaign_id": 81584
                }
            ]
        },
        {
            "campaign_status": "NEW",
            "campaign_name": "Life Event - Sự kiện",
            "campaign_id": 56618,
            "start_time": "2023-04-03 16:03:41",
            "end_time": "2023-04-03 16:03:41",
            "created_at": "2023-04-03 16:03:41"
            "v_type": 0,
        },
        {
            "campaign_status": "NEW",
            "campaign_name": "Life events - CMSN",
            "campaign_id": 56617,
            "start_time": "2023-04-03 16:03:33",
            "end_time": "2023-04-03 16:03:33",
            "created_at": "2023-04-03 16:03:33"
        },
        {
            "campaign_status": "NEW",
            "campaign_name": "Happy call",
            "campaign_id": 56616,
            "start_time": "2023-04-03 16:03:13",
            "end_time": "2023-04-03 16:03:13",
            "created_at": "2023-04-03 16:03:13"
        }
    ],
    "created_since": "2023-01-01 00:00:00",
    "created_to": "2023-04-24 15:29:36",
    "numFound": 3
}

Mô tả kết quả

STT	Trường dữ liệu	Ghi chú
1	code	Trạng thái thực thi ok, errors
2	campaigns	Mảng dữ liệu chiến dịch Gồm các object có cấu trúc campaign_status: Trạng thái chiến dịch campaign_name: Tên chiến dịch campaign_id: ID chiến dịch start_time: Ngày bắt đầu, end_time:Thời điểm kết thúc created_at: Ngày tạo v_type: Phiên bản chiến dịch (Đối với v_type=1 thì sẽ có thêm danh sách các trạng thái của chiến dịch, member_status.id sẽ tương đương member_status_id khi tạo hay update phiếu ghi. "member_status": [ { "id": 349, "description": "Chưa gửi", "is_default": 1, "campaign_id": 81584 },...
3	created_to	Thời điểm lọc chiến dịch đến theo ngày tạo
4	numFound	Số lượng chiến dịch tìm ra
5	created_since	Thời điểm lọc chiến dịch đến theo ngày tạo