Revert "feat: 小程序/公众号增加 openApi 管理。 (#685)"

This reverts commit 31f8e24994.

officialaccount/user/user.go

@@ -2,6 +2,7 @@ package user
 
 import (
 	"encoding/json"
+	"errors"
 	"fmt"
 	"net/url"
 
@@ -10,9 +11,10 @@ import (
 )
 
 const (
-	userInfoURL     = "https://api.weixin.qq.com/cgi-bin/user/info?access_token=%s&openid=%s&lang=zh_CN"
-	updateRemarkURL = "https://api.weixin.qq.com/cgi-bin/user/info/updateremark?access_token=%s"
-	userListURL     = "https://api.weixin.qq.com/cgi-bin/user/get"
+	userInfoURL      = "https://api.weixin.qq.com/cgi-bin/user/info?access_token=%s&openid=%s&lang=zh_CN"
+	userInfoBatchURL = "https://api.weixin.qq.com/cgi-bin/user/info/batchget"
+	updateRemarkURL  = "https://api.weixin.qq.com/cgi-bin/user/info/updateremark?access_token=%s"
+	userListURL      = "https://api.weixin.qq.com/cgi-bin/user/get"
 )
 
 // User 用户管理
@@ -30,7 +32,11 @@ func NewUser(context *context.Context) *User {
 // Info 用户基本信息
 type Info struct {
 	util.CommonError
+	userInfo
+}
 
+// 用户基本信息
+type userInfo struct {
 	Subscribe      int32   `json:"subscribe"`
 	OpenID         string  `json:"openid"`
 	Nickname       string  `json:"nickname"`
@@ -88,6 +94,48 @@ func (user *User) GetUserInfo(openID string) (userInfo *Info, err error) {
 	return
 }
 
+// BatchGetUserInfoParams 批量获取用户基本信息参数
+type BatchGetUserInfoParams struct {
+	UserList []BatchGetUserListItem `json:"user_list"` // 需要批量获取基本信息的用户列表
+}
+
+// BatchGetUserListItem 需要获取基本信息的用户
+type BatchGetUserListItem struct {
+	OpenID string `json:"openid"` // 用户的标识，对当前公众号唯一
+	Lang   string `json:"lang"`   // 国家地区语言版本，zh_CN 简体，zh_TW 繁体，en 英语，默认为zh-CN
+}
+
+// InfoList 用户基本信息列表
+type InfoList struct {
+	util.CommonError
+	UserInfoList []userInfo `json:"user_info_list"`
+}
+
+// BatchGetUserInfo 批量获取用户基本信息
+func (user *User) BatchGetUserInfo(params BatchGetUserInfoParams) (*InfoList, error) {
+	if len(params.UserList) > 100 {
+		return nil, errors.New("params length must be less than or equal to 100")
+	}
+
+	ak, err := user.GetAccessToken()
+	if err != nil {
+		return nil, err
+	}
+
+	uri := fmt.Sprintf("%s?access_token=%s", userInfoBatchURL, ak)
+	res, err := util.PostJSON(uri, params)
+	if err != nil {
+		return nil, err
+	}
+
+	var data InfoList
+	err = util.DecodeWithError(res, &data, "BatchGetUserInfo")
+	if err != nil {
+		return nil, err
+	}
+	return &data, nil
+}
+
 // UpdateRemark 设置用户备注名
 func (user *User) UpdateRemark(openID, remark string) (err error) {
 	var accessToken string

openplatform/miniprogram/component/component.go

@@ -36,7 +36,7 @@ type RegisterMiniProgramParam struct {
 func (component *Component) RegisterMiniProgram(param *RegisterMiniProgramParam) error {
 	componentAK, err := component.GetComponentAccessToken()
 	if err != nil {
-		return nil
+		return err
 	}
 	url := fmt.Sprintf(fastregisterweappURL+"?action=create&component_access_token=%s", componentAK)
 	data, err := util.PostJSON(url, param)
@@ -58,7 +58,7 @@ type GetRegistrationStatusParam struct {
 func (component *Component) GetRegistrationStatus(param *GetRegistrationStatusParam) error {
 	componentAK, err := component.GetComponentAccessToken()
 	if err != nil {
-		return nil
+		return err
 	}
 	url := fmt.Sprintf(fastregisterweappURL+"?action=search&component_access_token=%s", componentAK)
 	data, err := util.PostJSON(url, param)

util/query.go

@@ -0,0 +1,24 @@
+package util
+
+import (
+	"fmt"
+	"strings"
+)
+
+// Query 将Map序列化为Query参数
+func Query(params map[string]interface{}) string {
+	finalString := make([]string, 0)
+	for key, value := range params {
+		valueString := ""
+		switch v := value.(type) {
+		case int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uint64:
+			valueString = fmt.Sprintf("%d", v)
+		case bool:
+			valueString = fmt.Sprintf("%v", v)
+		default:
+			valueString = fmt.Sprintf("%s", v)
+		}
+		finalString = append(finalString, strings.Join([]string{key, valueString}, "="))
+	}
+	return strings.Join(finalString, "&")
+}

util/query_test.go

@@ -0,0 +1,19 @@
+package util
+
+import (
+	"testing"
+)
+
+// TestQuery query method test case
+func TestQuery(t *testing.T) {
+	result := Query(map[string]interface{}{
+		"age":  12,
+		"name": "Alan",
+		"cat":  "Peter",
+	})
+	if result == "" {
+		// 由于hash是乱序 所以没法很好的预测输出的字符串
+		// 将会输出符合Query规则的字符串 "age=12&name=Alan&cat=Peter"
+		t.Error("NOT PASS")
+	}
+}

util/template.go

@@ -0,0 +1,24 @@
+package util
+
+import (
+	"fmt"
+	"strings"
+)
+
+// Template 对字符串中的和map的key相同的字符串进行模板替换 仅支持 形如: {name}
+func Template(source string, data map[string]interface{}) string {
+	sourceCopy := &source
+	for k, val := range data {
+		valStr := ""
+		switch v := val.(type) {
+		case int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uint64:
+			valStr = fmt.Sprintf("%d", v)
+		case bool:
+			valStr = fmt.Sprintf("%v", v)
+		default:
+			valStr = fmt.Sprintf("%s", v)
+		}
+		*sourceCopy = strings.Replace(*sourceCopy, strings.Join([]string{"{", k, "}"}, ""), valStr, 1)
+	}
+	return *sourceCopy
+}

util/template_test.go

@@ -0,0 +1,20 @@
+package util
+
+import (
+	"testing"
+)
+
+// TestTemplate testing case about Template method
+func TestTemplate(t *testing.T) {
+	result := Template("{name}={age};{with}={another};any={any};boolean={boolean}", map[string]interface{}{
+		"name":    "Helan",
+		"age":     "33",
+		"with":    "Pep",
+		"another": "C",
+		"any":     33,
+		"boolean": false,
+	})
+	if result != "Helan=33;Pep=C;any=33;boolean=false" {
+		t.Error("NOT PSS testing")
+	}
+}

work/addresslist/user.go

@@ -1,18 +1,22 @@
 package addresslist
 
 import (
-	"fmt"
+	"strings"
 
 	"github.com/silenceper/wechat/v2/util"
 )
 
 const (
 	// userSimpleListURL 获取部门成员
-	userSimpleListURL = "https://qyapi.weixin.qq.com/cgi-bin/user/simplelist?access_token=%s&department_id=%d"
+	userSimpleListURL = "https://qyapi.weixin.qq.com/cgi-bin/user/simplelist"
 	// userGetURL 读取成员
-	userGetURL = "https://qyapi.weixin.qq.com/cgi-bin/user/get?access_token=%s&userid=%s"
+	userGetURL = "https://qyapi.weixin.qq.com/cgi-bin/user/get"
 	// userListIDURL 获取成员ID列表
-	userListIDURL = "https://qyapi.weixin.qq.com/cgi-bin/user/list_id?access_token=%s"
+	userListIDURL = "https://qyapi.weixin.qq.com/cgi-bin/user/list_id"
+	// convertToOpenIDURL userID转openID
+	convertToOpenIDURL = "https://qyapi.weixin.qq.com/cgi-bin/user/convert_to_openid"
+	// convertToUserIDURL openID转userID
+	convertToUserIDURL = "https://qyapi.weixin.qq.com/cgi-bin/user/convert_to_userid"
 )
 
 type (
@@ -41,7 +45,13 @@ func (r *Client) UserSimpleList(departmentID int) ([]*UserList, error) {
 		return nil, err
 	}
 	var response []byte
-	if response, err = util.HTTPGet(fmt.Sprintf(userSimpleListURL, accessToken, departmentID)); err != nil {
+	if response, err = util.HTTPGet(strings.Join([]string{
+		userSimpleListURL,
+		util.Query(map[string]interface{}{
+			"access_token":  accessToken,
+			"department_id": departmentID,
+		}),
+	}, "?")); err != nil {
 		return nil, err
 	}
 	result := &UserSimpleListResponse{}
@@ -125,7 +135,15 @@ func (r *Client) UserGet(UserID string) (*UserGetResponse, error) {
 		return nil, err
 	}
 	var response []byte
-	if response, err = util.HTTPGet(fmt.Sprintf(userGetURL, accessToken, UserID)); err != nil {
+
+	if response, err = util.HTTPGet(
+		strings.Join([]string{
+			userGetURL,
+			util.Query(map[string]interface{}{
+				"access_token":  accessToken,
+				"department_id": UserID,
+			}),
+		}, "?")); err != nil {
 		return nil, err
 	}
 	result := &UserGetResponse{}
@@ -166,7 +184,12 @@ func (r *Client) UserListID(req *UserListIDRequest) (*UserListIDResponse, error)
 		return nil, err
 	}
 	var response []byte
-	if response, err = util.PostJSON(fmt.Sprintf(userListIDURL, accessToken), req); err != nil {
+	if response, err = util.PostJSON(strings.Join([]string{
+		userListIDURL,
+		util.Query(map[string]interface{}{
+			"access_token": accessToken,
+		}),
+	}, "?"), req); err != nil {
 		return nil, err
 	}
 	result := &UserListIDResponse{}
@@ -175,3 +198,87 @@ func (r *Client) UserListID(req *UserListIDRequest) (*UserListIDResponse, error)
 	}
 	return result, nil
 }
+
+type (
+	// convertToOpenIDRequest userID转openID请求
+	convertToOpenIDRequest struct {
+		UserID string `json:"userid"`
+	}
+
+	// convertToOpenIDResponse userID转openID响应
+	convertToOpenIDResponse struct {
+		util.CommonError
+		OpenID string `json:"openid"`
+	}
+)
+
+// ConvertToOpenID userID转openID
+// see https://developer.work.weixin.qq.com/document/path/90202
+func (r *Client) ConvertToOpenID(userID string) (string, error) {
+	var (
+		accessToken string
+		err         error
+	)
+	if accessToken, err = r.GetAccessToken(); err != nil {
+		return "", err
+	}
+	var response []byte
+
+	if response, err = util.PostJSON(strings.Join([]string{
+		convertToOpenIDURL,
+		util.Query(map[string]interface{}{
+			"access_token": accessToken,
+		}),
+	}, "?"), &convertToOpenIDRequest{
+		UserID: userID,
+	}); err != nil {
+		return "", err
+	}
+	result := &convertToOpenIDResponse{}
+	if err = util.DecodeWithError(response, result, "ConvertToOpenID"); err != nil {
+		return "", err
+	}
+	return result.OpenID, nil
+}
+
+type (
+	// convertToUserIDRequest openID转userID请求
+	convertToUserIDRequest struct {
+		OpenID string `json:"openid"`
+	}
+
+	// convertToUserIDResponse openID转userID响应
+	convertToUserIDResponse struct {
+		util.CommonError
+		UserID string `json:"userid"`
+	}
+)
+
+// ConvertToUserID openID转userID
+// see https://developer.work.weixin.qq.com/document/path/90202
+func (r *Client) ConvertToUserID(openID string) (string, error) {
+	var (
+		accessToken string
+		err         error
+	)
+	if accessToken, err = r.GetAccessToken(); err != nil {
+		return "", err
+	}
+	var response []byte
+
+	if response, err = util.PostJSON(strings.Join([]string{
+		convertToUserIDURL,
+		util.Query(map[string]interface{}{
+			"access_token": accessToken,
+		}),
+	}, "?"), &convertToUserIDRequest{
+		OpenID: openID,
+	}); err != nil {
+		return "", err
+	}
+	result := &convertToUserIDResponse{}
+	if err = util.DecodeWithError(response, result, "ConvertToUserID"); err != nil {
+		return "", err
+	}
+	return result.UserID, nil
+}

work/appchat/appchat.go

@@ -0,0 +1,115 @@
+package appchat
+
+import (
+	"encoding/json"
+	"fmt"
+
+	"github.com/silenceper/wechat/v2/util"
+)
+
+const (
+	// 应用推送消息接口地址
+	sendURL = "https://qyapi.weixin.qq.com/cgi-bin/appchat/send?access_token=%s"
+)
+
+type (
+	// SendRequestCommon 发送应用推送消息请求公共参数
+	SendRequestCommon struct {
+		// 群聊id
+		ChatID string `json:"chatid"`
+		// 消息类型
+		MsgType string `json:"msgtype"`
+		// 表示是否是保密消息，0表示否，1表示是，默认0
+		Safe int `json:"safe"`
+	}
+
+	// SendResponse 发送应用消息响应参数
+	SendResponse struct {
+		util.CommonError
+	}
+
+	// SendTextRequest 发送文本消息的请求
+	SendTextRequest struct {
+		*SendRequestCommon
+		Text TextField `json:"text"`
+	}
+	// TextField 文本消息参数
+	TextField struct {
+		// 消息内容，最长不超过2048个字节
+		Content string `json:"content"`
+	}
+
+	// SendImageRequest 发送图片消息的请求
+	SendImageRequest struct {
+		*SendRequestCommon
+		Image ImageField `json:"image"`
+	}
+	// ImageField 图片消息参数
+	ImageField struct {
+		// 图片媒体文件id，可以调用上传临时素材接口获取
+		MediaID string `json:"media_id"`
+	}
+
+	// SendVoiceRequest 发送语音消息的请求
+	SendVoiceRequest struct {
+		*SendRequestCommon
+		Voice VoiceField `json:"voice"`
+	}
+	// VoiceField 语音消息参数
+	VoiceField struct {
+		// 语音文件id，可以调用上传临时素材接口获取
+		MediaID string `json:"media_id"`
+	}
+)
+
+// Send 发送应用消息
+// @desc 实现企业微信发送应用消息接口：https://developer.work.weixin.qq.com/document/path/90248
+func (r *Client) Send(apiName string, request interface{}) (*SendResponse, error) {
+	// 获取accessToken
+	accessToken, err := r.GetAccessToken()
+	if err != nil {
+		return nil, err
+	}
+	// 请求参数转 JSON 格式
+	jsonData, err := json.Marshal(request)
+	if err != nil {
+		return nil, err
+	}
+	// 发起http请求
+	response, err := util.HTTPPost(fmt.Sprintf(sendURL, accessToken), string(jsonData))
+	if err != nil {
+		return nil, err
+	}
+	// 按照结构体解析返回值
+	result := &SendResponse{}
+	if err = util.DecodeWithError(response, result, apiName); err != nil {
+		return nil, err
+	}
+	// 返回数据
+	return result, nil
+}
+
+// SendText 发送文本消息
+func (r *Client) SendText(request SendTextRequest) (*SendResponse, error) {
+	// 发送文本消息MsgType参数固定为：text
+	request.MsgType = "text"
+	return r.Send("MessageSendText", request)
+}
+
+// SendImage 发送图片消息
+func (r *Client) SendImage(request SendImageRequest) (*SendResponse, error) {
+	// 发送图片消息MsgType参数固定为：image
+	request.MsgType = "image"
+	return r.Send("MessageSendImage", request)
+}
+
+// SendVoice 发送语音消息
+func (r *Client) SendVoice(request SendVoiceRequest) (*SendResponse, error) {
+	// 发送语音消息MsgType参数固定为：voice
+	request.MsgType = "voice"
+	return r.Send("MessageSendVoice", request)
+}
+
+// 以上实现了部分常用消息推送：SendText 发送文本消息、SendImage 发送图片消息、SendVoice 发送语音消息，
+// 如需扩展其他消息类型，建议按照以上格式，扩展对应消息类型的参数即可
+// 也可以直接使用Send方法，按照企业微信消息推送的接口文档传对应消息类型的参数来使用

work/appchat/client.go

@@ -0,0 +1,16 @@
+// Package appchat 应用发送消息到群聊会话,企业微信接口：https://developer.work.weixin.qq.com/document/path/90248
+package appchat
+
+import (
+	"github.com/silenceper/wechat/v2/work/context"
+)
+
+// Client 接口实例
+type Client struct {
+	*context.Context
+}
+
+// NewClient 初始化实例
+func NewClient(ctx *context.Context) *Client {
+	return &Client{ctx}
+}

work/work.go

@@ -3,6 +3,7 @@ package work
 import (
 	"github.com/silenceper/wechat/v2/credential"
 	"github.com/silenceper/wechat/v2/work/addresslist"
+	"github.com/silenceper/wechat/v2/work/appchat"
 	"github.com/silenceper/wechat/v2/work/config"
 	"github.com/silenceper/wechat/v2/work/context"
 	"github.com/silenceper/wechat/v2/work/externalcontact"
@@ -69,7 +70,12 @@ func (wk *Work) GetRobot() *robot.Client {
 	return robot.NewClient(wk.ctx)
 }
 
-// GetMessage get robot
+// GetMessage 获取发送应用消息接口实例
 func (wk *Work) GetMessage() *message.Client {
 	return message.NewClient(wk.ctx)
 }
+
+// GetAppChat 获取应用发送消息到群聊会话接口实例
+func (wk *Work) GetAppChat() *appchat.Client {
+	return appchat.NewClient(wk.ctx)
+}