Lấy thông tin 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/group/getgroup
• Method: GET
• Response Type: text/json

Example request

curl --request GET 'https://openapi.zalo.me/v3.0/oa/group/getgroup?group_id=f414c8f76fa586fbdfb4' \
--header 'access_token: <your_access_token>'

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.

Tham số

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

Example respond

{
    "data": {
        "group_info": {
            "group_id": "a57a91e562b78be9d2a6",
            "group_link": "https://zalo.me/g/zkfgeb641",
            "name": "b52",
            "group_description": "",
            "avatar": "http://s120.ava.grp.talk.zdn.vn/default",
            "status": "enabled",
            "total_member": 2,
            "max_member": "10",
            "auto_delete_date":"10/11/2024"
        },
        "asset_info":{
            "asset_type": "gmf10",
            "asset_id": "asset_id",
            "valid_through": "10/10/2024",
            "auto_renew": "true"
        },
        "group_setting": {
            "lock_send_msg": false,
            "join_appr": true,
            "enable_msg_history": true,
            "enable_link_join": true
        }
    },
    "error": 0,
    "message": "Success"
}

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

Tham số	Kiểu dữ liệu	Mô tả
group_info	json object	Các thông tin của nhóm chat
asset_info	json object	Các thông tin của dịch vụ gắn với nhóm chat
group_setting	json object	Các thông tin cài đặt trong nhóm chat

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

Tham số	Kiểu dữ liệu	Mô tả
name	string	Tên nhóm
avatar	string	Avatar của nhóm
group_id	string	ID của nhóm
group_link	string	Link tham gia của nhóm
group_description	string	Mô tả nhóm
status	string	Trạng thái nhóm enabled: OA có thể quản lý và gửi tin nhắn trong nhóm disabled: OA không thể quản lý và không thể gửi tin nhắn trong nhóm
total_member	integer	Tổng số lượng thành viên trong nhóm
max_member	string	Số lượng thành viên tối đa của nhóm
auto_delete_date	string	Ngày nhóm chat tự động giải tán. Nhóm chat sẽ tự động giải tán sau 45 ngày không gia hạn

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

Tham số	Kiểu dữ liệu	Mô tả
asset_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

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

Tham số	Kiểu dữ liệu	Mô tả
lock_send_msg	boolean	Cài đặt chức năng nhắn tin của các thành viên true: Khóa tính năng nhắn tin của các thành viên trong nhóm false: Mở khóa cho phép các thành viên trong nhóm nhắn tin
join_appr	boolean	Cài đặt chế độ phê duyệt thành viên mới true: Thành viên mới phải được duyệt false: Không cần duyệt thành viên mới
enable_msg_history	boolean	Cài đặt cho phép thành viên mới đọc tin nhắn gần nhất true: Cho phép thành viên mới đọc tin nhắn gần nhất false: Không cho phép thành viên mới đọc tin nhắn gần nhất
enable_link_join	boolean	Cài đặt bật tắt tham gia nhóm bằng link true: Cho phép tham gia nhóm bằng link false: Không cho phép tham gia nhóm bằng link