getUserInfo

Cập nhật lần cuối: 11/06/2024

API truy xuất thông tin của người dùng bao gồm:

• ID: chuỗi định danh người dùng theo Zalo App, được cấp mặc định.
• Tên và Ảnh đại diện: nhằm tuân thủ Nghị Định số 13/2023/NĐ-CP về chính sách bảo vệ dữ liệu cá nhân, thông tin này sẽ yêu cầu người dùng xác nhận cho phép trước khi truy xuất. Nếu ứng dụng cần sử dụng thông tin này, vui lòng truyền param autoRequestPermission với giá trị true (hỗ trợ từ phiên bản 2.38.2), hoặc sử dụng API authorize để yêu cầu người dùng cho phép truy cập trước khi sử dụng API này.

Parameters

Object object

Property	Type	Default	Required	Description	Minimum Version
avatarType	string			Nhận các giá trị: "small", "normal", "large". Mặc định kích thước ảnh trả về sẽ là ảnh nhỏ nhất. Bạn có thể yêu cầu ảnh lớn hơn bằng cách thay đổi giá trị này	2.14.2
autoRequestPermission	boolean	false		Với giá trị true - ứng dụng sẽ tự động hiển thị form yêu cầu người dùng cho phép truy cập Tên và Ảnh đại diện nếu trước đó chưa được người dùng đồng ý.	2.38.2
success	function			Callback function khi gọi api thành công
fail	function			Callback function khi gọi api thất bại

Return Values

Promise <Object data>

Property	Type	Description	Minimum Version
userInfo	userInfo	Thông tin user

Entities

UserInfo

Property	Type	Description	Minimum Version
id	string	Chuỗi định danh người dùng theo Zalo App. Chuỗi này là duy nhất cho mỗi người dùng trên mỗi ID Zalo App. Các Mini App cùng chung một ID Zalo App sẽ có thể dùng chuỗi này để định danh người dùng. Có thể sử dụng ID này để gửi thông báo tới người dùng qua OA chung của Zalo Mini App, tham khảo tại đây
idByOA	string	Chuỗi định danh người dùng theo Official Account. Yêu cầu Zalo App phải được liên kết với Official Account. Có thể sử dụng ID này để gửi tin nhắn cho người dùng nếu người dùng đã theo dõi Official Account. Xem chi tiết cách gửi tin nhắn cho người dùng tại đây	2.23.3
followedOA	boolean	Trạng thái theo dõi Official Account đã được liên kết với Zalo App.	2.32.3
name	string	Tên hiển thị của người dùng.
avatar	string	Ảnh đại diện người dùng.
isSensitive	boolean	Cờ đánh dấu nếu true thì dữ liệu cá nhân thuộc diện nhạy cảm.	2.28.0

Sample Code

import { getUserInfo } from "zmp-sdk/apis";

getUserInfo({
  success: (data) => {
    // xử lý khi gọi api thành công
    const { userInfo } = data;
  },
  fail: (error) => {
    // xử lý khi gọi api thất bại
    console.log(error);
  },
});

Hoặc

import { getUserInfo } from "zmp-sdk/apis";

const getUser = async () => {
  try {
    const { userInfo } = await getUserInfo({});
  } catch (error) {
    // xử lý khi gọi api thất bại
    console.log(error);
  }
};