v2

API Khách hàng version 2

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

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

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

Headers

NameTypeDescription

Content-Type

String

application/json

Authorization

String

Bearer Access: Bearer 'token'

Request Body

NameTypeDescription

refId

String

Mã của khách hàng bên đối tác

tags

array

Danh sách tên thẻ tag. Ví dụ: ["Lead", "Contact"]

business

array

Danh sách tên các ngành. Ví dụ: ["Food", "Education"]

categories

array

Danh sách tên các nhóm. Ví dụ: ["High Prioriry", "Low Priority"]

userOwnerEmail

string

Email của nhân viên phụ trách

avatarUrl

string

Avatar của khách hàng

fullName

string

Tên đầy đủ của khách hàng

gender

string

Giới tính của khách hàng. Chấp nhận 1 trong các giá trị sau: male, female, other

passport

string

Hộ chiếu hoặc ID card

jobTitlte

string

Nghề nghiệp

address

string

Địa chỉ

refCode

string

Mã code của khách hàng bên đối tác

refType

string

Type của khách hàng bên đối tác

note

string

Ghi chú

phones

array

Danh sách đối tượng PHONE Ví dụ:

[

{

data : "0989xxxxxx",

type : "home",

valueType : "Nhà"

}

]

//type => home, personal, office

//valueType => "Nhà", "Cá nhân", "Công ty"

emails

array

Danh sách đối tượng EMAIL Ví dụ:

[

{

data : "xxx@gmail.com",

type : "home",

valueType : "Nhà"

}

]

//type => home, personal, office

//valueType => "Nhà", "Cá nhân", "Công ty"

filterContacts

array

Phễu khách hàng

Ví dụ:

[

{

id : "xxx",

index : 1,

secondLevelIndex : 1

}

]

//id: Id của phễu

//index: thứ tự trạng thái cấp 1

//secondLevelIndex : thứ tự trạng thái cấp 2 (nếu có)

{
    "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/v2/contact/addMany

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

Headers

NameTypeDescription

Content-Type

String

application/json

Authorization

String

Bearer Access: Bearer 'token'

Request Body

NameTypeDescription

data

array

Mảng thông tin các khách hàng cần thêm vào. Mẫu như sau:

[

{

refId : "",

tags" : [],

business : [],

categories : [],

userOwnerEmail : "",

avatarUrl : "",

fullName : "",

gender : "",

passport : "",

jobTitle : "",

address : "",

refCode : "",

refType : "",

note : "",

phones : [],

emails : [],

filterContacts : []

}

]

// kiểu giá trị của các trường tham khảo ở API Tạo mới khách hàng

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

Cập nhật khách hàng

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

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

Headers

NameTypeDescription

Authorization

string

Access Token : Bearer 'token'

Content-type

string

application/json

Request Body

NameTypeDescription

refId

string

Mã của khách hàng bên đối tác

tags

array

Danh sách tên thẻ tag cần thêm vào. Ví dụ: ["Company"]

business

array

Danh sách tên các ngành cần thêm vào. Ví dụ: ["E-Commerce"]

categories

array

Danh sách tên các nhóm. Ví dụ: ["Medium"]

tagRemoves

array

Danh sách tên thẻ tag cần xóa. Ví dụ: ["Contact"]

businessRemoves

array

Danh sách tên các ngành cần xóa. Ví dụ: ["Food"]

categoriesRemoves

array

Danh sách tên các nhóm cần xóa. Ví dụ: ["High Priority"]

userOwnerEmail

string

Email của nhân viên phụ trách

avatarUrl

string

Avatar khách hàng

fullName

string

Tên khách hàng

gender

string

Giới tính khách hàng. Chấp nhận 1 trong các giá trị sau: male, female, other

passport

String

Hộ chiếu hoặc ID card

jobTitle

String

Nghề nghiệp

address

String

Địa chỉ

note

String

Ghi chú

phones

array

Danh sách đối tượng PHONE Ví dụ:

[

{

data : "0989xxxxxx",

type : "home",

valueType : "Nhà"

}

]

//type => home, personal, office

//valueType => "Nhà", "Cá nhân", "Công ty"

emails

array

Danh sách đối tượng EMAIL Ví dụ:

[

{

data : "xxx@gmail.com",

type : "home",

valueType : "Nhà"

}

]

//type => home, personal, office

//valueType => "Nhà", "Cá nhân", "Công ty"

filterContacts

array

Phễu khách hàng

Ví dụ:

[

{

id : "xxx",

index : 1,

secondLevelIndex : 1

}

]

//id: Id của phễu

//index: thứ tự trạng thái cấp 1

//secondLevelIndex : thứ tự trạng thái cấp 2 (nếu có)

otherDynamicUpdates

array

Cập nhật các trường thuộc tính động khác.

Ví dụ:

[

{

fieldCode: "xxx",

values: [

{

data : "yyy",

type : "",

valueType : ""

}

]

}

]

{
    "status_code": 9999,
    "instance_id": "stg",
    "instance_name": "DESKTOP-3I0NHO0",
    "payload": true/false,
    "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

NameTypeDescription

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

NameTypeDescription

Authorization

string

Bearer Access: Bearer 'token'

Content-type

string

application/json

Request Body

NameTypeDescription

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

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

Chi tiết khách hàng

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

NameTypeDescription

id

String

Id contact

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

Danh sách các thuộc tính động

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

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

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

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

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

Last updated