Lấy danh sách người dùng

Lưu ý:

Đối với các API sử dụng cho Shop thì API key:<api_key>.Thông tin base_url của Shop
Đối với các API sử dụng cho Partner thì API key:<shop_key>.Thông tin base_url của Partner

ListFollowers

post

Body

Responses

200

A successful response

application/json

post

$BASE_URL.Zalo/ListFollowers

POST $BASE_URL.Zalo/ListFollowers HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 343

{
  "filter": {
    "assigned_user_id": "text",
    "date_from": "2026-01-25T10:56:25.334Z",
    "date_to": "2026-01-25T10:56:25.334Z",
    "gender": "unknown",
    "has_conversation": true,
    "name": "text",
    "oa_id": "text",
    "phone": "text",
    "state": "follow",
    "tags": [
      "text"
    ],
    "zl_user_id": "text",
    "zl_user_ids": [
      "text"
    ]
  },
  "paging": {
    "after": "text",
    "before": "text",
    "limit": 1,
    "sort": "text"
  }
}

200

A successful response

{
  "followers": [
    {
      "assigned_user_id": "text",
      "avatar": "text",
      "avatars": {
        "120": "text",
        "240": "text"
      },
      "created_at": "2026-01-25T10:56:25.334Z",
      "full_name": "text",
      "gender": "unknown",
      "has_conversation": true,
      "id": "text",
      "last_conversation": {
        "attachments": {
          "audio": [
            {
              "url": "text"
            }
          ],
          "business_card": [
            {
              "description": "text",
              "thumbnail": "text",
              "url": "text"
            }
          ],
          "file": [
            {
              "checksum": "text",
              "name": "text",
              "size": "text",
              "type": "text",
              "url": "text"
            }
          ],
          "gif": [
            {
              "thumbnail": "text",
              "url": "text"
            }
          ],
          "image": [
            {
              "thumbnail": "text",
              "url": "text"
            }
          ],
          "link": [
            {
              "description": "text",
              "thumbnail": "text",
              "url": "text"
            }
          ],
          "location": [
            {
              "latitude": "text",
              "longitude": "text"
            }
          ],
          "sticker": [
            {
              "id": "text",
              "url": "text"
            }
          ],
          "video": [
            {
              "description": "text",
              "thumbnail": "text",
              "url": "text"
            }
          ]
        },
        "direction": "in",
        "message": "text",
        "sent_time": "2026-01-25T10:56:25.334Z",
        "type": "unknown"
      },
      "oa_id": "text",
      "phone": "text",
      "shared_info": {
        "address": "text",
        "city": "text",
        "district": "text",
        "name": "text",
        "phone": "text",
        "ward": "text"
      },
      "shop_id": "text",
      "state": "follow",
      "tags_and_notes_info": {
        "notes": [
          "text"
        ],
        "tag_names": [
          "text"
        ]
      },
      "updated_at": "2026-01-25T10:56:25.334Z",
      "zl_user_id": "text",
      "zl_user_id_by_app": "text"
    }
  ],
  "paging": {
    "after": "text",
    "before": "text",
    "limit": 1,
    "next": "text",
    "prev": "text",
    "sort": "text"
  }
}

Request:

curl --location '$BASE_URL.Zalo/ListFollowers' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $API_KEY' \
--data '{
  "filter": {
    "assigned_user_id": "string",
    "date_from": "2019-08-24T14:15:22Z",
    "date_to": "2019-08-24T14:15:22Z",
    "gender": "unknown",
    "has_conversation": true,
    "name": "string",
    "oa_id": "string",
    "phone": "string",
    "state": "follow",
    "tags": [
      "string"
    ],
    "zl_user_id": "string",
    "zl_user_ids": [
      "string"
    ]
  },
  "paging": {
    "after": "string",
    "before": "string",
    "limit": 0,
    "sort": "string"
  }
}'

Response:

{
  "followers": [
    {
      "assigned_user_id": "string",
      "avatar": "string",
      "avatars": {
        "120": "string",
        "240": "string"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "full_name": "string",
      "gender": "unknown",
      "has_conversation": true,
      "id": "string",
      "oa_id": "string",
      "phone": "string",
      "shared_info": {
        "address": "string",
        "city": "string",
        "district": "string",
        "name": "string",
        "phone": "string",
        "ward": "string"
      },
      "shop_id": "string",
      "state": "follow",
      "tags_and_notes_info": {
        "notes": [
          "string"
        ],
        "tag_names": [
          "string"
        ]
      },
      "updated_at": "2019-08-24T14:15:22Z",
      "zl_user_id": "string",
      "zl_user_id_by_app": "string"
    }
  ],
  "paging": {
    "after": "string",
    "before": "string",
    "limit": 0,
    "next": "string",
    "prev": "string",
    "sort": "string"
  }
}

Cấu trúc body của request

Tham số

Kiểu dữ liệu

Mô tả

assigned_user_id

string

ID nhân viên được gán

oa_id

int64

ID của OA

name

string

Tên người dùng Zalo

date_from

string<date-time>

Ngày bắt đầu

date_to

string<date-time>

Ngày kết thúc

gender

string (pwGender) Enum

Giới tính "unknown" "male" "female" "other"

has_conversation

boolean

True: Có cuộc hội thoại

False: Không có cuộc hội thoại

phone

string

Số điện thoại người dùng

state

string (gqFollowState) Enum

follow: Đã quan tâm

unfollow: Chưa quan tâm

hashtagListFollowers

ListFollowers