Skip to navigation
Khách hàngTương tác

Gửi đánh giá, hoặc mở link đánh giá cho khách hàng

Scope yêu cầu: customer:write. Agent cần quyền tạo đánh giá (crm.feedback → create) và khách hàng phải nằm trong phạm vi dữ liệu crm.feedback của agent (cùng điều kiện như trên web). Tạo theo bản mẫu (template) đang ở phiên bản published hiện tại — 2 cách dùng:

  • Kèm answers — lưu ngay với trạng thái SUBMITTED, entryMode = API. Không thể sửa sau khi đã tạo.
  • Không kèm answers — mở một lượt đánh giá PENDING; response 201 trả về accessToken đúng một lần. Đặt token này vào link gửi cho khách hàng; trang của bạn gọi Mở biểu mẫu đánh giá rồi Gửi câu trả lời đánh giá để hoàn tất (2 endpoint này không cần API key — xác thực bằng chính token).

clientRequestId giúp retry an toàn — gọi lại trả về feedback đã tạo lần đầu (không kèm token).

Headers

X-Api-KeystringRequired

Request

This endpoint expects an object.
customerIdstringRequired<=64 characters

id (UUIDv7) hoặc uid (11 ký tự [0-9A-Z]) của khách hàng.

templateIdstringRequired

id bản mẫu đánh giá — chỉ dùng được bản mẫu đang ở phiên bản published.

sourceobjectRequired
answersobjectOptional

Có kèm → lưu ngay (SUBMITTED). Không kèm → mở lượt đánh giá PENDING, trả về accessToken để dùng với Biểu mẫu đánh giá.

submittedAtlongOptional

Chỉ dùng khi gửi kèm answers. Epoch millis; mặc định thời điểm hiện tại; không được ở tương lai.

expiresInHoursintegerOptional1-720Defaults to 168

Chỉ dùng khi không kèm answers — thời hạn hiệu lực của link.

clientRequestIdstringOptional<=64 characters

Tự sinh phía client — gọi lại cùng giá trị trả về đúng feedback đã tạo lần đầu.

Response

Feedback đã lưu — accessToken chỉ xuất hiện khi gửi không kèm answers.

idstringOptional
customerIdstringOptional
templateIdstringOptional
templateVersionintegerOptional
sourceobjectOptional
entryModestringOptional
statusenumOptional
Allowed values:
answersobjectOptional
scoreinteger or nullOptional
maxScoreinteger or nullOptional
ratiodouble or nullOptional
createdAtlongOptional
expiresAtlong or nullOptional
submittedAtlong or nullOptional
accessTokenstring or nullOptional

Chỉ có trong response, chỉ xuất hiện một lần, khi gửi không kèm answers. Dùng với Biểu mẫu đánh giá — lưu lại ngay, không thể lấy lại sau.

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