微信小程序新版获取手机号授权接口 (#528)

* save

* set privacy

* 完善小程序隐私设置接口

* fix privacy desc

* 移除gitpod定义文件,api响应解析改用公共方法

* use DecodeWithCommonError

* fix ci

* fix ci

* fix other package ci

* fix err

go.mod

@@ -15,4 +15,4 @@ require (
 	golang.org/x/sys v0.0.0-20210309074719-68d13333faf2 // indirect
 	gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect
 	gopkg.in/h2non/gock.v1 v1.0.15
-)
+)

miniprogram/auth/auth.go

@@ -13,6 +13,8 @@ const (
 	code2SessionURL = "https://api.weixin.qq.com/sns/jscode2session?appid=%s&secret=%s&js_code=%s&grant_type=authorization_code"
 
 	checkEncryptedDataURL = "https://api.weixin.qq.com/wxa/business/checkencryptedmsg?access_token=%s"
+
+	getPhoneNumber = "https://api.weixin.qq.com/wxa/business/getuserphonenumber?access_token=%s"
 )
 
 // Auth 登录/用户信息
@@ -90,3 +92,42 @@ func (auth *Auth) CheckEncryptedDataContext(ctx context2.Context, encryptedMsgHa
 	}
 	return
 }
+
+// GetPhoneNumberResponse 新版获取用户手机号响应结构体
+type GetPhoneNumberResponse struct {
+	util.CommonError
+
+	PhoneInfo PhoneInfo `json:"phone_info"`
+}
+
+// PhoneInfo 获取用户手机号内容
+type PhoneInfo struct {
+	PhoneNumber     string `json:"phoneNumber"`     // 用户绑定的手机号
+	PurePhoneNumber string `json:"purePhoneNumber"` // 没有区号的手机号
+	CountryCode     string `json:"countryCode"`     // 区号
+	WaterMark       struct {
+		Timestamp int64  `json:"timestamp"`
+		AppID     string `json:"appid"`
+	} `json:"watermark"` // 数据水印
+}
+
+// GetPhoneNumber 小程序通过code获取用户手机号
+func (auth *Auth) GetPhoneNumber(code string) (result GetPhoneNumberResponse, err error) {
+	var response []byte
+	var (
+		at string
+	)
+	if at, err = auth.GetAccessToken(); err != nil {
+		return
+	}
+	body := map[string]interface{}{
+		"code": code,
+	}
+	if response, err = util.PostJSON(fmt.Sprintf(getPhoneNumber, at), body); err != nil {
+		return
+	}
+	if err = util.DecodeWithError(response, &result, "phonenumber.getPhoneNumber"); err != nil {
+		return
+	}
+	return
+}

miniprogram/miniprogram.go

