Kiểm tra hạn mức gửi tin tới User cụ thể

mẹo

API này dùng để kiểm tra các thông tin sau:

• Thời gian tương tác lần cuối của User với OA
• Kiểm tra hạn mức gửi tin nhắn Truyền thông theo ngày/tháng

Lưu ý

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

HTTP request

URL: https://openapi.zalo.me/v3.0/oa/quota/message

Method: POST

Content Type: application/json

Response Type: text/json

Example request

curl '<https://openapi.zalo.me/v3.0/oa/quota/message>'
--header 'access_token: <oa_access_token>'
--header 'Content-Type: application/json'
--data '{
    "user_id": "3665924733554159312"
}'

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ả
user_id	string	yes	User ID của người dùng cần kiểm tra thông tin. Lưu ý: Người dùng không cần quan tâm OA

Example respond

{
    "data": {
        "last_interaction": "1690184100000",
        "cs_reply": {
            "remain": 8,
            "total": 8
        },
        "promotion": {
            "daily_remain": 0,
            "daily_total": 1,
            "monthly_remain": 4,
            "monthly_total": 6
        }
    },
    "error": 0,
    "message": "Success"
}

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

Thuộc tính	Kiểu dữ liệu	Mô tả
last_interaction	string	Thời gian tương tác cuối cùng của user với OA (định dạng unix milliseconds)
cs_reply	object	Từ ngày 1/1/2026, đối tác có thể gửi tin Tư vấn miễn phí không giới hạn trong khung 48h Lộ trình chuyển đổi: - Từ ngày 1/1/2026: luôn trả về giá trị remain = 8 - Sau ngày 1/3/2026: sẽ dừng trả về thuộc tính này
promotion	object	daily_remain: số lượt gửi tin truyền thông còn lại trong ngày tới User này - daily_total: tổng số lượt gửi tin truyền thông trong ngày tới User này - monthly_remain: số lượt gửi tin truyền thông còn lại trong tháng tới User này - monthly_total: tổng số lượt gửi tin truyền thông trong tháng tới User này