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

Tìm kiếm khách hàng

Body rỗng trả về trang 1 của toàn bộ khách hàng trong phạm vi dữ liệu của agent. Scope yêu cầu: customer:read. Kết quả chỉ giới hạn trong phạm vi xem của agent gắn với key.

Headers

X-Api-KeystringRequired

Request

This endpoint expects an object.
filtermap from strings to anyOptional

Tương ứng CustomerFilter của web app — ví dụ keyword, lifecycleStages[], statuses[], createdFrom/createdTo (epoch millis), assignedAgentId, tagIds[], groupIds[], conditions[] ({field, operator, value|values}) trong đó field là fieldCode của thuộc tính (hoặc phone/ email), không bao giờ là slot lưu trữ thô. Lọc theo thuộc tính mức Che dữ liệu/Bảo mật cần agent có quyền tương ứng, nếu không sẽ trả 403.

sortlist of objectsOptional
paginationobjectOptional

Response

Một trang kết quả khách hàng.

itemslist of objectsOptional
pageintegerOptional
sizeintegerOptional
totalItemslongOptional
totalPagesintegerOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
503
Service Unavailable Error