Lấy danh sách khách hàng quan tâm OA

Lưu ý

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

API này được thay thế bởi API Lấy danh sách người dùng và sẽ dừng hỗ trợ OA Doanh nghiệp từ ngày 01/06/2024

HTTP request

• URL: https://openapi.zalo.me/v2.0/oa/getfollowers
• Method: GET
• Response Type: text/json

Example request

curl \
-X GET \
-H 'access_token: <your_access_token>' \
'https://openapi.zalo.me/v2.0/oa/getfollowers?data={"offset":0,"count":5,"tag_name":"Khách hàng Q1"}'

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ả
data	Json object	yes	Thông tin truyền vào để lấy dữ liệu. Xem chi tiết cấu trúc data tại bảng bên dưới.

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 quan tâm đầu tiên trong danh sách trả về.
count	int	yes	Số lượng người quan tâm muốn lấy. Lưu ý: tối đa 50 người quan tâm 1 request
tag_name	string	no	Tên của nhãn được gắn cho người quan tâm. Khi bạn sử dụng tham số này, API sẽ trả về danh sách người quan tâm 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 quan tâm.

Example respond

{
    "error": 0,
    "message": “Success”,
    "data": {
        "total": 62,
        "followers": [
            {
                "user_id": “2512523625412515”
            },...
        ]
    }
}

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

Thuộc tính	Kiểu dữ liệu	Mô tả
total	int	Tổng số lượng người quan tâm của OA.
followers	array	Danh sách ID của tất cả người quan tâm hoặc người quan tâm có nhãn tương ứng với nhãn được truyền vào tham số tag_name.