Gửi thông báo đính kèm file

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

Lưu ý: để gửi thông báo đính kèm file, bạn cần sử dụng API upload file.

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": {
    "attachment": {
        "type": "file",
        "payload": {
            "token": "12i8LV3BcmmDS4iLfyoU3qKxHXNtpu077ZjA7xRHmmi8EXrEjuR50LHjJXJWWvTQ17OJ7R2Oc5q4SHSJjPoPKmDq5X2tyS4MI78oKexCna1CUJnQyiMvUKmfG7UOX8PYVW5FJAckbWbi1tWbj8BnCNOyTGMBr8mrG5XZ4epkfbD4HczzjUs3FM0QL1ZM"
        }
    }
  }
}' "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ả
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 = file
payload	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ố	Loại	Tính bắt buộc	Mô tả
token	string	yes	Chuỗi token được trả về khi sử dụng API upload file.

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