v1

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

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

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 "agent1@gmail.com" // Email nhân nhân viên ] } ]

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

"agent1@gmail.com" // Email nhân nhân viên

]

} ]

{
    "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": "tientv1212@gmail.com",
                                "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'

Name

Type

Description

Content-Type

string

application/json

Authorization

string

Bearer Access: Bearer 'token'

Request Body

Name Type Description

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: "tientv@demo.com.nv", 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 }]`

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

Name

Type

Description

Authorization

string

Access token: Bearer 'token'

Content-type

string

application/json

{
    "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

Name

Type

Description

Authorization

string

Access Token : Bearer 'token'

Content-type

string

application/json

Request Body

Name Type Description

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 : "tientv@demo.com.vn", 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"` `}] }]`

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

Name

Type

Description

string

Id khách hàng

Headers

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

Name

Type

Description

Authorization

string

AccessToken. Bearer 'token'

Content-type

string

application/json

{
    "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

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

{
    "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

Name

Type

Description

phone

String

Số điện thoại

String

ref_id

String

Id bên thứ 3

ref_code

String

Mã bên thứ 3

{
    // 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

Name

Type

Description

String

Id contact

{
    // 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

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

PreviousKhách hàng Nextv2

Last updated 2 months ago