Truy xuất danh sách người dùng

Lưu ý

Ứng dụng cần được cấp quyền quản lý thông tin người dùng

HTTP request

• URL: https://openapi.zalo.me/v3.0/oa/user/getlist
• Method: GET
• Response Type: text/json

Example request

curl --location --globoff 
--request GET 'https://openapi.zalo.me/v3.0/oa/user/getlist?data={"offset":0,"count":15,"last_interaction_period":"TODAY","is_follower":"true"}' \
--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

Tham số

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
data	Json object	yes	Thông tin truyền vào để lấy dữ liệu

Cấu trúc tham số data

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
offset	int	yes	Thứ tự của người dùng đầu tiên trong danh sách trả về. Hỗ trợ tối đa 9951 (tương ứng 10000 người dùng, 50 người dùng/request)
count	int	yes	Số lượng người dùng muốn lấy. Lưu ý: tối đa 50 người dùng 1 request
tag_name	string	no	Tên của nhãn được gắn cho người dùng. Khi bạn sử dụng tham số này, API sẽ trả về danh sách người dùng theo nhãn tương ứng. Lưu ý: Trường hợp không truyền vào tag_name, API sẽ trả về toàn bộ danh sách người dùng.
last_interaction_period	string	no	Khoảng thời gian tương tác gần nhất của người dùng TODAY : trong ngày hôm nay YESTERDAY : trong ngày hôm qua L7D : trong 7 ngày vừa qua, không bao gồm ngày hiện tại (TODAY) L30D : trong 30 ngày vừa qua, không bao gồm ngày hiện tại (TODAY) <YYYY_MM_DD:YYYY_MM_DD>: trong khoảng thời gian tùy biến, ví dụ 2024_05_22:2024_05_23
is_follower	boolean	no	Trạng thái quan tâm OA của người dùng true: Người dùng đang quan tâm OA false: Người dùng chưa quan tâm OA

Example respond

{
    "data": {
        "total": 6,
        "count": 15,
        "offset": 0,
        "users": [
            {
                "user_id": "4572947693969771653"
            },
            {
                "user_id": "8969911359184683656"
            },
            {
                "user_id": "195313740847641158"
            },
            {
                "user_id": "2242767944251000300"
            },
            {
                "user_id": "4476513743385388268"
            },
            {
                "user_id": "7511600376107668429"
            }
        ]
    },
    "error": 0,
    "message": "Success"
}

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

Tham số	Kiểu dữ liệu	Mô tả
count	int	Số lượng người dùng đã request
offset	int	Thứ tự của người dùng đầu tiên trong danh sách trả về
total	int	Tổng số lượng người dùng thỏa điều kiện
users	array	Danh sách ID của tất cả người dùng thỏa điều kiện truyền vào