POST/api/public/widget/voice-speak

Chuyển đổi văn bản thành giọng nói (phát âm thanh trong widget), nếu tính năng giọng nói được bật.

Gửi `widget_code` và văn bản cần đọc to trong `text`. Phản hồi chứa dữ liệu âm thanh để phát trong trình duyệt. Để phát trực tiếp qua một phần tử `<audio>`, cùng đường dẫn cũng có sẵn qua GET. Nếu thiếu `widget_code`, server trả lời bằng 400 `WIDGET_CODE_REQUIRED`; nếu tính năng giọng nói không được bật hoặc hiện không khả dụng, bằng 503 `VOICE_UNAVAILABLE`. Chỉ bắt đầu phát mới khi lần phát trước đã kết thúc.

Tổng quan

Lệnh gọi: POST /api/public/widget/voice-speak. Endpoint này thuộc nhóm “Widget chat” trong API của Zentor App. Endpoint này yêu cầu một widget embed token hợp lệ. Lệnh gọi có tính idempotent: các lệnh gọi lặp lại với cùng dữ liệu đầu vào trả về cùng một kết quả. Tham số bắt buộc: widget_code (body), text (body). Các trường hợp lỗi được tài liệu hóa: 400 WIDGET_CODE_REQUIRED, 503 VOICE_UNAVAILABLE. Phản hồi mẫu bên dưới cho thấy cấu trúc của một phản hồi thành công ở định dạng JSON.

Xác thực & bảo mật

Widget-Embed-Token (Header X-Widget-Token) + danh sách Origin được cho phép

Lũy đẳng (idempotent): Có

Tham số

widget_code(body, string, bắt buộc)— Mã widget từ mã nhúng của bạn
text(body, string, bắt buộc)— Văn bản cần đọc to

Response mẫu

{"ok":false,"error":{"code":"VOICE_UNAVAILABLE","message":"Chức năng giọng nói hiện không khả dụng."}}

Mã lỗi

400 WIDGET_CODE_REQUIRED — Trường `widget_code` bị thiếu.
503 VOICE_UNAVAILABLE — Tính năng giọng nói không được bật cho widget này hoặc hiện không khả dụng.

Hành vi đã được xác minh

Thiếu `widget_code` trả về 400 `WIDGET_CODE_REQUIRED`, widget không có tính năng giọng nói trả về 503 `VOICE_UNAVAILABLE`. Trường hợp thành công yêu cầu widget có tính năng giọng nói được bật.

Widget chat

GET /api/public/widget/healthKiểm tra khả dụng đơn giản của dịch vụ widget.GET /api/public/widget/config/:widget_codeTrả về cấu hình công khai của widget (tên hiển thị, lời chào, thiết kế, ngôn ngữ, tính năng giọng nói) để khởi tạo trong trình duyệt.POST /api/public/widget/messageGửi tin nhắn của khách truy cập đến chatbot và trả về câu trả lời của nó – endpoint trung tâm của chat widget.GET /api/public/widget/historyTải lịch sử tin nhắn trước đó của một cuộc hội thoại widget, ví dụ sau khi tải lại trang.POST /api/public/widget/pollLấy các tin nhắn đến sau một thời điểm cho trước – ví dụ câu trả lời của một nhân viên đã tiếp nhận cuộc hội thoại.POST /api/public/widget/ratingLưu đánh giá của khách truy cập về một cuộc hội thoại (có ích hoặc không có ích).POST /api/public/widget/trackGhi lại một sự kiện sử dụng widget ẩn danh (ví dụ: “widget đã mở”) cho các phân tích trong bảng điều khiển.POST /api/public/widget/voice-transcribeChuyển đổi bản ghi âm giọng nói của khách truy cập thành văn bản (nhập liệu bằng giọng nói), nếu tính năng giọng nói được bật cho widget.

Bài viết liên quan

← Widget chat