Khách hàng (customers)
Truy vấn và cập nhật hồ sơ khách hàng được hợp nhất từ các kênh, kèm ghi chú nội bộ của nhân viên.
Mỗi người liên hệ được lưu thành một hồ sơ khách hàng (customer), hợp nhất thông tin từ các kênh họ từng nhắn tin. Bạn có thể đọc danh sách, xem chi tiết, cập nhật thông tin và thêm ghi chú nội bộ.
Endpoints
| Method | Endpoint | Mô tả |
|---|---|---|
GET | /v1/customers | Danh sách khách hàng (lọc theo kênh, từ khoá) |
GET | /v1/customers/{id} | Chi tiết một khách hàng |
PUT | /v1/customers/{id} | Cập nhật hồ sơ (tên, điện thoại, email, địa chỉ) |
POST | /v1/customers/{id}/notes | Thêm ghi chú nội bộ cho khách |
Tham số truy vấn danh sách
| Tham số | Kiểu | Mô tả |
|---|---|---|
channel_id | string | Lọc khách đã liên hệ qua một kênh |
q | string | Tìm theo tên, số điện thoại hoặc email |
since | string | Khách tạo/ cập nhật từ thời điểm ISO-8601 |
page | integer | Số thứ tự trang |
per_page | integer | Số bản ghi mỗi trang, tối đa 100 |
Kiểm thử tại chỗ
GET
https://omni.hitechcloud.vn/v1/customersKiểm thử tại chỗNhập Access Token rồi bấm Gửi thử. Token không được lưu lại.
Query
cURL cập nhật hồ sơ khách (PUT)
curl -X PUT "https://omni.hitechcloud.vn/v1/customers/cus_01HZCUST" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Nguyen Van A",
"phone": "0909123456",
"email": "vana@example.com"
}'Phản hồi chi tiết khách hàng
{
"status": "success",
"data": {
"id": "cus_01HZCUST",
"name": "Nguyen Van A",
"phone": "0909123456",
"email": "vana@example.com",
"identities": [
{ "platform": "facebook", "external_id": "7788990011" },
{ "platform": "zalo", "external_id": "zl_55443322" }
],
"tags": ["khach-than-thiet"],
"last_contacted_at": "2026-10-31T09:35:00+07:00",
"created_at": "2026-05-12T10:00:00+07:00"
}
}Trường
identities cho biết khách này tương ứng với những định danh nào trên từng nền tảng, nhờ đó bạn tránh tạo trùng hồ sơ khi khách nhắn qua nhiều kênh.Mỗi người liên hệ được lưu thành một hồ sơ khách hàng (customer), hợp nhất thông tin từ các kênh họ từng nhắn tin. Bạn có thể đọc danh sách, xem chi tiết, cập nhật thông tin và thêm ghi chú nội bộ.
Endpoints
| Method | Endpoint | Mô tả |
|---|---|---|
GET | /v1/customers | Danh sách khách hàng (lọc theo kênh, từ khoá) |
GET | /v1/customers/{id} | Chi tiết một khách hàng |
PUT | /v1/customers/{id} | Cập nhật hồ sơ (tên, điện thoại, email, địa chỉ) |
POST | /v1/customers/{id}/notes | Thêm ghi chú nội bộ cho khách |
Tham số truy vấn danh sách
| Tham số | Kiểu | Mô tả |
|---|---|---|
channel_id | string | Lọc khách đã liên hệ qua một kênh |
q | string | Tìm theo tên, số điện thoại hoặc email |
since | string | Khách tạo/ cập nhật từ thời điểm ISO-8601 |
page | integer | Số thứ tự trang |
per_page | integer | Số bản ghi mỗi trang, tối đa 100 |
Kiểm thử tại chỗ
GET
https://omni.hitechcloud.vn/v1/customersKiểm thử tại chỗNhập Access Token rồi bấm Gửi thử. Token không được lưu lại.
Query
Trường
identities cho biết khách này tương ứng với những định danh nào trên từng nền tảng, nhờ đó bạn tránh tạo trùng hồ sơ khi khách nhắn qua nhiều kênh.cURL cập nhật hồ sơ khách (PUT)
curl -X PUT "https://omni.hitechcloud.vn/v1/customers/cus_01HZCUST" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Nguyen Van A",
"phone": "0909123456",
"email": "vana@example.com"
}'Phản hồi chi tiết khách hàng
{
"status": "success",
"data": {
"id": "cus_01HZCUST",
"name": "Nguyen Van A",
"phone": "0909123456",
"email": "vana@example.com",
"identities": [
{ "platform": "facebook", "external_id": "7788990011" },
{ "platform": "zalo", "external_id": "zl_55443322" }
],
"tags": ["khach-than-thiet"],
"last_contacted_at": "2026-10-31T09:35:00+07:00",
"created_at": "2026-05-12T10:00:00+07:00"
}
}