getPhoneNumber
Bắt đầu hỗ trợ ở phiên bản:
- SDK: 2.13.0
Cần xin cấp quyền tại trang Quản lý ứng dụng
import { getPhoneNumber } from "zmp-sdk/apis";
Lấy thông tin số điện thoại của người dùng. Khi gọi API, một thông báo xin cấp quyền sẽ được hiển thị. Mini App chỉ lấy được thông tin số điện thoại nếu người dùng đồng ý cấp quyền chia sẻ số điện thoại.
Lưu ý, để giúp các nhà phát triển Mini App sử dụng flow xin quyền một cách hiệu quả, cũng như phù hợp với chính sách của Zalo Mini App điều 3.3.4, Mini App Team đã đưa ra một số gợi ý thiết kế trải nghiệm như thông tin bên dưới. Nhà phát triển cần giải thích rõ ràng và trực quan mục đích xin quyền để người dùng dễ dàng hiểu và đồng ý cung cấp thông tin.
Trường hợp chỉ cần số điện thoại cho một số tính năng nhất định
Chỉ nên yêu cầu người dùng chia sẻ số điện thoại khi người dùng bắt đầu sử dụng các tính năng đó như khi tiến hành đặt hàng, đăng ký tham sự kiện...
Trường bắt buộc phải cung cấp số điện thoại để sử dụng ứng dụng
Với trường hợp này cần hiển thị UI Onboarding giải thích cụ thể lý do người dùng cần phải cung cấp số điện thoại. Tham khảo hình minh họa:
Nhằm đảm bảo trải nghiệm thoải mái của người dùng Mini App, chúng tôi sẽ từ chối xét duyệt cho những Mini App có luồng xin cấp quyền chưa rõ ràng, không nêu được mục đích xin quyền đến người dùng. Tham khảo một số trường hợp vi phạm như bên dưới:
Mô tả luồng truy xuất thông tin

Ví dụ
- Ở Zalo Mini App, gọi API này để lấy token số điện thoại:
const { token } = await getPhoneNumber();
-
Dùng fetch hoặc axios để gửi token này lên server. Nếu không, bạn sẽ bị lỗi khi gọi các API Server-Server từ Mini App.
-
Server chuyển đổi token thành thông tin số điện thoại và trả về cho Mini App theo hướng dẫn.
Kết quả trả về
API trả về Promise<GetPhoneNumberReturns>
chứa chứa token để truy xuất thông tin số điện thoại.
GetPhoneNumberReturns
Name | Type | Default | Description |
---|---|---|---|
token | string | Là một chuỗi ký tự dùng để truy xuất thông tin số điện thoại thông qua server. Mỗi token được cung cấp chỉ có thể truy xuất thông tin được 1 lần với thời gian hết hạn sau 2 phút. |
Hướng dẫn chuyển đổi token thành số điện thoại người dùng
Sử dụng token vừa nhận được để truy xuất số điện thoại của người dùng từ Server của bạn thông qua Zalo Open API, vui lòng tham khảo code mẫu bên dưới:
Mô tả các tham số cần sử dụng:
- access_token: truy xuất thông qua API sdk.getAccessToken({...})
- code: giá trị là token bạn nhận được khi gọi API lấy số điện thoại.
- secret_key: Khoá bí mật của Zalo App, truy cập https://developers.zalo.me/, phần Quản lý ứng dụng tương ứng để truy xuất thông tin
Ví dụ kết quả trả về:
{
"data": {
"number": "849123456789"
},
"error": 0,
"message": "Success"
}