Skip to navigation
Khách hàngThông tin khách hàng

Chi tiết khách hàng

Tra theo customerId duy nhất — chính là id công khai (11 ký tự [0-9A-Z]) mà API trả về; không nhận id nội bộ (UUID). Scope yêu cầu: customer:read; agent cần quyền xem. Khách hàng ngoài phạm vi dữ liệu của agent, hoặc thuộc tenant khác: 404.

Headers

X-Api-KeystringRequired

Query parameters

customerIdstringRequiredformat: "^[0-9A-Z]{11}$"

customerId do API trả về (11 ký tự [0-9A-Z]). Gửi id nội bộ (UUID) sẽ bị từ chối.

Response

Khách hàng.

customerIdstringOptionalformat: "^[0-9A-Z]{11}$"
lifecycleStagesstringOptional
statusstringOptional
fullNamestringOptional
phonestringOptional

Có thể đã bị che.

emailstringOptional

Có thể đã bị che.

genderstringOptional
dateOfBirthlongOptional
Epoch millis.
customerSourcestringOptional
avatarUrlstringOptional
refIdstringOptional
attributesmap from strings to anyOptional

Khoá theo fieldCode.

aiAttributesmap from strings to anyOptional

Câu trả lời của Agent Bot (AI Insight), có ở cả GET /customers và search. Khoá theo id của card trong Danh sách tiêu chí AI Insights — là mã kỹ năng (card SYSTEM) hoặc id của card (card CUSTOM không có mã). Chỉ trả về card đang được cấu hình; card chưa có câu trả lời sẽ không xuất hiện. Giá trị theo valueType: TEXT/SINGLE_SELECT → chuỗi, STRING_LIST → mảng chuỗi, RATING → số, BOOLEAN → boolean.

socialIdsmap from strings to stringsOptional

Chỉ có ở GET /customers, không có khi search.

assignedAgentIdstringOptional
relatedAgentIdslist of stringsOptional
relatedCustomerUidslist of stringsOptional
tagIdslist of stringsOptional
groupIdslist of stringsOptional
workflowStateslist of objectsOptional

Các quy trình chăm sóc đang gắn với khách hàng.

createdBystringOptional

id của agent tạo khách hàng — public-service khi tạo qua API này.

createdAtlongOptional
lastModifiedBystringOptional

id của agent sửa khách hàng gần nhất.

lastModifiedAtlongOptional
lastLifecycleStageTimelongOptional

Thời điểm chuyển sang giai đoạn hành trình hiện tại.

lastInteractionAtlong or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
502
Bad Gateway Error
503
Service Unavailable Error