Kiểm tra hạn mức nhóm

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/quota/group
• Method: POST
• Content Type: application/json
• Response Type: application/json

Example request

curl --request POST 'https://openapi.zalo.me/v3.0/oa/quota/group' \
--header 'access_token: <your_oa_access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "quota_owner": "OA",
    "product_type": "gmf10"
    "quota_type": "sub_quota"
}'

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ả
quota_owner	string	yes	Thực thể sở hữu Quota muốn truy xuất OA: Official Account là thực thể sở hữu hạn mức APP: Ứng dụng gửi request là thực thể sở hữu hạn mức
product_type	string	no	Loại sản phẩm thuộc nhánh tính năng muốn truy xuất. Giá trị: gmf10: Nhóm chat tối đa 10 thành viên gmf50: Nhóm chat tối đa 50 thành viên gmf100: Nhóm chat tối đa 100 thành viên
quota_type	string	no	Loại quota (nguồn quota sử dụng) muốn truy xuất. Giá trị: sub_quota: Hạn mức từ gói OA (Gói Nâng cao/Gói Premium) purchase_quota: Hạn mức từ việc mua lẻ tính năng reward_quota: Hạn mức được tặng

Example respond

{
    "data": [
            {
                "product_type": "gmf10",
                "quota_type": "sub_quota",
                "asset_id": "asset_id",
                "valid_through": "10/10/2024",
                "auto_renew": false,
                "status": "available",
                "used_id": "group_id"
            }
    ],
    "error": 0,
    "message": "Success"
}

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

Tham số	Kiểu dữ liệu	Mô tả
product_type	string	Loại sản phẩm gmf10: Sản phẩm dành cho Nhóm chat tối đa 10 thành viên gmf50: Sản phẩm dành cho Nhóm chat tối đa 50 thành viên gmf100: Sản phẩm dành cho Nhóm chat tối đa 100 thành viên
asset_id	string	ID gói GMF, sử dụng để làm dịch vụ hoạt động của Nhóm
valid_through	string	Ngày hết hạn của gói
auto_renew	string	True: Có bật tự động gia hạn False: KHÔNG bật tự động gia hạn
used_id	string	ID của đối tượng sử dụng gói. Đối với gói GMF thì là group_id
status	string	Trạng thái asset: available: asset_id chưa được sử dụng và có thể liên kết với nhóm chat used: asset_id đã được sử dụng và không thể liên kết với nhóm chat
quota_type	string	Loại quota (nguồn quota sử dụng). Giá trị: sub_quota: Hạn mức từ gói OA (Gói Nâng cao/Gói Premium) purchase_quota: Hạn mức từ việc mua lẻ tính năng reward_quota: Hạn mức được tặng