Khách hàng
Các API liên quan đến người dùng, khách hàng
Trên hệ thống CareSoft. Mỗi người dùng/Khách hàng được định nghĩa bằng số điện thoại hoặc email. Một người dùng có tối đa ba (03) số điện thoại và hai (02) email làm định danh.
Các trường thông tin của người dùng
STT | Tên trường | Kiểu dữ liệu | Ghi chú |
---|---|---|---|
1 | id | INT | ID của người dùng |
2 | username | TEXT(255) | Họ tên |
3 | EMAIL | Email người dùng | |
4 | email2 | EMAIL | Email thứ 2 |
5 | phone_no | TELEPHONE | Số điện thoại của người dùng |
6 | phone_no2 | TELEPHONE | Số điện thoại thứ 2 |
7 | phone_no3 | TELEPHONE | Số điện thoại thứ 3 |
8 | created_at | DATETIME | Ngày tạo |
9 | updated_at | DATETIME | Ngày cập nhật. |
10 | created_from | INT | Nguồn tạo (Xem danh sách nguồn) Cột Source ID |
11 | organization_id | INT | ID tổ chức |
12 | organization | TEXT(255) | Tên tổ chức |
13 | city_id | INT | ID thành phố (Tham khảo danh sách tỉnh thành) |
14 | district_id | INT | ID huyện/quận |
15 | address | TEXT(255) | Địa chỉ |
16 | gender | INT | Giới tính: 0. Nam, 1 Nữ, 2 Không xác định |
17 | INT | ID facebook (De-precade) | |
18 | campaign_handler_id | INT | ID chiến dịch xử lý |
19 | custom_fields | ARRAY | Danh sách trường động |
20 | follower_id | INT | Id của chuyên viên quản lý (xem Chuyên viên Trường ID |
21 | take_phone_at | DATETIME | Thời điểm thu thập được số điện thoại (Null hoặc Ngày tháng) |
22 | take_email_at | DATETIME | Thời điểm thu thập được email(Null hoặc Ngày tháng) |
Thêm mới khách hàng
Để thêm mới khách hàng. Lập trình viên cần tạo 1 đối tượng contact kiểu Json Object có cấu trúc sau. Các trường dữ liệu
Ví dụ tham khảo mẫu POSTMAN tạo mới khách hàng
Thêm mới khách hàng
POST
{{domain}/api/v1/contacts
Headers
Name | Type | Description |
---|---|---|
** | String |
Request Body
Name | Type | Description |
---|---|---|
contact | Object | Cấu trúc object ở trên |
Cập nhật khách hàng
Trong trường hợp có thay đổi thông tin khách hàng, VD: Thay đổi số điện thoại, email hay thông tin người phụ trách hoặc các thông tin phân loại được tùy biến. Lập trình viên sử dụng hàm này để cập nhật dữ liệu lên hệ thống
Gợi ý: Trong một số trường hợp không lưu contactId của khách hoặc khách phát sinh trước khi tích hợp, thì sử dụng hàm tạo mới khách hàng sau đó dựa trên dublicated_id
phát sinh (nếu trùng) để thực hiện cập nhật
Cập nhật người dùng
PUT
{{domain}/api/v1/contacts/{{contactId}}
Headers
Name | Type | Description |
---|---|---|
*** | String |
Request Body
Name | Type | Description |
---|---|---|
contact | Object | Cấu trúc object như ví dụ minh họa |
Danh sách khách hàng
Là dữ liệu biến thiên theo ngày tháng. Sẽ tăng dần theo thời gian, Danh sách này có kết quả gồm số ít trường thông tin mang tính chất điển hình gồm ID, số điện thoại, họ tên, email ngày tạo. Dựa vào danh sách này có thể lấy thông tin đầy đủ và chi tiết cho 1 khách hàng bằng api Chi tiết khách hàng phía dưới
Mẫu tham khảo cấu hình POSTMAN lấy danh sách khách hàng
Danh sách khách hàng
GET
{{domain}/api/v1/contacts
Query Parameters
Name | Type | Description |
---|---|---|
updated_since | DateTimeTZ | Có thời điểm cập nhật từ ngày (Kiểu dữ liệu YYYY-MM-DDTHH:mm:ssZ) |
updated_to | DateTimeTZ | Có thời điểm cập nhật đến ngày (Kiểu dữ liệu YYYY-MM-DDTHH:mm:ssZ) |
created_since | DateTimeTZ | Có thời điểm tạo từ ngày (Kiểu dữ liệu YYYY-MM-DDTHH:mm:ssZ) |
created_to | DateTimeTZ | Có thời điểm tạo từ ngày (Kiểu dữ liệu YYYY-MM-DDTHH:mm:ssZ) |
page | Int | Trang số |
count | Int | Số bản ghi trên trang (Tối đa 500) |
order_by | String | Sắp xếp theo trường dữ liệu (mặc định created_at) |
order_type | String | Kiểu sắp xếp DESC hoặc ASC (Giảm dần hoặc tăng dần) Mặc định DESC |
Headers
Name | Type | Description |
---|---|---|
*** | String |
Chi tiết khách hàng
Dựa vào các hàm tạo mới hay cập nhật khách hàng hoặc danh sách khách hàng, trả về các {{contactId}}. Nhà phát triển sử dụng hàm này để lấy thông tin chi tiết 1 khách hàng. API này bắt buộc phải có contactID mới thực hiện được
Chi tiết khách hàng
GET
{{domain}/api/v1/contacts/{{contactId}}
Headers
Name | Type | Description |
---|---|---|
*** | String |
Tìm khách hàng theo số điện thoại
Trong trường hợp cần tìm 1 khách hàng đã tồn tại hay chưa sử dụng API dưới đây, hệ thống sẽ trả về thông tin cơ bản của khách hàng.
Tìm khách hàng theo số điện thoại
GET
{{domain}/api/v1/api/v1/contactsByPhone
Sử dụng parametter phoneNo để tìm khách hàng (Xem ảnh mô tả)
Query Parameters
Name | Type | Description |
---|---|---|
phoneNo* | String | Số điện thoại của khách hàng (Dạng 0XXXXX) |
Last updated