Gửi tin nhắn nhóm dạng Hình ảnh

Lưu ý

Ứng dụng cần được cấp quyền quản lý thông tin nhóm.

HTTP request

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

Example request

curl --location --request POST 'https://openapi.zalo.me/v3.0/oa/group/message' \
--header 'access_token: <your_access_token>' \
--header 'Content-Type: application/json' \
--data '{
    "recipient": {
        "group_id": "f414c8f76fa586fbdfb4"
    },
    "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"
                    }
                ]
            }
        }
    }
}
'

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	json object	yes	Thông tin người nhận
message	json object	yes	Nội dung tin nhắn

Cấu trúc body của recipient

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
group_id	string	yes	ID của nhóm

Cấu trúc body của 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	json object	yes	Attachment cần gửi

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

Tham số	Kiểu dữ liệu	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	json object	yes	Chứa payload của attachment muốn gửi. Xem cấu trúc payload tại mục bên dưới.

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

Tham số	Kiểu dữ liệu	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à: 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 các ả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": "81d74a9cd71d6f473608",
        "group_id": "f414c8f76fa586fbdfb4"
    },
    "error": 0,
    "message": "Success"
}

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

Tham số	Kiểu dữ liệu	Mô tả
message_id	string	ID của tin nhắn mới được gửi
group_id	string	ID của nhóm