Gửi Notification

Cập nhật lần cuối: 06/02/2023

Lưu ý

API đang trong quá trình thử nghiệm, dự kiến sẽ mở chính thức cho đối tác tích hợp từ ngày 01/05/2023

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ú ý

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.
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:

curl --location 'https://openapi.mini.zalo.me/notification/template' \
--request POST \
--header 'X-Api-Key: Bearer <api-key>' \
--header 'X-User-Id: <receiver-id>' \
--header 'X-MiniApp-Id: <mini-app-id>' \
--header 'Content-Type: application/json' \
--data '{
    "templateId": "00126fd75392bacce383",
    "templateData": {
        "buttonText": "Xem chi tiết đơn hàng",
        "buttonUrl": "https://zalo.me/s/194839900003483517/",
        "title": "ZaUI Coffee - Xác nhận đơn hàng",
        "contentTitle": "Xác nhận đơn hàng",
        "contentDescription": "Chúng tôi đã nhận yêu cầu đặt hàng từ bạn. Thông tin chi tiết đơn hàng"
    }
}'

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

Request URL​

Request Headers​

Request Body​

Template Data​

Mẫu tin nhắn 01:​

Return Value​

Error Code​