Zalo — Người theo dõi

Danh sách người dùng (List users) — zalo.list_users

List OA users, up to 50 per page (offset up to 9951). Filter by tag_name, is_follower or last_interaction_period (TODAY, YESTERDAY, L7D, L30D or YYYY_MM_DD:YYYY_MM_DD).

Tác động	Rủi ro	Cần duyệt	Idempotent	Scopes
NONE	low	không	có	—

Input

Field	Nhãn	Kiểu	Bắt buộc	Mô tả
offset	Vị trí bắt đầu	integer	có	Min 0. Max 9951.
count	Số lượng	integer	có	Min 1. Max 50.
tag_name	Nhãn	string	không
last_interaction_period	Tương tác gần nhất	string	không	TODAY, YESTERDAY, L7D, L30D or YYYY_MM_DD:YYYY_MM_DD.
is_follower	Đang theo dõi	string	không	One of: true, false.

Field thêm: bỏ qua.

Output

Field	Nhãn	Kiểu	Mô tả
data	Kết quả	object	One page of users.
data.total		integer	Total users that match the filter.
data.count		integer	Number of users requested.
data.offset		integer	Position of the first user in this page.
data.users		array of object	Users in this page.
data.users[].user_id		string	Zalo user ID.

Chi tiết người dùng (Get user) — zalo.get_user

Get a user's profile: name, alias, tags, notes, last interaction and shared contact info.

Tác động	Rủi ro	Cần duyệt	Idempotent	Scopes
NONE	low	không	có	—

Input

Field	Nhãn	Kiểu	Bắt buộc	Mô tả
user_id	Mã người dùng	string	có	Zalo user ID of the OA follower.

Field thêm: bỏ qua.

Output

Field	Nhãn	Kiểu	Mô tả
data	Kết quả	object	The user's profile.
data.user_id		string	Zalo user ID.
data.user_id_by_app		string	The user's ID within the connected app.
data.user_external_id		string	The user's ID in your own system. Empty string when not set.
data.display_name		string	Name shown on the user's Zalo profile.
data.user_alias		string	Alias the OA gave the user.
data.is_sensitive		boolean	True when the user is under 18, false when 18 or older.
data.user_last_interaction_date		string	Date of the user's last interaction with the OA, dd/MM/yyyy.
data.user_is_follower		boolean	True while the user follows the OA.
data.avatar		string	URL of the user's avatar.
data.avatars		object	Avatar URLs by size, keyed by pixel size. The reference table types this as a string; its example shows an object.
data.avatars.120		string	URL of the 120 px avatar.
data.avatars.240		string	URL of the 240 px avatar.
data.dynamic_param		string	Last dynamic_param the user arrived with through the OA's Dynamic URL. Missing when none.
data.tags_and_notes_info		object	Tags and notes the OA set on the user.
data.tags_and_notes_info.notes		array of string	Notes on the user.
data.tags_and_notes_info.tag_names		array of string	Tags on the user.
data.shared_info		object	Contact details the user shared with the OA. Empty when the user shared none.
data.shared_info.name		string	Name the user shared.
data.shared_info.phone		string	Phone number the user shared. The reference also shows it as a number.
data.shared_info.address		string	Street address the user shared.
data.shared_info.city		string	City the user shared.
data.shared_info.district		string	District the user shared.
data.shared_info.user_dob		string	Birthday the user shared, dd/MM/yyyy.

Cập nhật người dùng (Update user) — zalo.update_user

Update a user's shared contact info, alias or external ID.

Tác động	Rủi ro	Cần duyệt	Idempotent	Scopes
WRITE	medium	có	không	—

Input

Field	Nhãn	Kiểu	Bắt buộc	Mô tả
user_id	Mã người dùng	string	có	Zalo user ID of the OA follower.
shared_info	Thông tin liên hệ	object	không	Contact details the user shared with the OA.
shared_info.name		string	không
shared_info.phone		string	không
shared_info.address		string	không
shared_info.city_id		string	không
shared_info.district_id		string	không
shared_info.user_dob		string	không	Birthday, dd/MM/yyyy.
user_alias	Biệt danh	string	không
user_external_id	Mã ngoài	string	không

Field thêm: bỏ qua.

Output

Field	Nhãn	Kiểu	Mô tả
data	Kết quả	object	Not returned: Zalo replies only error and message.

Thông tin tùy chỉnh người dùng (Get user custom info) — zalo.get_user_custom_info

Get a user's custom field values. Limit the result with fields_to_export.

Tác động	Rủi ro	Cần duyệt	Idempotent	Scopes
NONE	low	không	có	—

Input

Field	Nhãn	Kiểu	Bắt buộc	Mô tả
user_id	Mã người dùng	string	có	Zalo user ID of the OA follower.
fields_to_export	Trường cần lấy	array of string	không	Custom field names to return.

Field thêm: bỏ qua.

Output

Field	Nhãn	Kiểu	Mô tả
data	Kết quả	object	The user's profile and custom field values.
data.user_id		string	Zalo user ID.
data.name		string	Name of the user. Empty when unknown.
data.phone		string	Phone number. Empty when unknown.
data.user_dob		string	Birthday, dd/MM/yyyy.
data.gender		string	Gender of the user.
data.full_address		object	Address of the user.
data.full_address.user_city		string	City.
data.full_address.user_ward		string	Ward.
data.full_address.user_address		string	Street address.
data.user_external_id		string	The user's ID in your own system. Empty string when not set.
data.dynamic_param		string	Last dynamic_param the user arrived with through the OA's Dynamic URL.
data.custom_info		object	Custom field values, keyed by the OA's own field names (for example loyaltyPoints_number). Every value is a string (booleans as "true"/"false", numbers as text); a table field is an object whose values are strings. This reply sends error as the string "0".

Cập nhật thông tin tùy chỉnh (Update user custom info) — zalo.update_user_custom_info

Set a user's custom field values. custom_info maps field name to value.

Tác động	Rủi ro	Cần duyệt	Idempotent	Scopes
WRITE	medium	có	không	—

Input

Field	Nhãn	Kiểu	Bắt buộc	Mô tả
user_id	Mã người dùng	string	có	Zalo user ID of the OA follower.
custom_info	Giá trị tùy chỉnh	object	có	Map of custom field name to value.

Field thêm: bỏ qua.

Output

Field	Nhãn	Kiểu	Mô tả
data	Kết quả	object	Not returned: Zalo replies only error and message.

Xóa thông tin người dùng (Delete user info) — zalo.delete_user_info

Delete the personal info the OA stored for a user. Cannot be undone.

Tác động	Rủi ro	Cần duyệt	Idempotent	Scopes
WRITE	high	có	không	—

Input

Field	Nhãn	Kiểu	Bắt buộc	Mô tả
user_id	Mã người dùng	string	có	Zalo user ID of the OA follower.

Field thêm: bỏ qua.

Output

Field	Nhãn	Kiểu	Mô tả
data	Kết quả	object	Not returned: Zalo replies only error and message.