1
0
mirror of https://github.com/silenceper/wechat.git synced 2026-02-13 17:22:26 +08:00

Compare commits

...

4 Commits

Author SHA1 Message Date
markwang
a5776bc9f2 feat: 企业微信-微信客服,客服账号列表接口支持分页拉取,接待人员增加部门ID 2024-10-09 15:38:34 +08:00
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
8 changed files with 164 additions and 22 deletions

2
cache/redis.go vendored
View File

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

View File

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

View File

@@ -6,6 +6,7 @@ import (
"fmt" "fmt"
"io" "io"
"os" "os"
"path"
"github.com/silenceper/wechat/v2/officialaccount/context" "github.com/silenceper/wechat/v2/officialaccount/context"
"github.com/silenceper/wechat/v2/util" "github.com/silenceper/wechat/v2/util"
@@ -163,7 +164,7 @@ type resAddMaterial struct {
} }
// AddMaterialFromReader 上传永久性素材(处理视频需要单独上传),从 io.Reader 中读取 // AddMaterialFromReader 上传永久性素材(处理视频需要单独上传),从 io.Reader 中读取
func (material *Material) AddMaterialFromReader(mediaType MediaType, filename string, reader io.Reader) (mediaID string, url string, err error) { func (material *Material) AddMaterialFromReader(mediaType MediaType, filePath string, reader io.Reader) (mediaID string, url string, err error) {
if mediaType == MediaTypeVideo { if mediaType == MediaTypeVideo {
err = errors.New("永久视频素材上传使用 AddVideo 方法") err = errors.New("永久视频素材上传使用 AddVideo 方法")
return return
@@ -175,8 +176,10 @@ func (material *Material) AddMaterialFromReader(mediaType MediaType, filename st
} }
uri := fmt.Sprintf("%s?access_token=%s&type=%s", addMaterialURL, accessToken, mediaType) uri := fmt.Sprintf("%s?access_token=%s&type=%s", addMaterialURL, accessToken, mediaType)
// 获取文件名
filename := path.Base(filePath)
var response []byte var response []byte
response, err = util.PostFileFromReader("media", filename, uri, reader) response, err = util.PostFileFromReader("media", filePath, filename, uri, reader)
if err != nil { if err != nil {
return return
} }
@@ -211,7 +214,7 @@ type reqVideo struct {
} }
// AddVideoFromReader 永久视频素材文件上传,从 io.Reader 中读取 // AddVideoFromReader 永久视频素材文件上传,从 io.Reader 中读取
func (material *Material) AddVideoFromReader(filename, title, introduction string, reader io.Reader) (mediaID string, url string, err error) { func (material *Material) AddVideoFromReader(filePath, title, introduction string, reader io.Reader) (mediaID string, url string, err error) {
var accessToken string var accessToken string
accessToken, err = material.GetAccessToken() accessToken, err = material.GetAccessToken()
if err != nil { if err != nil {
@@ -229,17 +232,19 @@ func (material *Material) AddVideoFromReader(filename, title, introduction strin
if err != nil { if err != nil {
return return
} }
fileName := path.Base(filePath)
fields := []util.MultipartFormField{ fields := []util.MultipartFormField{
{ {
IsFile: true, IsFile: true,
Fieldname: "media", Fieldname: "media",
Filename: filename, FilePath: filePath,
Filename: fileName,
FileReader: reader, FileReader: reader,
}, },
{ {
IsFile: false, IsFile: false,
Fieldname: "description", Fieldname: "description",
Filename: fileName,
Value: fieldValue, Value: fieldValue,
}, },
} }
@@ -265,14 +270,14 @@ func (material *Material) AddVideoFromReader(filename, title, introduction strin
} }
// AddVideo 永久视频素材文件上传 // AddVideo 永久视频素材文件上传
func (material *Material) AddVideo(filename, title, introduction string) (mediaID string, url string, err error) { func (material *Material) AddVideo(directory, title, introduction string) (mediaID string, url string, err error) {
f, err := os.Open(filename) f, err := os.Open(directory)
if err != nil { if err != nil {
return "", "", err return "", "", err
} }
defer func() { _ = f.Close() }() defer func() { _ = f.Close() }()
return material.AddVideoFromReader(filename, title, introduction, f) return material.AddVideoFromReader(directory, title, introduction, f)
} }
type reqDeleteMaterial struct { type reqDeleteMaterial struct {

View File

@@ -3,6 +3,7 @@ package material
import ( import (
"encoding/json" "encoding/json"
"fmt" "fmt"
"io"
"github.com/silenceper/wechat/v2/util" "github.com/silenceper/wechat/v2/util"
) )
@@ -62,6 +63,38 @@ func (material *Material) MediaUpload(mediaType MediaType, filename string) (med
return 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 返回临时素材的下载地址供用户自己处理 // GetMediaURL 返回临时素材的下载地址供用户自己处理
// NOTICE: URL 不可公开因为含access_token 需要立即另存文件 // NOTICE: URL 不可公开因为含access_token 需要立即另存文件
func (material *Material) GetMediaURL(mediaID string) (mediaURL string, err error) { func (material *Material) GetMediaURL(mediaID string) (mediaURL string, err error) {

View File

@@ -146,24 +146,38 @@ func PostJSONWithRespContentType(uri string, obj interface{}) ([]byte, string, e
return responseData, contentType, err 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 上传文件 // PostFile 上传文件
func PostFile(fieldName, filename, uri string) ([]byte, error) { func PostFile(fieldName, filePath, uri string) ([]byte, error) {
fields := []MultipartFormField{ fields := []MultipartFormField{
{ {
IsFile: true, IsFile: true,
Fieldname: fieldName, Fieldname: fieldName,
Filename: filename, FilePath: filePath,
}, },
} }
return PostMultipartForm(fields, uri) return PostMultipartForm(fields, uri)
} }
// PostFileFromReader 上传文件,从 io.Reader 中读取 // PostFileFromReader 上传文件,从 io.Reader 中读取
func PostFileFromReader(filedName, fileName, uri string, reader io.Reader) ([]byte, error) { func PostFileFromReader(filedName, filePath, fileName, uri string, reader io.Reader) ([]byte, error) {
fields := []MultipartFormField{ fields := []MultipartFormField{
{ {
IsFile: true, IsFile: true,
Fieldname: filedName, Fieldname: filedName,
FilePath: filePath,
Filename: fileName, Filename: fileName,
FileReader: reader, FileReader: reader,
}, },
@@ -176,6 +190,7 @@ type MultipartFormField struct {
IsFile bool IsFile bool
Fieldname string Fieldname string
Value []byte Value []byte
FilePath string
Filename string Filename string
FileReader io.Reader FileReader io.Reader
} }
@@ -197,7 +212,7 @@ func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte
} }
if field.FileReader == nil { if field.FileReader == nil {
fh, e := os.Open(field.Filename) fh, e := os.Open(field.FilePath)
if e != nil { if e != nil {
err = fmt.Errorf("error opening file , err=%v", e) err = fmt.Errorf("error opening file , err=%v", e)
return return
@@ -213,7 +228,7 @@ func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte
} }
} }
} else { } else {
partWriter, e := bodyWriter.CreateFormField(field.Fieldname) partWriter, e := bodyWriter.CreateFormFile(field.Fieldname, field.Filename)
if e != nil { if e != nil {
err = e err = e
return return

View File

@@ -33,6 +33,7 @@ type AccountAddSchema struct {
} }
// AccountAdd 添加客服账号 // AccountAdd 添加客服账号
// see https://developer.work.weixin.qq.com/document/path/94662
func (r *Client) AccountAdd(options AccountAddOptions) (info AccountAddSchema, err error) { func (r *Client) AccountAdd(options AccountAddOptions) (info AccountAddSchema, err error) {
var ( var (
accessToken string accessToken string
@@ -59,6 +60,7 @@ type AccountDelOptions struct {
} }
// AccountDel 删除客服账号 // AccountDel 删除客服账号
// see https://developer.work.weixin.qq.com/document/path/94663
func (r *Client) AccountDel(options AccountDelOptions) (info util.CommonError, err error) { func (r *Client) AccountDel(options AccountDelOptions) (info util.CommonError, err error) {
var ( var (
accessToken string accessToken string
@@ -86,7 +88,8 @@ type AccountUpdateOptions struct {
MediaID string `json:"media_id"` // 客服头像临时素材。可以调用上传临时素材接口获取, 不多于128个字节 MediaID string `json:"media_id"` // 客服头像临时素材。可以调用上传临时素材接口获取, 不多于128个字节
} }
// AccountUpdate 修客服账号 // AccountUpdate 修客服账号
// see https://developer.work.weixin.qq.com/document/path/94664
func (r *Client) AccountUpdate(options AccountUpdateOptions) (info util.CommonError, err error) { func (r *Client) AccountUpdate(options AccountUpdateOptions) (info util.CommonError, err error) {
var ( var (
accessToken string accessToken string
@@ -109,9 +112,10 @@ func (r *Client) AccountUpdate(options AccountUpdateOptions) (info util.CommonEr
// AccountInfoSchema 客服详情 // AccountInfoSchema 客服详情
type AccountInfoSchema struct { type AccountInfoSchema struct {
OpenKFID string `json:"open_kfid"` // 客服帐号ID OpenKFID string `json:"open_kfid"` // 客服帐号ID
Name string `json:"name"` // 客服帐号名称 Name string `json:"name"` // 客服帐号名称
Avatar string `json:"avatar"` // 客服头像URL Avatar string `json:"avatar"` // 客服头像URL
ManagePrivilege bool `json:"manage_privilege"` // 当前调用接口的应用身份,是否有该客服账号的管理权限(编辑客服账号信息、分配会话和收发消息)
} }
// AccountListSchema 获取客服账号列表响应内容 // AccountListSchema 获取客服账号列表响应内容
@@ -141,6 +145,31 @@ func (r *Client) AccountList() (info AccountListSchema, err error) {
return info, nil return info, nil
} }
// AccountPagingRequest 分页获取客服账号列表请求
type AccountPagingRequest struct {
Offset int `json:"offset"`
Limit int `json:"limit"`
}
// AccountPaging 分页获取客服账号列表
// see https://developer.work.weixin.qq.com/document/path/94661
func (r *Client) AccountPaging(req *AccountPagingRequest) (*AccountListSchema, error) {
var (
accessToken string
err error
)
if accessToken, err = r.ctx.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(accountListAddr, accessToken), req); err != nil {
return nil, err
}
result := &AccountListSchema{}
err = util.DecodeWithError(response, result, "AccountPaging")
return result, err
}
// AddContactWayOptions 获取客服账号链接 // AddContactWayOptions 获取客服账号链接
// 1.若scene非空返回的客服链接开发者可拼接scene_param=SCENE_PARAM参数使用用户进入会话事件会将SCENE_PARAM原样返回。其中SCENE_PARAM需要urlencode且长度不能超过128字节。 // 1.若scene非空返回的客服链接开发者可拼接scene_param=SCENE_PARAM参数使用用户进入会话事件会将SCENE_PARAM原样返回。其中SCENE_PARAM需要urlencode且长度不能超过128字节。
// 如 https://work.weixin.qq.com/kf/kfcbf8f8d07ac7215f?enc_scene=ENCGFSDF567DF&scene_param=a%3D1%26b%3D2 // 如 https://work.weixin.qq.com/kf/kfcbf8f8d07ac7215f?enc_scene=ENCGFSDF567DF&scene_param=a%3D1%26b%3D2
@@ -158,6 +187,7 @@ type AddContactWaySchema struct {
} }
// AddContactWay 获取客服账号链接 // AddContactWay 获取客服账号链接
// see https://developer.work.weixin.qq.com/document/path/94665
func (r *Client) AddContactWay(options AddContactWayOptions) (info AddContactWaySchema, err error) { func (r *Client) AddContactWay(options AddContactWayOptions) (info AddContactWaySchema, err error) {
var ( var (
accessToken string accessToken string

View File

@@ -18,15 +18,17 @@ 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列表。第三方应用填密文userid即open_userid 可填充个数1 ~ 100。超过100个需分批调用。
DepartmentIDList []int `json:"department_id_list"` // 接待人员部门id列表 可填充个数0 ~ 100。超过100个需分批调用。
} }
// ReceptionistSchema 添加接待人员响应内容 // ReceptionistSchema 添加接待人员响应内容
type ReceptionistSchema struct { type ReceptionistSchema struct {
util.CommonError util.CommonError
ResultList []struct { ResultList []struct {
UserID string `json:"userid"` UserID string `json:"userid"`
DepartmentID int `json:"department_id"`
util.CommonError util.CommonError
} `json:"result_list"` } `json:"result_list"`
} }
@@ -79,8 +81,9 @@ func (r *Client) ReceptionistDel(options ReceptionistOptions) (info Receptionist
type ReceptionistListSchema struct { type ReceptionistListSchema struct {
util.CommonError util.CommonError
ReceptionistList []struct { ReceptionistList []struct {
UserID string `json:"userid"` // 接待人员的userid。第三方应用获取到的为密文userid即open_userid UserID string `json:"userid"` // 接待人员的userid。第三方应用获取到的为密文userid即open_userid
Status int `json:"status"` // 接待人员的接待状态。0:接待中,1:停止接待。第三方应用需具有“管理帐号、分配会话和收发消息”权限才可获取 Status int `json:"status"` // 接待人员的接待状态。0:接待中,1:停止接待。第三方应用需具有“管理帐号、分配会话和收发消息”权限才可获取
DepartmentID int `json:"department_id"` // 接待人员部门的id
} `json:"servicer_list"` } `json:"servicer_list"`
} }

View File

@@ -2,6 +2,7 @@ package material
import ( import (
"fmt" "fmt"
"io"
"github.com/silenceper/wechat/v2/util" "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") err = util.DecodeWithError(response, result, "UploadAttachment")
return result, err 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
}