Gửi thông báo theo mẫu đính kèm ảnh

Quyền cần có: Quyền gửi tin và thông báo qua OA

HTTP request

• URL: https://openapi.zalo.me/v2.0/oa/message
• Method: POST
• Content Type: application/json
• Response Type: text/json

Example request

curl
-X POST
-H 'Content-Type: application/json'
-H 'access_token: <your_access_token>'
-d '{ 
  "recipient": {
    "user_id": "2468458835296117922"
  },
  "message": {
    "text": "Zalo đạt 100 triệu người dùng",
    "attachment": {
        "type": "template",
        "payload": {
            "template_type": "media",
            "elements": [{
                "media_type": "image",
                "url": "https://stc-developers.zdn.vn/images/bg_1.jpg"
            }]
        }
    }
  }
}' "https://openapi.zalo.me/v2.0/oa/message"

Tham số header

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
access_token	string	yes	Token cho phép ứng dụng đại diện OA gọi API. Xem chi tiết cách lấy access token tại đây.

Cấu trúc body của request

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
recipient	object	yes	Thông tin người nhận
message	object	yes	Nội dung cần gửi

Cấu trúc thuộc tính recipient

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
user_id	string	yes	ID của người nhận (nhận được thông qua API truy xuất chi tiết người dùng, API truy xuất danh sách người dùng)

Cấu trúc thuộc tính message

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
text	string	yes	Tiêu đề của ảnh Giới hạn tối đa là 2.000 ký tự
attachment	object	yes	Attachment cần gửi.

Cấu trúc thuộc tính message.attachment

Tham số	Loại	Tính bắt buộc	Mô tả
type	string	yes	Loại attachment. Giá trị nhận vào bắt buộc: type = template
payload	object	yes	Chứa payload của attachment muốn gửi.

Cấu trúc thuộc tính message.attachment.payload

Tham số	Loại	Tính bắt buộc	Mô tả
template_type	string	yes	Loại template Với template gửi thông báo theo mẫu đính kèm ảnh, giá trị nhận vào là: template_type = media
elements	array	yes	Các đối tượng của template. Lưu ý: Cấu trúc element thay đổi tùy theo loại template. Với template media, danh sách element bao gồm tối đa 1 phần tử.

Cấu trúc thuộc tính message.attachment.payload.element

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
media_type	string	yes	Loại media. Các giá trị nhận vào: image: ảnh tĩnh gif: ảnh động
attachment_id	string	yes	ID của ảnh bạn muốn sử dụng (nhận được thông qua API upload ảnh) Các định dạng ảnh hỗ trợ: jpg và png Dung lượng tối đa: 1MB Lưu ý: chỉ sử dụng 1 trong 2 biến attachment_id hoặc url kích thước ảnh tối ưu 16:9 và vùng safe zone 14:9
url	string	yes	Đường dẫn đến ảnh Các định dạng ảnh hỗ trợ: jpg và png Dung lượng tối đa: 1MB Lưu ý: chỉ sử dụng 1 trong 2 biến attachment_id hoặc url kích thước ảnh tối ưu 16:9 và vùng safe zone 14:9
width	integer	Chỉ bắt buộc khi media_type = gif	Chiều rộng của ảnh
height	integer	Chỉ bắt buộc khi media_type = gif	Chiều cao của ảnh

Example respond

{
  "data": {
    "message_id": "e6fa968f027",
    "user_id": "2468458835296117922"
  },
  "error": 0,
  "message": "Success"
}

Cấu trúc thuộc tính data

Thuộc tính	Kiểu dữ liệu	Mô tả
message_id	string	ID của thông báo
user_id	string	ID của người nhận