Khách hàng

Quản lý khách hàng

Tìm kiếm khách hàng

POST [URL]/api/contacts/list

Tìm kiếm khách hàng

Query Parameters

Name	Type	Description
page	number	Trang. Bắt đầu từ 1. Mặc định là 1
size	number	Kích thước trang. Mặc định là 50

Headers

Name	Type	Description
Authorization	string	Bearer Access: Bearer 'token'
Content-type	string	application/json

Request Body

Name	Type	Description
keyword	String	Từ khóa tìm kiếm. Có thể một trong các giá trị - Số điện thoại - Email - Họ và tên
filters	Array	Lọc "filters": [ { "field_code" : "contact_owner", // Người phụ trách "value":[ "unassigned", // chưa gán "[e-mail]" // Email nhân nhân viên ] } ]

200 Dữ liệu trả về thành công

{
    "status_code": 9999,
    "instance_id": "stg",
    "instance_name": "DESKTOP-3I0NHO0",
    "payload": {
        "next_page": 1,
        "page_number": 1,
        "has_previous": false,
        "has_next": false,
        "total_pages": 1,
        "previous_page": 1,
        "total_items": 1,
        "page_size": 50
        "items": [
            {
                "public_id": "", // Id
                "create_by": {
                    "name": "TestBoss 123"
                },
                "last_update_by": {
                    "name": "TestBoss 123"
                },
                "created_date": 1576229754881,
                "last_updated_date": 1580807004410,
                "contact_type": "contact",
                "tags_view": null,
                "is_deleted": false, // Trạng thái
                "tags": [], // Thẻ tags khách hàng
                "attribute_structure": [
                    {
                        "identify": false,
                        "field_code": "full_name",
                        "field_type": "single_text",
                        "value": [
                            {
                                "display_value": "Trần Văn Tiến 1",
                                "data_type": null,
                                "value_type": null
                            }
                        ]
                    },
                    {
                        "identify": false,
                        "field_code": "job_title",
                        "field_type": "single_text",
                        "value": [
                            {
                                "display_value": "Giám đốc",
                                "data_type": null,
                                "value_type": null
                            }
                        ]
                    },
                    {
                        "identify": false,
                        "field_code": "gender",
                        "field_type": "radio",
                        "value": [
                            {
                                "display_value": "male",
                                "data_type": null,
                                "value_type": null
                            }
                        ]
                    },
                    {
                        "identify": false,
                        "field_code": "phone_number",
                        "field_type": "phone",
                        "value": [
                            {
                                "display_value": "0395187319",
                                "data_type": "personal",
                                "value_type": "Cá nhân"
                            }
                        ]
                    },
                    {
                        "identify": false,
                        "field_code": "mail",
                        "field_type": "email",
                        "value": [
                            {
                                "display_value": "[e-mail]",
                                "data_type": "personal",
                                "value_type": "Cá nhân"
                            }
                        ]
                    },
                    {
                        "identify": false,
                        "field_code": "address",
                        "field_type": "single_text",
                        "value": [
                            {
                                "display_value": "Số 6 , đường 16, Hiệp Bình Chánh, Thủ Đức, HCM",
                                "data_type": null,
                                "value_type": null
                            }
                        ]
                    },
                    {
                        "identify": false,
                        "field_code": "passport",
                        "field_type": "single_text",
                        "value": [
                            {
                                "display_value": "",
                                "data_type": null,
                                "value_type": null
                            }
                        ]
                    },
                    {
                        "identify": false,
                        "field_code": "note",
                        "field_type": "multi_text",
                        "value": [
                            {
                                "display_value": "Khách hàng VIP, cần được chăm sóc kĩ",
                                "data_type": null,
                                "value_type": null
                            }
                        ]
                    },
                    {
                        "identify": false,
                        "field_code": "more_infomation",
                        "field_type": "customize",
                        "value": [
                            {
                                "display_value": "Nguyễn Văn B",
                                "data_type": "value1",
                                "value_type": "Người thân"
                            },
                            {
                                "display_value": "Vàng",
                                "data_type": "label2",
                                "value_type": "Màu sắc yêu thích"
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "key_enabled": false
}

Tìm kiếm khách hàng

POST [URL]/api/v2/contact/search

Tìm kiếm khách hàng

Query Parameters

Name	Type	Description
page	number	Trang. Bắt đầu từ 1. Mặc định là 1
size	number	Kích thước trang. Mặc định là 50

Headers

Name	Type	Description
Authorization	string	Bearer Access: Bearer 'token'
Content-type	string	application/json

Request Body

Name	Type	Description
keyword	String	Từ khóa tìm kiếm. Có thể một trong các giá trị - Số điện thoại - Email - Họ và tên
tags	Array	Lọc theo tags "tags": ["Demo"]
business	Array	Lọc theo ngành "business": ["Demo"]
categories	Array	Lọc theo nhóm "categories" :["Demo"]
ranges	Array	Lọc theo thời gian "ranges" :[{ "field": "created_date", "from": 1704819600000, "to": 1704905999999 }]
includeIds	Array	Lọc khách hàng có id thuộc mảng "includeIds":["123", "345"]
excludeIds	Array	Lọc khách hàng có id không thuộc mảng "excludeIds":["123", "345"]

200 Dữ liệu trả về thành công

{
    "status_code": 9999,
    "instance_id": "stg",
    "instance_name": "DESKTOP-3I0NHO0",
    "payload": {
        "next_page": 1,
        "page_number": 1,
        "has_previous": false,
        "has_next": false,
        "total_pages": 1,
        "previous_page": 1,
        "total_items": 1,
        "page_size": 50
        "items": [
            {
                "public_id": "", // Id
                "create_by": {
                    "name": "TestBoss 123"
                },
                "last_update_by": {
                    "name": "TestBoss 123"
                },
                "created_date": 1576229754881,
                "last_updated_date": 1580807004410,
                "contact_type": "contact",
                "tags_view": null,
                "is_deleted": false, // Trạng thái
                "tags": [], // Thẻ tags khách hàng
                "attribute_structure": [
                    {
                        "identify": false,
                        "field_code": "full_name",
                        "field_type": "single_text",
                        "value": [
                            {
                                "display_value": "Trần Văn Tiến 1",
                                "data_type": null,
                                "value_type": null
                            }
                        ]
                    },
                    {
                        "identify": false,
                        "field_code": "job_title",
                        "field_type": "single_text",
                        "value": [
                            {
                                "display_value": "Giám đốc",
                                "data_type": null,
                                "value_type": null
                            }
                        ]
                    },
                    {
                        "identify": false,
                        "field_code": "gender",
                        "field_type": "radio",
                        "value": [
                            {
                                "display_value": "male",
                                "data_type": null,
                                "value_type": null
                            }
                        ]
                    },
                    {
                        "identify": false,
                        "field_code": "phone_number",
                        "field_type": "phone",
                        "value": [
                            {
                                "display_value": "0395187319",
                                "data_type": "personal",
                                "value_type": "Cá nhân"
                            }
                        ]
                    },
                    {
                        "identify": false,
                        "field_code": "mail",
                        "field_type": "email",
                        "value": [
                            {
                                "display_value": "[e-mail]",
                                "data_type": "personal",
                                "value_type": "Cá nhân"
                            }
                        ]
                    },
                    {
                        "identify": false,
                        "field_code": "address",
                        "field_type": "single_text",
                        "value": [
                            {
                                "display_value": "Số 6 , đường 16, Hiệp Bình Chánh, Thủ Đức, HCM",
                                "data_type": null,
                                "value_type": null
                            }
                        ]
                    },
                    {
                        "identify": false,
                        "field_code": "passport",
                        "field_type": "single_text",
                        "value": [
                            {
                                "display_value": "",
                                "data_type": null,
                                "value_type": null
                            }
                        ]
                    },
                    {
                        "identify": false,
                        "field_code": "note",
                        "field_type": "multi_text",
                        "value": [
                            {
                                "display_value": "Khách hàng VIP, cần được chăm sóc kĩ",
                                "data_type": null,
                                "value_type": null
                            }
                        ]
                    },
                    {
                        "identify": false,
                        "field_code": "more_infomation",
                        "field_type": "customize",
                        "value": [
                            {
                                "display_value": "Nguyễn Văn B",
                                "data_type": "value1",
                                "value_type": "Người thân"
                            },
                            {
                                "display_value": "Vàng",
                                "data_type": "label2",
                                "value_type": "Màu sắc yêu thích"
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "key_enabled": false
}

Tạo mới khách hàng

POST [URL]/api/contacts/add

Tạo mới khách hàng

Headers

Name	Type	Description
Content-Type	string	application/json
Authorization	string	Bearer Access: Bearer 'token'

Request Body

Name	Type	Description
tags	array	Danh sách thẻ tags Ví dụ : "tags" : ["Khách lẻ", "Khách có nhu cầu"]
more_infomation	array	Thông tin trường tùy chỉnh Ví dụ [ {value_type : "Cao", display_value: "1.75m"}, {value_type:"Nặng", display_value : "75kg"} {value_type:"Điểm", display_value: "90"} ]
user_owner_email	string	Email nhân viên phụ trách
refId	string	Id của khách hàng bên đối tác
refCode	string	Mã của khách hàng bên đối tác
job_title	string	Công việc / chức vụ của khách hàng
note	string	Ghi chú về khách hàng
birthday	string	Ngày tháng năm sinh, định dạng : (dd/MM/yyyy)
gender	string	Giới tính gồm ( 'other' : Giới tính khác; 'male' : Nam; 'female' : Nữ)
fullName	string	Họ và tên
passport	string	Hộ chiếu hoặc Id card
address	string	Địa chỉ
emails	array	Danh sách đối tượng EMAIL Ví dụ : [{ data: "[e-mail]", type : "home", // home, personal, office valueType: "Nhà" // Nhà, Cá nhân, Công ty }]
phones	array	Danh sách đối tượng PHONE Ví dụ : [{ data: "02525485xxx", type : "home", // home, personal, office valueType : "Nhà" // Nhà, Cá nhân, Công ty }]

200 Dữ liệu trả về khi yêu cầu thành công

{
    "status_code": 9999,
    "instance_id": "stg",
    "instance_name": "DESKTOP-3I0NHO0",
    "payload": true /false,
    "key_enabled": false
}

Tạo nhiều khách hàng

POST [URL/api/contacts/add-more

Tạo danh nhiều khách hàng, Request Body là array Object đối tượng khách hàng lúc tạo mới. API xử lý bất đồng bộ

Path Parameters

Name	Type	Description
Authorization	string	Access token: Bearer 'token'
Content-type	string	application/json

200 Tạo danh sách thành công

{
    "status_code": 9999,
    "instance_id": "stg",
    "payload": true /false,
    "key_enabled": false
}

Sửa thông tin khách hàng

POST [URL]/api/contacts/update

Sửa thông tin khách hàng

Headers

Name	Type	Description
Authorization	string	Access Token : Bearer 'token'
Content-type	string	application/json

Request Body

Name	Type	Description
tags	array	Danh sách thẻ tags Ví dụ : "tags":["Khách lẻ","Khách có nhu cầu"]
refId	string	Id khách hàng
birthday	string	Ngày tháng năm sinh: định dạng (dd/MM/yyyy)
more_infomation	array	Thông tin trường tùy chỉnh [ {"value_type":"Điểm","display_value":"20"}, {"value_type":"Đơn","display_value":"10"}, {"value_type":"Tiền","display_value":"500000"} ]
user_owner_email	string	Email người phụ trách
fullName	string	Họ và tên
gender	string	Giới tính ('other' : Giới tính khác; 'male' : Nam; 'female' : Nữ)
passport	string	Hộ chiếu hoặc id card
address	string	Địa chỉ
note	string	Ghi chú
emails	array	Danh sách đối tượng EMAILS Ví dụ : [{ data : "[e-mail]", type: "home", // home, personal, office valueType: "Nhà" // Nhà, Cá nhân, Công ty }]
phones	array	Danh sách đối tượng PHONES Ví dụ : [{ data : "03256521XXX", type : "home", //home, personal/ office valueType : "Nhà" // Nhà, Cá nhân, Công ty }]
dynamic_attributes	array	Danh sách thuộc tính động Ví dụ : [{ field_code: "vWabCEBkqM", field_type: "single_text", dynamic_attribute_value:[{ display_value: "demo" }] }]

200 Dữ liệu thông tin khách hàng trả về, khi sửa thông tin thành công

{
    "status_code": 9999,
    "instance_id": "stg",
    "instance_name": "DESKTOP-3I0NHO0",
    "payload": true/false,
    "key_enabled": false
}

Sửa thông tin khách hàng V2

POST [URL]/api/v2/contact/update

Sửa thông tin khách hàng V2

Headers

Name	Type	Description
Authorization	string	Access Token : Bearer 'token'
Content-type	string	application/json

Request Body

Name	Type	Description
tags	array	Danh sách thẻ tags thêm Ví dụ : "tags":["Khách lẻ","Khách có nhu cầu"]
refId	string	Id khách hàng
moreInfo	array	Thông tin trường tùy chỉnh [{ data : "Dữ liệu từ API", type: "source", valueType: "Nguồn" }]
fullName	string	Họ và tên
gender	string	Giới tính ('other' : Giới tính khác; 'male' : Nam; 'female' : Nữ)
emails	array	Danh sách đối tượng EMAILS Ví dụ : [{ data : "[e-mail]", type: "home", // home, personal, office valueType: "Nhà" // Nhà, Cá nhân, Công ty }]
phones	array	Danh sách đối tượng PHONES Ví dụ : [{ data : "03256521XXX", type : "home", //home, personal/ office valueType : "Nhà" // Nhà, Cá nhân, Công ty }]
tagRemoves	array	Danh sách thẻ tags xóa Ví dụ : "tagRemoves":["Khách lẻ","Khách có nhu cầu"]
businessRemoves	array	Danh sách ngành thêm Ví dụ : "businessRemoves":["Ngành A","Ngành B"]
business	array	Danh sách ngành thêm Ví dụ : "business":["Ngành A","Ngành B"]
categoriesRemoves	array	Danh sách nhóm xóa Ví dụ : "categoriesRemoves":["Nhóm A","Nhóm B"]
categories	array	Danh sách nhóm thêm Ví dụ : "categories":["Nhóm A","Nhóm B"]
filterContacts	array	Danh sách trạng thái khách hàng Ví dụ : [{ id: "65234234234234234234a", "index": 3 , "secondLevelIndex" : 1 }]
otherDynamicUpdates	array	Danh sách các thuộc tính động khác Ví dụ: [{ "fieldCode": "vWabCEBkqM", "values":[{ "data": "demo", "type":"", "valueType":"", }] }]
note	String	Ghi chú khách hàng
avatarUrl	String	Link Avatar khách hàng
jobTitle	String	Nghề nghiệp khách hàng
address	String	Địa chỉ khách hàng
passport	String	Hộ chiếu, căn cước khách hàng
userOwnerEmail	String	Email nhân viên phụ trách khách hàng

200 Dữ liệu thông tin khách hàng trả về, khi sửa thông tin thành công

{
    "status_code": 9999,
    "instance_id": "stg",
    "instance_name": "DESKTOP-3I0NHO0",
    "payload": true/false,
    "key_enabled": false
}

Xóa khách hàng

DELETE [URL]/api/contacts/delete/:id

Xóa khách hàng thông qua Id

Path Parameters

Name	Type	Description
id	string	Id khách hàng

Headers

Name	Type	Description
Authorization	string	AccessToken. Bearer 'token'
Content-type	string	application/json

200 Xóa khách hàng thành công

{
    "status_code": 9999,
    "instance_id": "stg",
    "instance_name": "DESKTOP-3I0NHO0",
    "payload": true,
    "key_enabled": false
}

Tạo tương tác ghi chú

POST [URL]/api/contacts/add-note

Tạo nhiều tương tác. Request Body là Mảng đối tượng chứa các thuộc tính bên dưới

Request Body

Name	Type	Description
note_by	Strig	Email nhân viên
content*	Sting	Nội dung ghi chú
phone*	Strig	Số điện thoại khách hàng

200: OK

{
    "status_code": 9999,
    "instance_id": "stg",
    "instance_version": "1.2.163",
    "payload": 1, // Số tương tác đã gửi đi
    "key_enabled": false
}

GET [URL]/api/contacts/get

Query Parameters

Name	Type	Description
phone	String	Số điện thoại
email	String	Email
ref_id	String	Id bên thứ 3
ref_code	String	Mã bên thứ 3

200: OK

{
    // Thông tin chi tiết 1 contact
}

Lấy thông tin chi tiết của một khách hàng

GET [URL]/api/contacts/details/:id

Lấy thông tin chi tiết của một khách hàng

Path Parameters

Name	Type	Description
id	String	Id contact

200: OK

{
    // Thông tin chi tiết 1 contact
}

Lấy thông tin chi tiết của một khách hàng V2

GET [URL]/api/v2/contact/get/:id

Lấy thông tin chi tiết của một khách hàng

Path Parameters

Name	Type	Description
id	String	Id contact

200: OK

{
    // Thông tin chi tiết 1 contact
}

Lấy danh sách các thuộc tính động

GET [URL]/api/source_contact_layout/get

Lấy danh sách thuộc tính động

200: OK

{
    // Thông tin các thuộc tính động
}

Lấy danh sách các thuộc tính động V2

GET [URL]/api/v2/contact/layout/list

Lấy danh sách thuộc tính động V2

200: OK

{
    // Thông tin các thuộc tính động
}

Lấy danh sách bộ trạng thái khách hàng

GET [URL]/api/v2/contact/filterContact/list

Lấy danh sách bộ trạng thái khách hàng

200: OK

{
    // Thông tin các bộ trạng thái
}