@@ -9,6 +9,7 @@ import (
 	"github.com/silenceper/wechat/v2/miniprogram/context"
 	"github.com/silenceper/wechat/v2/miniprogram/encryptor"
 	"github.com/silenceper/wechat/v2/miniprogram/message"
+	"github.com/silenceper/wechat/v2/miniprogram/privacy"
 	"github.com/silenceper/wechat/v2/miniprogram/qrcode"
 	"github.com/silenceper/wechat/v2/miniprogram/shortlink"
 	"github.com/silenceper/wechat/v2/miniprogram/subscribe"
@@ -57,6 +58,11 @@ func (miniProgram *MiniProgram) GetAnalysis() *analysis.Analysis {
 	return analysis.NewAnalysis(miniProgram.ctx)
 }
 
+// GetPrivacy 小程序隐私协议相关API
+func (miniProgram *MiniProgram) GetPrivacy() *privacy.Privacy {
+	return privacy.NewPrivacy(miniProgram.ctx)
+}
+
 // GetQRCode 小程序码相关API
 func (miniProgram *MiniProgram) GetQRCode() *qrcode.QRCode {
 	return qrcode.NewQRCode(miniProgram.ctx)

miniprogram/privacy/privacy.go

@@ -0,0 +1,167 @@
+package privacy
+
+import (
+	"errors"
+	"fmt"
+
+	"github.com/silenceper/wechat/v2/miniprogram/context"
+	"github.com/silenceper/wechat/v2/util"
+)
+
+// Privacy 小程序授权隐私设置
+type Privacy struct {
+	*context.Context
+}
+
+// NewPrivacy 实例化小程序隐私接口
+// 文档地址 https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/privacy_config/set_privacy_setting.html
+func NewPrivacy(context *context.Context) *Privacy {
+	if context == nil {
+		panic("NewPrivacy got a nil context")
+	}
+	return &Privacy{
+		context,
+	}
+}
+
+// OwnerSetting 收集方（开发者）信息配置
+type OwnerSetting struct {
+	ContactEmail         string `json:"contact_email"`
+	ContactPhone         string `json:"contact_phone"`
+	ContactQQ            string `json:"contact_qq"`
+	ContactWeixin        string `json:"contact_weixin"`
+	ExtFileMediaID       string `json:"ext_file_media_id"`
+	NoticeMethod         string `json:"notice_method"`
+	StoreExpireTimestamp string `json:"store_expire_timestamp"`
+}
+
+// SettingItem 收集权限的配置
+type SettingItem struct {
+	PrivacyKey  string `json:"privacy_key"`
+	PrivacyText string `json:"privacy_text"`
+}
+
+// SetPrivacySettingRequest 设置权限的请求参数
+type SetPrivacySettingRequest struct {
+	PrivacyVer   int           `json:"privacy_ver"`
+	OwnerSetting OwnerSetting  `json:"owner_setting"`
+	SettingList  []SettingItem `json:"setting_list"`
+}
+
+const (
+	setPrivacySettingURL    = "https://api.weixin.qq.com/cgi-bin/component/setprivacysetting"
+	getPrivacySettingURL    = "https://api.weixin.qq.com/cgi-bin/component/getprivacysetting"
+	uploadPrivacyExtFileURL = "https://api.weixin.qq.com/cgi-bin/component/uploadprivacyextfile"
+
+	// PrivacyV1 用户隐私保护指引的版本，1表示现网版本。
+	PrivacyV1 = 1
+	// PrivacyV2 2表示开发版。默认是2开发版。
+	PrivacyV2 = 2
+)
+
+// GetPrivacySettingResponse 获取权限配置的响应结果
+type GetPrivacySettingResponse struct {
+	util.CommonError
+	CodeExist    int                   `json:"code_exist"`
+	PrivacyList  []string              `json:"privacy_list"`
+	SettingList  []SettingResponseItem `json:"setting_list"`
+	UpdateTime   int64                 `json:"update_time"`
+	OwnerSetting OwnerSetting          `json:"owner_setting"`
+	PrivacyDesc  DescList              `json:"privacy_desc"`
+}
+
+// SettingResponseItem 获取权限设置的响应明细
+type SettingResponseItem struct {
+	PrivacyKey   string `json:"privacy_key"`
+	PrivacyText  string `json:"privacy_text"`
+	PrivacyLabel string `json:"privacy_label"`
+}
+
+// DescList 权限列表(保持与官方一致)
+type DescList struct {
+	PrivacyDescList []Desc `json:"privacy_desc_list"`
+}
+
+// Desc 权限列表明细(保持与官方一致)
+type Desc struct {
+	PrivacyDesc string `json:"privacy_desc"`
+	PrivacyKey  string `json:"privacy_key"`
+}
+
+// GetPrivacySetting 获取小程序权限配置
+func (s *Privacy) GetPrivacySetting(privacyVer int) (GetPrivacySettingResponse, error) {
+	accessToken, err := s.GetAccessToken()
+	if err != nil {
+		return GetPrivacySettingResponse{}, err
+	}
+
+	response, err := util.PostJSON(fmt.Sprintf("%s?access_token=%s", getPrivacySettingURL, accessToken), map[string]int{
+		"privacy_ver": privacyVer,
+	})
+	if err != nil {
+		return GetPrivacySettingResponse{}, err
+	}
+	// 返回错误信息
+	var result GetPrivacySettingResponse
+	if err = util.DecodeWithError(response, &result, "getprivacysetting"); err != nil {
+		return GetPrivacySettingResponse{}, err
+	}
+
+	return result, nil
+}
+
+// SetPrivacySetting 更新小程序权限配置
+func (s *Privacy) SetPrivacySetting(privacyVer int, ownerSetting OwnerSetting, settingList []SettingItem) error {
+	if privacyVer == PrivacyV1 && len(settingList) > 0 {
+		return errors.New("当privacy_ver传2或者不传时，setting_list是必填；当privacy_ver传1时，该参数不可传")
+	}
+	accessToken, err := s.GetAccessToken()
+	if err != nil {
+		return err
+	}
+
+	response, err := util.PostJSON(fmt.Sprintf("%s?access_token=%s", setPrivacySettingURL, accessToken), SetPrivacySettingRequest{
+		PrivacyVer:   privacyVer,
+		OwnerSetting: ownerSetting,
+		SettingList:  settingList,
+	})
+	if err != nil {
+		return err
+	}
+
+	// 返回错误信息
+	if err = util.DecodeWithCommonError(response, "setprivacysetting"); err != nil {
+		return err
+	}
+
+	return err
+}
+
+// UploadPrivacyExtFileResponse 上传权限定义模板响应参数
+type UploadPrivacyExtFileResponse struct {
+	util.CommonError
+	ExtFileMediaID string `json:"ext_file_media_id"`
+}
+
+// UploadPrivacyExtFile 上传权限定义模板
+func (s *Privacy) UploadPrivacyExtFile(fileData []byte) (UploadPrivacyExtFileResponse, error) {
+	accessToken, err := s.GetAccessToken()
+	if err != nil {
+		return UploadPrivacyExtFileResponse{}, err
+	}
+
+	response, err := util.PostJSON(fmt.Sprintf("%s?access_token=%s", uploadPrivacyExtFileURL, accessToken), map[string][]byte{
+		"file": fileData,
+	})
+	if err != nil {
+		return UploadPrivacyExtFileResponse{}, err
+	}
+
+	// 返回错误信息
+	var result UploadPrivacyExtFileResponse
+	if err = util.DecodeWithError(response, &result, "setprivacysetting"); err != nil {
+		return UploadPrivacyExtFileResponse{}, err
+	}
+
+	return result, err
+}

miniprogram/qrcode/qrcode.go

@@ -40,6 +40,8 @@ type QRCoder struct {
 	Page string `json:"page,omitempty"`
 	// path 扫码进入的小程序页面路径
 	Path string `json:"path,omitempty"`
+	// checkPath 检查page 是否存在，为 true 时 page 必须是已经发布的小程序存在的页面（否则报错）；为 false 时允许小程序未发布或者 page 不存在， 但page 有数量上限（60000个）请勿滥用
+	CheckPath bool `json:"check_path,omitempty"`
 	// width 图片宽度
 	Width int `json:"width,omitempty"`
 	// scene 最大32个可见字符，只支持数字，大小写英文以及部分特殊字符：!#$&'()*+,/:;=?@-._~，其它字符请自行编码为合法字符（因不支持%，中文无法使用 urlencode 处理，请使用其他编码方式）
@@ -50,6 +52,8 @@ type QRCoder struct {
 	LineColor Color `json:"line_color,omitempty"`
 	// isHyaline 是否需要透明底色
 	IsHyaline bool `json:"is_hyaline,omitempty"`
+	// envVersion 要打开的小程序版本。正式版为 "release"，体验版为 "trial"，开发版为 "develop"
+	EnvVersion string `json:"env_version,omitempty"`
 }
 
 // fetchCode 请求并返回二维码二进制数据

miniprogram/urllink/urllink.go

@@ -33,8 +33,10 @@ const (
 // ULParams 请求参数
 // https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-link/urllink.generate.html#请求参数
 type ULParams struct {
-	Path           string      `json:"path"`
-	Query          string      `json:"query"`
+	Path  string `json:"path"`
+	Query string `json:"query"`
+	// envVersion 要打开的小程序版本。正式版为 "release"，体验版为 "trial"，开发版为 "develop"
+	EnvVersion     string      `json:"env_version,omitempty"`
 	IsExpire       bool        `json:"is_expire"`
 	ExpireType     TExpireType `json:"expire_type"`
 	ExpireTime     int64       `json:"expire_time"`

openplatform/context/accessToken.go

@@ -26,6 +26,7 @@ const (
 
 // ComponentAccessToken 第三方平台
 type ComponentAccessToken struct {
+	util.CommonError
 	AccessToken string `json:"component_access_token"`
 	ExpiresIn   int64  `json:"expires_in"`
 }
@@ -57,6 +58,10 @@ func (ctx *Context) SetComponentAccessToken(verifyTicket string) (*ComponentAcce
 		return nil, err
 	}
 
+	if at.ErrCode != 0 {
+		return nil, fmt.Errorf("SetComponentAccessToken Error , errcode=%d , errmsg=%s", at.ErrCode, at.ErrMsg)
+	}
+
 	accessTokenCacheKey := fmt.Sprintf("component_access_token_%s", ctx.AppID)
 	expires := at.ExpiresIn - 1500
 	if err := ctx.Cache.Set(accessTokenCacheKey, at.AccessToken, time.Duration(expires)*time.Second); err != nil {

work/msgaudit/README.md

@@ -34,13 +34,13 @@ import (
 func main() {
 	//初始化客户端
 	wechatClient := wechat.NewWechat()
-	
+
 	workClient := wechatClient.GetWork(&config.Config{
 		CorpID:        "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 		CorpSecret:    "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 		RasPrivateKey: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
 	})
-	
+
 	client, err := workClient.GetMsgAudit()
 	if err != nil {
 		fmt.Printf("SDK 初始化失败：%v \n", err)
@@ -64,13 +64,14 @@ func main() {
 
 		if chatInfo.Type == "image" {
 			image, _ := chatInfo.GetImageMessage()
-			sdkfileid := image.Image.SdkFileId
+			sdkFileID := image.Image.SdkFileID
 
 			isFinish := false
 			buffer := bytes.Buffer{}
+			indexBuf := ""
 			for !isFinish {
 				//获取媒体数据
-				mediaData, err := client.GetMediaData("", sdkfileid, "", "", 5)
+				mediaData, err := client.GetMediaData(indexBuf, sdkFileID, "", "", 5)
 				if err != nil {
 					fmt.Printf("媒体数据拉取失败：%v \n", err)
 					return
@@ -79,6 +80,7 @@ func main() {
 				if mediaData.IsFinish {
 					isFinish = mediaData.IsFinish
 				}
+				indexBuf = mediaData.OutIndexBuf
 			}
 			filePath, _ := os.Getwd()
 			filePath = path.Join(filePath, "test.png")
@@ -90,11 +92,11 @@ func main() {
 			break
 		}
 	}
-	
+
 	//释放SDK实例
 	client.Free()
 }
 
 
 
-```
+```