Lấy danh sách người dùng đang quan tâm (Followers) của Official Account. Hỗ trợ phân trang và lọc.


Request Information

Link Request API (METHOD POST):

https://api.abenla.com/zbs/oa/followers


Information Request

URI Parameters

None.

Request Body Parameters

Name Description Type
brand_name

Tên thương hiệu OA cần lấy danh sách follower.

 string
offset

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)

 integer
count

Số lượng người dùng muốn lấy.
Lưu ý: tối đa 50 người dùng 1 request

 integer
tag_name

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.

 string
last_interaction_period

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

 string
is_follower

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

 boolean
login_name

Tên tài khoản đăng nhập hoặc định danh người dùng API.

 string
sign

Chữ ký bảo mật (hash MD5) dùng để xác thực tính toàn vẹn của yêu cầu.

View More 		string

Request Formats

application/json, text/json, text/html

Sample: 
{
  "brand_name": "Abenla",
  "offset": 0,
  "count": 50,
  "tag_name": "HCM",
  "last_interaction_period": "L30D",
  "is_follower": true,
  "login_name": "ABL1234",
  "sign": "691a5659131a04e0a831472e7a4ba33b"
}

Response Information

Resource Description

Name Description Type
data

Dữ liệu danh sách follower.

 GetOAFollowerData
code

Mã lỗi trả về từ hệ thống (enum).
Error code returned from the system (enum type).

 ErrorCode
message

Thông điệp lỗi hoặc mô tả phản hồi.
Error message or response description.

 string

Response Formats

application/json, text/json, text/html

Sample: 
{
  "data": {
    "total": 1,
    "count": 50,
    "offset": 0,
    "users": [
      {
        "user_id": "12345678910111213"
      },
      {
        "user_id": "14151617181920212"
      }
    ]
  },
  "code": 106,
  "message": "Success"
}