Create

Post

curl --location 'https://{{base_url}}/v3/lead' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '{
    "list_uuid": "c4869e79-f0fa-4c6a-9410-bc0defac375a",
    "lead_name": "Demo01",
    "lead_code": "DP01",
    "phone_number": "0349719999"
}'

Response trả về:

{
	"created": true,
	"lead_uuid": "152a5c45-68f0-4ee7-85c0-32ae87bb611b"
}

Error Response trả về:

{
	"error": [
		{
			"list_uuid": "String length must be greater than or equal to 36"
		}
	]
}

{
	"error": [
		{
			"phone_number": "String length must be greater than or equal to 1"
		},
		{
			"phone_number": "Does not match pattern '^(84|0[3|5|7|8|9])+([0-9]{8})$'"
		}
	]
}

API này dùng để tạo lead và gán vào danh sách đã có sẵn.

HTTP Request

POST https://{{base_url}}/v3/lead

Body

Sample data:

{
	"list_uuid": "c4869e79-f0fa-4c6a-9410-bc0defac375a",
	"lead_name": "Demo01",
	"lead_code": "DP01",
	"phone_number": "0349719999"
}

Parameter	Description	Required
list_uuid	UUID của danh sách cần gán lead vào	x
lead_name	Tên khách hàng
lead_code	Mã khách hàng
phone_number	Số điện thoại khách hàng	x
contract_number	Số hợp đồng
identity_number	Số CMND
identity_issued_at	Nơi cấp CMND
identity_issued_on	Ngày cấp CMND
address	Địa chỉ
province	Tỉnh/Thành phố
district	Quận/Huyện
ward	Phường/Xã
date_of_birth	Ngày sinh
additional	Thông tin bổ sung
gender	Giới tính

Post Lead With CSV File

curl --location 'https://{{base_url}}/v3/lead/file' \
--header 'Authorization: Bearer {{token}}' \
--form 'file=@"/D:/DOCUMENT/Template_Upload_Lead/template_lead_viettel.csv"' \
--form 'list_uuid="c4869e79-f0fa-4c6a-9410-bc0defac375a"'

Response trả về:

{
	"msg": "file upload is processing"
}

Error Response trả về:

{
	"error": "list_uuid is missing"
}

{
	"error": "http: no such file"
}

API này dùng để upload lead qua file csv và gán vào danh sách đã có sẵn.

HTTP Request

POST https://{{base_url}}/v3/lead

Body

Sample data:

--form 'file=@"/D:/DOCUMENT/Template_Upload_Lead/template_lead_viettel.csv"' \
--form 'list_uuid="c4869e79-f0fa-4c6a-9410-bc0defac375a"'

Parameter	Description	Required
list_uuid	UUID của danh sách cần gán lead vào	x
file	Đường dẫn file cần upload lại máy local	x

Post Lead Multiple

curl --location 'https://{{base_url}}/v3/lead/multi' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data '{
    "list_uuid": "a7d4d5d8-751f-4502-b175-a988ac022717",
    "data": [
        {
            "lead_name": "Phùng Phùng",
            "phone_number": "0949719066",
            "contract_number": "ABC123",
            "after_day": 0
        },
        {
            "lead_name": "Luân Luân",
            "phone_number": "0934567489",
            "contract_number": "ABCXYZ",
            "after_day": 0
        }
    ]
}'

Response trả về:

{
	"message": "success",
	"total_insert": 2
}

Error Response trả về:

{
	"error": "list_uuid is missing"
}

API này dùng để tạo cùng lúc nhiều lead bằng một request và gán vào danh sách đã có sẵn.

HTTP Request

POST https://{{base_url}}/v3/lead

Body

Sample data:

{
	"list_uuid": "a7d4d5d8-751f-4502-b175-a988ac022717",
	"data": [
		{
			"lead_name": "Phùng Phùng",
			"phone_number": "0949719066",
			"contract_number": "ABC123",
			"after_day": 0
		},
		{
			"lead_name": "Luân Luân",
			"phone_number": "0934567489",
			"contract_number": "ABCXYZ",
			"after_day": 0
		}
	]
}

Parameter	Description	Required
list_uuid	UUID của danh sách cần gán lead vào	x
data	Các dữ liệu cần truyền vào	x
data.lead_name	Tên khách hàng
data.phone_number	Số điện thoại khách hàng	x
data.contract_number	Số hợp đồng khách hàng
data.after_day	Số ngày sau khi tạo lead sẽ được gọi