Gửi Notification
Tài liệu hướng dẫn gửi thông báo tới người dùng qua OA chung của Zalo Mini App dựa trên các mẫu tin nhắn có sẵn. Cách này phù hợp với Mini App đang trong quá trình thử nghiệm, chưa có OA doanh nghiệp.
Chú ý (cập nhật ngày 25/05/2023)
Giới hạn gửi tin nhắn thông báo:
- Bạn chỉ có thể thông báo tới người dùng truy cập Mini App trong 7 ngày gần nhất và đã cho phép nhận thông báo từ Mini App của bạn. Để yêu cầu người dùng cho phép nhận thông báo, vui lòng sử dụng API sau requestSendNotification.
- Số lượng thông báo gửi từ ứng dụng tối đa là 1000 mỗi ngày, và mỗi người dùng chỉ nhận được một lần mỗi ngày.
- Thời gian gửi thông báo được phép là từ 6 giờ sáng tới 22 giờ tối.
Request URL
- URL:
https://openapi.mini.zalo.me/notification/template - Method: POST
- Content Type: application/json
- Response Type: application/json
Request Headers
| Key | Description | Note |
|---|---|---|
| X-User-Id | Id của người nhận, có thể lấy thông qua api getUserInfo | |
| X-Api-Key | Xem hướng dẫn lấy api key tại đây | Type Bearer |
| X-MiniApp-Id | MiniApp cần gửi thông báo |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| templateId | string | true | Id của template cần gửi |
| templateData | Template Data Object | true | Dữ liệu cần truyền vào template. Tùy vào từng loại template sẽ phải truyền dữ liệu khác nhau |
Template Data
Mẫu tin nhắn 01:
Sử dụng cho các trường hợp thông báo tình trạng đơn hàng, xác nhận kết quả đăng ký tham gia sự kiện... sau khi người dùng tương tác trên Mini App của bạn.
- Template ID:
00126fd75392bacce383 - Template Data:
| Field | Type | Description | Constraint |
|---|---|---|---|
| title | string | Tiêu đề thông báo | Tối đa 32 ký tự |
| contentTitle | string | Tiêu đề nội dung | Tối đa 32 ký tự |
| contentDescription | string | Nội dung | Tối đa 400 ký tự. Có thể in đậm, in nghiêng, xuống dòng |
| buttonText | string | Nội dung sẽ hiển thị trên button | Tối đa 12 ký tự |
| buttonUrl | string | Liên kết sẽ được mở khi click vào button | Phải là deeplink của Mini App. Có thể thêm param vào link |
- Hình ảnh minh họa:
- Request example:
Code demo fallback when rendering server side!
Return Value
| Attribute | Type | Description |
|---|---|---|
| err | number | Mã lỗi |
| msg | string | Mô tả lỗi |
| data | object | Chi tiết lỗi |
Error Code
Tham khảo tại đây