mirror of
https://github.com/silenceper/wechat.git
synced 2026-02-04 12:52:27 +08:00
Compare commits
115 Commits
v2.1.3-rc.
...
v2.1.7-rc.
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1138a7db0e | ||
|
|
1842f08f4c | ||
|
|
d28ca4f334 | ||
|
|
74795e86ee | ||
|
|
179704187b | ||
|
|
ceb006bf58 | ||
|
|
9f14122a87 | ||
|
|
7fcd7a34dd | ||
|
|
5b29289dbb | ||
|
|
74e3e9c04e | ||
|
|
97c9f7d908 | ||
|
|
97e1af5904 | ||
|
|
a5e674bf10 | ||
|
|
0ffe34187a | ||
|
|
04b62f6c3c | ||
|
|
4adc59b1b0 | ||
|
|
dad7932574 | ||
|
|
56a3734546 | ||
|
|
d4fd145bb5 | ||
|
|
038037b89d | ||
|
|
479ff1f242 | ||
|
|
3f1c5e7637 | ||
|
|
da5067bcb2 | ||
|
|
8f10936479 | ||
|
|
9bfebc8a27 | ||
|
|
4f6cbc3d59 | ||
|
|
49c4cfaf54 | ||
|
|
ead8a6fadb | ||
|
|
ae40639b56 | ||
|
|
8bb145155e | ||
|
|
85bf989242 | ||
|
|
b4f2d1793c | ||
|
|
4a2c44c7c8 | ||
|
|
9e810be88a | ||
|
|
06719f77b7 | ||
|
|
b70ecd93a7 | ||
|
|
dea33e0e48 | ||
|
|
e02af1dc0f | ||
|
|
c81d0b1215 | ||
|
|
da80430065 | ||
|
|
cc201fcece | ||
|
|
26b0aacb4c | ||
|
|
7df3fe1a09 | ||
|
|
5a23c5c780 | ||
|
|
c84eb7b550 | ||
|
|
45ad2ab8ca | ||
|
|
5d0e32e2ea | ||
|
|
822cfaa6c8 | ||
|
|
acaab64fe7 | ||
|
|
b12825f83b | ||
|
|
86cbd8c0b2 | ||
|
|
46c3722308 | ||
|
|
7d11af713b | ||
|
|
fafb1784da | ||
|
|
31f8e24994 | ||
|
|
ae1b056515 | ||
|
|
8bae546b77 | ||
|
|
9df943df69 | ||
|
|
0a37184c2f | ||
|
|
b4f243ab13 | ||
|
|
d92cd35533 | ||
|
|
58621cd79d | ||
|
|
8821a3856d | ||
|
|
4094adc5b4 | ||
|
|
cb0928a03c | ||
|
|
d6371c7289 | ||
|
|
07b7dc40fc | ||
|
|
01784c2a4a | ||
|
|
8bc1474777 | ||
|
|
ca0b74e082 | ||
|
|
fbda048f62 | ||
|
|
494082ff4f | ||
|
|
9c0189340b | ||
|
|
d39615f2fa | ||
|
|
429219b53f | ||
|
|
6e80b71cb2 | ||
|
|
ab354c4d03 | ||
|
|
d1d034eb95 | ||
|
|
1a9dbc493b | ||
|
|
04559ed4bb | ||
|
|
abd583df01 | ||
|
|
3cb741ae1a | ||
|
|
da3859261b | ||
|
|
86ceb6af2f | ||
|
|
243f8198ae | ||
|
|
2bc0536c02 | ||
|
|
bbbada1b44 | ||
|
|
5380d5bee7 | ||
|
|
a03f3f9f32 | ||
|
|
9d8b803b33 | ||
|
|
5e0c31bfa9 | ||
|
|
9ad8981ff0 | ||
|
|
57fd96454c | ||
|
|
d09d706946 | ||
|
|
88fc6465bb | ||
|
|
b3cb101899 | ||
|
|
86e036a55b | ||
|
|
a8f7a24ff6 | ||
|
|
df62164811 | ||
|
|
0160f99045 | ||
|
|
430c60a36e | ||
|
|
cac3072199 | ||
|
|
37f9e981d6 | ||
|
|
a07c50fda7 | ||
|
|
eb3dbf1646 | ||
|
|
27e18b6958 | ||
|
|
252fc4838b | ||
|
|
fdaffb6aa2 | ||
|
|
108a65ecf3 | ||
|
|
cc9be30ed1 | ||
|
|
adf142dac2 | ||
|
|
ded5a10f9f | ||
|
|
e1307648fd | ||
|
|
c6325ace85 | ||
|
|
f2e7979a9f |
6
.github/ISSUE_TEMPLATE/bug.md
vendored
6
.github/ISSUE_TEMPLATE/bug.md
vendored
@@ -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]
|
||||
|
||||
8
.github/ISSUE_TEMPLATE/feature.md
vendored
8
.github/ISSUE_TEMPLATE/feature.md
vendored
@@ -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**
|
||||
|
||||
|
||||
|
||||
6
.github/ISSUE_TEMPLATE/question.md
vendored
6
.github/ISSUE_TEMPLATE/question.md
vendored
@@ -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/
|
||||
-->
|
||||
**请描述您的问题**
|
||||
|
||||
28
.github/workflows/go.yml
vendored
28
.github/workflows/go.yml
vendored
@@ -2,25 +2,29 @@ name: Go
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ master,release-*,v2 ]
|
||||
branches: [ master,release-*,v2,feature/**,fix/** ]
|
||||
pull_request:
|
||||
branches: [ master,release-*,v2 ]
|
||||
branches: [ master,release-*,v2,feature/**,fix/** ]
|
||||
|
||||
jobs:
|
||||
golangci:
|
||||
strategy:
|
||||
matrix:
|
||||
go-version: [1.15.x,1.16.x]
|
||||
go-version: [ '1.16','1.17','1.18','1.19','1.20','1.21.4' ]
|
||||
name: golangci-lint
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/setup-go@v2
|
||||
- uses: actions/checkout@v2
|
||||
- name: Setup Golang ${{ matrix.go-version }}
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: ${{ matrix.go-version }}
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
- name: golangci-lint
|
||||
uses: golangci/golangci-lint-action@v3.1.0
|
||||
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.31
|
||||
version: v1.52.2
|
||||
build:
|
||||
name: Test
|
||||
runs-on: ubuntu-latest
|
||||
@@ -28,7 +32,7 @@ jobs:
|
||||
redis:
|
||||
image: redis
|
||||
ports:
|
||||
- 6379:6379
|
||||
- 6379:6379
|
||||
options: --entrypoint redis-server
|
||||
memcached:
|
||||
image: memcached
|
||||
@@ -38,14 +42,14 @@ jobs:
|
||||
# strategy set
|
||||
strategy:
|
||||
matrix:
|
||||
go: ["1.14","1.15", "1.16", "1.17", "1.18"]
|
||||
go: [ '1.16','1.17','1.18','1.19','1.20','1.21','1.22' ]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- uses: actions/checkout@v4
|
||||
- name: Set up Go 1.x
|
||||
uses: actions/setup-go@v2
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: ${{ matrix.go }}
|
||||
id: go
|
||||
- name: Test
|
||||
run: go test -v -race ./...
|
||||
run: go test -v -race ./...
|
||||
29
.github/workflows/release.yml
vendored
29
.github/workflows/release.yml
vendored
@@ -1,29 +0,0 @@
|
||||
name: goreleaser
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*'
|
||||
|
||||
jobs:
|
||||
goreleaser:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
-
|
||||
name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
-
|
||||
name: Set up Go
|
||||
uses: actions/setup-go@v2
|
||||
with:
|
||||
go-version: 1.15
|
||||
-
|
||||
name: Run GoReleaser
|
||||
uses: goreleaser/goreleaser-action@v2
|
||||
with:
|
||||
version: latest
|
||||
args: release --rm-dist
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -36,8 +36,13 @@ linters:
|
||||
- whitespace
|
||||
|
||||
issues:
|
||||
# Excluding configuration per-path, per-linter, per-text and per-source
|
||||
include:
|
||||
- EXC0002 # disable excluding of issues about comments from golint
|
||||
exclude-rules:
|
||||
- linters:
|
||||
- stylecheck
|
||||
text: "ST1000:"
|
||||
# Excluding configuration per-path, per-linter, per-text and per-source
|
||||
- path: _test\.go
|
||||
linters:
|
||||
- gomnd
|
||||
@@ -50,12 +55,12 @@ issues:
|
||||
linters-settings:
|
||||
funlen:
|
||||
lines: 66
|
||||
statements: 40
|
||||
statements: 50
|
||||
|
||||
issues:
|
||||
include:
|
||||
- EXC0002 # disable excluding of issues about comments from golint
|
||||
exclude-rules:
|
||||
- linters:
|
||||
- stylecheck
|
||||
text: "ST1000:"
|
||||
#issues:
|
||||
# include:
|
||||
# - EXC0002 # disable excluding of issues about comments from golint
|
||||
# exclude-rules:
|
||||
# - linters:
|
||||
# - stylecheck
|
||||
# text: "ST1000:"
|
||||
|
||||
@@ -1,29 +0,0 @@
|
||||
# This is an example goreleaser.yaml file with some sane defaults.
|
||||
# Make sure to check the documentation at http://goreleaser.com
|
||||
before:
|
||||
hooks:
|
||||
# You may remove this if you don't use go modules.
|
||||
- go mod download
|
||||
# you may remove this if you don't need go generate
|
||||
- go generate ./...
|
||||
builds:
|
||||
- skip: true
|
||||
|
||||
archives:
|
||||
- replacements:
|
||||
darwin: Darwin
|
||||
linux: Linux
|
||||
windows: Windows
|
||||
386: i386
|
||||
amd64: x86_64
|
||||
|
||||
checksum:
|
||||
name_template: 'checksums.txt'
|
||||
snapshot:
|
||||
name_template: "{{ .Tag }}-next"
|
||||
changelog:
|
||||
sort: asc
|
||||
filters:
|
||||
exclude:
|
||||
- '^docs:'
|
||||
- '^test:'
|
||||
12
README.md
12
README.md
@@ -25,35 +25,35 @@ import "github.com/silenceper/wechat/v2"
|
||||
以下是一个微信公众号处理消息接收以及回复的例子:
|
||||
|
||||
```go
|
||||
//使用memcache保存access_token,也可选择redis或自定义cache
|
||||
// 使用memcache保存access_token,也可选择redis或自定义cache
|
||||
wc := wechat.NewWechat()
|
||||
memory := cache.NewMemory()
|
||||
cfg := &offConfig.Config{
|
||||
AppID: "xxx",
|
||||
AppSecret: "xxx",
|
||||
Token: "xxx",
|
||||
//EncodingAESKey: "xxxx",
|
||||
// EncodingAESKey: "xxxx",
|
||||
Cache: memory,
|
||||
}
|
||||
officialAccount := wc.GetOfficialAccount(cfg)
|
||||
|
||||
// 传入request和responseWriter
|
||||
server := officialAccount.GetServer(req, rw)
|
||||
//设置接收消息的处理方法
|
||||
// 设置接收消息的处理方法
|
||||
server.SetMessageHandler(func(msg *message.MixMessage) *message.Reply {
|
||||
|
||||
//回复消息:演示回复用户发送的消息
|
||||
// 回复消息:演示回复用户发送的消息
|
||||
text := message.NewText(msg.Content)
|
||||
return &message.Reply{MsgType: message.MsgTypeText, MsgData: text}
|
||||
})
|
||||
|
||||
//处理消息接收以及回复
|
||||
// 处理消息接收以及回复
|
||||
err := server.Serve()
|
||||
if err != nil {
|
||||
fmt.Println(err)
|
||||
return
|
||||
}
|
||||
//发送回复的消息
|
||||
// 发送回复的消息
|
||||
server.Send()
|
||||
|
||||
```
|
||||
|
||||
46
cache/cache.go
vendored
46
cache/cache.go
vendored
@@ -1,6 +1,9 @@
|
||||
package cache
|
||||
|
||||
import "time"
|
||||
import (
|
||||
"context"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Cache interface
|
||||
type Cache interface {
|
||||
@@ -9,3 +12,44 @@ type Cache interface {
|
||||
IsExist(key string) bool
|
||||
Delete(key string) error
|
||||
}
|
||||
|
||||
// ContextCache interface
|
||||
type ContextCache interface {
|
||||
Cache
|
||||
GetContext(ctx context.Context, key string) interface{}
|
||||
SetContext(ctx context.Context, key string, val interface{}, timeout time.Duration) error
|
||||
IsExistContext(ctx context.Context, key string) bool
|
||||
DeleteContext(ctx context.Context, key string) error
|
||||
}
|
||||
|
||||
// GetContext get value from cache
|
||||
func GetContext(ctx context.Context, cache Cache, key string) interface{} {
|
||||
if cache, ok := cache.(ContextCache); ok {
|
||||
return cache.GetContext(ctx, key)
|
||||
}
|
||||
return cache.Get(key)
|
||||
}
|
||||
|
||||
// SetContext set value to cache
|
||||
func SetContext(ctx context.Context, cache Cache, key string, val interface{}, timeout time.Duration) error {
|
||||
if cache, ok := cache.(ContextCache); ok {
|
||||
return cache.SetContext(ctx, key, val, timeout)
|
||||
}
|
||||
return cache.Set(key, val, timeout)
|
||||
}
|
||||
|
||||
// IsExistContext check value exists in cache.
|
||||
func IsExistContext(ctx context.Context, cache Cache, key string) bool {
|
||||
if cache, ok := cache.(ContextCache); ok {
|
||||
return cache.IsExistContext(ctx, key)
|
||||
}
|
||||
return cache.IsExist(key)
|
||||
}
|
||||
|
||||
// DeleteContext delete value in cache.
|
||||
func DeleteContext(ctx context.Context, cache Cache, key string) error {
|
||||
if cache, ok := cache.(ContextCache); ok {
|
||||
return cache.DeleteContext(ctx, key)
|
||||
}
|
||||
return cache.Delete(key)
|
||||
}
|
||||
|
||||
28
cache/redis.go
vendored
28
cache/redis.go
vendored
@@ -47,7 +47,12 @@ func (r *Redis) SetRedisCtx(ctx context.Context) {
|
||||
|
||||
// Get 获取一个值
|
||||
func (r *Redis) Get(key string) interface{} {
|
||||
result, err := r.conn.Do(r.ctx, "GET", key).Result()
|
||||
return r.GetContext(r.ctx, key)
|
||||
}
|
||||
|
||||
// GetContext 获取一个值
|
||||
func (r *Redis) GetContext(ctx context.Context, key string) interface{} {
|
||||
result, err := r.conn.Do(ctx, "GET", key).Result()
|
||||
if err != nil {
|
||||
return nil
|
||||
}
|
||||
@@ -56,17 +61,32 @@ func (r *Redis) Get(key string) interface{} {
|
||||
|
||||
// Set 设置一个值
|
||||
func (r *Redis) Set(key string, val interface{}, timeout time.Duration) error {
|
||||
return r.conn.SetEX(r.ctx, key, val, timeout).Err()
|
||||
return r.SetContext(r.ctx, key, val, timeout)
|
||||
}
|
||||
|
||||
// SetContext 设置一个值
|
||||
func (r *Redis) SetContext(ctx context.Context, key string, val interface{}, timeout time.Duration) error {
|
||||
return r.conn.SetEX(ctx, key, val, timeout).Err()
|
||||
}
|
||||
|
||||
// IsExist 判断key是否存在
|
||||
func (r *Redis) IsExist(key string) bool {
|
||||
result, _ := r.conn.Exists(r.ctx, key).Result()
|
||||
return r.IsExistContext(r.ctx, key)
|
||||
}
|
||||
|
||||
// IsExistContext 判断key是否存在
|
||||
func (r *Redis) IsExistContext(ctx context.Context, key string) bool {
|
||||
result, _ := r.conn.Exists(ctx, key).Result()
|
||||
|
||||
return result > 0
|
||||
}
|
||||
|
||||
// Delete 删除
|
||||
func (r *Redis) Delete(key string) error {
|
||||
return r.conn.Del(r.ctx, key).Err()
|
||||
return r.DeleteContext(r.ctx, key)
|
||||
}
|
||||
|
||||
// DeleteContext 删除
|
||||
func (r *Redis) DeleteContext(ctx context.Context, key string) error {
|
||||
return r.conn.Del(ctx, key).Err()
|
||||
}
|
||||
|
||||
10
cache/redis_test.go
vendored
10
cache/redis_test.go
vendored
@@ -4,17 +4,23 @@ import (
|
||||
"context"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/alicebob/miniredis/v2"
|
||||
)
|
||||
|
||||
func TestRedis(t *testing.T) {
|
||||
server, err := miniredis.Run()
|
||||
if err != nil {
|
||||
t.Error("miniredis.Run Error", err)
|
||||
}
|
||||
t.Cleanup(server.Close)
|
||||
var (
|
||||
timeoutDuration = time.Second
|
||||
ctx = context.Background()
|
||||
opts = &RedisOpts{
|
||||
Host: "127.0.0.1:6379",
|
||||
Host: server.Addr(),
|
||||
}
|
||||
redis = NewRedis(ctx, opts)
|
||||
err error
|
||||
val = "silenceper"
|
||||
key = "username"
|
||||
)
|
||||
|
||||
@@ -1,6 +1,14 @@
|
||||
package credential
|
||||
|
||||
import "context"
|
||||
|
||||
// AccessTokenHandle AccessToken 接口
|
||||
type AccessTokenHandle interface {
|
||||
GetAccessToken() (accessToken string, err error)
|
||||
}
|
||||
|
||||
// AccessTokenContextHandle AccessToken 接口
|
||||
type AccessTokenContextHandle interface {
|
||||
AccessTokenHandle
|
||||
GetAccessTokenContext(ctx context.Context) (accessToken string, err error)
|
||||
}
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package credential
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"sync"
|
||||
@@ -11,9 +12,11 @@ import (
|
||||
)
|
||||
|
||||
const (
|
||||
// AccessTokenURL 获取access_token的接口
|
||||
// accessTokenURL 获取access_token的接口
|
||||
accessTokenURL = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=%s&secret=%s"
|
||||
// AccessTokenURL 企业微信获取access_token的接口
|
||||
// stableAccessTokenURL 获取稳定版access_token的接口
|
||||
stableAccessTokenURL = "https://api.weixin.qq.com/cgi-bin/stable_token"
|
||||
// workAccessTokenURL 企业微信获取access_token的接口
|
||||
workAccessTokenURL = "https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=%s&corpsecret=%s"
|
||||
// CacheKeyOfficialAccountPrefix 微信公众号cache key前缀
|
||||
CacheKeyOfficialAccountPrefix = "gowechat_officialaccount_"
|
||||
@@ -33,7 +36,7 @@ type DefaultAccessToken struct {
|
||||
}
|
||||
|
||||
// NewDefaultAccessToken new DefaultAccessToken
|
||||
func NewDefaultAccessToken(appID, appSecret, cacheKeyPrefix string, cache cache.Cache) AccessTokenHandle {
|
||||
func NewDefaultAccessToken(appID, appSecret, cacheKeyPrefix string, cache cache.Cache) AccessTokenContextHandle {
|
||||
if cache == nil {
|
||||
panic("cache is ineed")
|
||||
}
|
||||
@@ -56,10 +59,18 @@ type ResAccessToken struct {
|
||||
|
||||
// GetAccessToken 获取access_token,先从cache中获取,没有则从服务端获取
|
||||
func (ak *DefaultAccessToken) GetAccessToken() (accessToken string, err error) {
|
||||
return ak.GetAccessTokenContext(context.Background())
|
||||
}
|
||||
|
||||
// GetAccessTokenContext 获取access_token,先从cache中获取,没有则从服务端获取
|
||||
func (ak *DefaultAccessToken) GetAccessTokenContext(ctx context.Context) (accessToken string, err error) {
|
||||
// 先从cache中取
|
||||
accessTokenCacheKey := fmt.Sprintf("%s_access_token_%s", ak.cacheKeyPrefix, ak.appID)
|
||||
|
||||
if val := ak.cache.Get(accessTokenCacheKey); val != nil {
|
||||
return val.(string), nil
|
||||
if accessToken = val.(string); accessToken != "" {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// 加上lock,是为了防止在并发获取token时,cache刚好失效,导致从微信服务器上获取到不同token
|
||||
@@ -68,25 +79,97 @@ func (ak *DefaultAccessToken) GetAccessToken() (accessToken string, err error) {
|
||||
|
||||
// 双检,防止重复从微信服务器获取
|
||||
if val := ak.cache.Get(accessTokenCacheKey); val != nil {
|
||||
return val.(string), nil
|
||||
if accessToken = val.(string); accessToken != "" {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// cache失效,从微信服务器获取
|
||||
var resAccessToken ResAccessToken
|
||||
resAccessToken, err = GetTokenFromServer(fmt.Sprintf(accessTokenURL, ak.appID, ak.appSecret))
|
||||
if err != nil {
|
||||
if resAccessToken, err = GetTokenFromServerContext(ctx, fmt.Sprintf(accessTokenURL, ak.appID, ak.appSecret)); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
expires := resAccessToken.ExpiresIn - 1500
|
||||
err = ak.cache.Set(accessTokenCacheKey, resAccessToken.AccessToken, time.Duration(expires)*time.Second)
|
||||
|
||||
accessToken = resAccessToken.AccessToken
|
||||
return
|
||||
}
|
||||
|
||||
// StableAccessToken 获取稳定版接口调用凭据(与getAccessToken获取的调用凭证完全隔离,互不影响)
|
||||
// 不强制更新access_token,可用于不同环境不同服务而不需要分布式锁以及公用缓存,避免access_token争抢
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-access-token/getStableAccessToken.html
|
||||
type StableAccessToken struct {
|
||||
appID string
|
||||
appSecret string
|
||||
cacheKeyPrefix string
|
||||
cache cache.Cache
|
||||
}
|
||||
|
||||
// NewStableAccessToken new StableAccessToken
|
||||
func NewStableAccessToken(appID, appSecret, cacheKeyPrefix string, cache cache.Cache) AccessTokenContextHandle {
|
||||
if cache == nil {
|
||||
panic("cache is need")
|
||||
}
|
||||
return &StableAccessToken{
|
||||
appID: appID,
|
||||
appSecret: appSecret,
|
||||
cache: cache,
|
||||
cacheKeyPrefix: cacheKeyPrefix,
|
||||
}
|
||||
}
|
||||
|
||||
// GetAccessToken 获取access_token,先从cache中获取,没有则从服务端获取
|
||||
func (ak *StableAccessToken) GetAccessToken() (accessToken string, err error) {
|
||||
return ak.GetAccessTokenContext(context.Background())
|
||||
}
|
||||
|
||||
// GetAccessTokenContext 获取access_token,先从cache中获取,没有则从服务端获取
|
||||
func (ak *StableAccessToken) GetAccessTokenContext(ctx context.Context) (accessToken string, err error) {
|
||||
// 先从cache中取
|
||||
accessTokenCacheKey := fmt.Sprintf("%s_stable_access_token_%s", ak.cacheKeyPrefix, ak.appID)
|
||||
if val := ak.cache.Get(accessTokenCacheKey); val != nil {
|
||||
return val.(string), nil
|
||||
}
|
||||
|
||||
// cache失效,从微信服务器获取
|
||||
var resAccessToken ResAccessToken
|
||||
resAccessToken, err = ak.GetAccessTokenDirectly(ctx, false)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
expires := resAccessToken.ExpiresIn - 300
|
||||
err = ak.cache.Set(accessTokenCacheKey, resAccessToken.AccessToken, time.Duration(expires)*time.Second)
|
||||
|
||||
accessToken = resAccessToken.AccessToken
|
||||
return
|
||||
}
|
||||
|
||||
// GetAccessTokenDirectly 从微信获取access_token
|
||||
func (ak *StableAccessToken) GetAccessTokenDirectly(ctx context.Context, forceRefresh bool) (resAccessToken ResAccessToken, err error) {
|
||||
b, err := util.PostJSONContext(ctx, stableAccessTokenURL, map[string]interface{}{
|
||||
"grant_type": "client_credential",
|
||||
"appid": ak.appID,
|
||||
"secret": ak.appSecret,
|
||||
"force_refresh": forceRefresh,
|
||||
})
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
if err = json.Unmarshal(b, &resAccessToken); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
if resAccessToken.ErrCode != 0 {
|
||||
err = fmt.Errorf("get stable access_token error : errcode=%v , errormsg=%v", resAccessToken.ErrCode, resAccessToken.ErrMsg)
|
||||
return
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// WorkAccessToken 企业微信AccessToken 获取
|
||||
type WorkAccessToken struct {
|
||||
CorpID string
|
||||
@@ -97,7 +180,7 @@ type WorkAccessToken struct {
|
||||
}
|
||||
|
||||
// NewWorkAccessToken new WorkAccessToken
|
||||
func NewWorkAccessToken(corpID, corpSecret, cacheKeyPrefix string, cache cache.Cache) AccessTokenHandle {
|
||||
func NewWorkAccessToken(corpID, corpSecret, cacheKeyPrefix string, cache cache.Cache) AccessTokenContextHandle {
|
||||
if cache == nil {
|
||||
panic("cache the not exist")
|
||||
}
|
||||
@@ -112,6 +195,11 @@ func NewWorkAccessToken(corpID, corpSecret, cacheKeyPrefix string, cache cache.C
|
||||
|
||||
// GetAccessToken 企业微信获取access_token,先从cache中获取,没有则从服务端获取
|
||||
func (ak *WorkAccessToken) GetAccessToken() (accessToken string, err error) {
|
||||
return ak.GetAccessTokenContext(context.Background())
|
||||
}
|
||||
|
||||
// GetAccessTokenContext 企业微信获取access_token,先从cache中获取,没有则从服务端获取
|
||||
func (ak *WorkAccessToken) GetAccessTokenContext(ctx context.Context) (accessToken string, err error) {
|
||||
// 加上lock,是为了防止在并发获取token时,cache刚好失效,导致从微信服务器上获取到不同token
|
||||
ak.accessTokenLock.Lock()
|
||||
defer ak.accessTokenLock.Unlock()
|
||||
@@ -124,24 +212,27 @@ func (ak *WorkAccessToken) GetAccessToken() (accessToken string, err error) {
|
||||
|
||||
// cache失效,从微信服务器获取
|
||||
var resAccessToken ResAccessToken
|
||||
resAccessToken, err = GetTokenFromServer(fmt.Sprintf(workAccessTokenURL, ak.CorpID, ak.CorpSecret))
|
||||
resAccessToken, err = GetTokenFromServerContext(ctx, fmt.Sprintf(workAccessTokenURL, ak.CorpID, ak.CorpSecret))
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
expires := resAccessToken.ExpiresIn - 1500
|
||||
err = ak.cache.Set(accessTokenCacheKey, resAccessToken.AccessToken, time.Duration(expires)*time.Second)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
accessToken = resAccessToken.AccessToken
|
||||
return
|
||||
}
|
||||
|
||||
// GetTokenFromServer 强制从微信服务器获取token
|
||||
func GetTokenFromServer(url string) (resAccessToken ResAccessToken, err error) {
|
||||
return GetTokenFromServerContext(context.Background(), url)
|
||||
}
|
||||
|
||||
// GetTokenFromServerContext 强制从微信服务器获取token
|
||||
func GetTokenFromServerContext(ctx context.Context, url string) (resAccessToken ResAccessToken, err error) {
|
||||
var body []byte
|
||||
body, err = util.HTTPGet(url)
|
||||
body, err = util.HTTPGetContext(ctx, url)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
2
doc.go
2
doc.go
@@ -7,4 +7,6 @@ Package wechat provide wechat sdk for go
|
||||
更多信息:https://github.com/silenceper/wechat
|
||||
|
||||
*/
|
||||
|
||||
// Package wechat provide wechat sdk for go
|
||||
package wechat
|
||||
|
||||
@@ -1,29 +1,29 @@
|
||||
# 微信公众号API列表
|
||||
# 微信公众号 API 列表
|
||||
|
||||
## 基础接口
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Get_access_token.html)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| :---------------------: | -------- | :------------------------- | ---------- | -------- |
|
||||
| 获取Access token | GET | /cgi-bin/token | YES | |
|
||||
| 获取微信服务器IP地址 | GET | /cgi-bin/get_api_domain_ip | YES | |
|
||||
| 获取微信callback IP地址 | GET | /cgi-bin/getcallbackip | YES | |
|
||||
| 清理接口调用次数 | POST | /cgi-bin/clear_quota | YES | |
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| :-----------------------: | -------- | :------------------------- | ---------- | -------- |
|
||||
| 获取 Access token | GET | /cgi-bin/token | YES | |
|
||||
| 获取微信服务器 IP 地址 | GET | /cgi-bin/get_api_domain_ip | YES | |
|
||||
| 获取微信 callback IP 地址 | GET | /cgi-bin/getcallbackip | YES | |
|
||||
| 清理接口调用次数 | POST | /cgi-bin/clear_quota | YES | |
|
||||
|
||||
## 订阅通知
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| -------------------- | -------- | -------------------------------------- | ---------- | ----------------------- |
|
||||
| 选用模板 | POST | /wxaapi/newtmpl/addtemplate | YES | (tpl *Subscribe) Add |
|
||||
| 删除模板 | POST | /wxaapi/newtmpl/deltemplate | YES | (tpl *Subscribe) Delete |
|
||||
| 获取公众号类目 | GET | /wxaapi/newtmpl/getcategory | NO | |
|
||||
| 获取模板中的关键词 | GET | /wxaapi/newtmpl/getpubtemplatekeywords | NO | |
|
||||
| 获取类目下的公共模板 | GET | /wxaapi/newtmpl/getpubtemplatetitles | NO | |
|
||||
| 获取私有模板列表 | GET | /wxaapi/newtmpl/gettemplate | YES | (tpl *Subscribe) List() |
|
||||
| 发送订阅通知 | POST | /cgi-bin/message/subscribe/bizsend | YES | (tpl *Subscribe) Send |
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| -------------------- | -------- | -------------------------------------- | ---------- | -------------------------------------------- |
|
||||
| 选用模板 | POST | /wxaapi/newtmpl/addtemplate | YES | (tpl \*Subscribe) Add |
|
||||
| 删除模板 | POST | /wxaapi/newtmpl/deltemplate | YES | (tpl \*Subscribe) Delete |
|
||||
| 获取公众号类目 | GET | /wxaapi/newtmpl/getcategory | YES | (tpl \*Subscribe) GetCategory |
|
||||
| 获取模板中的关键词 | GET | /wxaapi/newtmpl/getpubtemplatekeywords | YES | (tpl \*Subscribe) GetPubTplKeyWordsByID |
|
||||
| 获取类目下的公共模板 | GET | /wxaapi/newtmpl/getpubtemplatetitles | YES | (tpl \*Subscribe) GetPublicTemplateTitleList |
|
||||
| 获取私有模板列表 | GET | /wxaapi/newtmpl/gettemplate | YES | (tpl \*Subscribe) List() |
|
||||
| 发送订阅通知 | POST | /cgi-bin/message/subscribe/bizsend | YES | (tpl \*Subscribe) Send |
|
||||
|
||||
## 客服消息
|
||||
|
||||
@@ -33,14 +33,16 @@
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Customer_Service/Customer_Service_Management.html)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| ---------------- | --------- | -------------------------------------- | ---------- | -------- |
|
||||
| 获取客服基本信息 | GET | /cgi-bin/customservice/getkflist | NO | |
|
||||
| 添加客服帐号 | POST | /customservice/kfaccount/add | NO | |
|
||||
| 邀请绑定客服帐号 | POST | /customservice/kfaccount/inviteworker | NO | |
|
||||
| 设置客服信息 | POST | /customservice/kfaccount/update | NO | |
|
||||
| 上传客服头像 | POST/FORM | /customservice/kfaccount/uploadheadimg | NO | |
|
||||
| 删除客服帐号 | GET | /customservice/kfaccount/del | NO | |
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| ---------------- | --------- | -------------------------------------- | ---------- | -------------------------------- |
|
||||
| 获取客服基本信息 | GET | /cgi-bin/customservice/getkflist | YES | (csm \*Manager) List |
|
||||
| 添加客服帐号 | POST | /customservice/kfaccount/add | YES | (csm \*Manager) Add |
|
||||
| 邀请绑定客服帐号 | POST | /customservice/kfaccount/inviteworker | YES | (csm \*Manager) InviteBind |
|
||||
| 设置客服信息 | POST | /customservice/kfaccount/update | YES | (csm \*Manager) Update |
|
||||
| 上传客服头像 | POST/FORM | /customservice/kfaccount/uploadheadimg | YES | (csm \*Manager) UploadHeadImg |
|
||||
| 删除客服帐号 | POST | /customservice/kfaccount/del | YES | (csm \*Manager) Delete |
|
||||
| 获取在线客服 | POST | /cgi-bin/customservice/getonlinekflist | YES | (csm \*Manager) OnlineList |
|
||||
| 下发客服输入状态 | POST | /cgi-bin/message/custom/typing | YES | (csm \*Manager) SendTypingStatus |
|
||||
|
||||
#### 会话控制
|
||||
|
||||
@@ -146,15 +148,15 @@
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_webpage_authorization.html)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| ------------------------------------------------------------ | -------- | --------------------------------------------------- | ---------- | ----------------------------------- |
|
||||
| 获取跳转的url地址 | GET | https://open.weixin.qq.com/connect/oauth2/authorize | YES | (oauth *Oauth) GetRedirectURL |
|
||||
| 获取网页应用跳转的url地址 | GET | https://open.weixin.qq.com/connect/qrconnect | YES | (oauth *Oauth) GetWebAppRedirectURL |
|
||||
| 通过网页授权的code 换取access_token(区别于context中的access_token) | GET | /sns/oauth2/access_token | YES | (oauth *Oauth) GetUserAccessToken |
|
||||
| 刷新access_token | GET | /sns/oauth2/refresh_token? | YES | (oauth *Oauth) RefreshAccessToken |
|
||||
| 检验access_token是否有效 | GET | /sns/auth | YES | (oauth *Oauth) CheckAccessToken( |
|
||||
| 拉取用户信息(需scope为 snsapi_userinfo) | GET | /sns/userinfo | YES | (oauth *Oauth) GetUserInfo |
|
||||
| 获取jssdk需要的配置参数 | GET | /cgi-bin/ticket/getticket | YES | (js *Js) GetConfig |
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| ----------------------------------------------------------------------- | -------- | --------------------------------------------------- | ---------- | ------------------------------------ |
|
||||
| 获取跳转的 url 地址 | GET | https://open.weixin.qq.com/connect/oauth2/authorize | YES | (oauth \*Oauth) GetRedirectURL |
|
||||
| 获取网页应用跳转的 url 地址 | GET | https://open.weixin.qq.com/connect/qrconnect | YES | (oauth \*Oauth) GetWebAppRedirectURL |
|
||||
| 通过网页授权的 code 换取 access_token(区别于 context 中的 access_token) | GET | /sns/oauth2/access_token | YES | (oauth \*Oauth) GetUserAccessToken |
|
||||
| 刷新 access_token | GET | /sns/oauth2/refresh_token? | YES | (oauth \*Oauth) RefreshAccessToken |
|
||||
| 检验 access_token 是否有效 | GET | /sns/auth | YES | (oauth \*Oauth) CheckAccessToken( |
|
||||
| 拉取用户信息(需 scope 为 snsapi_userinfo) | GET | /sns/userinfo | YES | (oauth \*Oauth) GetUserInfo |
|
||||
| 获取 jssdk 需要的配置参数 | GET | /cgi-bin/ticket/getticket | YES | (js \*Js) GetConfig |
|
||||
|
||||
## 素材管理
|
||||
|
||||
@@ -162,17 +164,15 @@
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Draft_Box/Add_draft.html)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| -------------------------- | -------- | ------------------------------------------------------------ | ---------- | ---------------------------- |
|
||||
| 新建草稿 | POST | /cgi-bin/draft/add | YES | (draft *Draft) AddDraft |
|
||||
| 获取草稿 | POST | /cgi-bin/draft/get | YES | (draft *Draft) GetDraft |
|
||||
| 删除草稿 | POST | /cgi-bin/draft/delete | YES | (draft *Draft) DeleteDraft |
|
||||
| 修改草稿 | POST | /cgi-bin/draft/update | YES | (draft *Draft) UpdateDraft |
|
||||
| 获取草稿总数 | GET | /cgi-bin/draft/count | YES | (draft *Draft) CountDraft |
|
||||
| 获取草稿列表 | POST | /cgi-bin/draft/batchget | YES | (draft *Draft) PaginateDraft |
|
||||
| MP端开关(仅内测期间使用) | POST | /cgi-bin/draft/switch<br />/cgi-bin/draft/switch?checkonly=1 | NO | |
|
||||
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| --------------------------- | -------- | ------------------------------------------------------------ | ---------- | ----------------------------- |
|
||||
| 新建草稿 | POST | /cgi-bin/draft/add | YES | (draft \*Draft) AddDraft |
|
||||
| 获取草稿 | POST | /cgi-bin/draft/get | YES | (draft \*Draft) GetDraft |
|
||||
| 删除草稿 | POST | /cgi-bin/draft/delete | YES | (draft \*Draft) DeleteDraft |
|
||||
| 修改草稿 | POST | /cgi-bin/draft/update | YES | (draft \*Draft) UpdateDraft |
|
||||
| 获取草稿总数 | GET | /cgi-bin/draft/count | YES | (draft \*Draft) CountDraft |
|
||||
| 获取草稿列表 | POST | /cgi-bin/draft/batchget | YES | (draft \*Draft) PaginateDraft |
|
||||
| MP 端开关(仅内测期间使用) | POST | /cgi-bin/draft/switch<br />/cgi-bin/draft/switch?checkonly=1 | NO | |
|
||||
|
||||
## 发布能力
|
||||
|
||||
@@ -185,20 +185,40 @@
|
||||
- 群发:主动推送给粉丝,历史消息可看,被搜一搜收录,可以限定部分的粉丝接收到。
|
||||
- 发布:不会主动推给粉丝,历史消息列表看不到,但是是公开给所有人的文章。也不会占用群发的次数。每天可以发布多篇内容。可以用于自动回复、自定义菜单、页面模板和话题中,发布成功时会生成一个永久链接。
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| ------------------------------ | -------- | ------------------------------- | ---------- | --------------------------------------- |
|
||||
| 发布接口 | POST | /cgi-bin/freepublish/submit | YES | (freePublish *FreePublish) Publish |
|
||||
| 发布状态轮询接口 | POST | /cgi-bin/freepublish/get | YES | (freePublish *FreePublish) SelectStatus |
|
||||
| 事件推送发布结果 | | | YES | EventPublishJobFinish |
|
||||
| 删除发布 | POST | /cgi-bin/freepublish/delete | YES | (freePublish *FreePublish) Delete |
|
||||
| 通过 article_id 获取已发布文章 | POST | /cgi-bin/freepublish/getarticle | YES | (freePublish *FreePublish) First |
|
||||
| 获取成功发布列表 | POST | /cgi-bin/freepublish/batchget | YES | (freePublish *FreePublish) Paginate |
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| ------------------------------ | -------- | ------------------------------- | ---------- | ---------------------------------------- |
|
||||
| 发布接口 | POST | /cgi-bin/freepublish/submit | YES | (freePublish \*FreePublish) Publish |
|
||||
| 发布状态轮询接口 | POST | /cgi-bin/freepublish/get | YES | (freePublish \*FreePublish) SelectStatus |
|
||||
| 事件推送发布结果 | | | YES | EventPublishJobFinish |
|
||||
| 删除发布 | POST | /cgi-bin/freepublish/delete | YES | (freePublish \*FreePublish) Delete |
|
||||
| 通过 article_id 获取已发布文章 | POST | /cgi-bin/freepublish/getarticle | YES | (freePublish \*FreePublish) First |
|
||||
| 获取成功发布列表 | POST | /cgi-bin/freepublish/batchget | YES | (freePublish \*FreePublish) Paginate |
|
||||
|
||||
## 图文消息留言管理
|
||||
|
||||
## 用户管理
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| ------------------------------------------ | -------- | -------------------------------------- | ---------- | ---------------------------------- |
|
||||
| 获取指定 OpenID 变化列表(公众号账号迁移) | POST | /cgi-bin/changeopenid | YES | (user \*User) ListChangeOpenIDs |
|
||||
| 获取所有用户 OpenID 列表(公众号账号迁移) | | | YES | (user \*User) ListAllChangeOpenIDs |
|
||||
| 获取用户基本信息 | GET | /cgi-bin/user/info | YES | (user \*User) GetUserInfo |
|
||||
| 设置用户备注名 | POST | /cgi-bin/user/info/updateremark | YES | (user \*User) UpdateRemark |
|
||||
| 获取用户列表 | GET | /cgi-bin/user/get | YES | (user \*User) ListUserOpenIDs |
|
||||
| 获取所有用户 OpenID 列表 | | | YES | (user \*User) ListAllUserOpenIDs |
|
||||
| 获取公众号的黑名单列表 | POST | /cgi-bin/tags/members/getblacklist | YES | (user \*User) GetBlackList |
|
||||
| 获取公众号的所有黑名单列表 | | | YES | (user \*User) GetAllBlackList |
|
||||
| 拉黑用户 | POST | /cgi-bin/tags/members/batchblacklist | YES | (user \*User) BatchBlackList |
|
||||
| 取消拉黑用户 | POST | /cgi-bin/tags/members/batchunblacklist | YES | (user \*User) BatchUnBlackList |
|
||||
| 创建标签 | POST | /cgi-bin/tags/create | YES | (user \*User) CreateTag |
|
||||
| 删除标签 | POST | /cgi-bin/tags/delete | YES | (user \*User) DeleteTag |
|
||||
| 编辑标签 | POST | /cgi-bin/tags/update | YES | (user \*User) UpdateTag |
|
||||
| 获取公众号已创建的标签 | GET | /cgi-bin/tags/get | YES | (user \*User) GetTag |
|
||||
| 获取标签下粉丝列表 | POST | /cgi-bin/user/tag/get | YES | (user \*User) OpenIDListByTag |
|
||||
| 批量为用户打标签 | POST | /cgi-bin/tags/members/batchtagging | YES | (user \*User) BatchTag |
|
||||
| 批量为用户取消标签 | POST | /cgi-bin/tags/members/batchuntagging | YES | (user \*User) BatchUntag |
|
||||
| 获取用户身上的标签列表 | POST | /cgi-bin/tags/getidlist | YES | (user \*User) UserTidList |
|
||||
|
||||
## 账号管理
|
||||
|
||||
## 数据统计
|
||||
@@ -215,5 +235,4 @@
|
||||
|
||||
## 微信发票
|
||||
|
||||
## 微信非税缴费
|
||||
|
||||
## 微信非税缴费
|
||||
|
||||
@@ -59,7 +59,73 @@ host: https://qyapi.weixin.qq.com/
|
||||
| 获取客户基础信息 | POST | /cgi-bin/kf/customer/batchget | YES | (r *Client) CustomerBatchGet | NICEXAI |
|
||||
| 获取视频号绑定状态 | GET | /cgi-bin/kf/get_corp_qualification | YES | (r *Client) GetCorpQualification | NICEXAI |
|
||||
|
||||
### 客户联系
|
||||
[官方文档](https://developer.work.weixin.qq.com/document/path/92132/92133/92228)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 |
|
||||
|:------------------------:| -------- |:-------------------------------------------------------------| ---------- | ------------------------------- |----------|
|
||||
| 获取「联系客户统计」数据 | POST | /cgi-bin/externalcontact/get_user_behavior_data | YES | (r *Client) GetUserBehaviorData | MARKWANG |
|
||||
| 获取「群聊数据统计」数据 (按群主聚合的方式) | POST | /cgi-bin/externalcontact/groupchat/statistic | YES | (r *Client) GetGroupChatStat | MARKWANG |
|
||||
| 获取「群聊数据统计」数据 (按自然日聚合的方式) | POST | /cgi-bin/externalcontact/groupchat/statistic_group_by_day | YES | (r *Client) GetGroupChatStatByDay | MARKWANG |
|
||||
| 配置客户联系「联系我」方式 | POST | /cgi-bin/externalcontact/add_contact_way | YES | (r *Client) AddContactWay | MARKWANG |
|
||||
| 获取企业已配置的「联系我」方式 | POST | /cgi-bin/externalcontact/get_contact_way | YES | (r *Client) GetContactWay | MARKWANG |
|
||||
| 更新企业已配置的「联系我」方式 | POST | /cgi-bin/externalcontact/update_contact_way | YES | (r *Client) UpdateContactWay | MARKWANG |
|
||||
| 获取企业已配置的「联系我」列表 | POST | /cgi-bin/externalcontact/list_contact_way | YES | (r *Client) ListContactWay | MARKWANG |
|
||||
| 删除企业已配置的「联系我」方式 | POST | /cgi-bin/externalcontact/del_contact_way | YES | (r *Client) DelContactWay | MARKWANG |
|
||||
| 创建企业群发 | POST | /cgi-bin/externalcontact/add_msg_template | YES | (r *Client) AddMsgTemplate | MARKWANG |
|
||||
| 获取群发记录列表 | POST | /cgi-bin/externalcontact/get_groupmsg_list_v2 | YES | (r *Client) GetGroupMsgListV2 | MARKWANG |
|
||||
| 获取群发成员发送任务列表 | POST | /cgi-bin/externalcontact/get_groupmsg_task | YES | (r *Client) GetGroupMsgTask | MARKWANG |
|
||||
| 获取企业群发成员执行结果 | POST | /cgi-bin/externalcontact/get_groupmsg_send_result | YES | (r *Client) GetGroupMsgSendResult | MARKWANG |
|
||||
| 发送新客户欢迎语 | POST | /cgi-bin/externalcontact/send_welcome_msg | YES | (r *Client) SendWelcomeMsg | MARKWANG |
|
||||
| 添加入群欢迎语素材 | POST | /cgi-bin/externalcontact/group_welcome_template/add | YES | (r *Client) AddGroupWelcomeTemplate | MARKWANG |
|
||||
| 编辑入群欢迎语素材 | POST | /cgi-bin/externalcontact/group_welcome_template/edit | YES | (r *Client) EditGroupWelcomeTemplate | MARKWANG |
|
||||
| 获取入群欢迎语素材 | POST | /cgi-bin/externalcontact/group_welcome_template/get | YES | (r *Client) GetGroupWelcomeTemplate | MARKWANG |
|
||||
| 删除入群欢迎语素材 | POST | /cgi-bin/externalcontact/group_welcome_template/del | YES | (r *Client) DelGroupWelcomeTemplate | MARKWANG |
|
||||
|
||||
## 通讯录管理
|
||||
[官方文档](https://developer.work.weixin.qq.com/document/path/90193)
|
||||
|
||||
### 部门管理
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 |
|
||||
|:---------:|------|:----------------------------------------| ---------- | ------------------------------- |----------|
|
||||
| 获取子部门ID列表 | GET | /cgi-bin/department/simplelist | YES | (r *Client) DepartmentSimpleList| MARKWANG |
|
||||
| 获取部门列表 | GET | /cgi-bin/department/list | YES | (r *Client) DepartmentList| just5325, ourines |
|
||||
| 获取部门成员 | GET | /cgi-bin/user/simplelist | YES | (r *Client) UserSimpleList | MARKWANG |
|
||||
| 获取成员ID列表 | Post | /cgi-bin/user/list_id | YES | (r *Client) UserListId | MARKWANG |
|
||||
|
||||
|
||||
|
||||
## 素材管理
|
||||
[官方文档](https://developer.work.weixin.qq.com/document/path/91054)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 |
|
||||
|:---------:|------|:----------------------------------------| ---------- | ------------------------------- |----------|
|
||||
| 上传图片 | POST | /cgi-bin/media/uploadimg | YES | (r *Client) UploadImg| MARKWANG |
|
||||
|
||||
### 成员管理
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 |
|
||||
| -------- | -------- | ----------------- | ---------- | ------------------- | -------- |
|
||||
| 读取成员 | GET | /cgi-bin/user/get | YES | (r *Client) UserGet | chcthink |
|
||||
|
||||
|
||||
## 群机器人
|
||||
|
||||
[官方文档](https://developer.work.weixin.qq.com/document/path/91770)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 |
|
||||
| ---------------- | -------- | --------------------- | ---------- | -------------------------- | -------- |
|
||||
| 群机器人发送消息 | POST | /cgi-bin/webhook/send | YES | (r *Client) RobotBroadcast | chcthink |
|
||||
|
||||
## 打卡
|
||||
|
||||
[官方文档](https://developer.work.weixin.qq.com/document/path/96497)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 |
|
||||
|----------| -------- | --------------------- | ---------- | -------------------------- |---------|
|
||||
| 获取打卡日报数据 | POST | /cgi-bin/checkin/getcheckin_daydata | YES | (r *Client) GetDayData | Thinker |
|
||||
| 获取打卡月报数据 | POST | /cgi-bin/checkin/getcheckin_monthdata | YES | (r *Client) GetMonthData | Thinker |
|
||||
|
||||
## 应用管理
|
||||
|
||||
TODO
|
||||
|
||||
|
||||
36
domain/openapi/mgnt.go
Normal file
36
domain/openapi/mgnt.go
Normal file
@@ -0,0 +1,36 @@
|
||||
package openapi
|
||||
|
||||
import "github.com/silenceper/wechat/v2/util"
|
||||
|
||||
// GetAPIQuotaParams 查询 API 调用额度参数
|
||||
type GetAPIQuotaParams struct {
|
||||
CgiPath string `json:"cgi_path"` // api 的请求地址,例如"/cgi-bin/message/custom/send";不要前缀“https://api.weixin.qq.com” ,也不要漏了"/",否则都会 76003 的报错
|
||||
}
|
||||
|
||||
// APIQuota API 调用额度
|
||||
type APIQuota struct {
|
||||
util.CommonError
|
||||
Quota struct {
|
||||
DailyLimit int64 `json:"daily_limit"` // 当天该账号可调用该接口的次数
|
||||
Used int64 `json:"used"` // 当天已经调用的次数
|
||||
Remain int64 `json:"remain"` // 当天剩余调用次数
|
||||
} `json:"quota"` // 详情
|
||||
}
|
||||
|
||||
// GetRidInfoParams 查询 rid 信息参数
|
||||
type GetRidInfoParams struct {
|
||||
Rid string `json:"rid"` // 调用接口报错返回的 rid
|
||||
}
|
||||
|
||||
// RidInfo rid 信息
|
||||
type RidInfo struct {
|
||||
util.CommonError
|
||||
Request struct {
|
||||
InvokeTime int64 `json:"invoke_time"` // 发起请求的时间戳
|
||||
CostInMs int64 `json:"cost_in_ms"` // 请求毫秒级耗时
|
||||
RequestURL string `json:"request_url"` // 请求的 URL 参数
|
||||
RequestBody string `json:"request_body"` // post 请求的请求参数
|
||||
ResponseBody string `json:"response_body"` // 接口请求返回参数
|
||||
ClientIP string `json:"client_ip"` // 接口请求的客户端 ip
|
||||
} `json:"request"` // 该 rid 对应的请求详情
|
||||
}
|
||||
9
go.mod
9
go.mod
@@ -1,15 +1,16 @@
|
||||
module github.com/silenceper/wechat/v2
|
||||
|
||||
go 1.14
|
||||
go 1.16
|
||||
|
||||
require (
|
||||
github.com/alicebob/miniredis/v2 v2.30.0
|
||||
github.com/bradfitz/gomemcache v0.0.0-20220106215444-fb4bf637b56d
|
||||
github.com/fatih/structs v1.1.0
|
||||
github.com/go-redis/redis/v8 v8.11.6-0.20220405070650-99c79f7041fc
|
||||
github.com/sirupsen/logrus v1.8.1
|
||||
github.com/go-redis/redis/v8 v8.11.5
|
||||
github.com/sirupsen/logrus v1.9.0
|
||||
github.com/spf13/cast v1.4.1
|
||||
github.com/stretchr/testify v1.7.1
|
||||
github.com/tidwall/gjson v1.14.1
|
||||
golang.org/x/crypto v0.0.0-20220411220226-7b82a4e95df4
|
||||
golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d
|
||||
gopkg.in/h2non/gock.v1 v1.1.2
|
||||
)
|
||||
|
||||
42
go.sum
42
go.sum
@@ -1,3 +1,7 @@
|
||||
github.com/alicebob/gopher-json v0.0.0-20200520072559-a9ecdc9d1d3a h1:HbKu58rmZpUGpz5+4FfNmIU+FmZg2P3Xaj2v2bfNWmk=
|
||||
github.com/alicebob/gopher-json v0.0.0-20200520072559-a9ecdc9d1d3a/go.mod h1:SGnFV6hVsYE877CKEZ6tDNTjaSXYUk6QqoIK6PrAtcc=
|
||||
github.com/alicebob/miniredis/v2 v2.30.0 h1:uA3uhDbCxfO9+DI/DuGeAMr9qI+noVWwGPNTFuKID5M=
|
||||
github.com/alicebob/miniredis/v2 v2.30.0/go.mod h1:84TWKZlxYkfgMucPBf5SOQBYJceZeQRFIaQgNMiCX6Q=
|
||||
github.com/bradfitz/gomemcache v0.0.0-20220106215444-fb4bf637b56d h1:pVrfxiGfwelyab6n21ZBkbkmbevaf+WvMIiR7sr97hw=
|
||||
github.com/bradfitz/gomemcache v0.0.0-20220106215444-fb4bf637b56d/go.mod h1:H0wQNHz2YrLsuXOZozoeDmnHXkNCRmMW0gwFWDfEZDA=
|
||||
github.com/cespare/xxhash/v2 v2.1.2 h1:YRXhKfTDauu4ajMg1TPgFO5jnlC2HCbmLXMcTG5cbYE=
|
||||
@@ -15,8 +19,8 @@ github.com/fatih/structs v1.1.0/go.mod h1:9NiDSp5zOcgEDl+j00MP/WkGVPOlPRLejGD8Ga
|
||||
github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
|
||||
github.com/fsnotify/fsnotify v1.4.9 h1:hsms1Qyu0jgnwNXIxa+/V/PDsU6CfLf6CNO8H7IWoS4=
|
||||
github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ=
|
||||
github.com/go-redis/redis/v8 v8.11.6-0.20220405070650-99c79f7041fc h1:jZY+lpZB92nvBo2f31oPC/ivGll6NcsnEOORm8Fkr4M=
|
||||
github.com/go-redis/redis/v8 v8.11.6-0.20220405070650-99c79f7041fc/go.mod h1:25mL1NKxbJhB63ihiK8MnNeTRd+xAizd6bOdydrTLUQ=
|
||||
github.com/go-redis/redis/v8 v8.11.5 h1:AcZZR7igkdvfVmQTPnu9WE37LRrO/YrBH5zWyjDC0oI=
|
||||
github.com/go-redis/redis/v8 v8.11.5/go.mod h1:gREzHqY1hg6oD9ngVRbLStwAWKhA0FEgq8Jd4h5lpwo=
|
||||
github.com/go-task/slim-sprig v0.0.0-20210107165309-348f09dbbbc0/go.mod h1:fyg7847qk6SyHyPtNmDHnmrv/HOrqktSC+C9fM+CJOE=
|
||||
github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
|
||||
github.com/golang/protobuf v1.4.0-rc.1/go.mod h1:ceaxUfeHdC40wWswd/P6IGgMaK3YpKi5j83Wpe3EHw8=
|
||||
@@ -26,12 +30,10 @@ github.com/golang/protobuf v1.4.0-rc.4.0.20200313231945-b860323f09d0/go.mod h1:W
|
||||
github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvqG2KuDX0=
|
||||
github.com/golang/protobuf v1.4.2/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI=
|
||||
github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
|
||||
github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw=
|
||||
github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
|
||||
github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
|
||||
github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
|
||||
github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
|
||||
github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
|
||||
github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
|
||||
github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE=
|
||||
github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 h1:2VTzZjLZBgl62/EtslCrtky5vbi9dd7HrQPQIx6wqiw=
|
||||
@@ -48,22 +50,22 @@ github.com/onsi/ginkgo v1.12.1/go.mod h1:zj2OWP4+oCPe1qIXoGWkgMRwljMUYCdkwsT2108
|
||||
github.com/onsi/ginkgo v1.16.4/go.mod h1:dX+/inL/fNMqNlz0e9LfyB9TswhZpCVdJM/Z6Vvnwo0=
|
||||
github.com/onsi/ginkgo v1.16.5 h1:8xi0RTUf59SOSfEtZMvwTvXYMzG4gV23XVHOZiXNtnE=
|
||||
github.com/onsi/ginkgo v1.16.5/go.mod h1:+E8gABHa3K6zRBolWtd+ROzc/U5bkGt0FwiG042wbpU=
|
||||
github.com/onsi/ginkgo/v2 v2.1.3 h1:e/3Cwtogj0HA+25nMP1jCMDIf8RtRYbGwGGuBIFztkc=
|
||||
github.com/onsi/ginkgo/v2 v2.1.3/go.mod h1:vw5CSIxN1JObi/U8gcbwft7ZxR2dgaR70JSE3/PpL4c=
|
||||
github.com/onsi/ginkgo/v2 v2.0.0/go.mod h1:vw5CSIxN1JObi/U8gcbwft7ZxR2dgaR70JSE3/PpL4c=
|
||||
github.com/onsi/gomega v1.7.1/go.mod h1:XdKZgCCFLUoM/7CFJVPcG8C1xQ1AJ0vpAezJrB7JYyY=
|
||||
github.com/onsi/gomega v1.10.1/go.mod h1:iN09h71vgCQne3DLsj+A5owkum+a2tYe+TOCB1ybHNo=
|
||||
github.com/onsi/gomega v1.17.0/go.mod h1:HnhC7FXeEQY45zxNK3PPoIUhzk/80Xly9PcubAlGdZY=
|
||||
github.com/onsi/gomega v1.19.0 h1:4ieX6qQjPP/BfC3mpsAtIGGlxTWPeA3Inl/7DtXw1tw=
|
||||
github.com/onsi/gomega v1.19.0/go.mod h1:LY+I3pBVzYsTBU1AnDwOSxaYi9WoWiqgwooUqq9yPro=
|
||||
github.com/onsi/gomega v1.18.1 h1:M1GfJqGRrBrrGGsbxzV5dqM2U2ApXefZCQpkukxYRLE=
|
||||
github.com/onsi/gomega v1.18.1/go.mod h1:0q+aL8jAiMXy9hbwj2mr5GziHiwhAIQpFmmtT5hitRs=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/sirupsen/logrus v1.8.1 h1:dJKuHgqk1NNQlqoA6BTlM1Wf9DOH3NBjQyu0h9+AZZE=
|
||||
github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
|
||||
github.com/sirupsen/logrus v1.9.0 h1:trlNQbNUG3OdDrDil03MCb1H2o9nJ1x4/5LYw7byDE0=
|
||||
github.com/sirupsen/logrus v1.9.0/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
|
||||
github.com/spf13/cast v1.4.1 h1:s0hze+J0196ZfEMTs80N7UlFt0BDuQ7Q+JDnHiMWKdA=
|
||||
github.com/spf13/cast v1.4.1/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
|
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
|
||||
github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
|
||||
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||
github.com/stretchr/testify v1.7.1 h1:5TQK59W5E3v0r2duFAb7P95B6hEeOyEnHRa8MjYSMTY=
|
||||
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||
github.com/tidwall/gjson v1.14.1 h1:iymTbGkQBhveq21bEvAQ81I0LEBork8BFe1CUZXdyuo=
|
||||
@@ -73,11 +75,13 @@ github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JT
|
||||
github.com/tidwall/pretty v1.2.0 h1:RWIZEg2iJ8/g6fDDYzMpobmaoGh5OLl4AXtGUGPcqCs=
|
||||
github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
|
||||
github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
|
||||
github.com/yuin/gopher-lua v0.0.0-20220504180219-658193537a64 h1:5mLPGnFdSsevFRFc9q3yYbBkB6tsm4aCwwQV/j1JQAQ=
|
||||
github.com/yuin/gopher-lua v0.0.0-20220504180219-658193537a64/go.mod h1:GBR0iDaNXjAgGg9zfCvksxSRnQx76gclCIb7kdAd1Pw=
|
||||
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
||||
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
|
||||
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
|
||||
golang.org/x/crypto v0.0.0-20220411220226-7b82a4e95df4 h1:kUhD7nTDoI3fVd9G4ORWrbV5NY0liEs/Jg2pv5f+bBA=
|
||||
golang.org/x/crypto v0.0.0-20220411220226-7b82a4e95df4/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
|
||||
golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d h1:sK3txAijHtOK88l68nt020reeT1ZdKLIYetKl95FzVY=
|
||||
golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
|
||||
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
||||
golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
|
||||
@@ -85,18 +89,17 @@ golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLL
|
||||
golang.org/x/net v0.0.0-20200520004742-59133d7f0dd7/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
|
||||
golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
|
||||
golang.org/x/net v0.0.0-20210428140749-89ef3d95e781/go.mod h1:OJAsFXCWl8Ukc7SiCT/9KSuxbyM7479/AVlXFRxuMCk=
|
||||
golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2 h1:CIJ76btIcR3eFI5EgSo6k1qKw9KJexJuRLI9G7Hp5wE=
|
||||
golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
|
||||
golang.org/x/net v0.0.0-20220225172249-27dd8689420f h1:oA4XRj0qtSt8Yo1Zms0CUlsT3KG69V2UGQWPBxujDmc=
|
||||
golang.org/x/net v0.0.0-20220225172249-27dd8689420f/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk=
|
||||
golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20190204203706-41f3e6584952/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20190904154756-749cb33beabd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20191005200804-aed5e4c7ecf9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20191120155948-bd437916bb0e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20191204072324-ce4227a45e2e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
@@ -105,22 +108,20 @@ golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7w
|
||||
golang.org/x/sys v0.0.0-20210112080510-489259a85091/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e h1:fLOSk5Q00efkSvAm+4xcoXD+RRmLmmulPn5I3Y9F2EM=
|
||||
golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=
|
||||
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
|
||||
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
|
||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||
golang.org/x/text v0.3.6 h1:aRYxNxv6iGQlyVaZmk6ZgYEDa+Jg18DxebPSrd6bg1M=
|
||||
golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||
golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk=
|
||||
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
|
||||
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
|
||||
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
|
||||
golang.org/x/tools v0.0.0-20201224043029-2b0845dc783e/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
|
||||
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE=
|
||||
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8=
|
||||
google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0=
|
||||
@@ -129,7 +130,6 @@ google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miE
|
||||
google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo=
|
||||
google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
|
||||
google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
|
||||
google.golang.org/protobuf v1.26.0 h1:bxAC2xTBsZGibn2RTntX0oH50xLsqy1OxA9tTL3p/lk=
|
||||
google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
|
||||
127
internal/openapi/mgnt.go
Normal file
127
internal/openapi/mgnt.go
Normal file
@@ -0,0 +1,127 @@
|
||||
package openapi
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/domain/openapi"
|
||||
mpContext "github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
ocContext "github.com/silenceper/wechat/v2/officialaccount/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
clearQuotaURL = "https://api.weixin.qq.com/cgi-bin/clear_quota" // 重置API调用次数
|
||||
getAPIQuotaURL = "https://api.weixin.qq.com/cgi-bin/openapi/quota/get" // 查询API调用额度
|
||||
getRidInfoURL = "https://api.weixin.qq.com/cgi-bin/openapi/rid/get" // 查询rid信息
|
||||
clearQuotaByAppSecretURL = "https://api.weixin.qq.com/cgi-bin/clear_quota/v2" // 使用AppSecret重置 API 调用次数
|
||||
)
|
||||
|
||||
// OpenAPI openApi管理
|
||||
type OpenAPI struct {
|
||||
ctx interface{}
|
||||
}
|
||||
|
||||
// NewOpenAPI 实例化
|
||||
func NewOpenAPI(ctx interface{}) *OpenAPI {
|
||||
return &OpenAPI{ctx: ctx}
|
||||
}
|
||||
|
||||
// ClearQuota 重置API调用次数
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/clearQuota.html
|
||||
func (o *OpenAPI) ClearQuota() error {
|
||||
appID, _, err := o.getAppIDAndSecret()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
var payload = struct {
|
||||
AppID string `json:"appid"`
|
||||
}{
|
||||
AppID: appID,
|
||||
}
|
||||
res, err := o.doPostRequest(clearQuotaURL, payload)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return util.DecodeWithCommonError(res, "ClearQuota")
|
||||
}
|
||||
|
||||
// GetAPIQuota 查询API调用额度
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/getApiQuota.html
|
||||
func (o *OpenAPI) GetAPIQuota(params openapi.GetAPIQuotaParams) (quota openapi.APIQuota, err error) {
|
||||
res, err := o.doPostRequest(getAPIQuotaURL, params)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(res, "a, "GetAPIQuota")
|
||||
return
|
||||
}
|
||||
|
||||
// GetRidInfo 查询rid信息
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/getRidInfo.html
|
||||
func (o *OpenAPI) GetRidInfo(params openapi.GetRidInfoParams) (r openapi.RidInfo, err error) {
|
||||
res, err := o.doPostRequest(getRidInfoURL, params)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(res, &r, "GetRidInfo")
|
||||
return
|
||||
}
|
||||
|
||||
// ClearQuotaByAppSecret 使用AppSecret重置 API 调用次数
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/clearQuotaByAppSecret.html
|
||||
func (o *OpenAPI) ClearQuotaByAppSecret() error {
|
||||
id, secret, err := o.getAppIDAndSecret()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf("%s?appid=%s&appsecret=%s", clearQuotaByAppSecretURL, id, secret)
|
||||
res, err := util.HTTPPost(uri, "")
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return util.DecodeWithCommonError(res, "ClearQuotaByAppSecret")
|
||||
}
|
||||
|
||||
// 获取 AppID 和 AppSecret
|
||||
func (o *OpenAPI) getAppIDAndSecret() (string, string, error) {
|
||||
switch o.ctx.(type) {
|
||||
case *mpContext.Context:
|
||||
c := o.ctx.(*mpContext.Context)
|
||||
return c.AppID, c.AppSecret, nil
|
||||
case *ocContext.Context:
|
||||
c := o.ctx.(*ocContext.Context)
|
||||
return c.AppID, c.AppSecret, nil
|
||||
default:
|
||||
return "", "", errors.New("invalid context type")
|
||||
}
|
||||
}
|
||||
|
||||
// 获取 AccessToken
|
||||
func (o *OpenAPI) getAccessToken() (string, error) {
|
||||
switch o.ctx.(type) {
|
||||
case *mpContext.Context:
|
||||
return o.ctx.(*mpContext.Context).GetAccessToken()
|
||||
case *ocContext.Context:
|
||||
return o.ctx.(*ocContext.Context).GetAccessToken()
|
||||
default:
|
||||
return "", errors.New("invalid context type")
|
||||
}
|
||||
}
|
||||
|
||||
// 创建 POST 请求
|
||||
func (o *OpenAPI) doPostRequest(uri string, payload interface{}) ([]byte, error) {
|
||||
ak, err := o.getAccessToken()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
uri = fmt.Sprintf("%s?access_token=%s", uri, ak)
|
||||
return util.PostJSON(uri, payload)
|
||||
}
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
## 包说明
|
||||
|
||||
- analysis 数据分析相关API
|
||||
- analysis 数据分析相关 API
|
||||
|
||||
## 快速入门
|
||||
|
||||
@@ -18,4 +18,36 @@ cfg := &miniConfig.Config{
|
||||
}
|
||||
miniprogram := wc.GetMiniProgram(cfg)
|
||||
miniprogram.GetAnalysis().GetAnalysisDailyRetain()
|
||||
```
|
||||
|
||||
### 小程序虚拟支付
|
||||
#### `注意:需要传入 Appkey、OfferID 的值`
|
||||
相关文档:[小程序虚拟支付](https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/virtual-payment.html)
|
||||
```go
|
||||
wc := wechat.NewWechat()
|
||||
miniprogram := wc.GetMiniProgram(&miniConfig.Config{
|
||||
AppID: "xxx",
|
||||
AppSecret: "xxx",
|
||||
AppKey: "xxx",
|
||||
OfferID: "xxx",
|
||||
Cache: cache.NewRedis(&redis.Options{
|
||||
Addr: "",
|
||||
}),
|
||||
})
|
||||
virtualPayment := miniprogram.GetVirtualPayment()
|
||||
virtualPayment.SetSessionKey("xxx")
|
||||
// 查询用户余额
|
||||
var (
|
||||
res *virtualPayment.QueryUserBalanceResponse
|
||||
err error
|
||||
)
|
||||
|
||||
if res, err = virtualPayment.QueryUserBalance(context.TODO(), &virtualPayment.QueryUserBalanceRequest{
|
||||
OpenID: "xxx",
|
||||
Env: virtualPayment.EnvProduction,
|
||||
UserIP: "xxx",
|
||||
}); err != nil {
|
||||
panic(err)
|
||||
}
|
||||
|
||||
```
|
||||
@@ -190,9 +190,9 @@ func (analysis *Analysis) GetAnalysisWeeklyVisitTrend(beginDate, endDate string)
|
||||
|
||||
// UserPortraitItem 用户画像项目
|
||||
type UserPortraitItem struct {
|
||||
ID int `json:"id"` // 属性值id
|
||||
Name string `json:"name"` // 属性值名称
|
||||
AccessSourceVisitUV int `json:"access_source_visit_uv"` // 该场景访问uv
|
||||
ID int `json:"id"` // 属性值id
|
||||
Name string `json:"name"` // 属性值名称
|
||||
Value int `json:"value"` // 该场景访问uv
|
||||
}
|
||||
|
||||
// UserPortrait 用户画像
|
||||
|
||||
@@ -40,8 +40,8 @@ type ResCode2Session struct {
|
||||
type RspCheckEncryptedData struct {
|
||||
util.CommonError
|
||||
|
||||
Vaild bool `json:"vaild"` // 是否是合法的数据
|
||||
CreateTime uint `json:"create_time"` // 加密数据生成的时间戳
|
||||
Vaild bool `json:"vaild"` // 是否是合法的数据
|
||||
CreateTime uint64 `json:"create_time"` // 加密数据生成的时间戳
|
||||
}
|
||||
|
||||
// Code2Session 登录凭证校验。
|
||||
@@ -84,7 +84,9 @@ func (auth *Auth) CheckEncryptedDataContext(ctx context2.Context, encryptedMsgHa
|
||||
if at, err = auth.GetAccessToken(); err != nil {
|
||||
return
|
||||
}
|
||||
if response, err = util.HTTPPostContext(ctx, fmt.Sprintf(checkEncryptedDataURL, at), "encrypted_msg_hash="+encryptedMsgHash); err != nil {
|
||||
|
||||
// 由于GetPhoneNumberContext需要传入JSON,所以HTTPPostContext入参改为[]byte
|
||||
if response, err = util.HTTPPostContext(ctx, fmt.Sprintf(checkEncryptedDataURL, at), []byte("encrypted_msg_hash="+encryptedMsgHash), nil); err != nil {
|
||||
return
|
||||
}
|
||||
if err = util.DecodeWithError(response, &result, "CheckEncryptedDataAuth"); err != nil {
|
||||
@@ -111,8 +113,8 @@ type PhoneInfo struct {
|
||||
} `json:"watermark"` // 数据水印
|
||||
}
|
||||
|
||||
// GetPhoneNumber 小程序通过code获取用户手机号
|
||||
func (auth *Auth) GetPhoneNumber(code string) (*GetPhoneNumberResponse, error) {
|
||||
// GetPhoneNumberContext 小程序通过code获取用户手机号
|
||||
func (auth *Auth) GetPhoneNumberContext(ctx context2.Context, code string) (*GetPhoneNumberResponse, error) {
|
||||
var response []byte
|
||||
var (
|
||||
at string
|
||||
@@ -124,12 +126,23 @@ func (auth *Auth) GetPhoneNumber(code string) (*GetPhoneNumberResponse, error) {
|
||||
body := map[string]interface{}{
|
||||
"code": code,
|
||||
}
|
||||
if response, err = util.PostJSON(fmt.Sprintf(getPhoneNumber, at), body); err != nil {
|
||||
|
||||
bodyBytes, err := json.Marshal(body)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
header := map[string]string{"Content-Type": "application/json;charset=utf-8"}
|
||||
if response, err = util.HTTPPostContext(ctx, fmt.Sprintf(getPhoneNumber, at), bodyBytes, header); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var result GetPhoneNumberResponse
|
||||
if err = util.DecodeWithError(response, &result, "phonenumber.getPhoneNumber"); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &result, nil
|
||||
err = util.DecodeWithError(response, &result, "phonenumber.getPhoneNumber")
|
||||
return &result, err
|
||||
}
|
||||
|
||||
// GetPhoneNumber 小程序通过code获取用户手机号
|
||||
func (auth *Auth) GetPhoneNumber(code string) (*GetPhoneNumberResponse, error) {
|
||||
return auth.GetPhoneNumberContext(context2.Background(), code)
|
||||
}
|
||||
|
||||
@@ -45,10 +45,5 @@ func (business *Business) GetPhoneNumber(in *GetPhoneNumberRequest) (info PhoneI
|
||||
PhoneInfo PhoneInfo `json:"phone_info"`
|
||||
}
|
||||
err = util.DecodeWithError(response, &resp, "business.GetPhoneNumber")
|
||||
if nil != err {
|
||||
return
|
||||
}
|
||||
|
||||
info = resp.PhoneInfo
|
||||
return
|
||||
return resp.PhoneInfo, err
|
||||
}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
// Package config 小程序config配置
|
||||
// Package config 小程序 config 配置
|
||||
package config
|
||||
|
||||
import (
|
||||
@@ -7,7 +7,11 @@ import (
|
||||
|
||||
// Config .config for 小程序
|
||||
type Config struct {
|
||||
AppID string `json:"app_id"` // appid
|
||||
AppSecret string `json:"app_secret"` // appsecret
|
||||
Cache cache.Cache
|
||||
AppID string `json:"app_id"` // appid
|
||||
AppSecret string `json:"app_secret"` // appSecret
|
||||
AppKey string `json:"app_key"` // appKey
|
||||
OfferID string `json:"offer_id"` // offerId
|
||||
Token string `json:"token"` // token
|
||||
EncodingAESKey string `json:"encoding_aes_key"` // EncodingAESKey
|
||||
Cache cache.Cache
|
||||
}
|
||||
|
||||
@@ -20,6 +20,12 @@ const (
|
||||
MsgTypeLink = "link"
|
||||
// MsgTypeMiniProgramPage 小程序卡片
|
||||
MsgTypeMiniProgramPage = "miniprogrampage"
|
||||
// MsgTypeEvent 事件
|
||||
MsgTypeEvent MsgType = "event"
|
||||
// DataTypeXML XML 格式数据
|
||||
DataTypeXML = "xml"
|
||||
// DataTypeJSON JSON 格式数据
|
||||
DataTypeJSON = "json"
|
||||
)
|
||||
|
||||
// CommonToken 消息中通用的结构
|
||||
|
||||
@@ -28,7 +28,7 @@ type MediaText struct {
|
||||
Content string `json:"content"`
|
||||
}
|
||||
|
||||
// MediaResource 消息使用的临时素材id
|
||||
// MediaResource 消息使用的临时素材 id
|
||||
type MediaResource struct {
|
||||
MediaID string `json:"media_id"`
|
||||
}
|
||||
@@ -51,7 +51,7 @@ type MediaLink struct {
|
||||
|
||||
// CustomerMessage 客服消息
|
||||
type CustomerMessage struct {
|
||||
ToUser string `json:"touser"` // 接受者OpenID
|
||||
ToUser string `json:"touser"` // 接受者 OpenID
|
||||
Msgtype MsgType `json:"msgtype"` // 客服消息类型
|
||||
Text *MediaText `json:"text,omitempty"` // 可选
|
||||
Image *MediaResource `json:"image,omitempty"` // 可选
|
||||
|
||||
579
miniprogram/message/message.go
Normal file
579
miniprogram/message/message.go
Normal file
@@ -0,0 +1,579 @@
|
||||
package message
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"encoding/xml"
|
||||
"errors"
|
||||
"io"
|
||||
"net/http"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"github.com/tidwall/gjson"
|
||||
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/security"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
// ConfirmReceiveMethod 确认收货方式
|
||||
type ConfirmReceiveMethod int8
|
||||
|
||||
const (
|
||||
// EventTypeTradeManageRemindAccessAPI 提醒接入发货信息管理服务 API
|
||||
// 小程序完成账期授权时/小程序产生第一笔交易时/已产生交易但从未发货的小程序,每天一次
|
||||
EventTypeTradeManageRemindAccessAPI EventType = "trade_manage_remind_access_api"
|
||||
// EventTypeTradeManageRemindShipping 提醒需要上传发货信息
|
||||
// 曾经发过货的小程序,订单超过 48 小时未发货时
|
||||
EventTypeTradeManageRemindShipping EventType = "trade_manage_remind_shipping"
|
||||
// EventTypeTradeManageOrderSettlement 订单将要结算或已经结算
|
||||
// 订单完成发货时/订单结算时
|
||||
EventTypeTradeManageOrderSettlement EventType = "trade_manage_order_settlement"
|
||||
// EventTypeAddExpressPath 运单轨迹更新事件
|
||||
EventTypeAddExpressPath EventType = "add_express_path"
|
||||
// EventTypeSecvodUpload 短剧媒资上传完成事件
|
||||
EventTypeSecvodUpload EventType = "secvod_upload_event"
|
||||
// EventTypeSecvodAudit 短剧媒资审核状态事件
|
||||
EventTypeSecvodAudit EventType = "secvod_audit_event"
|
||||
// EventTypeWxaMediaCheck 媒体内容安全异步审查结果通知
|
||||
EventTypeWxaMediaCheck EventType = "wxa_media_check"
|
||||
// EventTypeXpayGoodsDeliverNotify 道具发货推送事件
|
||||
EventTypeXpayGoodsDeliverNotify EventType = "xpay_goods_deliver_notify"
|
||||
// EventTypeXpayCoinPayNotify 代币支付推送事件
|
||||
EventTypeXpayCoinPayNotify EventType = "xpay_coin_pay_notify"
|
||||
// EventSubscribePopup 用户操作订阅通知弹窗事件推送,用户在图文等场景内订阅通知的操作
|
||||
EventSubscribePopup EventType = "subscribe_msg_popup_event"
|
||||
// EventSubscribeMsgChange 用户管理订阅通知,用户在服务通知管理页面做通知管理时的操作
|
||||
EventSubscribeMsgChange EventType = "subscribe_msg_change_event"
|
||||
// EventSubscribeMsgSent 发送订阅通知,调用 bizsend 接口发送通知
|
||||
EventSubscribeMsgSent EventType = "subscribe_msg_sent_event"
|
||||
// ConfirmReceiveMethodAuto 自动确认收货
|
||||
ConfirmReceiveMethodAuto ConfirmReceiveMethod = 1
|
||||
// ConfirmReceiveMethodManual 手动确认收货
|
||||
ConfirmReceiveMethodManual ConfirmReceiveMethod = 2
|
||||
)
|
||||
|
||||
const (
|
||||
// InfoTypeAcceptSubscribeMessage 接受订阅通知
|
||||
InfoTypeAcceptSubscribeMessage InfoType = "accept"
|
||||
// InfoTypeRejectSubscribeMessage 拒绝订阅通知
|
||||
InfoTypeRejectSubscribeMessage InfoType = "reject"
|
||||
)
|
||||
|
||||
// PushReceiver 接收消息推送
|
||||
// 暂仅支付 Aes 加密方式
|
||||
type PushReceiver struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewPushReceiver 实例化
|
||||
func NewPushReceiver(ctx *context.Context) *PushReceiver {
|
||||
return &PushReceiver{
|
||||
Context: ctx,
|
||||
}
|
||||
}
|
||||
|
||||
// GetMsg 获取接收到的消息 (如果是加密的返回解密数据)
|
||||
func (receiver *PushReceiver) GetMsg(r *http.Request) (string, []byte, error) {
|
||||
// 判断请求格式
|
||||
var dataType string
|
||||
contentType := r.Header.Get("Content-Type")
|
||||
if strings.HasPrefix(contentType, "text/xml") {
|
||||
// xml 格式
|
||||
dataType = DataTypeXML
|
||||
} else {
|
||||
// json 格式
|
||||
dataType = DataTypeJSON
|
||||
}
|
||||
|
||||
// 读取参数,验证签名
|
||||
signature := r.FormValue("signature")
|
||||
timestamp := r.FormValue("timestamp")
|
||||
nonce := r.FormValue("nonce")
|
||||
encryptType := r.FormValue("encrypt_type")
|
||||
// 验证签名
|
||||
tmpArr := []string{
|
||||
receiver.Token,
|
||||
timestamp,
|
||||
nonce,
|
||||
}
|
||||
sort.Strings(tmpArr)
|
||||
tmpSignature := util.Signature(tmpArr...)
|
||||
if tmpSignature != signature {
|
||||
return dataType, nil, errors.New("signature error")
|
||||
}
|
||||
|
||||
if encryptType == "aes" {
|
||||
// 解密
|
||||
var reqData DataReceived
|
||||
if dataType == DataTypeXML {
|
||||
if err := xml.NewDecoder(r.Body).Decode(&reqData); err != nil {
|
||||
return dataType, nil, err
|
||||
}
|
||||
} else {
|
||||
if err := json.NewDecoder(r.Body).Decode(&reqData); err != nil {
|
||||
return dataType, nil, err
|
||||
}
|
||||
}
|
||||
_, rawMsgBytes, err := util.DecryptMsg(receiver.AppID, reqData.Encrypt, receiver.EncodingAESKey)
|
||||
return dataType, rawMsgBytes, err
|
||||
}
|
||||
// 不加密
|
||||
byteData, err := io.ReadAll(r.Body)
|
||||
return dataType, byteData, err
|
||||
}
|
||||
|
||||
// GetMsgData 获取接收到的消息 (解密数据)
|
||||
func (receiver *PushReceiver) GetMsgData(r *http.Request) (MsgType, EventType, PushData, error) {
|
||||
dataType, decryptMsg, err := receiver.GetMsg(r)
|
||||
if err != nil {
|
||||
return "", "", nil, err
|
||||
}
|
||||
var (
|
||||
msgType MsgType
|
||||
eventType EventType
|
||||
)
|
||||
if dataType == DataTypeXML {
|
||||
var commonToken CommonPushData
|
||||
if err := xml.Unmarshal(decryptMsg, &commonToken); err != nil {
|
||||
return "", "", nil, err
|
||||
}
|
||||
msgType, eventType = commonToken.MsgType, commonToken.Event
|
||||
} else {
|
||||
var commonToken CommonPushData
|
||||
if err := json.Unmarshal(decryptMsg, &commonToken); err != nil {
|
||||
return "", "", nil, err
|
||||
}
|
||||
msgType, eventType = commonToken.MsgType, commonToken.Event
|
||||
}
|
||||
if msgType == MsgTypeEvent {
|
||||
pushData, err := receiver.getEvent(dataType, eventType, decryptMsg)
|
||||
// 暂不支持其他事件类型
|
||||
return msgType, eventType, pushData, err
|
||||
}
|
||||
// 暂不支持其他消息类型
|
||||
return msgType, eventType, decryptMsg, nil
|
||||
}
|
||||
|
||||
// getEvent 获取事件推送的数据
|
||||
func (receiver *PushReceiver) getEvent(dataType string, eventType EventType, decryptMsg []byte) (PushData, error) {
|
||||
switch eventType {
|
||||
case EventTypeTradeManageRemindAccessAPI:
|
||||
// 提醒接入发货信息管理服务 API
|
||||
var pushData PushDataRemindAccessAPI
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventTypeTradeManageRemindShipping:
|
||||
// 提醒需要上传发货信息
|
||||
var pushData PushDataRemindShipping
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventTypeTradeManageOrderSettlement:
|
||||
// 订单将要结算或已经结算
|
||||
var pushData PushDataOrderSettlement
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventTypeWxaMediaCheck:
|
||||
// 媒体内容安全异步审查结果通知
|
||||
var pushData MediaCheckAsyncData
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventTypeAddExpressPath:
|
||||
// 运单轨迹更新
|
||||
var pushData PushDataAddExpressPath
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventTypeSecvodUpload:
|
||||
// 短剧媒资上传完成
|
||||
var pushData PushDataSecVodUpload
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventTypeSecvodAudit:
|
||||
// 短剧媒资审核状态
|
||||
var pushData PushDataSecVodAudit
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventTypeXpayGoodsDeliverNotify:
|
||||
// 道具发货推送事件
|
||||
var pushData PushDataXpayGoodsDeliverNotify
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventTypeXpayCoinPayNotify:
|
||||
// 代币支付推送事件
|
||||
var pushData PushDataXpayCoinPayNotify
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventSubscribePopup:
|
||||
// 用户操作订阅通知弹窗事件推送
|
||||
return receiver.unmarshalSubscribePopup(dataType, decryptMsg)
|
||||
case EventSubscribeMsgChange:
|
||||
// 用户管理订阅通知事件推送
|
||||
return receiver.unmarshalSubscribeMsgChange(dataType, decryptMsg)
|
||||
case EventSubscribeMsgSent:
|
||||
// 用户发送订阅通知事件推送
|
||||
return receiver.unmarshalSubscribeMsgSent(dataType, decryptMsg)
|
||||
}
|
||||
// 暂不支持其他事件类型,直接返回解密后的数据,由调用方处理
|
||||
return decryptMsg, nil
|
||||
}
|
||||
|
||||
// unmarshal 解析推送的数据
|
||||
func (receiver *PushReceiver) unmarshal(dataType string, decryptMsg []byte, pushData interface{}) error {
|
||||
if dataType == DataTypeXML {
|
||||
return xml.Unmarshal(decryptMsg, pushData)
|
||||
}
|
||||
return json.Unmarshal(decryptMsg, pushData)
|
||||
}
|
||||
|
||||
// unmarshalSubscribePopup
|
||||
func (receiver *PushReceiver) unmarshalSubscribePopup(dataType string, decryptMsg []byte) (PushData, error) {
|
||||
var pushData PushDataSubscribePopup
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
if err == nil {
|
||||
listData := gjson.Get(string(decryptMsg), "List")
|
||||
if listData.IsObject() {
|
||||
listItem := SubscribeMsgPopupEventList{}
|
||||
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItem); parseErr != nil {
|
||||
return &pushData, parseErr
|
||||
}
|
||||
pushData.SetSubscribeMsgPopupEvents([]SubscribeMsgPopupEventList{listItem})
|
||||
} else if listData.IsArray() {
|
||||
listItems := make([]SubscribeMsgPopupEventList, 0)
|
||||
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItems); parseErr != nil {
|
||||
return &pushData, parseErr
|
||||
}
|
||||
pushData.SetSubscribeMsgPopupEvents(listItems)
|
||||
}
|
||||
}
|
||||
|
||||
return &pushData, err
|
||||
}
|
||||
|
||||
// unmarshalSubscribeMsgChange 解析用户管理订阅通知事件推送
|
||||
func (receiver *PushReceiver) unmarshalSubscribeMsgChange(dataType string, decryptMsg []byte) (PushData, error) {
|
||||
var pushData PushDataSubscribeMsgChange
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
if err == nil {
|
||||
listData := gjson.Get(string(decryptMsg), "List")
|
||||
if listData.IsObject() {
|
||||
listItem := SubscribeMsgChangeList{}
|
||||
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItem); parseErr != nil {
|
||||
return &pushData, parseErr
|
||||
}
|
||||
pushData.SetSubscribeMsgChangeEvents([]SubscribeMsgChangeList{listItem})
|
||||
} else if listData.IsArray() {
|
||||
listItems := make([]SubscribeMsgChangeList, 0)
|
||||
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItems); parseErr != nil {
|
||||
return &pushData, parseErr
|
||||
}
|
||||
pushData.SetSubscribeMsgChangeEvents(listItems)
|
||||
}
|
||||
}
|
||||
return &pushData, err
|
||||
}
|
||||
|
||||
// unmarshalSubscribeMsgSent 解析用户发送订阅通知事件推送
|
||||
func (receiver *PushReceiver) unmarshalSubscribeMsgSent(dataType string, decryptMsg []byte) (PushData, error) {
|
||||
var pushData PushDataSubscribeMsgSent
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
if err == nil {
|
||||
listData := gjson.Get(string(decryptMsg), "List")
|
||||
if listData.IsObject() {
|
||||
listItem := SubscribeMsgSentList{}
|
||||
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItem); parseErr != nil {
|
||||
return &pushData, parseErr
|
||||
}
|
||||
pushData.SetSubscribeMsgSentEvents([]SubscribeMsgSentList{listItem})
|
||||
} else if listData.IsArray() {
|
||||
listItems := make([]SubscribeMsgSentList, 0)
|
||||
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItems); parseErr != nil {
|
||||
return &pushData, parseErr
|
||||
}
|
||||
pushData.SetSubscribeMsgSentEvents(listItems)
|
||||
}
|
||||
}
|
||||
return &pushData, err
|
||||
}
|
||||
|
||||
// DataReceived 接收到的数据
|
||||
type DataReceived struct {
|
||||
Encrypt string `json:"Encrypt" xml:"Encrypt"` // 加密的消息体
|
||||
}
|
||||
|
||||
// PushData 推送的数据 (已转对应的结构体)
|
||||
type PushData interface{}
|
||||
|
||||
// CommonPushData 推送数据通用部分
|
||||
type CommonPushData struct {
|
||||
XMLName xml.Name `json:"-" xml:"xml"`
|
||||
MsgType MsgType `json:"MsgType" xml:"MsgType"` // 消息类型,为固定值 "event"
|
||||
Event EventType `json:"Event" xml:"Event"` // 事件类型
|
||||
ToUserName string `json:"ToUserName" xml:"ToUserName"` // 小程序的原始 ID
|
||||
FromUserName string `json:"FromUserName" xml:"FromUserName"` // 发送方账号(一个 OpenID,此时发送方是系统账号)
|
||||
CreateTime int64 `json:"CreateTime" xml:"CreateTime"` // 消息创建时间(整型),时间戳
|
||||
}
|
||||
|
||||
// MediaCheckAsyncData 媒体内容安全异步审查结果通知
|
||||
type MediaCheckAsyncData struct {
|
||||
CommonPushData
|
||||
Appid string `json:"appid" xml:"appid"`
|
||||
TraceID string `json:"trace_id" xml:"trace_id"`
|
||||
Version int `json:"version" xml:"version"`
|
||||
Detail []*MediaCheckDetail `json:"detail" xml:"detail"`
|
||||
Errcode int `json:"errcode" xml:"errcode"`
|
||||
Errmsg string `json:"errmsg" xml:"errmsg"`
|
||||
Result MediaCheckAsyncResult `json:"result" xml:"result"`
|
||||
}
|
||||
|
||||
// MediaCheckDetail 检测结果详情
|
||||
type MediaCheckDetail struct {
|
||||
Strategy string `json:"strategy" xml:"strategy"`
|
||||
Errcode int `json:"errcode" xml:"errcode"`
|
||||
Suggest security.CheckSuggest `json:"suggest" xml:"suggest"`
|
||||
Label int `json:"label" xml:"label"`
|
||||
Prob int `json:"prob" xml:"prob"`
|
||||
}
|
||||
|
||||
// MediaCheckAsyncResult 检测结果
|
||||
type MediaCheckAsyncResult struct {
|
||||
Suggest security.CheckSuggest `json:"suggest" xml:"suggest"`
|
||||
Label security.CheckLabel `json:"label" xml:"label"`
|
||||
}
|
||||
|
||||
// PushDataOrderSettlement 订单将要结算或已经结算通知
|
||||
type PushDataOrderSettlement struct {
|
||||
CommonPushData
|
||||
TransactionID string `json:"transaction_id" xml:"transaction_id"` // 支付订单号
|
||||
MerchantID string `json:"merchant_id" xml:"merchant_id"` // 商户号
|
||||
SubMerchantID string `json:"sub_merchant_id" xml:"sub_merchant_id"` // 子商户号
|
||||
MerchantTradeNo string `json:"merchant_trade_no" xml:"merchant_trade_no"` // 商户订单号
|
||||
PayTime int64 `json:"pay_time" xml:"pay_time"` // 支付成功时间,秒级时间戳
|
||||
ShippedTime int64 `json:"shipped_time" xml:"shipped_time"` // 发货时间,秒级时间戳
|
||||
EstimatedSettlementTime int64 `json:"estimated_settlement_time" xml:"estimated_settlement_time"` // 预计结算时间,秒级时间戳。发货时推送才有该字段
|
||||
ConfirmReceiveMethod ConfirmReceiveMethod `json:"confirm_receive_method" xml:"confirm_receive_method"` // 确认收货方式:1. 自动确认收货;2. 手动确认收货。结算时推送才有该字段
|
||||
ConfirmReceiveTime int64 `json:"confirm_receive_time" xml:"confirm_receive_time"` // 确认收货时间,秒级时间戳。结算时推送才有该字段
|
||||
SettlementTime int64 `json:"settlement_time" xml:"settlement_time"` // 订单结算时间,秒级时间戳。结算时推送才有该字段
|
||||
}
|
||||
|
||||
// PushDataRemindShipping 提醒需要上传发货信息
|
||||
type PushDataRemindShipping struct {
|
||||
CommonPushData
|
||||
TransactionID string `json:"transaction_id" xml:"transaction_id"` // 微信支付订单号
|
||||
MerchantID string `json:"merchant_id" xml:"merchant_id"` // 商户号
|
||||
SubMerchantID string `json:"sub_merchant_id" xml:"sub_merchant_id"` // 子商户号
|
||||
MerchantTradeNo string `json:"merchant_trade_no" xml:"merchant_trade_no"` // 商户订单号
|
||||
PayTime int64 `json:"pay_time" xml:"pay_time"` // 支付成功时间,秒级时间戳
|
||||
Msg string `json:"msg" xml:"msg"` // 消息文本内容
|
||||
}
|
||||
|
||||
// PushDataRemindAccessAPI 提醒接入发货信息管理服务 API 信息
|
||||
type PushDataRemindAccessAPI struct {
|
||||
CommonPushData
|
||||
Msg string `json:"msg" xml:"msg"` // 消息文本内容
|
||||
}
|
||||
|
||||
// PushDataAddExpressPath 运单轨迹更新信息
|
||||
type PushDataAddExpressPath struct {
|
||||
CommonPushData
|
||||
DeliveryID string `json:"DeliveryID" xml:"DeliveryID"` // 快递公司 ID
|
||||
WayBillID string `json:"WaybillId" xml:"WaybillId"` // 运单 ID
|
||||
OrderID string `json:"OrderId" xml:"OrderId"` // 订单 ID
|
||||
Version int `json:"Version" xml:"Version"` // 轨迹版本号(整型)
|
||||
Count int `json:"Count" xml:"Count"` // 轨迹节点数(整型)
|
||||
Actions []*PushDataAddExpressPathAction `json:"Actions" xml:"Actions"` // 轨迹节点列表
|
||||
}
|
||||
|
||||
// PushDataAddExpressPathAction 轨迹节点
|
||||
type PushDataAddExpressPathAction struct {
|
||||
ActionTime int64 `json:"ActionTime" xml:"ActionTime"` // 轨迹节点 Unix 时间戳
|
||||
ActionType int `json:"ActionType" xml:"ActionType"` // 轨迹节点类型
|
||||
ActionMsg string `json:"ActionMsg" xml:"ActionMsg"` // 轨迹节点详情
|
||||
}
|
||||
|
||||
// PushDataSecVodUpload 短剧媒资上传完成
|
||||
type PushDataSecVodUpload struct {
|
||||
CommonPushData
|
||||
UploadEvent SecVodUploadEvent `json:"upload_event" xml:"upload_event"` // 上传完成事件
|
||||
}
|
||||
|
||||
// SecVodUploadEvent 短剧媒资上传完成事件
|
||||
type SecVodUploadEvent struct {
|
||||
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"` // 错误提示
|
||||
}
|
||||
|
||||
// PushDataSecVodAudit 短剧媒资审核状态
|
||||
type PushDataSecVodAudit struct {
|
||||
CommonPushData
|
||||
AuditEvent SecVodAuditEvent `json:"audit_event" xml:"audit_event"` // 审核状态事件
|
||||
}
|
||||
|
||||
// SecVodAuditEvent 短剧媒资审核状态事件
|
||||
type SecVodAuditEvent struct {
|
||||
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 查询剧集详情得到
|
||||
}
|
||||
|
||||
// DramaAuditDetail 剧目审核结果
|
||||
type DramaAuditDetail struct {
|
||||
Status int `json:"status" xml:"status"` // 审核状态,0 为无效值;1 为审核中;2 为最终失败;3 为审核通过;4 为驳回重填
|
||||
CreateTime int64 `json:"create_time" xml:"create_time"` // 提审时间戳
|
||||
AuditTime int64 `json:"audit_time" xml:"audit_time"` // 审核时间戳
|
||||
}
|
||||
|
||||
// PushDataXpayGoodsDeliverNotify 道具发货推送
|
||||
type PushDataXpayGoodsDeliverNotify struct {
|
||||
CommonPushData
|
||||
OpenID string `json:"OpenId" xml:"OpenId"` // 用户 openid
|
||||
OutTradeNo string `json:"OutTradeNo" xml:"OutTradeNo"` // 业务订单号
|
||||
Env int `json:"Env" xml:"Env"` // ,环境配置 0:现网环境(也叫正式环境)1:沙箱环境
|
||||
WeChatPayInfo WeChatPayInfo `json:"WeChatPayInfo" xml:"WeChatPayInfo"` // 微信支付信息 非微信支付渠道可能没有
|
||||
GoodsInfo GoodsInfo `json:"GoodsInfo" xml:"GoodsInfo"` // 道具参数信息
|
||||
}
|
||||
|
||||
// WeChatPayInfo 微信支付信息
|
||||
type WeChatPayInfo struct {
|
||||
MchOrderNo string `json:"MchOrderNo" xml:"MchOrderNo"` // 微信支付商户单号
|
||||
TransactionID string `json:"TransactionId" xml:"TransactionId"` // 交易单号(微信支付订单号)
|
||||
PaidTime int64 `json:"PaidTime" xml:"PaidTime"` // 用户支付时间,Linux 秒级时间戳
|
||||
}
|
||||
|
||||
// GoodsInfo 道具参数信息
|
||||
type GoodsInfo struct {
|
||||
ProductID string `json:"ProductId" xml:"ProductId"` // 道具 ID
|
||||
Quantity int `json:"Quantity" xml:"Quantity"` // 数量
|
||||
OrigPrice int64 `json:"OrigPrice" xml:"OrigPrice"` // 物品原始价格(单位:分)
|
||||
ActualPrice int64 `json:"ActualPrice" xml:"ActualPrice"` // 物品实际支付价格(单位:分)
|
||||
Attach string `json:"Attach" xml:"Attach"` // 透传信息
|
||||
}
|
||||
|
||||
// PushDataXpayCoinPayNotify 代币支付推送
|
||||
type PushDataXpayCoinPayNotify struct {
|
||||
CommonPushData
|
||||
OpenID string `json:"OpenId" xml:"OpenId"` // 用户 openid
|
||||
OutTradeNo string `json:"OutTradeNo" xml:"OutTradeNo"` // 业务订单号
|
||||
Env int `json:"Env" xml:"Env"` // ,环境配置 0:现网环境(也叫正式环境)1:沙箱环境
|
||||
WeChatPayInfo WeChatPayInfo `json:"WeChatPayInfo" xml:"WeChatPayInfo"` // 微信支付信息 非微信支付渠道可能没有
|
||||
CoinInfo CoinInfo `json:"CoinInfo" xml:"CoinInfo"` // 代币参数信息
|
||||
}
|
||||
|
||||
// CoinInfo 代币参数信息
|
||||
type CoinInfo struct {
|
||||
Quantity int `json:"Quantity" xml:"Quantity"` // 数量
|
||||
OrigPrice int64 `json:"OrigPrice" xml:"OrigPrice"` // 物品原始价格(单位:分)
|
||||
ActualPrice int64 `json:"ActualPrice" xml:"ActualPrice"` // 物品实际支付价格(单位:分)
|
||||
Attach string `json:"Attach" xml:"Attach"` // 透传信息
|
||||
}
|
||||
|
||||
// PushDataSubscribePopup 用户操作订阅通知弹窗事件推送
|
||||
type PushDataSubscribePopup struct {
|
||||
CommonPushData
|
||||
subscribeMsgPopupEventList []SubscribeMsgPopupEventList `json:"-"`
|
||||
SubscribeMsgPopupEvent SubscribeMsgPopupEvent `xml:"SubscribeMsgPopupEvent"`
|
||||
}
|
||||
|
||||
// SubscribeMsgPopupEvent 用户操作订阅通知弹窗消息回调
|
||||
type SubscribeMsgPopupEvent struct {
|
||||
List []SubscribeMsgPopupEventList `xml:"List"`
|
||||
}
|
||||
|
||||
// SubscribeMsgPopupEventList 订阅消息事件列表
|
||||
type SubscribeMsgPopupEventList struct {
|
||||
TemplateID string `xml:"TemplateId" json:"TemplateId"`
|
||||
SubscribeStatusString string `xml:"SubscribeStatusString" json:"SubscribeStatusString"`
|
||||
PopupScene string `xml:"PopupScene" json:"PopupScene"`
|
||||
}
|
||||
|
||||
// SetSubscribeMsgPopupEvents 设置订阅消息事件
|
||||
func (s *PushDataSubscribePopup) SetSubscribeMsgPopupEvents(list []SubscribeMsgPopupEventList) {
|
||||
s.subscribeMsgPopupEventList = list
|
||||
}
|
||||
|
||||
// GetSubscribeMsgPopupEvents 获取订阅消息事件数据
|
||||
func (s *PushDataSubscribePopup) GetSubscribeMsgPopupEvents() []SubscribeMsgPopupEventList {
|
||||
if s.subscribeMsgPopupEventList != nil {
|
||||
return s.subscribeMsgPopupEventList
|
||||
}
|
||||
|
||||
if s.SubscribeMsgPopupEvent.List == nil || len(s.SubscribeMsgPopupEvent.List) < 1 {
|
||||
return nil
|
||||
}
|
||||
return s.SubscribeMsgPopupEvent.List
|
||||
}
|
||||
|
||||
// PushDataSubscribeMsgChange 用户管理订阅通知事件推送
|
||||
type PushDataSubscribeMsgChange struct {
|
||||
CommonPushData
|
||||
SubscribeMsgChangeEvent SubscribeMsgChangeEvent `xml:"SubscribeMsgChangeEvent"`
|
||||
subscribeMsgChangeList []SubscribeMsgChangeList `json:"-"`
|
||||
}
|
||||
|
||||
// SubscribeMsgChangeEvent 用户管理订阅通知回调
|
||||
type SubscribeMsgChangeEvent struct {
|
||||
List []SubscribeMsgChangeList `xml:"List" json:"List"`
|
||||
}
|
||||
|
||||
// SubscribeMsgChangeList 订阅消息事件列表
|
||||
type SubscribeMsgChangeList struct {
|
||||
TemplateID string `xml:"TemplateId" json:"TemplateId"`
|
||||
SubscribeStatusString string `xml:"SubscribeStatusString" json:"SubscribeStatusString"`
|
||||
}
|
||||
|
||||
// SetSubscribeMsgChangeEvents 设置订阅消息事件
|
||||
func (s *PushDataSubscribeMsgChange) SetSubscribeMsgChangeEvents(list []SubscribeMsgChangeList) {
|
||||
s.subscribeMsgChangeList = list
|
||||
}
|
||||
|
||||
// GetSubscribeMsgChangeEvents 获取订阅消息事件数据
|
||||
func (s *PushDataSubscribeMsgChange) GetSubscribeMsgChangeEvents() []SubscribeMsgChangeList {
|
||||
if s.subscribeMsgChangeList != nil {
|
||||
return s.subscribeMsgChangeList
|
||||
}
|
||||
|
||||
if s.SubscribeMsgChangeEvent.List == nil || len(s.SubscribeMsgChangeEvent.List) < 1 {
|
||||
return nil
|
||||
}
|
||||
|
||||
return s.SubscribeMsgChangeEvent.List
|
||||
}
|
||||
|
||||
// PushDataSubscribeMsgSent 用户发送订阅通知事件推送
|
||||
type PushDataSubscribeMsgSent struct {
|
||||
CommonPushData
|
||||
SubscribeMsgSentEvent SubscribeMsgSentEvent `xml:"SubscribeMsgSentEvent"`
|
||||
subscribeMsgSentEventList []SubscribeMsgSentList `json:"-"`
|
||||
}
|
||||
|
||||
// SubscribeMsgSentEvent 用户发送订阅通知回调
|
||||
type SubscribeMsgSentEvent struct {
|
||||
List []SubscribeMsgSentList `xml:"List" json:"List"`
|
||||
}
|
||||
|
||||
// SubscribeMsgSentList 订阅消息事件列表
|
||||
type SubscribeMsgSentList struct {
|
||||
TemplateID string `xml:"TemplateId" json:"TemplateId"`
|
||||
MsgID string `xml:"MsgID" json:"MsgID"`
|
||||
ErrorCode int `xml:"ErrorCode" json:"ErrorCode"`
|
||||
ErrorStatus string `xml:"ErrorStatus" json:"ErrorStatus"`
|
||||
}
|
||||
|
||||
// SetSubscribeMsgSentEvents 设置订阅消息事件
|
||||
func (s *PushDataSubscribeMsgSent) SetSubscribeMsgSentEvents(list []SubscribeMsgSentList) {
|
||||
s.subscribeMsgSentEventList = list
|
||||
}
|
||||
|
||||
// GetSubscribeMsgSentEvents 获取订阅消息事件数据
|
||||
func (s *PushDataSubscribeMsgSent) GetSubscribeMsgSentEvents() []SubscribeMsgSentList {
|
||||
if s.subscribeMsgSentEventList != nil {
|
||||
return s.subscribeMsgSentEventList
|
||||
}
|
||||
|
||||
if s.SubscribeMsgSentEvent.List == nil || len(s.SubscribeMsgSentEvent.List) < 1 {
|
||||
return nil
|
||||
}
|
||||
|
||||
return s.SubscribeMsgSentEvent.List
|
||||
}
|
||||
15
miniprogram/message/reply.go
Normal file
15
miniprogram/message/reply.go
Normal file
@@ -0,0 +1,15 @@
|
||||
package message
|
||||
|
||||
import "errors"
|
||||
|
||||
// ErrInvalidReply 无效的回复
|
||||
var ErrInvalidReply = errors.New("无效的回复信息")
|
||||
|
||||
// ErrUnsupportedReply 不支持的回复类型
|
||||
var ErrUnsupportedReply = errors.New("不支持的回复消息")
|
||||
|
||||
// Reply 消息回复
|
||||
type Reply struct {
|
||||
MsgType MsgType
|
||||
MsgData interface{}
|
||||
}
|
||||
102
miniprogram/message/updatable_msg.go
Normal file
102
miniprogram/message/updatable_msg.go
Normal 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"`
|
||||
}
|
||||
100
miniprogram/minidrama/constant.go
Normal file
100
miniprogram/minidrama/constant.go
Normal file
@@ -0,0 +1,100 @@
|
||||
/*
|
||||
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
* You can obtain one at https://github.com/silenceper/wechat.
|
||||
*
|
||||
*/
|
||||
|
||||
package minidrama
|
||||
|
||||
const (
|
||||
// Success 错误码 0、成功
|
||||
Success ErrCode = 0
|
||||
// SystemError 错误码 -1、系统错误
|
||||
SystemError ErrCode = -1
|
||||
// InitError 错误码 -2 初始化未完成,请稍后再试
|
||||
InitError ErrCode = -2
|
||||
// FormatError 错误码 47001 输入格式错误
|
||||
FormatError ErrCode = 47001
|
||||
// ParamError 错误码 47003 参数不符合要求
|
||||
ParamError ErrCode = 47003
|
||||
// PostError 错误码 44002 POST 内容为空
|
||||
PostError ErrCode = 44002
|
||||
// MethodError 错误码 43002 HTTP 请求必须使用 POST 方法
|
||||
MethodError ErrCode = 43002
|
||||
// VideoTypeError 错误码 10090001 视频类型不支持
|
||||
VideoTypeError ErrCode = 10090001
|
||||
// ImageTypeError 错误码 10090002 图片类型不支持
|
||||
ImageTypeError ErrCode = 10090002
|
||||
// ImageURLError 错误码 10090003 图片 URL 无效
|
||||
ImageURLError ErrCode = 10090003
|
||||
// ResourceType 错误码 10090005 resource_type 无效
|
||||
ResourceType ErrCode = 10090005
|
||||
// OperationError 错误码 10093011 操作失败
|
||||
OperationError ErrCode = 10093011
|
||||
// ParamError2 错误码 10093014 参数错误(包括参数格式、类型等错误)
|
||||
ParamError2 ErrCode = 10093014
|
||||
// OperationFrequentError 错误码 10093023 操作过于频繁
|
||||
OperationFrequentError ErrCode = 10093023
|
||||
// ResourceNotExistError 错误码 10093030 资源不存在
|
||||
ResourceNotExistError ErrCode = 10093030
|
||||
)
|
||||
|
||||
const (
|
||||
// singleFileUpload 单个文件上传,上传媒体(和封面)文件,上传小文件(小于 10MB)时使用。上传大文件请使用分片上传接口。
|
||||
singleFileUpload = "https://api.weixin.qq.com/wxa/sec/vod/singlefileupload?access_token="
|
||||
|
||||
// pullUpload 拉取上传,该接口用于将一个网络上的视频拉取上传到平台。
|
||||
pullUpload = "https://api.weixin.qq.com/wxa/sec/vod/pullupload?access_token="
|
||||
|
||||
// getTask 查询任务,该接口用于查询拉取上传的任务状态。
|
||||
getTask = "https://api.weixin.qq.com/wxa/sec/vod/gettask?access_token="
|
||||
|
||||
// applyUpload 申请分片上传
|
||||
applyUpload = "https://api.weixin.qq.com/wxa/sec/vod/applyupload?access_token="
|
||||
|
||||
// uploadPart 上传分片
|
||||
uploadPart = "https://api.weixin.qq.com/wxa/sec/vod/uploadpart?access_token="
|
||||
|
||||
// commitUpload 确认上传,该接口用于完成整个分片上传流程,合并所有文件分片,确认媒体文件(和封面图片文件)上传到平台的结果,返回文件的 ID。请求中需要给出每一个分片的 part_number 和 etag,用来校验分片的准确性。
|
||||
commitUpload = "https://api.weixin.qq.com/wxa/sec/vod/commitupload?access_token="
|
||||
|
||||
// listMedia 获取媒体列表
|
||||
listMedia = "https://api.weixin.qq.com/wxa/sec/vod/listmedia?access_token="
|
||||
|
||||
// getMedia 获取媒资详细信息,该接口用于获取已上传到平台的指定媒资信息,用于开发者后台管理使用。用于给用户客户端播放的链接应该使用 getmedialink 接口获取。
|
||||
getMedia = "https://api.weixin.qq.com/wxa/sec/vod/getmedia?access_token="
|
||||
|
||||
// getMediaLink 获取媒资播放链接,该接口用于获取视频临时播放链接,用于给用户的播放使用。只有审核通过的视频才能通过该接口获取播放链接。
|
||||
getMediaLink = "https://api.weixin.qq.com/wxa/sec/vod/getmedialink?access_token="
|
||||
|
||||
// deleteMedia 删除媒体,该接口用于删除指定媒资。
|
||||
deleteMedia = "https://api.weixin.qq.com/wxa/sec/vod/deletemedia?access_token="
|
||||
|
||||
// auditDrama 审核剧本
|
||||
auditDrama = "https://api.weixin.qq.com/wxa/sec/vod/auditdrama?access_token="
|
||||
|
||||
// listDramas 获取剧目列表
|
||||
listDramas = "https://api.weixin.qq.com/wxa/sec/vod/listdramas?access_token="
|
||||
|
||||
// getDrama 获取剧目信息,该接口用于查询已提交的剧目。
|
||||
getDrama = "https://api.weixin.qq.com/wxa/sec/vod/getdrama?access_token="
|
||||
|
||||
// getCdnUsageData 查询 CDN 用量数据,该接口用于查询点播 CDN 的流量数据。
|
||||
getCdnUsageData = "https://api.weixin.qq.com/wxa/sec/vod/getcdnusagedata?access_token="
|
||||
|
||||
// getCdnLogs 查询 CDN 日志,该接口用于查询点播 CDN 的日志。
|
||||
getCdnLogs = "https://api.weixin.qq.com/wxa/sec/vod/getcdnlogs?access_token="
|
||||
)
|
||||
32
miniprogram/minidrama/doc.go
Normal file
32
miniprogram/minidrama/doc.go
Normal file
@@ -0,0 +1,32 @@
|
||||
/*
|
||||
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
* You can obtain one at https://github.com/silenceper/wechat.
|
||||
*
|
||||
*/
|
||||
|
||||
// Package minidrama Mini Program entertainment mini-drama related interface
|
||||
package minidrama
|
||||
|
||||
import (
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
)
|
||||
|
||||
// NewMiniDrama 实例化小程序娱乐直播 API
|
||||
func NewMiniDrama(ctx *context.Context) *MiniDrama {
|
||||
return &MiniDrama{
|
||||
ctx: ctx,
|
||||
}
|
||||
}
|
||||
440
miniprogram/minidrama/domain.go
Normal file
440
miniprogram/minidrama/domain.go
Normal file
@@ -0,0 +1,440 @@
|
||||
/*
|
||||
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
* You can obtain one at https://github.com/silenceper/wechat.
|
||||
*
|
||||
*/
|
||||
|
||||
package minidrama
|
||||
|
||||
import (
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
// MiniDrama mini program entertainment live broadcast related
|
||||
type MiniDrama struct {
|
||||
ctx *context.Context
|
||||
}
|
||||
|
||||
// ErrCode error code
|
||||
type ErrCode int
|
||||
|
||||
// SingleFileUploadRequest 单文件上传请求
|
||||
// Content-Type 需要指定为 multipart/form-data; boundary=<delimiter>
|
||||
// <箭头括号> 表示必须替换为有效值的变量。
|
||||
// 不填写 cover_type,cover_data 字段时默认截取视频首帧作为视频封面。
|
||||
type SingleFileUploadRequest struct {
|
||||
MediaName string `json:"media_name"` // 媒体文件名称 文件名,需按照“剧目名 - 对应剧集数”格式命名文件,示例值:"我的演艺 - 第 1 集"。
|
||||
MediaType string `json:"media_type"` // 媒体文件类型 视频格式,支持:MP4,TS,MOV,MXF,MPG,FLV,WMV,AVI,M4V,F4V,MPEG,3GP,ASF,MKV,示例值:"MP4"。
|
||||
MediaData []byte `json:"media_data"` // 媒体文件数据 视频文件内容,二进制。
|
||||
CoverType string `json:"cover_type,omitempty"` // 视频封面图片格式,支持:JPG、JPEG、PNG、BMP、TIFF、AI、CDR、EPS、TIF,示例值:"JPG"。
|
||||
CoverData []byte `json:"cover_data,omitempty"` // 视频封面图片内容,二进制。
|
||||
SourceContext string `json:"source_context,omitempty"` // 来源上下文,会在上传完成事件中透传给开发者。
|
||||
}
|
||||
|
||||
// SingleFileUploadResponse 单文件上传响应
|
||||
type SingleFileUploadResponse struct {
|
||||
util.CommonError
|
||||
MediaID int64 `json:"media_id"` // 媒体文件唯一标识,用于发布视频。
|
||||
}
|
||||
|
||||
// PullUploadRequest 拉取上传请求
|
||||
// 不填写 cover_url 字段时默认截取视频首帧作为封面。
|
||||
// Content-Type 需要指定为 application/json
|
||||
// 该接口为异步接口,上传完成会推送上传完成事件到开发者服务器,开发者也可以调用"查询任务"接口来轮询上传结果。
|
||||
type PullUploadRequest struct {
|
||||
MediaName string `json:"media_name"` // 媒体文件名称 文件名,需按照“剧目名 - 对应剧集数”格式命名文件,示例值:"我的演艺 - 第 1 集"。
|
||||
MediaURL string `json:"media_url"` // 视频 URL,示例值:"https://developers.weixin.qq.com/test.mp4"。
|
||||
CoverURL string `json:"cover_url,omitempty"` // 视频封面 URL,示例值:"https://developers.weixin.qq.com/test.jpg"。
|
||||
SourceContext string `json:"source_context,omitempty"` // 来源上下文,会在上传完成事件中透传给开发者。
|
||||
}
|
||||
|
||||
// PullUploadResponse 拉取上传响应
|
||||
type PullUploadResponse struct {
|
||||
util.CommonError
|
||||
TaskID int64 `json:"task_id"` // 任务 ID,用于查询拉取上传任务的结果。
|
||||
}
|
||||
|
||||
// GetTaskRequest 查询任务请求
|
||||
// 该接口用于查询拉取上传的任务状态。
|
||||
// Content-Type 需要指定为 application/json。
|
||||
type GetTaskRequest struct {
|
||||
TaskID int64 `json:"task_id"` // 任务 ID,用于查询拉取上传任务的结果。
|
||||
}
|
||||
|
||||
// GetTaskResponse 查询任务响应
|
||||
type GetTaskResponse struct {
|
||||
util.CommonError
|
||||
TaskInfo TaskInfo `json:"task_info"` // 任务信息。
|
||||
}
|
||||
|
||||
// TaskInfo 任务信息
|
||||
type TaskInfo struct {
|
||||
ID int64 `json:"id"` // 任务 ID。
|
||||
TaskType int `json:"task_type"` // 任务类型,1:拉取上传任务。
|
||||
Status int `json:"status"` // 任务状态枚举值:1. 等待中;2. 正在处理;3. 已完成;4. 失败。
|
||||
ErrCode int `json:"errcode"` // 任务错误码,0 表示成功,其它表示失败。
|
||||
ErrMsg string `json:"errmsg"` // 任务错误原因。
|
||||
CreateTime int64 `json:"create_time"` // 任务创建时间,时间戳,单位:秒。
|
||||
FinishTime int64 `json:"finish_time"` // 任务完成时间,时间戳,单位:秒。
|
||||
MediaID int64 `json:"media_id"` // 媒体文件唯一标识,用于发布视频。
|
||||
}
|
||||
|
||||
// ApplyUploadRequest 申请上传请求
|
||||
// 上传大文件时需使用分片上传方式,分为 3 个步骤:
|
||||
//
|
||||
// 申请分片上传,确定文件名、格式类型,返回 upload_id,唯一标识本次分片上传。
|
||||
// 上传分片,多次调用上传文件分片,需要携带 part_number 和 upload_id,其中 part_number 为分片的编号,支持乱序上传。当传入 part_number 和 upload_id 都相同的时候,后发起上传请求的分片将覆盖之前的分片。
|
||||
// 确认分片上传,当上传完所有分片后,需要完成整个文件的合并。请求体中需要给出每一个分片的 part_number 和 etag,用来校验分片的准确性,最后返回文件的 media_id。
|
||||
// 如果填写了 cover_type,表明本次分片上传除上传媒体文件外还需要上传封面图片,不填写 cover_type 则默认截取视频首帧作为封面。
|
||||
// Content-Type 需要指定为 application/json。
|
||||
type ApplyUploadRequest struct {
|
||||
MediaName string `json:"media_name"` // 媒体文件名称 文件名,需按照“剧目名 - 对应剧集数”格式命名文件,示例值:"我的演艺 - 第 1 集"。
|
||||
MediaType string `json:"media_type"` // 媒体文件类型 视频格式,支持:MP4,TS,MOV,MXF,MPG,FLV,WMV,AVI,M4V,F4V,MPEG,3GP,ASF,MKV,示例值:"MP4"。
|
||||
CoverType string `json:"cover_type,omitempty"` // 视频封面图片格式,支持:JPG、JPEG、PNG、BMP、TIFF、AI、CDR、EPS、TIF,示例值:"JPG"。
|
||||
SourceContext string `json:"source_context,omitempty"` // 来源上下文,会在上传完成事件中透传给开发者。
|
||||
}
|
||||
|
||||
// ApplyUploadResponse 申请上传响应
|
||||
type ApplyUploadResponse struct {
|
||||
util.CommonError
|
||||
UploadID string `json:"upload_id"` // 本次分片上传的唯一标识。
|
||||
}
|
||||
|
||||
// UploadPartRequest 上传分片请求
|
||||
// 将文件的其中一个分片上传到平台,最多支持 100 个分片,每个分片大小为 5MB,最后一个分片可以小于 5MB。该接口适用于视频和封面图片。视频最大支持 500MB,封面图片最大支持 10MB。
|
||||
// 调用该接口之前必须先调用申请分片上传接口。
|
||||
// 在申请分片上传时,如果不填写 cover_type,则默认截取视频首帧作为封面。
|
||||
// Content-Type 需要指定为 multipart/form-data; boundary=<delimiter>,<箭头括号>表示必须替换为有效值的变量。
|
||||
// part_number 从 1 开始。如除了上传视频外还需要上传封面图片,则封面图片的 part_number 需重新从 1 开始编号。
|
||||
type UploadPartRequest struct {
|
||||
UploadID string `json:"upload_id"` // 一次分片上传的唯一标识,由申请分片上传接口返回。
|
||||
PartNumber int `json:"part_number"` // 本次上传的分片的编号,范围在 1 - 100。
|
||||
ResourceType int `json:"resource_type"` // 指定该分片属于视频还是封面图片的枚举值:1. 视频,2. 封面图片。
|
||||
Data []byte `json:"data"` // 分片内容,二进制。
|
||||
}
|
||||
|
||||
// UploadPartResponse 上传分片响应
|
||||
type UploadPartResponse struct {
|
||||
util.CommonError
|
||||
ETag string `json:"etag"` // 上传分片成功后返回的分片标识,用于后续确认分片上传接口。
|
||||
}
|
||||
|
||||
// CommitUploadRequest 确认分片上传请求
|
||||
// 该接口用于完成整个分片上传流程,合并所有文件分片,确认媒体文件(和封面图片文件)上传到平台的结果,返回文件的 ID。请求中需要给出每一个分片的 part_number 和 etag,用来校验分片的准确性。
|
||||
// 注意事项
|
||||
// Content-Type 需要指定为 application/json。
|
||||
// 调用该接口之前必须先调用申请分片上传接口以及上传分片接口。
|
||||
// 如本次分片上传除上传媒体文件外还需要上传封面图片,则请求中还需提供 cover_part_infos 字段以用于合并封面图片文件分片。
|
||||
// 请求中 media_part_infos 和 cover_part_infos 字段必须按 part_number 从小到大排序,part_number 必须从 1 开始,连续且不重复。
|
||||
type CommitUploadRequest struct {
|
||||
UploadID string `json:"upload_id"`
|
||||
MediaPartInfos []*PartInfo `json:"media_part_infos"`
|
||||
CoverPartInfos []*PartInfo `json:"cover_part_infos,omitempty"`
|
||||
}
|
||||
|
||||
// PartInfo 分片信息
|
||||
type PartInfo struct {
|
||||
PartNumber int `json:"part_number"` // 分片编号。
|
||||
Etag string `json:"etag"` // 使用上传分片接口上传成功后返回的 etag 的值
|
||||
}
|
||||
|
||||
// CommitUploadResponse 确认分片上传响应
|
||||
type CommitUploadResponse struct {
|
||||
util.CommonError
|
||||
MediaID int64 `json:"media_id"` // 媒体文件唯一标识,用于发布视频。
|
||||
}
|
||||
|
||||
// ListMediaRequest 查询媒体列表请求
|
||||
// 该接口用于查询已经上传到平台的媒体文件列表。
|
||||
// 注意事项
|
||||
// Content-Type 需要指定为 application/json。
|
||||
// 本接口返回的视频或图片链接均为临时链接,不应将其保存下来。
|
||||
// media_name 参数支持模糊匹配,当需要模糊匹配时可以在前面或后面加上 %,否则为精确匹配。例如 "test%" 可以匹配到 "test123", "testxxx", "test"。
|
||||
// 调用方式
|
||||
type ListMediaRequest struct {
|
||||
DramaID int64 `json:"drama_id,omitempty"` // 剧目 ID,可通过查询剧目列表接口获取。
|
||||
MediaName string `json:"media_name,omitempty"` // 媒体文件名称,可通过查询媒体列表接口获取,模糊匹配。
|
||||
StartTime int64 `json:"start_time,omitempty"` // 媒资上传时间>=start_time,Unix 时间戳,单位:秒。
|
||||
EndTime int64 `json:"end_time,omitempty"` // 媒资上传时间<end_time,Unix 时间戳,单位:秒。
|
||||
Limit int `json:"limit,omitempty"` // 分页拉取的最大返回结果数。默认值:100;最大值:100。
|
||||
Offset int `json:"offset,omitempty"` // 分页拉取的起始偏移量。默认值:0。
|
||||
}
|
||||
|
||||
// MediaInfo 媒体信息
|
||||
type MediaInfo struct {
|
||||
MediaID int64 `json:"media_id"` // 媒资文件 id。
|
||||
CreateTime int64 `json:"create_time"` // 上传时间,时间戳。
|
||||
ExpireTime int64 `json:"expire_time"` // 过期时间,时间戳。
|
||||
DramaID int64 `json:"drama_id"` // 所属剧目 id。
|
||||
FileSize int64 `json:"file_size"` // 媒资文件大小,单位:字节。
|
||||
Duration int64 `json:"duration"` // 播放时长,单位:秒。
|
||||
Name string `json:"name"` // 媒资文件名。
|
||||
Description string `json:"description"` // 描述。
|
||||
CoverURL string `json:"cover_url"` // 封面图临时链接。
|
||||
OriginalURL string `json:"original_url"` // 原始视频临时链接。
|
||||
Mp4URL string `json:"mp4_url"` // mp4 格式临时链接。
|
||||
HlsURL string `json:"hls_url"` // hls 格式临时链接。
|
||||
AuditDetail *MediaAuditDetail `json:"audit_detail"` // 审核信息。
|
||||
}
|
||||
|
||||
// MediaAuditDetail 媒体审核详情
|
||||
type MediaAuditDetail struct {
|
||||
Status int `json:"status"` // 审核状态 0 为无效值;1 为审核中;2 为审核驳回;3 为审核通过;4 为驳回重填。需要注意可能存在单个剧集的状态为审核通过,但是剧目整体是未通过的情况,而能不能获取播放链接取决于剧目的审核状态。
|
||||
CreateTime int `json:"create_time"` // 提审时间戳。
|
||||
AuditTime int `json:"audit_time"` // 审核时间戳。
|
||||
Reason string `json:"reason"` // 审核备注。该值可能为空。
|
||||
EvidenceMaterialIDList []string `json:"evidence_material_id_list"` // 审核证据截图 id 列表,截图 id 可以用作 get_material 接口的参数来获得截图内容。
|
||||
}
|
||||
|
||||
// ListMediaResponse 查询媒体列表响应
|
||||
type ListMediaResponse struct {
|
||||
util.CommonError
|
||||
MediaInfoList []*MediaInfo `json:"media_info_list"` // 媒体信息列表。
|
||||
}
|
||||
|
||||
// GetMediaRequest 获取媒体请求
|
||||
// 该接口用于获取已上传到平台的指定媒资信息,用于开发者后台管理使用。用于给用户客户端播放的链接应该使用 getmedialink 接口获取。
|
||||
// Content-Type 需要指定为 application/json。
|
||||
// 本接口返回的视频或图片链接均为临时链接,不应将其保存下来。
|
||||
type GetMediaRequest struct {
|
||||
MediaID int64 `json:"media_id"` // 媒资文件 id。
|
||||
}
|
||||
|
||||
// GetMediaResponse 获取媒体响应
|
||||
type GetMediaResponse struct {
|
||||
util.CommonError
|
||||
MediaInfo MediaInfo `json:"media_info"` // 媒体信息。
|
||||
}
|
||||
|
||||
// GetMediaLinkRequest 获取媒体链接请求
|
||||
// 该接口用于获取视频临时播放链接,用于给用户的播放使用。只有审核通过的视频才能通过该接口获取播放链接。
|
||||
// 注意事项
|
||||
// Content-Type 需要指定为 application/json。
|
||||
// 本接口返回的视频或图片链接均为临时链接,不应将其保存下来。
|
||||
// 能不能获取播放链接取决于剧目审核状态,可能存在单个剧集的状态为审核通过,但是剧目整体是未通过的情况,这种情况也没法获取播放链接。
|
||||
// 开发者如需区分不同渠道的播放流量或次数,可以在 us 参数中传入渠道标识,这样得到的播放链接中 us 参数的前半部分就包含有渠道标识。开发者把这个带有渠道标识的链接分发给对应的渠道播放,就能统计到不同渠道播放情况。统计的数据来源为 CDN 日志(从 getcdnlogs 接口得到),CDN 日志中“文件路径”列中的参数也带有该标识,再结合日志中“字节数”列的流量数值,估算每个渠道所消耗的流量。另需注意日志统计的流量和扣费流量的差异,详情参考 getcdnlogs 接口中的注意事项。
|
||||
type GetMediaLinkRequest struct {
|
||||
MediaID int64 `json:"media_id"` // 媒资文件 id。
|
||||
T int64 `json:"t"` // 播放地址的过期时间戳。有效的时间最长不能超过 2 小时后。
|
||||
US string `json:"us,omitempty"` // 链接标识。平台默认会生成一个仅包含小写字母和数字的字符串用于增强链接的唯一性 (如 us=647488c4792c15185b8fd2a6)。如开发者需要增加自己的标识,比如区分播放的渠道,可使用该参数,该参数最终的值是"开发者标识 - 平台标识"(如开发者传入 abcd,则最终的临时链接中 us=abcd-647488c4792c15185b8fd2a6)
|
||||
Expr int `json:"expr,omitempty"` // 试看时长,单位:秒,最大值不能超过视频长度
|
||||
RLimit int `json:"rlimit,omitempty"` // 最多允许多少个不同 IP 的终端播放,以十进制表示,最大值为 9,不填表示不做限制。当限制 URL 只能被 1 个人播放时,建议 rlimit 不要严格限制成 1(例如可设置为 3),因为移动端断网后重连 IP 可能改变。
|
||||
WHref string `json:"whref,omitempty"` // 允许访问的域名列表,支持 1 条 - 10 条,用半角逗号分隔。域名前不要带协议名(http://和 https://),域名为前缀匹配(如填写 abc.com,则 abc.com/123 和 abc.com.cn 也会匹配),且支持通配符(如 *.abc.com)
|
||||
BkRef string `json:"bkref,omitempty"` // 禁止访问的域名列表,支持 1 条 - 10 条,用半角逗号分隔。域名前不要带协议名(http://和 https://),域名为前缀匹配(如填写 abc.com,则 abc.com/123 和 abc.com.cn 也会匹配),且支持通配符(如 *.abc.com)。
|
||||
}
|
||||
|
||||
// GetMediaLinkResponse 获取媒体链接响应
|
||||
type GetMediaLinkResponse struct {
|
||||
util.CommonError
|
||||
MediaInfo MediaPlaybackInfo `json:"media_info"` // 媒体播放信息。
|
||||
}
|
||||
|
||||
// MediaPlaybackInfo 媒体播放信息
|
||||
type MediaPlaybackInfo struct {
|
||||
MediaID int64 `json:"media_id"` // 媒资文件 id。
|
||||
Duration int64 `json:"duration"` // 播放时长,单位:秒。
|
||||
Name string `json:"name"` // 媒资文件名。
|
||||
Description string `json:"description"` // 描述。
|
||||
CoverURL string `json:"cover_url"` // 封面图临时链接。
|
||||
Mp4URL string `json:"mp4_url"` // mp4 格式临时链接。
|
||||
HlsURL string `json:"hls_url"` // hls 格式临时链接。
|
||||
}
|
||||
|
||||
// DeleteMediaRequest 删除媒体请求
|
||||
// 该接口用于删除已上传到平台的指定媒资文件,用于开发者后台管理使用。
|
||||
// Content-Type 需要指定为 application/json。
|
||||
type DeleteMediaRequest struct {
|
||||
MediaID int64 `json:"media_id"` // 媒资文件 id。
|
||||
}
|
||||
|
||||
// DeleteMediaResponse 删除媒体响应
|
||||
type DeleteMediaResponse struct {
|
||||
util.CommonError
|
||||
}
|
||||
|
||||
// AuditDramaRequest 审核剧目请求
|
||||
// 该接口用于审核剧目,审核通过后,剧目下所有剧集都会被审核通过。
|
||||
// 注意事项
|
||||
// Content-Type 需要指定为 application/json。
|
||||
// 剧目信息与审核材料在首次提审时为必填,重新提审时根据是否需要修改选填,
|
||||
// 本接口中使用的临时图片 material_id 可通过新增临时素材接口上传得到,对应临时素材接口中的 media_id,本文档中为避免与剧集的 media_id 混淆,称其为 material_id。
|
||||
// 新增临时素材接口可以被小程序调用,调用的小程序账号和剧目提审的小程序账号必须是同一个,否则提交审核时会无法识别素材 id。
|
||||
type AuditDramaRequest struct {
|
||||
DramaID int64 `json:"drama_id,omitempty"` // 剧目 ID,可通过查询剧目列表接口获取。首次提审不需要填该参数,重新提审时必填
|
||||
Name string `json:"name,omitempty"` // 剧名,首次提审时必填,重新提审时根据是否需要修改选填。
|
||||
MediaCount int `json:"media_count,omitempty"` // 剧集数目。首次提审时必填,重新提审时可不填,如要填写也要和第一次提审时一样。
|
||||
MediaIDList []int64 `json:"media_id_list,omitempty"` // 剧集媒资 media_id 列表。首次提审时必填,而且元素个数必须与 media_count 一致。重新提审时为可选,如果剧集有内容有变化,可以通过新的列表替换未通过的剧集(推荐使用 replace_media_list 进行替换,避免顺序和原列表不一致)。
|
||||
Producer string `json:"producer,omitempty"` // 制作方。首次提审时必填,重新提审时根据是否需要修改选填。
|
||||
Description string `json:"description,omitempty"` // 剧描述。首次提审时必填,重新提审时根据是否需要修改选填。
|
||||
CoverMaterialID string `json:"cover_material_id,omitempty"` // 封面图片临时 media_id。首次提审时必填,重新提审时根据是否需要修改选填。
|
||||
RegistrationNumber string `json:"registration_number,omitempty"` // 剧目备案号。首次提审时剧目备案号与网络剧片发行许可证编号二选一。重新提审时根据是否需要修改选填
|
||||
AuthorizedMaterialID string `json:"authorized_material_id,omitempty"` // 剧目播放授权材料 material_id。如果小程序主体名称和制作方完全一致,则不需要填,否则必填
|
||||
PublishLicense string `json:"publish_license,omitempty"` // 网络剧片发行许可证编号。首次提审时剧目备案号与网络剧片发行许可证编号二选一。重新提审时根据是否需要修改选填
|
||||
PublishLicenseMaterialID string `json:"publish_license_material_id,omitempty"` // 网络剧片发行许可证图片,首次提审时如果网络剧片发行许可证编号非空,则该改字段也非空。重新提审时根据是否变化选填
|
||||
Expedited int `json:"expedited,omitempty"` // 是否加急审核,填 1 表示审核加急,0 或不填为不加急。每天有 5 次加急机会。该字段在首次提审时才有效,重新提审时会沿用首次提审时的属性,重新提审不会扣次数。最终是否为加急单,可以根据 DramaInfo.expedited 属性判断
|
||||
ReplaceMediaList []*ReplaceInfo `json:"replace_media_list,omitempty"` // 重新提审时,如果剧目内容有变化,可以通过该字段替换未通过的剧集。用于重新提审时替换审核不通过的剧集。
|
||||
}
|
||||
|
||||
// ReplaceInfo 替换信息
|
||||
type ReplaceInfo struct {
|
||||
Old int64 `json:"old"` // 旧的 media_id
|
||||
New int64 `json:"new"` // 新的 media_id
|
||||
}
|
||||
|
||||
// AuditDramaResponse 审核剧目响应
|
||||
type AuditDramaResponse struct {
|
||||
util.CommonError
|
||||
DramaID int64 `json:"drama_id"` // 剧目 ID。
|
||||
}
|
||||
|
||||
// ListDramasRequest 查询剧目列表请求
|
||||
// 该接口用于获取已提交的剧目列表。
|
||||
// 注意事项
|
||||
// Content-Type 需要指定为 application/json。
|
||||
// 本接口返回的图片链接均为临时链接,不应将其保存下来。
|
||||
// 如果剧目审核结果为失败或驳回,则具体每一集的具体驳回理由及证据截图可通过“获取媒资列表”或者“获取媒资详细信息”接口来获取。
|
||||
type ListDramasRequest struct {
|
||||
Limit int `json:"limit,omitempty"` // 分页拉取的最大返回结果数。默认值:100;最大值:100。
|
||||
Offset int `json:"offset,omitempty"` // 分页拉取的起始偏移量。默认值:0。
|
||||
}
|
||||
|
||||
// DramaInfo 剧目信息
|
||||
type DramaInfo struct {
|
||||
DramaID int64 `json:"drama_id"` // 剧目 id。
|
||||
CreateTime int64 `json:"create_time"` // 创建时间,时间戳。
|
||||
Name string `json:"name"` // 剧名。
|
||||
Playwright string `json:"playwright"` // 编剧。
|
||||
Producer string `json:"producer"` // 制作方。
|
||||
ProductionLicense string `json:"production_license"` // 广播电视节目制作经营许可证。
|
||||
CoverURL string `json:"cover_url"` // 封面图临时链接,根据提审时提交的 cover_material_id 转存得到。
|
||||
MediaCount int `json:"media_count"` // 剧集数目。
|
||||
Description string `json:"description"` // 剧描述。
|
||||
MediaList []*DramaMediaInfo `json:"media_list"` // 剧集信息列表。
|
||||
AuditDetail *DramaAuditDetail `json:"audit_detail"` // 审核状态。
|
||||
Expedited int `json:"expedited"` // 是否加急审核,1 表示审核加急,0 或空为非加急审核。
|
||||
}
|
||||
|
||||
// DramaMediaInfo 剧目媒体信息
|
||||
type DramaMediaInfo struct {
|
||||
MediaID int64 `json:"media_id"`
|
||||
}
|
||||
|
||||
// DramaAuditDetail 剧目审核详情
|
||||
type DramaAuditDetail struct {
|
||||
Status int `json:"status"` // 审核状态 0 为无效值;1 为审核中;2 为审核驳回;3 为审核通过;4 为驳回重填。
|
||||
CreateTime int64 `json:"create_time"` // 提审时间戳。
|
||||
AuditTime int64 `json:"audit_time"` // 审核时间戳。
|
||||
}
|
||||
|
||||
// ListDramasResponse 查询剧目列表响应
|
||||
type ListDramasResponse struct {
|
||||
util.CommonError
|
||||
DramaInfoList []*DramaInfo `json:"drama_info_list"` // 剧目信息列表。
|
||||
}
|
||||
|
||||
// GetDramaRequest 获取剧目请求
|
||||
// 该接口用于查询已提交的剧目。
|
||||
// 注意事项
|
||||
// Content-Type 需要指定为 application/json。
|
||||
// 本接口返回的图片链接均为临时链接,不应将其保存下来。
|
||||
// 如果剧目审核结果为失败或驳回,则具体每一集的具体驳回理由及证据截图可通过“获取媒资列表”或者“获取媒资详细信息”接口来获取。
|
||||
type GetDramaRequest struct {
|
||||
DramaID int64 `json:"drama_id"` // 剧目 id。
|
||||
}
|
||||
|
||||
// GetDramaResponse 获取剧目响应
|
||||
type GetDramaResponse struct {
|
||||
util.CommonError
|
||||
DramaInfo *DramaInfo `json:"drama_info"` // 剧目信息。
|
||||
}
|
||||
|
||||
// GetCdnUsageDataRequest 获取 CDN 用量数据请求
|
||||
// 该接口用于查询点播 CDN 的流量数据。
|
||||
// 注意事项
|
||||
// 可以查询最近 365 天内的 CDN 用量数据。
|
||||
// 查询时间跨度不超过 90 天。
|
||||
// 可以指定用量数据的时间粒度,支持 5 分钟、1 小时、1 天的时间粒度。
|
||||
// 流量为查询时间粒度内的总流量。
|
||||
type GetCdnUsageDataRequest struct {
|
||||
StartTime int64 `json:"start_time"` // 查询起始时间,Unix 时间戳,单位:秒。
|
||||
EndTime int64 `json:"end_time"` // 查询结束时间,Unix 时间戳,单位:秒。
|
||||
DataInterval int `json:"data_interval"` // 用量数据的时间粒度,单位:分钟,取值有:5:5 分钟粒度,返回指定查询时间内 5 分钟粒度的明细数据。60:小时粒度,返回指定查询时间内 1 小时粒度的数据。1440:天粒度,返回指定查询时间内 1 天粒度的数据。默认值为 1440,返回天粒度的数据。
|
||||
}
|
||||
|
||||
// DataItem 数据项
|
||||
type DataItem struct {
|
||||
Time int64 `json:"time"` // 时间戳,单位:秒。
|
||||
Value int64 `json:"value"` // 用量数值。
|
||||
}
|
||||
|
||||
// GetCdnUsageDataResponse 获取 CDN 用量数据响应
|
||||
type GetCdnUsageDataResponse struct {
|
||||
util.CommonError
|
||||
DataInterval int `json:"data_interval"`
|
||||
ItemList []*DataItem `json:"item_list"`
|
||||
}
|
||||
|
||||
// GetCdnLogsRequest 获取 CDN 日志下载链接请求
|
||||
// 该接口用于获取点播 CDN 日志下载链接。
|
||||
// 注意事项
|
||||
// 可以查询最近 30 天内的 CDN 日志下载链接。
|
||||
// 默认情况下 CDN 每小时生成一个日志文件,如果某一个小时没有 CDN 访问,不会生成日志文件。
|
||||
// CDN 日志下载链接的有效期为 24 小时。
|
||||
// 日志字段依次为:请求时间、客户端 IP、访问域名、文件路径、字节数、省级编码、运营商编码、HTTP 状态码、referer、Request-Time、UA、range、HTTP Method、协议标识、缓存 HIT / MISS,日志数据打包存在延迟,正常情况下 3 小时后数据包趋于完整日志中的字节数为应用层数据大小,未考虑网络协议包头、加速重传等开销,因此与计费数据存在一定差异。
|
||||
// CDN 日志中记录的下行字节数统计而来的流量数据,是应用层数据。在实际网络传输中,产生的网络流量要比纯应用层流量多 5%-15%,比如 TCP/IP 协议的包头消耗、网络丢包重传等,这些无法被应用层统计到。在业内标准中,计费用流量一般在应用层流量的基础上加上上述开销,媒资管理服务中计费的加速流量约为日志计算加速流量的 110%。
|
||||
// 省份映射
|
||||
// 22:北京;86:内蒙古;146:山西;1069:河北;1177:天津;119:宁夏;152:陕西;1208:甘肃;1467:青海;1468:新疆;145:黑龙江;1445:吉林;1464:辽宁;2:福建;120:江苏;121:安徽;122:山东;1050:上海;1442:浙江;182:河南;1135:湖北;1465:江西;1466:湖南;118:贵州;153:云南;1051:重庆;1068:四川;1155:西藏;4:广东;173:广西;1441:海南;0:其他;1:港澳台;-1:海外。
|
||||
// 运营商映射
|
||||
// 2:中国电信;26:中国联通;38:教育网;43:长城宽带;1046:中国移动;3947:中国铁通;-1:海外运营商;0:其他运营商。
|
||||
type GetCdnLogsRequest struct {
|
||||
StartTime int64 `json:"start_time"` // 查询起始时间,Unix 时间戳,单位:秒。
|
||||
EndTime int64 `json:"end_time"` // 查询结束时间,Unix 时间戳,单位:秒。
|
||||
Limit int `json:"limit,omitempty"` // 分页拉取的最大返回结果数。默认值:100;最大值:100。
|
||||
Offset int `json:"offset,omitempty"` // 分页拉取的起始偏移量。默认值:0。
|
||||
}
|
||||
|
||||
// CdnLogInfo CDN 日志信息
|
||||
type CdnLogInfo struct {
|
||||
Date int64 `json:"date"` // 日志日期,格式为 YYYYMMDD。
|
||||
Name string `json:"name"` // 日志文件名
|
||||
URL string `json:"url"` // 日志下载链接,24 小时内下载有效。
|
||||
StartTime int64 `json:"start_time"` // 查询起始时间,Unix 时间戳,单位:秒。
|
||||
EndTime int64 `json:"end_time"` // 查询结束时间,Unix 时间戳,单位:秒。
|
||||
}
|
||||
|
||||
// GetCdnLogsResponse 获取 CDN 日志下载链接响应
|
||||
type GetCdnLogsResponse struct {
|
||||
util.CommonError
|
||||
TotalCount int `json:"total_count"` // 日志总条数。
|
||||
DomesticCdnLogs []*CdnLogInfo `json:"domestic_cdn_logs"` // 日志信息列表,国内 CDN 节点的日志下载列表。
|
||||
}
|
||||
|
||||
// AsyncMediaUploadEvent 异步媒体上传事件
|
||||
// see: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/mini-drama/mini_drama.html#_5-1-%E5%AA%92%E8%B5%84%E4%B8%8A%E4%BC%A0%E5%AE%8C%E6%88%90%E4%BA%8B%E4%BB%B6
|
||||
type AsyncMediaUploadEvent struct {
|
||||
util.CommonError
|
||||
MediaID int64 `json:"media_id"` // 媒资文件 id。
|
||||
SourceContext string `json:"source_context"` // 来源上下文,开发者可自定义该字段内容。
|
||||
}
|
||||
|
||||
// AsyncMediaAuditEvent 异步媒体审核事件
|
||||
// see: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/mini-drama/mini_drama.html#_5-2-%E5%AE%A1%E6%A0%B8%E7%8A%B6%E6%80%81%E4%BA%8B%E4%BB%B6
|
||||
type AsyncMediaAuditEvent struct {
|
||||
DramaID int64 `json:"drama_id"` // 剧目 id。
|
||||
SourceContext string `json:"source_context"` // 来源上下文,开发者可自定义该字段内容。
|
||||
AuditDetail *DramaAuditDetail `json:"audit_detail"` // 审核状态。
|
||||
}
|
||||
346
miniprogram/minidrama/minidrama.go
Normal file
346
miniprogram/minidrama/minidrama.go
Normal file
@@ -0,0 +1,346 @@
|
||||
/*
|
||||
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
* You can obtain one at https://github.com/silenceper/wechat.
|
||||
*
|
||||
*/
|
||||
|
||||
package minidrama
|
||||
|
||||
import (
|
||||
"context"
|
||||
"strconv"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
// SingleFileUpload 单文件上传
|
||||
func (s *MiniDrama) SingleFileUpload(ctx context.Context, in *SingleFileUploadRequest) (out SingleFileUploadResponse, err error) {
|
||||
var address string
|
||||
if address, err = s.requestAddress(ctx, singleFileUpload); err != nil {
|
||||
return
|
||||
}
|
||||
var (
|
||||
fields = []util.MultipartFormField{
|
||||
{
|
||||
IsFile: true,
|
||||
Fieldname: "media_data",
|
||||
Filename: string(in.MediaData),
|
||||
}, {
|
||||
IsFile: false,
|
||||
Fieldname: "media_name",
|
||||
Value: []byte(in.MediaName),
|
||||
}, {
|
||||
IsFile: false,
|
||||
Fieldname: "media_type",
|
||||
Value: []byte(in.MediaType),
|
||||
},
|
||||
}
|
||||
response []byte
|
||||
)
|
||||
|
||||
if in.CoverType != "" && in.CoverData != nil {
|
||||
fields = append(fields, util.MultipartFormField{
|
||||
IsFile: false,
|
||||
Fieldname: "cover_type",
|
||||
Value: []byte(in.CoverType),
|
||||
})
|
||||
fields = append(fields, util.MultipartFormField{
|
||||
IsFile: true,
|
||||
Fieldname: "cover_data",
|
||||
Filename: string(in.CoverData),
|
||||
})
|
||||
}
|
||||
|
||||
if in.SourceContext != "" {
|
||||
fields = append(fields, util.MultipartFormField{
|
||||
IsFile: false,
|
||||
Fieldname: "source_context",
|
||||
Value: []byte(in.SourceContext),
|
||||
})
|
||||
}
|
||||
|
||||
if response, err = util.PostMultipartForm(fields, address); err != nil {
|
||||
return
|
||||
}
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "SingleFileUpload")
|
||||
return
|
||||
}
|
||||
|
||||
// PullUpload 拉取上传
|
||||
func (s *MiniDrama) PullUpload(ctx context.Context, in *PullUploadRequest) (out PullUploadResponse, err error) {
|
||||
var address string
|
||||
if address, err = s.requestAddress(ctx, pullUpload); err != nil {
|
||||
return
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "PullUpload")
|
||||
return
|
||||
}
|
||||
|
||||
// GetTask 查询任务状态
|
||||
func (s *MiniDrama) GetTask(ctx context.Context, in *GetTaskRequest) (out GetTaskResponse, err error) {
|
||||
var address string
|
||||
if address, err = s.requestAddress(ctx, getTask); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "GetTask")
|
||||
return
|
||||
}
|
||||
|
||||
// ApplyUpload 申请分片上传
|
||||
func (s *MiniDrama) ApplyUpload(ctx context.Context, in *ApplyUploadRequest) (out ApplyUploadResponse, err error) {
|
||||
var address string
|
||||
if address, err = s.requestAddress(ctx, applyUpload); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "ApplyUpload")
|
||||
return
|
||||
}
|
||||
|
||||
// UploadPart 上传分片
|
||||
// Content-Type 需要指定为 multipart/form-data; boundary=<delimiter>,<箭头括号>表示必须替换为有效值的变量。
|
||||
func (s *MiniDrama) UploadPart(ctx context.Context, in *UploadPartRequest) (out UploadPartResponse, err error) {
|
||||
var address string
|
||||
if address, err = s.requestAddress(ctx, uploadPart); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
fields = []util.MultipartFormField{
|
||||
{
|
||||
IsFile: true,
|
||||
Fieldname: "data",
|
||||
Filename: string(in.Data),
|
||||
}, {
|
||||
IsFile: false,
|
||||
Fieldname: "upload_id",
|
||||
Value: []byte(in.UploadID),
|
||||
}, {
|
||||
IsFile: false,
|
||||
Fieldname: "part_number",
|
||||
Value: []byte(strconv.Itoa(in.PartNumber)),
|
||||
}, {
|
||||
IsFile: false,
|
||||
Fieldname: "resource_type",
|
||||
Value: []byte(strconv.Itoa(in.PartNumber)),
|
||||
},
|
||||
}
|
||||
response []byte
|
||||
)
|
||||
if response, err = util.PostMultipartForm(fields, address); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "UploadPart")
|
||||
return
|
||||
}
|
||||
|
||||
// CommitUpload 确认上传
|
||||
func (s *MiniDrama) CommitUpload(ctx context.Context, in *CommitUploadRequest) (out CommitUploadResponse, err error) {
|
||||
var address string
|
||||
if address, err = s.requestAddress(ctx, commitUpload); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "CommitUpload")
|
||||
return
|
||||
}
|
||||
|
||||
// ListMedia 获取媒体列表
|
||||
func (s *MiniDrama) ListMedia(ctx context.Context, in *ListMediaRequest) (out ListMediaResponse, err error) {
|
||||
var address string
|
||||
if address, err = s.requestAddress(ctx, listMedia); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "ListMedia")
|
||||
return
|
||||
}
|
||||
|
||||
// GetMedia 获取媒资详细信息
|
||||
func (s *MiniDrama) GetMedia(ctx context.Context, in *GetMediaRequest) (out GetMediaResponse, err error) {
|
||||
var address string
|
||||
if address, err = s.requestAddress(ctx, getMedia); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "GetMedia")
|
||||
return
|
||||
}
|
||||
|
||||
// GetMediaLink 获取媒资播放链接
|
||||
func (s *MiniDrama) GetMediaLink(ctx context.Context, in *GetMediaLinkRequest) (out GetMediaLinkResponse, err error) {
|
||||
var address string
|
||||
if address, err = s.requestAddress(ctx, getMediaLink); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "GetMediaLink")
|
||||
return
|
||||
}
|
||||
|
||||
// DeleteMedia 删除媒体
|
||||
func (s *MiniDrama) DeleteMedia(ctx context.Context, in *DeleteMediaRequest) (out DeleteMediaResponse, err error) {
|
||||
var address string
|
||||
if address, err = s.requestAddress(ctx, deleteMedia); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "DeleteMedia")
|
||||
return
|
||||
}
|
||||
|
||||
// AuditDrama 审核剧本
|
||||
func (s *MiniDrama) AuditDrama(ctx context.Context, in *AuditDramaRequest) (out AuditDramaResponse, err error) {
|
||||
var address string
|
||||
if address, err = s.requestAddress(ctx, auditDrama); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "AuditDrama")
|
||||
return
|
||||
}
|
||||
|
||||
// ListDramas 获取剧目列表
|
||||
func (s *MiniDrama) ListDramas(ctx context.Context, in *ListDramasRequest) (out ListDramasResponse, err error) {
|
||||
var address string
|
||||
if address, err = s.requestAddress(ctx, listDramas); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "ListDramas")
|
||||
return
|
||||
}
|
||||
|
||||
// GetDrama 获取剧目信息
|
||||
func (s *MiniDrama) GetDrama(ctx context.Context, in *GetDramaRequest) (out GetDramaResponse, err error) {
|
||||
var address string
|
||||
if address, err = s.requestAddress(ctx, getDrama); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "GetDrama")
|
||||
return
|
||||
}
|
||||
|
||||
// GetCdnUsageData 查询 CDN 用量数据
|
||||
func (s *MiniDrama) GetCdnUsageData(ctx context.Context, in *GetCdnUsageDataRequest) (out GetCdnUsageDataResponse, err error) {
|
||||
var address string
|
||||
if address, err = s.requestAddress(ctx, getCdnUsageData); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "GetCdnUsageData")
|
||||
return
|
||||
}
|
||||
|
||||
// GetCdnLogs 查询 CDN 日志
|
||||
func (s *MiniDrama) GetCdnLogs(ctx context.Context, in *GetCdnLogsRequest) (out GetCdnLogsResponse, err error) {
|
||||
var address string
|
||||
if address, err = s.requestAddress(ctx, getCdnLogs); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "GetCdnLogs")
|
||||
return
|
||||
}
|
||||
|
||||
// requestAddress 请求地址
|
||||
func (s *MiniDrama) requestAddress(_ context.Context, url string) (string, error) {
|
||||
accessToken, err := s.ctx.GetAccessToken()
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return url + accessToken, nil
|
||||
}
|
||||
@@ -2,6 +2,7 @@ package miniprogram
|
||||
|
||||
import (
|
||||
"github.com/silenceper/wechat/v2/credential"
|
||||
"github.com/silenceper/wechat/v2/internal/openapi"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/analysis"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/auth"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/business"
|
||||
@@ -10,8 +11,11 @@ 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/minidrama"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/order"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/privacy"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/qrcode"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/redpacketcover"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/riskcontrol"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/security"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/shortlink"
|
||||
@@ -19,15 +23,16 @@ import (
|
||||
"github.com/silenceper/wechat/v2/miniprogram/tcb"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/urllink"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/urlscheme"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/virtualpayment"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/werun"
|
||||
)
|
||||
|
||||
// MiniProgram 微信小程序相关API
|
||||
// MiniProgram 微信小程序相关 API
|
||||
type MiniProgram struct {
|
||||
ctx *context.Context
|
||||
}
|
||||
|
||||
// NewMiniProgram 实例化小程序API
|
||||
// NewMiniProgram 实例化小程序 API
|
||||
func NewMiniProgram(cfg *config.Config) *MiniProgram {
|
||||
defaultAkHandle := credential.NewDefaultAccessToken(cfg.AppID, cfg.AppSecret, credential.CacheKeyMiniProgramPrefix, cfg.Cache)
|
||||
ctx := &context.Context{
|
||||
@@ -37,7 +42,7 @@ func NewMiniProgram(cfg *config.Config) *MiniProgram {
|
||||
return &MiniProgram{ctx}
|
||||
}
|
||||
|
||||
// SetAccessTokenHandle 自定义access_token获取方式
|
||||
// SetAccessTokenHandle 自定义 access_token 获取方式
|
||||
func (miniProgram *MiniProgram) SetAccessTokenHandle(accessTokenHandle credential.AccessTokenHandle) {
|
||||
miniProgram.ctx.AccessTokenHandle = accessTokenHandle
|
||||
}
|
||||
@@ -67,17 +72,17 @@ func (miniProgram *MiniProgram) GetBusiness() *business.Business {
|
||||
return business.NewBusiness(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetPrivacy 小程序隐私协议相关API
|
||||
// GetPrivacy 小程序隐私协议相关 API
|
||||
func (miniProgram *MiniProgram) GetPrivacy() *privacy.Privacy {
|
||||
return privacy.NewPrivacy(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetQRCode 小程序码相关API
|
||||
// GetQRCode 小程序码相关 API
|
||||
func (miniProgram *MiniProgram) GetQRCode() *qrcode.QRCode {
|
||||
return qrcode.NewQRCode(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetTcb 小程序云开发API
|
||||
// GetTcb 小程序云开发 API
|
||||
func (miniProgram *MiniProgram) GetTcb() *tcb.Tcb {
|
||||
return tcb.NewTcb(miniProgram.ctx)
|
||||
}
|
||||
@@ -102,7 +107,7 @@ func (miniProgram *MiniProgram) GetContentSecurity() *content.Content {
|
||||
return content.NewContent(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetURLLink 小程序URL Link接口
|
||||
// GetURLLink 小程序 URL Link 接口
|
||||
func (miniProgram *MiniProgram) GetURLLink() *urllink.URLLink {
|
||||
return urllink.NewURLLink(miniProgram.ctx)
|
||||
}
|
||||
@@ -122,7 +127,42 @@ func (miniProgram *MiniProgram) GetShortLink() *shortlink.ShortLink {
|
||||
return shortlink.NewShortLink(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetSURLScheme 小程序URL Scheme接口
|
||||
// GetSURLScheme 小程序 URL Scheme 接口
|
||||
func (miniProgram *MiniProgram) GetSURLScheme() *urlscheme.URLScheme {
|
||||
return urlscheme.NewURLScheme(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetOpenAPI openApi 管理接口
|
||||
func (miniProgram *MiniProgram) GetOpenAPI() *openapi.OpenAPI {
|
||||
return openapi.NewOpenAPI(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetVirtualPayment 小程序虚拟支付
|
||||
func (miniProgram *MiniProgram) GetVirtualPayment() *virtualpayment.VirtualPayment {
|
||||
return virtualpayment.NewVirtualPayment(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetMessageReceiver 获取消息推送接收器
|
||||
func (miniProgram *MiniProgram) GetMessageReceiver() *message.PushReceiver {
|
||||
return message.NewPushReceiver(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetShipping 小程序发货信息管理服务
|
||||
func (miniProgram *MiniProgram) GetShipping() *order.Shipping {
|
||||
return order.NewShipping(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetMiniDrama 小程序娱乐微短剧
|
||||
func (miniProgram *MiniProgram) GetMiniDrama() *minidrama.MiniDrama {
|
||||
return minidrama.NewMiniDrama(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetRedPacketCover 小程序微信红包封面 API
|
||||
func (miniProgram *MiniProgram) GetRedPacketCover() *redpacketcover.RedPacketCover {
|
||||
return redpacketcover.NewRedPacketCover(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetUpdatableMessage 小程序动态消息
|
||||
func (miniProgram *MiniProgram) GetUpdatableMessage() *message.UpdatableMessage {
|
||||
return message.NewUpdatableMessage(miniProgram.ctx)
|
||||
}
|
||||
|
||||
269
miniprogram/order/shipping.go
Normal file
269
miniprogram/order/shipping.go
Normal file
@@ -0,0 +1,269 @@
|
||||
package order
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
// 发货信息录入
|
||||
uploadShippingInfoURL = "https://api.weixin.qq.com/wxa/sec/order/upload_shipping_info?access_token=%s"
|
||||
|
||||
// 查询订单发货状态
|
||||
getShippingOrderURL = "https://api.weixin.qq.com/wxa/sec/order/get_order?access_token=%s"
|
||||
|
||||
// 查询订单列表
|
||||
getShippingOrderListURL = "https://api.weixin.qq.com/wxa/sec/order/get_order_list?access_token=%s"
|
||||
|
||||
// 确认收货提醒接口
|
||||
notifyConfirmReceiveURL = "https://api.weixin.qq.com/wxa/sec/order/notify_confirm_receive?access_token=%s"
|
||||
)
|
||||
|
||||
// Shipping 发货信息管理
|
||||
type Shipping struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewShipping init
|
||||
func NewShipping(ctx *context.Context) *Shipping {
|
||||
return &Shipping{ctx}
|
||||
}
|
||||
|
||||
// UploadShippingInfo 发货信息录入
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/order-shipping/order-shipping.html
|
||||
func (shipping *Shipping) UploadShippingInfo(in *UploadShippingInfoRequest) (err error) {
|
||||
accessToken, err := shipping.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(uploadShippingInfoURL, accessToken)
|
||||
response, err := util.PostJSON(uri, in)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
return util.DecodeWithCommonError(response, "UploadShippingInfo")
|
||||
}
|
||||
|
||||
// GetShippingOrder 查询订单发货状态
|
||||
func (shipping *Shipping) GetShippingOrder(in *GetShippingOrderRequest) (res ShippingOrderResponse, err error) {
|
||||
accessToken, err := shipping.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(getShippingOrderURL, accessToken)
|
||||
response, err := util.PostJSON(uri, in)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &res, "GetShippingOrder")
|
||||
return
|
||||
}
|
||||
|
||||
// GetShippingOrderList 查询订单列表
|
||||
func (shipping *Shipping) GetShippingOrderList(in *GetShippingOrderListRequest) (res GetShippingOrderListResponse, err error) {
|
||||
accessToken, err := shipping.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(getShippingOrderListURL, accessToken)
|
||||
response, err := util.PostJSON(uri, in)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &res, "GetShippingOrderList")
|
||||
return
|
||||
}
|
||||
|
||||
// NotifyConfirmReceive 确认收货提醒接口
|
||||
func (shipping *Shipping) NotifyConfirmReceive(in *NotifyConfirmReceiveRequest) (err error) {
|
||||
accessToken, err := shipping.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(notifyConfirmReceiveURL, accessToken)
|
||||
response, err := util.PostJSON(uri, in)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
return util.DecodeWithCommonError(response, "NotifyConfirmReceive")
|
||||
}
|
||||
|
||||
// UploadShippingInfoRequest 发货信息录入请求参数
|
||||
type UploadShippingInfoRequest struct {
|
||||
OrderKey *ShippingOrderKey `json:"order_key"` // 订单,需要上传物流信息的订单
|
||||
LogisticsType LogisticsType `json:"logistics_type"` // 物流模式
|
||||
DeliveryMode DeliveryMode `json:"delivery_mode"` // 发货模式
|
||||
IsAllDelivered bool `json:"is_all_delivered"` // 分拆发货模式时必填,用于标识分拆发货模式下是否已全部发货完成
|
||||
ShippingList []*ShippingInfo `json:"shipping_list"` // 物流信息列表,发货物流单列表,支持统一发货(单个物流单)和分拆发货(多个物流单)两种模式
|
||||
UploadTime *time.Time `json:"upload_time"` // 上传时间,用于标识请求的先后顺序
|
||||
Payer *ShippingPayer `json:"payer"` // 支付人信息
|
||||
}
|
||||
|
||||
// ShippingOrderKey 订单
|
||||
type ShippingOrderKey struct {
|
||||
OrderNumberType NumberType `json:"order_number_type"` // 订单单号类型,用于确认需要上传详情的订单。枚举值1,使用下单商户号和商户侧单号;枚举值2,使用微信支付单号。
|
||||
TransactionID string `json:"transaction_id"` // 原支付交易对应的微信订单号
|
||||
Mchid string `json:"mchid"` // 支付下单商户的商户号,由微信支付生成并下发
|
||||
OutTradeNo string `json:"out_trade_no"` // 商户系统内部订单号,只能是数字、大小写字母`_-*`且在同一个商户号下唯一
|
||||
}
|
||||
|
||||
// ShippingPayer 支付者信息
|
||||
type ShippingPayer struct {
|
||||
Openid string `json:"openid"` // 用户标识,用户在小程序appid下的唯一标识
|
||||
}
|
||||
|
||||
// ShippingInfo 物流信息
|
||||
type ShippingInfo struct {
|
||||
TrackingNo string `json:"tracking_no"` // 物流单号,物流快递发货时必填
|
||||
ExpressCompany string `json:"express_company"` // 物流公司编码,快递公司ID,物流快递发货时必填;参见「查询物流公司编码列表」
|
||||
ItemDesc string `json:"item_desc"` // 商品信息,例如:微信红包抱枕*1个,限120个字以内
|
||||
Contact ShippingContact `json:"contact"` // 联系方式,当发货的物流公司为顺丰时,联系方式为必填,收件人或寄件人联系方式二选一
|
||||
}
|
||||
|
||||
// ShippingContact 联系方式
|
||||
type ShippingContact struct {
|
||||
ConsignorContact string `json:"consignor_contact"` // 寄件人联系方式,寄件人联系方式,采用掩码传输,最后4位数字不能打掩码
|
||||
ReceiverContact string `json:"receiver_contact"` // 收件人联系方式,收件人联系方式,采用掩码传输,最后4位数字不能打掩码
|
||||
}
|
||||
|
||||
// DeliveryMode 发货模式
|
||||
type DeliveryMode uint8
|
||||
|
||||
const (
|
||||
// DeliveryModeUnifiedDelivery 统一发货
|
||||
DeliveryModeUnifiedDelivery DeliveryMode = 1
|
||||
// DeliveryModeSplitDelivery 分拆发货
|
||||
DeliveryModeSplitDelivery DeliveryMode = 2
|
||||
)
|
||||
|
||||
// LogisticsType 物流模式
|
||||
type LogisticsType uint8
|
||||
|
||||
const (
|
||||
// LogisticsTypeExpress 实体物流配送采用快递公司进行实体物流配送形式
|
||||
LogisticsTypeExpress LogisticsType = 1
|
||||
// LogisticsTypeSameCity 同城配送
|
||||
LogisticsTypeSameCity LogisticsType = 2
|
||||
// LogisticsTypeVirtual 虚拟商品,虚拟商品,例如话费充值,点卡等,无实体配送形式
|
||||
LogisticsTypeVirtual LogisticsType = 3
|
||||
// LogisticsTypeSelfPickup 用户自提
|
||||
LogisticsTypeSelfPickup LogisticsType = 4
|
||||
)
|
||||
|
||||
// NumberType 订单单号类型
|
||||
type NumberType uint8
|
||||
|
||||
const (
|
||||
// NumberTypeOutTradeNo 使用下单商户号和商户侧单号
|
||||
NumberTypeOutTradeNo NumberType = 1
|
||||
// NumberTypeTransactionID 使用微信支付单号
|
||||
NumberTypeTransactionID NumberType = 2
|
||||
)
|
||||
|
||||
// GetShippingOrderRequest 查询订单发货状态参数
|
||||
type GetShippingOrderRequest struct {
|
||||
TransactionID string `json:"transaction_id"` // 原支付交易对应的微信订单号
|
||||
MerchantID string `json:"merchant_id"` // 支付下单商户的商户号,由微信支付生成并下发
|
||||
SubMerchantID string `json:"sub_merchant_id"` //二级商户号
|
||||
MerchantTradeNo string `json:"merchant_trade_no"` //商户系统内部订单号,只能是数字、大小写字母`_-*`且在同一个商户号下唯一。
|
||||
}
|
||||
|
||||
// ShippingItem 物流信息
|
||||
type ShippingItem struct {
|
||||
TrackingNo string `json:"tracking_no"` // 物流单号,示例值: "323244567777
|
||||
ExpressCompany string `json:"express_company"` // 物流公司编码,快递公司ID,物流快递发货时必填;参见「查询物流公司编码列表」
|
||||
UploadTime int64 `json:"upload_time"` // 上传物流信息时间,时间戳形式
|
||||
}
|
||||
|
||||
// ShippingDetail 发货信息
|
||||
type ShippingDetail struct {
|
||||
DeliveryMode DeliveryMode `json:"delivery_mode"` // 发货模式
|
||||
LogisticsType LogisticsType `json:"logistics_type"` // 物流模式
|
||||
FinishShipping bool `json:"finish_shipping"` // 是否已全部发货
|
||||
FinishShippingCount int `json:"finish_shipping_count"` // 已完成全部发货的次数
|
||||
GoodsDesc string `json:"goods_desc"` // 在小程序后台发货信息录入页录入的商品描述
|
||||
ShippingList []*ShippingItem `json:"shipping_list"` // 物流信息列表
|
||||
}
|
||||
|
||||
// ShippingOrder 订单发货状态
|
||||
type ShippingOrder struct {
|
||||
TransactionID string `json:"transaction_id"` // 原支付交易对应的微信订单号
|
||||
MerchantTradeNo string `json:"merchant_trade_no"` // 商户系统内部订单号,只能是数字、大小写字母`_-*`且在同一个商户号下唯一
|
||||
MerchantID string `json:"merchant_id"` // 支付下单商户的商户号,由微信支付生成并下发
|
||||
SubMerchantID string `json:"sub_merchant_id"` // 二级商户号
|
||||
Description string `json:"description"` // 以分号连接的该支付单的所有商品描述,当超过120字时自动截断并以 “...” 结尾
|
||||
PaidAmount int64 `json:"paid_amount"` // 支付单实际支付金额,整型,单位:分钱
|
||||
Openid string `json:"openid"` // 支付者openid
|
||||
TradeCreateTime int64 `json:"trade_create_time"` // 交易创建时间,时间戳形式
|
||||
PayTime int64 `json:"pay_time"` // 支付时间,时间戳形式
|
||||
InComplaint bool `json:"in_complaint"` // 是否处在交易纠纷中
|
||||
OrderState State `json:"order_state"` // 订单状态枚举:(1) 待发货;(2) 已发货;(3) 确认收货;(4) 交易完成;(5) 已退款
|
||||
Shipping *ShippingDetail `json:"shipping"` // 订单发货信息
|
||||
}
|
||||
|
||||
// ShippingOrderResponse 查询订单发货状态返回参数
|
||||
type ShippingOrderResponse struct {
|
||||
util.CommonError
|
||||
Order ShippingOrder `json:"order"` // 订单发货信息
|
||||
}
|
||||
|
||||
// State 订单状态
|
||||
type State uint8
|
||||
|
||||
const (
|
||||
// StateWaitShipment 待发货
|
||||
StateWaitShipment State = 1
|
||||
// StateShipped 已发货
|
||||
StateShipped State = 2
|
||||
// StateConfirm 确认收货
|
||||
StateConfirm State = 3
|
||||
// StateComplete 交易完成
|
||||
StateComplete State = 4
|
||||
// StateRefund 已退款
|
||||
StateRefund State = 5
|
||||
)
|
||||
|
||||
// GetShippingOrderListRequest 查询订单列表请求参数
|
||||
type GetShippingOrderListRequest struct {
|
||||
PayTimeRange *TimeRange `json:"pay_time_range"` // 支付时间范围
|
||||
OrderState State `json:"order_state,omitempty"` // 订单状态
|
||||
Openid string `json:"openid,omitempty"` // 支付者openid
|
||||
LastIndex string `json:"last_index,omitempty"` // 翻页时使用,获取第一页时不用传入,如果查询结果中 has_more 字段为 true,则传入该次查询结果中返回的 last_index 字段可获取下一页
|
||||
PageSize int64 `json:"page_size"` // 每页数量,最多50条
|
||||
}
|
||||
|
||||
// TimeRange 时间范围
|
||||
type TimeRange struct {
|
||||
BeginTime int64 `json:"begin_time,omitempty"` // 查询开始时间,时间戳形式
|
||||
EndTime int64 `json:"end_time,omitempty"` // 查询结束时间,时间戳形式
|
||||
}
|
||||
|
||||
// GetShippingOrderListResponse 查询订单列表返回参数
|
||||
type GetShippingOrderListResponse struct {
|
||||
util.CommonError
|
||||
OrderList []*ShippingOrder `json:"order_list"`
|
||||
LastIndex string `json:"last_index"`
|
||||
HasMore bool `json:"has_more"`
|
||||
}
|
||||
|
||||
// NotifyConfirmReceiveRequest 确认收货提醒接口请求参数
|
||||
type NotifyConfirmReceiveRequest struct {
|
||||
TransactionID string `json:"transaction_id"` // 原支付交易对应的微信订单号
|
||||
MerchantID string `json:"merchant_id"` // 支付下单商户的商户号,由微信支付生成并下发
|
||||
SubMerchantID string `json:"sub_merchant_id"` // 二级商户号
|
||||
MerchantTradeNo string `json:"merchant_trade_no"` // 商户系统内部订单号,只能是数字、大小写字母`_-*`且在同一个商户号下唯一
|
||||
ReceivedTime int64 `json:"received_time"` // 收货时间,时间戳形式
|
||||
}
|
||||
@@ -103,11 +103,8 @@ func (s *Privacy) GetPrivacySetting(privacyVer int) (GetPrivacySettingResponse,
|
||||
}
|
||||
// 返回错误信息
|
||||
var result GetPrivacySettingResponse
|
||||
if err = util.DecodeWithError(response, &result, "getprivacysetting"); err != nil {
|
||||
return GetPrivacySettingResponse{}, err
|
||||
}
|
||||
|
||||
return result, nil
|
||||
err = util.DecodeWithError(response, &result, "getprivacysetting")
|
||||
return result, err
|
||||
}
|
||||
|
||||
// SetPrivacySetting 更新小程序权限配置
|
||||
@@ -130,11 +127,7 @@ func (s *Privacy) SetPrivacySetting(privacyVer int, ownerSetting OwnerSetting, s
|
||||
}
|
||||
|
||||
// 返回错误信息
|
||||
if err = util.DecodeWithCommonError(response, "setprivacysetting"); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return err
|
||||
return util.DecodeWithCommonError(response, "setprivacysetting")
|
||||
}
|
||||
|
||||
// UploadPrivacyExtFileResponse 上传权限定义模板响应参数
|
||||
@@ -159,9 +152,6 @@ func (s *Privacy) UploadPrivacyExtFile(fileData []byte) (UploadPrivacyExtFileRes
|
||||
|
||||
// 返回错误信息
|
||||
var result UploadPrivacyExtFileResponse
|
||||
if err = util.DecodeWithError(response, &result, "setprivacysetting"); err != nil {
|
||||
return UploadPrivacyExtFileResponse{}, err
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &result, "setprivacysetting")
|
||||
return result, err
|
||||
}
|
||||
|
||||
59
miniprogram/redpacketcover/redpacketcover.go
Normal file
59
miniprogram/redpacketcover/redpacketcover.go
Normal file
@@ -0,0 +1,59 @@
|
||||
package redpacketcover
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
getRedPacketCoverURL = "https://api.weixin.qq.com/redpacketcover/wxapp/cover_url/get_by_token?access_token=%s"
|
||||
)
|
||||
|
||||
// RedPacketCover struct
|
||||
type RedPacketCover struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewRedPacketCover 实例
|
||||
func NewRedPacketCover(context *context.Context) *RedPacketCover {
|
||||
redPacketCover := new(RedPacketCover)
|
||||
redPacketCover.Context = context
|
||||
return redPacketCover
|
||||
}
|
||||
|
||||
// GetRedPacketCoverRequest 获取微信红包封面参数
|
||||
type GetRedPacketCoverRequest struct {
|
||||
// openid 可领取用户的openid
|
||||
OpenID string `json:"openid"`
|
||||
// ctoken 在红包封面平台获取发放ctoken(需要指定可以发放的appid)
|
||||
CToken string `json:"ctoken"`
|
||||
}
|
||||
|
||||
// GetRedPacketCoverResp 获取微信红包封面
|
||||
type GetRedPacketCoverResp struct {
|
||||
util.CommonError
|
||||
Data struct {
|
||||
URL string `json:"url"`
|
||||
} `json:"data"` // 唯一请求标识
|
||||
}
|
||||
|
||||
// GetRedPacketCoverURL 获得指定用户可以领取的红包封面链接。获取参数ctoken参考微信红包封面开放平台
|
||||
// 文档地址: https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/red-packet-cover/getRedPacketCoverUrl.html
|
||||
func (cover *RedPacketCover) GetRedPacketCoverURL(coderParams GetRedPacketCoverRequest) (res GetRedPacketCoverResp, err error) {
|
||||
accessToken, err := cover.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(getRedPacketCoverURL, accessToken)
|
||||
response, err := util.PostJSON(uri, coderParams)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &res, "GetRedPacketCoverURL")
|
||||
return
|
||||
}
|
||||
@@ -51,12 +51,7 @@ func (security *Security) MediaCheckAsyncV1(in *MediaCheckAsyncV1Request) (trace
|
||||
TraceID string `json:"trace_id"`
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "MediaCheckAsyncV1")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
traceID = res.TraceID
|
||||
return
|
||||
return res.TraceID, err
|
||||
}
|
||||
|
||||
// MediaCheckAsyncRequest 图片/音频异步校验请求参数
|
||||
@@ -93,12 +88,7 @@ func (security *Security) MediaCheckAsync(in *MediaCheckAsyncRequest) (traceID s
|
||||
TraceID string `json:"trace_id"`
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "MediaCheckAsync")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
traceID = res.TraceID
|
||||
return
|
||||
return res.TraceID, err
|
||||
}
|
||||
|
||||
// ImageCheckV1 校验一张图片是否含有违法违规内容(同步)
|
||||
|
||||
@@ -24,10 +24,10 @@ func NewShortLink(ctx *context.Context) *ShortLink {
|
||||
// ShortLinker 请求结构体
|
||||
type ShortLinker struct {
|
||||
|
||||
// pageUrl 通过 Short Link 进入的小程序页面路径,必须是已经发布的小程序存在的页面,可携带 query,最大1024个字符
|
||||
// pageUrl 通过 Short Link 进入的小程序页面路径,必须是已经发布的小程序存在的页面,可携带 query,最大 1024 个字符
|
||||
PageURL string `json:"page_url"`
|
||||
|
||||
// pageTitle 页面标题,不能包含违法信息,超过20字符会用... 截断代替
|
||||
// pageTitle 页面标题,不能包含违法信息,超过 20 字符会用... 截断代替
|
||||
PageTitle string `json:"page_title"`
|
||||
|
||||
// isPermanent 生成的 Short Link 类型,短期有效:false,永久有效:true
|
||||
@@ -37,7 +37,7 @@ type ShortLinker struct {
|
||||
// resShortLinker 返回结构体
|
||||
type resShortLinker struct {
|
||||
// 通用错误
|
||||
*util.CommonError
|
||||
util.CommonError
|
||||
|
||||
// 返回的 shortLink
|
||||
Link string `json:"link"`
|
||||
@@ -60,14 +60,10 @@ func (shortLink *ShortLink) generate(shortLinkParams ShortLinker) (string, error
|
||||
// 使用通用方法返回错误
|
||||
var res resShortLinker
|
||||
err = util.DecodeWithError(response, &res, "GenerateShortLink")
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
return res.Link, nil
|
||||
return res.Link, err
|
||||
}
|
||||
|
||||
// GenerateShortLinkPermanent 生成永久shortLink
|
||||
// GenerateShortLinkPermanent 生成永久 shortLink
|
||||
func (shortLink *ShortLink) GenerateShortLinkPermanent(PageURL, pageTitle string) (string, error) {
|
||||
return shortLink.generate(ShortLinker{
|
||||
PageURL: PageURL,
|
||||
@@ -76,7 +72,7 @@ func (shortLink *ShortLink) GenerateShortLinkPermanent(PageURL, pageTitle string
|
||||
})
|
||||
}
|
||||
|
||||
// GenerateShortLinkTemp 生成临时shortLink
|
||||
// GenerateShortLinkTemp 生成临时 shortLink
|
||||
func (shortLink *ShortLink) GenerateShortLinkTemp(PageURL, pageTitle string) (string, error) {
|
||||
return shortLink.generate(ShortLinker{
|
||||
PageURL: PageURL,
|
||||
|
||||
@@ -121,7 +121,7 @@ type UniformMessage struct {
|
||||
URL string `json:"url"`
|
||||
Miniprogram struct {
|
||||
Appid string `json:"appid"`
|
||||
Pagepath string `json:"page"`
|
||||
Pagepath string `json:"pagepath"`
|
||||
} `json:"miniprogram"`
|
||||
Data map[string]*DataItem `json:"data"`
|
||||
} `json:"mp_template_msg"`
|
||||
@@ -168,11 +168,7 @@ func (s *Subscribe) Add(ShortID string, kidList []int, sceneDesc string) (templa
|
||||
}
|
||||
var result resSubscribeAdd
|
||||
err = util.DecodeWithError(response, &result, "AddSubscribe")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
templateID = result.TemplateID
|
||||
return
|
||||
return result.TemplateID, err
|
||||
}
|
||||
|
||||
// Delete 删除私有模板
|
||||
|
||||
@@ -18,6 +18,7 @@ type InvokeCloudFunctionRes struct {
|
||||
}
|
||||
|
||||
// InvokeCloudFunction 云函数调用
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/functions/invokeCloudFunction.html
|
||||
func (tcb *Tcb) InvokeCloudFunction(env, name, args string) (*InvokeCloudFunctionRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
|
||||
@@ -192,6 +192,7 @@ type DatabaseCountRes struct {
|
||||
}
|
||||
|
||||
// DatabaseMigrateImport 数据库导入
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateImport.html
|
||||
func (tcb *Tcb) DatabaseMigrateImport(req *DatabaseMigrateImportReq) (*DatabaseMigrateImportRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -209,6 +210,7 @@ func (tcb *Tcb) DatabaseMigrateImport(req *DatabaseMigrateImportReq) (*DatabaseM
|
||||
}
|
||||
|
||||
// DatabaseMigrateExport 数据库导出
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateExport.html
|
||||
func (tcb *Tcb) DatabaseMigrateExport(req *DatabaseMigrateExportReq) (*DatabaseMigrateExportRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -226,6 +228,7 @@ func (tcb *Tcb) DatabaseMigrateExport(req *DatabaseMigrateExportReq) (*DatabaseM
|
||||
}
|
||||
|
||||
// DatabaseMigrateQueryInfo 数据库迁移状态查询
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateQueryInfo.html
|
||||
func (tcb *Tcb) DatabaseMigrateQueryInfo(env string, jobID int64) (*DatabaseMigrateQueryInfoRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -261,6 +264,7 @@ func (tcb *Tcb) UpdateIndex(req *UpdateIndexReq) error {
|
||||
}
|
||||
|
||||
// DatabaseCollectionAdd 新增集合
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionAdd.html
|
||||
func (tcb *Tcb) DatabaseCollectionAdd(env, collectionName string) error {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -279,6 +283,7 @@ func (tcb *Tcb) DatabaseCollectionAdd(env, collectionName string) error {
|
||||
}
|
||||
|
||||
// DatabaseCollectionDelete 删除集合
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionDelete.html
|
||||
func (tcb *Tcb) DatabaseCollectionDelete(env, collectionName string) error {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -297,6 +302,7 @@ func (tcb *Tcb) DatabaseCollectionDelete(env, collectionName string) error {
|
||||
}
|
||||
|
||||
// DatabaseCollectionGet 获取特定云环境下集合信息
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionGet.html
|
||||
func (tcb *Tcb) DatabaseCollectionGet(env string, limit, offset int64) (*DatabaseCollectionGetRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -318,6 +324,7 @@ func (tcb *Tcb) DatabaseCollectionGet(env string, limit, offset int64) (*Databas
|
||||
}
|
||||
|
||||
// DatabaseAdd 数据库插入记录
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseAdd.html
|
||||
func (tcb *Tcb) DatabaseAdd(env, query string) (*DatabaseAddRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -338,6 +345,7 @@ func (tcb *Tcb) DatabaseAdd(env, query string) (*DatabaseAddRes, error) {
|
||||
}
|
||||
|
||||
// DatabaseDelete 数据库插入记录
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseDelete.html
|
||||
func (tcb *Tcb) DatabaseDelete(env, query string) (*DatabaseDeleteRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -358,6 +366,7 @@ func (tcb *Tcb) DatabaseDelete(env, query string) (*DatabaseDeleteRes, error) {
|
||||
}
|
||||
|
||||
// DatabaseUpdate 数据库插入记录
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseUpdate.html
|
||||
func (tcb *Tcb) DatabaseUpdate(env, query string) (*DatabaseUpdateRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -378,6 +387,7 @@ func (tcb *Tcb) DatabaseUpdate(env, query string) (*DatabaseUpdateRes, error) {
|
||||
}
|
||||
|
||||
// DatabaseQuery 数据库查询记录
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseQuery.html
|
||||
func (tcb *Tcb) DatabaseQuery(env, query string) (*DatabaseQueryRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -398,6 +408,7 @@ func (tcb *Tcb) DatabaseQuery(env, query string) (*DatabaseQueryRes, error) {
|
||||
}
|
||||
|
||||
// DatabaseCount 统计集合记录数或统计查询语句对应的结果记录数
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCount.html
|
||||
func (tcb *Tcb) DatabaseCount(env, query string) (*DatabaseCountRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
|
||||
@@ -71,6 +71,7 @@ type BatchDeleteFileRes struct {
|
||||
}
|
||||
|
||||
// UploadFile 上传文件
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/uploadFile.html
|
||||
func (tcb *Tcb) UploadFile(env, path string) (*UploadFileRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -92,6 +93,7 @@ func (tcb *Tcb) UploadFile(env, path string) (*UploadFileRes, error) {
|
||||
}
|
||||
|
||||
// BatchDownloadFile 获取文件下载链接
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/batchDownloadFile.html
|
||||
func (tcb *Tcb) BatchDownloadFile(env string, fileList []*DownloadFile) (*BatchDownloadFileRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -113,6 +115,7 @@ func (tcb *Tcb) BatchDownloadFile(env string, fileList []*DownloadFile) (*BatchD
|
||||
}
|
||||
|
||||
// BatchDeleteFile 批量删除文件
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/batchDeleteFile.html
|
||||
func (tcb *Tcb) BatchDeleteFile(env string, fileIDList []string) (*BatchDeleteFileRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
|
||||
52
miniprogram/urllink/query.go
Normal file
52
miniprogram/urllink/query.go
Normal file
@@ -0,0 +1,52 @@
|
||||
package urllink
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const queryURL = "https://api.weixin.qq.com/wxa/query_urllink"
|
||||
|
||||
// ULQueryResult 返回的结果
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-link/urllink.query.html 返回值
|
||||
type ULQueryResult struct {
|
||||
util.CommonError
|
||||
|
||||
URLLinkInfo struct {
|
||||
Appid string `json:"appid"`
|
||||
Path string `json:"path"`
|
||||
Query string `json:"query"`
|
||||
CreateTime int64 `json:"create_time"`
|
||||
ExpireTime int64 `json:"expire_time"`
|
||||
EnvVersion string `json:"env_version"`
|
||||
CloudBase struct {
|
||||
Env string `json:"env"`
|
||||
Domain string `json:"domain"`
|
||||
Path string `json:"path"`
|
||||
Query string `json:"query"`
|
||||
ResourceAppid string `json:"resource_appid"`
|
||||
} `json:"cloud_base"`
|
||||
} `json:"url_link_info"`
|
||||
VisitOpenid string `json:"visit_openid"`
|
||||
}
|
||||
|
||||
// Query 查询小程序 url_link 配置。
|
||||
func (u *URLLink) Query(urlLink string) (*ULQueryResult, error) {
|
||||
accessToken, err := u.GetAccessToken()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf("%s?access_token=%s", queryURL, accessToken)
|
||||
response, err := util.PostJSON(uri, map[string]string{"url_link": urlLink})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var resp ULQueryResult
|
||||
err = util.DecodeWithError(response, &resp, "URLLink.Query")
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return &resp, nil
|
||||
}
|
||||
@@ -65,8 +65,5 @@ func (u *URLLink) Generate(params *ULParams) (string, error) {
|
||||
}
|
||||
var resp ULResult
|
||||
err = util.DecodeWithError(response, &resp, "URLLink.Generate")
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return resp.URLLink, nil
|
||||
return resp.URLLink, err
|
||||
}
|
||||
|
||||
@@ -37,7 +37,7 @@ type SchemeInfo struct {
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-scheme/urlscheme.query.html#参数
|
||||
type resQueryScheme struct {
|
||||
// 通用错误
|
||||
*util.CommonError
|
||||
util.CommonError
|
||||
// scheme 配置
|
||||
SchemeInfo SchemeInfo `json:"scheme_info"`
|
||||
// 访问该链接的openid,没有用户访问过则为空字符串
|
||||
@@ -62,9 +62,5 @@ func (u *URLScheme) QueryScheme(querySchemeParams QueryScheme) (schemeInfo Schem
|
||||
// 使用通用方法返回错误
|
||||
var res resQueryScheme
|
||||
err = util.DecodeWithError(response, &res, "QueryScheme")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
return res.SchemeInfo, res.VisitOpenid, nil
|
||||
return res.SchemeInfo, res.VisitOpenid, err
|
||||
}
|
||||
|
||||
@@ -78,8 +78,5 @@ func (u *URLScheme) Generate(params *USParams) (string, error) {
|
||||
}
|
||||
var resp USResult
|
||||
err = util.DecodeWithError(response, &resp, "URLScheme.Generate")
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return resp.OpenLink, nil
|
||||
return resp.OpenLink, err
|
||||
}
|
||||
|
||||
134
miniprogram/virtualpayment/constant.go
Normal file
134
miniprogram/virtualpayment/constant.go
Normal file
@@ -0,0 +1,134 @@
|
||||
/*
|
||||
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
* You can obtain one at https://github.com/silenceper/wechat.
|
||||
*
|
||||
*/
|
||||
|
||||
package virtualpayment
|
||||
|
||||
const (
|
||||
// EnvProduction 环境 0-正式环境 1-沙箱环境
|
||||
EnvProduction Env = 0
|
||||
// EnvSandbox 环境 0-正式环境 1-沙箱环境
|
||||
EnvSandbox Env = 1
|
||||
)
|
||||
|
||||
const (
|
||||
// Success 错误码 0、成功
|
||||
Success ErrCode = 0
|
||||
// SystemError 错误码 -1、系统错误
|
||||
SystemError ErrCode = -1
|
||||
// OpenIDError 错误码 268490001、openid 错误
|
||||
OpenIDError ErrCode = 268490001
|
||||
// RequestParamError 错误码 268490002、请求参数字段错误,具体看 errmsg
|
||||
RequestParamError ErrCode = 268490002
|
||||
// SignError 错误码 268490003、签名错误
|
||||
SignError ErrCode = 268490003
|
||||
// RepeatOperationError 错误码 268490004、重复操作(赠送和代币支付相关接口会返回,表示之前的操作已经成功)
|
||||
RepeatOperationError ErrCode = 268490004
|
||||
// OrderRefundedError 错误码 268490005、订单已经通过 cancel_currency_pay 接口退款,不支持再退款
|
||||
OrderRefundedError ErrCode = 268490005
|
||||
// InsufficientBalanceError 错误码 268490006、代币的退款/支付操作金额不足
|
||||
InsufficientBalanceError ErrCode = 268490006
|
||||
// SensitiveContentError 错误码 268490007、图片或文字存在敏感内容,禁止使用
|
||||
SensitiveContentError ErrCode = 268490007
|
||||
// TokenNotPublishedError 错误码 268490008、代币未发布,不允许进行代币操作
|
||||
TokenNotPublishedError ErrCode = 268490008
|
||||
// SessionKeyExpiredError 错误码 268490009、用户 session_key 不存在或已过期,请重新登录
|
||||
SessionKeyExpiredError ErrCode = 268490009
|
||||
// BillGeneratingError 错误码 268490011、账单数据生成中,请稍后调用本接口获取
|
||||
BillGeneratingError ErrCode = 268490011
|
||||
)
|
||||
|
||||
const (
|
||||
// OrderStatusInit 订单状态 当前状态 0-订单初始化(未创建成功,不可用于支付)
|
||||
OrderStatusInit OrderStatus = 0
|
||||
// OrderStatusCreated 订单状态 当前状态 1-订单创建成功
|
||||
OrderStatusCreated OrderStatus = 1
|
||||
// OrderStatusPaid 订单状态 当前状态 2-订单已经支付,待发货
|
||||
OrderStatusPaid OrderStatus = 2
|
||||
// OrderStatusDelivering 订单状态 当前状态 3-订单发货中
|
||||
OrderStatusDelivering OrderStatus = 3
|
||||
// OrderStatusDelivered 订单状态 当前状态 4-订单已发货
|
||||
OrderStatusDelivered OrderStatus = 4
|
||||
// OrderStatusRefunded 订单状态 当前状态 5-订单已经退款
|
||||
OrderStatusRefunded OrderStatus = 5
|
||||
// OrderStatusClosed 订单状态 当前状态 6-订单已经关闭(不可再使用)
|
||||
OrderStatusClosed OrderStatus = 6
|
||||
// OrderStatusRefundFailed 订单状态 当前状态 7-订单退款失败
|
||||
OrderStatusRefundFailed OrderStatus = 7
|
||||
)
|
||||
|
||||
const (
|
||||
// baseSite 基础网址
|
||||
baseSite = "https://api.weixin.qq.com"
|
||||
|
||||
// queryUserBalance 查询虚拟支付余额
|
||||
queryUserBalance = "/xpay/query_user_balance"
|
||||
|
||||
// currencyPay 扣减代币(一般用于代币支付)
|
||||
currencyPay = "/xpay/currency_pay"
|
||||
|
||||
// queryOrder 查询创建的订单(现金单,非代币单)
|
||||
queryOrder = "/xpay/query_order"
|
||||
|
||||
// cancelCurrencyPay 代币支付退款 (currency_pay 接口的逆操作)
|
||||
cancelCurrencyPay = "/xpay/cancel_currency_pay"
|
||||
|
||||
// notifyProvideGoods 通知已经发货完成(只能通知现金单),正常通过 xpay_goods_deliver_notify 消息推送返回成功就不需要调用这个 api 接口。这个接口用于异常情况推送不成功时手动将单改成已发货状态
|
||||
notifyProvideGoods = "/xpay/notify_provide_goods"
|
||||
|
||||
// presentCurrency 代币赠送接口,由于目前不支付按单号查赠送单的功能,所以当需要赠送的时候可以一直重试到返回 0 或者返回 268490004(重复操作)为止
|
||||
presentCurrency = "/xpay/present_currency"
|
||||
|
||||
// downloadBill 下载账单
|
||||
downloadBill = "/xpay/download_bill"
|
||||
|
||||
// refundOrder 退款 对使用 jsapi 接口下的单进行退款
|
||||
refundOrder = "/xpay/refund_order"
|
||||
|
||||
// createWithdrawOrder 创建提现单
|
||||
createWithdrawOrder = "/xpay/create_withdraw_order"
|
||||
|
||||
// queryWithdrawOrder 查询提现单
|
||||
queryWithdrawOrder = "/xpay/query_withdraw_order"
|
||||
|
||||
// startUploadGoods 启动批量上传道具任务
|
||||
startUploadGoods = "/xpay/start_upload_goods"
|
||||
|
||||
// queryUploadGoods 查询批量上传道具任务状态
|
||||
queryUploadGoods = "/xpay/query_upload_goods"
|
||||
|
||||
// startPublishGoods 启动批量发布道具任务
|
||||
startPublishGoods = "/xpay/start_publish_goods"
|
||||
|
||||
// queryPublishGoods 查询批量发布道具任务状态
|
||||
queryPublishGoods = "/xpay/query_publish_goods"
|
||||
)
|
||||
|
||||
const (
|
||||
// signature user mode signature
|
||||
signature = "signature"
|
||||
|
||||
// paySignature payment signature
|
||||
paySignature = "pay_sig"
|
||||
|
||||
// accessToken access_token authorization tokens
|
||||
accessToken = "access_token"
|
||||
|
||||
// EmptyString empty string
|
||||
EmptyString = ""
|
||||
)
|
||||
32
miniprogram/virtualpayment/doc.go
Normal file
32
miniprogram/virtualpayment/doc.go
Normal file
@@ -0,0 +1,32 @@
|
||||
/*
|
||||
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
* You can obtain one at https://github.com/silenceper/wechat.
|
||||
*
|
||||
*/
|
||||
|
||||
// Package virtualpayment mini program virtual payment
|
||||
package virtualpayment
|
||||
|
||||
import (
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
)
|
||||
|
||||
// NewVirtualPayment 实例化小程序虚拟支付 API
|
||||
func NewVirtualPayment(ctx *context.Context) *VirtualPayment {
|
||||
return &VirtualPayment{
|
||||
ctx: ctx,
|
||||
}
|
||||
}
|
||||
427
miniprogram/virtualpayment/domain.go
Normal file
427
miniprogram/virtualpayment/domain.go
Normal file
@@ -0,0 +1,427 @@
|
||||
/*
|
||||
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
* You can obtain one at https://github.com/silenceper/wechat.
|
||||
*
|
||||
*/
|
||||
|
||||
package virtualpayment
|
||||
|
||||
import (
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
// VirtualPayment mini program virtual payment
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/virtual-payment.html#_2-3-%E6%9C%8D%E5%8A%A1%E5%99%A8API
|
||||
type VirtualPayment struct {
|
||||
ctx *context.Context
|
||||
sessionKey string
|
||||
}
|
||||
|
||||
// Env Environment 0 - Production environment 1 - Sandbox environment
|
||||
type Env int
|
||||
|
||||
// ErrCode error code
|
||||
type ErrCode int
|
||||
|
||||
// OrderStatus 订单状态
|
||||
type OrderStatus int
|
||||
|
||||
// CommonRequest common request parameters
|
||||
type CommonRequest struct {
|
||||
OpenID string `json:"openid"` // The user's openID
|
||||
Env Env `json:"env"` // Environment 0 - Production environment 1 - Sandbox environment
|
||||
}
|
||||
|
||||
// PaymentRequest payment request parameters
|
||||
type PaymentRequest struct {
|
||||
SignData string `json:"sign_data"` // 具体支付参数见 signData, 该参数需以 string 形式传递,例如 signData: '{"offerId":"123","buyQuantity":1,"env":0,"currencyType":"CNY","platform":"android","productId":"testproductId","goodsPrice":10,"outTradeNo":"xxxxxx","attach":"testdata"}'
|
||||
Mode string `json:"mode"` // 支付模式,枚举值:short_series_goods: 道具直购,short_series_coin: 代币充值
|
||||
PaySig string `json:"pay_sig"` // 支付签名,具体生成方式见下方说明
|
||||
Signature string `json:"signature"` // 用户态签名,具体生成方式见下方说明
|
||||
}
|
||||
|
||||
// SignData 签名数据
|
||||
type SignData struct {
|
||||
OfferID string `json:"offerId"` // 在米大师侧申请的应用 id, mp-支付基础配置中的 offerid
|
||||
BuyQuantity int `json:"buyQuantity"` // 购买数量
|
||||
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
|
||||
CurrencyType string `json:"currencyType"` // 币种 默认值:CNY 人民币
|
||||
Platform string `json:"platform,omitempty"` // 申请接入时的平台,platform 与应用 id 有关 默认值:android 安卓平台
|
||||
ProductID string `json:"productId,omitempty"` // 道具 ID, **该字段仅 mode=short_series_goods 时可用**
|
||||
GoodsPrice int `json:"goodsPrice"` // 道具单价 (分), **该字段仅 mode=short_series_goods 时可用**, 用来校验价格与后台道具价格是否一致,避免用户在业务商城页看到的价格与实际价格不一致导致投诉
|
||||
OutTradeNo string `json:"outTradeNo"` // 业务订单号,每个订单号只能使用一次,重复使用会失败 (极端情况不保证唯一,不建议业务强依赖唯一性). 要求 8-32 个字符内,只能是数字、大小写字母、符号 _-|*@组成,不能以下划线 (_) 开头
|
||||
Attach string `json:"attach"` // 透传数据,发货通知时会透传给开发者
|
||||
}
|
||||
|
||||
// QueryUserBalanceRequest 查询用户代币余额,请求参数
|
||||
// 1. 需要用户态签名与支付签名
|
||||
// POST,请求参数为 json 字符串,Content-Type 为 application/json
|
||||
type QueryUserBalanceRequest struct {
|
||||
CommonRequest
|
||||
UserIP string `json:"user_ip"` // 用户 ip,例如:1.1.1.1
|
||||
}
|
||||
|
||||
// QueryUserBalanceResponse 查询虚拟支付余额 响应参数
|
||||
type QueryUserBalanceResponse struct {
|
||||
util.CommonError
|
||||
Balance int `json:"balance"` // 代币总余额,包括有价和赠送部分
|
||||
PresentBalance int `json:"present_balance"` // 赠送账户的代币余额
|
||||
SumSave int `json:"sum_save"` // 累计有价货币充值数量
|
||||
SumPresent int `json:"sum_present"` // 累计赠送无价货币数量
|
||||
SumBalance int `json:"sum_balance"` // 历史总增加的代币金额
|
||||
SumCost int `json:"sum_cost"` // 历史总消耗代币金额
|
||||
FirstSaveFlag int `json:"first_save_flag"` // 是否满足首充活动标记。0:不满足。1:满足
|
||||
}
|
||||
|
||||
// CurrencyPayRequest 扣减代币(一般用于代币支付)
|
||||
// 1. 需要用户态签名与支付签名
|
||||
// POST,请求参数为 json 字符串,Content-Type 为 application/json
|
||||
type CurrencyPayRequest struct {
|
||||
CommonRequest
|
||||
UserIP string `json:"user_ip"` // 用户 ip,例如:1.1.1.1
|
||||
Amount int `json:"amount"` // 支付的代币数量
|
||||
OrderID string `json:"order_id"` // 商户订单号,需要保证唯一性
|
||||
PayItem string `json:"payitem"` // 物品信息。记录到账户流水中。如:[{"productid":"物品 id", "unit_price": 单价,"quantity": 数量}]
|
||||
Remark string `json:"remark"` // 备注信息。需要在账单中展示
|
||||
DeviceType string `json:"device_type"` // 平台类型 1-安卓 2-苹果
|
||||
}
|
||||
|
||||
// PayItem 物品信息
|
||||
type PayItem struct {
|
||||
ProductID string `json:"productid"` // 物品 id
|
||||
UnitPrice int `json:"unit_price"` // 单价
|
||||
Quantity int `json:"quantity"` // 数量
|
||||
}
|
||||
|
||||
// CurrencyPayResponse 扣减代币(一般用于代币支付)响应参数
|
||||
type CurrencyPayResponse struct {
|
||||
util.CommonError
|
||||
OrderID string `json:"order_id"` // 商户订单号
|
||||
Balance int `json:"balance"` // 总余额,包括有价和赠送部分
|
||||
UsedPresentAmount int `json:"used_present_amount"` // 使用赠送部分的代币数量
|
||||
}
|
||||
|
||||
// QueryOrderRequest 查询创建的订单(现金单,非代币单),请求参数
|
||||
// 1. 使用支付签名
|
||||
// POST,请求参数为 json 字符串,Content-Type 为 application/json
|
||||
type QueryOrderRequest struct {
|
||||
CommonRequest
|
||||
OrderID string `json:"order_id,omitempty"` // 商户订单号 创建的订单号
|
||||
WxOrderID string `json:"wx_order_id,omitempty"` // 微信内部单号 (与 order_id 二选一)
|
||||
}
|
||||
|
||||
// OrderItem 订单信息
|
||||
type OrderItem struct {
|
||||
OrderID string `json:"order_id"` // 商户订单号
|
||||
CreateTime int64 `json:"create_time"` // 订单创建时间
|
||||
UpdateTime int64 `json:"update_time"` // 订单更新时间
|
||||
Status OrderStatus `json:"status"` // 订单状态 当前状态 0-订单初始化(未创建成功,不可用于支付)1-订单创建成功 2-订单已经支付,待发货 3-订单发货中 4-订单已发货 5-订单已经退款 6-订单已经关闭(不可再使用)7-订单退款失败
|
||||
BizType int `json:"biz_type"` // 业务类型 0-短剧
|
||||
OrderFee int `json:"order_fee"` // 订单金额,单位:分
|
||||
CouponFee int `json:"coupon_fee"` // 优惠金额,单位:分
|
||||
PaidFee int `json:"paid_fee"` // 用户支付金额,单位:分
|
||||
OrderType int `json:"order_type"` // 订单类型 0-支付单 1-退款单
|
||||
RefundFee int `json:"refund_fee"` // 当类型为退款单时表示退款金额,单位分
|
||||
PaidTime int64 `json:"paid_time"` // 支付/退款时间,unix秒级时间戳
|
||||
ProvideTime int64 `json:"provide_time"` // 发货时间,unix 秒级时间戳
|
||||
BizMeta string `json:"biz_meta"` // 业务自定义数据 订单创建时传的信息
|
||||
EnvType int `json:"env_type"` // 环境类型 1-现网 2-沙箱
|
||||
Token string `json:"token"` // 下单时米大师返回的 token
|
||||
LeftFee int `json:"left_fee"` // 支付单类型时表示此单经过退款还剩余的金额,单位:分
|
||||
WxOrderID string `json:"wx_order_id"` // 微信内部单号
|
||||
ChannelOrderID string `json:"channel_order_id"` // 渠道订单号,为用户微信支付详情页面上的商户单号
|
||||
WxPayOrderID string `json:"wxpay_order_id"` // 微信支付交易单号,为用户微信支付详情页面上的交易单号
|
||||
}
|
||||
|
||||
// QueryOrderResponse 查询创建的订单(现金单,非代币单)响应参数
|
||||
type QueryOrderResponse struct {
|
||||
util.CommonError
|
||||
Order *OrderItem `json:"order"` // 订单信息
|
||||
}
|
||||
|
||||
// CancelCurrencyPayRequest 取消订单(现金单,非代币单),请求参数
|
||||
// 1. 使用支付签名
|
||||
// POST,请求参数为 json 字符串,Content-Type 为 application/json
|
||||
type CancelCurrencyPayRequest struct {
|
||||
CommonRequest
|
||||
UserIP string `json:"user_ip"` // 用户 ip,例如:1.1.1.1
|
||||
PayOrderID string `json:"pay_order_id"` // 支付单号 代币支付 (调用 currency_pay 接口时) 时传的 order_id
|
||||
OrderID string `json:"order_id"` // 本次退款单的单号
|
||||
Amount int `json:"amount"` // 退款金额
|
||||
DeviceType int `json:"device_type"` // 平台类型 1-安卓 2-苹果
|
||||
}
|
||||
|
||||
// CancelCurrencyPayResponse 取消订单(现金单,非代币单)响应参数
|
||||
type CancelCurrencyPayResponse struct {
|
||||
util.CommonError
|
||||
OrderID string `json:"order_id"` // 退款订单号
|
||||
}
|
||||
|
||||
// NotifyProvideGoodsRequest 通知发货,请求参数
|
||||
// 通知已经发货完成(只能通知现金单),正常通过 xpay_goods_deliver_notify 消息推送返回成功就不需要调用这个 api 接口。这个接口用于异常情况推送不成功时手动将单改成已发货状态
|
||||
// 1. 使用支付签名
|
||||
// POST,请求参数为 json 字符串,Content-Type 为 application/json
|
||||
type NotifyProvideGoodsRequest struct {
|
||||
OrderID string `json:"order_id,omitempty"` // 商户订单号 下单时传的单号
|
||||
WxOrderID string `json:"wx_order_id,omitempty"` // 微信内部单号 (与 order_id 二选一)
|
||||
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
|
||||
}
|
||||
|
||||
// NotifyProvideGoodsResponse 通知发货响应参数
|
||||
type NotifyProvideGoodsResponse struct {
|
||||
util.CommonError
|
||||
}
|
||||
|
||||
// PresentCurrencyRequest 赠送代币,请求参数
|
||||
// 代币赠送接口,由于目前不支付按单号查赠送单的功能,所以当需要赠送的时候可以一直重试到返回 0 或者返回 268490004(重复操作)为止
|
||||
// 1. 需要用户态签名与支付签名
|
||||
// POST,请求参数为 json 字符串,Content-Type 为 application/json
|
||||
type PresentCurrencyRequest struct {
|
||||
CommonRequest
|
||||
OrderID string `json:"order_id"` // 赠送单号,商户订单号,需要保证唯一性
|
||||
Amount int `json:"amount"` // 赠送的代币数量
|
||||
DeviceType string `json:"device_type"` // 平台类型 1-安卓 2-苹果
|
||||
}
|
||||
|
||||
// PresentCurrencyResponse 赠送代币响应参数
|
||||
type PresentCurrencyResponse struct {
|
||||
util.CommonError
|
||||
Balance int `json:"balance"` // 赠送后用户的代币余额
|
||||
OrderID string `json:"order_id"` // 赠送单号
|
||||
PresentBalance int `json:"present_balance"` // 用户收到的总赠送金额
|
||||
}
|
||||
|
||||
// DownloadBillRequest 下载账单,请求参数
|
||||
// 用于下载小程序账单,第一次调用触发生成下载 url,可以间隔轮训来获取最终生成的下载 url。账单中金额相关字段是以分为单位。
|
||||
// 1. 使用支付签名
|
||||
// POST,请求参数为 json 字符串,Content-Type 为 application/json
|
||||
type DownloadBillRequest struct {
|
||||
BeginDs string `json:"begin_ds"` // 账单开始日期,格式为 yyyymmdd 起始时间(如 20230801)
|
||||
EndDs string `json:"end_ds"` // 账单结束日期,格式为 yyyymmdd 结束时间(如 20230801)
|
||||
}
|
||||
|
||||
// DownloadBillResponse 下载账单响应参数
|
||||
type DownloadBillResponse struct {
|
||||
util.CommonError
|
||||
URL string `json:"url"` // 账单下载地址
|
||||
}
|
||||
|
||||
// RefundOrderRequest 退款,请求参数
|
||||
// 对使用 jsapi 接口下的单进行退款
|
||||
// 1. 使用支付签名
|
||||
// POST,请求参数为 json 字符串,Content-Type 为 application/json
|
||||
type RefundOrderRequest struct {
|
||||
CommonRequest
|
||||
OrderID string `json:"order_id"` // 商户订单号,需要保证唯一性
|
||||
WxOrderID string `json:"wx_order_id"` // 微信内部单号 (与 order_id 二选一)
|
||||
RefundOrderID string `json:"refund_order_id"` // 退款单号,本次退款时需要传的单号,长度为 [8,32],字符只允许使用字母、数字、'_'、'-'
|
||||
LeftFee int `json:"left_fee"` // 退款金额,单位:分 当前单剩余可退金额,单位分,可以通过调用 query_order 接口查到
|
||||
RefundFee int `json:"refund_fee"` // 退款金额,单位:分 需要 (0,left_fee] 之间
|
||||
BizMeta string `json:"biz_meta"` // 商家自定义数据,传入后可在 query_order 接口查询时原样返回,长度需要 [0,1024]
|
||||
RefundReason string `json:"refund_reason"` // 退款原因,当前仅支持以下值 0-暂无描述 1-产品问题,影响使用或效果不佳 2-售后问题,无法满足需求 3-意愿问题,用户主动退款 4-价格问题 5:其他原因
|
||||
ReqFrom string `json:"req_from"` // 退款来源,当前仅支持以下值 1-人工客服退款,即用户电话给客服,由客服发起退款流程 2-用户自己发起退款流程 3-其它
|
||||
}
|
||||
|
||||
// RefundOrderResponse 退款响应参数
|
||||
type RefundOrderResponse struct {
|
||||
util.CommonError
|
||||
RefundOrderID string `json:"refund_order_id"` // 退款单号
|
||||
RefundWxOrderID string `json:"refund_wx_order_id"` // 退款单的微信侧单号
|
||||
PayOrderID string `json:"pay_order_id"` // 该退款单对应的支付单单号
|
||||
PayWxOrderID string `json:"pay_wx_order_id"` // 该退款单对应的支付单微信侧单号
|
||||
}
|
||||
|
||||
// CreateWithdrawOrderRequest 创建提现单,请求参数
|
||||
// 1. 使用支付签名
|
||||
// POST,请求参数为 json 字符串,Content-Type 为 application/json
|
||||
type CreateWithdrawOrderRequest struct {
|
||||
WithdrawNO string `json:"withdraw_no"` // 提现单单号,长度为 [8,32],字符只允许使用字母、数字、'_'、'-'
|
||||
WithdrawAmount string `json:"withdraw_amount"` // 提现的金额,单位元,例如提现 1 分钱请使用 0.01
|
||||
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
|
||||
}
|
||||
|
||||
// CreateWithdrawOrderResponse 创建提现单响应参数
|
||||
type CreateWithdrawOrderResponse struct {
|
||||
util.CommonError
|
||||
WithdrawNO string `json:"withdraw_no"` // 提现单单号
|
||||
WxWithdrawNO string `json:"wx_withdraw_no"` // 提现单的微信侧单号
|
||||
}
|
||||
|
||||
// QueryWithdrawOrderRequest 查询提现单,请求参数
|
||||
// 1. 使用支付签名
|
||||
// POST,请求参数为 json 字符串,Content-Type 为 application/json
|
||||
type QueryWithdrawOrderRequest struct {
|
||||
WithdrawNO string `json:"withdraw_no"` // 提现单单号,长度为 [8,32],字符只允许使用字母、数字、'_'、'-' (与 wx_withdraw_no 二选一)
|
||||
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
|
||||
}
|
||||
|
||||
// QueryWithdrawOrderResponse 查询提现单响应参数
|
||||
type QueryWithdrawOrderResponse struct {
|
||||
util.CommonError
|
||||
WithdrawNO string `json:"withdraw_no"` // 提现单单号
|
||||
Status int `json:"status"` // 提现单的微信侧单号 1-创建成功,提现中 2-提现成功 3-提现失败
|
||||
WithdrawAmount string `json:"withdraw_amount"` // 提现的金额,单位元,例如提现 1 分钱请使用 0.01
|
||||
WxWithdrawNo string `json:"wx_withdraw_no"` // 提现单的微信侧单号
|
||||
WithdrawSuccessTimestamp int64 `json:"withdraw_success_timestamp"` // 提现单成功的秒级时间戳,unix 秒级时间戳
|
||||
CreateTime string `json:"create_time"` // 提现单创建时间
|
||||
FailReason string `json:"failReason"` // 提现失败的原因
|
||||
}
|
||||
|
||||
// StartUploadGoodsRequest 启动批量上传道具任务,请求参数
|
||||
// 1. 使用支付签名
|
||||
// POST,请求参数为 json 字符串,Content-Type 为 application/json
|
||||
type StartUploadGoodsRequest struct {
|
||||
UploadItem []*UploadItem `json:"upload_item"` // 道具信息
|
||||
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
|
||||
}
|
||||
|
||||
// UploadItem 道具信息
|
||||
type UploadItem struct {
|
||||
ID string `json:"id"` // 道具 id,长度 (0,64],字符只允许使用字母、数字、'_'、'-'
|
||||
Name string `json:"name"` // 道具名称,长度 (0,1024]
|
||||
Price int `json:"price"` // 道具单价,单位分,需要大于 0
|
||||
Remark string `json:"remark"` // 道具备注,长度 (0,1024]
|
||||
ItemURL string `json:"item_url"` // 道具图片的 url 地址,当前仅支持 jpg,png 等格式
|
||||
UploadStatus int `json:"upload_status,omitempty"` // 上传状态 0-上传中 1-id 已经存在 2-上传成功 3-上传失败
|
||||
ErrMsg string `json:"errmsg,omitempty"` // 上传失败的原因
|
||||
}
|
||||
|
||||
// StartUploadGoodsResponse 启动批量上传道具任务响应参数
|
||||
type StartUploadGoodsResponse struct {
|
||||
util.CommonError
|
||||
}
|
||||
|
||||
// QueryUploadGoodsRequest 查询批量上传道具任务,请求参数
|
||||
// 1. 使用支付签名
|
||||
// POST,请求参数为 json 字符串,Content-Type 为 application/json
|
||||
type QueryUploadGoodsRequest struct {
|
||||
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
|
||||
}
|
||||
|
||||
// QueryUploadGoodsResponse 查询批量上传道具任务响应参数
|
||||
type QueryUploadGoodsResponse struct {
|
||||
util.CommonError
|
||||
UploadItem []*UploadItem `json:"upload_item"` // 道具信息列表
|
||||
Status int `json:"status"` // 任务状态 0-无任务在运行 1-任务运行中 2-上传失败或部分失败(上传任务已经完成)3-上传成功
|
||||
}
|
||||
|
||||
// StartPublishGoodsRequest 启动批量发布道具任务,请求参数
|
||||
// 1. 使用支付签名
|
||||
// POST,请求参数为 json 字符串,Content-Type 为 application/json
|
||||
type StartPublishGoodsRequest struct {
|
||||
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
|
||||
PublishItem []*PublishItem `json:"publish_item"` // 道具信息 发布的商品列表
|
||||
}
|
||||
|
||||
// PublishItem 道具信息
|
||||
type PublishItem struct {
|
||||
ID string `json:"id"` // 道具 id,添加到开发环境时传的道具 id,长度 (0,64],字符只允许使用字母、数字、'_'、'-'
|
||||
PublishStatus int `json:"publish_status,omitempty"` // 发布状态 0-上传中 1-id 已经存在 2-发布成功 3-发布失败
|
||||
ErrMsg string `json:"errmsg,omitempty"` // 发布失败的原因
|
||||
}
|
||||
|
||||
// StartPublishGoodsResponse 启动批量发布道具任务响应参数
|
||||
type StartPublishGoodsResponse struct {
|
||||
util.CommonError
|
||||
}
|
||||
|
||||
// QueryPublishGoodsRequest 查询批量发布道具任务,请求参数
|
||||
// 1. 使用支付签名
|
||||
// POST,请求参数为 json 字符串,Content-Type 为 application/json
|
||||
type QueryPublishGoodsRequest struct {
|
||||
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
|
||||
}
|
||||
|
||||
// QueryPublishGoodsResponse 查询批量发布道具任务响应参数
|
||||
type QueryPublishGoodsResponse struct {
|
||||
util.CommonError
|
||||
PublishItem []*PublishItem `json:"publish_item"` // 道具信息列表
|
||||
Status int `json:"status"` // 任务状态 0-无任务在运行 1-任务运行中 2-上传失败或部分失败(上传任务已经完成)3-上传成功
|
||||
|
||||
}
|
||||
|
||||
// AsyncXPayGoodsDeliverNotifyRequest 异步通知发货,请求参数
|
||||
// 1. 使用支付签名
|
||||
// POST,请求参数为 json 字符串,Content-Type 为 application/json
|
||||
type AsyncXPayGoodsDeliverNotifyRequest struct {
|
||||
ToUserName string `json:"ToUserName"` // 小程序的原始 ID
|
||||
FromUserName string `json:"FromUserName"` // 发送方帐号(一个 OpenID)该事件消息的 openid,道具发货场景固定为微信官方的 openid
|
||||
CreateTime int `json:"CreateTime"` // 消息发送时间(整型)
|
||||
MsgType string `json:"MsgType"` // 消息类型,此时固定为:event
|
||||
Event string `json:"Event"` // 事件类型,此时固定为:xpay_goods_deliver_notify
|
||||
Openid string `json:"openid"` // 用户 openid
|
||||
OutTradeNo string `json:"OutTradeNo"` // 业务订单号
|
||||
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
|
||||
WechatPayInfo *WeChatPayInfo `json:"WechatPayInfo"` // 微信支付订单信息
|
||||
GoodsInfo *GoodsInfo `json:"GoodsInfo"` // 道具信息
|
||||
}
|
||||
|
||||
// WeChatPayInfo 微信支付信息 非微信支付渠道可能没有
|
||||
type WeChatPayInfo struct {
|
||||
MchOrderNo string `json:"MchOrderNo"` // 商户订单号
|
||||
TransactionID string `json:"TransactionId"` // 微信支付订单号
|
||||
}
|
||||
|
||||
// GoodsInfo 道具参数信息
|
||||
type GoodsInfo struct {
|
||||
ProductID string `json:"ProductId"` // 道具 ID
|
||||
Quantity int `json:"Quantity"` // 数量
|
||||
OrigPrice int `json:"OrigPrice"` // 物品原始价格(单位:分)
|
||||
ActualPrice int `json:"ActualPrice"` // 物品实际支付价格(单位:分)
|
||||
Attach string `json:"Attach"` // 透传信息
|
||||
}
|
||||
|
||||
// AsyncXPayGoodsDeliverNotifyResponse 异步通知发货响应参数
|
||||
type AsyncXPayGoodsDeliverNotifyResponse struct {
|
||||
util.CommonError
|
||||
}
|
||||
|
||||
// AsyncXPayCoinPayNotifyRequest 异步通知代币支付推送,请求参数
|
||||
type AsyncXPayCoinPayNotifyRequest struct {
|
||||
ToUserName string `json:"ToUserName"` // 小程序的原始 ID
|
||||
FromUserName string `json:"FromUserName"` // 发送方帐号(一个 OpenID)该事件消息的 openid,道具发货场景固定为微信官方的 openid
|
||||
CreateTime int `json:"CreateTime"` // 消息发送时间(整型)
|
||||
MsgType string `json:"MsgType"` // 消息类型,此时固定为:event
|
||||
Event string `json:"Event"` // 事件类型,此时固定为:xpay_goods_deliver_notify
|
||||
Openid string `json:"openid"` // 用户 openid
|
||||
OutTradeNo string `json:"OutTradeNo"` // 业务订单号
|
||||
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
|
||||
WechatPayInfo *WeChatPayInfo `json:"WechatPayInfo"` // 微信支付订单信息
|
||||
CoinInfo *CoinInfo `json:"GoodsInfo"` // 道具信息
|
||||
}
|
||||
|
||||
// CoinInfo 代币信息
|
||||
type CoinInfo struct {
|
||||
Quantity int `json:"Quantity"` // 数量
|
||||
OrigPrice int `json:"OrigPrice"` // 物品原始价格(单位:分)
|
||||
ActualPrice int `json:"ActualPrice"` // 物品实际支付价格(单位:分)
|
||||
Attach string `json:"Attach"` // 透传信息
|
||||
}
|
||||
|
||||
// AsyncXPayCoinPayNotifyResponse 异步通知代币支付推送响应参数
|
||||
type AsyncXPayCoinPayNotifyResponse struct {
|
||||
util.CommonError
|
||||
}
|
||||
|
||||
// URLParams url parameter
|
||||
type URLParams struct {
|
||||
Path string `json:"path"`
|
||||
AccessToken string `json:"access_token"`
|
||||
PaySign string `json:"paySign"`
|
||||
Signature string `json:"signature"`
|
||||
Content string `json:"content"`
|
||||
}
|
||||
516
miniprogram/virtualpayment/virtualpayment.go
Normal file
516
miniprogram/virtualpayment/virtualpayment.go
Normal file
@@ -0,0 +1,516 @@
|
||||
/*
|
||||
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
* You can obtain one at https://github.com/silenceper/wechat.
|
||||
*
|
||||
*/
|
||||
|
||||
package virtualpayment
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/hmac"
|
||||
"crypto/sha256"
|
||||
"encoding/hex"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"strings"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
// SetSessionKey 设置 sessionKey
|
||||
func (s *VirtualPayment) SetSessionKey(sessionKey string) {
|
||||
s.sessionKey = sessionKey
|
||||
}
|
||||
|
||||
// QueryUserBalance 查询虚拟支付余额
|
||||
func (s *VirtualPayment) QueryUserBalance(ctx context.Context, in *QueryUserBalanceRequest) (out QueryUserBalanceResponse, err error) {
|
||||
var jsonByte []byte
|
||||
if jsonByte, err = json.Marshal(in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
params = URLParams{
|
||||
Path: queryUserBalance,
|
||||
Content: string(jsonByte),
|
||||
}
|
||||
address string
|
||||
)
|
||||
if address, err = s.requestAddress(params); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "QueryUserBalance")
|
||||
return
|
||||
}
|
||||
|
||||
// CurrencyPay currency pay 扣减代币(一般用于代币支付)
|
||||
func (s *VirtualPayment) CurrencyPay(ctx context.Context, in *CurrencyPayRequest) (out CurrencyPayResponse, err error) {
|
||||
var jsonByte []byte
|
||||
if jsonByte, err = json.Marshal(in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
params = URLParams{
|
||||
Path: currencyPay,
|
||||
Content: string(jsonByte),
|
||||
}
|
||||
address string
|
||||
)
|
||||
if address, err = s.requestAddress(params); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "CurrencyPay")
|
||||
return
|
||||
}
|
||||
|
||||
// QueryOrder 查询创建的订单(现金单,非代币单)
|
||||
func (s *VirtualPayment) QueryOrder(ctx context.Context, in *QueryOrderRequest) (out QueryOrderResponse, err error) {
|
||||
var jsonByte []byte
|
||||
if jsonByte, err = json.Marshal(in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
params = URLParams{
|
||||
Path: queryOrder,
|
||||
Signature: EmptyString,
|
||||
Content: string(jsonByte),
|
||||
}
|
||||
address string
|
||||
)
|
||||
if address, err = s.requestAddress(params); err != nil {
|
||||
return
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "QueryOrder")
|
||||
return
|
||||
}
|
||||
|
||||
// CancelCurrencyPay 取消订单 代币支付退款 (currency_pay 接口的逆操作)
|
||||
func (s *VirtualPayment) CancelCurrencyPay(ctx context.Context, in *CancelCurrencyPayRequest) (out CancelCurrencyPayResponse, err error) {
|
||||
var jsonByte []byte
|
||||
if jsonByte, err = json.Marshal(in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
params = URLParams{
|
||||
Path: cancelCurrencyPay,
|
||||
Content: string(jsonByte),
|
||||
}
|
||||
address string
|
||||
)
|
||||
if address, err = s.requestAddress(params); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "CancelCurrencyPay")
|
||||
return
|
||||
}
|
||||
|
||||
// NotifyProvideGoods 通知发货
|
||||
// 通知已经发货完成(只能通知现金单),正常通过 xpay_goods_deliver_notify 消息推送返回成功就不需要调用这个 api 接口。这个接口用于异常情况推送不成功时手动将单改成已发货状态
|
||||
func (s *VirtualPayment) NotifyProvideGoods(ctx context.Context, in *NotifyProvideGoodsRequest) (out NotifyProvideGoodsResponse, err error) {
|
||||
var jsonByte []byte
|
||||
if jsonByte, err = json.Marshal(in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
params = URLParams{
|
||||
Path: notifyProvideGoods,
|
||||
Content: string(jsonByte),
|
||||
Signature: EmptyString,
|
||||
}
|
||||
address string
|
||||
)
|
||||
if address, err = s.requestAddress(params); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "NotifyProvideGoods")
|
||||
return
|
||||
}
|
||||
|
||||
// PresentCurrency 代币赠送接口,由于目前不支付按单号查赠送单的功能,所以当需要赠送的时候可以一直重试到返回 0 或者返回 268490004(重复操作)为止
|
||||
func (s *VirtualPayment) PresentCurrency(ctx context.Context, in *PresentCurrencyRequest) (out PresentCurrencyResponse, err error) {
|
||||
var jsonByte []byte
|
||||
if jsonByte, err = json.Marshal(in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
params = URLParams{
|
||||
Path: presentCurrency,
|
||||
Content: string(jsonByte),
|
||||
Signature: EmptyString,
|
||||
}
|
||||
address string
|
||||
)
|
||||
if address, err = s.requestAddress(params); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "PresentCurrency")
|
||||
return
|
||||
}
|
||||
|
||||
// DownloadBill 下载订单交易账单
|
||||
func (s *VirtualPayment) DownloadBill(ctx context.Context, in *DownloadBillRequest) (out DownloadBillResponse, err error) {
|
||||
var jsonByte []byte
|
||||
if jsonByte, err = json.Marshal(in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
params = URLParams{
|
||||
Path: downloadBill,
|
||||
Content: string(jsonByte),
|
||||
Signature: EmptyString,
|
||||
}
|
||||
address string
|
||||
)
|
||||
if address, err = s.requestAddress(params); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "DownloadBill")
|
||||
return
|
||||
}
|
||||
|
||||
// RefundOrder 退款 对使用 jsapi 接口下的单进行退款
|
||||
func (s *VirtualPayment) RefundOrder(ctx context.Context, in *RefundOrderRequest) (out RefundOrderResponse, err error) {
|
||||
var jsonByte []byte
|
||||
if jsonByte, err = json.Marshal(in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
params = URLParams{
|
||||
Path: refundOrder,
|
||||
Content: string(jsonByte),
|
||||
Signature: EmptyString,
|
||||
}
|
||||
address string
|
||||
)
|
||||
if address, err = s.requestAddress(params); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "RefundOrder")
|
||||
return
|
||||
}
|
||||
|
||||
// CreateWithdrawOrder 创建提现单
|
||||
func (s *VirtualPayment) CreateWithdrawOrder(ctx context.Context, in *CreateWithdrawOrderRequest) (out CreateWithdrawOrderResponse, err error) {
|
||||
var jsonByte []byte
|
||||
if jsonByte, err = json.Marshal(in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
params = URLParams{
|
||||
Path: createWithdrawOrder,
|
||||
Content: string(jsonByte),
|
||||
Signature: EmptyString,
|
||||
}
|
||||
address string
|
||||
)
|
||||
if address, err = s.requestAddress(params); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "CreateWithdrawOrder")
|
||||
return
|
||||
}
|
||||
|
||||
// QueryWithdrawOrder 查询提现单
|
||||
func (s *VirtualPayment) QueryWithdrawOrder(ctx context.Context, in *QueryWithdrawOrderRequest) (out QueryWithdrawOrderResponse, err error) {
|
||||
var jsonByte []byte
|
||||
if jsonByte, err = json.Marshal(in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
params = URLParams{
|
||||
Path: queryWithdrawOrder,
|
||||
Content: string(jsonByte),
|
||||
Signature: EmptyString,
|
||||
}
|
||||
address string
|
||||
)
|
||||
if address, err = s.requestAddress(params); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "QueryWithdrawOrder")
|
||||
return
|
||||
}
|
||||
|
||||
// StartUploadGoods 开始上传商品
|
||||
func (s *VirtualPayment) StartUploadGoods(ctx context.Context, in *StartUploadGoodsRequest) (out StartUploadGoodsResponse, err error) {
|
||||
var jsonByte []byte
|
||||
if jsonByte, err = json.Marshal(in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
params = URLParams{
|
||||
Path: startUploadGoods,
|
||||
Content: string(jsonByte),
|
||||
Signature: EmptyString,
|
||||
}
|
||||
address string
|
||||
)
|
||||
if address, err = s.requestAddress(params); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "StartUploadGoods")
|
||||
return
|
||||
}
|
||||
|
||||
// QueryUploadGoods 查询上传商品
|
||||
func (s *VirtualPayment) QueryUploadGoods(ctx context.Context, in *QueryUploadGoodsRequest) (out QueryUploadGoodsResponse, err error) {
|
||||
var jsonByte []byte
|
||||
if jsonByte, err = json.Marshal(in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
params = URLParams{
|
||||
Path: queryUploadGoods,
|
||||
Content: string(jsonByte),
|
||||
Signature: EmptyString,
|
||||
}
|
||||
address string
|
||||
)
|
||||
if address, err = s.requestAddress(params); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "QueryUploadGoods")
|
||||
return
|
||||
}
|
||||
|
||||
// StartPublishGoods 开始发布商品
|
||||
func (s *VirtualPayment) StartPublishGoods(ctx context.Context, in *StartPublishGoodsRequest) (out StartPublishGoodsResponse, err error) {
|
||||
var jsonByte []byte
|
||||
if jsonByte, err = json.Marshal(in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
params = URLParams{
|
||||
Path: startPublishGoods,
|
||||
Content: string(jsonByte),
|
||||
Signature: EmptyString,
|
||||
}
|
||||
address string
|
||||
)
|
||||
if address, err = s.requestAddress(params); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "StartPublishGoods")
|
||||
return
|
||||
}
|
||||
|
||||
// QueryPublishGoods 查询发布商品
|
||||
func (s *VirtualPayment) QueryPublishGoods(ctx context.Context, in *QueryPublishGoodsRequest) (out QueryPublishGoodsResponse, err error) {
|
||||
var jsonByte []byte
|
||||
if jsonByte, err = json.Marshal(in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var (
|
||||
params = URLParams{
|
||||
Path: queryPublishGoods,
|
||||
Content: string(jsonByte),
|
||||
Signature: EmptyString,
|
||||
}
|
||||
address string
|
||||
)
|
||||
if address, err = s.requestAddress(params); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &out, "QueryPublishGoods")
|
||||
return
|
||||
}
|
||||
|
||||
// hmacSha256 hmac sha256
|
||||
func (s *VirtualPayment) hmacSha256(key, data string) string {
|
||||
h := hmac.New(sha256.New, []byte(key))
|
||||
h.Write([]byte(data))
|
||||
return hex.EncodeToString(h.Sum(nil))
|
||||
}
|
||||
|
||||
// PaySign pay sign
|
||||
func (s *VirtualPayment) PaySign(url, data string) (string, error) {
|
||||
if strings.TrimSpace(s.ctx.Config.AppKey) == "" {
|
||||
return "", errors.New("appKey is empty")
|
||||
}
|
||||
return s.hmacSha256(s.ctx.Config.AppKey, url+"&"+data), nil
|
||||
}
|
||||
|
||||
// Signature user signature
|
||||
func (s *VirtualPayment) Signature(data string) (string, error) {
|
||||
if strings.TrimSpace(s.sessionKey) == "" {
|
||||
return "", errors.New("sessionKey is empty")
|
||||
}
|
||||
return s.hmacSha256(s.sessionKey, data), nil
|
||||
}
|
||||
|
||||
// PaySignature pay sign and signature
|
||||
func (s *VirtualPayment) PaySignature(url, data string) (paySign, signature string, err error) {
|
||||
if paySign, err = s.PaySign(url, data); err != nil {
|
||||
return
|
||||
}
|
||||
if signature, err = s.Signature(data); err != nil {
|
||||
return
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// requestURL .组合 URL
|
||||
func (s *VirtualPayment) requestAddress(params URLParams) (url string, err error) {
|
||||
switch params.Path {
|
||||
case queryUserBalance:
|
||||
case currencyPay:
|
||||
case cancelCurrencyPay:
|
||||
if params.PaySign, params.Signature, err = s.PaySignature(params.Path, params.Content); err != nil {
|
||||
return
|
||||
}
|
||||
case queryOrder:
|
||||
case notifyProvideGoods:
|
||||
case presentCurrency:
|
||||
case downloadBill:
|
||||
case refundOrder:
|
||||
case createWithdrawOrder:
|
||||
case queryWithdrawOrder:
|
||||
case startUploadGoods:
|
||||
case queryUploadGoods:
|
||||
case startPublishGoods:
|
||||
case queryPublishGoods:
|
||||
if params.PaySign, err = s.PaySign(params.Path, params.Content); err != nil {
|
||||
return
|
||||
}
|
||||
default:
|
||||
err = errors.New("path is not exist")
|
||||
return
|
||||
}
|
||||
|
||||
if params.AccessToken, err = s.ctx.GetAccessToken(); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
url = baseSite + params.Path + "?" + accessToken + "=" + params.AccessToken
|
||||
if params.PaySign != EmptyString {
|
||||
url += "&" + paySignature + "=" + params.PaySign
|
||||
}
|
||||
if params.Signature != EmptyString {
|
||||
url += "&" + signature + "=" + params.Signature
|
||||
}
|
||||
return
|
||||
}
|
||||
@@ -44,9 +44,6 @@ func (basic *Basic) Long2ShortURL(longURL string) (shortURL string, err error) {
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
if err = util.DecodeWithError(responseBytes, resp, long2shortAction); err != nil {
|
||||
return
|
||||
}
|
||||
shortURL = resp.ShortURL
|
||||
return
|
||||
err = util.DecodeWithError(responseBytes, resp, long2shortAction)
|
||||
return resp.ShortURL, err
|
||||
}
|
||||
|
||||
@@ -79,6 +79,10 @@ type sendRequest struct {
|
||||
Mpnews map[string]interface{} `json:"mpnews,omitempty"`
|
||||
// 发送语音
|
||||
Voice map[string]interface{} `json:"voice,omitempty"`
|
||||
// 发送视频
|
||||
Mpvideo map[string]interface{} `json:"mpvideo,omitempty"`
|
||||
// 发送图片-预览使用
|
||||
Image map[string]interface{} `json:"image,omitempty"`
|
||||
// 发送图片
|
||||
Images *Image `json:"images,omitempty"`
|
||||
// 发送卡券
|
||||
@@ -183,7 +187,13 @@ func (broadcast *Broadcast) SendImage(user *User, images *Image) (*Result, error
|
||||
ToUser: nil,
|
||||
MsgType: MsgTypeImage,
|
||||
}
|
||||
req.Images = images
|
||||
if broadcast.preview {
|
||||
req.Image = map[string]interface{}{
|
||||
"media_id": images.MediaIDs[0],
|
||||
}
|
||||
} else {
|
||||
req.Images = images
|
||||
}
|
||||
req, sendURL := broadcast.chooseTagOrOpenID(user, req)
|
||||
url := fmt.Sprintf("%s?access_token=%s", sendURL, ak)
|
||||
data, err := util.PostJSON(url, req)
|
||||
@@ -205,7 +215,7 @@ func (broadcast *Broadcast) SendVideo(user *User, mediaID string, title, descrip
|
||||
ToUser: nil,
|
||||
MsgType: MsgTypeVideo,
|
||||
}
|
||||
req.Voice = map[string]interface{}{
|
||||
req.Mpvideo = map[string]interface{}{
|
||||
"media_id": mediaID,
|
||||
"title": title,
|
||||
"description": description,
|
||||
|
||||
245
officialaccount/customerservice/manager.go
Normal file
245
officialaccount/customerservice/manager.go
Normal file
@@ -0,0 +1,245 @@
|
||||
package customerservice
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/officialaccount/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
// TypingStatus 输入状态类型
|
||||
type TypingStatus string
|
||||
|
||||
const (
|
||||
customerServiceListURL = "https://api.weixin.qq.com/cgi-bin/customservice/getkflist"
|
||||
customerServiceOnlineListURL = "https://api.weixin.qq.com/cgi-bin/customservice/getonlinekflist"
|
||||
customerServiceAddURL = "https://api.weixin.qq.com/customservice/kfaccount/add"
|
||||
customerServiceUpdateURL = "https://api.weixin.qq.com/customservice/kfaccount/update"
|
||||
customerServiceDeleteURL = "https://api.weixin.qq.com/customservice/kfaccount/del"
|
||||
customerServiceInviteURL = "https://api.weixin.qq.com/customservice/kfaccount/inviteworker"
|
||||
customerServiceUploadHeadImg = "https://api.weixin.qq.com/customservice/kfaccount/uploadheadimg"
|
||||
customerServiceTypingURL = "https://api.weixin.qq.com/cgi-bin/message/custom/typing"
|
||||
)
|
||||
|
||||
const (
|
||||
// Typing 表示正在输入状态
|
||||
Typing TypingStatus = "Typing"
|
||||
// CancelTyping 表示取消正在输入状态
|
||||
CancelTyping TypingStatus = "CancelTyping"
|
||||
)
|
||||
|
||||
// Manager 客服管理者,可以管理客服
|
||||
type Manager struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewCustomerServiceManager 实例化客服管理
|
||||
func NewCustomerServiceManager(ctx *context.Context) *Manager {
|
||||
csm := new(Manager)
|
||||
csm.Context = ctx
|
||||
return csm
|
||||
}
|
||||
|
||||
// KeFuInfo 客服基本信息
|
||||
type KeFuInfo struct {
|
||||
KfAccount string `json:"kf_account"` // 完整客服帐号,格式为:帐号前缀@公众号微信号
|
||||
KfNick string `json:"kf_nick"` // 客服昵称
|
||||
KfID int `json:"kf_id"` // 客服编号
|
||||
KfHeadImgURL string `json:"kf_headimgurl"` // 客服头像
|
||||
KfWX string `json:"kf_wx"` // 如果客服帐号已绑定了客服人员微信号, 则此处显示微信号
|
||||
InviteWX string `json:"invite_wx"` // 如果客服帐号尚未绑定微信号,但是已经发起了一个绑定邀请, 则此处显示绑定邀请的微信号
|
||||
InviteExpTime int `json:"invite_expire_time"` // 如果客服帐号尚未绑定微信号,但是已经发起过一个绑定邀请, 邀请的过期时间,为unix 时间戳
|
||||
InviteStatus string `json:"invite_status"` // 邀请的状态,有等待确认“waiting”,被拒绝“rejected”, 过期“expired”
|
||||
}
|
||||
|
||||
type resKeFuList struct {
|
||||
util.CommonError
|
||||
KfList []*KeFuInfo `json:"kf_list"`
|
||||
}
|
||||
|
||||
// List 获取所有客服基本信息
|
||||
func (csm *Manager) List() (customerServiceList []*KeFuInfo, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = csm.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", customerServiceListURL, accessToken)
|
||||
var response []byte
|
||||
response, err = util.HTTPGet(uri)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
var res resKeFuList
|
||||
err = util.DecodeWithError(response, &res, "ListCustomerService")
|
||||
return res.KfList, err
|
||||
}
|
||||
|
||||
// KeFuOnlineInfo 客服在线信息
|
||||
type KeFuOnlineInfo struct {
|
||||
KfAccount string `json:"kf_account"`
|
||||
Status int `json:"status"`
|
||||
KfID int `json:"kf_id"`
|
||||
AcceptedCase int `json:"accepted_case"`
|
||||
}
|
||||
|
||||
type resKeFuOnlineList struct {
|
||||
util.CommonError
|
||||
KfOnlineList []*KeFuOnlineInfo `json:"kf_online_list"`
|
||||
}
|
||||
|
||||
// OnlineList 获取在线客服列表
|
||||
func (csm *Manager) OnlineList() (customerServiceOnlineList []*KeFuOnlineInfo, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = csm.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", customerServiceOnlineListURL, accessToken)
|
||||
var response []byte
|
||||
response, err = util.HTTPGet(uri)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
var res resKeFuOnlineList
|
||||
err = util.DecodeWithError(response, &res, "ListOnlineCustomerService")
|
||||
return res.KfOnlineList, err
|
||||
}
|
||||
|
||||
// Add 添加客服账号
|
||||
func (csm *Manager) Add(kfAccount, nickName string) (err error) {
|
||||
// kfAccount:完整客服帐号,格式为:帐号前缀@公众号微信号,帐号前缀最多10个字符,必须是英文、数字字符或者下划线,后缀为公众号微信号,长度不超过30个字符
|
||||
// nickName:客服昵称,最长16个字
|
||||
// 参数此处均不做校验
|
||||
var accessToken string
|
||||
accessToken, err = csm.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", customerServiceAddURL, accessToken)
|
||||
data := struct {
|
||||
KfAccount string `json:"kf_account"`
|
||||
NickName string `json:"nickname"`
|
||||
}{
|
||||
KfAccount: kfAccount,
|
||||
NickName: nickName,
|
||||
}
|
||||
var response []byte
|
||||
response, err = util.PostJSON(uri, data)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithCommonError(response, "AddCustomerService")
|
||||
return
|
||||
}
|
||||
|
||||
// Update 修改客服账号
|
||||
func (csm *Manager) Update(kfAccount, nickName string) (err error) {
|
||||
var accessToken string
|
||||
accessToken, err = csm.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", customerServiceUpdateURL, accessToken)
|
||||
data := struct {
|
||||
KfAccount string `json:"kf_account"`
|
||||
NickName string `json:"nickname"`
|
||||
}{
|
||||
KfAccount: kfAccount,
|
||||
NickName: nickName,
|
||||
}
|
||||
var response []byte
|
||||
response, err = util.PostJSON(uri, data)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithCommonError(response, "UpdateCustomerService")
|
||||
return
|
||||
}
|
||||
|
||||
// Delete 删除客服帐号
|
||||
func (csm *Manager) Delete(kfAccount string) (err error) {
|
||||
var accessToken string
|
||||
accessToken, err = csm.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", customerServiceDeleteURL, accessToken)
|
||||
data := struct {
|
||||
KfAccount string `json:"kf_account"`
|
||||
}{
|
||||
KfAccount: kfAccount,
|
||||
}
|
||||
var response []byte
|
||||
response, err = util.PostJSON(uri, data)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithCommonError(response, "DeleteCustomerService")
|
||||
return
|
||||
}
|
||||
|
||||
// InviteBind 邀请绑定客服帐号和微信号
|
||||
func (csm *Manager) InviteBind(kfAccount, inviteWX string) (err error) {
|
||||
var accessToken string
|
||||
accessToken, err = csm.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", customerServiceInviteURL, accessToken)
|
||||
data := struct {
|
||||
KfAccount string `json:"kf_account"`
|
||||
InviteWX string `json:"invite_wx"`
|
||||
}{
|
||||
KfAccount: kfAccount,
|
||||
InviteWX: inviteWX,
|
||||
}
|
||||
var response []byte
|
||||
response, err = util.PostJSON(uri, data)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithCommonError(response, "InviteBindCustomerService")
|
||||
return
|
||||
}
|
||||
|
||||
// UploadHeadImg 上传客服头像
|
||||
func (csm *Manager) UploadHeadImg(kfAccount, fileName string) (err error) {
|
||||
var accessToken string
|
||||
accessToken, err = csm.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s&kf_account=%s", customerServiceUploadHeadImg, accessToken, kfAccount)
|
||||
var response []byte
|
||||
response, err = util.PostFile("media", fileName, uri)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithCommonError(response, "UploadCustomerServiceHeadImg")
|
||||
return
|
||||
}
|
||||
|
||||
// SendTypingStatus 下发客服输入状态给用户
|
||||
func (csm *Manager) SendTypingStatus(openid string, cmd TypingStatus) (err error) {
|
||||
var accessToken string
|
||||
accessToken, err = csm.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", customerServiceTypingURL, accessToken)
|
||||
data := struct {
|
||||
ToUser string `json:"touser"`
|
||||
Command string `json:"command"`
|
||||
}{
|
||||
ToUser: openid,
|
||||
Command: string(cmd),
|
||||
}
|
||||
var response []byte
|
||||
response, err = util.PostJSON(uri, data)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithCommonError(response, "SendTypingStatus")
|
||||
return
|
||||
}
|
||||
@@ -183,9 +183,6 @@ func (cube *DataCube) fetchData(params ParamsPublisher) (response []byte, err er
|
||||
uri := fmt.Sprintf("%s?%s", publisherURL, v.Encode())
|
||||
|
||||
response, err = util.HTTPGet(uri)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
@@ -64,11 +64,7 @@ func (draft *Draft) AddDraft(articles []*Article) (mediaID string, err error) {
|
||||
MediaID string `json:"media_id"`
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "AddDraft")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
mediaID = res.MediaID
|
||||
return
|
||||
return res.MediaID, err
|
||||
}
|
||||
|
||||
// GetDraft 获取草稿
|
||||
@@ -94,12 +90,7 @@ func (draft *Draft) GetDraft(mediaID string) (articles []*Article, err error) {
|
||||
NewsItem []*Article `json:"news_item"`
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "GetDraft")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
articles = res.NewsItem
|
||||
return
|
||||
return res.NewsItem, err
|
||||
}
|
||||
|
||||
// DeleteDraft 删除草稿
|
||||
@@ -172,12 +163,7 @@ func (draft *Draft) CountDraft() (total uint, err error) {
|
||||
Total uint `json:"total_count"`
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "CountDraft")
|
||||
if nil != err {
|
||||
return
|
||||
}
|
||||
|
||||
total = res.Total
|
||||
return
|
||||
return res.Total, err
|
||||
}
|
||||
|
||||
// ArticleList 草稿列表
|
||||
|
||||
@@ -73,12 +73,7 @@ func (freePublish *FreePublish) Publish(mediaID string) (publishID int64, err er
|
||||
PublishID int64 `json:"publish_id"`
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "SubmitFreePublish")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
publishID = res.PublishID
|
||||
return
|
||||
return res.PublishID, err
|
||||
}
|
||||
|
||||
// PublishStatusList 发布任务状态列表
|
||||
@@ -191,12 +186,7 @@ func (freePublish *FreePublish) First(articleID string) (list []Article, err err
|
||||
NewsItem []Article `json:"news_item"`
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "FirstFreePublish")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
list = res.NewsItem
|
||||
return
|
||||
return res.NewsItem, err
|
||||
}
|
||||
|
||||
// ArticleList 发布列表
|
||||
|
||||
@@ -27,7 +27,7 @@ const (
|
||||
PermanentMaterialTypeImage PermanentMaterialType = "image"
|
||||
// PermanentMaterialTypeVideo 永久素材视频类型(video)
|
||||
PermanentMaterialTypeVideo PermanentMaterialType = "video"
|
||||
// PermanentMaterialTypeVoice 永久素材语音类型 (voice)
|
||||
// PermanentMaterialTypeVoice 永久素材语音类型(voice)
|
||||
PermanentMaterialTypeVoice PermanentMaterialType = "voice"
|
||||
// PermanentMaterialTypeNews 永久素材图文类型(news)
|
||||
PermanentMaterialTypeNews PermanentMaterialType = "news"
|
||||
@@ -278,7 +278,7 @@ type ArticleList struct {
|
||||
Item []ArticleListItem `json:"item"`
|
||||
}
|
||||
|
||||
// ArticleListItem 用于ArticleList的item节点
|
||||
// ArticleListItem 用于 ArticleList 的 item 节点
|
||||
type ArticleListItem struct {
|
||||
MediaID string `json:"media_id"`
|
||||
Content ArticleListContent `json:"content"`
|
||||
@@ -287,14 +287,14 @@ type ArticleListItem struct {
|
||||
UpdateTime int64 `json:"update_time"`
|
||||
}
|
||||
|
||||
// ArticleListContent 用于ArticleListItem的content节点
|
||||
// ArticleListContent 用于 ArticleListItem 的 content 节点
|
||||
type ArticleListContent struct {
|
||||
NewsItem []Article `json:"news_item"`
|
||||
UpdateTime int64 `json:"update_time"`
|
||||
CreateTime int64 `json:"create_time"`
|
||||
}
|
||||
|
||||
// reqBatchGetMaterial BatchGetMaterial请求参数
|
||||
// reqBatchGetMaterial BatchGetMaterial 请求参数
|
||||
type reqBatchGetMaterial struct {
|
||||
Type PermanentMaterialType `json:"type"`
|
||||
Count int64 `json:"count"`
|
||||
@@ -302,6 +302,7 @@ type reqBatchGetMaterial struct {
|
||||
}
|
||||
|
||||
// BatchGetMaterial 批量获取永久素材
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/Get_materials_list.html
|
||||
func (material *Material) BatchGetMaterial(permanentMaterialType PermanentMaterialType, offset, count int64) (list ArticleList, err error) {
|
||||
var accessToken string
|
||||
@@ -336,7 +337,7 @@ type ResMaterialCount struct {
|
||||
NewsCount int64 `json:"news_count"` // 图文总数量
|
||||
}
|
||||
|
||||
// GetMaterialCount 获取素材总数.
|
||||
// GetMaterialCount 获取素材总数。
|
||||
func (material *Material) GetMaterialCount() (res ResMaterialCount, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = material.GetAccessToken()
|
||||
|
||||
@@ -38,6 +38,7 @@ type CustomerMessage struct {
|
||||
Wxcard *MediaWxcard `json:"wxcard,omitempty"` // 可选
|
||||
Msgmenu *MediaMsgmenu `json:"msgmenu,omitempty"` // 可选
|
||||
Miniprogrampage *MediaMiniprogrampage `json:"miniprogrampage,omitempty"` // 可选
|
||||
Mpnewsarticle *MediaArticle `json:"mpnewsarticle,omitempty"` // 可选
|
||||
}
|
||||
|
||||
// NewCustomerTextMessage 文本消息结构体构造方法
|
||||
@@ -97,6 +98,11 @@ type MediaResource struct {
|
||||
MediaID string `json:"media_id"`
|
||||
}
|
||||
|
||||
// MediaArticle 消息使用的已发布文章id
|
||||
type MediaArticle struct {
|
||||
ArticleID string `json:"article_id"`
|
||||
}
|
||||
|
||||
// MediaVideo 视频消息包含的内容
|
||||
type MediaVideo struct {
|
||||
MediaID string `json:"media_id"`
|
||||
|
||||
@@ -27,15 +27,15 @@ const (
|
||||
MsgTypeVideo MsgType = "video"
|
||||
// MsgTypeMiniprogrampage 表示小程序卡片消息
|
||||
MsgTypeMiniprogrampage MsgType = "miniprogrampage"
|
||||
// MsgTypeShortVideo 表示短视频消息[限接收]
|
||||
// MsgTypeShortVideo 表示短视频消息 [限接收]
|
||||
MsgTypeShortVideo MsgType = "shortvideo"
|
||||
// MsgTypeLocation 表示坐标消息[限接收]
|
||||
// MsgTypeLocation 表示坐标消息 [限接收]
|
||||
MsgTypeLocation MsgType = "location"
|
||||
// MsgTypeLink 表示链接消息[限接收]
|
||||
// MsgTypeLink 表示链接消息 [限接收]
|
||||
MsgTypeLink MsgType = "link"
|
||||
// MsgTypeMusic 表示音乐消息[限回复]
|
||||
// MsgTypeMusic 表示音乐消息 [限回复]
|
||||
MsgTypeMusic MsgType = "music"
|
||||
// MsgTypeNews 表示图文消息[限回复]
|
||||
// MsgTypeNews 表示图文消息 [限回复]
|
||||
MsgTypeNews MsgType = "news"
|
||||
// MsgTypeTransfer 表示消息消息转发到客服
|
||||
MsgTypeTransfer MsgType = "transfer_customer_service"
|
||||
@@ -68,6 +68,8 @@ const (
|
||||
EventPicWeixin EventType = "pic_weixin"
|
||||
// EventLocationSelect 弹出地理位置选择器的事件推送
|
||||
EventLocationSelect EventType = "location_select"
|
||||
// EventViewMiniprogram 点击菜单跳转小程序的事件推送
|
||||
EventViewMiniprogram EventType = "view_miniprogram"
|
||||
// EventTemplateSendJobFinish 发送模板消息推送通知
|
||||
EventTemplateSendJobFinish EventType = "TEMPLATESENDJOBFINISH"
|
||||
// EventMassSendJobFinish 群发消息推送通知
|
||||
@@ -78,12 +80,18 @@ const (
|
||||
EventSubscribeMsgPopupEvent EventType = "subscribe_msg_popup_event"
|
||||
// EventPublishJobFinish 发布任务完成
|
||||
EventPublishJobFinish EventType = "PUBLISHJOBFINISH"
|
||||
// EventWeappAuditSuccess 审核通过
|
||||
EventWeappAuditSuccess EventType = "weapp_audit_success"
|
||||
// EventWeappAuditFail 审核不通过
|
||||
EventWeappAuditFail EventType = "weapp_audit_fail"
|
||||
// EventWeappAuditDelay 审核延后
|
||||
EventWeappAuditDelay EventType = "weapp_audit_delay"
|
||||
)
|
||||
|
||||
const (
|
||||
// 微信开放平台需要用到
|
||||
|
||||
// InfoTypeVerifyTicket 返回ticket
|
||||
// InfoTypeVerifyTicket 返回 ticket
|
||||
InfoTypeVerifyTicket InfoType = "component_verify_ticket"
|
||||
// InfoTypeAuthorized 授权
|
||||
InfoTypeAuthorized InfoType = "authorized"
|
||||
@@ -100,8 +108,8 @@ type MixMessage struct {
|
||||
CommonToken
|
||||
|
||||
// 基本消息
|
||||
MsgID int64 `xml:"MsgId"` // 其他消息推送过来是MsgId
|
||||
TemplateMsgID int64 `xml:"MsgID"` // 模板消息推送成功的消息是MsgID
|
||||
MsgID int64 `xml:"MsgId"` // 其他消息推送过来是 MsgId
|
||||
TemplateMsgID int64 `xml:"MsgID"` // 模板消息推送成功的消息是 MsgID
|
||||
Content string `xml:"Content"`
|
||||
Recognition string `xml:"Recognition"`
|
||||
PicURL string `xml:"PicUrl"`
|
||||
@@ -115,6 +123,7 @@ type MixMessage struct {
|
||||
Title string `xml:"Title"`
|
||||
Description string `xml:"Description"`
|
||||
URL string `xml:"Url"`
|
||||
BizMsgMenuID int64 `xml:"bizmsgmenuid"`
|
||||
|
||||
// 事件相关
|
||||
Event EventType `xml:"Event" json:"Event"`
|
||||
@@ -157,17 +166,17 @@ type MixMessage struct {
|
||||
|
||||
// 事件相关:发布能力
|
||||
PublishEventInfo struct {
|
||||
PublishID int64 `xml:"publish_id"` // 发布任务id
|
||||
PublishID int64 `xml:"publish_id"` // 发布任务 id
|
||||
PublishStatus freepublish.PublishStatus `xml:"publish_status"` // 发布状态
|
||||
ArticleID string `xml:"article_id"` // 当发布状态为0时(即成功)时,返回图文的 article_id,可用于“客服消息”场景
|
||||
ArticleID string `xml:"article_id"` // 当发布状态为 0 时(即成功)时,返回图文的 article_id,可用于“客服消息”场景
|
||||
ArticleDetail struct {
|
||||
Count uint `xml:"count"` // 文章数量
|
||||
Item []struct {
|
||||
Index uint `xml:"idx"` // 文章对应的编号
|
||||
ArticleURL string `xml:"article_url"` // 图文的永久链接
|
||||
} `xml:"item"`
|
||||
} `xml:"article_detail"` // 当发布状态为0时(即成功)时,返回内容
|
||||
FailIndex []uint `xml:"fail_idx"` // 当发布状态为2或4时,返回不通过的文章编号,第一篇为 1;其他发布状态则为空
|
||||
} `xml:"article_detail"` // 当发布状态为 0 时(即成功)时,返回内容
|
||||
FailIndex []uint `xml:"fail_idx"` // 当发布状态为 2 或 4 时,返回不通过的文章编号,第一篇为 1;其他发布状态则为空
|
||||
} `xml:"PublishEventInfo"`
|
||||
|
||||
// 第三方平台相关
|
||||
@@ -187,6 +196,14 @@ type MixMessage struct {
|
||||
LegalPersonaName string `xml:"legal_persona_name"`
|
||||
ComponentPhone string `xml:"component_phone"`
|
||||
} `xml:"info"`
|
||||
ResultInfo struct {
|
||||
APIName string `xml:"api_name"`
|
||||
ApplyTime string `xml:"apply_time"`
|
||||
AuditID string `xml:"audit_id"`
|
||||
AuditTime string `xml:"audit_time"`
|
||||
Reason string `xml:"reason"`
|
||||
Status string `xml:"status"`
|
||||
} `xml:"result_info"`
|
||||
|
||||
// 卡券相关
|
||||
CardID string `xml:"CardId"`
|
||||
@@ -205,8 +222,19 @@ type MixMessage struct {
|
||||
TraceID string `xml:"trace_id"`
|
||||
StatusCode int `xml:"status_code"`
|
||||
|
||||
// 小程序名称审核结果事件推送
|
||||
Ret int32 `xml:"ret"` // 审核结果 2:失败,3:成功
|
||||
NickName string `xml:"nickname"` // 小程序昵称
|
||||
|
||||
// 设备相关
|
||||
device.MsgDevice
|
||||
|
||||
// 小程序审核通知
|
||||
SuccTime int `xml:"SuccTime"` // 审核成功时的时间戳
|
||||
FailTime int `xml:"FailTime"` // 审核不通过的时间戳
|
||||
DelayTime int `xml:"DelayTime"` // 审核延后时的时间戳
|
||||
Reason string `xml:"Reason"` // 审核不通过的原因
|
||||
ScreenShot string `xml:"ScreenShot"` // 审核不通过的截图示例。用 | 分隔的 media_id 的列表,可通过获取永久素材接口拉取截图内容
|
||||
}
|
||||
|
||||
// SubscribeMsgPopupEvent 订阅通知事件推送的消息体
|
||||
@@ -254,7 +282,7 @@ type ResponseEncryptedXMLMsg struct {
|
||||
Nonce string `xml:"Nonce" json:"Nonce"`
|
||||
}
|
||||
|
||||
// CDATA 使用该类型,在序列化为 xml 文本时文本会被解析器忽略
|
||||
// CDATA 使用该类型,在序列化为 xml 文本时文本会被解析器忽略
|
||||
type CDATA string
|
||||
|
||||
// MarshalXML 实现自己的序列化方法
|
||||
|
||||
@@ -8,10 +8,13 @@ import (
|
||||
)
|
||||
|
||||
const (
|
||||
subscribeSendURL = "https://api.weixin.qq.com/cgi-bin/message/subscribe/bizsend"
|
||||
subscribeTemplateListURL = "https://api.weixin.qq.com/wxaapi/newtmpl/gettemplate"
|
||||
subscribeTemplateAddURL = "https://api.weixin.qq.com/wxaapi/newtmpl/addtemplate"
|
||||
subscribeTemplateDelURL = "https://api.weixin.qq.com/wxaapi/newtmpl/deltemplate"
|
||||
subscribeSendURL = "https://api.weixin.qq.com/cgi-bin/message/subscribe/bizsend"
|
||||
subscribeTemplateListURL = "https://api.weixin.qq.com/wxaapi/newtmpl/gettemplate"
|
||||
subscribeTemplateAddURL = "https://api.weixin.qq.com/wxaapi/newtmpl/addtemplate"
|
||||
subscribeTemplateDelURL = "https://api.weixin.qq.com/wxaapi/newtmpl/deltemplate"
|
||||
subscribeTemplateGetCategoryURL = "https://api.weixin.qq.com/wxaapi/newtmpl/getcategory"
|
||||
subscribeTemplateGetPubTplKeyWorksURL = "https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatekeywords"
|
||||
subscribeTemplateGetPubTplTitles = "https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatetitles"
|
||||
)
|
||||
|
||||
// Subscribe 订阅消息
|
||||
@@ -87,11 +90,7 @@ func (tpl *Subscribe) List() (templateList []*PrivateSubscribeItem, err error) {
|
||||
}
|
||||
var res resPrivateSubscribeList
|
||||
err = util.DecodeWithError(response, &res, "ListSubscribe")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
templateList = res.SubscriptionList
|
||||
return
|
||||
return res.SubscriptionList, err
|
||||
}
|
||||
|
||||
type resSubscribeAdd struct {
|
||||
@@ -120,11 +119,7 @@ func (tpl *Subscribe) Add(ShortID string, kidList []int, sceneDesc string) (temp
|
||||
}
|
||||
var result resSubscribeAdd
|
||||
err = util.DecodeWithError(response, &result, "AddSubscribe")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
templateID = result.TemplateID
|
||||
return
|
||||
return result.TemplateID, err
|
||||
}
|
||||
|
||||
// Delete 删除私有模板
|
||||
@@ -145,3 +140,95 @@ func (tpl *Subscribe) Delete(templateID string) (err error) {
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "DeleteSubscribe")
|
||||
}
|
||||
|
||||
// PublicTemplateCategory 公众号类目
|
||||
type PublicTemplateCategory struct {
|
||||
ID int `json:"id"` // 类目ID
|
||||
Name string `json:"name"` // 类目的中文名
|
||||
}
|
||||
|
||||
type resSubscribeCategoryList struct {
|
||||
util.CommonError
|
||||
CategoryList []*PublicTemplateCategory `json:"data"`
|
||||
}
|
||||
|
||||
// GetCategory 获取公众号类目
|
||||
func (tpl *Subscribe) GetCategory() (categoryList []*PublicTemplateCategory, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = tpl.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", subscribeTemplateGetCategoryURL, accessToken)
|
||||
var response []byte
|
||||
response, err = util.HTTPGet(uri)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
var result resSubscribeCategoryList
|
||||
err = util.DecodeWithError(response, &result, "GetCategory")
|
||||
return result.CategoryList, err
|
||||
}
|
||||
|
||||
// PublicTemplateKeyWords 模板中的关键词
|
||||
type PublicTemplateKeyWords struct {
|
||||
KeyWordsID int `json:"kid"` // 关键词 id
|
||||
Name string `json:"name"` // 关键词内容
|
||||
Example string `json:"example"` // 关键词内容对应的示例
|
||||
Rule string `json:"rule"` // 参数类型
|
||||
}
|
||||
|
||||
type resPublicTemplateKeyWordsList struct {
|
||||
util.CommonError
|
||||
KeyWordsList []*PublicTemplateKeyWords `json:"data"` // 关键词列表
|
||||
}
|
||||
|
||||
// GetPubTplKeyWordsByID 获取模板中的关键词
|
||||
func (tpl *Subscribe) GetPubTplKeyWordsByID(titleID string) (keyWordsList []*PublicTemplateKeyWords, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = tpl.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s&tid=%s", subscribeTemplateGetPubTplKeyWorksURL, accessToken, titleID)
|
||||
var response []byte
|
||||
response, err = util.HTTPGet(uri)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
var result resPublicTemplateKeyWordsList
|
||||
err = util.DecodeWithError(response, &result, "GetPublicTemplateKeyWords")
|
||||
return result.KeyWordsList, err
|
||||
}
|
||||
|
||||
// PublicTemplateTitle 类目下的公共模板
|
||||
type PublicTemplateTitle struct {
|
||||
TitleID int `json:"tid"` // 模版标题 id
|
||||
Title string `json:"title"` // 模版标题
|
||||
Type int `json:"type"` // 模版类型,2 为一次性订阅,3 为长期订阅
|
||||
CategoryID string `json:"categoryId"` // 模版所属类目 id
|
||||
}
|
||||
|
||||
type resPublicTemplateTitleList struct {
|
||||
util.CommonError
|
||||
Count int `json:"count"` // 公共模板列表总数
|
||||
TemplateTitleList []*PublicTemplateTitle `json:"data"` // 模板标题列表
|
||||
}
|
||||
|
||||
// GetPublicTemplateTitleList 获取类目下的公共模板
|
||||
func (tpl *Subscribe) GetPublicTemplateTitleList(ids string, start int, limit int) (count int, templateTitleList []*PublicTemplateTitle, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = tpl.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s&ids=%s&start=%d&limit=%d", subscribeTemplateGetPubTplTitles, accessToken, ids, start, limit)
|
||||
var response []byte
|
||||
response, err = util.HTTPGet(uri)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
var result resPublicTemplateTitleList
|
||||
err = util.DecodeWithError(response, &result, "GetPublicTemplateTitle")
|
||||
return result.Count, result.TemplateTitleList, err
|
||||
}
|
||||
|
||||
@@ -29,11 +29,12 @@ func NewTemplate(context *context.Context) *Template {
|
||||
|
||||
// TemplateMessage 发送的模板消息内容
|
||||
type TemplateMessage struct {
|
||||
ToUser string `json:"touser"` // 必须, 接受者OpenID
|
||||
TemplateID string `json:"template_id"` // 必须, 模版ID
|
||||
URL string `json:"url,omitempty"` // 可选, 用户点击后跳转的URL, 该URL必须处于开发者在公众平台网站中设置的域中
|
||||
Color string `json:"color,omitempty"` // 可选, 整个消息的颜色, 可以不设置
|
||||
Data map[string]*TemplateDataItem `json:"data"` // 必须, 模板数据
|
||||
ToUser string `json:"touser"` // 必须, 接受者OpenID
|
||||
TemplateID string `json:"template_id"` // 必须, 模版ID
|
||||
URL string `json:"url,omitempty"` // 可选, 用户点击后跳转的URL, 该URL必须处于开发者在公众平台网站中设置的域中
|
||||
Color string `json:"color,omitempty"` // 可选, 整个消息的颜色, 可以不设置
|
||||
Data map[string]*TemplateDataItem `json:"data"` // 必须, 模板数据
|
||||
ClientMsgID string `json:"client_msg_id,omitempty"` // 可选, 防重入ID
|
||||
|
||||
MiniProgram struct {
|
||||
AppID string `json:"appid"` // 所需跳转到的小程序appid(该小程序appid必须与发模板消息的公众号是绑定关联关系)
|
||||
@@ -110,11 +111,7 @@ func (tpl *Template) List() (templateList []*TemplateItem, err error) {
|
||||
}
|
||||
var res resTemplateList
|
||||
err = util.DecodeWithError(response, &res, "ListTemplate")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
templateList = res.TemplateList
|
||||
return
|
||||
return res.TemplateList, err
|
||||
}
|
||||
|
||||
type resTemplateAdd struct {
|
||||
@@ -142,11 +139,7 @@ func (tpl *Template) Add(shortID string) (templateID string, err error) {
|
||||
|
||||
var result resTemplateAdd
|
||||
err = util.DecodeWithError(response, &result, "AddTemplate")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
templateID = result.TemplateID
|
||||
return
|
||||
return result.TemplateID, err
|
||||
}
|
||||
|
||||
// Delete 删除私有模板.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package oauth
|
||||
|
||||
import (
|
||||
ctx2 "context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net/http"
|
||||
@@ -64,16 +65,37 @@ type ResAccessToken struct {
|
||||
OpenID string `json:"openid"`
|
||||
Scope string `json:"scope"`
|
||||
|
||||
// IsSnapShotUser 是否为快照页模式虚拟账号,只有当用户是快照页模式虚拟账号时返回,值为1
|
||||
// 公众号文档 https://developers.weixin.qq.com/community/minihome/doc/000c2c34068880629ced91a2f56001
|
||||
IsSnapShotUser int `json:"is_snapshotuser"`
|
||||
|
||||
// UnionID 只有在用户将公众号绑定到微信开放平台帐号后,才会出现该字段。
|
||||
// 公众号文档 https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140842
|
||||
UnionID string `json:"unionid"`
|
||||
}
|
||||
|
||||
// GetUserInfoByCodeContext 通过网页授权的code 换取用户的信息
|
||||
func (oauth *Oauth) GetUserInfoByCodeContext(ctx ctx2.Context, code string) (result UserInfo, err error) {
|
||||
var (
|
||||
token ResAccessToken
|
||||
)
|
||||
if token, err = oauth.GetUserAccessTokenContext(ctx, code); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
return oauth.GetUserInfoContext(ctx, token.AccessToken, token.OpenID, "")
|
||||
}
|
||||
|
||||
// GetUserAccessToken 通过网页授权的code 换取access_token(区别于context中的access_token)
|
||||
func (oauth *Oauth) GetUserAccessToken(code string) (result ResAccessToken, err error) {
|
||||
return oauth.GetUserAccessTokenContext(ctx2.Background(), code)
|
||||
}
|
||||
|
||||
// GetUserAccessTokenContext 通过网页授权的code 换取access_token(区别于context中的access_token) with context
|
||||
func (oauth *Oauth) GetUserAccessTokenContext(ctx ctx2.Context, code string) (result ResAccessToken, err error) {
|
||||
urlStr := fmt.Sprintf(accessTokenURL, oauth.AppID, oauth.AppSecret, code)
|
||||
var response []byte
|
||||
response, err = util.HTTPGet(urlStr)
|
||||
response, err = util.HTTPGetContext(ctx, urlStr)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
@@ -90,9 +112,14 @@ func (oauth *Oauth) GetUserAccessToken(code string) (result ResAccessToken, err
|
||||
|
||||
// RefreshAccessToken 刷新access_token
|
||||
func (oauth *Oauth) RefreshAccessToken(refreshToken string) (result ResAccessToken, err error) {
|
||||
return oauth.RefreshAccessTokenContext(ctx2.Background(), refreshToken)
|
||||
}
|
||||
|
||||
// RefreshAccessTokenContext 刷新access_token with context
|
||||
func (oauth *Oauth) RefreshAccessTokenContext(ctx ctx2.Context, refreshToken string) (result ResAccessToken, err error) {
|
||||
urlStr := fmt.Sprintf(refreshAccessTokenURL, oauth.AppID, refreshToken)
|
||||
var response []byte
|
||||
response, err = util.HTTPGet(urlStr)
|
||||
response, err = util.HTTPGetContext(ctx, urlStr)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
@@ -109,9 +136,14 @@ func (oauth *Oauth) RefreshAccessToken(refreshToken string) (result ResAccessTok
|
||||
|
||||
// CheckAccessToken 检验access_token是否有效
|
||||
func (oauth *Oauth) CheckAccessToken(accessToken, openID string) (b bool, err error) {
|
||||
return oauth.CheckAccessTokenContext(ctx2.Background(), accessToken, openID)
|
||||
}
|
||||
|
||||
// CheckAccessTokenContext 检验access_token是否有效 with context
|
||||
func (oauth *Oauth) CheckAccessTokenContext(ctx ctx2.Context, accessToken, openID string) (b bool, err error) {
|
||||
urlStr := fmt.Sprintf(checkAccessTokenURL, accessToken, openID)
|
||||
var response []byte
|
||||
response, err = util.HTTPGet(urlStr)
|
||||
response, err = util.HTTPGetContext(ctx, urlStr)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
@@ -145,12 +177,17 @@ type UserInfo struct {
|
||||
|
||||
// GetUserInfo 如果scope为 snsapi_userinfo 则可以通过此方法获取到用户基本信息
|
||||
func (oauth *Oauth) GetUserInfo(accessToken, openID, lang string) (result UserInfo, err error) {
|
||||
return oauth.GetUserInfoContext(ctx2.Background(), accessToken, openID, lang)
|
||||
}
|
||||
|
||||
// GetUserInfoContext 如果scope为 snsapi_userinfo 则可以通过此方法获取到用户基本信息 with context
|
||||
func (oauth *Oauth) GetUserInfoContext(ctx ctx2.Context, accessToken, openID, lang string) (result UserInfo, err error) {
|
||||
if lang == "" {
|
||||
lang = "zh_CN"
|
||||
}
|
||||
urlStr := fmt.Sprintf(userInfoURL, accessToken, openID, lang)
|
||||
var response []byte
|
||||
response, err = util.HTTPGet(urlStr)
|
||||
response, err = util.HTTPGetContext(ctx, urlStr)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
@@ -154,134 +154,120 @@ func NewOCR(c *context.Context) *OCR {
|
||||
}
|
||||
|
||||
// IDCard 身份证OCR识别接口
|
||||
func (ocr *OCR) IDCard(path string) (ResIDCard ResIDCard, err error) {
|
||||
func (ocr *OCR) IDCard(path string) (resIDCard ResIDCard, err error) {
|
||||
accessToken, err := ocr.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrIDCardURL, url.QueryEscape(path), accessToken)
|
||||
|
||||
response, err := util.HTTPPost(uri, "")
|
||||
response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrIDCardURL, url.QueryEscape(path), accessToken), "")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &ResIDCard, "OCRIDCard")
|
||||
err = util.DecodeWithError(response, &resIDCard, "OCRIDCard")
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// BankCard 银行卡OCR识别接口
|
||||
func (ocr *OCR) BankCard(path string) (ResBankCard ResBankCard, err error) {
|
||||
func (ocr *OCR) BankCard(path string) (resBankCard ResBankCard, err error) {
|
||||
accessToken, err := ocr.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrBankCardURL, url.QueryEscape(path), accessToken)
|
||||
|
||||
response, err := util.HTTPPost(uri, "")
|
||||
response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrBankCardURL, url.QueryEscape(path), accessToken), "")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &ResBankCard, "OCRBankCard")
|
||||
err = util.DecodeWithError(response, &resBankCard, "OCRBankCard")
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// Driving 行驶证OCR识别接口
|
||||
func (ocr *OCR) Driving(path string) (ResDriving ResDriving, err error) {
|
||||
func (ocr *OCR) Driving(path string) (resDriving ResDriving, err error) {
|
||||
accessToken, err := ocr.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrDrivingURL, url.QueryEscape(path), accessToken)
|
||||
|
||||
response, err := util.HTTPPost(uri, "")
|
||||
response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrDrivingURL, url.QueryEscape(path), accessToken), "")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &ResDriving, "OCRDriving")
|
||||
err = util.DecodeWithError(response, &resDriving, "OCRDriving")
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// DrivingLicense 驾驶证OCR识别接口
|
||||
func (ocr *OCR) DrivingLicense(path string) (ResDrivingLicense ResDrivingLicense, err error) {
|
||||
func (ocr *OCR) DrivingLicense(path string) (resDrivingLicense ResDrivingLicense, err error) {
|
||||
accessToken, err := ocr.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrDrivingLicenseURL, url.QueryEscape(path), accessToken)
|
||||
|
||||
response, err := util.HTTPPost(uri, "")
|
||||
response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrDrivingLicenseURL, url.QueryEscape(path), accessToken), "")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &ResDrivingLicense, "OCRDrivingLicense")
|
||||
err = util.DecodeWithError(response, &resDrivingLicense, "OCRDrivingLicense")
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// BizLicense 营业执照OCR识别接口
|
||||
func (ocr *OCR) BizLicense(path string) (ResBizLicense ResBizLicense, err error) {
|
||||
func (ocr *OCR) BizLicense(path string) (resBizLicense ResBizLicense, err error) {
|
||||
accessToken, err := ocr.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrBizLicenseURL, url.QueryEscape(path), accessToken)
|
||||
|
||||
response, err := util.HTTPPost(uri, "")
|
||||
response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrBizLicenseURL, url.QueryEscape(path), accessToken), "")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &ResBizLicense, "OCRBizLicense")
|
||||
err = util.DecodeWithError(response, &resBizLicense, "OCRBizLicense")
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// Common 通用印刷体OCR识别接口
|
||||
func (ocr *OCR) Common(path string) (ResCommon ResCommon, err error) {
|
||||
func (ocr *OCR) Common(path string) (resCommon ResCommon, err error) {
|
||||
accessToken, err := ocr.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrCommonURL, url.QueryEscape(path), accessToken)
|
||||
|
||||
response, err := util.HTTPPost(uri, "")
|
||||
response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrCommonURL, url.QueryEscape(path), accessToken), "")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &ResCommon, "OCRCommon")
|
||||
err = util.DecodeWithError(response, &resCommon, "OCRCommon")
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// PlateNumber 车牌OCR识别接口
|
||||
func (ocr *OCR) PlateNumber(path string) (ResPlateNumber ResPlateNumber, err error) {
|
||||
func (ocr *OCR) PlateNumber(path string) (resPlateNumber ResPlateNumber, err error) {
|
||||
accessToken, err := ocr.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrPlateNumberURL, url.QueryEscape(path), accessToken)
|
||||
|
||||
response, err := util.HTTPPost(uri, "")
|
||||
response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrPlateNumberURL, url.QueryEscape(path), accessToken), "")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &ResPlateNumber, "OCRPlateNumber")
|
||||
err = util.DecodeWithError(response, &resPlateNumber, "OCRPlateNumber")
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
package officialaccount
|
||||
|
||||
import (
|
||||
stdcontext "context"
|
||||
"net/http"
|
||||
|
||||
"github.com/silenceper/wechat/v2/internal/openapi"
|
||||
"github.com/silenceper/wechat/v2/officialaccount/draft"
|
||||
"github.com/silenceper/wechat/v2/officialaccount/freepublish"
|
||||
"github.com/silenceper/wechat/v2/officialaccount/ocr"
|
||||
@@ -14,6 +16,7 @@ import (
|
||||
"github.com/silenceper/wechat/v2/officialaccount/broadcast"
|
||||
"github.com/silenceper/wechat/v2/officialaccount/config"
|
||||
"github.com/silenceper/wechat/v2/officialaccount/context"
|
||||
"github.com/silenceper/wechat/v2/officialaccount/customerservice"
|
||||
"github.com/silenceper/wechat/v2/officialaccount/device"
|
||||
"github.com/silenceper/wechat/v2/officialaccount/js"
|
||||
"github.com/silenceper/wechat/v2/officialaccount/material"
|
||||
@@ -26,7 +29,22 @@ import (
|
||||
|
||||
// OfficialAccount 微信公众号相关API
|
||||
type OfficialAccount struct {
|
||||
ctx *context.Context
|
||||
ctx *context.Context
|
||||
basic *basic.Basic
|
||||
menu *menu.Menu
|
||||
oauth *oauth.Oauth
|
||||
material *material.Material
|
||||
draft *draft.Draft
|
||||
freepublish *freepublish.FreePublish
|
||||
js *js.Js
|
||||
user *user.User
|
||||
templateMsg *message.Template
|
||||
managerMsg *message.Manager
|
||||
device *device.Device
|
||||
broadcast *broadcast.Broadcast
|
||||
datacube *datacube.DataCube
|
||||
ocr *ocr.OCR
|
||||
subscribeMsg *message.Subscribe
|
||||
}
|
||||
|
||||
// NewOfficialAccount 实例化公众号API
|
||||
@@ -51,12 +69,18 @@ func (officialAccount *OfficialAccount) GetContext() *context.Context {
|
||||
|
||||
// GetBasic qr/url 相关配置
|
||||
func (officialAccount *OfficialAccount) GetBasic() *basic.Basic {
|
||||
return basic.NewBasic(officialAccount.ctx)
|
||||
if officialAccount.basic == nil {
|
||||
officialAccount.basic = basic.NewBasic(officialAccount.ctx)
|
||||
}
|
||||
return officialAccount.basic
|
||||
}
|
||||
|
||||
// GetMenu 菜单管理接口
|
||||
func (officialAccount *OfficialAccount) GetMenu() *menu.Menu {
|
||||
return menu.NewMenu(officialAccount.ctx)
|
||||
if officialAccount.menu == nil {
|
||||
officialAccount.menu = menu.NewMenu(officialAccount.ctx)
|
||||
}
|
||||
return officialAccount.menu
|
||||
}
|
||||
|
||||
// GetServer 消息管理:接收事件,被动回复消息管理
|
||||
@@ -72,68 +96,125 @@ func (officialAccount *OfficialAccount) GetAccessToken() (string, error) {
|
||||
return officialAccount.ctx.GetAccessToken()
|
||||
}
|
||||
|
||||
// GetAccessTokenContext 获取access_token
|
||||
func (officialAccount *OfficialAccount) GetAccessTokenContext(ctx stdcontext.Context) (string, error) {
|
||||
if c, ok := officialAccount.ctx.AccessTokenHandle.(credential.AccessTokenContextHandle); ok {
|
||||
return c.GetAccessTokenContext(ctx)
|
||||
}
|
||||
return officialAccount.ctx.GetAccessToken()
|
||||
}
|
||||
|
||||
// GetOauth oauth2网页授权
|
||||
func (officialAccount *OfficialAccount) GetOauth() *oauth.Oauth {
|
||||
return oauth.NewOauth(officialAccount.ctx)
|
||||
if officialAccount.oauth == nil {
|
||||
officialAccount.oauth = oauth.NewOauth(officialAccount.ctx)
|
||||
}
|
||||
return officialAccount.oauth
|
||||
}
|
||||
|
||||
// GetMaterial 素材管理
|
||||
func (officialAccount *OfficialAccount) GetMaterial() *material.Material {
|
||||
return material.NewMaterial(officialAccount.ctx)
|
||||
if officialAccount.material == nil {
|
||||
officialAccount.material = material.NewMaterial(officialAccount.ctx)
|
||||
}
|
||||
return officialAccount.material
|
||||
}
|
||||
|
||||
// GetDraft 草稿箱
|
||||
func (officialAccount *OfficialAccount) GetDraft() *draft.Draft {
|
||||
return draft.NewDraft(officialAccount.ctx)
|
||||
if officialAccount.draft == nil {
|
||||
officialAccount.draft = draft.NewDraft(officialAccount.ctx)
|
||||
}
|
||||
return officialAccount.draft
|
||||
}
|
||||
|
||||
// GetFreePublish 发布能力
|
||||
func (officialAccount *OfficialAccount) GetFreePublish() *freepublish.FreePublish {
|
||||
return freepublish.NewFreePublish(officialAccount.ctx)
|
||||
if officialAccount.freepublish == nil {
|
||||
officialAccount.freepublish = freepublish.NewFreePublish(officialAccount.ctx)
|
||||
}
|
||||
return officialAccount.freepublish
|
||||
}
|
||||
|
||||
// GetJs js-sdk配置
|
||||
func (officialAccount *OfficialAccount) GetJs() *js.Js {
|
||||
return js.NewJs(officialAccount.ctx)
|
||||
if officialAccount.js == nil {
|
||||
officialAccount.js = js.NewJs(officialAccount.ctx)
|
||||
}
|
||||
return officialAccount.js
|
||||
}
|
||||
|
||||
// GetUser 用户管理接口
|
||||
func (officialAccount *OfficialAccount) GetUser() *user.User {
|
||||
return user.NewUser(officialAccount.ctx)
|
||||
if officialAccount.user == nil {
|
||||
officialAccount.user = user.NewUser(officialAccount.ctx)
|
||||
}
|
||||
return officialAccount.user
|
||||
}
|
||||
|
||||
// GetTemplate 模板消息接口
|
||||
func (officialAccount *OfficialAccount) GetTemplate() *message.Template {
|
||||
return message.NewTemplate(officialAccount.ctx)
|
||||
if officialAccount.templateMsg == nil {
|
||||
officialAccount.templateMsg = message.NewTemplate(officialAccount.ctx)
|
||||
}
|
||||
return officialAccount.templateMsg
|
||||
}
|
||||
|
||||
// GetCustomerMessageManager 客服消息接口
|
||||
func (officialAccount *OfficialAccount) GetCustomerMessageManager() *message.Manager {
|
||||
return message.NewMessageManager(officialAccount.ctx)
|
||||
if officialAccount.managerMsg == nil {
|
||||
officialAccount.managerMsg = message.NewMessageManager(officialAccount.ctx)
|
||||
}
|
||||
return officialAccount.managerMsg
|
||||
}
|
||||
|
||||
// GetDevice 获取智能设备的实例
|
||||
func (officialAccount *OfficialAccount) GetDevice() *device.Device {
|
||||
return device.NewDevice(officialAccount.ctx)
|
||||
if officialAccount.device == nil {
|
||||
officialAccount.device = device.NewDevice(officialAccount.ctx)
|
||||
}
|
||||
return officialAccount.device
|
||||
}
|
||||
|
||||
// GetBroadcast 群发消息
|
||||
// TODO 待完善
|
||||
func (officialAccount *OfficialAccount) GetBroadcast() *broadcast.Broadcast {
|
||||
return broadcast.NewBroadcast(officialAccount.ctx)
|
||||
if officialAccount.broadcast == nil {
|
||||
officialAccount.broadcast = broadcast.NewBroadcast(officialAccount.ctx)
|
||||
}
|
||||
return officialAccount.broadcast
|
||||
}
|
||||
|
||||
// GetDataCube 数据统计
|
||||
func (officialAccount *OfficialAccount) GetDataCube() *datacube.DataCube {
|
||||
return datacube.NewCube(officialAccount.ctx)
|
||||
if officialAccount.datacube == nil {
|
||||
officialAccount.datacube = datacube.NewCube(officialAccount.ctx)
|
||||
}
|
||||
return officialAccount.datacube
|
||||
}
|
||||
|
||||
// GetOCR OCR接口
|
||||
func (officialAccount *OfficialAccount) GetOCR() *ocr.OCR {
|
||||
return ocr.NewOCR(officialAccount.ctx)
|
||||
if officialAccount.ocr == nil {
|
||||
officialAccount.ocr = ocr.NewOCR(officialAccount.ctx)
|
||||
}
|
||||
return officialAccount.ocr
|
||||
}
|
||||
|
||||
// GetSubscribe 公众号订阅消息
|
||||
func (officialAccount *OfficialAccount) GetSubscribe() *message.Subscribe {
|
||||
return message.NewSubscribe(officialAccount.ctx)
|
||||
if officialAccount.subscribeMsg == nil {
|
||||
officialAccount.subscribeMsg = message.NewSubscribe(officialAccount.ctx)
|
||||
}
|
||||
return officialAccount.subscribeMsg
|
||||
}
|
||||
|
||||
// GetCustomerServiceManager 客服管理
|
||||
func (officialAccount *OfficialAccount) GetCustomerServiceManager() *customerservice.Manager {
|
||||
return customerservice.NewCustomerServiceManager(officialAccount.ctx)
|
||||
}
|
||||
|
||||
// GetOpenAPI openApi管理接口
|
||||
func (officialAccount *OfficialAccount) GetOpenAPI() *openapi.OpenAPI {
|
||||
return openapi.NewOpenAPI(officialAccount.ctx)
|
||||
}
|
||||
|
||||
@@ -5,7 +5,7 @@ import (
|
||||
"encoding/xml"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io/ioutil"
|
||||
"io"
|
||||
"net/http"
|
||||
"reflect"
|
||||
"runtime/debug"
|
||||
@@ -13,11 +13,11 @@ import (
|
||||
"strings"
|
||||
|
||||
log "github.com/sirupsen/logrus"
|
||||
"github.com/tidwall/gjson"
|
||||
|
||||
"github.com/silenceper/wechat/v2/officialaccount/context"
|
||||
"github.com/silenceper/wechat/v2/officialaccount/message"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
"github.com/tidwall/gjson"
|
||||
)
|
||||
|
||||
// Server struct
|
||||
@@ -73,6 +73,11 @@ func (srv *Server) Serve() error {
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// 非安全模式下,请求处理方法返回为 nil 则直接回复 success 给微信服务器
|
||||
if response == nil && !srv.isSafeMode {
|
||||
srv.String("success")
|
||||
return nil
|
||||
}
|
||||
|
||||
// debug print request msg
|
||||
log.Debugf("request msg =%s", string(srv.RequestRawXMLMsg))
|
||||
@@ -101,7 +106,7 @@ func (srv *Server) handleRequest() (reply *message.Reply, err error) {
|
||||
srv.isSafeMode = true
|
||||
}
|
||||
|
||||
//set request contentType
|
||||
// set request contentType
|
||||
contentType := srv.Request.Header.Get("Content-Type")
|
||||
srv.isJSONContent = strings.Contains(contentType, "application/json")
|
||||
|
||||
@@ -157,7 +162,7 @@ func (srv *Server) getMessage() (interface{}, error) {
|
||||
return nil, fmt.Errorf("消息解密失败, err=%v", err)
|
||||
}
|
||||
} else {
|
||||
rawXMLMsgBytes, err = ioutil.ReadAll(srv.Request.Body)
|
||||
rawXMLMsgBytes, err = io.ReadAll(srv.Request.Body)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("从body中解析xml失败, err=%v", err)
|
||||
}
|
||||
@@ -188,12 +193,12 @@ func (srv *Server) parseRequestMessage(rawXMLMsgBytes []byte) (msg *message.MixM
|
||||
err = xml.Unmarshal(rawXMLMsgBytes, msg)
|
||||
return
|
||||
}
|
||||
//parse json
|
||||
// parse json
|
||||
err = json.Unmarshal(rawXMLMsgBytes, msg)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
// nonstandard json, 目前小程序订阅消息返回数据格式不标准,订阅消息模板单个List返回是对象,多个List返回是数组。
|
||||
// nonstandard json, 目前小程序订阅消息返回数据格式不标准,订阅消息模板单个 List 返回是对象,多个 List 返回是数组。
|
||||
if msg.MsgType == message.MsgTypeEvent {
|
||||
listData := gjson.Get(string(rawXMLMsgBytes), "List")
|
||||
if listData.IsObject() {
|
||||
@@ -279,7 +284,7 @@ func (srv *Server) Send() (err error) {
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
// TODO 如果获取不到timestamp nonce 则自己生成
|
||||
// TODO 如果获取不到 timestamp nonce 则自己生成
|
||||
timestamp := srv.timestamp
|
||||
timestampStr := strconv.FormatInt(timestamp, 10)
|
||||
msgSignature := util.Signature(srv.Token, timestampStr, srv.nonce, string(encryptedMsg))
|
||||
|
||||
116
officialaccount/user/blacklist.go
Normal file
116
officialaccount/user/blacklist.go
Normal file
@@ -0,0 +1,116 @@
|
||||
// Package user blacklist 公众号用户黑名单管理
|
||||
// 参考文档:https://developers.weixin.qq.com/doc/offiaccount/User_Management/Manage_blacklist.html
|
||||
package user
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
// 获取公众号的黑名单列表
|
||||
getblacklistURL = "https://api.weixin.qq.com/cgi-bin/tags/members/getblacklist?access_token=%s"
|
||||
// 拉黑用户
|
||||
batchblacklistURL = "https://api.weixin.qq.com/cgi-bin/tags/members/batchblacklist?access_token=%s"
|
||||
// 取消拉黑用户
|
||||
batchunblacklistURL = "https://api.weixin.qq.com/cgi-bin/tags/members/batchunblacklist?access_token=%s"
|
||||
)
|
||||
|
||||
// GetBlackList 获取公众号的黑名单列表
|
||||
// 该接口每次调用最多可拉取 1000 个OpenID,当列表数较多时,可以通过多次拉取的方式来满足需求。
|
||||
// 参数 beginOpenid:当 begin_openid 为空时,默认从开头拉取。
|
||||
func (user *User) GetBlackList(beginOpenid ...string) (userlist *OpenidList, err error) {
|
||||
if len(beginOpenid) > 1 {
|
||||
return nil, errors.New("参数 beginOpenid 错误:请传递 1 个openID,若需要从头开始拉取列表请留空。")
|
||||
}
|
||||
// 获取 AccessToken
|
||||
var accessToken string
|
||||
if accessToken, err = user.GetAccessToken(); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 处理 request 内容
|
||||
request := map[string]string{"begin_openid": ""}
|
||||
if len(beginOpenid) == 1 {
|
||||
request["begin_openid"] = beginOpenid[0]
|
||||
}
|
||||
|
||||
// 调用接口
|
||||
var resp []byte
|
||||
url := fmt.Sprintf(getblacklistURL, accessToken)
|
||||
if resp, err = util.PostJSON(url, &request); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// 处理返回
|
||||
userlist = &OpenidList{}
|
||||
if err = util.DecodeWithError(resp, userlist, "GetBlackList"); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// GetAllBlackList 获取公众号的所有黑名单列表
|
||||
func (user *User) GetAllBlackList() (openIDList []string, err error) {
|
||||
var (
|
||||
beginOpenid string
|
||||
count int
|
||||
userlist *OpenidList
|
||||
)
|
||||
|
||||
for {
|
||||
// 获取列表(每次1k条)
|
||||
if userlist, err = user.GetBlackList(beginOpenid); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
openIDList = append(openIDList, userlist.Data.OpenIDs...) // 存储本次获得的OpenIDs
|
||||
count += userlist.Count // 记录获得的总数量
|
||||
beginOpenid = userlist.NextOpenID // 记录下次循环的起始openID
|
||||
if count >= userlist.Total {
|
||||
break // 获得的数量=total,结束循环
|
||||
}
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// BatchBlackList 拉黑用户
|
||||
// 参数 openidList:需要拉入黑名单的用户的openid,每次拉黑最多允许20个
|
||||
func (user *User) BatchBlackList(openidList ...string) (err error) {
|
||||
return user.batch(batchblacklistURL, "BatchBlackList", openidList...)
|
||||
}
|
||||
|
||||
// BatchUnBlackList 取消拉黑用户
|
||||
// 参数 openidList:需要取消拉入黑名单的用户的openid,每次拉黑最多允许20个
|
||||
func (user *User) BatchUnBlackList(openidList ...string) (err error) {
|
||||
return user.batch(batchunblacklistURL, "BatchUnBlackList", openidList...)
|
||||
}
|
||||
|
||||
// batch 公共方法
|
||||
func (user *User) batch(url, apiName string, openidList ...string) (err error) {
|
||||
// 检查参数
|
||||
if len(openidList) == 0 || len(openidList) > 20 {
|
||||
return errors.New("参数 openidList 错误:每次操作黑名单用户数量为1-20个。")
|
||||
}
|
||||
|
||||
// 获取 AccessToken
|
||||
var accessToken string
|
||||
if accessToken, err = user.GetAccessToken(); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 处理 request 内容
|
||||
request := map[string][]string{"openid_list": openidList}
|
||||
|
||||
// 调用接口
|
||||
var resp []byte
|
||||
url = fmt.Sprintf(url, accessToken)
|
||||
if resp, err = util.PostJSON(url, &request); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
return util.DecodeWithCommonError(resp, apiName)
|
||||
}
|
||||
@@ -62,10 +62,6 @@ func (user *User) ListChangeOpenIDs(fromAppID string, openIDs ...string) (list *
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(resp, list, "ListChangeOpenIDs")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
@@ -126,10 +126,7 @@ func (user *User) GetTag() (tags []*TagInfo, err error) {
|
||||
Tags []*TagInfo `json:"tags"`
|
||||
}
|
||||
err = json.Unmarshal(response, &result)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
return result.Tags, nil
|
||||
return result.Tags, err
|
||||
}
|
||||
|
||||
// OpenIDListByTag 获取标签下粉丝列表
|
||||
@@ -154,9 +151,6 @@ func (user *User) OpenIDListByTag(tagID int32, nextOpenID ...string) (userList *
|
||||
}
|
||||
userList = new(TagOpenIDList)
|
||||
err = json.Unmarshal(response, &userList)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -2,11 +2,13 @@
|
||||
package context
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net/url"
|
||||
"time"
|
||||
|
||||
"github.com/silenceper/wechat/v2/cache"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
@@ -31,24 +33,29 @@ type ComponentAccessToken struct {
|
||||
ExpiresIn int64 `json:"expires_in"`
|
||||
}
|
||||
|
||||
// GetComponentAccessToken 获取 ComponentAccessToken
|
||||
func (ctx *Context) GetComponentAccessToken() (string, error) {
|
||||
// GetComponentAccessTokenContext 获取 ComponentAccessToken
|
||||
func (ctx *Context) GetComponentAccessTokenContext(stdCtx context.Context) (string, error) {
|
||||
accessTokenCacheKey := fmt.Sprintf("component_access_token_%s", ctx.AppID)
|
||||
val := ctx.Cache.Get(accessTokenCacheKey)
|
||||
val := cache.GetContext(stdCtx, ctx.Cache, accessTokenCacheKey)
|
||||
if val == nil {
|
||||
return "", fmt.Errorf("cann't get component access token")
|
||||
}
|
||||
return val.(string), nil
|
||||
}
|
||||
|
||||
// SetComponentAccessToken 通过component_verify_ticket 获取 ComponentAccessToken
|
||||
func (ctx *Context) SetComponentAccessToken(verifyTicket string) (*ComponentAccessToken, error) {
|
||||
// GetComponentAccessToken 获取 ComponentAccessToken
|
||||
func (ctx *Context) GetComponentAccessToken() (string, error) {
|
||||
return ctx.GetComponentAccessTokenContext(context.Background())
|
||||
}
|
||||
|
||||
// SetComponentAccessTokenContext 通过component_verify_ticket 获取 ComponentAccessToken
|
||||
func (ctx *Context) SetComponentAccessTokenContext(stdCtx context.Context, verifyTicket string) (*ComponentAccessToken, error) {
|
||||
body := map[string]string{
|
||||
"component_appid": ctx.AppID,
|
||||
"component_appsecret": ctx.AppSecret,
|
||||
"component_verify_ticket": verifyTicket,
|
||||
}
|
||||
respBody, err := util.PostJSON(componentAccessTokenURL, body)
|
||||
respBody, err := util.PostJSONContext(stdCtx, componentAccessTokenURL, body)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -64,15 +71,20 @@ func (ctx *Context) SetComponentAccessToken(verifyTicket string) (*ComponentAcce
|
||||
|
||||
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 {
|
||||
if err := cache.SetContext(stdCtx, ctx.Cache, accessTokenCacheKey, at.AccessToken, time.Duration(expires)*time.Second); err != nil {
|
||||
return nil, nil
|
||||
}
|
||||
return at, nil
|
||||
}
|
||||
|
||||
// GetPreCode 获取预授权码
|
||||
func (ctx *Context) GetPreCode() (string, error) {
|
||||
cat, err := ctx.GetComponentAccessToken()
|
||||
// SetComponentAccessToken 通过component_verify_ticket 获取 ComponentAccessToken
|
||||
func (ctx *Context) SetComponentAccessToken(stdCtx context.Context, verifyTicket string) (*ComponentAccessToken, error) {
|
||||
return ctx.SetComponentAccessTokenContext(stdCtx, verifyTicket)
|
||||
}
|
||||
|
||||
// GetPreCodeContext 获取预授权码
|
||||
func (ctx *Context) GetPreCodeContext(stdCtx context.Context) (string, error) {
|
||||
cat, err := ctx.GetComponentAccessTokenContext(stdCtx)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
@@ -80,7 +92,7 @@ func (ctx *Context) GetPreCode() (string, error) {
|
||||
"component_appid": ctx.AppID,
|
||||
}
|
||||
uri := fmt.Sprintf(getPreCodeURL, cat)
|
||||
body, err := util.PostJSON(uri, req)
|
||||
body, err := util.PostJSONContext(stdCtx, uri, req)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
@@ -88,31 +100,43 @@ func (ctx *Context) GetPreCode() (string, error) {
|
||||
var ret struct {
|
||||
PreCode string `json:"pre_auth_code"`
|
||||
}
|
||||
if err := json.Unmarshal(body, &ret); err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
return ret.PreCode, nil
|
||||
err = json.Unmarshal(body, &ret)
|
||||
return ret.PreCode, err
|
||||
}
|
||||
|
||||
// GetComponentLoginPage 获取第三方公众号授权链接(扫码授权)
|
||||
func (ctx *Context) GetComponentLoginPage(redirectURI string, authType int, bizAppID string) (string, error) {
|
||||
code, err := ctx.GetPreCode()
|
||||
// GetPreCode 获取预授权码
|
||||
func (ctx *Context) GetPreCode() (string, error) {
|
||||
return ctx.GetPreCodeContext(context.Background())
|
||||
}
|
||||
|
||||
// GetComponentLoginPageContext 获取第三方公众号授权链接(扫码授权)
|
||||
func (ctx *Context) GetComponentLoginPageContext(stdCtx context.Context, redirectURI string, authType int, bizAppID string) (string, error) {
|
||||
code, err := ctx.GetPreCodeContext(stdCtx)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return fmt.Sprintf(componentLoginURL, ctx.AppID, code, url.QueryEscape(redirectURI), authType, bizAppID), nil
|
||||
}
|
||||
|
||||
// GetBindComponentURL 获取第三方公众号授权链接(链接跳转,适用移动端)
|
||||
func (ctx *Context) GetBindComponentURL(redirectURI string, authType int, bizAppID string) (string, error) {
|
||||
code, err := ctx.GetPreCode()
|
||||
// GetComponentLoginPage 获取第三方公众号授权链接(扫码授权)
|
||||
func (ctx *Context) GetComponentLoginPage(redirectURI string, authType int, bizAppID string) (string, error) {
|
||||
return ctx.GetComponentLoginPageContext(context.Background(), redirectURI, authType, bizAppID)
|
||||
}
|
||||
|
||||
// GetBindComponentURLContext 获取第三方公众号授权链接(链接跳转,适用移动端)
|
||||
func (ctx *Context) GetBindComponentURLContext(stdCtx context.Context, redirectURI string, authType int, bizAppID string) (string, error) {
|
||||
code, err := ctx.GetPreCodeContext(stdCtx)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return fmt.Sprintf(bindComponentURL, authType, ctx.AppID, code, url.QueryEscape(redirectURI), bizAppID), nil
|
||||
}
|
||||
|
||||
// GetBindComponentURL 获取第三方公众号授权链接(链接跳转,适用移动端)
|
||||
func (ctx *Context) GetBindComponentURL(redirectURI string, authType int, bizAppID string) (string, error) {
|
||||
return ctx.GetBindComponentURLContext(context.Background(), redirectURI, authType, bizAppID)
|
||||
}
|
||||
|
||||
// ID 微信返回接口中各种类型字段
|
||||
type ID struct {
|
||||
ID int `json:"id"`
|
||||
@@ -137,9 +161,9 @@ type AuthrAccessToken struct {
|
||||
RefreshToken string `json:"authorizer_refresh_token"`
|
||||
}
|
||||
|
||||
// QueryAuthCode 使用授权码换取公众号或小程序的接口调用凭据和授权信息
|
||||
func (ctx *Context) QueryAuthCode(authCode string) (*AuthBaseInfo, error) {
|
||||
cat, err := ctx.GetComponentAccessToken()
|
||||
// QueryAuthCodeContext 使用授权码换取公众号或小程序的接口调用凭据和授权信息
|
||||
func (ctx *Context) QueryAuthCodeContext(stdCtx context.Context, authCode string) (*AuthBaseInfo, error) {
|
||||
cat, err := ctx.GetComponentAccessTokenContext(stdCtx)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -149,7 +173,7 @@ func (ctx *Context) QueryAuthCode(authCode string) (*AuthBaseInfo, error) {
|
||||
"authorization_code": authCode,
|
||||
}
|
||||
uri := fmt.Sprintf(queryAuthURL, cat)
|
||||
body, err := util.PostJSON(uri, req)
|
||||
body, err := util.PostJSONContext(stdCtx, uri, req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -169,9 +193,14 @@ func (ctx *Context) QueryAuthCode(authCode string) (*AuthBaseInfo, error) {
|
||||
return ret.Info, nil
|
||||
}
|
||||
|
||||
// RefreshAuthrToken 获取(刷新)授权公众号或小程序的接口调用凭据(令牌)
|
||||
func (ctx *Context) RefreshAuthrToken(appid, refreshToken string) (*AuthrAccessToken, error) {
|
||||
cat, err := ctx.GetComponentAccessToken()
|
||||
// QueryAuthCode 使用授权码换取公众号或小程序的接口调用凭据和授权信息
|
||||
func (ctx *Context) QueryAuthCode(authCode string) (*AuthBaseInfo, error) {
|
||||
return ctx.QueryAuthCodeContext(context.Background(), authCode)
|
||||
}
|
||||
|
||||
// RefreshAuthrTokenContext 获取(刷新)授权公众号或小程序的接口调用凭据(令牌)
|
||||
func (ctx *Context) RefreshAuthrTokenContext(stdCtx context.Context, appid, refreshToken string) (*AuthrAccessToken, error) {
|
||||
cat, err := ctx.GetComponentAccessTokenContext(stdCtx)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -182,7 +211,7 @@ func (ctx *Context) RefreshAuthrToken(appid, refreshToken string) (*AuthrAccessT
|
||||
"authorizer_refresh_token": refreshToken,
|
||||
}
|
||||
uri := fmt.Sprintf(refreshTokenURL, cat)
|
||||
body, err := util.PostJSON(uri, req)
|
||||
body, err := util.PostJSONContext(stdCtx, uri, req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -193,22 +222,32 @@ func (ctx *Context) RefreshAuthrToken(appid, refreshToken string) (*AuthrAccessT
|
||||
}
|
||||
|
||||
authrTokenKey := "authorizer_access_token_" + appid
|
||||
if err := ctx.Cache.Set(authrTokenKey, ret.AccessToken, time.Minute*80); err != nil {
|
||||
if err := cache.SetContext(stdCtx, ctx.Cache, authrTokenKey, ret.AccessToken, time.Second*time.Duration(ret.ExpiresIn-30)); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return ret, nil
|
||||
}
|
||||
|
||||
// GetAuthrAccessToken 获取授权方AccessToken
|
||||
func (ctx *Context) GetAuthrAccessToken(appid string) (string, error) {
|
||||
// RefreshAuthrToken 获取(刷新)授权公众号或小程序的接口调用凭据(令牌)
|
||||
func (ctx *Context) RefreshAuthrToken(appid, refreshToken string) (*AuthrAccessToken, error) {
|
||||
return ctx.RefreshAuthrTokenContext(context.Background(), appid, refreshToken)
|
||||
}
|
||||
|
||||
// GetAuthrAccessTokenContext 获取授权方AccessToken
|
||||
func (ctx *Context) GetAuthrAccessTokenContext(stdCtx context.Context, appid string) (string, error) {
|
||||
authrTokenKey := "authorizer_access_token_" + appid
|
||||
val := ctx.Cache.Get(authrTokenKey)
|
||||
val := cache.GetContext(stdCtx, ctx.Cache, authrTokenKey)
|
||||
if val == nil {
|
||||
return "", fmt.Errorf("cannot get authorizer %s access token", appid)
|
||||
}
|
||||
return val.(string), nil
|
||||
}
|
||||
|
||||
// GetAuthrAccessToken 获取授权方AccessToken
|
||||
func (ctx *Context) GetAuthrAccessToken(appid string) (string, error) {
|
||||
return ctx.GetAuthrAccessTokenContext(context.Background(), appid)
|
||||
}
|
||||
|
||||
// AuthorizerInfo 授权方详细信息
|
||||
type AuthorizerInfo struct {
|
||||
NickName string `json:"nick_name"`
|
||||
@@ -226,11 +265,41 @@ type AuthorizerInfo struct {
|
||||
}
|
||||
Alias string `json:"alias"`
|
||||
QrcodeURL string `json:"qrcode_url"`
|
||||
|
||||
MiniProgramInfo *MiniProgramInfo `json:"MiniProgramInfo"`
|
||||
RegisterType int `json:"register_type"`
|
||||
AccountStatus int `json:"account_status"`
|
||||
BasicConfig *AuthorizerBasicConfig `json:"basic_config"`
|
||||
}
|
||||
|
||||
// GetAuthrInfo 获取授权方的帐号基本信息
|
||||
func (ctx *Context) GetAuthrInfo(appid string) (*AuthorizerInfo, *AuthBaseInfo, error) {
|
||||
cat, err := ctx.GetComponentAccessToken()
|
||||
// AuthorizerBasicConfig 授权账号的基础配置结构体
|
||||
type AuthorizerBasicConfig struct {
|
||||
IsPhoneConfigured bool `json:"isPhoneConfigured"`
|
||||
IsEmailConfigured bool `json:"isEmailConfigured"`
|
||||
}
|
||||
|
||||
// MiniProgramInfo 授权账号小程序配置 授权账号为小程序时存在
|
||||
type MiniProgramInfo struct {
|
||||
Network struct {
|
||||
RequestDomain []string `json:"RequestDomain"`
|
||||
WsRequestDomain []string `json:"WsRequestDomain"`
|
||||
UploadDomain []string `json:"UploadDomain"`
|
||||
DownloadDomain []string `json:"DownloadDomain"`
|
||||
BizDomain []string `json:"BizDomain"`
|
||||
UDPDomain []string `json:"UDPDomain"`
|
||||
} `json:"network"`
|
||||
Categories []CategoriesInfo `json:"categories"`
|
||||
}
|
||||
|
||||
// CategoriesInfo 授权账号小程序配置的类目信息
|
||||
type CategoriesInfo struct {
|
||||
First string `wx:"first"`
|
||||
Second string `wx:"second"`
|
||||
}
|
||||
|
||||
// GetAuthrInfoContext 获取授权方的帐号基本信息
|
||||
func (ctx *Context) GetAuthrInfoContext(stdCtx context.Context, appid string) (*AuthorizerInfo, *AuthBaseInfo, error) {
|
||||
cat, err := ctx.GetComponentAccessTokenContext(stdCtx)
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
@@ -241,7 +310,7 @@ func (ctx *Context) GetAuthrInfo(appid string) (*AuthorizerInfo, *AuthBaseInfo,
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(getComponentInfoURL, cat)
|
||||
body, err := util.PostJSON(uri, req)
|
||||
body, err := util.PostJSONContext(stdCtx, uri, req)
|
||||
if err != nil {
|
||||
return nil, nil, err
|
||||
}
|
||||
@@ -256,3 +325,8 @@ func (ctx *Context) GetAuthrInfo(appid string) (*AuthorizerInfo, *AuthBaseInfo,
|
||||
|
||||
return ret.AuthorizerInfo, ret.AuthorizationInfo, nil
|
||||
}
|
||||
|
||||
// GetAuthrInfo 获取授权方的帐号基本信息
|
||||
func (ctx *Context) GetAuthrInfo(appid string) (*AuthorizerInfo, *AuthBaseInfo, error) {
|
||||
return ctx.GetAuthrInfoContext(context.Background(), appid)
|
||||
}
|
||||
|
||||
@@ -9,6 +9,12 @@ import (
|
||||
|
||||
const (
|
||||
getAccountBasicInfoURL = "https://api.weixin.qq.com/cgi-bin/account/getaccountbasicinfo"
|
||||
checkNickNameURL = "https://api.weixin.qq.com/cgi-bin/wxverify/checkwxverifynickname"
|
||||
setNickNameURL = "https://api.weixin.qq.com/wxa/setnickname"
|
||||
setSignatureURL = "https://api.weixin.qq.com/cgi-bin/account/modifysignature"
|
||||
setHeadImageURL = "https://api.weixin.qq.com/cgi-bin/account/modifyheadimage"
|
||||
getSearchStatusURL = "https://api.weixin.qq.com/wxa/getwxasearchstatus"
|
||||
setSearchStatusURL = "https://api.weixin.qq.com/wxa/changewxasearchstatus"
|
||||
)
|
||||
|
||||
// Basic 基础信息设置
|
||||
@@ -28,6 +34,7 @@ type AccountBasicInfo struct {
|
||||
}
|
||||
|
||||
// GetAccountBasicInfo 获取小程序基础信息
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/Mini_Programs/Mini_Program_Information_Settings.html
|
||||
func (basic *Basic) GetAccountBasicInfo() (*AccountBasicInfo, error) {
|
||||
ak, err := basic.GetAuthrAccessToken(basic.AppID)
|
||||
@@ -50,3 +57,181 @@ func (basic *Basic) GetAccountBasicInfo() (*AccountBasicInfo, error) {
|
||||
// TODO
|
||||
// func (encryptor *Basic) modifyDomain() {
|
||||
// }
|
||||
|
||||
// CheckNickNameResp 小程序名称检测结果
|
||||
type CheckNickNameResp struct {
|
||||
util.CommonError
|
||||
HitCondition bool `json:"hit_condition"` // 是否命中关键字策略。若命中,可以选填关键字材料
|
||||
Wording string `json:"wording"` // 命中关键字的说明描述
|
||||
}
|
||||
|
||||
// CheckNickName 检测微信认证的名称是否符合规则
|
||||
// ref: https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/basic-info-management/checkNickName.html
|
||||
func (basic *Basic) CheckNickName(nickname string) (*CheckNickNameResp, error) {
|
||||
ak, err := basic.GetAuthrAccessToken(basic.AppID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
url := fmt.Sprintf("%s?access_token=%s", checkNickNameURL, ak)
|
||||
data, err := util.PostJSON(url, map[string]string{
|
||||
"nick_name": nickname,
|
||||
})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
res := &CheckNickNameResp{}
|
||||
err = util.DecodeWithError(data, res, "CheckNickName")
|
||||
return res, err
|
||||
}
|
||||
|
||||
// SetNickNameResp 设置小程序名称结果
|
||||
type SetNickNameResp struct {
|
||||
util.CommonError
|
||||
AuditID int64 `json:"audit_id"` // 审核单Id,通过用于查询改名审核状态
|
||||
Wording string `json:"wording"` // 材料说明
|
||||
}
|
||||
|
||||
// SetNickNameParam 设置小程序名称参数
|
||||
type SetNickNameParam struct {
|
||||
NickName string `json:"nick_name"` // 昵称,不支持包含“小程序”关键字的昵称
|
||||
IDCard string `json:"id_card,omitempty"` // 身份证照片 mediaid,个人号必填
|
||||
License string `json:"license,omitempty"` // 组织机构代码证或营业执照 mediaid,组织号必填
|
||||
NameingOtherStuff1 string `json:"naming_other_stuff_1,omitempty"` // 其他证明材料 mediaid,选填
|
||||
NameingOtherStuff2 string `json:"naming_other_stuff_2,omitempty"` // 其他证明材料 mediaid,选填
|
||||
NameingOtherStuff3 string `json:"naming_other_stuff_3,omitempty"` // 其他证明材料 mediaid,选填
|
||||
NameingOtherStuff4 string `json:"naming_other_stuff_4,omitempty"` // 其他证明材料 mediaid,选填
|
||||
NameingOtherStuff5 string `json:"naming_other_stuff_5,omitempty"` // 其他证明材料 mediaid,选填
|
||||
}
|
||||
|
||||
// SetNickName 设置小程序名称
|
||||
func (basic *Basic) SetNickName(nickname string) (*SetNickNameResp, error) {
|
||||
return basic.SetNickNameFull(&SetNickNameParam{
|
||||
NickName: nickname,
|
||||
})
|
||||
}
|
||||
|
||||
// SetNickNameFull 设置小程序名称
|
||||
// ref: https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/basic-info-management/setNickName.html
|
||||
func (basic *Basic) SetNickNameFull(param *SetNickNameParam) (*SetNickNameResp, error) {
|
||||
ak, err := basic.GetAuthrAccessToken(basic.AppID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
url := fmt.Sprintf("%s?access_token=%s", setNickNameURL, ak)
|
||||
data, err := util.PostJSON(url, param)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
res := &SetNickNameResp{}
|
||||
err = util.DecodeWithError(data, res, "SetNickName")
|
||||
return res, err
|
||||
}
|
||||
|
||||
// SetSignatureResp 小程序功能介绍修改结果
|
||||
type SetSignatureResp struct {
|
||||
util.CommonError
|
||||
}
|
||||
|
||||
// SetSignature 小程序修改功能介绍
|
||||
// ref: https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/basic-info-management/setSignature.html
|
||||
func (basic *Basic) SetSignature(signature string) error {
|
||||
ak, err := basic.GetAuthrAccessToken(basic.AppID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
url := fmt.Sprintf("%s?access_token=%s", setSignatureURL, ak)
|
||||
data, err := util.PostJSON(url, map[string]string{
|
||||
"signature": signature,
|
||||
})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithError(data, &SetSignatureResp{}, "SetSignature")
|
||||
}
|
||||
|
||||
// GetSearchStatusResp 查询小程序当前是否可被搜索
|
||||
type GetSearchStatusResp struct {
|
||||
util.CommonError
|
||||
Status int `json:"status"` // 1 表示不可搜索,0 表示可搜索
|
||||
}
|
||||
|
||||
// GetSearchStatus 查询小程序当前是否可被搜索
|
||||
// ref: https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/basic-info-management/getSearchStatus.html
|
||||
func (basic *Basic) GetSearchStatus(signature string) (*GetSearchStatusResp, error) {
|
||||
ak, err := basic.GetAuthrAccessToken(basic.AppID)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
url := fmt.Sprintf("%s?access_token=%s", getSearchStatusURL, ak)
|
||||
data, err := util.HTTPGet(url)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
res := &GetSearchStatusResp{}
|
||||
err = util.DecodeWithError(data, res, "GetSearchStatus")
|
||||
return res, err
|
||||
}
|
||||
|
||||
// SetSearchStatusResp 小程序是否可被搜索修改结果
|
||||
type SetSearchStatusResp struct {
|
||||
util.CommonError
|
||||
}
|
||||
|
||||
// SetSearchStatus 修改小程序是否可被搜索
|
||||
// status: 1 表示不可搜索,0 表示可搜索
|
||||
// ref: https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/basic-info-management/setSearchStatus.html
|
||||
func (basic *Basic) SetSearchStatus(status int) error {
|
||||
ak, err := basic.GetAuthrAccessToken(basic.AppID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
url := fmt.Sprintf("%s?access_token=%s", setSearchStatusURL, ak)
|
||||
data, err := util.PostJSON(url, map[string]int{
|
||||
"status": status,
|
||||
})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithError(data, &SetSearchStatusResp{}, "SetSearchStatus")
|
||||
}
|
||||
|
||||
// SetHeadImageResp 小程序头像修改结果
|
||||
type SetHeadImageResp struct {
|
||||
util.CommonError
|
||||
}
|
||||
|
||||
// SetHeadImageParam 小程序头像修改参数
|
||||
type SetHeadImageParam struct {
|
||||
HeadImageMediaID string `json:"head_img_media_id"` // 头像素材 media_id
|
||||
X1 string `json:"x1"` // 裁剪框左上角 x 坐标(取值范围:[0, 1])
|
||||
Y1 string `json:"y1"` // 裁剪框左上角 y 坐标(取值范围:[0, 1])
|
||||
X2 string `json:"x2"` // 裁剪框右下角 x 坐标(取值范围:[0, 1])
|
||||
Y2 string `json:"y2"` // 裁剪框右下角 y 坐标(取值范围:[0, 1])
|
||||
}
|
||||
|
||||
// SetHeadImage 修改小程序头像
|
||||
func (basic *Basic) SetHeadImage(imgMediaID string) error {
|
||||
return basic.SetHeadImageFull(&SetHeadImageParam{
|
||||
HeadImageMediaID: imgMediaID,
|
||||
X1: "0",
|
||||
Y1: "0",
|
||||
X2: "1",
|
||||
Y2: "1",
|
||||
})
|
||||
}
|
||||
|
||||
// SetHeadImageFull 修改小程序头像
|
||||
// 新增临时素材: https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html
|
||||
// ref: https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/basic-info-management/setHeadImage.html
|
||||
func (basic *Basic) SetHeadImageFull(param *SetHeadImageParam) error {
|
||||
ak, err := basic.GetAuthrAccessToken(basic.AppID)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
url := fmt.Sprintf("%s?access_token=%s", setHeadImageURL, ak)
|
||||
data, err := util.PostJSON(url, param)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithError(data, &SetHeadImageResp{}, "account/setheadimage")
|
||||
}
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -1,6 +1,13 @@
|
||||
package miniprogram
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/credential"
|
||||
"github.com/silenceper/wechat/v2/miniprogram"
|
||||
miniConfig "github.com/silenceper/wechat/v2/miniprogram/config"
|
||||
miniContext "github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/urllink"
|
||||
openContext "github.com/silenceper/wechat/v2/openplatform/context"
|
||||
"github.com/silenceper/wechat/v2/openplatform/miniprogram/basic"
|
||||
"github.com/silenceper/wechat/v2/openplatform/miniprogram/component"
|
||||
@@ -10,14 +17,41 @@ import (
|
||||
type MiniProgram struct {
|
||||
AppID string
|
||||
openContext *openContext.Context
|
||||
*miniprogram.MiniProgram
|
||||
authorizerRefreshToken string
|
||||
}
|
||||
|
||||
// GetAccessToken 获取ak
|
||||
func (miniProgram *MiniProgram) GetAccessToken() (string, error) {
|
||||
ak, akErr := miniProgram.openContext.GetAuthrAccessToken(miniProgram.AppID)
|
||||
if akErr == nil {
|
||||
return ak, nil
|
||||
}
|
||||
if miniProgram.authorizerRefreshToken == "" {
|
||||
return "", fmt.Errorf("please set the authorizer_refresh_token first")
|
||||
}
|
||||
akRes, akResErr := miniProgram.GetComponent().RefreshAuthrToken(miniProgram.AppID, miniProgram.authorizerRefreshToken)
|
||||
if akResErr != nil {
|
||||
return "", akResErr
|
||||
}
|
||||
return akRes.AccessToken, nil
|
||||
}
|
||||
|
||||
// SetAuthorizerRefreshToken 设置代执操作业务授权账号authorizer_refresh_token
|
||||
func (miniProgram *MiniProgram) SetAuthorizerRefreshToken(authorizerRefreshToken string) *MiniProgram {
|
||||
miniProgram.authorizerRefreshToken = authorizerRefreshToken
|
||||
return miniProgram
|
||||
}
|
||||
|
||||
// NewMiniProgram 实例化
|
||||
func NewMiniProgram(opCtx *openContext.Context, appID string) *MiniProgram {
|
||||
return &MiniProgram{
|
||||
openContext: opCtx,
|
||||
AppID: appID,
|
||||
}
|
||||
miniProgram := miniprogram.NewMiniProgram(&miniConfig.Config{
|
||||
AppID: opCtx.AppID,
|
||||
Cache: opCtx.Cache,
|
||||
})
|
||||
// 设置获取access_token的函数
|
||||
miniProgram.SetAccessTokenHandle(NewDefaultAuthrAccessToken(opCtx, appID))
|
||||
return &MiniProgram{AppID: appID, MiniProgram: miniProgram, openContext: opCtx}
|
||||
}
|
||||
|
||||
// GetComponent get component
|
||||
@@ -30,3 +64,29 @@ func (miniProgram *MiniProgram) GetComponent() *component.Component {
|
||||
func (miniProgram *MiniProgram) GetBasic() *basic.Basic {
|
||||
return basic.NewBasic(miniProgram.openContext, miniProgram.AppID)
|
||||
}
|
||||
|
||||
// GetURLLink 小程序URL Link接口 调用前需确认已调用 SetAuthorizerRefreshToken 避免由于缓存中 authorizer_access_token 过期执行中断
|
||||
func (miniProgram *MiniProgram) GetURLLink() *urllink.URLLink {
|
||||
return urllink.NewURLLink(&miniContext.Context{
|
||||
AccessTokenHandle: miniProgram,
|
||||
})
|
||||
}
|
||||
|
||||
// DefaultAuthrAccessToken 默认获取授权ak的方法
|
||||
type DefaultAuthrAccessToken struct {
|
||||
opCtx *openContext.Context
|
||||
appID string
|
||||
}
|
||||
|
||||
// NewDefaultAuthrAccessToken 设置access_token
|
||||
func NewDefaultAuthrAccessToken(opCtx *openContext.Context, appID string) credential.AccessTokenHandle {
|
||||
return &DefaultAuthrAccessToken{
|
||||
opCtx: opCtx,
|
||||
appID: appID,
|
||||
}
|
||||
}
|
||||
|
||||
// GetAccessToken 获取ak
|
||||
func (ak *DefaultAuthrAccessToken) GetAccessToken() (string, error) {
|
||||
return ak.opCtx.GetAuthrAccessToken(ak.appID)
|
||||
}
|
||||
|
||||
@@ -18,9 +18,6 @@ type OpenPlatform struct {
|
||||
|
||||
// NewOpenPlatform new openplatform
|
||||
func NewOpenPlatform(cfg *config.Config) *OpenPlatform {
|
||||
if cfg.Cache == nil {
|
||||
panic("cache 未设置")
|
||||
}
|
||||
ctx := &context.Context{
|
||||
Config: cfg,
|
||||
}
|
||||
|
||||
@@ -48,7 +48,6 @@ type RefundedResp struct {
|
||||
|
||||
// DecryptReqInfo 对退款结果进行解密
|
||||
func (notify *Notify) DecryptReqInfo(result *RefundedResult) (*RefundedReqInfo, error) {
|
||||
var err error
|
||||
if result == nil || result.ReqInfo == nil {
|
||||
return nil, errors.New("empty refunded_result or req_info")
|
||||
}
|
||||
|
||||
@@ -172,7 +172,7 @@ func (o *Order) BridgeConfig(p *Params) (cfg Config, err error) {
|
||||
// BridgeAppConfig get app bridge config
|
||||
func (o *Order) BridgeAppConfig(p *Params) (cfg ConfigForApp, err error) {
|
||||
var (
|
||||
timestamp = strconv.FormatInt(time.Now().Unix(), 10)
|
||||
timestamp = strconv.FormatInt(util.GetCurrTS(), 10)
|
||||
noncestr = util.RandomStr(32)
|
||||
_package = "Sign=WXPay"
|
||||
)
|
||||
@@ -273,7 +273,7 @@ func (o *Order) PrePayOrder(p *Params) (payOrder PreOrder, err error) {
|
||||
return
|
||||
}
|
||||
|
||||
// PrePayID will request wechat merchant api and request for a pre payment order id
|
||||
// PrePayID will request wechat merchant api and request for a pre-payment order id
|
||||
func (o *Order) PrePayID(p *Params) (prePayID string, err error) {
|
||||
order, err := o.PrePayOrder(p)
|
||||
if err != nil {
|
||||
|
||||
10
pay/pay.go
10
pay/pay.go
@@ -4,6 +4,7 @@ import (
|
||||
"github.com/silenceper/wechat/v2/pay/config"
|
||||
"github.com/silenceper/wechat/v2/pay/notify"
|
||||
"github.com/silenceper/wechat/v2/pay/order"
|
||||
"github.com/silenceper/wechat/v2/pay/redpacket"
|
||||
"github.com/silenceper/wechat/v2/pay/refund"
|
||||
"github.com/silenceper/wechat/v2/pay/transfer"
|
||||
)
|
||||
@@ -23,12 +24,12 @@ func (pay *Pay) GetOrder() *order.Order {
|
||||
return order.NewOrder(pay.cfg)
|
||||
}
|
||||
|
||||
// GetNotify 通知
|
||||
// GetNotify 通知
|
||||
func (pay *Pay) GetNotify() *notify.Notify {
|
||||
return notify.NewNotify(pay.cfg)
|
||||
}
|
||||
|
||||
// GetRefund 退款
|
||||
// GetRefund 退款
|
||||
func (pay *Pay) GetRefund() *refund.Refund {
|
||||
return refund.NewRefund(pay.cfg)
|
||||
}
|
||||
@@ -37,3 +38,8 @@ func (pay *Pay) GetRefund() *refund.Refund {
|
||||
func (pay *Pay) GetTransfer() *transfer.Transfer {
|
||||
return transfer.NewTransfer(pay.cfg)
|
||||
}
|
||||
|
||||
// GetRedpacket 红包
|
||||
func (pay *Pay) GetRedpacket() *redpacket.Redpacket {
|
||||
return redpacket.NewRedpacket(pay.cfg)
|
||||
}
|
||||
|
||||
131
pay/redpacket/redpacket.go
Normal file
131
pay/redpacket/redpacket.go
Normal file
@@ -0,0 +1,131 @@
|
||||
package redpacket
|
||||
|
||||
import (
|
||||
"encoding/xml"
|
||||
"fmt"
|
||||
"strconv"
|
||||
|
||||
"github.com/silenceper/wechat/v2/pay/config"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
// redpacketGateway 发放红包接口
|
||||
// https://pay.weixin.qq.com/wiki/doc/api/tools/cash_coupon.php?chapter=13_4&index=3
|
||||
var redpacketGateway = "https://api.mch.weixin.qq.com/mmpaymkttransfers/sendredpack"
|
||||
|
||||
// Redpacket struct extends context
|
||||
type Redpacket struct {
|
||||
*config.Config
|
||||
}
|
||||
|
||||
// NewRedpacket return an instance of Redpacket package
|
||||
func NewRedpacket(cfg *config.Config) *Redpacket {
|
||||
return &Redpacket{cfg}
|
||||
}
|
||||
|
||||
// Params 调用参数
|
||||
type Params struct {
|
||||
MchBillno string // 商户订单号
|
||||
SendName string // 商户名称
|
||||
ReOpenID string
|
||||
TotalAmount int
|
||||
TotalNum int
|
||||
Wishing string
|
||||
ClientIP string
|
||||
ActName string
|
||||
Remark string
|
||||
|
||||
RootCa string // ca证书
|
||||
}
|
||||
|
||||
// request 接口请求参数
|
||||
type request struct {
|
||||
NonceStr string `xml:"nonce_str"`
|
||||
Sign string `xml:"sign"`
|
||||
MchID string `xml:"mch_id"`
|
||||
MchBillno string `xml:"mch_billno"`
|
||||
Wxappid string `xml:"wxappid"`
|
||||
SendName string `xml:"send_name"`
|
||||
ReOpenID string `xml:"re_openid"`
|
||||
TotalAmount int `xml:"total_amount"`
|
||||
TotalNum int `xml:"total_num"`
|
||||
Wishing string `xml:"wishing"`
|
||||
ClientIP string `xml:"client_ip"`
|
||||
ActName string `xml:"act_name"`
|
||||
Remark string `xml:"remark"`
|
||||
}
|
||||
|
||||
// Response 接口返回
|
||||
type Response struct {
|
||||
ReturnCode string `xml:"return_code"`
|
||||
ReturnMsg string `xml:"return_msg"`
|
||||
ResultCode string `xml:"result_code,omitempty"`
|
||||
ErrCode string `xml:"err_code,omitempty"`
|
||||
ErrCodeDes string `xml:"err_code_des,omitempty"`
|
||||
MchBillno string `xml:"mch_billno,omitempty"`
|
||||
MchID string `xml:"mch_id,omitempty"`
|
||||
Wxappid string `xml:"wxappid"`
|
||||
ReOpenID string `xml:"re_openid"`
|
||||
TotalAmount int `xml:"total_amount"`
|
||||
SendListid string `xml:"send_listid"`
|
||||
}
|
||||
|
||||
// SendRedpacket 发放红包
|
||||
func (redpacket *Redpacket) SendRedpacket(p *Params) (rsp *Response, err error) {
|
||||
nonceStr := util.RandomStr(32)
|
||||
param := make(map[string]string)
|
||||
|
||||
param["nonce_str"] = nonceStr
|
||||
param["mch_id"] = redpacket.MchID
|
||||
param["wxappid"] = redpacket.AppID
|
||||
param["mch_billno"] = p.MchBillno
|
||||
param["send_name"] = p.SendName
|
||||
param["re_openid"] = p.ReOpenID
|
||||
param["total_amount"] = strconv.Itoa(p.TotalAmount)
|
||||
param["total_num"] = strconv.Itoa(p.TotalNum)
|
||||
param["wishing"] = p.Wishing
|
||||
param["client_ip"] = p.ClientIP
|
||||
param["act_name"] = p.ActName
|
||||
param["remark"] = p.Remark
|
||||
//param["scene_id"] = "PRODUCT_2"
|
||||
|
||||
sign, err := util.ParamSign(param, redpacket.Key)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
req := request{
|
||||
NonceStr: nonceStr,
|
||||
Sign: sign,
|
||||
MchID: redpacket.MchID,
|
||||
Wxappid: redpacket.AppID,
|
||||
MchBillno: p.MchBillno,
|
||||
SendName: p.SendName,
|
||||
ReOpenID: p.ReOpenID,
|
||||
TotalAmount: p.TotalAmount,
|
||||
TotalNum: p.TotalNum,
|
||||
Wishing: p.Wishing,
|
||||
ClientIP: p.ClientIP,
|
||||
ActName: p.ActName,
|
||||
Remark: p.Remark,
|
||||
}
|
||||
|
||||
rawRet, err := util.PostXMLWithTLS(redpacketGateway, req, p.RootCa, redpacket.MchID)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
err = xml.Unmarshal(rawRet, &rsp)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
if rsp.ReturnCode == "SUCCESS" {
|
||||
if rsp.ResultCode == "SUCCESS" {
|
||||
err = nil
|
||||
return
|
||||
}
|
||||
err = fmt.Errorf("send redpacket error, errcode=%s,errmsg=%s", rsp.ErrCode, rsp.ErrCodeDes)
|
||||
return
|
||||
}
|
||||
err = fmt.Errorf("[msg : xmlUnmarshalError] [rawReturn : %s] [sign : %s]", string(rawRet), sign)
|
||||
return
|
||||
}
|
||||
@@ -9,7 +9,7 @@ import (
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
// 付款到零钱
|
||||
// walletTransferGateway 付款到零钱
|
||||
// https://pay.weixin.qq.com/wiki/doc/api/tools/mch_pay.php?chapter=14_2
|
||||
var walletTransferGateway = "https://api.mch.weixin.qq.com/mmpaymkttransfers/promotion/transfers"
|
||||
|
||||
@@ -20,8 +20,7 @@ type Transfer struct {
|
||||
|
||||
// NewTransfer return an instance of Transfer package
|
||||
func NewTransfer(cfg *config.Config) *Transfer {
|
||||
transfer := Transfer{cfg}
|
||||
return &transfer
|
||||
return &Transfer{cfg}
|
||||
}
|
||||
|
||||
// Params 调用参数
|
||||
|
||||
@@ -6,21 +6,36 @@ import (
|
||||
"reflect"
|
||||
)
|
||||
|
||||
// CommonError 微信返回的通用错误json
|
||||
// CommonError 微信返回的通用错误 json
|
||||
type CommonError struct {
|
||||
apiName string
|
||||
ErrCode int64 `json:"errcode"`
|
||||
ErrMsg string `json:"errmsg"`
|
||||
}
|
||||
|
||||
// DecodeWithCommonError 将返回值按照CommonError解析
|
||||
func (c *CommonError) Error() string {
|
||||
return fmt.Sprintf("%s Error , errcode=%d , errmsg=%s", c.apiName, c.ErrCode, c.ErrMsg)
|
||||
}
|
||||
|
||||
// NewCommonError 新建 CommonError 错误,对于无 errcode 和 errmsg 的返回也可以返回该通用错误
|
||||
func NewCommonError(apiName string, code int64, msg string) *CommonError {
|
||||
return &CommonError{
|
||||
apiName: apiName,
|
||||
ErrCode: code,
|
||||
ErrMsg: msg,
|
||||
}
|
||||
}
|
||||
|
||||
// DecodeWithCommonError 将返回值按照 CommonError 解析
|
||||
func DecodeWithCommonError(response []byte, apiName string) (err error) {
|
||||
var commError CommonError
|
||||
err = json.Unmarshal(response, &commError)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
commError.apiName = apiName
|
||||
if commError.ErrCode != 0 {
|
||||
return fmt.Errorf("%s Error , errcode=%d , errmsg=%s", apiName, commError.ErrCode, commError.ErrMsg)
|
||||
return &commError
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -45,7 +60,11 @@ func DecodeWithError(response []byte, obj interface{}, apiName string) error {
|
||||
return fmt.Errorf("errcode or errmsg is invalid")
|
||||
}
|
||||
if errCode.Int() != 0 {
|
||||
return fmt.Errorf("%s Error , errcode=%d , errmsg=%s", apiName, errCode.Int(), errMsg.String())
|
||||
return &CommonError{
|
||||
apiName: apiName,
|
||||
ErrCode: errCode.Int(),
|
||||
ErrMsg: errMsg.String(),
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
55
util/error_test.go
Normal file
55
util/error_test.go
Normal file
@@ -0,0 +1,55 @@
|
||||
package util
|
||||
|
||||
import "testing"
|
||||
|
||||
var okErrData string = `{"errcode": 0}`
|
||||
var errData string = `{"errcode": 43101, "errmsg": "user refuse to accept the msg"}`
|
||||
var expectError string = "Send Error , errcode=43101 , errmsg=user refuse to accept the msg"
|
||||
|
||||
func TestDecodeWithCommonErrorNoError(t *testing.T) {
|
||||
err := DecodeWithCommonError([]byte(okErrData), "Send")
|
||||
if err != nil {
|
||||
t.Error("DecodeWithCommonError should not return error")
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
func TestDecodeWithCommonError(t *testing.T) {
|
||||
err := DecodeWithCommonError([]byte(errData), "Send")
|
||||
if err == nil {
|
||||
t.Error("DecodeWithCommonError should return error")
|
||||
return
|
||||
}
|
||||
|
||||
cErr, ok := err.(*CommonError)
|
||||
if !ok {
|
||||
t.Errorf("DecodeWithCommonError should return *CommonError but %T", err)
|
||||
return
|
||||
}
|
||||
if !(cErr.ErrCode == 43101 && cErr.ErrMsg == "user refuse to accept the msg" && cErr.Error() == expectError) {
|
||||
t.Error("DecodeWithCommonError return bad *CommonError")
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
func TestDecodeWithError(t *testing.T) {
|
||||
type DE struct {
|
||||
CommonError
|
||||
}
|
||||
var obj DE
|
||||
err := DecodeWithError([]byte(errData), &obj, "Send")
|
||||
if err == nil {
|
||||
t.Error("DecodeWithError should return error")
|
||||
return
|
||||
}
|
||||
|
||||
cErr, ok := err.(*CommonError)
|
||||
if !ok {
|
||||
t.Errorf("DecodeWithError should return *CommonError but %T", err)
|
||||
return
|
||||
}
|
||||
if !(cErr.ErrCode == 43101 && cErr.ErrMsg == "user refuse to accept the msg" && cErr.Error() == expectError) {
|
||||
t.Error("DecodeWithError return bad *CommonError")
|
||||
return
|
||||
}
|
||||
}
|
||||
106
util/http.go
106
util/http.go
@@ -9,7 +9,6 @@ import (
|
||||
"encoding/xml"
|
||||
"fmt"
|
||||
"io"
|
||||
"io/ioutil"
|
||||
"log"
|
||||
"mime/multipart"
|
||||
"net/http"
|
||||
@@ -18,6 +17,19 @@ import (
|
||||
"golang.org/x/crypto/pkcs12"
|
||||
)
|
||||
|
||||
// URIModifier URI修改器
|
||||
type URIModifier func(uri string) string
|
||||
|
||||
var uriModifier URIModifier
|
||||
|
||||
// DefaultHTTPClient 默认httpClient
|
||||
var DefaultHTTPClient = http.DefaultClient
|
||||
|
||||
// SetURIModifier 设置URI修改器
|
||||
func SetURIModifier(fn URIModifier) {
|
||||
uriModifier = fn
|
||||
}
|
||||
|
||||
// HTTPGet get 请求
|
||||
func HTTPGet(uri string) ([]byte, error) {
|
||||
return HTTPGetContext(context.Background(), uri)
|
||||
@@ -25,11 +37,14 @@ func HTTPGet(uri string) ([]byte, error) {
|
||||
|
||||
// HTTPGetContext get 请求
|
||||
func HTTPGetContext(ctx context.Context, uri string) ([]byte, error) {
|
||||
if uriModifier != nil {
|
||||
uri = uriModifier(uri)
|
||||
}
|
||||
request, err := http.NewRequestWithContext(ctx, http.MethodGet, uri, nil)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
response, err := http.DefaultClient.Do(request)
|
||||
response, err := DefaultHTTPClient.Do(request)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -38,35 +53,46 @@ func HTTPGetContext(ctx context.Context, uri string) ([]byte, error) {
|
||||
if response.StatusCode != http.StatusOK {
|
||||
return nil, fmt.Errorf("http get error : uri=%v , statusCode=%v", uri, response.StatusCode)
|
||||
}
|
||||
return ioutil.ReadAll(response.Body)
|
||||
return io.ReadAll(response.Body)
|
||||
}
|
||||
|
||||
// HTTPPost post 请求
|
||||
func HTTPPost(uri string, data string) ([]byte, error) {
|
||||
return HTTPPostContext(context.Background(), uri, data)
|
||||
return HTTPPostContext(context.Background(), uri, []byte(data), nil)
|
||||
}
|
||||
|
||||
// HTTPPostContext post 请求
|
||||
func HTTPPostContext(ctx context.Context, uri string, data string) ([]byte, error) {
|
||||
body := bytes.NewBuffer([]byte(data))
|
||||
func HTTPPostContext(ctx context.Context, uri string, data []byte, header map[string]string) ([]byte, error) {
|
||||
if uriModifier != nil {
|
||||
uri = uriModifier(uri)
|
||||
}
|
||||
body := bytes.NewBuffer(data)
|
||||
request, err := http.NewRequestWithContext(ctx, http.MethodPost, uri, body)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
response, err := http.DefaultClient.Do(request)
|
||||
|
||||
for key, value := range header {
|
||||
request.Header.Set(key, value)
|
||||
}
|
||||
|
||||
response, err := DefaultHTTPClient.Do(request)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
defer response.Body.Close()
|
||||
if response.StatusCode != http.StatusOK {
|
||||
return nil, fmt.Errorf("http get error : uri=%v , statusCode=%v", uri, response.StatusCode)
|
||||
return nil, fmt.Errorf("http post error : uri=%v , statusCode=%v", uri, response.StatusCode)
|
||||
}
|
||||
return ioutil.ReadAll(response.Body)
|
||||
return io.ReadAll(response.Body)
|
||||
}
|
||||
|
||||
// PostJSON post json 数据请求
|
||||
func PostJSON(uri string, obj interface{}) ([]byte, error) {
|
||||
// PostJSONContext post json 数据请求
|
||||
func PostJSONContext(ctx context.Context, uri string, obj interface{}) ([]byte, error) {
|
||||
if uriModifier != nil {
|
||||
uri = uriModifier(uri)
|
||||
}
|
||||
jsonBuf := new(bytes.Buffer)
|
||||
enc := json.NewEncoder(jsonBuf)
|
||||
enc.SetEscapeHTML(false)
|
||||
@@ -74,7 +100,12 @@ func PostJSON(uri string, obj interface{}) ([]byte, error) {
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
response, err := http.Post(uri, "application/json;charset=utf-8", jsonBuf)
|
||||
req, err := http.NewRequestWithContext(ctx, "POST", uri, jsonBuf)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
req.Header.Set("Content-Type", "application/json;charset=utf-8")
|
||||
response, err := DefaultHTTPClient.Do(req)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -83,10 +114,15 @@ func PostJSON(uri string, obj interface{}) ([]byte, error) {
|
||||
if response.StatusCode != http.StatusOK {
|
||||
return nil, fmt.Errorf("http get error : uri=%v , statusCode=%v", uri, response.StatusCode)
|
||||
}
|
||||
return ioutil.ReadAll(response.Body)
|
||||
return io.ReadAll(response.Body)
|
||||
}
|
||||
|
||||
// PostJSONWithRespContentType post json数据请求,且返回数据类型
|
||||
// PostJSON post json 数据请求
|
||||
func PostJSON(uri string, obj interface{}) ([]byte, error) {
|
||||
return PostJSONContext(context.Background(), uri, obj)
|
||||
}
|
||||
|
||||
// PostJSONWithRespContentType post json 数据请求,且返回数据类型
|
||||
func PostJSONWithRespContentType(uri string, obj interface{}) ([]byte, string, error) {
|
||||
jsonBuf := new(bytes.Buffer)
|
||||
enc := json.NewEncoder(jsonBuf)
|
||||
@@ -96,7 +132,7 @@ func PostJSONWithRespContentType(uri string, obj interface{}) ([]byte, string, e
|
||||
return nil, "", err
|
||||
}
|
||||
|
||||
response, err := http.Post(uri, "application/json;charset=utf-8", jsonBuf)
|
||||
response, err := DefaultHTTPClient.Post(uri, "application/json;charset=utf-8", jsonBuf)
|
||||
if err != nil {
|
||||
return nil, "", err
|
||||
}
|
||||
@@ -105,17 +141,17 @@ func PostJSONWithRespContentType(uri string, obj interface{}) ([]byte, string, e
|
||||
if response.StatusCode != http.StatusOK {
|
||||
return nil, "", fmt.Errorf("http get error : uri=%v , statusCode=%v", uri, response.StatusCode)
|
||||
}
|
||||
responseData, err := ioutil.ReadAll(response.Body)
|
||||
responseData, err := io.ReadAll(response.Body)
|
||||
contentType := response.Header.Get("Content-Type")
|
||||
return responseData, contentType, err
|
||||
}
|
||||
|
||||
// PostFile 上传文件
|
||||
func PostFile(fieldname, filename, uri string) ([]byte, error) {
|
||||
func PostFile(fieldName, filename, uri string) ([]byte, error) {
|
||||
fields := []MultipartFormField{
|
||||
{
|
||||
IsFile: true,
|
||||
Fieldname: fieldname,
|
||||
Fieldname: fieldName,
|
||||
Filename: filename,
|
||||
},
|
||||
}
|
||||
@@ -132,6 +168,9 @@ type MultipartFormField struct {
|
||||
|
||||
// PostMultipartForm 上传文件或其他多个字段
|
||||
func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte, err error) {
|
||||
if uriModifier != nil {
|
||||
uri = uriModifier(uri)
|
||||
}
|
||||
bodyBuf := &bytes.Buffer{}
|
||||
bodyWriter := multipart.NewWriter(bodyBuf)
|
||||
|
||||
@@ -169,7 +208,7 @@ func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte
|
||||
contentType := bodyWriter.FormDataContentType()
|
||||
bodyWriter.Close()
|
||||
|
||||
resp, e := http.Post(uri, contentType, bodyBuf)
|
||||
resp, e := DefaultHTTPClient.Post(uri, contentType, bodyBuf)
|
||||
if e != nil {
|
||||
err = e
|
||||
return
|
||||
@@ -178,19 +217,22 @@ func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return nil, err
|
||||
}
|
||||
respBody, err = ioutil.ReadAll(resp.Body)
|
||||
respBody, err = io.ReadAll(resp.Body)
|
||||
return
|
||||
}
|
||||
|
||||
// PostXML perform a HTTP/POST request with XML body
|
||||
func PostXML(uri string, obj interface{}) ([]byte, error) {
|
||||
if uriModifier != nil {
|
||||
uri = uriModifier(uri)
|
||||
}
|
||||
xmlData, err := xml.Marshal(obj)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
body := bytes.NewBuffer(xmlData)
|
||||
response, err := http.Post(uri, "application/xml;charset=utf-8", body)
|
||||
response, err := DefaultHTTPClient.Post(uri, "application/xml;charset=utf-8", body)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -199,13 +241,13 @@ func PostXML(uri string, obj interface{}) ([]byte, error) {
|
||||
if response.StatusCode != http.StatusOK {
|
||||
return nil, fmt.Errorf("http code error : uri=%v , statusCode=%v", uri, response.StatusCode)
|
||||
}
|
||||
return ioutil.ReadAll(response.Body)
|
||||
return io.ReadAll(response.Body)
|
||||
}
|
||||
|
||||
// httpWithTLS CA证书
|
||||
// httpWithTLS CA 证书
|
||||
func httpWithTLS(rootCa, key string) (*http.Client, error) {
|
||||
var client *http.Client
|
||||
certData, err := ioutil.ReadFile(rootCa)
|
||||
certData, err := os.ReadFile(rootCa)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("unable to find cert path=%s, error=%v", rootCa, err)
|
||||
}
|
||||
@@ -213,15 +255,14 @@ func httpWithTLS(rootCa, key string) (*http.Client, error) {
|
||||
config := &tls.Config{
|
||||
Certificates: []tls.Certificate{cert},
|
||||
}
|
||||
tr := &http.Transport{
|
||||
TLSClientConfig: config,
|
||||
DisableCompression: true,
|
||||
}
|
||||
client = &http.Client{Transport: tr}
|
||||
trans := (DefaultHTTPClient.Transport.(*http.Transport)).Clone()
|
||||
trans.TLSClientConfig = config
|
||||
trans.DisableCompression = true
|
||||
client = &http.Client{Transport: trans}
|
||||
return client, nil
|
||||
}
|
||||
|
||||
// pkcs12ToPem 将Pkcs12转成Pem
|
||||
// pkcs12ToPem 将 Pkcs12 转成 Pem
|
||||
func pkcs12ToPem(p12 []byte, password string) tls.Certificate {
|
||||
blocks, err := pkcs12.ToPEM(p12, password)
|
||||
defer func() {
|
||||
@@ -245,6 +286,9 @@ func pkcs12ToPem(p12 []byte, password string) tls.Certificate {
|
||||
|
||||
// PostXMLWithTLS perform a HTTP/POST request with XML body and TLS
|
||||
func PostXMLWithTLS(uri string, obj interface{}, ca, key string) ([]byte, error) {
|
||||
if uriModifier != nil {
|
||||
uri = uriModifier(uri)
|
||||
}
|
||||
xmlData, err := xml.Marshal(obj)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
@@ -264,5 +308,5 @@ func PostXMLWithTLS(uri string, obj interface{}, ca, key string) ([]byte, error)
|
||||
if response.StatusCode != http.StatusOK {
|
||||
return nil, fmt.Errorf("http code error : uri=%v , statusCode=%v", uri, response.StatusCode)
|
||||
}
|
||||
return ioutil.ReadAll(response.Body)
|
||||
return io.ReadAll(response.Body)
|
||||
}
|
||||
|
||||
24
util/query.go
Normal file
24
util/query.go
Normal file
@@ -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, "&")
|
||||
}
|
||||
19
util/query_test.go
Normal file
19
util/query_test.go
Normal file
@@ -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")
|
||||
}
|
||||
}
|
||||
24
util/template.go
Normal file
24
util/template.go
Normal file
@@ -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
|
||||
}
|
||||
20
util/template_test.go
Normal file
20
util/template_test.go
Normal file
@@ -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")
|
||||
}
|
||||
}
|
||||
19
wechat.go
19
wechat.go
@@ -1,6 +1,7 @@
|
||||
package wechat
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"os"
|
||||
|
||||
log "github.com/sirupsen/logrus"
|
||||
@@ -14,6 +15,7 @@ import (
|
||||
openConfig "github.com/silenceper/wechat/v2/openplatform/config"
|
||||
"github.com/silenceper/wechat/v2/pay"
|
||||
payConfig "github.com/silenceper/wechat/v2/pay/config"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
"github.com/silenceper/wechat/v2/work"
|
||||
workConfig "github.com/silenceper/wechat/v2/work/config"
|
||||
)
|
||||
@@ -40,9 +42,9 @@ func NewWechat() *Wechat {
|
||||
return &Wechat{}
|
||||
}
|
||||
|
||||
// SetCache 设置cache
|
||||
func (wc *Wechat) SetCache(cahce cache.Cache) {
|
||||
wc.cache = cahce
|
||||
// SetCache 设置 cache
|
||||
func (wc *Wechat) SetCache(cache cache.Cache) {
|
||||
wc.cache = cache
|
||||
}
|
||||
|
||||
// GetOfficialAccount 获取微信公众号实例
|
||||
@@ -68,10 +70,21 @@ func (wc *Wechat) GetPay(cfg *payConfig.Config) *pay.Pay {
|
||||
|
||||
// GetOpenPlatform 获取微信开放平台的实例
|
||||
func (wc *Wechat) GetOpenPlatform(cfg *openConfig.Config) *openplatform.OpenPlatform {
|
||||
if cfg.Cache == nil {
|
||||
cfg.Cache = wc.cache
|
||||
}
|
||||
return openplatform.NewOpenPlatform(cfg)
|
||||
}
|
||||
|
||||
// GetWork 获取企业微信的实例
|
||||
func (wc *Wechat) GetWork(cfg *workConfig.Config) *work.Work {
|
||||
if cfg.Cache == nil {
|
||||
cfg.Cache = wc.cache
|
||||
}
|
||||
return work.NewWork(cfg)
|
||||
}
|
||||
|
||||
// SetHTTPClient 设置HTTPClient
|
||||
func (wc *Wechat) SetHTTPClient(client *http.Client) {
|
||||
util.DefaultHTTPClient = client
|
||||
}
|
||||
|
||||
17
work/addresslist/client.go
Normal file
17
work/addresslist/client.go
Normal file
@@ -0,0 +1,17 @@
|
||||
package addresslist
|
||||
|
||||
import (
|
||||
"github.com/silenceper/wechat/v2/work/context"
|
||||
)
|
||||
|
||||
// Client 通讯录管理接口实例
|
||||
type Client struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewClient 初始化实例
|
||||
func NewClient(ctx *context.Context) *Client {
|
||||
return &Client{
|
||||
ctx,
|
||||
}
|
||||
}
|
||||
162
work/addresslist/department.go
Normal file
162
work/addresslist/department.go
Normal file
@@ -0,0 +1,162 @@
|
||||
package addresslist
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
// departmentCreateURL 创建部门
|
||||
departmentCreateURL = "https://qyapi.weixin.qq.com/cgi-bin/department/create?access_token=%s"
|
||||
// departmentSimpleListURL 获取子部门ID列表
|
||||
departmentSimpleListURL = "https://qyapi.weixin.qq.com/cgi-bin/department/simplelist?access_token=%s&id=%d"
|
||||
// departmentListURL 获取部门列表
|
||||
departmentListURL = "https://qyapi.weixin.qq.com/cgi-bin/department/list?access_token=%s"
|
||||
departmentListByIDURL = "https://qyapi.weixin.qq.com/cgi-bin/department/list?access_token=%s&id=%d"
|
||||
// departmentGetURL 获取单个部门详情 https://qyapi.weixin.qq.com/cgi-bin/department/get?access_token=ACCESS_TOKEN&id=ID
|
||||
departmentGetURL = "https://qyapi.weixin.qq.com/cgi-bin/department/get?access_token=%s&id=%d"
|
||||
)
|
||||
|
||||
type (
|
||||
// DepartmentCreateRequest 创建部门数据请求
|
||||
DepartmentCreateRequest struct {
|
||||
Name string `json:"name"`
|
||||
NameEn string `json:"name_en,omitempty"`
|
||||
ParentID int `json:"parentid"`
|
||||
Order int `json:"order,omitempty"`
|
||||
ID int `json:"id,omitempty"`
|
||||
}
|
||||
// DepartmentCreateResponse 创建部门数据响应
|
||||
DepartmentCreateResponse struct {
|
||||
util.CommonError
|
||||
ID int `json:"id"`
|
||||
}
|
||||
|
||||
// DepartmentSimpleListResponse 获取子部门ID列表响应
|
||||
DepartmentSimpleListResponse struct {
|
||||
util.CommonError
|
||||
DepartmentID []*DepartmentID `json:"department_id"`
|
||||
}
|
||||
// DepartmentID 子部门ID
|
||||
DepartmentID struct {
|
||||
ID int `json:"id"`
|
||||
ParentID int `json:"parentid"`
|
||||
Order int `json:"order"`
|
||||
}
|
||||
|
||||
// DepartmentListResponse 获取部门列表响应
|
||||
DepartmentListResponse struct {
|
||||
util.CommonError
|
||||
Department []*Department `json:"department"`
|
||||
}
|
||||
// Department 部门列表数据
|
||||
Department struct {
|
||||
ID int `json:"id"` // 创建的部门id
|
||||
Name string `json:"name"` // 部门名称
|
||||
NameEn string `json:"name_en"` // 英文名称
|
||||
DepartmentLeader []string `json:"department_leader"` // 部门负责人的UserID
|
||||
ParentID int `json:"parentid"` // 父部门id。根部门为1
|
||||
Order int `json:"order"` // 在父部门中的次序值。order值大的排序靠前
|
||||
}
|
||||
// DepartmentGetResponse 获取单个部门详情
|
||||
DepartmentGetResponse struct {
|
||||
util.CommonError
|
||||
Department Department `json:"department"`
|
||||
}
|
||||
)
|
||||
|
||||
// DepartmentCreate 创建部门
|
||||
// see https://developer.work.weixin.qq.com/document/path/90205
|
||||
func (r *Client) DepartmentCreate(req *DepartmentCreateRequest) (*DepartmentCreateResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(departmentCreateURL, accessToken), req); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &DepartmentCreateResponse{}
|
||||
err = util.DecodeWithError(response, result, "DepartmentCreate")
|
||||
return result, err
|
||||
}
|
||||
|
||||
// DepartmentSimpleList 获取子部门ID列表
|
||||
// see https://developer.work.weixin.qq.com/document/path/95350
|
||||
func (r *Client) DepartmentSimpleList(departmentID int) ([]*DepartmentID, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(departmentSimpleListURL, accessToken, departmentID)); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &DepartmentSimpleListResponse{}
|
||||
err = util.DecodeWithError(response, result, "DepartmentSimpleList")
|
||||
return result.DepartmentID, err
|
||||
}
|
||||
|
||||
// DepartmentList 获取部门列表
|
||||
// @desc https://developer.work.weixin.qq.com/document/path/90208
|
||||
func (r *Client) DepartmentList() ([]*Department, error) {
|
||||
return r.DepartmentListByID(0)
|
||||
}
|
||||
|
||||
// DepartmentListByID 获取部门列表
|
||||
//
|
||||
// departmentID 部门id。获取指定部门及其下的子部门(以及子部门的子部门等等,递归)
|
||||
//
|
||||
// @desc https://developer.work.weixin.qq.com/document/path/90208
|
||||
func (r *Client) DepartmentListByID(departmentID int) ([]*Department, error) {
|
||||
var formatURL string
|
||||
|
||||
// 获取accessToken
|
||||
accessToken, err := r.GetAccessToken()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if departmentID > 0 {
|
||||
formatURL = fmt.Sprintf(departmentListByIDURL, accessToken, departmentID)
|
||||
} else {
|
||||
formatURL = fmt.Sprintf(departmentListURL, accessToken)
|
||||
}
|
||||
|
||||
// 发起http请求
|
||||
response, err := util.HTTPGet(formatURL)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
// 按照结构体解析返回值
|
||||
result := &DepartmentListResponse{}
|
||||
err = util.DecodeWithError(response, result, "DepartmentList")
|
||||
// 返回数据
|
||||
return result.Department, err
|
||||
}
|
||||
|
||||
// DepartmentGet 获取单个部门详情
|
||||
// see https://developer.work.weixin.qq.com/document/path/95351
|
||||
func (r *Client) DepartmentGet(departmentID int) (*Department, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(departmentGetURL, accessToken, departmentID)); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &DepartmentGetResponse{}
|
||||
err = util.DecodeWithError(response, result, "DepartmentGet")
|
||||
return &result.Department, err
|
||||
}
|
||||
220
work/addresslist/linkedcorp.go
Normal file
220
work/addresslist/linkedcorp.go
Normal file
@@ -0,0 +1,220 @@
|
||||
package addresslist
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
// getPermListURL 获取应用的可见范围
|
||||
getPermListURL = "https://qyapi.weixin.qq.com/cgi-bin/linkedcorp/agent/get_perm_list?access_token=%s"
|
||||
// getLinkedCorpUserURL 获取互联企业成员详细信息
|
||||
getLinkedCorpUserURL = "https://qyapi.weixin.qq.com/cgi-bin/linkedcorp/user/get?access_token=%s"
|
||||
// linkedCorpSimpleListURL 获取互联企业部门成员
|
||||
linkedCorpSimpleListURL = "https://qyapi.weixin.qq.com/cgi-bin/linkedcorp/user/simplelist?access_token=%s"
|
||||
// linkedCorpUserListURL 获取互联企业部门成员详情
|
||||
linkedCorpUserListURL = "https://qyapi.weixin.qq.com/cgi-bin/linkedcorp/user/list?access_token=%s"
|
||||
// linkedCorpDepartmentListURL 获取互联企业部门列表
|
||||
linkedCorpDepartmentListURL = "https://qyapi.weixin.qq.com/cgi-bin/linkedcorp/department/list?access_token=%s"
|
||||
)
|
||||
|
||||
// GetPermListResponse 获取应用的可见范围响应
|
||||
type GetPermListResponse struct {
|
||||
util.CommonError
|
||||
UserIDs []string `json:"userids"`
|
||||
DepartmentIDs []string `json:"department_ids"`
|
||||
}
|
||||
|
||||
// GetPermList 获取应用的可见范围
|
||||
// see https://developer.work.weixin.qq.com/document/path/93172
|
||||
func (r *Client) GetPermList() (*GetPermListResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPPost(fmt.Sprintf(getPermListURL, accessToken), ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &GetPermListResponse{}
|
||||
err = util.DecodeWithError(response, result, "GetPermList")
|
||||
return result, err
|
||||
}
|
||||
|
||||
// GetLinkedCorpUserRequest 获取互联企业成员详细信息请求
|
||||
type GetLinkedCorpUserRequest struct {
|
||||
UserID string `json:"userid"`
|
||||
}
|
||||
|
||||
// GetLinkedCorpUserResponse 获取互联企业成员详细信息响应
|
||||
type GetLinkedCorpUserResponse struct {
|
||||
util.CommonError
|
||||
UserInfo LinkedCorpUserInfo `json:"user_info"`
|
||||
}
|
||||
|
||||
// LinkedCorpUserInfo 互联企业成员详细信息
|
||||
type LinkedCorpUserInfo struct {
|
||||
UserID string `json:"userid"`
|
||||
Name string `json:"name"`
|
||||
Department []string `json:"department"`
|
||||
Mobile string `json:"mobile"`
|
||||
Telephone string `json:"telephone"`
|
||||
Email string `json:"email"`
|
||||
Position string `json:"position"`
|
||||
CorpID string `json:"corpid"`
|
||||
Extattr Extattr `json:"extattr"`
|
||||
}
|
||||
|
||||
// Extattr 互联企业成员详细信息扩展属性
|
||||
type Extattr struct {
|
||||
Attrs []ExtattrItem `json:"attrs"`
|
||||
}
|
||||
|
||||
// ExtattrItem 互联企业成员详细信息扩展属性条目
|
||||
type ExtattrItem struct {
|
||||
Name string `json:"name"`
|
||||
Value string `json:"value,omitempty"`
|
||||
Type int `json:"type"`
|
||||
Text ExtattrItemText `json:"text,omitempty"`
|
||||
Web ExtattrItemWeb `json:"web,omitempty"`
|
||||
}
|
||||
|
||||
// ExtattrItemText 互联企业成员详细信息自定义属性(文本)
|
||||
type ExtattrItemText struct {
|
||||
Value string `json:"value"`
|
||||
}
|
||||
|
||||
// ExtattrItemWeb 互联企业成员详细信息自定义属性(网页)
|
||||
type ExtattrItemWeb struct {
|
||||
URL string `json:"url"`
|
||||
Title string `json:"title"`
|
||||
}
|
||||
|
||||
// GetLinkedCorpUser 获取互联企业成员详细信息
|
||||
// see https://developer.work.weixin.qq.com/document/path/93171
|
||||
func (r *Client) GetLinkedCorpUser(req *GetLinkedCorpUserRequest) (*GetLinkedCorpUserResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(getLinkedCorpUserURL, accessToken), req); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &GetLinkedCorpUserResponse{}
|
||||
err = util.DecodeWithError(response, result, "GetLinkedCorpUser")
|
||||
return result, err
|
||||
}
|
||||
|
||||
// LinkedCorpSimpleListRequest 获取互联企业部门成员请求
|
||||
type LinkedCorpSimpleListRequest struct {
|
||||
DepartmentID string `json:"department_id"`
|
||||
}
|
||||
|
||||
// LinkedCorpSimpleListResponse 获取互联企业部门成员响应
|
||||
type LinkedCorpSimpleListResponse struct {
|
||||
util.CommonError
|
||||
Userlist []LinkedCorpUser `json:"userlist"`
|
||||
}
|
||||
|
||||
// LinkedCorpUser 企业部门成员
|
||||
type LinkedCorpUser struct {
|
||||
UserID string `json:"userid"`
|
||||
Name string `json:"name"`
|
||||
Department []string `json:"department"`
|
||||
CorpID string `json:"corpid"`
|
||||
}
|
||||
|
||||
// LinkedCorpSimpleList 获取互联企业部门成员
|
||||
// see https://developer.work.weixin.qq.com/document/path/93168
|
||||
func (r *Client) LinkedCorpSimpleList(req *LinkedCorpSimpleListRequest) (*LinkedCorpSimpleListResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(linkedCorpSimpleListURL, accessToken), req); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &LinkedCorpSimpleListResponse{}
|
||||
err = util.DecodeWithError(response, result, "LinkedCorpSimpleList")
|
||||
return result, err
|
||||
}
|
||||
|
||||
// LinkedCorpUserListRequest 获取互联企业部门成员详情请求
|
||||
type LinkedCorpUserListRequest struct {
|
||||
DepartmentID string `json:"department_id"`
|
||||
}
|
||||
|
||||
// LinkedCorpUserListResponse 获取互联企业部门成员详情响应
|
||||
type LinkedCorpUserListResponse struct {
|
||||
util.CommonError
|
||||
UserList []LinkedCorpUserInfo `json:"userlist"`
|
||||
}
|
||||
|
||||
// LinkedCorpUserList 获取互联企业部门成员详情
|
||||
// see https://developer.work.weixin.qq.com/document/path/93169
|
||||
func (r *Client) LinkedCorpUserList(req *LinkedCorpUserListRequest) (*LinkedCorpUserListResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(linkedCorpUserListURL, accessToken), req); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &LinkedCorpUserListResponse{}
|
||||
err = util.DecodeWithError(response, result, "LinkedCorpUserList")
|
||||
return result, err
|
||||
}
|
||||
|
||||
// LinkedCorpDepartmentListRequest 获取互联企业部门列表请求
|
||||
type LinkedCorpDepartmentListRequest struct {
|
||||
DepartmentID string `json:"department_id"`
|
||||
}
|
||||
|
||||
// LinkedCorpDepartmentListResponse 获取互联企业部门列表响应
|
||||
type LinkedCorpDepartmentListResponse struct {
|
||||
util.CommonError
|
||||
DepartmentList []LinkedCorpDepartment `json:"department_list"`
|
||||
}
|
||||
|
||||
// LinkedCorpDepartment 互联企业部门
|
||||
type LinkedCorpDepartment struct {
|
||||
DepartmentID string `json:"department_id"`
|
||||
DepartmentName string `json:"department_name"`
|
||||
ParentID string `json:"parentid"`
|
||||
Order int `json:"order"`
|
||||
}
|
||||
|
||||
// LinkedCorpDepartmentList 获取互联企业部门列表
|
||||
// see https://developer.work.weixin.qq.com/document/path/93170
|
||||
func (r *Client) LinkedCorpDepartmentList(req *LinkedCorpDepartmentListRequest) (*LinkedCorpDepartmentListResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(linkedCorpDepartmentListURL, accessToken), req); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &LinkedCorpDepartmentListResponse{}
|
||||
err = util.DecodeWithError(response, result, "LinkedCorpDepartmentList")
|
||||
return result, err
|
||||
}
|
||||
232
work/addresslist/tag.go
Normal file
232
work/addresslist/tag.go
Normal file
@@ -0,0 +1,232 @@
|
||||
package addresslist
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
// createTagURL 创建标签
|
||||
createTagURL = "https://qyapi.weixin.qq.com/cgi-bin/tag/create?access_token=%s"
|
||||
// updateTagURL 更新标签名字
|
||||
updateTagURL = "https://qyapi.weixin.qq.com/cgi-bin/tag/update?access_token=%s"
|
||||
// deleteTagURL 删除标签
|
||||
deleteTagURL = "https://qyapi.weixin.qq.com/cgi-bin/tag/delete?access_token=%s&tagid=%d"
|
||||
// getTagURL 获取标签成员
|
||||
getTagURL = "https://qyapi.weixin.qq.com/cgi-bin/tag/get?access_token=%s&tagid=%d"
|
||||
// addTagUsersURL 增加标签成员
|
||||
addTagUsersURL = "https://qyapi.weixin.qq.com/cgi-bin/tag/addtagusers?access_token=%s"
|
||||
// delTagUsersURL 删除标签成员
|
||||
delTagUsersURL = "https://qyapi.weixin.qq.com/cgi-bin/tag/deltagusers?access_token=%s"
|
||||
// listTagURL 获取标签列表
|
||||
listTagURL = "https://qyapi.weixin.qq.com/cgi-bin/tag/list?access_token=%s"
|
||||
)
|
||||
|
||||
type (
|
||||
// CreateTagRequest 创建标签请求
|
||||
CreateTagRequest struct {
|
||||
TagName string `json:"tagname"`
|
||||
TagID int `json:"tagid,omitempty"`
|
||||
}
|
||||
// CreateTagResponse 创建标签响应
|
||||
CreateTagResponse struct {
|
||||
util.CommonError
|
||||
TagID int `json:"tagid"`
|
||||
}
|
||||
)
|
||||
|
||||
// CreateTag 创建标签
|
||||
// see https://developer.work.weixin.qq.com/document/path/90210
|
||||
func (r *Client) CreateTag(req *CreateTagRequest) (*CreateTagResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(createTagURL, accessToken), req); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &CreateTagResponse{}
|
||||
err = util.DecodeWithError(response, result, "CreateTag")
|
||||
return result, err
|
||||
}
|
||||
|
||||
type (
|
||||
// UpdateTagRequest 更新标签名字请求
|
||||
UpdateTagRequest struct {
|
||||
TagID int `json:"tagid"`
|
||||
TagName string `json:"tagname"`
|
||||
}
|
||||
)
|
||||
|
||||
// UpdateTag 更新标签名字
|
||||
// see https://developer.work.weixin.qq.com/document/path/90211
|
||||
func (r *Client) UpdateTag(req *UpdateTagRequest) error {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(updateTagURL, accessToken), req); err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "UpdateTag")
|
||||
}
|
||||
|
||||
// DeleteTag 删除标签
|
||||
// @see https://developer.work.weixin.qq.com/document/path/90212
|
||||
func (r *Client) DeleteTag(tagID int) error {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(deleteTagURL, accessToken, tagID)); err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "DeleteTag")
|
||||
}
|
||||
|
||||
type (
|
||||
// GetTagResponse 获取标签成员响应
|
||||
GetTagResponse struct {
|
||||
util.CommonError
|
||||
TagName string `json:"tagname"`
|
||||
UserList []GetTagUserList `json:"userlist"`
|
||||
PartyList []int `json:"partylist"`
|
||||
}
|
||||
// GetTagUserList 标签中包含的成员列表
|
||||
GetTagUserList struct {
|
||||
UserID string `json:"userid"`
|
||||
Name string `json:"name"`
|
||||
}
|
||||
)
|
||||
|
||||
// GetTag 获取标签成员
|
||||
// @see https://developer.work.weixin.qq.com/document/path/90213
|
||||
func (r *Client) GetTag(tagID int) (*GetTagResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(getTagURL, accessToken, tagID)); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &GetTagResponse{}
|
||||
err = util.DecodeWithError(response, result, "GetTag")
|
||||
return result, err
|
||||
}
|
||||
|
||||
type (
|
||||
// AddTagUsersRequest 增加标签成员请求
|
||||
AddTagUsersRequest struct {
|
||||
TagID int `json:"tagid"`
|
||||
UserList []string `json:"userlist"`
|
||||
PartyList []int `json:"partylist"`
|
||||
}
|
||||
// AddTagUsersResponse 增加标签成员响应
|
||||
AddTagUsersResponse struct {
|
||||
util.CommonError
|
||||
InvalidList string `json:"invalidlist"`
|
||||
InvalidParty []int `json:"invalidparty"`
|
||||
}
|
||||
)
|
||||
|
||||
// AddTagUsers 增加标签成员
|
||||
// see https://developer.work.weixin.qq.com/document/path/90214
|
||||
func (r *Client) AddTagUsers(req *AddTagUsersRequest) (*AddTagUsersResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(addTagUsersURL, accessToken), req); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &AddTagUsersResponse{}
|
||||
err = util.DecodeWithError(response, result, "AddTagUsers")
|
||||
return result, err
|
||||
}
|
||||
|
||||
type (
|
||||
// DelTagUsersRequest 删除标签成员请求
|
||||
DelTagUsersRequest struct {
|
||||
TagID int `json:"tagid"`
|
||||
UserList []string `json:"userlist"`
|
||||
PartyList []int `json:"partylist"`
|
||||
}
|
||||
// DelTagUsersResponse 删除标签成员响应
|
||||
DelTagUsersResponse struct {
|
||||
util.CommonError
|
||||
InvalidList string `json:"invalidlist"`
|
||||
InvalidParty []int `json:"invalidparty"`
|
||||
}
|
||||
)
|
||||
|
||||
// DelTagUsers 删除标签成员
|
||||
// see https://developer.work.weixin.qq.com/document/path/90215
|
||||
func (r *Client) DelTagUsers(req *DelTagUsersRequest) (*DelTagUsersResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(delTagUsersURL, accessToken), req); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &DelTagUsersResponse{}
|
||||
err = util.DecodeWithError(response, result, "DelTagUsers")
|
||||
return result, err
|
||||
}
|
||||
|
||||
type (
|
||||
// ListTagResponse 获取标签列表响应
|
||||
ListTagResponse struct {
|
||||
util.CommonError
|
||||
TagList []Tag `json:"taglist"`
|
||||
}
|
||||
// Tag 标签
|
||||
Tag struct {
|
||||
TagID int `json:"tagid"`
|
||||
TagName string `json:"tagname"`
|
||||
}
|
||||
)
|
||||
|
||||
// ListTag 获取标签列表
|
||||
// @see https://developer.work.weixin.qq.com/document/path/90216
|
||||
func (r *Client) ListTag() (*ListTagResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(listTagURL, accessToken)); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &ListTagResponse{}
|
||||
err = util.DecodeWithError(response, result, "ListTag")
|
||||
return result, err
|
||||
}
|
||||
399
work/addresslist/user.go
Normal file
399
work/addresslist/user.go
Normal file
@@ -0,0 +1,399 @@
|
||||
package addresslist
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"strings"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
// userSimpleListURL 获取部门成员
|
||||
userSimpleListURL = "https://qyapi.weixin.qq.com/cgi-bin/user/simplelist"
|
||||
// userCreateURL 创建成员
|
||||
userCreateURL = "https://qyapi.weixin.qq.com/cgi-bin/user/create?access_token=%s"
|
||||
// userGetURL 读取成员
|
||||
userGetURL = "https://qyapi.weixin.qq.com/cgi-bin/user/get"
|
||||
// userDeleteURL 删除成员
|
||||
userDeleteURL = "https://qyapi.weixin.qq.com/cgi-bin/user/delete"
|
||||
// userListIDURL 获取成员ID列表
|
||||
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 (
|
||||
// UserSimpleListResponse 获取部门成员响应
|
||||
UserSimpleListResponse struct {
|
||||
util.CommonError
|
||||
UserList []*UserList
|
||||
}
|
||||
// UserList 部门成员
|
||||
UserList struct {
|
||||
UserID string `json:"userid"`
|
||||
Name string `json:"name"`
|
||||
Department []int `json:"department"`
|
||||
OpenUserID string `json:"open_userid"`
|
||||
}
|
||||
)
|
||||
|
||||
// UserSimpleList 获取部门成员
|
||||
// @see https://developer.work.weixin.qq.com/document/path/90200
|
||||
func (r *Client) UserSimpleList(departmentID int) ([]*UserList, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
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{}
|
||||
err = util.DecodeWithError(response, result, "UserSimpleList")
|
||||
return result.UserList, err
|
||||
}
|
||||
|
||||
type (
|
||||
// UserCreateRequest 创建成员数据请求
|
||||
UserCreateRequest struct {
|
||||
UserID string `json:"userid"`
|
||||
Name string `json:"name"`
|
||||
Alias string `json:"alias"`
|
||||
Mobile string `json:"mobile"`
|
||||
Department []int `json:"department"`
|
||||
Order []int `json:"order"`
|
||||
Position string `json:"position"`
|
||||
Gender int `json:"gender"`
|
||||
Email string `json:"email"`
|
||||
BizMail string `json:"biz_mail"`
|
||||
IsLeaderInDept []int `json:"is_leader_in_dept"`
|
||||
DirectLeader []string `json:"direct_leader"`
|
||||
Enable int `json:"enable"`
|
||||
AvatarMediaid string `json:"avatar_mediaid"`
|
||||
Telephone string `json:"telephone"`
|
||||
Address string `json:"address"`
|
||||
MainDepartment int `json:"main_department"`
|
||||
Extattr struct {
|
||||
Attrs []ExtraAttr `json:"attrs"`
|
||||
} `json:"extattr"`
|
||||
ToInvite bool `json:"to_invite"`
|
||||
ExternalPosition string `json:"external_position"`
|
||||
ExternalProfile ExternalProfile `json:"external_profile"`
|
||||
}
|
||||
// ExtraAttr 扩展属性
|
||||
ExtraAttr struct {
|
||||
Type int `json:"type"`
|
||||
Name string `json:"name"`
|
||||
Text struct {
|
||||
Value string `json:"value"`
|
||||
} `json:"text,omitempty"`
|
||||
Web struct {
|
||||
URL string `json:"url"`
|
||||
Title string `json:"title"`
|
||||
} `json:"web,omitempty"`
|
||||
}
|
||||
// ExternalProfile 成员对外信息
|
||||
ExternalProfile struct {
|
||||
ExternalCorpName string `json:"external_corp_name"`
|
||||
WechatChannels struct {
|
||||
Nickname string `json:"nickname"`
|
||||
Status int `json:"status"`
|
||||
} `json:"wechat_channels"`
|
||||
ExternalAttr []ExternalProfileAttr `json:"external_attr"`
|
||||
}
|
||||
// ExternalProfileAttr 成员对外信息属性
|
||||
ExternalProfileAttr struct {
|
||||
Type int `json:"type"`
|
||||
Name string `json:"name"`
|
||||
Text struct {
|
||||
Value string `json:"value"`
|
||||
} `json:"text,omitempty"`
|
||||
Web struct {
|
||||
URL string `json:"url"`
|
||||
Title string `json:"title"`
|
||||
} `json:"web,omitempty"`
|
||||
Miniprogram struct {
|
||||
Appid string `json:"appid"`
|
||||
Pagepath string `json:"pagepath"`
|
||||
Title string `json:"title"`
|
||||
} `json:"miniprogram,omitempty"`
|
||||
}
|
||||
// UserCreateResponse 创建成员数据响应
|
||||
UserCreateResponse struct {
|
||||
util.CommonError
|
||||
}
|
||||
)
|
||||
|
||||
// UserCreate 创建成员
|
||||
// @see https://developer.work.weixin.qq.com/document/path/90195
|
||||
func (r *Client) UserCreate(req *UserCreateRequest) (*UserCreateResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(userCreateURL, accessToken), req); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &UserCreateResponse{}
|
||||
err = util.DecodeWithError(response, result, "UserCreate")
|
||||
return result, err
|
||||
}
|
||||
|
||||
// UserGetResponse 获取部门成员响应
|
||||
type UserGetResponse struct {
|
||||
util.CommonError
|
||||
UserID string `json:"userid"` // 成员UserID。对应管理端的帐号,企业内必须唯一。不区分大小写,长度为1~64个字节;第三方应用返回的值为open_userid
|
||||
Name string `json:"name"` // 成员名称;第三方不可获取,调用时返回userid以代替name;代开发自建应用需要管理员授权才返回;对于非第三方创建的成员,第三方通讯录应用也不可获取;未返回name的情况需要通过通讯录展示组件来展示名字
|
||||
Department []int `json:"department"` // 成员所属部门id列表,仅返回该应用有查看权限的部门id;成员授权模式下,固定返回根部门id,即固定为1。对授权了“组织架构信息”权限的第三方应用,返回成员所属的全部部门id
|
||||
Order []int `json:"order"` // 部门内的排序值,默认为0。数量必须和department一致,数值越大排序越前面。值范围是[0, 2^32)。成员授权模式下不返回该字段
|
||||
Position string `json:"position"` // 职务信息;代开发自建应用需要管理员授权才返回;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段
|
||||
Mobile string `json:"mobile"` // 手机号码,代开发自建应用需要管理员授权且成员oauth2授权获取;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段
|
||||
Gender string `json:"gender"` // 性别。0表示未定义,1表示男性,2表示女性。代开发自建应用需要管理员授权且成员oauth2授权获取;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段。注:不可获取指返回值0
|
||||
Email string `json:"email"` // 邮箱,代开发自建应用需要管理员授权且成员oauth2授权获取;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段
|
||||
BizMail string `json:"biz_mail"` // 企业邮箱,代开发自建应用需要管理员授权且成员oauth2授权获取;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段
|
||||
IsLeaderInDept []int `json:"is_leader_in_dept"` // 表示在所在的部门内是否为部门负责人,数量与department一致;第三方通讯录应用或者授权了“组织架构信息-应用可获取企业的部门组织架构信息-部门负责人”权限的第三方应用可获取;对于非第三方创建的成员,第三方通讯录应用不可获取;上游企业不可获取下游企业成员该字段
|
||||
DirectLeader []string `json:"direct_leader"` // 直属上级UserID,返回在应用可见范围内的直属上级列表,最多有五个直属上级;第三方通讯录应用或者授权了“组织架构信息-应用可获取可见范围内成员组织架构信息-直属上级”权限的第三方应用可获取;对于非第三方创建的成员,第三方通讯录应用不可获取;上游企业不可获取下游企业成员该字段;代开发自建应用不可获取该字段
|
||||
Avatar string `json:"avatar"` // 头像url。 代开发自建应用需要管理员授权且成员oauth2授权获取;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段
|
||||
ThumbAvatar string `json:"thumb_avatar"` // 头像缩略图url。第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段
|
||||
Telephone string `json:"telephone"` // 座机。代开发自建应用需要管理员授权才返回;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段
|
||||
Alias string `json:"alias"` // 别名;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段
|
||||
Address string `json:"address"` // 地址。代开发自建应用需要管理员授权且成员oauth2授权获取;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段
|
||||
OpenUserid string `json:"open_userid"` // 全局唯一。对于同一个服务商,不同应用获取到企业内同一个成员的open_userid是相同的,最多64个字节。仅第三方应用可获取
|
||||
MainDepartment int `json:"main_department"` // 主部门,仅当应用对主部门有查看权限时返回。
|
||||
Extattr struct {
|
||||
Attrs []struct {
|
||||
Type int `json:"type"`
|
||||
Name string `json:"name"`
|
||||
Text struct {
|
||||
Value string `json:"value"`
|
||||
} `json:"text,omitempty"`
|
||||
Web struct {
|
||||
URL string `json:"url"`
|
||||
Title string `json:"title"`
|
||||
} `json:"web,omitempty"`
|
||||
} `json:"attrs"`
|
||||
} `json:"extattr"` // 扩展属性,代开发自建应用需要管理员授权才返回;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段
|
||||
Status int `json:"status"` // 激活状态: 1=已激活,2=已禁用,4=未激活,5=退出企业。 已激活代表已激活企业微信或已关注微信插件(原企业号)。未激活代表既未激活企业微信又未关注微信插件(原企业号)。
|
||||
QrCode string `json:"qr_code"` // 员工个人二维码,扫描可添加为外部联系人(注意返回的是一个url,可在浏览器上打开该url以展示二维码);代开发自建应用需要管理员授权且成员oauth2授权获取;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段
|
||||
ExternalPosition string `json:"external_position"` // 对外职务,如果设置了该值,则以此作为对外展示的职务,否则以position来展示。代开发自建应用需要管理员授权才返回;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段
|
||||
ExternalProfile struct {
|
||||
ExternalCorpName string `json:"external_corp_name"`
|
||||
WechatChannels struct {
|
||||
Nickname string `json:"nickname"`
|
||||
Status int `json:"status"`
|
||||
} `json:"wechat_channels"`
|
||||
ExternalAttr []struct {
|
||||
Type int `json:"type"`
|
||||
Name string `json:"name"`
|
||||
Text struct {
|
||||
Value string `json:"value"`
|
||||
} `json:"text,omitempty"`
|
||||
Web struct {
|
||||
URL string `json:"url"`
|
||||
Title string `json:"title"`
|
||||
} `json:"web,omitempty"`
|
||||
Miniprogram struct {
|
||||
Appid string `json:"appid"`
|
||||
Pagepath string `json:"pagepath"`
|
||||
Title string `json:"title"`
|
||||
} `json:"miniprogram,omitempty"`
|
||||
} `json:"external_attr"`
|
||||
} `json:"external_profile"` // 成员对外属性,字段详情见对外属性;代开发自建应用需要管理员授权才返回;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段
|
||||
}
|
||||
|
||||
// UserGet 读取成员
|
||||
// @see https://developer.work.weixin.qq.com/document/path/90196
|
||||
func (r *Client) UserGet(UserID string) (*UserGetResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
|
||||
if response, err = util.HTTPGet(
|
||||
strings.Join([]string{
|
||||
userGetURL,
|
||||
util.Query(map[string]interface{}{
|
||||
"access_token": accessToken,
|
||||
"userid": UserID,
|
||||
}),
|
||||
}, "?")); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &UserGetResponse{}
|
||||
err = util.DecodeWithError(response, result, "UserGet")
|
||||
return result, err
|
||||
}
|
||||
|
||||
type (
|
||||
// UserDeleteResponse 删除成员数据响应
|
||||
UserDeleteResponse struct {
|
||||
util.CommonError
|
||||
}
|
||||
)
|
||||
|
||||
// UserDelete 删除成员
|
||||
// @see https://developer.work.weixin.qq.com/document/path/90334
|
||||
func (r *Client) UserDelete(userID string) (*UserDeleteResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(strings.Join([]string{
|
||||
userDeleteURL,
|
||||
util.Query(map[string]interface{}{
|
||||
"access_token": accessToken,
|
||||
"userid": userID,
|
||||
}),
|
||||
}, "?")); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &UserDeleteResponse{}
|
||||
err = util.DecodeWithError(response, result, "UserDelete")
|
||||
return result, err
|
||||
}
|
||||
|
||||
// UserListIDRequest 获取成员ID列表请求
|
||||
type UserListIDRequest struct {
|
||||
Cursor string `json:"cursor"`
|
||||
Limit int `json:"limit"`
|
||||
}
|
||||
|
||||
// UserListIDResponse 获取成员ID列表响应
|
||||
type UserListIDResponse struct {
|
||||
util.CommonError
|
||||
NextCursor string `json:"next_cursor"`
|
||||
DeptUser []*DeptUser `json:"dept_user"`
|
||||
}
|
||||
|
||||
// DeptUser 用户-部门关系
|
||||
type DeptUser struct {
|
||||
UserID string `json:"userid"`
|
||||
Department int `json:"department"`
|
||||
}
|
||||
|
||||
// UserListID 获取成员ID列表
|
||||
// see https://developer.work.weixin.qq.com/document/path/96067
|
||||
func (r *Client) UserListID(req *UserListIDRequest) (*UserListIDResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
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{}
|
||||
err = util.DecodeWithError(response, result, "UserListID")
|
||||
return result, err
|
||||
}
|
||||
|
||||
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{}
|
||||
err = util.DecodeWithError(response, result, "ConvertToOpenID")
|
||||
return result.OpenID, err
|
||||
}
|
||||
|
||||
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{}
|
||||
err = util.DecodeWithError(response, result, "ConvertToUserID")
|
||||
return result.UserID, err
|
||||
}
|
||||
113
work/appchat/appchat.go
Normal file
113
work/appchat/appchat.go
Normal file
@@ -0,0 +1,113 @@
|
||||
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{}
|
||||
err = util.DecodeWithError(response, result, apiName)
|
||||
// 返回数据
|
||||
return result, err
|
||||
}
|
||||
|
||||
// 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方法,按照企业微信消息推送的接口文档传对应消息类型的参数来使用
|
||||
16
work/appchat/client.go
Normal file
16
work/appchat/client.go
Normal file
@@ -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}
|
||||
}
|
||||
387
work/checkin/checkin.go
Normal file
387
work/checkin/checkin.go
Normal file
@@ -0,0 +1,387 @@
|
||||
package checkin
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
// setScheduleListURL 为打卡人员排班
|
||||
setScheduleListURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/setcheckinschedulist?access_token=%s"
|
||||
// punchCorrectionURL 为打卡人员补卡
|
||||
punchCorrectionURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/punch_correction?access_token=%s"
|
||||
// addUserFaceURL 录入打卡人员人脸信息
|
||||
addUserFaceURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/addcheckinuserface?access_token=%s"
|
||||
// addOptionURL 创建打卡规则
|
||||
addOptionURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/add_checkin_option?access_token=%s"
|
||||
// updateOptionURL 修改打卡规则
|
||||
updateOptionURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/update_checkin_option?access_token=%s"
|
||||
// clearOptionURL 清空打卡规则数组元素
|
||||
clearOptionURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/clear_checkin_option_array_field?access_token=%s"
|
||||
// delOptionURL 删除打卡规则
|
||||
delOptionURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/del_checkin_option?access_token=%s"
|
||||
)
|
||||
|
||||
// SetScheduleListRequest 为打卡人员排班请求
|
||||
type SetScheduleListRequest struct {
|
||||
GroupID int64 `json:"groupid"`
|
||||
Items []SetScheduleListItem `json:"items"`
|
||||
YearMonth int64 `json:"yearmonth"`
|
||||
}
|
||||
|
||||
// SetScheduleListItem 排班表信息
|
||||
type SetScheduleListItem struct {
|
||||
UserID string `json:"userid"`
|
||||
Day int64 `json:"day"`
|
||||
ScheduleID int64 `json:"schedule_id"`
|
||||
}
|
||||
|
||||
// SetScheduleList 为打卡人员排班
|
||||
// see https://developer.work.weixin.qq.com/document/path/93385
|
||||
func (r *Client) SetScheduleList(req *SetScheduleListRequest) error {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(setScheduleListURL, accessToken), req); err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "SetScheduleList")
|
||||
}
|
||||
|
||||
// PunchCorrectionRequest 为打卡人员补卡请求
|
||||
type PunchCorrectionRequest struct {
|
||||
UserID string `json:"userid"`
|
||||
ScheduleDateTime int64 `json:"schedule_date_time"`
|
||||
ScheduleCheckinTime int64 `json:"schedule_checkin_time"`
|
||||
CheckinTime int64 `json:"checkin_time"`
|
||||
Remark string `json:"remark"`
|
||||
}
|
||||
|
||||
// PunchCorrection 为打卡人员补卡
|
||||
// see https://developer.work.weixin.qq.com/document/path/95803
|
||||
func (r *Client) PunchCorrection(req *PunchCorrectionRequest) error {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(punchCorrectionURL, accessToken), req); err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "PunchCorrection")
|
||||
}
|
||||
|
||||
// AddUserFaceRequest 录入打卡人员人脸信息请求
|
||||
type AddUserFaceRequest struct {
|
||||
UserID string `json:"userid"`
|
||||
UserFace string `json:"userface"`
|
||||
}
|
||||
|
||||
// AddUserFace 录入打卡人员人脸信息
|
||||
// see https://developer.work.weixin.qq.com/document/path/93378
|
||||
func (r *Client) AddUserFace(req *AddUserFaceRequest) error {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(addUserFaceURL, accessToken), req); err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "AddUserFace")
|
||||
}
|
||||
|
||||
// AddOptionRequest 创建打卡规则请求
|
||||
type AddOptionRequest struct {
|
||||
EffectiveNow bool `json:"effective_now,omitempty"`
|
||||
Group OptionGroupRule `json:"group,omitempty"`
|
||||
}
|
||||
|
||||
// OptionGroupRule 打卡规则字段
|
||||
type OptionGroupRule struct {
|
||||
GroupID int64 `json:"groupid,omitempty"`
|
||||
GroupType int64 `json:"grouptype"`
|
||||
GroupName string `json:"groupname"`
|
||||
CheckinDate []OptionGroupRuleCheckinDate `json:"checkindate,omitempty"`
|
||||
SpeWorkdays []OptionGroupSpeWorkdays `json:"spe_workdays,omitempty"`
|
||||
SpeOffDays []OptionGroupSpeOffDays `json:"spe_offdays,omitempty"`
|
||||
SyncHolidays bool `json:"sync_holidays,omitempty"`
|
||||
NeedPhoto bool `json:"need_photo,omitempty"`
|
||||
NoteCanUseLocalPic bool `json:"note_can_use_local_pic,omitempty"`
|
||||
WifiMacInfos []OptionGroupWifiMacInfos `json:"wifimac_infos,omitempty"`
|
||||
LocInfos []OptionGroupLocInfos `json:"loc_infos,omitempty"`
|
||||
AllowCheckinOffWorkday bool `json:"allow_checkin_offworkday,omitempty"`
|
||||
AllowApplyOffWorkday bool `json:"allow_apply_offworkday,omitempty"`
|
||||
Range []OptionGroupRange `json:"range"`
|
||||
WhiteUsers []string `json:"white_users,omitempty"`
|
||||
Type int64 `json:"type,omitempty"`
|
||||
ReporterInfo OptionGroupReporterInfo `json:"reporterinfo,omitempty"`
|
||||
AllowApplyBkCnt int64 `json:"allow_apply_bk_cnt,omitempty"`
|
||||
AllowApplyBkDayLimit int64 `json:"allow_apply_bk_day_limit,omitempty"`
|
||||
BukaLimitNextMonth int64 `json:"buka_limit_next_month,omitempty"`
|
||||
OptionOutRange int64 `json:"option_out_range,omitempty"`
|
||||
ScheduleList []OptionGroupScheduleList `json:"schedulelist,omitempty"`
|
||||
OffWorkIntervalTime int64 `json:"offwork_interval_time,omitempty"`
|
||||
UseFaceDetect bool `json:"use_face_detect,omitempty"`
|
||||
OpenFaceLiveDetect bool `json:"open_face_live_detect,omitempty"`
|
||||
OtInfoV2 OptionGroupOtInfoV2 `json:"ot_info_v2,omitempty"`
|
||||
SyncOutCheckin bool `json:"sync_out_checkin,omitempty"`
|
||||
BukaRemind OptionGroupBukaRemind `json:"buka_remind,omitempty"`
|
||||
BukaRestriction int64 `json:"buka_restriction,omitempty"`
|
||||
SpanDayTime int64 `json:"span_day_time,omitempty"`
|
||||
StandardWorkDuration int64 `json:"standard_work_duration,omitempty"`
|
||||
}
|
||||
|
||||
// OptionGroupRuleCheckinDate 固定时间上下班打卡时间
|
||||
type OptionGroupRuleCheckinDate struct {
|
||||
Workdays []int64 `json:"workdays"`
|
||||
CheckinTime []OptionGroupRuleCheckinTime `json:"checkintime"`
|
||||
FlexTime int64 `json:"flex_time"`
|
||||
AllowFlex bool `json:"allow_flex"`
|
||||
FlexOnDutyTime int64 `json:"flex_on_duty_time"`
|
||||
FlexOffDutyTime int64 `json:"flex_off_duty_time"`
|
||||
MaxAllowArriveEarly int64 `json:"max_allow_arrive_early"`
|
||||
MaxAllowArriveLate int64 `json:"max_allow_arrive_late"`
|
||||
LateRule OptionGroupLateRule `json:"late_rule"`
|
||||
}
|
||||
|
||||
// OptionGroupRuleCheckinTime 工作日上下班打卡时间信息
|
||||
type OptionGroupRuleCheckinTime struct {
|
||||
TimeID int64 `json:"time_id"`
|
||||
WorkSec int64 `json:"work_sec"`
|
||||
OffWorkSec int64 `json:"off_work_sec"`
|
||||
RemindWorkSec int64 `json:"remind_work_sec"`
|
||||
RemindOffWorkSec int64 `json:"remind_off_work_sec"`
|
||||
AllowRest bool `json:"allow_rest"`
|
||||
RestBeginTime int64 `json:"rest_begin_time"`
|
||||
RestEndTime int64 `json:"rest_end_time"`
|
||||
EarliestWorkSec int64 `json:"earliest_work_sec"`
|
||||
LatestWorkSec int64 `json:"latest_work_sec"`
|
||||
EarliestOffWorkSec int64 `json:"earliest_off_work_sec"`
|
||||
LatestOffWorkSec int64 `json:"latest_off_work_sec"`
|
||||
NoNeedCheckOn bool `json:"no_need_checkon"`
|
||||
NoNeedCheckOff bool `json:"no_need_checkoff"`
|
||||
}
|
||||
|
||||
// OptionGroupLateRule 晚走晚到时间规则信息
|
||||
type OptionGroupLateRule struct {
|
||||
OffWorkAfterTime int64 `json:"offwork_after_time"`
|
||||
OnWorkFlexTime int64 `json:"onwork_flex_time"`
|
||||
AllowOffWorkAfterTime int64 `json:"allow_offwork_after_time"`
|
||||
TimeRules []OptionGroupTimeRule `json:"timerules"`
|
||||
}
|
||||
|
||||
// OptionGroupTimeRule 晚走晚到时间规则
|
||||
type OptionGroupTimeRule struct {
|
||||
OffWorkAfterTime int64 `json:"offwork_after_time"`
|
||||
OnWorkFlexTime int64 `json:"onwork_flex_time"`
|
||||
}
|
||||
|
||||
// OptionGroupSpeWorkdays 特殊工作日
|
||||
type OptionGroupSpeWorkdays struct {
|
||||
Timestamp int64 `json:"timestamp"`
|
||||
Notes string `json:"notes"`
|
||||
CheckinTime []OptionGroupCheckinTime `json:"checkintime"`
|
||||
Type int64 `json:"type"`
|
||||
BegTime int64 `json:"begtime"`
|
||||
EndTime int64 `json:"endtime"`
|
||||
}
|
||||
|
||||
// OptionGroupCheckinTime 特殊工作日的上下班打卡时间配置
|
||||
type OptionGroupCheckinTime struct {
|
||||
TimeID int64 `json:"time_id"`
|
||||
WorkSec int64 `json:"work_sec"`
|
||||
OffWorkSec int64 `json:"off_work_sec"`
|
||||
RemindWorkSec int64 `json:"remind_work_sec"`
|
||||
RemindOffWorkSec int64 `json:"remind_off_work_sec"`
|
||||
}
|
||||
|
||||
// OptionGroupSpeOffDays 特殊非工作日
|
||||
type OptionGroupSpeOffDays struct {
|
||||
Timestamp int64 `json:"timestamp"`
|
||||
Notes string `json:"notes"`
|
||||
Type int64 `json:"type"`
|
||||
BegTime int64 `json:"begtime"`
|
||||
EndTime int64 `json:"endtime"`
|
||||
}
|
||||
|
||||
// OptionGroupWifiMacInfos WIFI信息
|
||||
type OptionGroupWifiMacInfos struct {
|
||||
WifiName string `json:"wifiname"`
|
||||
WifiMac string `json:"wifimac"`
|
||||
}
|
||||
|
||||
// OptionGroupLocInfos 地点信息
|
||||
type OptionGroupLocInfos struct {
|
||||
Lat int64 `json:"lat"`
|
||||
Lng int64 `json:"lng"`
|
||||
LocTitle string `json:"loc_title"`
|
||||
LocDetail string `json:"loc_detail"`
|
||||
Distance int64 `json:"distance"`
|
||||
}
|
||||
|
||||
// OptionGroupRange 人员信息
|
||||
type OptionGroupRange struct {
|
||||
PartyID []string `json:"party_id"`
|
||||
UserID []string `json:"userid"`
|
||||
TagID []int64 `json:"tagid"`
|
||||
}
|
||||
|
||||
// OptionGroupReporterInfo 汇报人
|
||||
type OptionGroupReporterInfo struct {
|
||||
Reporters []OptionGroupReporters `json:"reporters"`
|
||||
}
|
||||
|
||||
// OptionGroupReporters 汇报对象
|
||||
type OptionGroupReporters struct {
|
||||
UserID string `json:"userid"`
|
||||
TagID int64 `json:"tagid"`
|
||||
}
|
||||
|
||||
// OptionGroupScheduleList 自定义排班规则所有排班
|
||||
type OptionGroupScheduleList struct {
|
||||
ScheduleID int64 `json:"schedule_id"`
|
||||
ScheduleName string `json:"schedule_name"`
|
||||
TimeSection []OptionGroupTimeSection `json:"time_section"`
|
||||
AllowFlex bool `json:"allow_flex"`
|
||||
FlexOnDutyTime int64 `json:"flex_on_duty_time"`
|
||||
FlexOffDutyTime int64 `json:"flex_off_duty_time"`
|
||||
LateRule OptionGroupLateRule `json:"late_rule"`
|
||||
MaxAllowArriveEarly int64 `json:"max_allow_arrive_early"`
|
||||
MaxAllowArriveLate int64 `json:"max_allow_arrive_late"`
|
||||
}
|
||||
|
||||
// OptionGroupTimeSection 班次上下班时段信息
|
||||
type OptionGroupTimeSection struct {
|
||||
TimeID int64 `json:"time_id"`
|
||||
WorkSec int64 `json:"work_sec"`
|
||||
OffWorkSec int64 `json:"off_work_sec"`
|
||||
RemindWorkSec int64 `json:"remind_work_sec"`
|
||||
RemindOffWorkSec int64 `json:"remind_off_work_sec"`
|
||||
RestBeginTime int64 `json:"rest_begin_time"`
|
||||
RestEndTime int64 `json:"rest_end_time"`
|
||||
AllowRest bool `json:"allow_rest"`
|
||||
EarliestWorkSec int64 `json:"earliest_work_sec"`
|
||||
LatestWorkSec int64 `json:"latest_work_sec"`
|
||||
EarliestOffWorkSec int64 `json:"earliest_off_work_sec"`
|
||||
LatestOffWorkSec int64 `json:"latest_off_work_sec"`
|
||||
NoNeedCheckOn bool `json:"no_need_checkon"`
|
||||
NoNeedCheckOff bool `json:"no_need_checkoff"`
|
||||
}
|
||||
|
||||
// OptionGroupOtInfoV2 加班配置
|
||||
type OptionGroupOtInfoV2 struct {
|
||||
WorkdayConf OptionGroupWorkdayConf `json:"workdayconf"`
|
||||
}
|
||||
|
||||
// OptionGroupWorkdayConf 工作日加班配置
|
||||
type OptionGroupWorkdayConf struct {
|
||||
AllowOt bool `json:"allow_ot"`
|
||||
Type int64 `json:"type"`
|
||||
}
|
||||
|
||||
// OptionGroupBukaRemind 补卡提醒
|
||||
type OptionGroupBukaRemind struct {
|
||||
OpenRemind bool `json:"open_remind"`
|
||||
BukaRemindDay int64 `json:"buka_remind_day"`
|
||||
BukaRemindMonth int64 `json:"buka_remind_month"`
|
||||
}
|
||||
|
||||
// AddOption 创建打卡规则
|
||||
// see https://developer.work.weixin.qq.com/document/path/98041#%E5%88%9B%E5%BB%BA%E6%89%93%E5%8D%A1%E8%A7%84%E5%88%99
|
||||
func (r *Client) AddOption(req *AddOptionRequest) error {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(addOptionURL, accessToken), req); err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "AddOption")
|
||||
}
|
||||
|
||||
// UpdateOptionRequest 修改打卡规则请求
|
||||
type UpdateOptionRequest struct {
|
||||
EffectiveNow bool `json:"effective_now,omitempty"`
|
||||
Group OptionGroupRule `json:"group,omitempty"`
|
||||
}
|
||||
|
||||
// UpdateOption 修改打卡规则
|
||||
// see https://developer.work.weixin.qq.com/document/path/98041#%E4%BF%AE%E6%94%B9%E6%89%93%E5%8D%A1%E8%A7%84%E5%88%99
|
||||
func (r *Client) UpdateOption(req *UpdateOptionRequest) error {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(updateOptionURL, accessToken), req); err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "UpdateOption")
|
||||
}
|
||||
|
||||
// ClearOptionRequest 清空打卡规则数组元素请求
|
||||
type ClearOptionRequest struct {
|
||||
GroupID int64 `json:"groupid"`
|
||||
ClearField []int64 `json:"clear_field"`
|
||||
EffectiveNow bool `json:"effective_now"`
|
||||
}
|
||||
|
||||
// ClearOption 清空打卡规则数组元素
|
||||
// see https://developer.work.weixin.qq.com/document/path/98041#%E6%B8%85%E7%A9%BA%E6%89%93%E5%8D%A1%E8%A7%84%E5%88%99%E6%95%B0%E7%BB%84%E5%85%83%E7%B4%A0
|
||||
func (r *Client) ClearOption(req *ClearOptionRequest) error {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(clearOptionURL, accessToken), req); err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "ClearOption")
|
||||
}
|
||||
|
||||
// DelOptionRequest 删除打卡规则请求
|
||||
type DelOptionRequest struct {
|
||||
GroupID int64 `json:"groupid"`
|
||||
EffectiveNow bool `json:"effective_now"`
|
||||
}
|
||||
|
||||
// DelOption 删除打卡规则
|
||||
// see https://developer.work.weixin.qq.com/document/path/98041#%E5%88%A0%E9%99%A4%E6%89%93%E5%8D%A1%E8%A7%84%E5%88%99
|
||||
func (r *Client) DelOption(req *DelOptionRequest) error {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(delOptionURL, accessToken), req); err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "DelOption")
|
||||
}
|
||||
17
work/checkin/client.go
Normal file
17
work/checkin/client.go
Normal file
@@ -0,0 +1,17 @@
|
||||
package checkin
|
||||
|
||||
import (
|
||||
"github.com/silenceper/wechat/v2/work/context"
|
||||
)
|
||||
|
||||
// Client 打卡接口实例
|
||||
type Client struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewClient 初始化实例
|
||||
func NewClient(ctx *context.Context) *Client {
|
||||
return &Client{
|
||||
ctx,
|
||||
}
|
||||
}
|
||||
660
work/checkin/record.go
Normal file
660
work/checkin/record.go
Normal file
@@ -0,0 +1,660 @@
|
||||
package checkin
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
// getCheckinDataURL 获取打卡记录数据
|
||||
getCheckinDataURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/getcheckindata?access_token=%s"
|
||||
// getDayDataURL 获取打卡日报数据
|
||||
getDayDataURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/getcheckin_daydata?access_token=%s"
|
||||
// getMonthDataURL 获取打卡月报数据
|
||||
getMonthDataURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/getcheckin_monthdata?access_token=%s"
|
||||
// getCorpOptionURL 获取企业所有打卡规则
|
||||
getCorpOptionURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/getcorpcheckinoption?access_token=%s"
|
||||
// getOptionURL 获取员工打卡规则
|
||||
getOptionURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/getcheckinoption?access_token=%s"
|
||||
// getScheduleListURL 获取打卡人员排班信息
|
||||
getScheduleListURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/getcheckinschedulist?access_token=%s"
|
||||
// getHardwareDataURL获取设备打卡数据
|
||||
getHardwareDataURL = "https://qyapi.weixin.qq.com/cgi-bin/hardware/get_hardware_checkin_data?access_token=%s"
|
||||
)
|
||||
|
||||
type (
|
||||
// GetCheckinDataRequest 获取打卡记录数据请求
|
||||
GetCheckinDataRequest struct {
|
||||
OpenCheckinDataType int64 `json:"opencheckindatatype"`
|
||||
StartTime int64 `json:"starttime"`
|
||||
EndTime int64 `json:"endtime"`
|
||||
UserIDList []string `json:"useridlist"`
|
||||
}
|
||||
// GetCheckinDataResponse 获取打卡记录数据响应
|
||||
GetCheckinDataResponse struct {
|
||||
util.CommonError
|
||||
CheckinData []*GetCheckinDataItem `json:"checkindata"`
|
||||
}
|
||||
// GetCheckinDataItem 打卡记录数据
|
||||
GetCheckinDataItem struct {
|
||||
UserID string `json:"userid"`
|
||||
GroupName string `json:"groupname"`
|
||||
CheckinType string `json:"checkin_type"`
|
||||
ExceptionType string `json:"exception_type"`
|
||||
CheckinTime int64 `json:"checkin_time"`
|
||||
LocationTitle string `json:"location_title"`
|
||||
LocationDetail string `json:"location_detail"`
|
||||
WifiName string `json:"wifiname"`
|
||||
Notes string `json:"notes"`
|
||||
WifiMac string `json:"wifimac"`
|
||||
MediaIDs []string `json:"mediaids"`
|
||||
SchCheckinTime int64 `json:"sch_checkin_time"`
|
||||
GroupID int64 `json:"groupid"`
|
||||
ScheduleID int64 `json:"schedule_id"`
|
||||
TimelineID int64 `json:"timeline_id"`
|
||||
Lat int64 `json:"lat,omitempty"`
|
||||
Lng int64 `json:"lng,omitempty"`
|
||||
DeviceID string `json:"deviceid,omitempty"`
|
||||
}
|
||||
)
|
||||
|
||||
// GetCheckinData 获取打卡记录数据
|
||||
// @see https://developer.work.weixin.qq.com/document/path/90262
|
||||
func (r *Client) GetCheckinData(req *GetCheckinDataRequest) (*GetCheckinDataResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(getCheckinDataURL, accessToken), req); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &GetCheckinDataResponse{}
|
||||
err = util.DecodeWithError(response, result, "GetCheckinData")
|
||||
return result, err
|
||||
}
|
||||
|
||||
type (
|
||||
// GetDayDataResponse 获取打卡日报数据
|
||||
GetDayDataResponse struct {
|
||||
util.CommonError
|
||||
Datas []DayDataItem `json:"datas"`
|
||||
}
|
||||
|
||||
// DayDataItem 日报
|
||||
DayDataItem struct {
|
||||
BaseInfo DayBaseInfo `json:"base_info"`
|
||||
SummaryInfo DaySummaryInfo `json:"summary_info"`
|
||||
HolidayInfos []HolidayInfo `json:"holiday_infos"`
|
||||
ExceptionInfos []ExceptionInfo `json:"exception_infos"`
|
||||
OtInfo OtInfo `json:"ot_info"`
|
||||
SpItems []SpItem `json:"sp_items"`
|
||||
}
|
||||
|
||||
// DayBaseInfo 基础信息
|
||||
DayBaseInfo struct {
|
||||
Date int64 `json:"date"`
|
||||
RecordType int64 `json:"record_type"`
|
||||
Name string `json:"name"`
|
||||
NameEx string `json:"name_ex"`
|
||||
DepartsName string `json:"departs_name"`
|
||||
AcctID string `json:"acctid"`
|
||||
DayType int64 `json:"day_type"`
|
||||
RuleInfo DayRuleInfo `json:"rule_info"`
|
||||
}
|
||||
|
||||
// DayCheckInTime 当日打卡时间
|
||||
DayCheckInTime struct {
|
||||
WorkSec int64 `json:"work_sec"`
|
||||
OffWorkSec int64 `json:"off_work_sec"`
|
||||
}
|
||||
|
||||
// DayRuleInfo 打卡人员所属规则信息
|
||||
DayRuleInfo struct {
|
||||
GroupID int64 `json:"groupid"`
|
||||
GroupName string `json:"groupname"`
|
||||
ScheduleID int64 `json:"scheduleid"`
|
||||
ScheduleName string `json:"schedulename"`
|
||||
CheckInTimes []DayCheckInTime `json:"checkintime"`
|
||||
}
|
||||
|
||||
// DaySummaryInfo 汇总信息
|
||||
DaySummaryInfo struct {
|
||||
CheckinCount int64 `json:"checkin_count"`
|
||||
RegularWorkSec int64 `json:"regular_work_sec"`
|
||||
StandardWorkSec int64 `json:"standard_work_sec"`
|
||||
EarliestTime int64 `json:"earliest_time"`
|
||||
LastestTime int64 `json:"lastest_time"`
|
||||
}
|
||||
|
||||
// HolidayInfo 假勤相关信息
|
||||
HolidayInfo struct {
|
||||
SpNumber string `json:"sp_number"`
|
||||
SpTitle SpTitle `json:"sp_title"`
|
||||
SpDescription SpDescription `json:"sp_description"`
|
||||
}
|
||||
|
||||
// SpTitle 假勤信息摘要-标题信息
|
||||
SpTitle struct {
|
||||
Data []SpData `json:"data"`
|
||||
}
|
||||
|
||||
// SpDescription 假勤信息摘要-描述信息
|
||||
SpDescription struct {
|
||||
Data []SpData `json:"data"`
|
||||
}
|
||||
|
||||
// SpData 假勤信息(多种语言描述,目前只有中文一种)
|
||||
SpData struct {
|
||||
Lang string `json:"lang"`
|
||||
Text string `json:"text"`
|
||||
}
|
||||
|
||||
// SpItem 假勤统计信息
|
||||
SpItem struct {
|
||||
Count int64 `json:"count"`
|
||||
Duration int64 `json:"duration"`
|
||||
TimeType int64 `json:"time_type"`
|
||||
Type int64 `json:"type"`
|
||||
VacationID int64 `json:"vacation_id"`
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
// ExceptionInfo 校准状态信息
|
||||
ExceptionInfo struct {
|
||||
Count int64 `json:"count"`
|
||||
Duration int64 `json:"duration"`
|
||||
Exception int64 `json:"exception"`
|
||||
}
|
||||
|
||||
// OtInfo 加班信息
|
||||
OtInfo struct {
|
||||
OtStatus int64 `json:"ot_status"`
|
||||
OtDuration int64 `json:"ot_duration"`
|
||||
ExceptionDuration []uint64 `json:"exception_duration"`
|
||||
}
|
||||
)
|
||||
|
||||
// GetDayData 获取打卡日报数据
|
||||
// @see https://developer.work.weixin.qq.com/document/path/96498
|
||||
func (r *Client) GetDayData(req *GetCheckinDataRequest) (result *GetDayDataResponse, err error) {
|
||||
var (
|
||||
response []byte
|
||||
accessToken string
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return
|
||||
}
|
||||
if response, err = util.PostJSON(fmt.Sprintf(getDayDataURL, accessToken), req); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
result = new(GetDayDataResponse)
|
||||
err = util.DecodeWithError(response, result, "GetDayData")
|
||||
return
|
||||
}
|
||||
|
||||
type (
|
||||
// GetMonthDataResponse 获取打卡月报数据
|
||||
GetMonthDataResponse struct {
|
||||
util.CommonError
|
||||
Datas []MonthDataItem `json:"datas"`
|
||||
}
|
||||
|
||||
// MonthDataItem 月报数据
|
||||
MonthDataItem struct {
|
||||
BaseInfo MonthBaseInfo `json:"base_info"`
|
||||
SummaryInfo MonthSummaryInfo `json:"summary_info"`
|
||||
ExceptionInfos []ExceptionInfo `json:"exception_infos"`
|
||||
SpItems []SpItem `json:"sp_items"`
|
||||
OverWorkInfo OverWorkInfo `json:"overwork_info"`
|
||||
}
|
||||
|
||||
// MonthBaseInfo 基础信息
|
||||
MonthBaseInfo struct {
|
||||
RecordType int64 `json:"record_type"`
|
||||
Name string `json:"name"`
|
||||
NameEx string `json:"name_ex"`
|
||||
DepartsName string `json:"departs_name"`
|
||||
AcctID string `json:"acctid"`
|
||||
RuleInfo MonthRuleInfo `json:"rule_info"`
|
||||
}
|
||||
|
||||
// MonthRuleInfo 打卡人员所属规则信息
|
||||
MonthRuleInfo struct {
|
||||
GroupID int64 `json:"groupid"`
|
||||
GroupName string `json:"groupname"`
|
||||
}
|
||||
|
||||
// MonthSummaryInfo 汇总信息
|
||||
MonthSummaryInfo struct {
|
||||
WorkDays int64 `json:"work_days"`
|
||||
ExceptDays int64 `json:"except_days"`
|
||||
RegularDays int64 `json:"regular_days"`
|
||||
RegularWorkSec int64 `json:"regular_work_sec"`
|
||||
StandardWorkSec int64 `json:"standard_work_sec"`
|
||||
}
|
||||
|
||||
// OverWorkInfo 加班情况
|
||||
OverWorkInfo struct {
|
||||
WorkdayOverSec int64 `json:"workday_over_sec"`
|
||||
HolidayOverSec int64 `json:"holidays_over_sec"`
|
||||
RestDayOverSec int64 `json:"restdays_over_sec"`
|
||||
}
|
||||
)
|
||||
|
||||
// GetMonthData 获取打卡月报数据
|
||||
// @see https://developer.work.weixin.qq.com/document/path/96499
|
||||
func (r *Client) GetMonthData(req *GetCheckinDataRequest) (result *GetMonthDataResponse, err error) {
|
||||
var (
|
||||
response []byte
|
||||
accessToken string
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return
|
||||
}
|
||||
if response, err = util.PostJSON(fmt.Sprintf(getMonthDataURL, accessToken), req); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
result = new(GetMonthDataResponse)
|
||||
err = util.DecodeWithError(response, result, "GetMonthData")
|
||||
return
|
||||
}
|
||||
|
||||
// GetCorpOptionResponse 获取企业所有打卡规则响应
|
||||
type GetCorpOptionResponse struct {
|
||||
util.CommonError
|
||||
Group []CorpOptionGroup `json:"group"`
|
||||
}
|
||||
|
||||
// CorpOptionGroup 企业规则信息列表
|
||||
type CorpOptionGroup struct {
|
||||
GroupType int64 `json:"grouptype"`
|
||||
GroupID int64 `json:"groupid"`
|
||||
GroupName string `json:"groupname"`
|
||||
CheckinDate []GroupCheckinDate `json:"checkindate"`
|
||||
SpeWorkdays []SpeWorkdays `json:"spe_workdays"`
|
||||
SpeOffDays []SpeOffDays `json:"spe_offdays"`
|
||||
SyncHolidays bool `json:"sync_holidays"`
|
||||
NeedPhoto bool `json:"need_photo"`
|
||||
NoteCanUseLocalPic bool `json:"note_can_use_local_pic"`
|
||||
AllowCheckinOffWorkday bool `json:"allow_checkin_offworkday"`
|
||||
AllowApplyOffWorkday bool `json:"allow_apply_offworkday"`
|
||||
WifiMacInfos []WifiMacInfos `json:"wifimac_infos"`
|
||||
LocInfos []LocInfos `json:"loc_infos"`
|
||||
Range []Range `json:"range"`
|
||||
CreateTime int64 `json:"create_time"`
|
||||
WhiteUsers []string `json:"white_users"`
|
||||
Type int64 `json:"type"`
|
||||
ReporterInfo ReporterInfo `json:"reporterinfo"`
|
||||
OtInfo GroupOtInfo `json:"ot_info"`
|
||||
OtApplyInfo OtApplyInfo `json:"otapplyinfo"`
|
||||
Uptime int64 `json:"uptime"`
|
||||
AllowApplyBkCnt int64 `json:"allow_apply_bk_cnt"`
|
||||
OptionOutRange int64 `json:"option_out_range"`
|
||||
CreateUserID string `json:"create_userid"`
|
||||
UseFaceDetect bool `json:"use_face_detect"`
|
||||
AllowApplyBkDayLimit int64 `json:"allow_apply_bk_day_limit"`
|
||||
UpdateUserID string `json:"update_userid"`
|
||||
BukaRestriction int64 `json:"buka_restriction"`
|
||||
ScheduleList []ScheduleList `json:"schedulelist"`
|
||||
OffWorkIntervalTime int64 `json:"offwork_interval_time"`
|
||||
}
|
||||
|
||||
// GroupCheckinDate 打卡时间,当规则类型为排班时没有意义
|
||||
type GroupCheckinDate struct {
|
||||
Workdays []int64 `json:"workdays"`
|
||||
CheckinTime []GroupCheckinTime `json:"checkintime"`
|
||||
NoNeedOffWork bool `json:"noneed_offwork"`
|
||||
LimitAheadTime int64 `json:"limit_aheadtime"`
|
||||
FlexOnDutyTime int64 `json:"flex_on_duty_time"`
|
||||
FlexOffDutyTime int64 `json:"flex_off_duty_time"`
|
||||
}
|
||||
|
||||
// GroupCheckinTime 工作日上下班打卡时间信息
|
||||
type GroupCheckinTime struct {
|
||||
WorkSec int64 `json:"work_sec"`
|
||||
OffWorkSec int64 `json:"off_work_sec"`
|
||||
RemindWorkSec int64 `json:"remind_work_sec"`
|
||||
RemindOffWorkSec int64 `json:"remind_off_work_sec"`
|
||||
}
|
||||
|
||||
// SpeWorkdays 特殊日期-必须打卡日期信息
|
||||
type SpeWorkdays struct {
|
||||
Timestamp int64 `json:"timestamp"`
|
||||
Notes string `json:"notes"`
|
||||
CheckinTime []GroupCheckinTime `json:"checkintime"`
|
||||
}
|
||||
|
||||
// SpeOffDays 特殊日期-不用打卡日期信息
|
||||
type SpeOffDays struct {
|
||||
Timestamp int64 `json:"timestamp"`
|
||||
Notes string `json:"notes"`
|
||||
}
|
||||
|
||||
// WifiMacInfos 打卡地点-WiFi打卡信息
|
||||
type WifiMacInfos struct {
|
||||
WifiName string `json:"wifiname"`
|
||||
WifiMac string `json:"wifimac"`
|
||||
}
|
||||
|
||||
// LocInfos 打卡地点-位置打卡信息
|
||||
type LocInfos struct {
|
||||
Lat int64 `json:"lat"`
|
||||
Lng int64 `json:"lng"`
|
||||
LocTitle string `json:"loc_title"`
|
||||
LocDetail string `json:"loc_detail"`
|
||||
Distance int64 `json:"distance"`
|
||||
}
|
||||
|
||||
// Range 打卡人员信息
|
||||
type Range struct {
|
||||
PartyID []string `json:"partyid"`
|
||||
UserID []string `json:"userid"`
|
||||
TagID []int64 `json:"tagid"`
|
||||
}
|
||||
|
||||
// ReporterInfo 汇报对象信息
|
||||
type ReporterInfo struct {
|
||||
Reporters []Reporters `json:"reporters"`
|
||||
UpdateTime int64 `json:"updatetime"`
|
||||
}
|
||||
|
||||
// Reporters 汇报对象,每个汇报人用userid表示
|
||||
type Reporters struct {
|
||||
UserID string `json:"userid"`
|
||||
}
|
||||
|
||||
// GroupOtInfo 加班信息
|
||||
type GroupOtInfo struct {
|
||||
Type int64 `json:"type"`
|
||||
AllowOtWorkingDay bool `json:"allow_ot_workingday"`
|
||||
AllowOtNonWorkingDay bool `json:"allow_ot_nonworkingday"`
|
||||
OtCheckInfo OtCheckInfo `json:"otcheckinfo"`
|
||||
}
|
||||
|
||||
// OtCheckInfo 以打卡时间为准-加班时长计算规则信息
|
||||
type OtCheckInfo struct {
|
||||
OtWorkingDayTimeStart int64 `json:"ot_workingday_time_start"`
|
||||
OtWorkingDayTimeMin int64 `json:"ot_workingday_time_min"`
|
||||
OtWorkingDayTimeMax int64 `json:"ot_workingday_time_max"`
|
||||
OtNonworkingDayTimeMin int64 `json:"ot_nonworkingday_time_min"`
|
||||
OtNonworkingDayTimeMax int64 `json:"ot_nonworkingday_time_max"`
|
||||
OtNonworkingDaySpanDayTime int64 `json:"ot_nonworkingday_spanday_time"`
|
||||
OtWorkingDayRestInfo OtRestInfo `json:"ot_workingday_restinfo"`
|
||||
OtNonWorkingDayRestInfo OtRestInfo `json:"ot_nonworkingday_restinfo"`
|
||||
}
|
||||
|
||||
// OtRestInfo 加班-休息扣除配置信息
|
||||
type OtRestInfo struct {
|
||||
Type int64 `json:"type"`
|
||||
FixTimeRule FixTimeRule `json:"fix_time_rule"`
|
||||
CalOtTimeRule CalOtTimeRule `json:"cal_ottime_rule"`
|
||||
}
|
||||
|
||||
// FixTimeRule 工作日加班-指定休息时间配置信息
|
||||
type FixTimeRule struct {
|
||||
FixTimeBeginSec int64 `json:"fix_time_begin_sec"`
|
||||
FixTimeEndSec int64 `json:"fix_time_end_sec"`
|
||||
}
|
||||
|
||||
// CalOtTimeRule 工作日加班-按加班时长扣除配置信息
|
||||
type CalOtTimeRule struct {
|
||||
Items []CalOtTimeRuleItem `json:"items"`
|
||||
}
|
||||
|
||||
// CalOtTimeRuleItem 工作日加班-按加班时长扣除条件信息
|
||||
type CalOtTimeRuleItem struct {
|
||||
OtTime int64 `json:"ot_time"`
|
||||
RestTime int64 `json:"rest_time"`
|
||||
}
|
||||
|
||||
// OtApplyInfo 以加班申请核算打卡记录相关信息
|
||||
type OtApplyInfo struct {
|
||||
AllowOtWorkingDay bool `json:"allow_ot_workingday"`
|
||||
AllowOtNonWorkingDay bool `json:"allow_ot_nonworkingday"`
|
||||
Uiptime int64 `json:"uptime"`
|
||||
OtNonworkingDaySpanDayTime int64 `json:"ot_nonworkingday_spanday_time"`
|
||||
OtWorkingDayRestInfo OtRestInfo `json:"ot_workingday_restinfo"`
|
||||
OtNonWorkingDayRestInfo OtRestInfo `json:"ot_nonworkingday_restinfo"`
|
||||
}
|
||||
|
||||
// ScheduleList 排班信息列表
|
||||
type ScheduleList struct {
|
||||
ScheduleID int64 `json:"schedule_id"`
|
||||
ScheduleName string `json:"schedule_name"`
|
||||
TimeSection []TimeSection `json:"time_section"`
|
||||
LimitAheadTime int64 `json:"limit_aheadtime"`
|
||||
NoNeedOffWork bool `json:"noneed_offwork"`
|
||||
LimitOffTime int64 `json:"limit_offtime"`
|
||||
FlexOnDutyTime int64 `json:"flex_on_duty_time"`
|
||||
FlexOffDutyTime int64 `json:"flex_off_duty_time"`
|
||||
AllowFlex bool `json:"allow_flex"`
|
||||
LateRule LateRule `json:"late_rule"`
|
||||
MaxAllowArriveEarly int64 `json:"max_allow_arrive_early"`
|
||||
MaxAllowArriveLate int64 `json:"max_allow_arrive_late"`
|
||||
}
|
||||
|
||||
// TimeSection 班次上下班时段信息
|
||||
type TimeSection struct {
|
||||
TimeID int64 `json:"time_id"`
|
||||
WorkSec int64 `json:"work_sec"`
|
||||
OffWorkSec int64 `json:"off_work_sec"`
|
||||
RemindWorkSec int64 `json:"remind_work_sec"`
|
||||
RemindOffWorkSec int64 `json:"remind_off_work_sec"`
|
||||
RestBeginTime int64 `json:"rest_begin_time"`
|
||||
RestEndTime int64 `json:"rest_end_time"`
|
||||
AllowRest bool `json:"allow_rest"`
|
||||
}
|
||||
|
||||
// LateRule 晚走晚到时间规则信息
|
||||
type LateRule struct {
|
||||
AllowOffWorkAfterTime bool `json:"allow_offwork_after_time"`
|
||||
TimeRules []TimeRule `json:"timerules"`
|
||||
}
|
||||
|
||||
// TimeRule 迟到规则时间
|
||||
type TimeRule struct {
|
||||
OffWorkAfterTime int64 `json:"offwork_after_time"`
|
||||
OnWorkFlexTime int64 `json:"onwork_flex_time"`
|
||||
}
|
||||
|
||||
// GetCorpOption 获取企业所有打卡规则
|
||||
// @see https://developer.work.weixin.qq.com/document/path/93384
|
||||
func (r *Client) GetCorpOption() (*GetCorpOptionResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPPost(fmt.Sprintf(getCorpOptionURL, accessToken), ""); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &GetCorpOptionResponse{}
|
||||
err = util.DecodeWithError(response, result, "GetCorpOption")
|
||||
return result, err
|
||||
}
|
||||
|
||||
// GetOptionRequest 获取员工打卡规则请求
|
||||
type GetOptionRequest struct {
|
||||
Datetime int64 `json:"datetime"`
|
||||
UserIDList []string `json:"useridlist"`
|
||||
}
|
||||
|
||||
// GetOptionResponse 获取员工打卡规则响应
|
||||
type GetOptionResponse struct {
|
||||
util.CommonError
|
||||
Info []OptionInfo `json:"info"`
|
||||
}
|
||||
|
||||
// OptionInfo 打卡规则列表
|
||||
type OptionInfo struct {
|
||||
UserID string `json:"userid"`
|
||||
Group OptionGroup `json:"group"`
|
||||
}
|
||||
|
||||
// OptionGroup 打卡规则相关信息
|
||||
type OptionGroup struct {
|
||||
GroupType int64 `json:"grouptype"`
|
||||
GroupID int64 `json:"groupid"`
|
||||
GroupName string `json:"groupname"`
|
||||
CheckinDate []OptionCheckinDate `json:"checkindate"`
|
||||
SpeWorkdays []SpeWorkdays `json:"spe_workdays"`
|
||||
SpeOffDays []SpeOffDays `json:"spe_offdays"`
|
||||
SyncHolidays bool `json:"sync_holidays"`
|
||||
NeedPhoto bool `json:"need_photo"`
|
||||
WifiMacInfos []WifiMacInfos `json:"wifimac_infos"`
|
||||
NoteCanUseLocalPic bool `json:"note_can_use_local_pic"`
|
||||
AllowCheckinOffWorkday bool `json:"allow_checkin_offworkday"`
|
||||
AllowApplyOffWorkday bool `json:"allow_apply_offworkday"`
|
||||
LocInfos []LocInfos `json:"loc_infos"`
|
||||
ScheduleList []ScheduleList `json:"schedulelist"`
|
||||
BukaRestriction int64 `json:"buka_restriction"`
|
||||
}
|
||||
|
||||
// OptionCheckinDate 打卡时间配置
|
||||
type OptionCheckinDate struct {
|
||||
Workdays []int64 `json:"workdays"`
|
||||
CheckinTime []GroupCheckinTime `json:"checkintime"`
|
||||
FlexTime int64 `json:"flex_time"`
|
||||
NoNeedOffWork bool `json:"noneed_offwork"`
|
||||
LimitAheadTime int64 `json:"limit_aheadtime"`
|
||||
FlexOnDutyTime int64 `json:"flex_on_duty_time"`
|
||||
FlexOffDutyTime int64 `json:"flex_off_duty_time"`
|
||||
}
|
||||
|
||||
// GetOption 获取员工打卡规则
|
||||
// see https://developer.work.weixin.qq.com/document/path/90263
|
||||
func (r *Client) GetOption(req *GetOptionRequest) (*GetOptionResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(getOptionURL, accessToken), req); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &GetOptionResponse{}
|
||||
err = util.DecodeWithError(response, result, "GetOption")
|
||||
return result, err
|
||||
}
|
||||
|
||||
// GetScheduleListRequest 获取打卡人员排班信息请求
|
||||
type GetScheduleListRequest struct {
|
||||
StartTime int64 `json:"starttime"`
|
||||
EndTime int64 `json:"endtime"`
|
||||
UserIDList []string `json:"useridlist"`
|
||||
}
|
||||
|
||||
// GetScheduleListResponse 获取打卡人员排班信息响应
|
||||
type GetScheduleListResponse struct {
|
||||
util.CommonError
|
||||
ScheduleList []ScheduleItem `json:"schedule_list"`
|
||||
}
|
||||
|
||||
// ScheduleItem 排班表信息
|
||||
type ScheduleItem struct {
|
||||
UserID string `json:"userid"`
|
||||
YearMonth int64 `json:"yearmonth"`
|
||||
GroupID int64 `json:"groupid"`
|
||||
GroupName string `json:"groupname"`
|
||||
Schedule Schedule `json:"schedule"`
|
||||
}
|
||||
|
||||
// Schedule 个人排班信息
|
||||
type Schedule struct {
|
||||
ScheduleList []ScheduleListItem `json:"scheduleList"`
|
||||
}
|
||||
|
||||
// ScheduleListItem 个人排班表信息
|
||||
type ScheduleListItem struct {
|
||||
Day int64 `json:"day"`
|
||||
ScheduleInfo ScheduleInfo `json:"schedule_info"`
|
||||
}
|
||||
|
||||
// ScheduleInfo 个人当日排班信息
|
||||
type ScheduleInfo struct {
|
||||
ScheduleID int64 `json:"schedule_id"`
|
||||
ScheduleName string `json:"schedule_name"`
|
||||
TimeSection []ScheduleTimeSection `json:"time_section"`
|
||||
}
|
||||
|
||||
// ScheduleTimeSection 班次上下班时段信息
|
||||
type ScheduleTimeSection struct {
|
||||
ID int64 `json:"id"`
|
||||
WorkSec int64 `json:"work_sec"`
|
||||
OffWorkSec int64 `json:"off_work_sec"`
|
||||
RemindWorkSec int64 `json:"remind_work_sec"`
|
||||
RemindOffWorkSec int64 `json:"remind_off_work_sec"`
|
||||
}
|
||||
|
||||
// GetScheduleList 获取打卡人员排班信息
|
||||
// see https://developer.work.weixin.qq.com/document/path/93380
|
||||
func (r *Client) GetScheduleList(req *GetScheduleListRequest) (*GetScheduleListResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(getScheduleListURL, accessToken), req); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &GetScheduleListResponse{}
|
||||
err = util.DecodeWithError(response, result, "GetScheduleList")
|
||||
return result, err
|
||||
}
|
||||
|
||||
// GetHardwareDataRequest 获取设备打卡数据请求
|
||||
type GetHardwareDataRequest struct {
|
||||
FilterType int64 `json:"filter_type"`
|
||||
StartTime int64 `json:"starttime"`
|
||||
EndTime int64 `json:"endtime"`
|
||||
UserIDList []string `json:"useridlist"`
|
||||
}
|
||||
|
||||
// GetHardwareDataResponse 获取设备打卡数据响应
|
||||
type GetHardwareDataResponse struct {
|
||||
util.CommonError
|
||||
CheckinData []HardwareCheckinData `json:"checkindata"`
|
||||
}
|
||||
|
||||
// HardwareCheckinData 设备打卡数据
|
||||
type HardwareCheckinData struct {
|
||||
UserID string `json:"userid"`
|
||||
CheckinTime int64 `json:"checkin_time"`
|
||||
DeviceSn string `json:"device_sn"`
|
||||
DeviceName string `json:"device_name"`
|
||||
}
|
||||
|
||||
// GetHardwareData 获取设备打卡数据
|
||||
// see https://developer.work.weixin.qq.com/document/path/94126
|
||||
func (r *Client) GetHardwareData(req *GetHardwareDataRequest) (*GetHardwareDataResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = r.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(getHardwareDataURL, accessToken), req); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &GetHardwareDataResponse{}
|
||||
err = util.DecodeWithError(response, result, "GetHardwareData")
|
||||
return result, err
|
||||
}
|
||||
43
work/externalcontact/callback.go
Normal file
43
work/externalcontact/callback.go
Normal file
@@ -0,0 +1,43 @@
|
||||
package externalcontact
|
||||
|
||||
import (
|
||||
"encoding/xml"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
// 原始回调消息内容
|
||||
type callbackOriginMessage struct {
|
||||
ToUserName string // 企业微信的CorpID,当为第三方套件回调事件时,CorpID的内容为suiteid
|
||||
AgentID string // 接收的应用id,可在应用的设置页面获取
|
||||
Encrypt string // 消息结构体加密后的字符串
|
||||
}
|
||||
|
||||
// EventCallbackMessage 微信客户联系回调消息
|
||||
// https://developer.work.weixin.qq.com/document/path/92130
|
||||
type EventCallbackMessage struct {
|
||||
ToUserName string `json:"to_user_name"`
|
||||
FromUserName string `json:"from_user_name"`
|
||||
CreateTime int64 `json:"create_time"`
|
||||
MsgType string `json:"msg_type"`
|
||||
Event string `json:"event"`
|
||||
ChangeType string `json:"change_type"`
|
||||
UserID string `json:"user_id"`
|
||||
ExternalUserID string `json:"external_user_id"`
|
||||
State string `json:"state"`
|
||||
WelcomeCode string `json:"welcome_code"`
|
||||
}
|
||||
|
||||
// GetCallbackMessage 获取联系客户回调事件中的消息内容
|
||||
func (r *Client) GetCallbackMessage(encryptedMsg []byte) (msg EventCallbackMessage, err error) {
|
||||
var origin callbackOriginMessage
|
||||
if err = xml.Unmarshal(encryptedMsg, &origin); err != nil {
|
||||
return
|
||||
}
|
||||
_, bData, err := util.DecryptMsg(r.CorpID, origin.Encrypt, r.EncodingAESKey)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
err = xml.Unmarshal(bData, &msg)
|
||||
return
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user