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

API này dùng để lấy danh sách người dùng tương tác với OA

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$BASE_URL.Zalo/ListFollowers

Body

application/json

filtermrListFollowersFilter (object)

pagingktCursorPaging (object)

Response

200

A successful response

Body

application/json

followersarray of mrZlOAFollower (object)

pagingktCursorPageInfo (object)

Request

JavaScriptCurlPython

const response = await fetch('$BASE_URL.Zalo/ListFollowers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "followers": [
    {
      "assigned_user_id": "text",
      "avatar": "text",
      "avatars": {
        "120": "text",
        "240": "text"
      },
      "created_at": "2025-01-07T00:55:57.714Z",
      "full_name": "text",
      "gender": "unknown",
      "has_conversation": false,
      "id": "text",
      "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": "2025-01-07T00:55:57.714Z",
      "zl_user_id": "text",
      "zl_user_id_by_app": "text"
    }
  ],
  "paging": {
    "after": "text",
    "before": "text",
    "limit": 0,
    "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
tags	Array of strings	Nhãn được gán cho người dùng
zl_user_id	string	ID người dùng Zalo

Cấu trúc thuộc tính dữ liệu trả về

Tham số	Kiểu dữ liệu	Mô tả
assigned_user_id	string	ID nhân viên được gán
avatar	string	Ảnh đại diện người dùng
full_name	string	Tên người dùng
id	string	ID người dùng trên eTelecom
oa_id	int64	ID của OA
shared_info	object (mrSharedInfo)	Người dùng đồng ý chia sẻ thông tin
address	string	Địa chỉ
city	string	Thành phố
district	string	Quận, Huyện
ward	string	Phường
name	string	Tên người dùng Zalo
created_at	string<date-time>	Thời điểm ghi nhận tương tác
updated_at	string<date-time>	Thời điểm update
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
shop_id	string	ID shop trên eTelecom
state	string (gqFollowState) Enum	follow: Đã quan tâm unfollow: Chưa quan tâm
tags	Array of strings	Nhãn được gán cho người dùng
zl_user_id	string	ID người dùng Zalo
zl_user_id_by_app	string	ID người dùng Zalo theo app