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

Compare commits

..

8 Commits

Author SHA1 Message Date
Lien Li
2e0708845b add-show_splash_ad-for-qrcodeparam (#794) 2024-08-26 10:20:39 +08:00
oah8
c1770130a0 add stream_upload_source (#786)
Co-authored-by: _oah <57302072@qq.com>
2024-08-22 14:21:58 +08:00
一叶知秋
c22a036b7f fix: 增加一个用户信息接口 (#793) 2024-08-22 12:08:44 +08:00
Ji Luo Yang
05ac7148d4 feat: 公众号新增模板接口,支持模板参数传递 (#783)
* feat: 公众号新增模板接口,支持模板参数传递

* fix: 公众号新增模板接口,合并定义参数

* fix: 公众号新增模板接口,统一代码风格

---------

Co-authored-by: yangj23 <yangj23@mingyuanyun.com>
2024-07-16 21:02:59 +08:00
sam
6b3532cc2d feat: Material 增加 AddMaterialFromReader 与 AddVideoFromReader 方法 (#780)
* feat: Material 增加 AddMaterialFromReader 与 AddVideoFromReader 方法

* update: 调整 PostFileFromReader 参数。
2024-07-16 15:43:18 +08:00
ccfish
1138a7db0e feat:追加动态消息接口 (#775)
* 小程序发货信息管理

* fix golang lint

* fix miss

* fix lint

* fix lint

* fix lint

* 修复查询参数last_index=“”时异常

* 小程序消息推送

* fix lint errors

* fix lint

* fix lint

* fix lint,

* 简化写法

* fix 简化写法

* fix name in comments

* Update miniprogram.go

* add events

* change GoodsInfo type

* change statements to 50

* 追加xml支持

* fix cl lint

* 追加动态消息

* 删除多余空格

* 修复命名

* 修复createActivityId返回值类型
2024-04-23 10:03:08 +08:00
houseme
1842f08f4c fix:modify mediaID type (#771)
* fix:modify mediaID type

* upgrade action version

* upgrade

* upgrade
2024-04-16 10:52:47 +08:00
markwang
d28ca4f334 feat: optimized-error-handling&remove unused constant (#772)
* feat: optimized-error-handling&remove unused constant

* feat: optimized-error-handling

---------

Co-authored-by: markwang <www.wang61@qq.com>
2024-04-16 10:51:51 +08:00
14 changed files with 336 additions and 73 deletions

View File

@@ -1,6 +1,6 @@
---
name: 报告Bug
about: 反馈BUG信息
name: 报告 Bug
about: 反馈 BUG 信息
title: "[BUG]"
labels: bug
assignees: ''
@@ -18,4 +18,4 @@ assignees: ''
**使用的版本**
- SDK版本: [比如 v0.0.0]
- SDK 版本[比如 v0.0.0]

View File

@@ -1,6 +1,6 @@
---
name: API需求
about: 待实现的API接口SDK的强大离不开社区的帮助欢迎为项目贡献PR
name: API 需求
about: 待实现的 API 接口SDK 的强大离不开社区的帮助,欢迎为项目贡献 PR
title: "[Feature]"
labels: enhancement
assignees: ''
@@ -8,8 +8,8 @@ assignees: ''
---
<!--
!!!SDK的强大离不开社区的帮助欢迎为本项目贡献PR!!!
!!!SDK 的强大离不开社区的帮助,欢迎为本项目贡献 PR!!!
-->
**你想要实现的模块或API**
**你想要实现的模块或 API**

View File

@@ -1,6 +1,6 @@
---
name: 使用咨询
about: 关于SDK使用相关的咨询在使用前请先阅读官方微信文档
about: 关于 SDK 使用相关的咨询,在使用前请先阅读官方微信文档
title: "[咨询]"
labels: question
assignees: ''
@@ -9,7 +9,7 @@ assignees: ''
<!--
重要:
1、在使用本SDK前请先阅读对应的官方微信API文档https://developers.weixin.qq.com/doc/offiaccount/Getting_Started/Overview.html
2、本SDK部分接口文档 https://silenceper.com/wechat/
1、在使用本 SDK 前请先阅读对应的官方微信 API 文档https://developers.weixin.qq.com/doc/offiaccount/Getting_Started/Overview.html
2、本 SDK 部分接口文档https://silenceper.com/wechat/
-->
**请描述您的问题**

View File

@@ -2,9 +2,9 @@ name: Go
on:
push:
branches: [ master,release-*,v2,feature/** ]
branches: [ master,release-*,v2,feature/**,fix/** ]
pull_request:
branches: [ master,release-*,v2,feature/** ]
branches: [ master,release-*,v2,feature/**,fix/** ]
jobs:
golangci:
@@ -15,13 +15,13 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Setup Golang ${{ matrix.go-version }}
uses: actions/setup-go@v4
uses: actions/setup-go@v5
with:
go-version: ${{ matrix.go-version }}
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: golangci-lint
uses: golangci/golangci-lint-action@v3
uses: golangci/golangci-lint-action@v4
with:
# Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
version: v1.52.2
@@ -42,12 +42,12 @@ jobs:
# strategy set
strategy:
matrix:
go: [ '1.16','1.17','1.18','1.19','1.20','1.21' ]
go: [ '1.16','1.17','1.18','1.19','1.20','1.21','1.22' ]
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Set up Go 1.x
uses: actions/setup-go@v4
uses: actions/setup-go@v5
with:
go-version: ${{ matrix.go }}
id: go

2
cache/redis.go vendored
View File

@@ -16,6 +16,7 @@ type Redis struct {
// RedisOpts redis 连接属性
type RedisOpts struct {
Host string `yml:"host" json:"host"`
Username string `yaml:"username" json:"username"`
Password string `yml:"password" json:"password"`
Database int `yml:"database" json:"database"`
MaxIdle int `yml:"max_idle" json:"max_idle"`
@@ -28,6 +29,7 @@ func NewRedis(ctx context.Context, opts *RedisOpts) *Redis {
conn := redis.NewUniversalClient(&redis.UniversalOptions{
Addrs: []string{opts.Host},
DB: opts.Database,
Username: opts.Username,
Password: opts.Password,
IdleTimeout: time.Second * time.Duration(opts.IdleTimeout),
MinIdleConns: opts.MaxIdle,

View File

@@ -398,7 +398,7 @@ type PushDataSecVodUpload struct {
// SecVodUploadEvent 短剧媒资上传完成事件
type SecVodUploadEvent struct {
MediaID string `json:"media_id" xml:"media_id"` // 媒资 id
MediaID int64 `json:"media_id" xml:"media_id"` // 媒资 id
SourceContext string `json:"source_context" xml:"source_context"` // 透传上传接口中开发者设置的值。
ErrCode int `json:"errcode" xml:"errcode"` // 错误码,上传失败时该值非
ErrMsg string `json:"errmsg" xml:"errmsg"` // 错误提示
@@ -412,7 +412,7 @@ type PushDataSecVodAudit struct {
// SecVodAuditEvent 短剧媒资审核状态事件
type SecVodAuditEvent struct {
DramaID string `json:"drama_id" xml:"drama_id"` // 剧目 id
DramaID int64 `json:"drama_id" xml:"drama_id"` // 剧目 id
SourceContext string `json:"source_context" xml:"source_context"` // 透传上传接口中开发者设置的值
AuditDetail DramaAuditDetail `json:"audit_detail" xml:"audit_detail"` // 剧目审核结果,单独每一集的审核结果可以根据 drama_id 查询剧集详情得到
}

View File

@@ -0,0 +1,102 @@
package message
import (
"fmt"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/util"
)
const (
// createActivityURL 创建activity_id
createActivityURL = "https://api.weixin.qq.com/cgi-bin/message/wxopen/activityid/create?access_token=%s"
// SendUpdatableMsgURL 修改动态消息
setUpdatableMsgURL = "https://api.weixin.qq.com/cgi-bin/message/wxopen/updatablemsg/send?access_token=%s"
)
// UpdatableTargetState 动态消息状态
type UpdatableTargetState int
const (
// TargetStateNotStarted 未开始
TargetStateNotStarted UpdatableTargetState = 0
// TargetStateStarted 已开始
TargetStateStarted UpdatableTargetState = 1
// TargetStateFinished 已结束
TargetStateFinished UpdatableTargetState = 2
)
// UpdatableMessage 动态消息
type UpdatableMessage struct {
*context.Context
}
// NewUpdatableMessage 实例化
func NewUpdatableMessage(ctx *context.Context) *UpdatableMessage {
return &UpdatableMessage{
Context: ctx,
}
}
// CreateActivityID 创建activity_id
func (updatableMessage *UpdatableMessage) CreateActivityID() (res CreateActivityIDResponse, err error) {
accessToken, err := updatableMessage.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(createActivityURL, accessToken)
response, err := util.HTTPGet(uri)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "CreateActivityID")
return
}
// SetUpdatableMsg 修改动态消息
func (updatableMessage *UpdatableMessage) SetUpdatableMsg(activityID string, targetState UpdatableTargetState, template UpdatableMsgTemplate) (err error) {
accessToken, err := updatableMessage.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(setUpdatableMsgURL, accessToken)
data := SendUpdatableMsgReq{
ActivityID: activityID,
TargetState: targetState,
TemplateInfo: template,
}
response, err := util.PostJSON(uri, data)
if err != nil {
return
}
return util.DecodeWithCommonError(response, "SendUpdatableMsg")
}
// CreateActivityIDResponse 创建activity_id 返回
type CreateActivityIDResponse struct {
util.CommonError
ActivityID string `json:"activity_id"`
ExpirationTime int64 `json:"expiration_time"`
}
// UpdatableMsgTemplate 动态消息模板
type UpdatableMsgTemplate struct {
ParameterList []UpdatableMsgParameter `json:"parameter_list"`
}
// UpdatableMsgParameter 动态消息参数
type UpdatableMsgParameter struct {
Name string `json:"name"`
Value string `json:"value"`
}
// SendUpdatableMsgReq 修改动态消息参数
type SendUpdatableMsgReq struct {
ActivityID string `json:"activity_id"`
TemplateInfo UpdatableMsgTemplate `json:"template_info"`
TargetState UpdatableTargetState `json:"target_state"`
}

View File

@@ -161,3 +161,8 @@ func (miniProgram *MiniProgram) GetMiniDrama() *minidrama.MiniDrama {
func (miniProgram *MiniProgram) GetRedPacketCover() *redpacketcover.RedPacketCover {
return redpacketcover.NewRedPacketCover(miniProgram.ctx)
}
// GetUpdatableMessage 小程序动态消息
func (miniProgram *MiniProgram) GetUpdatableMessage() *message.UpdatableMessage {
return message.NewUpdatableMessage(miniProgram.ctx)
}

View File

@@ -54,6 +54,8 @@ type QRCoder struct {
IsHyaline bool `json:"is_hyaline,omitempty"`
// envVersion 要打开的小程序版本。正式版为 "release",体验版为 "trial",开发版为 "develop"
EnvVersion string `json:"env_version,omitempty"`
// ShowSplashAd 控制通过该小程序码进入小程序是否展示封面广告1、默认为true展示封面广告2、传入为false时不展示封面广告
ShowSplashAd bool `json:"show_splash_ad,omitempty"`
}
// fetchCode 请求并返回二维码二进制数据

View File

@@ -4,6 +4,9 @@ import (
"encoding/json"
"errors"
"fmt"
"io"
"os"
"path"
"github.com/silenceper/wechat/v2/officialaccount/context"
"github.com/silenceper/wechat/v2/util"
@@ -160,8 +163,8 @@ type resAddMaterial struct {
URL string `json:"url"`
}
// AddMaterial 上传永久性素材(处理视频需要单独上传)
func (material *Material) AddMaterial(mediaType MediaType, filename string) (mediaID string, url string, err error) {
// AddMaterialFromReader 上传永久性素材(处理视频需要单独上传),从 io.Reader 中读取
func (material *Material) AddMaterialFromReader(mediaType MediaType, filePath string, reader io.Reader) (mediaID string, url string, err error) {
if mediaType == MediaTypeVideo {
err = errors.New("永久视频素材上传使用 AddVideo 方法")
return
@@ -173,8 +176,10 @@ func (material *Material) AddMaterial(mediaType MediaType, filename string) (med
}
uri := fmt.Sprintf("%s?access_token=%s&type=%s", addMaterialURL, accessToken, mediaType)
// 获取文件名
filename := path.Base(filePath)
var response []byte
response, err = util.PostFile("media", filename, uri)
response, err = util.PostFileFromReader("media", filePath, filename, uri, reader)
if err != nil {
return
}
@@ -192,13 +197,24 @@ func (material *Material) AddMaterial(mediaType MediaType, filename string) (med
return
}
// AddMaterial 上传永久性素材(处理视频需要单独上传)
func (material *Material) AddMaterial(mediaType MediaType, filename string) (mediaID string, url string, err error) {
f, err := os.Open(filename)
if err != nil {
return
}
defer func() { _ = f.Close() }()
return material.AddMaterialFromReader(mediaType, filename, f)
}
type reqVideo struct {
Title string `json:"title"`
Introduction string `json:"introduction"`
}
// AddVideo 永久视频素材文件上传
func (material *Material) AddVideo(filename, title, introduction string) (mediaID string, url string, err error) {
// AddVideoFromReader 永久视频素材文件上传,从 io.Reader 中读取
func (material *Material) AddVideoFromReader(filePath, title, introduction string, reader io.Reader) (mediaID string, url string, err error) {
var accessToken string
accessToken, err = material.GetAccessToken()
if err != nil {
@@ -216,16 +232,19 @@ func (material *Material) AddVideo(filename, title, introduction string) (mediaI
if err != nil {
return
}
fileName := path.Base(filePath)
fields := []util.MultipartFormField{
{
IsFile: true,
Fieldname: "media",
Filename: filename,
IsFile: true,
Fieldname: "media",
FilePath: filePath,
Filename: fileName,
FileReader: reader,
},
{
IsFile: false,
Fieldname: "description",
Filename: fileName,
Value: fieldValue,
},
}
@@ -250,6 +269,17 @@ func (material *Material) AddVideo(filename, title, introduction string) (mediaI
return
}
// AddVideo 永久视频素材文件上传
func (material *Material) AddVideo(directory, title, introduction string) (mediaID string, url string, err error) {
f, err := os.Open(directory)
if err != nil {
return "", "", err
}
defer func() { _ = f.Close() }()
return material.AddVideoFromReader(directory, title, introduction, f)
}
type reqDeleteMaterial struct {
MediaID string `json:"media_id"`
}

View File

@@ -3,6 +3,7 @@ package material
import (
"encoding/json"
"fmt"
"io"
"github.com/silenceper/wechat/v2/util"
)
@@ -62,6 +63,38 @@ func (material *Material) MediaUpload(mediaType MediaType, filename string) (med
return
}
// MediaUploadFromReader 临时素材上传
func (material *Material) MediaUploadFromReader(mediaType MediaType, filename string, reader io.Reader) (media Media, err error) {
var accessToken string
accessToken, err = material.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s&type=%s", mediaUploadURL, accessToken, mediaType)
var byteData []byte
byteData, err = io.ReadAll(reader)
if err != nil {
return
}
var response []byte
response, err = util.PostFileByStream("media", filename, uri, byteData)
if err != nil {
return
}
err = json.Unmarshal(response, &media)
if err != nil {
return
}
if media.ErrCode != 0 {
err = fmt.Errorf("MediaUpload error : errcode=%v , errmsg=%v", media.ErrCode, media.ErrMsg)
return
}
return
}
// GetMediaURL 返回临时素材的下载地址供用户自己处理
// NOTICE: URL 不可公开因为含access_token 需要立即另存文件
func (material *Material) GetMediaURL(mediaID string) (mediaURL string, err error) {

View File

@@ -61,15 +61,15 @@ func (tpl *Template) Send(msg *TemplateMessage) (msgID int64, err error) {
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", templateSendURL, accessToken)
var response []byte
response, err = util.PostJSON(uri, msg)
if err != nil {
var (
uri = fmt.Sprintf("%s?access_token=%s", templateSendURL, accessToken)
response []byte
)
if response, err = util.PostJSON(uri, msg); err != nil {
return
}
var result resTemplateSend
err = json.Unmarshal(response, &result)
if err != nil {
if err = json.Unmarshal(response, &result); err != nil {
return
}
if result.ErrCode != 0 {
@@ -103,10 +103,11 @@ func (tpl *Template) List() (templateList []*TemplateItem, err error) {
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", templateListURL, accessToken)
var response []byte
response, err = util.HTTPGet(uri)
if err != nil {
var (
uri = fmt.Sprintf("%s?access_token=%s", templateListURL, accessToken)
response []byte
)
if response, err = util.HTTPGet(uri); err != nil {
return
}
var res resTemplateList
@@ -121,22 +122,23 @@ type resTemplateAdd struct {
}
// Add 添加模板.
func (tpl *Template) Add(shortID string) (templateID string, err error) {
func (tpl *Template) Add(shortID string, keyNameList []string) (templateID string, err error) {
var accessToken string
accessToken, err = tpl.GetAccessToken()
if err != nil {
return
}
var msg = struct {
ShortID string `json:"template_id_short"`
}{ShortID: shortID}
uri := fmt.Sprintf("%s?access_token=%s", templateAddURL, accessToken)
var response []byte
response, err = util.PostJSON(uri, msg)
if err != nil {
var (
msg = struct {
ShortID string `json:"template_id_short"`
KeyNameList []string `json:"keyword_name_list"`
}{ShortID: shortID, KeyNameList: keyNameList}
uri = fmt.Sprintf("%s?access_token=%s", templateAddURL, accessToken)
response []byte
)
if response, err = util.PostJSON(uri, msg); err != nil {
return
}
var result resTemplateAdd
err = util.DecodeWithError(response, &result, "AddTemplate")
return result.TemplateID, err
@@ -149,14 +151,14 @@ func (tpl *Template) Delete(templateID string) (err error) {
if err != nil {
return
}
var msg = struct {
TemplateID string `json:"template_id"`
}{TemplateID: templateID}
uri := fmt.Sprintf("%s?access_token=%s", templateDelURL, accessToken)
var response []byte
response, err = util.PostJSON(uri, msg)
if err != nil {
var (
msg = struct {
TemplateID string `json:"template_id"`
}{TemplateID: templateID}
uri = fmt.Sprintf("%s?access_token=%s", templateDelURL, accessToken)
response []byte
)
if response, err = util.PostJSON(uri, msg); err != nil {
return
}
return util.DecodeWithCommonError(response, "DeleteTemplate")

View File

@@ -146,13 +146,40 @@ func PostJSONWithRespContentType(uri string, obj interface{}) ([]byte, string, e
return responseData, contentType, err
}
// PostFileByStream 上传文件
func PostFileByStream(fieldName, fileName, uri string, byteData []byte) ([]byte, error) {
fields := []MultipartFormField{
{
IsFile: false,
Fieldname: fieldName,
Filename: fileName,
Value: byteData,
},
}
return PostMultipartForm(fields, uri)
}
// PostFile 上传文件
func PostFile(fieldName, filename, uri string) ([]byte, error) {
func PostFile(fieldName, filePath, uri string) ([]byte, error) {
fields := []MultipartFormField{
{
IsFile: true,
Fieldname: fieldName,
Filename: filename,
FilePath: filePath,
},
}
return PostMultipartForm(fields, uri)
}
// PostFileFromReader 上传文件,从 io.Reader 中读取
func PostFileFromReader(filedName, filePath, fileName, uri string, reader io.Reader) ([]byte, error) {
fields := []MultipartFormField{
{
IsFile: true,
Fieldname: filedName,
FilePath: filePath,
Filename: fileName,
FileReader: reader,
},
}
return PostMultipartForm(fields, uri)
@@ -160,10 +187,12 @@ func PostFile(fieldName, filename, uri string) ([]byte, error) {
// MultipartFormField 保存文件或其他字段信息
type MultipartFormField struct {
IsFile bool
Fieldname string
Value []byte
Filename string
IsFile bool
Fieldname string
Value []byte
FilePath string
Filename string
FileReader io.Reader
}
// PostMultipartForm 上传文件或其他多个字段
@@ -182,18 +211,24 @@ func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte
return
}
fh, e := os.Open(field.Filename)
if e != nil {
err = fmt.Errorf("error opening file , err=%v", e)
return
}
defer fh.Close()
if _, err = io.Copy(fileWriter, fh); err != nil {
return
if field.FileReader == nil {
fh, e := os.Open(field.FilePath)
if e != nil {
err = fmt.Errorf("error opening file , err=%v", e)
return
}
_, err = io.Copy(fileWriter, fh)
_ = fh.Close()
if err != nil {
return
}
} else {
if _, err = io.Copy(fileWriter, field.FileReader); err != nil {
return
}
}
} else {
partWriter, e := bodyWriter.CreateFormField(field.Fieldname)
partWriter, e := bodyWriter.CreateFormFile(field.Fieldname, field.Filename)
if e != nil {
err = e
return
@@ -215,7 +250,7 @@ func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return nil, err
return nil, fmt.Errorf("http code error : uri=%v , statusCode=%v", uri, resp.StatusCode)
}
respBody, err = io.ReadAll(resp.Body)
return

View File

@@ -2,6 +2,7 @@ package material
import (
"fmt"
"io"
"github.com/silenceper/wechat/v2/util"
)
@@ -96,3 +97,54 @@ func (r *Client) UploadAttachment(filename string, mediaType string, attachmentT
err = util.DecodeWithError(response, result, "UploadAttachment")
return result, err
}
// UploadTempFileFromReader 上传临时素材
// @see https://developer.work.weixin.qq.com/document/path/90253
// @mediaType 媒体文件类型分别有图片image、语音voice、视频video普通文件file
func (r *Client) UploadTempFileFromReader(filename, mediaType string, reader io.Reader) (*UploadTempFileResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var byteData []byte
byteData, err = io.ReadAll(reader)
if err != nil {
return nil, err
}
var response []byte
if response, err = util.PostFileByStream("media", filename, fmt.Sprintf(uploadTempFile, accessToken, mediaType), byteData); err != nil {
return nil, err
}
result := &UploadTempFileResponse{}
err = util.DecodeWithError(response, result, "UploadTempFile")
return result, err
}
// UploadAttachmentFromReader 上传附件资源
// @see https://developer.work.weixin.qq.com/document/path/95098
// @mediaType 媒体文件类型分别有图片image、视频video、普通文件file
// @attachment_type 附件类型不同的附件类型用于不同的场景。1朋友圈2:商品图册
func (r *Client) UploadAttachmentFromReader(filename, mediaType string, reader io.Reader, attachmentType int) (*UploadAttachmentResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var byteData []byte
byteData, err = io.ReadAll(reader)
if err != nil {
return nil, err
}
var response []byte
if response, err = util.PostFileByStream("media", filename, fmt.Sprintf(uploadAttachment, accessToken, mediaType, attachmentType), byteData); err != nil {
return nil, err
}
result := &UploadAttachmentResponse{}
err = util.DecodeWithError(response, result, "UploadAttachment")
return result, err
}