Lấy danh sách người quan tâm của OA

Lấy danh sách người quan tâm tới Zalo OA

HTTP Request

URL: https://zns.api.gobysend.com/api/follower/list Method: POST Content Type: application/json Response Type: application/json

Example request

curl
-X GET
-H "Content-Type: application/json" 
"https://zns.api.gobysend.com/api/follower/list?tag_name=example&page=1&size=10    "

Tham số header

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
access_token	string	yes	Đoạn mã cần truyền vào để xác minh quyền sử dụng API. Xem thêm tài liệu tham khảo

Tham số

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
tag_name	string	no	Lọc khách hàng theo thẻ đã gắn trên Zalo.
page	integer	no	Sử dụng để phân trang. Giá trị mặc định là 1.
size	integer	no	Sử dụng để lấy số lượng bản ghi mỗi trang. Giá trị mặc định là 10.

Example respond

{
  "data": [
    {
      "user_id": "2512523625412515"
    },
    ...
  ],
  "error": 0,
  "message": "string",
  "metadata": {
    "page": 0,
    "size": 0,
    "total": 0
  }
}

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

Thuộc tính	Kiểu dữ liệu	Mô tả
error	int	Mã lỗi trả về. Tham khảo Phụ lục bảng mã lỗi.
message	string	Nội dung lỗi trả về nếu có.
metadata	JSON object	Dữ liệu phân trang.
data	JSON object	Danh sách người quan tâm.

Cấu trúc metadata

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.
page	int	Trang hiện tại.
size	int	Số lượng người quan tâm sẽ lấy trên mỗi trang.

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

Thuộc tính	Kiểu dữ liệu	Mô tả
user_id	string	Zalo ID của người quan tâm.

English version:

HTTP Request

URL: https://zns.api.gobysend.com/api/follower/list Method: POST Content Type: application/json Response Type: application/json

Example request

curl
-X GET
-H "Content-Type: application/json" 
"https://zns.api.gobysend.com/api/follower/list?tag_name=example&page=1&size=10    "

Header param

Param	Data type	Compulsory	Description
access_token	string	yes	The code that needs to be passed in to verify the permission to use the API. Reference document

Param

Param	Data type	Compulsory	Description
tag_name	string	no	Filter customers by tag on Zalo.
page	integer	no	Pagination. The default value is 1.
size	integer	no	Get the number of records per page. The default value is 10.

Example respond

{
  "data": [
    {
      "user_id": "2512523625412515"
    },
    ...
  ],
  "error": 0,
  "message": "string",
  "metadata": {
    "page": 0,
    "size": 0,
    "total": 0
  }
}

Data attribute structure

Attribute	Data type	Description
error	int	Returned error code See more at Error code table
message	string	Returned error content
metadata	JSON object	Paging data
data	JSON object	Followers list

Metadata structure

Attribute	Data type	Description
total	int	Total OA followers
page	int	Current page
size	int	Number of followers will be taken per page

Data attribute structure

Attribute	Data type	Description
user_id	string	Followers's Zalo ID