Danh sách cơ hội
Endpoint
GET /api/v6.1/opportunities
Dùng API này khi cần lọc danh sách cơ hội theo chiến dịch (theo campaign_id hoặc campaign_code). Không truyền filtering[campaign_code] vào API chi tiết /opportunity.
Ví dụ yêu cầu
curl --location --globoff 'https://demo.getflycrm.com/api/v6.1/opportunities?fields=id,opportunity_name,opportunity_code,probability,opportunity_status,opportunity_status_name,recipient,rcpt_avatar,rcpt_display_name,rcpt_role_name,rcpt_department_name,created_at,time_registed,responsible,c_display_name,create_user,account_id,account_name,phone_office,account_email,campaign_id,campaign_name&filtering[campaign_code]=CD0008' \
--header 'X-API-KEY: YOUR_API_KEY'
Lọc theo ID chiến dịch:
curl --location --globoff 'https://demo.getflycrm.com/api/v6.1/opportunities?fields=id,opportunity_name,campaign_id,campaign_name&filtering[campaign_id]=25' \
--header 'X-API-KEY: YOUR_API_KEY'
Contains (mã chứa chuỗi):
curl --location --globoff 'https://demo.getflycrm.com/api/v6.1/opportunities?fields=id,opportunity_name,campaign_id&filtering[campaign_code:contains]=CD' \
--header 'X-API-KEY: YOUR_API_KEY'
Tham số truy vấn
| Tham số | Kiểu | Mô tả |
|---|---|---|
fields | string | Danh sách trường cần lấy (phân tách bằng dấu phẩy) |
limit / offset | integer | Phân trang |
sort / direction | string | Sắp xếp (vd id, DESC) |
Filtering
| Tham số | Toán tử | Kiểu | Mô tả |
|---|---|---|---|
filtering[id] | eq, ne, in | integer | ID cơ hội |
filtering[campaign_id] | eq, in | integer | ID chiến dịch |
filtering[campaign_code] | eq, in, contains | string | Mã chiến dịch |
filtering[opportunity_status] | eq, in | integer | Trạng thái cơ hội |
filtering[opportunity_status_name] | eq, contains | string | Tên trạng thái |
filtering[account_id] | eq, in | integer | ID khách hàng |
filtering[recipient] | eq, in | integer | ID người xử lý |
filtering[create_user] | eq, in | integer | ID người tạo |
filtering[valid] | is, in | integer | Bản ghi hợp lệ |
Không truyền toán tử (filtering[campaign_code]=CD0008) tương đương eq.
Phản hồi mẫu
{
"data": [
{
"id": 123456,
"opportunity_name": "Cơ hội ABC",
"opportunity_code": "CH123456",
"probability": 60,
"opportunity_status": 100,
"opportunity_status_name": "Gặp mặt và chăm sóc",
"recipient": 5,
"rcpt_avatar": "https://example.com/avatar.jpg",
"rcpt_display_name": "Người A",
"rcpt_role_name": "Trưởng phòng",
"rcpt_department_name": "Kinh doanh",
"created_at": "2025-05-29 10:00:08",
"time_registed": 0,
"responsible": 5,
"c_display_name": "Người tạo",
"create_user": 3,
"account_id": 7890,
"account_name": "Khách hàng ABC",
"account_email": "",
"campaign_id": 25,
"campaign_name": "Chiến dịch mẫu",
"status": 0,
"status_label": "Đang thực hiện",
"define_fields": {
"text_input": "JPSKW",
"number_input": "12"
}
}
],
"has_more": true,
"offset": 0,
"limited": 20,
"sorted": {
"id": "DESC"
}
}
Mô tả các trường chính
| Trường | Kiểu | Mô tả |
|---|---|---|
id | int | ID cơ hội |
opportunity_name | string | Tên cơ hội |
opportunity_code | string | Mã cơ hội |
probability | int | Xác suất thành công (%) |
opportunity_status | int | Mã trạng thái cơ hội |
opportunity_status_name | string | Tên trạng thái |
recipient | int | ID người nhận xử lý |
rcpt_display_name | string | Tên hiển thị người xử lý |
rcpt_avatar | string | Ảnh đại diện người xử lý |
rcpt_role_name | string | Vai trò người xử lý |
rcpt_department_name | string | Phòng ban người xử lý |
created_at | string (datetime) | Ngày tạo cơ hội |
time_registed | int | Thời điểm đăng ký (0 nếu không đặt) |
responsible | int | ID người phụ trách |
c_display_name | string | Tên người tạo |
create_user | int | ID người tạo |
account_id | int | ID khách hàng |
account_name | string | Tên khách hàng |
account_email | string | Email khách hàng |
campaign_id | int | ID chiến dịch |
campaign_name | string | Tên chiến dịch |
status | int | Trạng thái |
status_label | string | Nhãn trạng thái |
define_fields | object | Trường định nghĩa dữ liệu |
Xử lý lỗi thường gặp
| Mã | Nguyên nhân thường gặp |
|---|---|
400 invalid_parameter | Filtering field/toán tử không hỗ trợ (vd truyền filter sai API) |
| 401 | Thiếu hoặc sai X-API-KEY |