API nhận data khách hàng mới

Last updated: May 8, 2020

Download Postman example PEROB CRM-ADS.postman_collection.json

Là API dùng cho việc nhận thông tin khách hàng từ các nguồn quảng cáo hoặc đối tác quảng cáo.

Lưu ý, khi gửi data vào CRM, data sẽ được xử lý theo các bước như sau:

  1. Bước 1. Lấy thông tin UTM từ trường link nếu lấy được thông tin UTM thì bỏ qua bước 2, thực hiện bước 3.
  2. Bước 2. Lấy thông tin UTM từ các trường utm_* mà API nhận được.
  3. Bước 3. Tìm Chiến dịch marketing tương ứng với các UTM lấy được sau 2 bước trên.
    1. Nếu tìm thấy chiến dịch marketing gắn chiến dịch và Nguồn marketing của chiến dịch đó cho data khách hàng. Thực hiện bước 5.
    2. Nếu không tìm thấy chiến dịch marketing tương ứng thì thực hiện bước 4.
  4. Bước 4. Tạo chiến dịch marketing mới với các thông tin utm fields ở bước 2 và sản phẩm tương ứng với mã sản phẩm trong CRM.
  5. Bước 5.
    1. Nếu thông tin khách hàng chưa tồn tại trong hệ thống với label L0 thì trả response thành công và hiển thị thông tin khách hàng trong danh sách khách hàng tiềm năng với label L0.
    2. Nếu thông tin khách hàng đã tồn tại trong hệ thống cũng với label L0 thì sẽ trả response thông báo lỗi trùng lặp dữ liệu, không tạo mới.

  • Request:

POST /crm/v1/single_product_potential_customers/ HTTP/1.1

  • Headers:

Authorization: Token {{API_TOKEN}}

Content-Type: application/json

  • Data:

{
"name": "Nguyen Van Test",
"phone": "0999999990",
"product_code": "ich-mau",
"reference_id": "reference_id",
"form_id": "form_id",
"address": "address",
"message": "this is test phone number, do not call",
"note": "note",
"extra1": "extra11",
"extra2": "extra12",
"extra3": "extra13",
"link": "http://tinhhau.tinhhaubienob.info/?utm_source=utm_source5&utm_medium=utm_medium&utm_campaign=utm_campaign&utm_content=utm_content&fid=fid1",
"utm_content": "utm_content (option)",
"utm_campaign": "utm_campaign (option)",
"utm_source": "utm_source (option)",
"utm_medium": "utm_medium (option)"
}

  • Mô tả tham số
Mô tả tham số
Tham số Kiểu Bắt buộc Mô tả
name String Tên khách hàng
phone String Số điện thoại của khách hàng
product_code String Mã sản phẩm cần tư vấn do CRM cấp
address String Không Địa chỉ khách hàng
gender Integer Không Giới tính khách hàng, 0 - nam, 1 - nữ
message String Không Thông tin khách hàng để lại
source String Không Mã nguồn chiến dịch do CRM cung cấp,
*nếu là đối tác quảng cáo thì BẮT BUỘC phải nhập thông tin này*
note String Không Ghi chú thêm nếu có, sẽ lưu vào trường ghi chú trong CRM
reference_id String Không Là mã định danh duy nhất của khách hàng trong hệ thống của Đối tác quảng cáo,
dùng để tham chiếu giữa CRM với Đối tác quảng cáo trong mọi trường hợp.
*Nếu là đối tác quảng cáo thì BẮT BUỘC phải có thông tin này*
link String Không Là utm_link của chiến dịch quảng cáo, CRM sẽ lấy thông tin chiến dịch quảng cáo theo trường này.
Trong một số trường hợp trường này không có thông tin chiến dịch thì CRM sẽ lấy thông tin từ các trường utm_* dưới đây.

- *Lưu ý* : trường thông tin *fid* sẽ được sử dụng để phân biệt nếu có nhiều tài khoản quảng cáo chạy chung 1 campaign. Thông thường, marketer sẽ điền id của tài khoản quảng cáo vào trường thông tin này, hoặc 1 mã định danh duy nhất mà marketer mong muốn.
utm_source String Không
utm_medium String Không
utm_campaign String Không
utm_content String Không
form_id String Không Id của form đặt trong landing page (dùng để tracking hiệu quả vị trí đặt form nếu cần)
extra1, ... extraN String Không Các trường thông tin mà không được định nghĩa ở trên, nếu gửi vào CRM sẽ được lưu vào note của data.
  • Response:
    • Thành công:

{
"success":
true,
"data": {
"created_ids": [7528]
}
}

{
"success":
false,
"error_message": "{\"non_field_errors\": [\"Khách hàng này đã tồn tại\"]}"
}

{
"success":
false,
"error_message": "Thông báo lỗi"
}