From 572048be6c6ea1a62c693ce5e8723acdf34dc90c Mon Sep 17 00:00:00 2001
From: niko <1377382065@qq.com>
Date: Tue, 21 Dec 2021 09:28:52 +0800
Subject: [PATCH] add PhoneNumberApi doc

---
 .../com/foxinmy/weixin4j/wxa/api/PhoneNumberApi.java | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/PhoneNumberApi.java b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/PhoneNumberApi.java
index ee283fd2..fa59efff 100644
--- a/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/PhoneNumberApi.java
+++ b/weixin4j-wxa/src/main/java/com/foxinmy/weixin4j/wxa/api/PhoneNumberApi.java
@@ -8,8 +8,9 @@ import com.foxinmy.weixin4j.wxa.WXBizDataCrypt;
 import com.foxinmy.weixin4j.wxa.model.phone.PhoneInfo;
 
 import java.util.Properties;
+
 /**
- * 微信绑定号码。
+ * 获取微信绑定号码。
  *
  * @since 1.10.0
  */
@@ -21,7 +22,10 @@ public class PhoneNumberApi extends TokenManagerApi {
 
 	/**
 	 * 获取微信绑定手机号码
+	 * code换取用户手机号。 每个code只能使用一次，code的有效期为5min
 	 *
+	 * @param code 微信小程序 open-type="getPhoneNumber"
+	 * @throws WeixinException code无效或过期
 	 * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/phonenumber/phonenumber.getPhoneNumber.html"><a/>
 	 */
 	public PhoneInfo getPhoneNumber(String code) throws WeixinException {
@@ -38,6 +42,12 @@ public class PhoneNumberApi extends TokenManagerApi {
 
 	/**
 	 * 从 encryptedData 中解析 PhoneInfo
+	 *
+	 * @param appId         小程序 appId
+	 * @param sessionKey    wx.login 获取
+	 * @param encryptedData 密文
+	 * @param iv            加密方式
+	 * @see <a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/deprecatedGetPhoneNumber.html"></a>
 	 */
 	public PhoneInfo parsePhoneNumber(
 		String appId,