1
0
mirror of https://github.com/silenceper/wechat.git synced 2026-02-08 06:32:27 +08:00

Compare commits

..

4 Commits

Author SHA1 Message Date
silenceper
39dbfd1c13 fix linux build failed when cgo disable (#453) 2021-08-30 18:00:08 +08:00
silenceper
5ad3475cdb 修正字段问题 (#451)
fix #443
2021-08-30 15:13:35 +08:00
silenceper
bcc41989ed Update go.yml (#452) 2021-08-30 15:13:09 +08:00
silenceper
e189b87e71 merge branch release-2.0 to v2 (#450)
* feat: add/delete subscribe template (#449)

* feat: 添加 SDKApiNotOpen 错误信息 (#448)

* 添加微信客服SDK

* polish:优化签名函数

* polish:优化注释内容

* polish:复用已有的Token以及CommonError,移除无用的输出

* polish:复用已有的消息加解密

* fix:修复错误信息被覆盖的问题

* polish:go fmt 文件

* polish:客服链接支持自定义参数并更新注释文档内容

* feat:支持微信客服回调请求的校验和消息的解析,复用原有的Signature和DecryptMsg方法

* feat:对外暴露SDKApiForbidden等错误

可以通过调用升级服务相关接口然后根据该错误判断微信客服配置来源

* feat:添加无效的open_kfid错误信息

* fix: 添加SDKApiNotOpen 错误信息

目前主要用于判断客户是否关闭了API授权,如果客户关闭了API功能导致服务异常,则可以引导用户执行相应的操作重新开启改功能

Co-authored-by: Afeyer <afeyer@h5base.cn>

Co-authored-by: ZmJ <wzmmmmj@gmail.com>
Co-authored-by: Afeyer <1500527791@qq.com>
Co-authored-by: Afeyer <afeyer@h5base.cn>
2021-08-30 11:14:25 +08:00
100 changed files with 785 additions and 1195 deletions

9
cache/redis.go vendored
View File

@@ -7,7 +7,7 @@ import (
"github.com/gomodule/redigo/redis" "github.com/gomodule/redigo/redis"
) )
// Redis .redis cache //Redis redis cache
type Redis struct { type Redis struct {
conn *redis.Pool conn *redis.Pool
} }
@@ -23,17 +23,16 @@ type RedisOpts struct {
} }
//NewRedis 实例化 //NewRedis 实例化
func NewRedis(opts *RedisOpts, dialOpts ...redis.DialOption) *Redis { func NewRedis(opts *RedisOpts) *Redis {
pool := &redis.Pool{ pool := &redis.Pool{
MaxActive: opts.MaxActive, MaxActive: opts.MaxActive,
MaxIdle: opts.MaxIdle, MaxIdle: opts.MaxIdle,
IdleTimeout: time.Second * time.Duration(opts.IdleTimeout), IdleTimeout: time.Second * time.Duration(opts.IdleTimeout),
Dial: func() (redis.Conn, error) { Dial: func() (redis.Conn, error) {
dialOpts = append(dialOpts, []redis.DialOption{ return redis.Dial("tcp", opts.Host,
redis.DialDatabase(opts.Database), redis.DialDatabase(opts.Database),
redis.DialPassword(opts.Password), redis.DialPassword(opts.Password),
}...) )
return redis.Dial("tcp", opts.Host, dialOpts...)
}, },
TestOnBorrow: func(conn redis.Conn, t time.Time) error { TestOnBorrow: func(conn redis.Conn, t time.Time) error {
if time.Since(t) < time.Minute { if time.Since(t) < time.Minute {

View File

@@ -7,7 +7,6 @@ import (
"gopkg.in/h2non/gock.v1" "gopkg.in/h2non/gock.v1"
) )
// TestGetTicketFromServer .
func TestGetTicketFromServer(t *testing.T) { func TestGetTicketFromServer(t *testing.T) {
defer gock.Off() defer gock.Off()
gock.New(getTicketURL).Reply(200).JSON(&ResTicket{Ticket: "mock-ticket", ExpiresIn: 10}) gock.New(getTicketURL).Reply(200).JSON(&ResTicket{Ticket: "mock-ticket", ExpiresIn: 10})

View File

@@ -10,7 +10,7 @@ import (
"github.com/silenceper/wechat/v2/util" "github.com/silenceper/wechat/v2/util"
) )
// getTicketURL 获取ticket的url //获取ticket的url
const getTicketURL = "https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=%s&type=jsapi" const getTicketURL = "https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=%s&type=jsapi"
//DefaultJsTicket 默认获取js ticket方法 //DefaultJsTicket 默认获取js ticket方法

2
go.mod
View File

@@ -5,7 +5,7 @@ go 1.14
require ( require (
github.com/bradfitz/gomemcache v0.0.0-20190913173617-a41fca850d0b github.com/bradfitz/gomemcache v0.0.0-20190913173617-a41fca850d0b
github.com/fatih/structs v1.1.0 github.com/fatih/structs v1.1.0
github.com/gomodule/redigo v1.8.5 github.com/gomodule/redigo v1.8.4
github.com/kr/text v0.2.0 // indirect github.com/kr/text v0.2.0 // indirect
github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
github.com/sirupsen/logrus v1.8.1 github.com/sirupsen/logrus v1.8.1

4
go.sum
View File

@@ -6,8 +6,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/fatih/structs v1.1.0 h1:Q7juDM0QtcnhCpeyLGQKyg4TOIghuNXrkL32pHAUMxo= github.com/fatih/structs v1.1.0 h1:Q7juDM0QtcnhCpeyLGQKyg4TOIghuNXrkL32pHAUMxo=
github.com/fatih/structs v1.1.0/go.mod h1:9NiDSp5zOcgEDl+j00MP/WkGVPOlPRLejGD8Ga6PJ7M= github.com/fatih/structs v1.1.0/go.mod h1:9NiDSp5zOcgEDl+j00MP/WkGVPOlPRLejGD8Ga6PJ7M=
github.com/gomodule/redigo v1.8.5 h1:nRAxCa+SVsyjSBrtZmG/cqb6VbTmuRzpg/PoTFlpumc= github.com/gomodule/redigo v1.8.4 h1:Z5JUg94HMTR1XpwBaSH4vq3+PNSIykBLxMdglbw10gg=
github.com/gomodule/redigo v1.8.5/go.mod h1:P9dn9mFrCBvWhGE1wpxx6fgq7BAeLBk+UUUzlpkBYO0= github.com/gomodule/redigo v1.8.4/go.mod h1:P9dn9mFrCBvWhGE1wpxx6fgq7BAeLBk+UUUzlpkBYO0=
github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 h1:2VTzZjLZBgl62/EtslCrtky5vbi9dd7HrQPQIx6wqiw= github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 h1:2VTzZjLZBgl62/EtslCrtky5vbi9dd7HrQPQIx6wqiw=
github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542/go.mod h1:Ow0tF8D4Kplbc8s8sSb3V2oUCygFHVp8gC3Dn6U4MNI= github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542/go.mod h1:Ow0tF8D4Kplbc8s8sSb3V2oUCygFHVp8gC3Dn6U4MNI=
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=

View File

@@ -10,8 +10,6 @@ import (
const ( const (
code2SessionURL = "https://api.weixin.qq.com/sns/jscode2session?appid=%s&secret=%s&js_code=%s&grant_type=authorization_code" 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"
) )
//Auth 登录/用户信息 //Auth 登录/用户信息
@@ -33,21 +31,16 @@ type ResCode2Session struct {
UnionID string `json:"unionid"` // 用户在开放平台的唯一标识符在满足UnionID下发条件的情况下会返回 UnionID string `json:"unionid"` // 用户在开放平台的唯一标识符在满足UnionID下发条件的情况下会返回
} }
// RspCheckEncryptedData .
type RspCheckEncryptedData struct {
util.CommonError
Vaild bool `json:"vaild"` // 是否是合法的数据
CreateTime uint `json:"create_time"` // 加密数据生成的时间戳
}
//Code2Session 登录凭证校验。 //Code2Session 登录凭证校验。
func (auth *Auth) Code2Session(jsCode string) (result ResCode2Session, err error) { func (auth *Auth) Code2Session(jsCode string) (result ResCode2Session, err error) {
urlStr := fmt.Sprintf(code2SessionURL, auth.AppID, auth.AppSecret, jsCode)
var response []byte var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(code2SessionURL, auth.AppID, auth.AppSecret, jsCode)); err != nil { response, err = util.HTTPGet(urlStr)
if err != nil {
return return
} }
if err = json.Unmarshal(response, &result); err != nil { err = json.Unmarshal(response, &result)
if err != nil {
return return
} }
if result.ErrCode != 0 { if result.ErrCode != 0 {
@@ -61,21 +54,3 @@ func (auth *Auth) Code2Session(jsCode string) (result ResCode2Session, err error
func (auth *Auth) GetPaidUnionID() { func (auth *Auth) GetPaidUnionID() {
//TODO //TODO
} }
// CheckEncryptedData .检查加密信息是否由微信生成当前只支持手机号加密数据只能检测最近3天生成的加密数据
func (auth *Auth) CheckEncryptedData(encryptedMsgHash string) (result RspCheckEncryptedData, err error) {
var response []byte
var (
at string
)
if at, err = auth.GetAccessToken(); err != nil {
return
}
if response, err = util.HTTPPost(fmt.Sprintf(checkEncryptedDataURL, at), "encrypted_msg_hash="+encryptedMsgHash); err != nil {
return
}
if err = util.DecodeWithError(response, &result, "CheckEncryptedDataAuth"); err != nil {
return
}
return
}

View File

@@ -5,7 +5,7 @@ import (
"github.com/silenceper/wechat/v2/cache" "github.com/silenceper/wechat/v2/cache"
) )
// Config .config for 小程序 // Config config for 小程序
type Config struct { type Config struct {
AppID string `json:"app_id"` // appid AppID string `json:"app_id"` // appid
AppSecret string `json:"app_secret"` // appsecret AppSecret string `json:"app_secret"` // appsecret

View File

@@ -10,10 +10,8 @@ import (
"github.com/silenceper/wechat/v2/miniprogram/encryptor" "github.com/silenceper/wechat/v2/miniprogram/encryptor"
"github.com/silenceper/wechat/v2/miniprogram/message" "github.com/silenceper/wechat/v2/miniprogram/message"
"github.com/silenceper/wechat/v2/miniprogram/qrcode" "github.com/silenceper/wechat/v2/miniprogram/qrcode"
"github.com/silenceper/wechat/v2/miniprogram/shortlink"
"github.com/silenceper/wechat/v2/miniprogram/subscribe" "github.com/silenceper/wechat/v2/miniprogram/subscribe"
"github.com/silenceper/wechat/v2/miniprogram/tcb" "github.com/silenceper/wechat/v2/miniprogram/tcb"
"github.com/silenceper/wechat/v2/miniprogram/urllink"
"github.com/silenceper/wechat/v2/miniprogram/werun" "github.com/silenceper/wechat/v2/miniprogram/werun"
) )
@@ -86,13 +84,3 @@ func (miniProgram *MiniProgram) GetWeRun() *werun.WeRun {
func (miniProgram *MiniProgram) GetContentSecurity() *content.Content { func (miniProgram *MiniProgram) GetContentSecurity() *content.Content {
return content.NewContent(miniProgram.ctx) return content.NewContent(miniProgram.ctx)
} }
// GetURLLink 小程序URL Link接口
func (miniProgram *MiniProgram) GetURLLink() *urllink.URLLink {
return urllink.NewURLLink(miniProgram.ctx)
}
// GetShortLink 小程序短链接口
func (miniProgram *MiniProgram) GetShortLink() *shortlink.ShortLink {
return shortlink.NewShortLink(miniProgram.ctx)
}

View File

@@ -1,86 +0,0 @@
package shortlink
import (
"fmt"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/util"
)
const (
generateShortLinkURL = "https://api.weixin.qq.com/wxa/genwxashortlink?access_token=%s"
)
// ShortLink 短链接
type ShortLink struct {
*context.Context
}
// NewShortLink 实例
func NewShortLink(ctx *context.Context) *ShortLink {
return &ShortLink{ctx}
}
// ShortLinker 请求结构体
type ShortLinker struct {
// pageUrl 通过 Short Link 进入的小程序页面路径,必须是已经发布的小程序存在的页面,可携带 query最大1024个字符
PageURL string `json:"page_url"`
// pageTitle 页面标题不能包含违法信息超过20字符会用... 截断代替
PageTitle string `json:"page_title"`
// isPermanent 生成的 Short Link 类型短期有效false永久有效true
IsPermanent bool `json:"is_permanent,omitempty"`
}
// resShortLinker 返回结构体
type resShortLinker struct {
// 通用错误
*util.CommonError
// 返回的 shortLink
Link string `json:"link"`
}
// Generate 生成 shortLink
func (shortLink *ShortLink) generate(shortLinkParams ShortLinker) (string, error) {
var accessToken string
accessToken, err := shortLink.GetAccessToken()
if err != nil {
return "", err
}
urlStr := fmt.Sprintf(generateShortLinkURL, accessToken)
response, err := util.PostJSON(urlStr, shortLinkParams)
if err != nil {
return "", err
}
// 使用通用方法返回错误
var res resShortLinker
err = util.DecodeWithError(response, &res, "GenerateShortLink")
if err != nil {
return "", err
}
return res.Link, nil
}
// GenerateShortLinkPermanent 生成永久shortLink
func (shortLink *ShortLink) GenerateShortLinkPermanent(PageURL, pageTitle string) (string, error) {
return shortLink.generate(ShortLinker{
PageURL: PageURL,
PageTitle: pageTitle,
IsPermanent: true,
})
}
// GenerateShortLinkTemp 生成临时shortLink
func (shortLink *ShortLink) GenerateShortLinkTemp(PageURL, pageTitle string) (string, error) {
return shortLink.generate(ShortLinker{
PageURL: PageURL,
PageTitle: pageTitle,
IsPermanent: false,
})
}

View File

@@ -1,70 +0,0 @@
package urllink
import (
"fmt"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/util"
)
// URLLink 小程序 URL Link
type URLLink struct {
*context.Context
}
// NewURLLink 实例化
func NewURLLink(ctx *context.Context) *URLLink {
return &URLLink{Context: ctx}
}
const generateURL = "https://api.weixin.qq.com/wxa/generate_urllink"
// TExpireType 失效类型 (指定时间戳/指定间隔)
type TExpireType int
const (
// ExpireTypeTime 指定时间戳后失效
ExpireTypeTime TExpireType = 0
// ExpireTypeInterval 间隔指定天数后失效
ExpireTypeInterval TExpireType = 1
)
// 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"`
IsExpire bool `json:"is_expire"`
ExpireType TExpireType `json:"expire_type"`
ExpireTime int64 `json:"expire_time"`
ExpireInterval int `json:"expire_interval"`
}
// ULResult 返回的结果
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-link/urllink.generate.html#返回值
type ULResult struct {
util.CommonError
URLLink string `json:"url_link"`
}
// Generate 生成url link
func (u *URLLink) Generate(params *ULParams) (string, error) {
accessToken, err := u.GetAccessToken()
if err != nil {
return "", err
}
uri := fmt.Sprintf("%s?access_token=%s", generateURL, accessToken)
response, err := util.PostJSON(uri, params)
if err != nil {
return "", err
}
var resp ULResult
err = util.DecodeWithError(response, &resp, "URLLink.Generate")
if err != nil {
return "", err
}
return resp.URLLink, nil
}

View File

@@ -4,7 +4,7 @@ import (
"github.com/silenceper/wechat/v2/cache" "github.com/silenceper/wechat/v2/cache"
) )
// Config .config for 微信公众号 // Config config for 微信公众号
type Config struct { type Config struct {
AppID string `json:"app_id"` //appid AppID string `json:"app_id"` //appid
AppSecret string `json:"app_secret"` //appsecret AppSecret string `json:"app_secret"` //appsecret

View File

@@ -4,7 +4,7 @@ import (
"github.com/silenceper/wechat/v2/cache" "github.com/silenceper/wechat/v2/cache"
) )
// Config .config for 微信开放平台 //Config config for 微信开放平台
type Config struct { type Config struct {
AppID string `json:"app_id"` //appid AppID string `json:"app_id"` //appid
AppSecret string `json:"app_secret"` //appsecret AppSecret string `json:"app_secret"` //appsecret

View File

@@ -1,6 +1,6 @@
package config package config
// Config .config for pay // Config config for pay
type Config struct { type Config struct {
AppID string `json:"app_id"` AppID string `json:"app_id"`
MchID string `json:"mch_id"` MchID string `json:"mch_id"`

View File

@@ -1,98 +0,0 @@
package order
import (
"encoding/xml"
"errors"
"github.com/silenceper/wechat/v2/util"
)
// https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=9_3
var closeGateway = "https://api.mch.weixin.qq.com/pay/closeorder"
// CloseParams 传入的参数
type CloseParams struct {
OutTradeNo string // 商户订单号
SignType string // 签名类型
}
// closeRequest 接口请求参数
type closeRequest struct {
AppID string `xml:"appid"` // 公众账号ID
MchID string `xml:"mch_id"` // 商户号
NonceStr string `xml:"nonce_str"` // 随机字符串
Sign string `xml:"sign"` // 签名
SignType string `xml:"sign_type,omitempty"` // 签名类型
OutTradeNo string `xml:"out_trade_no"` // 商户订单号
}
// CloseResult 关闭订单返回结果
type CloseResult struct {
ReturnCode *string `xml:"return_code"`
ReturnMsg *string `xml:"return_msg"`
AppID *string `xml:"appid" json:"appid"`
MchID *string `xml:"mch_id"`
NonceStr *string `xml:"nonce_str"`
Sign *string `xml:"sign"`
ResultCode *string `xml:"result_code"`
ResultMsg *string `xml:"result_msg"`
ErrCode *string `xml:"err_code"`
ErrCodeDes *string `xml:"err_code_des"`
}
// CloseOrder 关闭订单
func (o *Order) CloseOrder(p *CloseParams) (closeResult CloseResult, err error) {
nonceStr := util.RandomStr(32)
// 签名类型
if p.SignType == "" {
p.SignType = "MD5"
}
params := make(map[string]string)
params["appid"] = o.AppID
params["mch_id"] = o.MchID
params["nonce_str"] = nonceStr
params["out_trade_no"] = p.OutTradeNo
params["sign_type"] = p.SignType
var (
sign string
rawRet []byte
)
sign, err = util.ParamSign(params, o.Key)
if err != nil {
return
}
request := closeRequest{
AppID: o.AppID,
MchID: o.MchID,
NonceStr: nonceStr,
Sign: sign,
OutTradeNo: p.OutTradeNo,
SignType: p.SignType,
}
rawRet, err = util.PostXML(closeGateway, request)
if err != nil {
return
}
err = xml.Unmarshal(rawRet, &closeResult)
if err != nil {
return
}
if *closeResult.ReturnCode == SUCCESS {
// close success
if *closeResult.ResultCode == SUCCESS {
err = nil
return
}
err = errors.New(*closeResult.ErrCode + *closeResult.ErrCodeDes)
return
}
err = errors.New("[msg : xmlUnmarshalError] [rawReturn : " + string(rawRet) + "] [sign : " + sign + "]")
return
}

View File

@@ -172,9 +172,9 @@ func (o *Order) BridgeConfig(p *Params) (cfg Config, err error) {
// BridgeAppConfig get app bridge config // BridgeAppConfig get app bridge config
func (o *Order) BridgeAppConfig(p *Params) (cfg ConfigForApp, err error) { func (o *Order) BridgeAppConfig(p *Params) (cfg ConfigForApp, err error) {
var ( var (
timestamp = strconv.FormatInt(time.Now().Unix(), 10) timestamp string = strconv.FormatInt(time.Now().Unix(), 10)
noncestr = util.RandomStr(32) noncestr string = util.RandomStr(32)
_package = "Sign=WXPay" _package string = "Sign=WXPay"
) )
order, err := o.PrePayOrder(p) order, err := o.PrePayOrder(p)
if err != nil { if err != nil {
@@ -210,17 +210,6 @@ func (o *Order) BridgeAppConfig(p *Params) (cfg ConfigForApp, err error) {
// PrePayOrder return data for invoke wechat payment // PrePayOrder return data for invoke wechat payment
func (o *Order) PrePayOrder(p *Params) (payOrder PreOrder, err error) { func (o *Order) PrePayOrder(p *Params) (payOrder PreOrder, err error) {
nonceStr := util.RandomStr(32) nonceStr := util.RandomStr(32)
// 通知地址
if len(p.NotifyURL) == 0 {
p.NotifyURL = o.NotifyURL // 默认使用order.NotifyURL
}
// 签名类型
if p.SignType == "" {
p.SignType = util.SignTypeMD5
}
param := map[string]string{ param := map[string]string{
"appid": o.AppID, "appid": o.AppID,
"body": p.Body, "body": p.Body,
@@ -235,7 +224,15 @@ func (o *Order) PrePayOrder(p *Params) (payOrder PreOrder, err error) {
"detail": p.Detail, "detail": p.Detail,
"attach": p.Attach, "attach": p.Attach,
"goods_tag": p.GoodsTag, "goods_tag": p.GoodsTag,
"notify_url": p.NotifyURL, }
// 签名类型
if param["sign_type"] == "" {
param["sign_type"] = util.SignTypeMD5
}
// 通知地址
if p.NotifyURL != "" {
param["notify_url"] = p.NotifyURL
} }
if p.TimeExpire != "" { if p.TimeExpire != "" {

View File

@@ -39,8 +39,6 @@ const (
SDKOpenKFIDNotExist Error = "open_kfid 不存在" SDKOpenKFIDNotExist Error = "open_kfid 不存在"
// SDKWeWorkAlready 错误码95011 // SDKWeWorkAlready 错误码95011
SDKWeWorkAlready Error = "已在企业微信使用微信客服" SDKWeWorkAlready Error = "已在企业微信使用微信客服"
// SDKNotUseInWeCom 错误码95012
SDKNotUseInWeCom Error = "未在企业微信使用微信客服"
// SDKApiNotOpen 错误码95017 // SDKApiNotOpen 错误码95017
SDKApiNotOpen Error = "API 功能没有被开启" SDKApiNotOpen Error = "API 功能没有被开启"
) )
@@ -81,8 +79,6 @@ func NewSDKErr(code int64, msgList ...string) Error {
return SDKOpenKFIDNotExist return SDKOpenKFIDNotExist
case 95011: case 95011:
return SDKWeWorkAlready return SDKWeWorkAlready
case 95012:
return SDKNotUseInWeCom
case 95017: case 95017:
return SDKApiNotOpen return SDKApiNotOpen
default: default:

View File

@@ -82,8 +82,7 @@ type Menu struct {
MsgType string `json:"msgtype"` // 消息类型此时固定为msgmenu MsgType string `json:"msgtype"` // 消息类型此时固定为msgmenu
MsgMenu struct { MsgMenu struct {
HeadContent string `json:"head_content"` // 消息内容不多于1024字节 HeadContent string `json:"head_content"` // 消息内容不多于1024字节
List []interface{} `json:"list"` // 菜单项配置不能多余10个 List []interface{} `json:"list"` // 菜单项配置
TailContent string `json:"tail_content"` // 结束文本, 不多于1024字
} `json:"msgmenu"` } `json:"msgmenu"`
} }

View File

@@ -1,45 +0,0 @@
package kf
import (
"encoding/json"
"fmt"
"github.com/silenceper/wechat/v2/util"
)
const (
// 发送事件响应消息
sendMsgOnEventAddr = "https://qyapi.weixin.qq.com/cgi-bin/kf/send_msg_on_event?access_token=%s"
)
// SendMsgOnEventSchema 发送事件响应消息
type SendMsgOnEventSchema struct {
util.CommonError
MsgID string `json:"msgid"` // 消息ID。如果请求参数指定了msgid则原样返回否则系统自动生成并返回。不多于32字节, 字符串取值范围(正则表达式)[0-9a-zA-Z_-]*
}
// SendMsgOnEvent 发送事件响应消息
//「进入会话事件」响应消息:
// 如果满足通过API下发欢迎语条件条件为1. 企业没有在管理端配置了原生欢迎语2. 用户在过去48小时里未收过欢迎语且未向该用户发过消息则用户进入会话事件会额外返回一个welcome_code开发者以此为凭据调用接口填到该接口code参数即可向客户发送客服欢迎语。
// 为了保证用户体验以及避免滥用开发者仅可在收到相关事件后20秒内调用且只可调用一次。
func (r *Client) SendMsgOnEvent(options interface{}) (info SendMsgOnEventSchema, err error) {
var (
accessToken string
data []byte
)
accessToken, err = r.ctx.GetAccessToken()
if err != nil {
return
}
data, err = util.PostJSON(fmt.Sprintf(sendMsgOnEventAddr, accessToken), options)
if err != nil {
return
}
if err = json.Unmarshal(data, &info); err != nil {
return
}
if info.ErrCode != 0 {
return info, NewSDKErr(info.ErrCode, info.ErrMsg)
}
return info, nil
}

View File

@@ -1,55 +0,0 @@
package sendmsgonevent
// Message 发送事件响应消息
type Message struct {
Code string `json:"code"` // 事件响应消息对应的code。通过事件回调下发仅可使用一次。
MsgID string `json:"msgid"` // 消息ID。如果请求参数指定了msgid则原样返回否则系统自动生成并返回。不多于32字节不多于32字节
}
// Text 文本消息
type Text struct {
Message
MsgType string `json:"msgtype"` // 消息类型此时固定为text
Text struct {
Content string `json:"content"` // 消息内容最长不超过2048个字节
} `json:"text"` // 文本消息
}
// Menu 发送菜单消息
type Menu struct {
Message
MsgType string `json:"msgtype"` // 消息类型此时固定为msgmenu
MsgMenu struct {
HeadContent string `json:"head_content"` // 消息内容不多于1024字节
List []interface{} `json:"list"` // 菜单项配置不能多余10个
TailContent string `json:"tail_content"` // 结束文本, 不多于1024字
} `json:"msgmenu"`
}
// MenuClick 回复菜单
type MenuClick struct {
Type string `json:"type"` // 菜单类型: click 回复菜单
Click struct {
ID string `json:"id"` // 菜单ID, 不少于1字节, 不多于64字节
Content string `json:"content"` // 菜单显示内容, 不少于1字节, 不多于128字节
} `json:"click"`
}
// MenuView 超链接菜单
type MenuView struct {
Type string `json:"type"` // 菜单类型: view 超链接菜单
View struct {
URL string `json:"url"` // 点击后跳转的链接, 不少于1字节, 不多于2048字节
Content string `json:"content"` // 菜单显示内容, 不少于1字节, 不多于1024字节
} `json:"view"`
}
// MenuMiniProgram 小程序菜单
type MenuMiniProgram struct {
Type string `json:"type"` // 菜单类型: miniprogram 小程序菜单
MiniProgram struct {
AppID string `json:"appid"` // 小程序appid, 不少于1字节, 不多于32字节
PagePath string `json:"pagepath"` // 点击后进入的小程序页面, 不少于1字节, 不多于1024字节
Content string `json:"content"` // 菜单显示内容, 不少于1字节, 不多于1024字节
} `json:"miniprogram"`
}

View File

@@ -19,7 +19,7 @@ const (
// ReceptionistOptions 添加接待人员请求参数 // ReceptionistOptions 添加接待人员请求参数
type ReceptionistOptions struct { type ReceptionistOptions struct {
OpenKFID string `json:"open_kfid"` // 客服帐号ID OpenKFID string `json:"open_kfid"` // 客服帐号ID
UserIDList []string `json:"userid_list"` // 接待人员userid列表。第三方应用填密文userid即open_userid 可填充个数1 ~ 100。超过100个需分批调用。 UserIDList []string `json:"userid_list"` // 接待人员userid列表
} }
// ReceptionistSchema 添加接待人员响应内容 // ReceptionistSchema 添加接待人员响应内容

View File

@@ -120,7 +120,6 @@ type EnterSessionEvent struct {
ExternalUserID string `json:"external_userid"` // 客户UserID ExternalUserID string `json:"external_userid"` // 客户UserID
Scene string `json:"scene"` // 进入会话的场景值,获取客服帐号链接开发者自定义的场景值 Scene string `json:"scene"` // 进入会话的场景值,获取客服帐号链接开发者自定义的场景值
SceneParam string `json:"scene_param"` // 进入会话的自定义参数获取客服帐号链接返回的url开发者按规范拼接的scene_param参数 SceneParam string `json:"scene_param"` // 进入会话的自定义参数获取客服帐号链接返回的url开发者按规范拼接的scene_param参数
WelcomeCode string `json:"welcome_code"` // 如果满足发送欢迎语条件条件为1. 企业没有在管理端配置了原生欢迎语2. 用户在过去48小时里未收过欢迎语且未向该用户发过消息会返回该字段。可用该welcome_code调用发送事件响应消息接口给客户发送欢迎语。
} `json:"event"` // 事件消息 } `json:"event"` // 事件消息
} }

View File

@@ -7,7 +7,6 @@ type Message struct {
MsgID string `json:"msgid"` // 消息ID MsgID string `json:"msgid"` // 消息ID
OpenKFID string `json:"open_kfid"` // 客服帐号ID OpenKFID string `json:"open_kfid"` // 客服帐号ID
ExternalUserID string `json:"external_userid"` // 客户UserID ExternalUserID string `json:"external_userid"` // 客户UserID
ReceptionistUserID string `json:"servicer_userid"` // 接待客服userID
SendTime uint64 `json:"send_time"` // 消息发送时间 SendTime uint64 `json:"send_time"` // 消息发送时间
Origin uint32 `json:"origin"` // 消息来源。3-客户回复的消息 4-系统推送的消 息 Origin uint32 `json:"origin"` // 消息来源。3-客户回复的消息 4-系统推送的消 息
MsgType string `json:"msgtype"` // 消息类型 MsgType string `json:"msgtype"` // 消息类型

View File

@@ -1,6 +1,5 @@
企业微信会话存档SDK基于企业微信C版官方SDK封装暂时只支持在`linux`环境下使用当前SDK。 企业微信会话存档SDK基于企业微信C版官方SDK封装暂时只支持在`linux`环境下使用当前SDK。
### 官方文档地址 ### 官方文档地址
https://open.work.weixin.qq.com/api/doc/90000/90135/91774 https://open.work.weixin.qq.com/api/doc/90000/90135/91774
@@ -11,10 +10,6 @@ https://open.work.weixin.qq.com/api/doc/90000/90135/91774
2、从 `github.com/silenceper/wechat/v2/work/msgaudit/lib` 文件夹下复制 `libWeWorkFinanceSdk_C.so` 动态库文件到系统动态链接库默认文件夹下,或者复制到任意文件夹并在当前文件夹下执行 `export LD_LIBRARY_PATH=$(pwd)`命令设置动态链接库检索地址后即可正常使用 2、从 `github.com/silenceper/wechat/v2/work/msgaudit/lib` 文件夹下复制 `libWeWorkFinanceSdk_C.so` 动态库文件到系统动态链接库默认文件夹下,或者复制到任意文件夹并在当前文件夹下执行 `export LD_LIBRARY_PATH=$(pwd)`命令设置动态链接库检索地址后即可正常使用
3、编译要求
- 开启CGO: `CGO_ENABLED=1`
- 增加tags参数`msgaudit` `go build -tags msgaudit`或者`go run -tags msgaudit main.go`
### Example ### Example
```go ```go
@@ -35,7 +30,7 @@ func main() {
//初始化客户端 //初始化客户端
wechatClient := wechat.NewWechat() wechatClient := wechat.NewWechat()
workClient := wechatClient.GetWork(&config.Config{ workClient := wechatClient.NewWork(&config.Config{
CorpID: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", CorpID: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
CorpSecret: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", CorpSecret: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
RasPrivateKey: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", RasPrivateKey: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",

View File

@@ -1,5 +1,4 @@
//go:build linux && cgo && msgaudit // +build linux
// +build linux,cgo,msgaudit
//Package msgaudit only for linux //Package msgaudit only for linux
package msgaudit package msgaudit

View File

@@ -1,5 +1,4 @@
//go:build !linux || !cgo || !msgaudit // +build !linux linux,!cgo
// +build !linux !cgo !msgaudit
//Package msgaudit for unsupport platform //Package msgaudit for unsupport platform
package msgaudit package msgaudit