Nhảy tới nội dung

getUserInfo

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​

PropertyTypeDefaultRequiredDescriptionMinimum Version
avatarTypestringNhậ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ày2.14.2
autoRequestPermissionbooleanfalseVớ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
successfunctionCallback function khi gọi api thành công
failfunctionCallback function khi gọi api thất bại

Return Values​

Promise <Object data>​

PropertyTypeDescriptionMinimum Version
userInfouserInfoThông tin user

Entities​

UserInfo​

PropertyTypeDescriptionMinimum Version
idstringChuỗ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
idByOAstringChuỗi định danh người dùng theo Official Account. Có thể sử dụng ID này để gửi tin nhắn cho người dùng ( xem cách gửi tin nhắn với idByOA). Chuỗi có giá trị nếu thỏa 1 trong các điều kiện dưới đây:
  • Mini App đã được xác thực bởi Official Account, chi tiết xem tại đây
  • Zalo App phải được liên kết với Official Account và người dùng đã follow Official Account đó
2.23.3
followedOAbooleanTrạng thái theo dõi Official Account đã được liên kết với Zalo App.2.32.3
namestringTên hiển thị của người dùng.
avatarstringẢnh đại diện người dùng.
isSensitivebooleanTrả về 2 giá trị:
  • True: tài khoản này thuộc nhóm người dùng cần nhà phát triển Mini App xác minh và áp dụng các cơ chế xử lý dữ liệu phù hợp theo quy định Pháp luật, có thể bao gồm nhưng không giới hạn người đã chết hoặc mất tích, người không biết chữ, người khuyết tật, trẻ em,…
  • False: tài khoản này thuộc nhóm người dùng bình thường
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);
  }
};

getUserInfo

zi-chevron-up