Gửi thông báo OA

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.

Request URL

• URL: https://openapi.mini.zalo.me/notification/template
• Method: POST
• Content Type: application/json
• Response Type: application/json

Request Header

Attribute	Value	Description	Note
X-User-Id	User Access Token	Token của người nhận
X-Api-Key	Api Key của Zalo App	Xác thực API Key, IP Address, Scopes	Type Bearer
X-MiniApp-Id	Zalo Mini App Id	MiniApp cần gửi thông báo

Request Parameters

Attribute	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 tương tác trên Mini App của bạn.

• Template ID: 9501b1c48d8164df3d90
• Template Data:

Field	Type	Description	Constraint
title	string	tiêu đề thông báo	Cho phép Developer tuỳ chỉnh, tối đa 32 ký tự
contentTitle	string	tiêu đề nội dung	Cho phép Developer tuỳ chỉnh, tối đa 32 ký tự
contentDescription	string	nội dung	Tối đa 400 ký tự. Hỗ trợ cho Developer có thể in đậm, in nghiêng, xuống dòng
buttonText	string	button text	Developer nhập nội dung button, tối đa 12 ký tự
buttonUrl	string	button url	Phải mở miniapp. theo dạng: https://zalo.me/s/{miniAppId}/… . Có thể thêm param vào link.

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 Example

Mẫu tin nhắn 01

• Template ID: 9501b1c48d8164df3d90

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": "9501b1c48d8164df3d90",
    "templateData": {
        "buttonText": "Xem chi tiết đơn hàng",
        "buttonUrl": "https://zalo.me/s/3600165838663854189/?page=products",
        "title": "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"
    }
}'

Người nhận sẽ nhận được tin nhắn như sau: