mirror of
https://github.com/silenceper/wechat.git
synced 2026-02-04 21:02:25 +08:00
Compare commits
142 Commits
v2.1.5-rc.
...
v2
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
20a8183e88 | ||
|
|
f0f35e2f77 | ||
|
|
eebfb93386 | ||
|
|
9b028e5368 | ||
|
|
2bfc250f21 | ||
|
|
f0866babb5 | ||
|
|
7d93d1b9c8 | ||
|
|
78c00a9124 | ||
|
|
54f08cbd73 | ||
|
|
c34ff2031b | ||
|
|
30c8e77246 | ||
|
|
6f6e95cfdb | ||
|
|
c806a0c172 | ||
|
|
c136b878ce | ||
|
|
d4a81916d5 | ||
|
|
ef1372b98a | ||
|
|
0d666b60ba | ||
|
|
e1122d42b0 | ||
|
|
be3f0d8bd5 | ||
|
|
66f9794d2f | ||
|
|
ee5f045b89 | ||
|
|
d35f0f0865 | ||
|
|
bbad169706 | ||
|
|
5927c26152 | ||
|
|
8ebff5c29c | ||
|
|
86ef690ecd | ||
|
|
ee85790123 | ||
|
|
8a810837a4 | ||
|
|
c51d41ee8a | ||
|
|
24f812d187 | ||
|
|
dd43b7baa3 | ||
|
|
2dfd2ff608 | ||
|
|
23bb10b0c9 | ||
|
|
b639d2235d | ||
|
|
26d2093bd7 | ||
|
|
cf42cd8d54 | ||
|
|
85ee45580b | ||
|
|
208d5c528a | ||
|
|
b5f9a8933e | ||
|
|
52fb5596d3 | ||
|
|
44150c557e | ||
|
|
635a0c640d | ||
|
|
010e49c35c | ||
|
|
9c87d1cb34 | ||
|
|
71c8ab58fb | ||
|
|
92bf6c7699 | ||
|
|
6b9d4f82da | ||
|
|
17521d047e | ||
|
|
d38e750876 | ||
|
|
3bd886d7f2 | ||
|
|
35af33f0bc | ||
|
|
4a8371e178 | ||
|
|
a571bf3546 | ||
|
|
3fbe8634d9 | ||
|
|
990ba6ede9 | ||
|
|
44b09c7c3b | ||
|
|
2e0708845b | ||
|
|
c1770130a0 | ||
|
|
c22a036b7f | ||
|
|
05ac7148d4 | ||
|
|
6b3532cc2d | ||
|
|
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 |
4
.github/FUNDING.yml
vendored
4
.github/FUNDING.yml
vendored
@@ -1,8 +1,8 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
|
||||
github: # silenceper
|
||||
patreon: # Replace with a single Patreon username
|
||||
open_collective: # Replace with a single Open Collective username
|
||||
open_collective: gowechat
|
||||
ko_fi: # Replace with a single Ko-fi username
|
||||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
||||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
||||
|
||||
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/
|
||||
-->
|
||||
**请描述您的问题**
|
||||
|
||||
38
.github/workflows/ai-dev.yaml
vendored
Normal file
38
.github/workflows/ai-dev.yaml
vendored
Normal file
@@ -0,0 +1,38 @@
|
||||
name: Claude Code
|
||||
|
||||
on:
|
||||
issue_comment:
|
||||
types: [created]
|
||||
pull_request_review_comment:
|
||||
types: [created]
|
||||
issues:
|
||||
types: [opened, assigned]
|
||||
pull_request_review:
|
||||
types: [submitted]
|
||||
|
||||
jobs:
|
||||
claude:
|
||||
if: |
|
||||
(github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) ||
|
||||
(github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) ||
|
||||
(github.event_name == 'pull_request_review' && contains(github.event.review.body, '@claude')) ||
|
||||
(github.event_name == 'issues' && (contains(github.event.issue.body, '@claude') || contains(github.event.issue.title, '@claude')))
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: read
|
||||
issues: read
|
||||
id-token: write
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 1
|
||||
- name: Run Claude Code
|
||||
id: claude
|
||||
uses: anthropics/claude-code-action@beta
|
||||
env:
|
||||
ANTHROPIC_BASE_URL: "${{ secrets.ANTHROPIC_BASE_URL }}"
|
||||
with:
|
||||
model: "${{ secrets.ANTHROPIC_MODEL }}"
|
||||
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
|
||||
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.16.x,1.17.x,1.18.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@v3
|
||||
- uses: actions/checkout@v3
|
||||
- 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.2.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: latest
|
||||
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.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 }}
|
||||
@@ -55,7 +55,7 @@ issues:
|
||||
linters-settings:
|
||||
funlen:
|
||||
lines: 66
|
||||
statements: 40
|
||||
statements: 50
|
||||
|
||||
#issues:
|
||||
# include:
|
||||
|
||||
@@ -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:'
|
||||
17
README.md
17
README.md
@@ -1,12 +1,13 @@
|
||||
# WeChat SDK for Go
|
||||
|
||||

|
||||
[](https://goreportcard.com/report/github.com/silenceper/wechat)
|
||||

|
||||
[](https://goreportcard.com/report/github.com/silenceper/wechat/v2)
|
||||
[](https://pkg.go.dev/github.com/silenceper/wechat/v2?tab=doc)
|
||||

|
||||

|
||||

|
||||
|
||||
|
||||
使用Golang开发的微信SDK,简单、易用。
|
||||
> 注意:当前版本为v2版本,v1版本已废弃
|
||||
|
||||
## 文档 && 例子
|
||||
|
||||
@@ -75,7 +76,13 @@ server.Send()
|
||||
- 提交issue,描述需要贡献的内容
|
||||
- 完成更改后,提交PR
|
||||
|
||||
## 公众号
|
||||
|
||||
## 感谢以下贡献者
|
||||
|
||||
<a href="https://opencollective.com/gowechat"><img src="https://opencollective.com/gowechat/contributors.svg?width=890" /></a>
|
||||
|
||||
|
||||
## 作者公众号
|
||||
|
||||

|
||||
|
||||
|
||||
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)
|
||||
}
|
||||
|
||||
103
cache/redis.go
vendored
103
cache/redis.go
vendored
@@ -2,6 +2,8 @@ package cache
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/tls"
|
||||
"net"
|
||||
"time"
|
||||
|
||||
"github.com/go-redis/redis/v8"
|
||||
@@ -15,23 +17,76 @@ type Redis struct {
|
||||
|
||||
// RedisOpts redis 连接属性
|
||||
type RedisOpts struct {
|
||||
Host string `yml:"host" json:"host"`
|
||||
Password string `yml:"password" json:"password"`
|
||||
Database int `yml:"database" json:"database"`
|
||||
MaxIdle int `yml:"max_idle" json:"max_idle"`
|
||||
MaxActive int `yml:"max_active" json:"max_active"`
|
||||
IdleTimeout int `yml:"idle_timeout" json:"idle_timeout"` // second
|
||||
Host string `json:"host" yaml:"host"`
|
||||
Username string `json:"username" yaml:"username"`
|
||||
Password string `json:"password" yaml:"password"`
|
||||
Database int `json:"database" yaml:"database"`
|
||||
MinIdleConns int `json:"min_idle_conns" yaml:"min_idle_conns"` // 最小空闲连接数
|
||||
PoolSize int `json:"pool_size" yaml:"pool_size"` // 连接池大小,0 表示使用默认值(即 CPU 核心数 * 10)
|
||||
MaxRetries int `json:"max_retries" yaml:"max_retries"` // 最大重试次数,-1 表示不重试,0 表示使用默认值(即 3 次)
|
||||
DialTimeout int `json:"dial_timeout" yaml:"dial_timeout"` // 连接超时时间(秒),0 表示使用默认值(即 5 秒)
|
||||
ReadTimeout int `json:"read_timeout" yaml:"read_timeout"` // 读取超时时间(秒),-1 表示不超时,0 表示使用默认值(即 3 秒)
|
||||
WriteTimeout int `json:"write_timeout" yaml:"write_timeout"` // 写入超时时间(秒),-1 表示不超时,0 表示使用默认值(即 ReadTimeout)
|
||||
PoolTimeout int `json:"pool_timeout" yaml:"pool_timeout"` // 连接池获取连接超时时间(秒),0 表示使用默认值(即 ReadTimeout + 1 秒)
|
||||
IdleTimeout int `json:"idle_timeout" yaml:"idle_timeout"` // 空闲连接超时时间(秒),-1 表示禁用空闲连接超时检查,0 表示使用默认值(即 5 分钟)
|
||||
UseTLS bool `json:"use_tls" yaml:"use_tls"` // 是否使用 TLS
|
||||
|
||||
// Deprecated: 应使用 MinIdleConns 代替
|
||||
MaxIdle int `json:"max_idle" yaml:"max_idle"`
|
||||
// Deprecated: 应使用 PoolSize 代替
|
||||
MaxActive int `json:"max_active" yaml:"max_active"`
|
||||
}
|
||||
|
||||
// NewRedis 实例化
|
||||
func NewRedis(ctx context.Context, opts *RedisOpts) *Redis {
|
||||
conn := redis.NewUniversalClient(&redis.UniversalOptions{
|
||||
uniOpt := &redis.UniversalOptions{
|
||||
Addrs: []string{opts.Host},
|
||||
DB: opts.Database,
|
||||
Username: opts.Username,
|
||||
Password: opts.Password,
|
||||
IdleTimeout: time.Second * time.Duration(opts.IdleTimeout),
|
||||
MinIdleConns: opts.MaxIdle,
|
||||
})
|
||||
MinIdleConns: opts.MinIdleConns,
|
||||
PoolSize: opts.PoolSize,
|
||||
MaxRetries: opts.MaxRetries,
|
||||
}
|
||||
|
||||
// 兼容旧的 MaxIdle 参数,仅在未显式设置 MinIdleConns 时生效
|
||||
if opts.MaxIdle > 0 && opts.MinIdleConns == 0 {
|
||||
uniOpt.MinIdleConns = opts.MaxIdle
|
||||
}
|
||||
|
||||
// 兼容旧的 MaxActive 参数,仅在未显式设置 PoolSize 时生效
|
||||
if opts.MaxActive > 0 && opts.PoolSize == 0 {
|
||||
uniOpt.PoolSize = opts.MaxActive
|
||||
}
|
||||
|
||||
applyTimeout := func(seconds int, target *time.Duration) {
|
||||
if seconds > 0 {
|
||||
*target = time.Duration(seconds) * time.Second
|
||||
} else if seconds == -1 {
|
||||
// 当 seconds 为 -1 时,表示禁用超时:按 go-redis 约定,将超时时间设置为负值(如 -1ns)代表「无超时」
|
||||
*target = -1
|
||||
}
|
||||
// 当 seconds 为 0 时,使用 go-redis 的默认超时配置:
|
||||
// 不修改 target,保持其零值(0),由 go-redis 解释为“使用默认值”
|
||||
}
|
||||
|
||||
applyTimeout(opts.DialTimeout, &uniOpt.DialTimeout)
|
||||
applyTimeout(opts.ReadTimeout, &uniOpt.ReadTimeout)
|
||||
applyTimeout(opts.WriteTimeout, &uniOpt.WriteTimeout)
|
||||
applyTimeout(opts.PoolTimeout, &uniOpt.PoolTimeout)
|
||||
applyTimeout(opts.IdleTimeout, &uniOpt.IdleTimeout)
|
||||
|
||||
if opts.UseTLS {
|
||||
h, _, err := net.SplitHostPort(opts.Host)
|
||||
if err != nil {
|
||||
h = opts.Host
|
||||
}
|
||||
uniOpt.TLSConfig = &tls.Config{
|
||||
ServerName: h,
|
||||
}
|
||||
}
|
||||
|
||||
conn := redis.NewUniversalClient(uniOpt)
|
||||
return &Redis{ctx: ctx, conn: conn}
|
||||
}
|
||||
|
||||
@@ -47,7 +102,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 +116,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()
|
||||
}
|
||||
|
||||
276
cache/redis_test.go
vendored
276
cache/redis_test.go
vendored
@@ -4,17 +4,33 @@ import (
|
||||
"context"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/alicebob/miniredis/v2"
|
||||
"github.com/go-redis/redis/v8"
|
||||
)
|
||||
|
||||
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(),
|
||||
Password: "",
|
||||
Database: 0,
|
||||
PoolSize: 10,
|
||||
MinIdleConns: 5,
|
||||
DialTimeout: 5,
|
||||
ReadTimeout: 5,
|
||||
WriteTimeout: 5,
|
||||
PoolTimeout: 5,
|
||||
IdleTimeout: 300,
|
||||
}
|
||||
redis = NewRedis(ctx, opts)
|
||||
err error
|
||||
val = "silenceper"
|
||||
key = "username"
|
||||
)
|
||||
@@ -38,3 +54,259 @@ func TestRedis(t *testing.T) {
|
||||
t.Errorf("delete Error , err=%v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// setupRedisServer 创建并返回一个 miniredis 服务器实例
|
||||
func setupRedisServer(t *testing.T) *miniredis.Miniredis {
|
||||
server, err := miniredis.Run()
|
||||
if err != nil {
|
||||
t.Fatal("miniredis.Run Error", err)
|
||||
}
|
||||
t.Cleanup(server.Close)
|
||||
return server
|
||||
}
|
||||
|
||||
// TestRedisMaxIdleMapping 测试只设置MaxIdle应该映射到MinIdleConns
|
||||
func TestRedisMaxIdleMapping(t *testing.T) {
|
||||
server := setupRedisServer(t)
|
||||
ctx := context.Background()
|
||||
|
||||
opts := &RedisOpts{
|
||||
Host: server.Addr(),
|
||||
Database: 0,
|
||||
MaxIdle: 10,
|
||||
}
|
||||
r := NewRedis(ctx, opts)
|
||||
|
||||
// 获取底层的 UniversalClient 并断言为 *redis.Client
|
||||
client, ok := r.conn.(*redis.Client)
|
||||
if !ok {
|
||||
t.Fatal("无法转换为 *redis.Client")
|
||||
}
|
||||
|
||||
// 注意:MinIdleConns 表示期望的最小空闲连接数,但实际空闲连接数可能不同
|
||||
// 我们需要通过 Options() 来验证配置是否正确应用
|
||||
clientOpts := client.Options()
|
||||
if clientOpts.MinIdleConns != 10 {
|
||||
t.Errorf("期望 MinIdleConns = 10, 实际 = %d", clientOpts.MinIdleConns)
|
||||
}
|
||||
}
|
||||
|
||||
// TestRedisMaxActiveMapping 测试只设置MaxActive应该映射到PoolSize
|
||||
func TestRedisMaxActiveMapping(t *testing.T) {
|
||||
server := setupRedisServer(t)
|
||||
ctx := context.Background()
|
||||
|
||||
opts := &RedisOpts{
|
||||
Host: server.Addr(),
|
||||
Database: 0,
|
||||
MaxActive: 20,
|
||||
}
|
||||
r := NewRedis(ctx, opts)
|
||||
|
||||
client, ok := r.conn.(*redis.Client)
|
||||
if !ok {
|
||||
t.Fatal("无法转换为 *redis.Client")
|
||||
}
|
||||
|
||||
clientOpts := client.Options()
|
||||
if clientOpts.PoolSize != 20 {
|
||||
t.Errorf("期望 PoolSize = 20, 实际 = %d", clientOpts.PoolSize)
|
||||
}
|
||||
}
|
||||
|
||||
// TestRedisNewFieldsPriority 测试新字段应该优先于旧字段
|
||||
func TestRedisNewFieldsPriority(t *testing.T) {
|
||||
server := setupRedisServer(t)
|
||||
ctx := context.Background()
|
||||
|
||||
opts := &RedisOpts{
|
||||
Host: server.Addr(),
|
||||
Database: 0,
|
||||
MaxIdle: 5,
|
||||
MinIdleConns: 15,
|
||||
MaxActive: 10,
|
||||
PoolSize: 30,
|
||||
}
|
||||
r := NewRedis(ctx, opts)
|
||||
|
||||
client, ok := r.conn.(*redis.Client)
|
||||
if !ok {
|
||||
t.Fatal("无法转换为 *redis.Client")
|
||||
}
|
||||
|
||||
clientOpts := client.Options()
|
||||
if clientOpts.MinIdleConns != 15 {
|
||||
t.Errorf("期望 MinIdleConns = 15 (新字段优先), 实际 = %d", clientOpts.MinIdleConns)
|
||||
}
|
||||
if clientOpts.PoolSize != 30 {
|
||||
t.Errorf("期望 PoolSize = 30 (新字段优先), 实际 = %d", clientOpts.PoolSize)
|
||||
}
|
||||
}
|
||||
|
||||
// TestRedisPositiveTimeouts 测试正值超时应该正确应用
|
||||
func TestRedisPositiveTimeouts(t *testing.T) {
|
||||
server := setupRedisServer(t)
|
||||
ctx := context.Background()
|
||||
|
||||
opts := &RedisOpts{
|
||||
Host: server.Addr(),
|
||||
Database: 0,
|
||||
DialTimeout: 10,
|
||||
ReadTimeout: 20,
|
||||
WriteTimeout: 30,
|
||||
PoolTimeout: 40,
|
||||
IdleTimeout: 50,
|
||||
}
|
||||
r := NewRedis(ctx, opts)
|
||||
|
||||
client, ok := r.conn.(*redis.Client)
|
||||
if !ok {
|
||||
t.Fatal("无法转换为 *redis.Client")
|
||||
}
|
||||
|
||||
clientOpts := client.Options()
|
||||
if clientOpts.DialTimeout != 10*time.Second {
|
||||
t.Errorf("期望 DialTimeout = 10s, 实际 = %v", clientOpts.DialTimeout)
|
||||
}
|
||||
if clientOpts.ReadTimeout != 20*time.Second {
|
||||
t.Errorf("期望 ReadTimeout = 20s, 实际 = %v", clientOpts.ReadTimeout)
|
||||
}
|
||||
if clientOpts.WriteTimeout != 30*time.Second {
|
||||
t.Errorf("期望 WriteTimeout = 30s, 实际 = %v", clientOpts.WriteTimeout)
|
||||
}
|
||||
if clientOpts.PoolTimeout != 40*time.Second {
|
||||
t.Errorf("期望 PoolTimeout = 40s, 实际 = %v", clientOpts.PoolTimeout)
|
||||
}
|
||||
if clientOpts.IdleTimeout != 50*time.Second {
|
||||
t.Errorf("期望 IdleTimeout = 50s, 实际 = %v", clientOpts.IdleTimeout)
|
||||
}
|
||||
}
|
||||
|
||||
// TestRedisNegativeTimeouts 测试-1值应该禁用超时
|
||||
func TestRedisNegativeTimeouts(t *testing.T) {
|
||||
server := setupRedisServer(t)
|
||||
ctx := context.Background()
|
||||
|
||||
opts := &RedisOpts{
|
||||
Host: server.Addr(),
|
||||
Database: 0,
|
||||
DialTimeout: -1,
|
||||
ReadTimeout: -1,
|
||||
WriteTimeout: -1,
|
||||
PoolTimeout: -1,
|
||||
IdleTimeout: -1,
|
||||
}
|
||||
r := NewRedis(ctx, opts)
|
||||
|
||||
client, ok := r.conn.(*redis.Client)
|
||||
if !ok {
|
||||
t.Fatal("无法转换为 *redis.Client")
|
||||
}
|
||||
|
||||
clientOpts := client.Options()
|
||||
// -1 应该被设置为负值表示禁用超时
|
||||
// DialTimeout, PoolTimeout, IdleTimeout 会被设置为 -1ns
|
||||
if clientOpts.DialTimeout != -1 {
|
||||
t.Errorf("期望 DialTimeout = -1ns (禁用), 实际 = %v", clientOpts.DialTimeout)
|
||||
}
|
||||
// ReadTimeout 和 WriteTimeout 在 go-redis 中有特殊处理
|
||||
// 当设置为负值时,会被规范化为 0,这也表示无超时
|
||||
t.Logf("ReadTimeout = %v (设置为-1后的值)", clientOpts.ReadTimeout)
|
||||
t.Logf("WriteTimeout = %v (设置为-1后的值)", clientOpts.WriteTimeout)
|
||||
|
||||
if clientOpts.PoolTimeout != -1 {
|
||||
t.Errorf("期望 PoolTimeout = -1ns (禁用), 实际 = %v", clientOpts.PoolTimeout)
|
||||
}
|
||||
if clientOpts.IdleTimeout != -1 {
|
||||
t.Errorf("期望 IdleTimeout = -1ns (禁用), 实际 = %v", clientOpts.IdleTimeout)
|
||||
}
|
||||
}
|
||||
|
||||
// TestRedisZeroTimeouts 测试0值应该使用go-redis默认值
|
||||
func TestRedisZeroTimeouts(t *testing.T) {
|
||||
server := setupRedisServer(t)
|
||||
ctx := context.Background()
|
||||
|
||||
opts := &RedisOpts{
|
||||
Host: server.Addr(),
|
||||
Database: 0,
|
||||
DialTimeout: 0,
|
||||
ReadTimeout: 0,
|
||||
WriteTimeout: 0,
|
||||
PoolTimeout: 0,
|
||||
IdleTimeout: 0,
|
||||
}
|
||||
r := NewRedis(ctx, opts)
|
||||
|
||||
client, ok := r.conn.(*redis.Client)
|
||||
if !ok {
|
||||
t.Fatal("无法转换为 *redis.Client")
|
||||
}
|
||||
|
||||
clientOpts := client.Options()
|
||||
// 0值应该保持为0,由 go-redis 使用默认值
|
||||
// go-redis 的默认值:
|
||||
// DialTimeout: 5s
|
||||
// ReadTimeout: 3s
|
||||
// WriteTimeout: ReadTimeout
|
||||
// PoolTimeout: ReadTimeout + 1s
|
||||
// IdleTimeout: 5min
|
||||
|
||||
if clientOpts.DialTimeout == 0 {
|
||||
t.Error("期望 DialTimeout 使用 go-redis 默认值 (5s), 实际为 0")
|
||||
}
|
||||
if clientOpts.ReadTimeout == 0 {
|
||||
t.Error("期望 ReadTimeout 使用 go-redis 默认值 (3s), 实际为 0")
|
||||
}
|
||||
if clientOpts.WriteTimeout == 0 {
|
||||
t.Error("期望 WriteTimeout 使用 go-redis 默认值 (ReadTimeout), 实际为 0")
|
||||
}
|
||||
if clientOpts.PoolTimeout == 0 {
|
||||
t.Error("期望 PoolTimeout 使用 go-redis 默认值 (ReadTimeout + 1s), 实际为 0")
|
||||
}
|
||||
if clientOpts.IdleTimeout == 0 {
|
||||
t.Error("期望 IdleTimeout 使用 go-redis 默认值 (5min), 实际为 0")
|
||||
}
|
||||
}
|
||||
|
||||
// TestRedisMixedTimeouts 测试混合超时配置
|
||||
func TestRedisMixedTimeouts(t *testing.T) {
|
||||
server := setupRedisServer(t)
|
||||
ctx := context.Background()
|
||||
|
||||
opts := &RedisOpts{
|
||||
Host: server.Addr(),
|
||||
Database: 0,
|
||||
DialTimeout: 5, // 正值
|
||||
ReadTimeout: -1, // 禁用
|
||||
WriteTimeout: 0, // 使用默认值
|
||||
PoolTimeout: 10, // 正值
|
||||
IdleTimeout: -1, // 禁用
|
||||
}
|
||||
r := NewRedis(ctx, opts)
|
||||
|
||||
client, ok := r.conn.(*redis.Client)
|
||||
if !ok {
|
||||
t.Fatal("无法转换为 *redis.Client")
|
||||
}
|
||||
|
||||
clientOpts := client.Options()
|
||||
if clientOpts.DialTimeout != 5*time.Second {
|
||||
t.Errorf("期望 DialTimeout = 5s, 实际 = %v", clientOpts.DialTimeout)
|
||||
}
|
||||
// ReadTimeout 设置为 -1,会被 go-redis 处理为 0(无超时)
|
||||
t.Logf("ReadTimeout = %v (设置为-1后的值)", clientOpts.ReadTimeout)
|
||||
|
||||
// WriteTimeout 设置为 0,应该使用 go-redis 的默认值
|
||||
// 默认值通常是 ReadTimeout 的值
|
||||
t.Logf("WriteTimeout = %v (设置为0后使用的默认值)", clientOpts.WriteTimeout)
|
||||
|
||||
if clientOpts.PoolTimeout != 10*time.Second {
|
||||
t.Errorf("期望 PoolTimeout = 10s, 实际 = %v", clientOpts.PoolTimeout)
|
||||
}
|
||||
|
||||
// IdleTimeout 设置为 -1,应该被设置为 -1ns(禁用空闲超时)
|
||||
if clientOpts.IdleTimeout != -1 {
|
||||
t.Errorf("期望 IdleTimeout = -1ns (禁用), 实际 = %v", clientOpts.IdleTimeout)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -7,6 +7,16 @@ type AccessTokenHandle interface {
|
||||
GetAccessToken() (accessToken string, err error)
|
||||
}
|
||||
|
||||
// AccessTokenCompatibleHandle 同时实现 AccessTokenHandle 和 AccessTokenContextHandle
|
||||
type AccessTokenCompatibleHandle struct {
|
||||
AccessTokenHandle
|
||||
}
|
||||
|
||||
// GetAccessTokenContext 获取access_token,先从cache中获取,没有则从服务端获取
|
||||
func (c AccessTokenCompatibleHandle) GetAccessTokenContext(_ context.Context) (accessToken string, err error) {
|
||||
return c.GetAccessToken()
|
||||
}
|
||||
|
||||
// AccessTokenContextHandle AccessToken 接口
|
||||
type AccessTokenContextHandle interface {
|
||||
AccessTokenHandle
|
||||
|
||||
@@ -12,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_"
|
||||
@@ -64,8 +66,11 @@ func (ak *DefaultAccessToken) GetAccessToken() (accessToken string, err error) {
|
||||
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
|
||||
@@ -74,42 +79,137 @@ func (ak *DefaultAccessToken) GetAccessTokenContext(ctx context.Context) (access
|
||||
|
||||
// 双检,防止重复从微信服务器获取
|
||||
if val := ak.cache.Get(accessTokenCacheKey); val != nil {
|
||||
return val.(string), nil
|
||||
if accessToken = val.(string); accessToken != "" {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// cache失效,从微信服务器获取
|
||||
var resAccessToken ResAccessToken
|
||||
resAccessToken, err = GetTokenFromServerContext(ctx, 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
|
||||
accessTokenLock *sync.Mutex
|
||||
}
|
||||
|
||||
// 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,
|
||||
accessTokenLock: new(sync.Mutex),
|
||||
}
|
||||
}
|
||||
|
||||
// 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 {
|
||||
if accessToken = val.(string); accessToken != "" {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// 加上lock,是为了防止在并发获取token时,cache刚好失效,导致从微信服务器上获取到不同token
|
||||
ak.accessTokenLock.Lock()
|
||||
defer ak.accessTokenLock.Unlock()
|
||||
|
||||
// 双检,防止重复从微信服务器获取
|
||||
if val := ak.cache.Get(accessTokenCacheKey); val != nil {
|
||||
if accessToken = val.(string); accessToken != "" {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// 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
|
||||
CorpSecret string
|
||||
AgentID string // 可选,用于区分不同应用
|
||||
cacheKeyPrefix string
|
||||
cache cache.Cache
|
||||
accessTokenLock *sync.Mutex
|
||||
}
|
||||
|
||||
// NewWorkAccessToken new WorkAccessToken
|
||||
func NewWorkAccessToken(corpID, corpSecret, cacheKeyPrefix string, cache cache.Cache) AccessTokenContextHandle {
|
||||
// NewWorkAccessToken new WorkAccessToken (保持向后兼容)
|
||||
func NewWorkAccessToken(corpID, corpSecret, agentID, cacheKeyPrefix string, cache cache.Cache) AccessTokenContextHandle {
|
||||
// 调用新方法,保持兼容性
|
||||
return NewWorkAccessTokenWithAgentID(corpID, corpSecret, agentID, cacheKeyPrefix, cache)
|
||||
}
|
||||
|
||||
// NewWorkAccessTokenWithAgentID new WorkAccessToken with agentID
|
||||
func NewWorkAccessTokenWithAgentID(corpID, corpSecret, agentID, cacheKeyPrefix string, cache cache.Cache) AccessTokenContextHandle {
|
||||
if cache == nil {
|
||||
panic("cache the not exist")
|
||||
panic("cache is needed")
|
||||
}
|
||||
return &WorkAccessToken{
|
||||
CorpID: corpID,
|
||||
CorpSecret: corpSecret,
|
||||
AgentID: agentID,
|
||||
cache: cache,
|
||||
cacheKeyPrefix: cacheKeyPrefix,
|
||||
accessTokenLock: new(sync.Mutex),
|
||||
@@ -126,7 +226,18 @@ func (ak *WorkAccessToken) GetAccessTokenContext(ctx context.Context) (accessTok
|
||||
// 加上lock,是为了防止在并发获取token时,cache刚好失效,导致从微信服务器上获取到不同token
|
||||
ak.accessTokenLock.Lock()
|
||||
defer ak.accessTokenLock.Unlock()
|
||||
accessTokenCacheKey := fmt.Sprintf("%s_access_token_%s", ak.cacheKeyPrefix, ak.CorpID)
|
||||
|
||||
// 构建缓存key
|
||||
var accessTokenCacheKey string
|
||||
|
||||
if ak.AgentID != "" {
|
||||
// 如果设置了AgentID,使用新的key格式
|
||||
accessTokenCacheKey = fmt.Sprintf("%s_access_token_%s_%s", ak.cacheKeyPrefix, ak.CorpID, ak.AgentID)
|
||||
} else {
|
||||
// 兼容历史版本的key格式
|
||||
accessTokenCacheKey = fmt.Sprintf("%s_access_token_%s", ak.cacheKeyPrefix, ak.CorpID)
|
||||
}
|
||||
|
||||
val := ak.cache.Get(accessTokenCacheKey)
|
||||
if val != nil {
|
||||
accessToken = val.(string)
|
||||
@@ -145,6 +256,7 @@ func (ak *WorkAccessToken) GetAccessTokenContext(ctx context.Context) (accessTok
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
accessToken = resAccessToken.AccessToken
|
||||
return
|
||||
}
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package credential
|
||||
|
||||
import (
|
||||
context2 "context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"sync"
|
||||
@@ -42,6 +43,16 @@ type ResTicket struct {
|
||||
|
||||
// GetTicket 获取jsapi_ticket
|
||||
func (js *DefaultJsTicket) GetTicket(accessToken string) (ticketStr string, err error) {
|
||||
return js.GetTicketContext(context2.Background(), accessToken)
|
||||
}
|
||||
|
||||
// GetTicketFromServer 从服务器中获取ticket
|
||||
func GetTicketFromServer(accessToken string) (ticket ResTicket, err error) {
|
||||
return GetTicketFromServerContext(context2.Background(), accessToken)
|
||||
}
|
||||
|
||||
// GetTicketContext 获取jsapi_ticket
|
||||
func (js *DefaultJsTicket) GetTicketContext(ctx context2.Context, accessToken string) (ticketStr string, err error) {
|
||||
// 先从cache中取
|
||||
jsAPITicketCacheKey := fmt.Sprintf("%s_jsapi_ticket_%s", js.cacheKeyPrefix, js.appID)
|
||||
if val := js.cache.Get(jsAPITicketCacheKey); val != nil {
|
||||
@@ -57,7 +68,7 @@ func (js *DefaultJsTicket) GetTicket(accessToken string) (ticketStr string, err
|
||||
}
|
||||
|
||||
var ticket ResTicket
|
||||
ticket, err = GetTicketFromServer(accessToken)
|
||||
ticket, err = GetTicketFromServerContext(ctx, accessToken)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
@@ -67,11 +78,11 @@ func (js *DefaultJsTicket) GetTicket(accessToken string) (ticketStr string, err
|
||||
return
|
||||
}
|
||||
|
||||
// GetTicketFromServer 从服务器中获取ticket
|
||||
func GetTicketFromServer(accessToken string) (ticket ResTicket, err error) {
|
||||
// GetTicketFromServerContext 从服务器中获取ticket
|
||||
func GetTicketFromServerContext(ctx context2.Context, accessToken string) (ticket ResTicket, err error) {
|
||||
var response []byte
|
||||
url := fmt.Sprintf(getTicketURL, accessToken)
|
||||
response, err = util.HTTPGet(url)
|
||||
response, err = util.HTTPGetContext(ctx, url)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
22
credential/default_js_ticket_test.go
Normal file
22
credential/default_js_ticket_test.go
Normal file
@@ -0,0 +1,22 @@
|
||||
package credential
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"gopkg.in/h2non/gock.v1"
|
||||
)
|
||||
|
||||
// TestGetTicketFromServerContext 测试 GetTicketFromServerContext 函数
|
||||
func TestGetTicketFromServerContext(t *testing.T) {
|
||||
defer gock.Off()
|
||||
gock.New(fmt.Sprintf(getTicketURL, "arg-ak")).Reply(200).JSON(&ResTicket{Ticket: "mock-ticket", ExpiresIn: 10})
|
||||
|
||||
ticket, err := GetTicketFromServerContext(context.Background(), "arg-ak")
|
||||
assert.Nil(t, err)
|
||||
assert.Equal(t, int64(0), ticket.ErrCode)
|
||||
assert.Equal(t, "mock-ticket", ticket.Ticket, "they should be equal")
|
||||
assert.Equal(t, int64(10), ticket.ExpiresIn, "they should be equal")
|
||||
}
|
||||
@@ -1,7 +1,15 @@
|
||||
package credential
|
||||
|
||||
import context2 "context"
|
||||
|
||||
// JsTicketHandle js ticket获取
|
||||
type JsTicketHandle interface {
|
||||
// GetTicket 获取ticket
|
||||
GetTicket(accessToken string) (ticket string, err error)
|
||||
}
|
||||
|
||||
// JsTicketContextHandle js ticket获取
|
||||
type JsTicketContextHandle interface {
|
||||
JsTicketHandle
|
||||
GetTicketContext(ctx context2.Context, accessToken string) (ticket string, err error)
|
||||
}
|
||||
|
||||
118
credential/work_js_ticket.go
Normal file
118
credential/work_js_ticket.go
Normal file
@@ -0,0 +1,118 @@
|
||||
package credential
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"github.com/silenceper/wechat/v2/cache"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
// TicketType ticket类型
|
||||
type TicketType int
|
||||
|
||||
const (
|
||||
// TicketTypeCorpJs 企业jsapi ticket
|
||||
TicketTypeCorpJs TicketType = iota
|
||||
// TicketTypeAgentJs 应用jsapi ticket
|
||||
TicketTypeAgentJs
|
||||
)
|
||||
|
||||
// 企业微信相关的 ticket URL
|
||||
const (
|
||||
// 企业微信 jsapi ticket
|
||||
getWorkJsTicketURL = "https://qyapi.weixin.qq.com/cgi-bin/get_jsapi_ticket?access_token=%s"
|
||||
// 企业微信应用 jsapi ticket
|
||||
getWorkAgentJsTicketURL = "https://qyapi.weixin.qq.com/cgi-bin/ticket/get?access_token=%s&type=agent_config"
|
||||
)
|
||||
|
||||
// WorkJsTicket 企业微信js ticket获取
|
||||
type WorkJsTicket struct {
|
||||
corpID string
|
||||
agentID string
|
||||
cacheKeyPrefix string
|
||||
cache cache.Cache
|
||||
jsAPITicketLock *sync.Mutex
|
||||
}
|
||||
|
||||
// NewWorkJsTicket new WorkJsTicket
|
||||
func NewWorkJsTicket(corpID, agentID, cacheKeyPrefix string, cache cache.Cache) *WorkJsTicket {
|
||||
return &WorkJsTicket{
|
||||
corpID: corpID,
|
||||
agentID: agentID,
|
||||
cache: cache,
|
||||
cacheKeyPrefix: cacheKeyPrefix,
|
||||
jsAPITicketLock: new(sync.Mutex),
|
||||
}
|
||||
}
|
||||
|
||||
// GetTicket 根据类型获取相应的jsapi_ticket
|
||||
func (js *WorkJsTicket) GetTicket(accessToken string, ticketType TicketType) (ticketStr string, err error) {
|
||||
var cacheKey string
|
||||
switch ticketType {
|
||||
case TicketTypeCorpJs:
|
||||
cacheKey = fmt.Sprintf("%s_corp_jsapi_ticket_%s", js.cacheKeyPrefix, js.corpID)
|
||||
case TicketTypeAgentJs:
|
||||
if js.agentID == "" {
|
||||
err = fmt.Errorf("agentID is empty")
|
||||
return
|
||||
}
|
||||
cacheKey = fmt.Sprintf("%s_agent_jsapi_ticket_%s_%s", js.cacheKeyPrefix, js.corpID, js.agentID)
|
||||
default:
|
||||
err = fmt.Errorf("unsupported ticket type: %v", ticketType)
|
||||
return
|
||||
}
|
||||
|
||||
if val := js.cache.Get(cacheKey); val != nil {
|
||||
return val.(string), nil
|
||||
}
|
||||
|
||||
js.jsAPITicketLock.Lock()
|
||||
defer js.jsAPITicketLock.Unlock()
|
||||
|
||||
// 双检,防止重复从微信服务器获取
|
||||
if val := js.cache.Get(cacheKey); val != nil {
|
||||
return val.(string), nil
|
||||
}
|
||||
|
||||
var ticket ResTicket
|
||||
ticket, err = js.getTicketFromServer(accessToken, ticketType)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
expires := ticket.ExpiresIn - 1500
|
||||
err = js.cache.Set(cacheKey, ticket.Ticket, time.Duration(expires)*time.Second)
|
||||
ticketStr = ticket.Ticket
|
||||
return
|
||||
}
|
||||
|
||||
// getTicketFromServer 从服务器中获取ticket
|
||||
func (js *WorkJsTicket) getTicketFromServer(accessToken string, ticketType TicketType) (ticket ResTicket, err error) {
|
||||
var url string
|
||||
switch ticketType {
|
||||
case TicketTypeCorpJs:
|
||||
url = fmt.Sprintf(getWorkJsTicketURL, accessToken)
|
||||
case TicketTypeAgentJs:
|
||||
url = fmt.Sprintf(getWorkAgentJsTicketURL, accessToken)
|
||||
default:
|
||||
err = fmt.Errorf("unsupported ticket type: %v", ticketType)
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
response, err = util.HTTPGet(url)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
err = json.Unmarshal(response, &ticket)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
if ticket.ErrCode != 0 {
|
||||
err = fmt.Errorf("getTicket Error : errcode=%d , errmsg=%s", ticket.ErrCode, ticket.ErrMsg)
|
||||
return
|
||||
}
|
||||
return
|
||||
}
|
||||
@@ -90,10 +90,12 @@ host: https://qyapi.weixin.qq.com/
|
||||
| 名称 | 请求方式 | 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)
|
||||
|
||||
@@ -116,5 +118,14 @@ host: https://qyapi.weixin.qq.com/
|
||||
| ---------------- | -------- | --------------------- | ---------- | -------------------------- | -------- |
|
||||
| 群机器人发送消息 | 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 对应的请求详情
|
||||
}
|
||||
1
go.mod
1
go.mod
@@ -3,6 +3,7 @@ module github.com/silenceper/wechat/v2
|
||||
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.5
|
||||
|
||||
7
go.sum
7
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=
|
||||
@@ -71,6 +75,8 @@ 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=
|
||||
@@ -89,6 +95,7 @@ golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJ
|
||||
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=
|
||||
|
||||
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)
|
||||
}
|
||||
|
||||
```
|
||||
@@ -30,6 +30,8 @@ const (
|
||||
getAnalysisVisitDistributionURL = "https://api.weixin.qq.com/datacube/getweanalysisappidvisitdistribution?access_token=%s"
|
||||
// 访问页面
|
||||
getAnalysisVisitPageURL = "https://api.weixin.qq.com/datacube/getweanalysisappidvisitpage?access_token=%s"
|
||||
// 获取小程序性能数据
|
||||
getPerformanceDataURL = "https://api.weixin.qq.com/wxa/business/performance/boot?access_token=%s"
|
||||
)
|
||||
|
||||
// Analysis analyis 数据分析
|
||||
@@ -315,3 +317,67 @@ func (analysis *Analysis) GetAnalysisVisitPage(beginDate, endDate string) (resul
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// GetPerformanceDataRequest 获取小程序性能数据请求
|
||||
type GetPerformanceDataRequest struct {
|
||||
Module string `json:"module"`
|
||||
Time PerformanceDataTime `json:"time"`
|
||||
Params []PerformanceDataParams `json:"params"`
|
||||
}
|
||||
|
||||
// PerformanceDataTime 获取小程序性能数据开始和结束日期
|
||||
type PerformanceDataTime struct {
|
||||
BeginTimestamp int64 `json:"begin_timestamp"`
|
||||
EndTimestamp int64 `json:"end_timestamp"`
|
||||
}
|
||||
|
||||
// PerformanceDataParams 获取小程序性能数据查询条件
|
||||
type PerformanceDataParams struct {
|
||||
Field string `json:"field"`
|
||||
Value string `json:"value"`
|
||||
}
|
||||
|
||||
// GetPerformanceDataResponse 获取小程序性能数据响应
|
||||
type GetPerformanceDataResponse struct {
|
||||
util.CommonError
|
||||
Body PerformanceDataBody `json:"body"`
|
||||
}
|
||||
|
||||
// PerformanceDataBody 性能数据
|
||||
type PerformanceDataBody struct {
|
||||
Tables []PerformanceDataTable `json:"tables"`
|
||||
Count int64 `json:"count"`
|
||||
}
|
||||
|
||||
// PerformanceDataTable 数据数组
|
||||
type PerformanceDataTable struct {
|
||||
ID string `json:"id"`
|
||||
Lines []PerformanceDataTableLine `json:"lines"`
|
||||
Zh string `json:"zh"`
|
||||
}
|
||||
|
||||
// PerformanceDataTableLine 按时间排列的性能数据
|
||||
type PerformanceDataTableLine struct {
|
||||
Fields []PerformanceDataTableLineField `json:"fields"`
|
||||
}
|
||||
|
||||
// PerformanceDataTableLineField 单天的性能数据
|
||||
type PerformanceDataTableLineField struct {
|
||||
RefDate string `json:"refdate"`
|
||||
Value string `json:"value"`
|
||||
}
|
||||
|
||||
// GetPerformanceData 获取小程序性能数据
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/data-analysis/others/getPerformanceData.html
|
||||
func (analysis *Analysis) GetPerformanceData(req *GetPerformanceDataRequest) (res GetPerformanceDataResponse, err error) {
|
||||
var accessToken string
|
||||
if accessToken, err = analysis.GetAccessToken(); err != nil {
|
||||
return
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(getPerformanceDataURL, accessToken), req); err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "GetPerformanceData")
|
||||
return
|
||||
}
|
||||
|
||||
@@ -10,11 +10,22 @@ import (
|
||||
)
|
||||
|
||||
const (
|
||||
// code2SessionURL 小程序登录
|
||||
code2SessionURL = "https://api.weixin.qq.com/sns/jscode2session?appid=%s&secret=%s&js_code=%s&grant_type=authorization_code"
|
||||
|
||||
// checkEncryptedDataURL 检查加密信息
|
||||
checkEncryptedDataURL = "https://api.weixin.qq.com/wxa/business/checkencryptedmsg?access_token=%s"
|
||||
|
||||
// getPhoneNumber 获取手机号
|
||||
getPhoneNumber = "https://api.weixin.qq.com/wxa/business/getuserphonenumber?access_token=%s"
|
||||
// checkSessionURL 检验登录态
|
||||
checkSessionURL = "https://api.weixin.qq.com/wxa/checksession?access_token=%s&signature=%s&openid=%s&sig_method=hmac_sha256"
|
||||
// resetUserSessionKeyURL 重置登录态
|
||||
resetUserSessionKeyURL = "https://api.weixin.qq.com/wxa/resetusersessionkey?access_token=%s&signature=%s&openid=%s&sig_method=hmac_sha256"
|
||||
// getPluginOpenPIDURL 获取插件用户openPID
|
||||
getPluginOpenPIDURL = "https://api.weixin.qq.com/wxa/getpluginopenpid?access_token=%s"
|
||||
// getPaidUnionIDURL 支付后获取 UnionID
|
||||
getPaidUnionIDURL = "https://api.weixin.qq.com/wxa/getpaidunionid"
|
||||
// getUserEncryptKeyURL 获取用户encryptKey
|
||||
getUserEncryptKeyURL = "https://api.weixin.qq.com/wxa/business/getuserencryptkey?access_token=%s&signature=%s&openid=%s&sig_method=hmac_sha256"
|
||||
)
|
||||
|
||||
// Auth 登录/用户信息
|
||||
@@ -40,8 +51,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 登录凭证校验。
|
||||
@@ -65,9 +76,45 @@ func (auth *Auth) Code2SessionContext(ctx context2.Context, jsCode string) (resu
|
||||
return
|
||||
}
|
||||
|
||||
type (
|
||||
// GetPaidUnionIDRequest 支付后获取UnionID请求
|
||||
GetPaidUnionIDRequest struct {
|
||||
OpenID string `json:"openid"`
|
||||
TransactionID string `json:"transaction_id,omitempty"`
|
||||
MchID string `json:"mch_id,omitempty"`
|
||||
OutTradeNo string `json:"out_trade_no,omitempty"`
|
||||
}
|
||||
|
||||
// GetPaidUnionIDResponse 支付后获取UnionID响应
|
||||
GetPaidUnionIDResponse struct {
|
||||
util.CommonError
|
||||
UnionID string `json:"unionid"`
|
||||
}
|
||||
)
|
||||
|
||||
// GetPaidUnionID 用户支付完成后,获取该用户的 UnionId,无需用户授权
|
||||
func (auth *Auth) GetPaidUnionID() {
|
||||
// TODO
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-info/basic-info/getPaidUnionid.html
|
||||
func (auth *Auth) GetPaidUnionID(req *GetPaidUnionIDRequest) (string, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = auth.GetAccessToken(); err != nil {
|
||||
return "", err
|
||||
}
|
||||
var url string
|
||||
if req.TransactionID != "" {
|
||||
url = fmt.Sprintf("%s?access_token=%s&openid=%s&transaction_id=%s", getPaidUnionIDURL, accessToken, req.OpenID, req.TransactionID)
|
||||
} else {
|
||||
url = fmt.Sprintf("%s?access_token=%s&openid=%s&mch_id=%s&out_trade_no=%s", getPaidUnionIDURL, accessToken, req.OpenID, req.MchID, req.OutTradeNo)
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(url); err != nil {
|
||||
return "", err
|
||||
}
|
||||
result := &GetPaidUnionIDResponse{}
|
||||
err = util.DecodeWithError(response, result, "GetPaidUnionID")
|
||||
return result.UnionID, err
|
||||
}
|
||||
|
||||
// CheckEncryptedData .检查加密信息是否由微信生成(当前只支持手机号加密数据),只能检测最近3天生成的加密数据
|
||||
@@ -81,7 +128,7 @@ func (auth *Auth) CheckEncryptedDataContext(ctx context2.Context, encryptedMsgHa
|
||||
var (
|
||||
at string
|
||||
)
|
||||
if at, err = auth.GetAccessToken(); err != nil {
|
||||
if at, err = auth.GetAccessTokenContext(ctx); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
@@ -120,7 +167,7 @@ func (auth *Auth) GetPhoneNumberContext(ctx context2.Context, code string) (*Get
|
||||
at string
|
||||
err error
|
||||
)
|
||||
if at, err = auth.GetAccessToken(); err != nil {
|
||||
if at, err = auth.GetAccessTokenContext(ctx); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
body := map[string]interface{}{
|
||||
@@ -138,13 +185,123 @@ func (auth *Auth) GetPhoneNumberContext(ctx context2.Context, code string) (*Get
|
||||
}
|
||||
|
||||
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)
|
||||
}
|
||||
|
||||
// CheckSession 检验登录态
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-login/checkSessionKey.html
|
||||
func (auth *Auth) CheckSession(signature, openID string) error {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = auth.GetAccessToken(); err != nil {
|
||||
return err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(checkSessionURL, accessToken, signature, openID)); err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "CheckSession")
|
||||
}
|
||||
|
||||
// ResetUserSessionKeyResponse 重置登录态响应
|
||||
type ResetUserSessionKeyResponse struct {
|
||||
util.CommonError
|
||||
OpenID string `json:"openid"`
|
||||
SessionKey string `json:"session_key"`
|
||||
}
|
||||
|
||||
// ResetUserSessionKey 重置登录态
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-login/ResetUserSessionKey.html
|
||||
func (auth *Auth) ResetUserSessionKey(signature, openID string) (*ResetUserSessionKeyResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = auth.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(resetUserSessionKeyURL, accessToken, signature, openID)); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &ResetUserSessionKeyResponse{}
|
||||
err = util.DecodeWithError(response, result, "ResetUserSessionKey")
|
||||
return result, err
|
||||
}
|
||||
|
||||
type (
|
||||
// GetPluginOpenPIDRequest 获取插件用户openPID请求
|
||||
GetPluginOpenPIDRequest struct {
|
||||
Code string `json:"code"`
|
||||
}
|
||||
|
||||
// GetPluginOpenPIDResponse 获取插件用户openPID响应
|
||||
GetPluginOpenPIDResponse struct {
|
||||
util.CommonError
|
||||
OpenPID string `json:"openpid"`
|
||||
}
|
||||
)
|
||||
|
||||
// GetPluginOpenPID 获取插件用户openPID
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-info/basic-info/getPluginOpenPId.html
|
||||
func (auth *Auth) GetPluginOpenPID(code string) (string, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = auth.GetAccessToken(); err != nil {
|
||||
return "", err
|
||||
}
|
||||
req := &GetPluginOpenPIDRequest{
|
||||
Code: code,
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(getPluginOpenPIDURL, accessToken), req); err != nil {
|
||||
return "", err
|
||||
}
|
||||
result := &GetPluginOpenPIDResponse{}
|
||||
err = util.DecodeWithError(response, result, "GetPluginOpenPID")
|
||||
return result.OpenPID, err
|
||||
}
|
||||
|
||||
// GetUserEncryptKeyResponse 获取用户encryptKey响应
|
||||
type GetUserEncryptKeyResponse struct {
|
||||
util.CommonError
|
||||
KeyInfoList []KeyInfo `json:"key_info_list"`
|
||||
}
|
||||
|
||||
// KeyInfo 用户最近三次的加密key
|
||||
type KeyInfo struct {
|
||||
EncryptKey string `json:"encrypt_key"`
|
||||
Version int64 `json:"version"`
|
||||
ExpireIn int64 `json:"expire_in"`
|
||||
Iv string `json:"iv"`
|
||||
CreateTime int64 `json:"create_time"`
|
||||
}
|
||||
|
||||
// GetUserEncryptKey 获取用户encryptKey
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-info/internet/getUserEncryptKey.html
|
||||
func (auth *Auth) GetUserEncryptKey(signature, openID string) (*GetUserEncryptKeyResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = auth.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(getUserEncryptKeyURL, accessToken, signature, openID)); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &GetUserEncryptKeyResponse{}
|
||||
err = util.DecodeWithError(response, result, "GetUserEncryptKey")
|
||||
return result, err
|
||||
}
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package business
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
@@ -28,13 +29,18 @@ type PhoneInfo struct {
|
||||
|
||||
// GetPhoneNumber code换取用户手机号。 每个code只能使用一次,code的有效期为5min
|
||||
func (business *Business) GetPhoneNumber(in *GetPhoneNumberRequest) (info PhoneInfo, err error) {
|
||||
accessToken, err := business.GetAccessToken()
|
||||
return business.GetPhoneNumberWithContext(context.Background(), in)
|
||||
}
|
||||
|
||||
// GetPhoneNumberWithContext 利用context将code换取用户手机号。 每个code只能使用一次,code的有效期为5min
|
||||
func (business *Business) GetPhoneNumberWithContext(ctx context.Context, in *GetPhoneNumberRequest) (info PhoneInfo, err error) {
|
||||
accessToken, err := business.GetAccessTokenContext(ctx)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(getPhoneNumberURL, accessToken)
|
||||
response, err := util.PostJSON(uri, in)
|
||||
response, err := util.PostJSONContext(ctx, uri, in)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
@@ -45,10 +51,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,12 @@ 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
|
||||
UseStableAK bool // use the stable access_token
|
||||
}
|
||||
|
||||
@@ -8,5 +8,5 @@ import (
|
||||
// Context struct
|
||||
type Context struct {
|
||||
*config.Config
|
||||
credential.AccessTokenHandle
|
||||
credential.AccessTokenContextHandle
|
||||
}
|
||||
|
||||
295
miniprogram/express/delivery.go
Normal file
295
miniprogram/express/delivery.go
Normal file
@@ -0,0 +1,295 @@
|
||||
package express
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
// 传运单接口,商户使用此接口向微信提供某交易单号对应的运单号。微信后台会跟踪运单的状态变化
|
||||
openMsgTraceWaybillURL = "https://api.weixin.qq.com/cgi-bin/express/delivery/open_msg/trace_waybill?access_token=%s"
|
||||
|
||||
// 查询运单接口,商户在调用完trace_waybill接口后,可以使用本接口查询到对应运单的详情信息
|
||||
openMsgQueryTraceURL = "https://api.weixin.qq.com/cgi-bin/express/delivery/open_msg/query_trace?access_token=%s"
|
||||
|
||||
// 更新物流信息,更新物品信息
|
||||
openMsgUpdateWaybillGoodsURL = "https://api.weixin.qq.com/cgi-bin/express/delivery/open_msg/update_waybill_goods?access_token=%s"
|
||||
|
||||
// 传运单接口,商户使用此接口向微信提供某交易单号对应的运单号。微信后台会跟踪运单的状态变化,在关键物流节点给下单用户推送消息通知
|
||||
openMsgFollowWaybillURL = "https://api.weixin.qq.com/cgi-bin/express/delivery/open_msg/follow_waybill?access_token=%s"
|
||||
|
||||
// 查运单接口,商户在调用完follow_waybill接口后,可以使用本接口查询到对应运单的详情信息
|
||||
openMsgQueryFollowTraceURL = "https://api.weixin.qq.com/cgi-bin/express/delivery/open_msg/query_follow_trace?access_token=%s"
|
||||
|
||||
// 更新物品信息接口
|
||||
openMsgUpdateFollowWaybillGoodsURL = "https://api.weixin.qq.com/cgi-bin/express/delivery/open_msg/update_follow_waybill_goods?access_token=%s"
|
||||
|
||||
// 获取运力id列表
|
||||
openMsgGetDeliveryListURL = "https://api.weixin.qq.com/cgi-bin/express/delivery/open_msg/get_delivery_list?access_token=%s"
|
||||
)
|
||||
|
||||
// TraceWaybill 传运单
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/express_search.html#_2-%E6%8E%A5%E5%8F%A3%E5%88%97%E8%A1%A8
|
||||
func (express *Express) TraceWaybill(ctx context.Context, in *TraceWaybillRequest) (res TraceWaybillResponse, err error) {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(openMsgTraceWaybillURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, in)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &res, "TraceWaybill")
|
||||
return
|
||||
}
|
||||
|
||||
// QueryTrace 查询运单详情信息
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/express_search.html#_2-%E6%8E%A5%E5%8F%A3%E5%88%97%E8%A1%A8
|
||||
func (express *Express) QueryTrace(ctx context.Context, in *QueryTraceRequest) (res QueryTraceResponse, err error) {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(openMsgQueryTraceURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, in)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &res, "QueryTrace")
|
||||
return
|
||||
}
|
||||
|
||||
// UpdateWaybillGoods 更新物品信息
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/express_search.html#_2-%E6%8E%A5%E5%8F%A3%E5%88%97%E8%A1%A8
|
||||
func (express *Express) UpdateWaybillGoods(ctx context.Context, in *UpdateWaybillGoodsRequest) (err error) {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(openMsgUpdateWaybillGoodsURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, in)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithCommonError(response, "UpdateWaybillGoods")
|
||||
return
|
||||
}
|
||||
|
||||
// FollowWaybill 传运单
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/express_open_msg.html#_4-1%E3%80%81%E4%BC%A0%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3-follow-waybill
|
||||
func (express *Express) FollowWaybill(ctx context.Context, in *FollowWaybillRequest) (res FollowWaybillResponse, err error) {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(openMsgFollowWaybillURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, in)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &res, "FollowWaybill")
|
||||
return
|
||||
}
|
||||
|
||||
// QueryFollowTrace 查询运单详情信息
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/express_open_msg.html#_4-2%E3%80%81%E6%9F%A5%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3-query-follow-trace
|
||||
func (express *Express) QueryFollowTrace(ctx context.Context, in *QueryFollowTraceRequest) (res QueryFollowTraceResponse, err error) {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(openMsgQueryFollowTraceURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, in)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &res, "QueryFollowTrace")
|
||||
return
|
||||
}
|
||||
|
||||
// UpdateFollowWaybillGoods 更新物品信息
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/express_open_msg.html#_4-3%E3%80%81%E6%9B%B4%E6%96%B0%E7%89%A9%E5%93%81%E4%BF%A1%E6%81%AF%E6%8E%A5%E5%8F%A3-update-follow-waybill-goods
|
||||
func (express *Express) UpdateFollowWaybillGoods(ctx context.Context, in *UpdateFollowWaybillGoodsRequest) (err error) {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(openMsgUpdateFollowWaybillGoodsURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, in)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithCommonError(response, "UpdateFollowWaybillGoods")
|
||||
return
|
||||
}
|
||||
|
||||
// GetDeliveryList 获取运力id列表
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/express_open_msg.html#_4-4%E8%8E%B7%E5%8F%96%E8%BF%90%E5%8A%9Bid%E5%88%97%E8%A1%A8get-delivery-list
|
||||
func (express *Express) GetDeliveryList(ctx context.Context) (res GetDeliveryListResponse, err error) {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(openMsgGetDeliveryListURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, map[string]interface{}{})
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &res, "GetDeliveryList")
|
||||
return
|
||||
}
|
||||
|
||||
// TraceWaybillRequest 传运单接口请求参数
|
||||
type TraceWaybillRequest struct {
|
||||
GoodsInfo FollowWaybillGoodsInfo `json:"goods_info"` // 必选,商品信息
|
||||
Openid string `json:"openid"` // 必选,用户openid
|
||||
SenderPhone string `json:"sender_phone"` // 寄件人手机号
|
||||
ReceiverPhone string `json:"receiver_phone"` // 必选,收件人手机号,部分运力需要用户手机号作为查单依据
|
||||
DeliveryID string `json:"delivery_id"` // 运力id(运单号所属运力公司id)
|
||||
WaybillID string `json:"waybill_id"` // 必选,运单号
|
||||
TransID string `json:"trans_id"` // 必选,交易单号(微信支付生成的交易单号,一般以420开头)
|
||||
OrderDetailPath string `json:"order_detail_path"` // 订单详情页地址
|
||||
|
||||
}
|
||||
|
||||
// TraceWaybillResponse 传运单接口返回参数
|
||||
type TraceWaybillResponse struct {
|
||||
util.CommonError
|
||||
WaybillToken string `json:"waybill_token"` // 查询id
|
||||
}
|
||||
|
||||
// QueryTraceRequest 查询运单详情接口请求参数
|
||||
type QueryTraceRequest struct {
|
||||
WaybillToken string `json:"waybill_token"` // 必选,查询id
|
||||
}
|
||||
|
||||
// QueryTraceResponse 查询运单详情接口返回参数
|
||||
type QueryTraceResponse struct {
|
||||
util.CommonError
|
||||
WaybillInfo FlowWaybillInfo `json:"waybill_info"` // 运单信息
|
||||
ShopInfo FollowWaybillShopInfo `json:"shop_info"` // 商品信息
|
||||
DeliveryInfo FlowWaybillDeliveryInfo `json:"delivery_info"` // 运力信息
|
||||
}
|
||||
|
||||
// UpdateWaybillGoodsRequest 更新物品信息接口请求参数
|
||||
type UpdateWaybillGoodsRequest struct {
|
||||
WaybillToken string `json:"waybill_token"` // 必选,查询id
|
||||
GoodsInfo FollowWaybillGoodsInfo `json:"goods_info"` // 必选,商品信息
|
||||
}
|
||||
|
||||
// FollowWaybillRequest 传运单接口请求参数
|
||||
type FollowWaybillRequest struct {
|
||||
GoodsInfo FollowWaybillGoodsInfo `json:"goods_info"` // 必选,商品信息
|
||||
Openid string `json:"openid"` // 必选,用户openid
|
||||
SenderPhone string `json:"sender_phone"` // 寄件人手机号
|
||||
ReceiverPhone string `json:"receiver_phone"` // 必选,收件人手机号,部分运力需要用户手机号作为查单依据
|
||||
DeliveryID string `json:"delivery_id"` // 运力id(运单号所属运力公司id)
|
||||
WaybillID string `json:"waybill_id"` // 必选,运单号
|
||||
TransID string `json:"trans_id"` // 必选,交易单号(微信支付生成的交易单号,一般以420开头)
|
||||
OrderDetailPath string `json:"order_detail_path"` // 订单详情页地址
|
||||
}
|
||||
|
||||
// FollowWaybillGoodsInfo 商品信息
|
||||
type FollowWaybillGoodsInfo struct {
|
||||
DetailList []FollowWaybillGoodsInfoItem `json:"detail_list"`
|
||||
}
|
||||
|
||||
// FollowWaybillShopInfo 商品信息
|
||||
type FollowWaybillShopInfo struct {
|
||||
GoodsInfo FollowWaybillGoodsInfo `json:"goods_info"` // 商品信息
|
||||
}
|
||||
|
||||
// FollowWaybillGoodsInfoItem 商品信息详情
|
||||
type FollowWaybillGoodsInfoItem struct {
|
||||
GoodsName string `json:"goods_name"` // 必选,商品名称(最大长度为utf-8编码下的60个字符)
|
||||
GoodsImgURL string `json:"goods_img_url"` // 必选,商品图片url
|
||||
GoodsDesc string `json:"goods_desc,omitempty"` // 商品详情描述,不传默认取“商品名称”值,最多40汉字
|
||||
}
|
||||
|
||||
// FollowWaybillResponse 传运单接口返回参数
|
||||
type FollowWaybillResponse struct {
|
||||
util.CommonError
|
||||
WaybillToken string `json:"waybill_token"` // 查询id
|
||||
}
|
||||
|
||||
// QueryFollowTraceRequest 查询运单详情信息请求参数
|
||||
type QueryFollowTraceRequest struct {
|
||||
WaybillToken string `json:"waybill_token"` // 必选,查询id
|
||||
}
|
||||
|
||||
// QueryFollowTraceResponse 查询运单详情信息返回参数
|
||||
type QueryFollowTraceResponse struct {
|
||||
util.CommonError
|
||||
WaybillInfo FlowWaybillInfo `json:"waybill_info"` // 运单信息
|
||||
ShopInfo FollowWaybillShopInfo `json:"shop_info"` // 商品信息
|
||||
DeliveryInfo FlowWaybillDeliveryInfo `json:"delivery_info"` // 运力信息
|
||||
}
|
||||
|
||||
// FlowWaybillInfo 运单信息
|
||||
type FlowWaybillInfo struct {
|
||||
WaybillID string `json:"waybill_id"` // 运单号
|
||||
Status WaybillStatus `json:"status"` // 运单状态
|
||||
}
|
||||
|
||||
// UpdateFollowWaybillGoodsRequest 修改运单商品信息请求参数
|
||||
type UpdateFollowWaybillGoodsRequest struct {
|
||||
WaybillToken string `json:"waybill_token"` // 必选,查询id
|
||||
GoodsInfo FollowWaybillGoodsInfo `json:"goods_info"` // 必选,商品信息
|
||||
}
|
||||
|
||||
// GetDeliveryListResponse 获取运力id列表返回参数
|
||||
type GetDeliveryListResponse struct {
|
||||
util.CommonError
|
||||
DeliveryList []FlowWaybillDeliveryInfo `json:"delivery_list"` // 运力公司列表
|
||||
Count int `json:"count"` // 运力公司个数
|
||||
}
|
||||
|
||||
// FlowWaybillDeliveryInfo 运力公司信息
|
||||
type FlowWaybillDeliveryInfo struct {
|
||||
DeliveryID string `json:"delivery_id"` // 运力公司id
|
||||
DeliveryName string `json:"delivery_name"` // 运力公司名称
|
||||
}
|
||||
|
||||
// WaybillStatus 运单状态
|
||||
type WaybillStatus int
|
||||
|
||||
const (
|
||||
// WaybillStatusNotExist 运单不存在或者未揽收
|
||||
WaybillStatusNotExist WaybillStatus = iota
|
||||
// WaybillStatusPicked 已揽件
|
||||
WaybillStatusPicked
|
||||
// WaybillStatusTransporting 运输中
|
||||
WaybillStatusTransporting
|
||||
// WaybillStatusDispatching 派件中
|
||||
WaybillStatusDispatching
|
||||
// WaybillStatusSigned 已签收
|
||||
WaybillStatusSigned
|
||||
// WaybillStatusException 异常
|
||||
WaybillStatusException
|
||||
// WaybillStatusSignedByOthers 代签收
|
||||
WaybillStatusSignedByOthers
|
||||
)
|
||||
16
miniprogram/express/express.go
Normal file
16
miniprogram/express/express.go
Normal file
@@ -0,0 +1,16 @@
|
||||
package express
|
||||
|
||||
import (
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
)
|
||||
|
||||
// Express 微信物流服务
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/introduction.html
|
||||
type Express struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewExpress init
|
||||
func NewExpress(ctx *context.Context) *Express {
|
||||
return &Express{ctx}
|
||||
}
|
||||
618
miniprogram/express/intracity.go
Normal file
618
miniprogram/express/intracity.go
Normal file
@@ -0,0 +1,618 @@
|
||||
package express
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
// 同城配送 API URL
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/intracity_service.html
|
||||
const (
|
||||
// 开通门店权限
|
||||
intracityApplyURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/apply?access_token=%s"
|
||||
// 创建门店
|
||||
intracityCreateStoreURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/createstore?access_token=%s"
|
||||
// 查询门店
|
||||
intracityQueryStoreURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/querystore?access_token=%s"
|
||||
// 更新门店
|
||||
intracityUpdateStoreURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/updatestore?access_token=%s"
|
||||
// 门店运费充值
|
||||
intracityStoreChargeURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/storecharge?access_token=%s"
|
||||
// 门店运费退款
|
||||
intracityStoreRefundURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/storerefund?access_token=%s"
|
||||
// 门店运费流水查询
|
||||
intracityQueryFlowURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/queryflow?access_token=%s"
|
||||
// 门店余额查询
|
||||
intracityBalanceQueryURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/balancequery?access_token=%s"
|
||||
// 预下配送单(查询运费)
|
||||
intracityPreAddOrderURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/preaddorder?access_token=%s"
|
||||
// 创建配送单
|
||||
intracityAddOrderURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/addorder?access_token=%s"
|
||||
// 查询配送单
|
||||
intracityQueryOrderURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/queryorder?access_token=%s"
|
||||
// 取消配送单
|
||||
intracityCancelOrderURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/cancelorder?access_token=%s"
|
||||
// 模拟配送回调(仅用于测试)
|
||||
intracityMockNotifyURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/mocknotify?access_token=%s"
|
||||
)
|
||||
|
||||
// PayMode 充值/扣费主体
|
||||
type PayMode string
|
||||
|
||||
const (
|
||||
// PayModeStore 门店
|
||||
PayModeStore PayMode = "PAY_MODE_STORE"
|
||||
// PayModeApp 小程序
|
||||
PayModeApp PayMode = "PAY_MODE_APP"
|
||||
// PayModeComponent 服务商
|
||||
PayModeComponent PayMode = "PAY_MODE_COMPONENT"
|
||||
)
|
||||
|
||||
// OrderPattern 运力偏好
|
||||
type OrderPattern uint32
|
||||
|
||||
const (
|
||||
// OrderPatternPriceFirst 价格优先
|
||||
OrderPatternPriceFirst OrderPattern = 1
|
||||
// OrderPatternTransFirst 运力优先
|
||||
OrderPatternTransFirst OrderPattern = 2
|
||||
)
|
||||
|
||||
// FlowType 流水类型
|
||||
type FlowType uint32
|
||||
|
||||
const (
|
||||
// FlowTypeCharge 充值流水
|
||||
FlowTypeCharge FlowType = 1
|
||||
// FlowTypeConsume 消费流水
|
||||
FlowTypeConsume FlowType = 2
|
||||
// FlowTypeRefund 退款流水
|
||||
FlowTypeRefund FlowType = 3
|
||||
)
|
||||
|
||||
// IntracityDeliveryStatus 配送单状态
|
||||
type IntracityDeliveryStatus int32
|
||||
|
||||
const (
|
||||
// IntracityDeliveryStatusReady 配送单待接单
|
||||
IntracityDeliveryStatusReady IntracityDeliveryStatus = 100
|
||||
// IntracityDeliveryStatusPickedUp 配送单待取货
|
||||
IntracityDeliveryStatusPickedUp IntracityDeliveryStatus = 101
|
||||
// IntracityDeliveryStatusOngoing 配送单配送中
|
||||
IntracityDeliveryStatusOngoing IntracityDeliveryStatus = 102
|
||||
// IntracityDeliveryStatusFinished 配送单已送达
|
||||
IntracityDeliveryStatusFinished IntracityDeliveryStatus = 200
|
||||
// IntracityDeliveryStatusCancelled 配送单已取消
|
||||
IntracityDeliveryStatusCancelled IntracityDeliveryStatus = 300
|
||||
// IntracityDeliveryStatusAbnormal 配送单异常
|
||||
IntracityDeliveryStatusAbnormal IntracityDeliveryStatus = 400
|
||||
)
|
||||
|
||||
// IntracityAddressInfo 门店地址信息
|
||||
type IntracityAddressInfo struct {
|
||||
Province string `json:"province"` // 省/自治区/直辖市
|
||||
City string `json:"city"` // 地级市
|
||||
Area string `json:"area"` // 县/县级市/区
|
||||
Street string `json:"street"` // 街道
|
||||
House string `json:"house"` // 具体门牌号或详细地址
|
||||
Lat float64 `json:"lat"` // 门店所在地纬度
|
||||
Lng float64 `json:"lng"` // 门店所在地经度
|
||||
Phone string `json:"phone"` // 门店联系电话
|
||||
Name string `json:"name,omitempty"` // 联系人姓名(收货地址时使用)
|
||||
}
|
||||
|
||||
// IntracityStoreInfo 门店信息
|
||||
type IntracityStoreInfo struct {
|
||||
WxStoreID string `json:"wx_store_id"` // 微信门店编号
|
||||
OutStoreID string `json:"out_store_id"` // 自定义门店编号
|
||||
CityID string `json:"city_id"` // 门店所在城市ID
|
||||
StoreName string `json:"store_name"` // 门店名称
|
||||
OrderPattern OrderPattern `json:"order_pattern"` // 运力偏好
|
||||
ServiceTransPrefer string `json:"service_trans_prefer"` // 优先使用的运力ID
|
||||
AddressInfo IntracityAddressInfo `json:"address_info"` // 门店地址信息
|
||||
}
|
||||
|
||||
// ============ 门店管理接口 ============
|
||||
|
||||
// IntracityApply 开通门店权限
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/intracity_service.html
|
||||
func (express *Express) IntracityApply(ctx context.Context) error {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(intracityApplyURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, map[string]interface{}{})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return util.DecodeWithCommonError(response, "IntracityApply")
|
||||
}
|
||||
|
||||
// CreateStoreRequest 创建门店请求参数
|
||||
type CreateStoreRequest struct {
|
||||
OutStoreID string `json:"out_store_id"` // 自定义门店编号
|
||||
StoreName string `json:"store_name"` // 门店名称
|
||||
OrderPattern OrderPattern `json:"order_pattern,omitempty"` // 运力偏好:1-价格优先,2-运力优先
|
||||
ServiceTransPrefer string `json:"service_trans_prefer,omitempty"` // 优先使用的运力ID,order_pattern=2时必填
|
||||
AddressInfo IntracityAddressInfo `json:"address_info"` // 门店地址信息
|
||||
}
|
||||
|
||||
// CreateStoreResponse 创建门店返回参数
|
||||
type CreateStoreResponse struct {
|
||||
util.CommonError
|
||||
WxStoreID string `json:"wx_store_id"` // 微信门店编号
|
||||
AppID string `json:"appid"` // 小程序appid
|
||||
OutStoreID string `json:"out_store_id"` // 自定义门店ID
|
||||
}
|
||||
|
||||
// IntracityCreateStore 创建门店
|
||||
func (express *Express) IntracityCreateStore(ctx context.Context, req *CreateStoreRequest) (res CreateStoreResponse, err error) {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(intracityCreateStoreURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &res, "IntracityCreateStore")
|
||||
return
|
||||
}
|
||||
|
||||
// QueryStoreRequest 查询门店请求参数
|
||||
type QueryStoreRequest struct {
|
||||
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号
|
||||
OutStoreID string `json:"out_store_id,omitempty"` // 自定义门店编号
|
||||
}
|
||||
|
||||
// QueryStoreResponse 查询门店返回参数
|
||||
type QueryStoreResponse struct {
|
||||
util.CommonError
|
||||
Total uint32 `json:"total"` // 符合条件的门店总数
|
||||
AppID string `json:"appid"` // 小程序appid
|
||||
StoreList []IntracityStoreInfo `json:"store_list"` // 门店信息列表
|
||||
}
|
||||
|
||||
// IntracityQueryStore 查询门店
|
||||
func (express *Express) IntracityQueryStore(ctx context.Context, req *QueryStoreRequest) (res QueryStoreResponse, err error) {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(intracityQueryStoreURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &res, "IntracityQueryStore")
|
||||
return
|
||||
}
|
||||
|
||||
// UpdateStoreKeyInfo 更新门店的key信息
|
||||
type UpdateStoreKeyInfo struct {
|
||||
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号
|
||||
OutStoreID string `json:"out_store_id,omitempty"` // 自定义门店编号,二选一
|
||||
}
|
||||
|
||||
// UpdateStoreContent 更新门店的内容
|
||||
type UpdateStoreContent struct {
|
||||
StoreName string `json:"store_name,omitempty"` // 门店名称
|
||||
OrderPattern OrderPattern `json:"order_pattern,omitempty"` // 运力偏好
|
||||
ServiceTransPrefer string `json:"service_trans_prefer,omitempty"` // 优先使用的运力ID
|
||||
AddressInfo *IntracityAddressInfo `json:"address_info,omitempty"` // 门店地址信息
|
||||
}
|
||||
|
||||
// UpdateStoreRequest 更新门店请求参数
|
||||
type UpdateStoreRequest struct {
|
||||
Keys UpdateStoreKeyInfo `json:"keys"` // 门店编号
|
||||
Content UpdateStoreContent `json:"content"` // 更新内容
|
||||
}
|
||||
|
||||
// IntracityUpdateStore 更新门店
|
||||
func (express *Express) IntracityUpdateStore(ctx context.Context, req *UpdateStoreRequest) error {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(intracityUpdateStoreURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, req)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return util.DecodeWithCommonError(response, "IntracityUpdateStore")
|
||||
}
|
||||
|
||||
// ============ 充值退款接口 ============
|
||||
|
||||
// StoreChargeRequest 门店运费充值请求参数
|
||||
type StoreChargeRequest struct {
|
||||
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号,pay_mode=PAY_MODE_STORE时必传
|
||||
ServiceTransID string `json:"service_trans_id"` // 运力ID
|
||||
Amount uint32 `json:"amount"` // 充值金额,单位:分,50元起充
|
||||
PayMode PayMode `json:"pay_mode,omitempty"` // 充值主体
|
||||
}
|
||||
|
||||
// StoreChargeResponse 门店运费充值返回参数
|
||||
type StoreChargeResponse struct {
|
||||
util.CommonError
|
||||
PayURL string `json:"payurl"` // 充值页面地址
|
||||
AppID string `json:"appid"` // 小程序appid
|
||||
WxStoreID string `json:"wx_store_id"` // 微信门店编号
|
||||
}
|
||||
|
||||
// IntracityStoreCharge 门店运费充值
|
||||
func (express *Express) IntracityStoreCharge(ctx context.Context, req *StoreChargeRequest) (res StoreChargeResponse, err error) {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(intracityStoreChargeURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &res, "IntracityStoreCharge")
|
||||
return
|
||||
}
|
||||
|
||||
// StoreRefundRequest 门店运费退款请求参数
|
||||
type StoreRefundRequest struct {
|
||||
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号
|
||||
PayMode PayMode `json:"pay_mode,omitempty"` // 充值/扣费主体
|
||||
ServiceTransID string `json:"service_trans_id"` // 运力ID
|
||||
}
|
||||
|
||||
// StoreRefundResponse 门店运费退款返回参数
|
||||
type StoreRefundResponse struct {
|
||||
util.CommonError
|
||||
AppID string `json:"appid"` // 小程序appid
|
||||
WxStoreID string `json:"wx_store_id"` // 微信门店编号
|
||||
RefundAmount uint32 `json:"refund_amount"` // 退款金额,单位:分
|
||||
}
|
||||
|
||||
// IntracityStoreRefund 门店运费退款
|
||||
func (express *Express) IntracityStoreRefund(ctx context.Context, req *StoreRefundRequest) (res StoreRefundResponse, err error) {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(intracityStoreRefundURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &res, "IntracityStoreRefund")
|
||||
return
|
||||
}
|
||||
|
||||
// QueryFlowRequest 门店运费流水查询请求参数
|
||||
type QueryFlowRequest struct {
|
||||
WxStoreID string `json:"wx_store_id"` // 微信门店编号
|
||||
FlowType FlowType `json:"flow_type"` // 流水类型:1-充值,2-消费,3-退款
|
||||
ServiceTransID string `json:"service_trans_id,omitempty"` // 运力ID
|
||||
BeginTime uint32 `json:"begin_time,omitempty"` // 开始时间戳
|
||||
EndTime uint32 `json:"end_time,omitempty"` // 结束时间戳
|
||||
PayMode PayMode `json:"pay_mode"` // 扣费主体
|
||||
}
|
||||
|
||||
// FlowRecordInfo 流水记录信息
|
||||
type FlowRecordInfo struct {
|
||||
FlowType FlowType `json:"flow_type"` // 流水类型
|
||||
AppID string `json:"appid"` // appid
|
||||
WxStoreID string `json:"wx_store_id"` // 微信门店ID
|
||||
PayOrderID uint64 `json:"pay_order_id,omitempty"` // 充值订单号
|
||||
WxOrderID string `json:"wx_order_id,omitempty"` // 订单ID(消费流水)
|
||||
ServiceTransID string `json:"service_trans_id"` // 运力ID
|
||||
OpenID string `json:"openid,omitempty"` // 用户openid(消费流水)
|
||||
DeliveryStatus int32 `json:"delivery_status,omitempty"` // 运单状态(消费流水)
|
||||
PayAmount int32 `json:"pay_amount"` // 支付金额,单位:分
|
||||
PayTime uint32 `json:"pay_time,omitempty"` // 支付时间
|
||||
PayStatus string `json:"pay_status,omitempty"` // 支付状态
|
||||
RefundStatus string `json:"refund_status,omitempty"` // 退款状态
|
||||
RefundAmount int32 `json:"refund_amount,omitempty"` // 退款金额
|
||||
RefundTime uint32 `json:"refund_time,omitempty"` // 退款时间
|
||||
DeductAmount int32 `json:"deduct_amount,omitempty"` // 扣除违约金
|
||||
CreateTime uint32 `json:"create_time"` // 创建时间
|
||||
ConsumeDeadline uint32 `json:"consume_deadline,omitempty"` // 有效截止日期
|
||||
BillID string `json:"bill_id,omitempty"` // 运单ID
|
||||
DeliveryFinishedTime uint32 `json:"delivery_finished_time,omitempty"` // 运单完成配送的时间
|
||||
}
|
||||
|
||||
// QueryFlowResponse 门店运费流水查询返回参数
|
||||
type QueryFlowResponse struct {
|
||||
util.CommonError
|
||||
Total uint32 `json:"total"` // 总数
|
||||
FlowList []FlowRecordInfo `json:"flow_list"` // 流水数组
|
||||
TotalPayAmt int `json:"total_pay_amt"` // 总支付金额
|
||||
TotalRefundAmt int `json:"total_refund_amt"` // 总退款金额
|
||||
TotalDeductAmt int `json:"total_deduct_amt"` // 总违约金(消费流水返回)
|
||||
}
|
||||
|
||||
// IntracityQueryFlow 门店运费流水查询
|
||||
func (express *Express) IntracityQueryFlow(ctx context.Context, req *QueryFlowRequest) (res QueryFlowResponse, err error) {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(intracityQueryFlowURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &res, "IntracityQueryFlow")
|
||||
return
|
||||
}
|
||||
|
||||
// BalanceQueryRequest 门店余额查询请求参数
|
||||
type BalanceQueryRequest struct {
|
||||
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号
|
||||
ServiceTransID string `json:"service_trans_id,omitempty"` // 运力ID
|
||||
PayMode PayMode `json:"pay_mode,omitempty"` // 充值/扣费主体
|
||||
}
|
||||
|
||||
// BalanceInfo 余额信息
|
||||
type BalanceInfo struct {
|
||||
ServiceTransID string `json:"service_trans_id"` // 运力ID
|
||||
Balance int32 `json:"balance"` // 余额,单位:分
|
||||
}
|
||||
|
||||
// BalanceQueryResponse 门店余额查询返回参数
|
||||
type BalanceQueryResponse struct {
|
||||
util.CommonError
|
||||
AppID string `json:"appid"` // 小程序appid
|
||||
WxStoreID string `json:"wx_store_id"` // 微信门店编号
|
||||
BalanceList []BalanceInfo `json:"balance_list"` // 余额列表
|
||||
}
|
||||
|
||||
// IntracityBalanceQuery 门店余额查询
|
||||
func (express *Express) IntracityBalanceQuery(ctx context.Context, req *BalanceQueryRequest) (res BalanceQueryResponse, err error) {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(intracityBalanceQueryURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &res, "IntracityBalanceQuery")
|
||||
return
|
||||
}
|
||||
|
||||
// ============ 配送订单接口 ============
|
||||
|
||||
// CargoInfo 货物信息
|
||||
type CargoInfo struct {
|
||||
Name string `json:"name"` // 货物名称
|
||||
Num uint32 `json:"num,omitempty"` // 货物数量
|
||||
Price uint32 `json:"price,omitempty"` // 货物价格,单位:分
|
||||
Weight uint32 `json:"weight,omitempty"` // 货物重量,单位:克
|
||||
}
|
||||
|
||||
// PreAddOrderRequest 预下配送单请求参数
|
||||
type PreAddOrderRequest struct {
|
||||
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号,二选一
|
||||
OutStoreID string `json:"out_store_id,omitempty"` // 自定义门店编号,二选一
|
||||
UserOpenID string `json:"user_openid"` // 用户openid
|
||||
UserPhone string `json:"user_phone,omitempty"` // 用户联系电话
|
||||
UserName string `json:"user_name,omitempty"` // 用户姓名
|
||||
UserLat float64 `json:"user_lat"` // 用户地址纬度
|
||||
UserLng float64 `json:"user_lng"` // 用户地址经度
|
||||
UserAddress string `json:"user_address"` // 用户详细地址
|
||||
ServiceTransID string `json:"service_trans_id,omitempty"` // 运力ID,不传则查询所有运力
|
||||
PayMode PayMode `json:"pay_mode,omitempty"` // 充值/扣费主体
|
||||
CargoInfo *CargoInfo `json:"cargo_info,omitempty"` // 货物信息
|
||||
}
|
||||
|
||||
// TransInfo 运力信息
|
||||
type TransInfo struct {
|
||||
ServiceTransID string `json:"service_trans_id"` // 运力ID
|
||||
ServiceName string `json:"service_name"` // 运力名称
|
||||
Price uint32 `json:"price"` // 配送费用,单位:分
|
||||
Distance uint32 `json:"distance"` // 配送距离,单位:米
|
||||
Errcode int `json:"errcode"` // 错误码,0表示成功
|
||||
Errmsg string `json:"errmsg"` // 错误信息
|
||||
}
|
||||
|
||||
// PreAddOrderResponse 预下配送单返回参数
|
||||
type PreAddOrderResponse struct {
|
||||
util.CommonError
|
||||
WxStoreID string `json:"wx_store_id"` // 微信门店编号
|
||||
AppID string `json:"appid"` // 小程序appid
|
||||
TransList []TransInfo `json:"trans_list"` // 运力列表
|
||||
}
|
||||
|
||||
// IntracityPreAddOrder 预下配送单(查询运费)
|
||||
func (express *Express) IntracityPreAddOrder(ctx context.Context, req *PreAddOrderRequest) (res PreAddOrderResponse, err error) {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(intracityPreAddOrderURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &res, "IntracityPreAddOrder")
|
||||
return
|
||||
}
|
||||
|
||||
// AddOrderRequest 创建配送单请求参数
|
||||
type AddOrderRequest struct {
|
||||
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号,二选一
|
||||
OutStoreID string `json:"out_store_id,omitempty"` // 自定义门店编号,二选一
|
||||
OutOrderID string `json:"out_order_id"` // 自定义订单号,需唯一
|
||||
ServiceTransID string `json:"service_trans_id,omitempty"` // 运力ID
|
||||
UserOpenID string `json:"user_openid"` // 用户openid
|
||||
UserPhone string `json:"user_phone"` // 用户联系电话
|
||||
UserName string `json:"user_name"` // 用户姓名
|
||||
UserLat float64 `json:"user_lat"` // 用户地址纬度
|
||||
UserLng float64 `json:"user_lng"` // 用户地址经度
|
||||
UserAddress string `json:"user_address"` // 用户详细地址
|
||||
PayMode PayMode `json:"pay_mode,omitempty"` // 充值/扣费主体
|
||||
CargoInfo *CargoInfo `json:"cargo_info,omitempty"` // 货物信息
|
||||
OrderDetailPath string `json:"order_detail_path,omitempty"` // 订单详情页路径
|
||||
CallbackURL string `json:"callback_url,omitempty"` // 配送状态回调URL
|
||||
UseInsurance uint32 `json:"use_insurance,omitempty"` // 是否使用保价:0-不使用,1-使用
|
||||
InsuranceValue uint32 `json:"insurance_value,omitempty"` // 保价金额,单位:分
|
||||
ExpectTime uint32 `json:"expect_time,omitempty"` // 期望送达时间戳
|
||||
Remark string `json:"remark,omitempty"` // 备注
|
||||
}
|
||||
|
||||
// AddOrderResponse 创建配送单返回参数
|
||||
type AddOrderResponse struct {
|
||||
util.CommonError
|
||||
WxOrderID string `json:"wx_order_id"` // 微信订单号
|
||||
AppID string `json:"appid"` // 小程序appid
|
||||
WxStoreID string `json:"wx_store_id"` // 微信门店编号
|
||||
OutOrderID string `json:"out_order_id"` // 自定义订单号
|
||||
ServiceTransID string `json:"service_trans_id"` // 运力ID
|
||||
BillID string `json:"bill_id"` // 运力订单号
|
||||
Price uint32 `json:"price"` // 配送费用,单位:分
|
||||
Distance uint32 `json:"distance"` // 配送距离,单位:米
|
||||
}
|
||||
|
||||
// IntracityAddOrder 创建配送单
|
||||
func (express *Express) IntracityAddOrder(ctx context.Context, req *AddOrderRequest) (res AddOrderResponse, err error) {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(intracityAddOrderURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &res, "IntracityAddOrder")
|
||||
return
|
||||
}
|
||||
|
||||
// QueryOrderRequest 查询配送单请求参数
|
||||
type QueryOrderRequest struct {
|
||||
WxOrderID string `json:"wx_order_id,omitempty"` // 微信订单号,二选一
|
||||
OutOrderID string `json:"out_order_id,omitempty"` // 自定义订单号,二选一
|
||||
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号
|
||||
OutStoreID string `json:"out_store_id,omitempty"` // 自定义门店编号
|
||||
}
|
||||
|
||||
// RiderInfo 骑手信息
|
||||
type RiderInfo struct {
|
||||
Name string `json:"name"` // 骑手姓名
|
||||
Phone string `json:"phone"` // 骑手电话
|
||||
RiderCode string `json:"rider_code"` // 骑手编号
|
||||
RiderImgURL string `json:"rider_img_url"` // 骑手头像URL
|
||||
}
|
||||
|
||||
// QueryOrderResponse 查询配送单返回参数
|
||||
type QueryOrderResponse struct {
|
||||
util.CommonError
|
||||
WxOrderID string `json:"wx_order_id"` // 微信订单号
|
||||
AppID string `json:"appid"` // 小程序appid
|
||||
WxStoreID string `json:"wx_store_id"` // 微信门店编号
|
||||
OutOrderID string `json:"out_order_id"` // 自定义订单号
|
||||
ServiceTransID string `json:"service_trans_id"` // 运力ID
|
||||
BillID string `json:"bill_id"` // 运力订单号
|
||||
DeliveryStatus IntracityDeliveryStatus `json:"delivery_status"` // 配送状态
|
||||
Price uint32 `json:"price"` // 配送费用,单位:分
|
||||
Distance uint32 `json:"distance"` // 配送距离,单位:米
|
||||
CreateTime uint32 `json:"create_time"` // 订单创建时间
|
||||
RiderInfo *RiderInfo `json:"rider_info"` // 骑手信息
|
||||
FinishTime uint32 `json:"finish_time"` // 订单完成时间
|
||||
}
|
||||
|
||||
// IntracityQueryOrder 查询配送单
|
||||
func (express *Express) IntracityQueryOrder(ctx context.Context, req *QueryOrderRequest) (res QueryOrderResponse, err error) {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(intracityQueryOrderURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &res, "IntracityQueryOrder")
|
||||
return
|
||||
}
|
||||
|
||||
// CancelOrderRequest 取消配送单请求参数
|
||||
type CancelOrderRequest struct {
|
||||
WxOrderID string `json:"wx_order_id,omitempty"` // 微信订单号,二选一
|
||||
OutOrderID string `json:"out_order_id,omitempty"` // 自定义订单号,二选一
|
||||
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号
|
||||
OutStoreID string `json:"out_store_id,omitempty"` // 自定义门店编号
|
||||
CancelReason string `json:"cancel_reason,omitempty"` // 取消原因
|
||||
}
|
||||
|
||||
// CancelOrderResponse 取消配送单返回参数
|
||||
type CancelOrderResponse struct {
|
||||
util.CommonError
|
||||
WxOrderID string `json:"wx_order_id"` // 微信订单号
|
||||
RefundAmount int32 `json:"refund_amount"` // 退款金额,单位:分
|
||||
DeductAmount int32 `json:"deduct_amount"` // 扣除违约金,单位:分
|
||||
}
|
||||
|
||||
// IntracityCancelOrder 取消配送单
|
||||
func (express *Express) IntracityCancelOrder(ctx context.Context, req *CancelOrderRequest) (res CancelOrderResponse, err error) {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(intracityCancelOrderURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &res, "IntracityCancelOrder")
|
||||
return
|
||||
}
|
||||
|
||||
// MockNotifyRequest 模拟配送回调请求参数(仅用于测试)
|
||||
type MockNotifyRequest struct {
|
||||
WxOrderID string `json:"wx_order_id"` // 微信订单号
|
||||
DeliveryStatus IntracityDeliveryStatus `json:"delivery_status"` // 配送状态
|
||||
}
|
||||
|
||||
// IntracityMockNotify 模拟配送回调(仅用于测试)
|
||||
func (express *Express) IntracityMockNotify(ctx context.Context, req *MockNotifyRequest) error {
|
||||
accessToken, err := express.GetAccessToken()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(intracityMockNotifyURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, req)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return util.DecodeWithCommonError(response, "IntracityMockNotify")
|
||||
}
|
||||
@@ -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 string `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{}
|
||||
}
|
||||
147
miniprogram/message/updatable_msg.go
Normal file
147
miniprogram/message/updatable_msg.go
Normal file
@@ -0,0 +1,147 @@
|
||||
package message
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
// createActivityIDURL 创建activity_id
|
||||
createActivityIDURL = "https://api.weixin.qq.com/cgi-bin/message/wxopen/activityid/create?access_token=%s&unionid=%s&openid=%s"
|
||||
// SendUpdatableMsgURL 修改动态消息
|
||||
setUpdatableMsgURL = "https://api.weixin.qq.com/cgi-bin/message/wxopen/updatablemsg/send?access_token=%s"
|
||||
// setChatToolMsgURL 修改小程序聊天工具的动态卡片消息
|
||||
setChatToolMsgURL = "https://api.weixin.qq.com/cgi-bin/message/wxopen/chattoolmsg/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,
|
||||
}
|
||||
}
|
||||
|
||||
// CreateActivityIDRequest 创建activity_id请求
|
||||
type CreateActivityIDRequest struct {
|
||||
UnionID string
|
||||
OpenID string
|
||||
}
|
||||
|
||||
// CreateActivityID 创建activity_id
|
||||
func (updatableMessage *UpdatableMessage) CreateActivityID() (CreateActivityIDResponse, error) {
|
||||
return updatableMessage.CreateActivityIDWithReq(&CreateActivityIDRequest{})
|
||||
}
|
||||
|
||||
// CreateActivityIDWithReq 创建activity_id
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/updatable-message/createActivityId.html
|
||||
func (updatableMessage *UpdatableMessage) CreateActivityIDWithReq(req *CreateActivityIDRequest) (res CreateActivityIDResponse, err error) {
|
||||
accessToken, err := updatableMessage.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
url := fmt.Sprintf(createActivityIDURL, accessToken, req.UnionID, req.OpenID)
|
||||
response, err := util.HTTPGet(url)
|
||||
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"`
|
||||
}
|
||||
|
||||
// SetChatToolMsgRequest 修改小程序聊天工具的动态卡片消息请求
|
||||
type SetChatToolMsgRequest struct {
|
||||
VersionType int64 `json:"version_type"`
|
||||
TargetState UpdatableTargetState `json:"target_state"`
|
||||
ActivityID string `json:"activity_id"`
|
||||
TemplateID string `json:"template_id"`
|
||||
ParticipatorInfoList []ParticipatorInfo `json:"participator_info_list,omitempty"`
|
||||
}
|
||||
|
||||
// ParticipatorInfo 更新后的聊天室成员状态
|
||||
type ParticipatorInfo struct {
|
||||
State int `json:"state"`
|
||||
GroupOpenID string `json:"group_openid"`
|
||||
}
|
||||
|
||||
// SetChatToolMsg 修改小程序聊天工具的动态卡片消息
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/updatable-message/setChatToolMsg.html
|
||||
func (updatableMessage *UpdatableMessage) SetChatToolMsg(req *SetChatToolMsgRequest) error {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = updatableMessage.GetAccessToken(); err != nil {
|
||||
return err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(setChatToolMsgURL, accessToken), req); err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "SetChatToolMsg")
|
||||
}
|
||||
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"
|
||||
@@ -9,9 +10,15 @@ import (
|
||||
"github.com/silenceper/wechat/v2/miniprogram/content"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/encryptor"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/express"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/message"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/minidrama"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/ocr"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/operation"
|
||||
"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,27 +26,41 @@ 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)
|
||||
var defaultAkHandle credential.AccessTokenContextHandle
|
||||
const cacheKeyPrefix = credential.CacheKeyMiniProgramPrefix
|
||||
if cfg.UseStableAK {
|
||||
defaultAkHandle = credential.NewStableAccessToken(cfg.AppID, cfg.AppSecret, cacheKeyPrefix, cfg.Cache)
|
||||
} else {
|
||||
defaultAkHandle = credential.NewDefaultAccessToken(cfg.AppID, cfg.AppSecret, cacheKeyPrefix, cfg.Cache)
|
||||
}
|
||||
ctx := &context.Context{
|
||||
Config: cfg,
|
||||
AccessTokenHandle: defaultAkHandle,
|
||||
Config: cfg,
|
||||
AccessTokenContextHandle: defaultAkHandle,
|
||||
}
|
||||
return &MiniProgram{ctx}
|
||||
}
|
||||
|
||||
// SetAccessTokenHandle 自定义access_token获取方式
|
||||
// SetAccessTokenHandle 自定义 access_token 获取方式
|
||||
func (miniProgram *MiniProgram) SetAccessTokenHandle(accessTokenHandle credential.AccessTokenHandle) {
|
||||
miniProgram.ctx.AccessTokenHandle = accessTokenHandle
|
||||
miniProgram.ctx.AccessTokenContextHandle = credential.AccessTokenCompatibleHandle{
|
||||
AccessTokenHandle: accessTokenHandle,
|
||||
}
|
||||
}
|
||||
|
||||
// SetAccessTokenContextHandle 自定义 access_token 获取方式
|
||||
func (miniProgram *MiniProgram) SetAccessTokenContextHandle(accessTokenContextHandle credential.AccessTokenContextHandle) {
|
||||
miniProgram.ctx.AccessTokenContextHandle = accessTokenContextHandle
|
||||
}
|
||||
|
||||
// GetContext get Context
|
||||
@@ -67,17 +88,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 +123,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 +143,62 @@ 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)
|
||||
}
|
||||
|
||||
// GetOperation 小程序运维中心
|
||||
func (miniProgram *MiniProgram) GetOperation() *operation.Operation {
|
||||
return operation.NewOperation(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetExpress 微信物流服务
|
||||
func (miniProgram *MiniProgram) GetExpress() *express.Express {
|
||||
return express.NewExpress(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetOCR OCR接口
|
||||
func (miniProgram *MiniProgram) GetOCR() *ocr.OCR {
|
||||
return ocr.NewOCR(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetIntracity 同城配送接口
|
||||
func (miniProgram *MiniProgram) GetIntracity() *express.Express {
|
||||
return express.NewExpress(miniProgram.ctx)
|
||||
}
|
||||
|
||||
248
miniprogram/ocr/ocr.go
Normal file
248
miniprogram/ocr/ocr.go
Normal file
@@ -0,0 +1,248 @@
|
||||
package ocr
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/url"
|
||||
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
ocrIDCardURL = "https://api.weixin.qq.com/cv/ocr/idcard"
|
||||
ocrBankCardURL = "https://api.weixin.qq.com/cv/ocr/bankcard"
|
||||
ocrDrivingURL = "https://api.weixin.qq.com/cv/ocr/driving"
|
||||
ocrDrivingLicenseURL = "https://api.weixin.qq.com/cv/ocr/drivinglicense"
|
||||
ocrBizLicenseURL = "https://api.weixin.qq.com/cv/ocr/bizlicense"
|
||||
ocrCommonURL = "https://api.weixin.qq.com/cv/ocr/comm"
|
||||
)
|
||||
|
||||
// OCR struct
|
||||
type OCR struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// coordinate 坐标
|
||||
type coordinate struct {
|
||||
X int64 `json:"x,omitempty"`
|
||||
Y int64 `json:"y,omitempty"`
|
||||
}
|
||||
|
||||
// position 位置
|
||||
type position struct {
|
||||
LeftTop coordinate `json:"left_top"`
|
||||
RightTop coordinate `json:"right_top"`
|
||||
RightBottom coordinate `json:"right_bottom"`
|
||||
LeftBottom coordinate `json:"left_bottom"`
|
||||
}
|
||||
|
||||
// imageSize 图片尺寸
|
||||
type imageSize struct {
|
||||
Width int64 `json:"w,omitempty"`
|
||||
Height int64 `json:"h,omitempty"`
|
||||
}
|
||||
|
||||
// ResDriving 行驶证返回结果
|
||||
type ResDriving struct {
|
||||
util.CommonError
|
||||
|
||||
PlateNumber string `json:"plate_num,omitempty"`
|
||||
VehicleType string `json:"vehicle_type,omitempty"`
|
||||
Owner string `json:"owner,omitempty"`
|
||||
Address string `json:"addr,omitempty"`
|
||||
UseCharacter string `json:"use_character,omitempty"`
|
||||
Model string `json:"model,omitempty"`
|
||||
Vin string `json:"vin,omitempty"`
|
||||
EngineNumber string `json:"engine_num,omitempty"`
|
||||
RegisterDate string `json:"register_date,omitempty"`
|
||||
IssueDate string `json:"issue_date,omitempty"`
|
||||
PlateNumberB string `json:"plate_num_b,omitempty"`
|
||||
Record string `json:"record,omitempty"`
|
||||
PassengersNumber string `json:"passengers_num,omitempty"`
|
||||
TotalQuality string `json:"total_quality,omitempty"`
|
||||
PrepareQuality string `json:"prepare_quality,omitempty"`
|
||||
OverallSize string `json:"overall_size,omitempty"`
|
||||
CardPositionFront map[string]position `json:"card_position_front,omitempty"`
|
||||
CardPositionBack map[string]position `json:"card_position_back,omitempty"`
|
||||
ImageSize imageSize `json:"img_size,omitempty"`
|
||||
}
|
||||
|
||||
// ResIDCard 身份证返回结果
|
||||
type ResIDCard struct {
|
||||
util.CommonError
|
||||
|
||||
Type string `json:"type,omitempty"`
|
||||
Name string `json:"name,omitempty"`
|
||||
ID string `json:"id,omitempty"`
|
||||
Address string `json:"addr,omitempty"`
|
||||
Gender string `json:"gender,omitempty"`
|
||||
Nationality string `json:"nationality,omitempty"`
|
||||
ValidDate string `json:"valid_date,omitempty"`
|
||||
}
|
||||
|
||||
// ResBankCard 银行卡返回结果
|
||||
type ResBankCard struct {
|
||||
util.CommonError
|
||||
|
||||
Number string `json:"number,omitempty"`
|
||||
}
|
||||
|
||||
// ResDrivingLicense 驾驶证返回结果
|
||||
type ResDrivingLicense struct {
|
||||
util.CommonError
|
||||
|
||||
IDNumber string `json:"id_num,omitempty"`
|
||||
Name string `json:"name,omitempty"`
|
||||
Sex string `json:"sex,omitempty"`
|
||||
Nationality string `json:"nationality,omitempty"`
|
||||
Address string `json:"address,omitempty"`
|
||||
Birthday string `json:"birth_date,omitempty"`
|
||||
IssueDate string `json:"issue_date,omitempty"`
|
||||
CarClass string `json:"car_class,omitempty"`
|
||||
ValidFrom string `json:"valid_from,omitempty"`
|
||||
ValidTo string `json:"valid_to,omitempty"`
|
||||
OfficialSeal string `json:"official_seal,omitempty"`
|
||||
}
|
||||
|
||||
// ResBizLicense 营业执照返回结果
|
||||
type ResBizLicense struct {
|
||||
util.CommonError
|
||||
|
||||
RegisterNumber string `json:"reg_num,omitempty"`
|
||||
Serial string `json:"serial,omitempty"`
|
||||
LegalRepresentative string `json:"legal_representative,omitempty"`
|
||||
EnterpriseName string `json:"enterprise_name,omitempty"`
|
||||
TypeOfOrganization string `json:"type_of_organization,omitempty"`
|
||||
Address string `json:"address,omitempty"`
|
||||
TypeOfEnterprise string `json:"type_of_enterprise,omitempty"`
|
||||
BusinessScope string `json:"business_scope,omitempty"`
|
||||
RegisteredCapital string `json:"registered_capital,omitempty"`
|
||||
PaidInCapital string `json:"paid_in_capital,omitempty"`
|
||||
ValidPeriod string `json:"valid_period,omitempty"`
|
||||
RegisterDate string `json:"registered_date,omitempty"`
|
||||
CertPosition map[string]position `json:"cert_position,omitempty"`
|
||||
ImageSize imageSize `json:"img_size,omitempty"`
|
||||
}
|
||||
|
||||
// ResCommon 公共印刷品返回结果
|
||||
type ResCommon struct {
|
||||
util.CommonError
|
||||
|
||||
Items []commonItem `json:"items,omitempty"`
|
||||
ImageSize imageSize `json:"img_size,omitempty"`
|
||||
}
|
||||
|
||||
// commonItem 公共元素
|
||||
type commonItem struct {
|
||||
Position position `json:"pos"`
|
||||
Text string `json:"text"`
|
||||
}
|
||||
|
||||
// NewOCR 实例
|
||||
func NewOCR(c *context.Context) *OCR {
|
||||
ocr := new(OCR)
|
||||
ocr.Context = c
|
||||
return ocr
|
||||
}
|
||||
|
||||
// IDCard 身份证OCR识别接口
|
||||
func (ocr *OCR) IDCard(path string) (resIDCard ResIDCard, err error) {
|
||||
accessToken, err := ocr.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
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")
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// BankCard 银行卡OCR识别接口
|
||||
func (ocr *OCR) BankCard(path string) (resBankCard ResBankCard, err error) {
|
||||
accessToken, err := ocr.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
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")
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// Driving 行驶证OCR识别接口
|
||||
func (ocr *OCR) Driving(path string) (resDriving ResDriving, err error) {
|
||||
accessToken, err := ocr.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
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")
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// DrivingLicense 驾驶证OCR识别接口
|
||||
func (ocr *OCR) DrivingLicense(path string) (resDrivingLicense ResDrivingLicense, err error) {
|
||||
accessToken, err := ocr.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
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")
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// BizLicense 营业执照OCR识别接口
|
||||
func (ocr *OCR) BizLicense(path string) (resBizLicense ResBizLicense, err error) {
|
||||
accessToken, err := ocr.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
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")
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// Common 通用印刷体OCR识别接口
|
||||
func (ocr *OCR) Common(path string) (resCommon ResCommon, err error) {
|
||||
accessToken, err := ocr.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
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")
|
||||
|
||||
return
|
||||
}
|
||||
456
miniprogram/operation/operation.go
Normal file
456
miniprogram/operation/operation.go
Normal file
@@ -0,0 +1,456 @@
|
||||
package operation
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
// getDomainInfoURL 查询域名配置
|
||||
getDomainInfoURL = "https://api.weixin.qq.com/wxa/getwxadevinfo?access_token=%s"
|
||||
// getPerformanceURL 获取性能数据
|
||||
getPerformanceURL = "https://api.weixin.qq.com/wxaapi/log/get_performance?access_token=%s"
|
||||
// getSceneListURL 获取访问来源
|
||||
getSceneListURL = "https://api.weixin.qq.com/wxaapi/log/get_scene?access_token=%s"
|
||||
// getVersionListURL 获取客户端版本
|
||||
getVersionListURL = "https://api.weixin.qq.com/wxaapi/log/get_client_version?access_token=%s"
|
||||
// realTimeLogSearchURL 查询实时日志
|
||||
realTimeLogSearchURL = "https://api.weixin.qq.com/wxaapi/userlog/userlog_search?%s"
|
||||
// getFeedbackListURL 获取用户反馈列表
|
||||
getFeedbackListURL = "https://api.weixin.qq.com/wxaapi/feedback/list?%s"
|
||||
// getJsErrDetailURL 查询js错误详情
|
||||
getJsErrDetailURL = "https://api.weixin.qq.com/wxaapi/log/jserr_detail?access_token=%s"
|
||||
// getJsErrListURL 查询错误列表
|
||||
getJsErrListURL = "https://api.weixin.qq.com/wxaapi/log/jserr_list?access_token=%s"
|
||||
// getGrayReleasePlanURL 获取分阶段发布详情
|
||||
getGrayReleasePlanURL = "https://api.weixin.qq.com/wxa/getgrayreleaseplan?access_token=%s"
|
||||
)
|
||||
|
||||
// Operation 运维中心
|
||||
type Operation struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewOperation 实例化
|
||||
func NewOperation(ctx *context.Context) *Operation {
|
||||
return &Operation{ctx}
|
||||
}
|
||||
|
||||
// GetDomainInfoRequest 查询域名配置请求
|
||||
type GetDomainInfoRequest struct {
|
||||
Action string `json:"action"`
|
||||
}
|
||||
|
||||
// GetDomainInfoResponse 查询域名配置响应
|
||||
type GetDomainInfoResponse struct {
|
||||
util.CommonError
|
||||
RequestDomain []string `json:"requestdomain"`
|
||||
WsRequestDomain []string `json:"wsrequestdomain"`
|
||||
UploadDomain []string `json:"uploaddomain"`
|
||||
DownloadDomain []string `json:"downloaddomain"`
|
||||
UDPDomain []string `json:"udpdomain"`
|
||||
BizDomain []string `json:"bizdomain"`
|
||||
}
|
||||
|
||||
// GetDomainInfo 查询域名配置
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/getDomainInfo.html
|
||||
func (o *Operation) GetDomainInfo(req *GetDomainInfoRequest) (res GetDomainInfoResponse, err error) {
|
||||
var accessToken string
|
||||
if accessToken, err = o.GetAccessToken(); err != nil {
|
||||
return
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(getDomainInfoURL, accessToken), req); err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "GetDomainInfo")
|
||||
return
|
||||
}
|
||||
|
||||
// GetPerformanceRequest 获取性能数据请求
|
||||
type GetPerformanceRequest struct {
|
||||
CostTimeType int64 `json:"cost_time_type"`
|
||||
DefaultStartTime int64 `json:"default_start_time"`
|
||||
DefaultEndTime int64 `json:"default_end_time"`
|
||||
Device string `json:"device"`
|
||||
IsDownloadCode string `json:"is_download_code"`
|
||||
Scene string `json:"scene"`
|
||||
NetworkType string `json:"networktype"`
|
||||
}
|
||||
|
||||
// GetPerformanceResponse 获取性能数据响应
|
||||
type GetPerformanceResponse struct {
|
||||
util.CommonError
|
||||
DefaultTimeData string `json:"default_time_data"`
|
||||
CompareTimeData string `json:"compare_time_data"`
|
||||
}
|
||||
|
||||
// PerformanceDefaultTimeData 查询数据
|
||||
type PerformanceDefaultTimeData struct {
|
||||
List []DefaultTimeDataItem `json:"list"`
|
||||
}
|
||||
|
||||
// DefaultTimeDataItem 查询数据
|
||||
type DefaultTimeDataItem struct {
|
||||
RefData string `json:"ref_data"`
|
||||
CostTimeType int64 `json:"cost_time_type"`
|
||||
CostTime int64 `json:"cost_time"`
|
||||
}
|
||||
|
||||
// GetPerformance 获取性能数据
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/getPerformance.html
|
||||
func (o *Operation) GetPerformance(req *GetPerformanceRequest) (res GetPerformanceResponse, err error) {
|
||||
var accessToken string
|
||||
if accessToken, err = o.GetAccessToken(); err != nil {
|
||||
return
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(getPerformanceURL, accessToken), req); err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "GetPerformance")
|
||||
return
|
||||
}
|
||||
|
||||
// GetSceneListResponse 获取访问来源响应
|
||||
type GetSceneListResponse struct {
|
||||
util.CommonError
|
||||
Scene []Scene `json:"scene"`
|
||||
}
|
||||
|
||||
// Scene 访问来源
|
||||
type Scene struct {
|
||||
Name string `json:"name"`
|
||||
Value string `json:"value"`
|
||||
}
|
||||
|
||||
// GetSceneList 获取访问来源
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/getSceneList.html
|
||||
func (o *Operation) GetSceneList() (res GetSceneListResponse, err error) {
|
||||
var accessToken string
|
||||
if accessToken, err = o.GetAccessToken(); err != nil {
|
||||
return
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(getSceneListURL, accessToken)); err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "GetSceneList")
|
||||
return
|
||||
}
|
||||
|
||||
// GetVersionListResponse 获取客户端版本响应
|
||||
type GetVersionListResponse struct {
|
||||
util.CommonError
|
||||
CvList []ClientVersion `json:"cvlist"`
|
||||
}
|
||||
|
||||
// ClientVersion 客户端版本
|
||||
type ClientVersion struct {
|
||||
Type int64 `json:"type"`
|
||||
ClientVersionList []string `json:"client_version_list"`
|
||||
}
|
||||
|
||||
// GetVersionList 获取客户端版本
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/getVersionList.html
|
||||
func (o *Operation) GetVersionList() (res GetVersionListResponse, err error) {
|
||||
var accessToken string
|
||||
if accessToken, err = o.GetAccessToken(); err != nil {
|
||||
return
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(getVersionListURL, accessToken)); err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "GetVersionList")
|
||||
return
|
||||
}
|
||||
|
||||
// RealTimeLogSearchRequest 查询实时日志请求
|
||||
type RealTimeLogSearchRequest struct {
|
||||
Date string
|
||||
BeginTime int64
|
||||
EndTime int64
|
||||
Start int64
|
||||
Limit int64
|
||||
Level int64
|
||||
TraceID string
|
||||
URL string
|
||||
ID string
|
||||
FilterMsg string
|
||||
}
|
||||
|
||||
// RealTimeLogSearchResponse 查询实时日志响应
|
||||
type RealTimeLogSearchResponse struct {
|
||||
util.CommonError
|
||||
Data RealTimeLogSearchData `json:"data"`
|
||||
}
|
||||
|
||||
// RealTimeLogSearchData 日志数据和日志条数总量
|
||||
type RealTimeLogSearchData struct {
|
||||
List []RealTimeLogSearchDataList `json:"list"`
|
||||
Total int64 `json:"total"`
|
||||
}
|
||||
|
||||
// RealTimeLogSearchDataList 日志数据列表
|
||||
type RealTimeLogSearchDataList struct {
|
||||
Level int64 `json:"level"`
|
||||
LibraryVersion string `json:"libraryVersion"`
|
||||
ClientVersion string `json:"clientVersion"`
|
||||
ID string `json:"id"`
|
||||
Timestamp int64 `json:"timestamp"`
|
||||
Platform int64 `json:"platform"`
|
||||
URL string `json:"url"`
|
||||
TraceID string `json:"traceid"`
|
||||
FilterMsg string `json:"filterMsg"`
|
||||
Msg []RealTimeLogSearchDataListMsg `json:"msg"`
|
||||
}
|
||||
|
||||
// RealTimeLogSearchDataListMsg 日志内容数组
|
||||
type RealTimeLogSearchDataListMsg struct {
|
||||
Time int64 `json:"time"`
|
||||
Level int64 `json:"level"`
|
||||
Msg []string `json:"msg"`
|
||||
}
|
||||
|
||||
// RealTimeLogSearch 查询实时日志
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/realtimelogSearch.html
|
||||
func (o *Operation) RealTimeLogSearch(req *RealTimeLogSearchRequest) (res RealTimeLogSearchResponse, err error) {
|
||||
var accessToken string
|
||||
if accessToken, err = o.GetAccessToken(); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
params := map[string]interface{}{
|
||||
"access_token": accessToken,
|
||||
"date": req.Date,
|
||||
"begintime": req.BeginTime,
|
||||
"endtime": req.EndTime,
|
||||
}
|
||||
if req.Start > 0 {
|
||||
params["start"] = req.Start
|
||||
}
|
||||
if req.Limit > 0 {
|
||||
params["limit"] = req.Limit
|
||||
}
|
||||
if req.TraceID != "" {
|
||||
params["traceId"] = req.TraceID
|
||||
}
|
||||
if req.URL != "" {
|
||||
params["url"] = req.URL
|
||||
}
|
||||
if req.ID != "" {
|
||||
params["id"] = req.ID
|
||||
}
|
||||
if req.FilterMsg != "" {
|
||||
params["filterMsg"] = req.FilterMsg
|
||||
}
|
||||
if req.Level > 0 {
|
||||
params["level"] = req.Level
|
||||
}
|
||||
query := util.Query(params)
|
||||
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(realTimeLogSearchURL, query)); err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "RealTimeLogSearch")
|
||||
return
|
||||
}
|
||||
|
||||
// GetFeedbackListRequest 获取用户反馈列表请求
|
||||
type GetFeedbackListRequest struct {
|
||||
Page int64
|
||||
Num int64
|
||||
Type int64
|
||||
}
|
||||
|
||||
// GetFeedbackListResponse 获取用户反馈列表响应
|
||||
type GetFeedbackListResponse struct {
|
||||
util.CommonError
|
||||
TotalNum int64 `json:"total_num"`
|
||||
List []Feedback `json:"list"`
|
||||
}
|
||||
|
||||
// Feedback 反馈列表
|
||||
type Feedback struct {
|
||||
RecordID int64 `json:"record_id"`
|
||||
CreateTime int64 `json:"create_time"`
|
||||
Content string `json:"content"`
|
||||
Phone string `json:"phone"`
|
||||
OpenID string `json:"openid"`
|
||||
Nickname string `json:"nickname"`
|
||||
HeadURL string `json:"head_url"`
|
||||
Type int64 `json:"type"`
|
||||
MediaIDS []string `json:"mediaIds"`
|
||||
SystemInfo string `json:"systemInfo"`
|
||||
}
|
||||
|
||||
// GetFeedbackList 获取用户反馈列表
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/getFeedback.html
|
||||
func (o *Operation) GetFeedbackList(req *GetFeedbackListRequest) (res GetFeedbackListResponse, err error) {
|
||||
var accessToken string
|
||||
if accessToken, err = o.GetAccessToken(); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
params := map[string]interface{}{
|
||||
"access_token": accessToken,
|
||||
"page": req.Page,
|
||||
"num": req.Num,
|
||||
}
|
||||
if req.Type > 0 {
|
||||
params["type"] = req.Type
|
||||
}
|
||||
query := util.Query(params)
|
||||
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(getFeedbackListURL, query)); err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "GetFeedbackList")
|
||||
return
|
||||
}
|
||||
|
||||
// GetJsErrDetailRequest 查询js错误详情请求
|
||||
type GetJsErrDetailRequest struct {
|
||||
StartTime string `json:"startTime"`
|
||||
EndTime string `json:"endTime"`
|
||||
ErrorMsgMd5 string `json:"errorMsgMd5"`
|
||||
ErrorStackMd5 string `json:"errorStackMd5"`
|
||||
AppVersion string `json:"appVersion"`
|
||||
SdkVersion string `json:"sdkVersion"`
|
||||
OsName string `json:"osName"`
|
||||
ClientVersion string `json:"clientVersion"`
|
||||
OpenID string `json:"openid"`
|
||||
Offset int64 `json:"offset"`
|
||||
Limit int64 `json:"limit"`
|
||||
Desc string `json:"desc"`
|
||||
}
|
||||
|
||||
// GetJsErrDetailResponse 查询js错误详情响应
|
||||
type GetJsErrDetailResponse struct {
|
||||
util.CommonError
|
||||
TotalCount int64 `json:"totalCount"`
|
||||
OpenID string `json:"openid"`
|
||||
Data []JsErrDetailData `json:"data"`
|
||||
}
|
||||
|
||||
// JsErrDetailData 错误列表
|
||||
type JsErrDetailData struct {
|
||||
Count string `json:"Count"`
|
||||
SdkVersion string `json:"sdkVersion"`
|
||||
ClientVersion string `json:"ClientVersion"`
|
||||
ErrorStackMd5 string `json:"errorStackMd5"`
|
||||
TimeStamp string `json:"TimeStamp"`
|
||||
AppVersion string `json:"appVersion"`
|
||||
ErrorMsgMd5 string `json:"errorMsgMd5"`
|
||||
ErrorMsg string `json:"errorMsg"`
|
||||
ErrorStack string `json:"errorStack"`
|
||||
Ds string `json:"Ds"`
|
||||
OsName string `json:"OsName"`
|
||||
OpenID string `json:"openId"`
|
||||
PluginVersion string `json:"pluginversion"`
|
||||
AppID string `json:"appId"`
|
||||
DeviceModel string `json:"DeviceModel"`
|
||||
Source string `json:"source"`
|
||||
Route string `json:"route"`
|
||||
Uin string `json:"Uin"`
|
||||
Nickname string `json:"nickname"`
|
||||
}
|
||||
|
||||
// GetJsErrDetail 查询js错误详情
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/getJsErrDetail.html
|
||||
func (o *Operation) GetJsErrDetail(req *GetJsErrDetailRequest) (res GetJsErrDetailResponse, err error) {
|
||||
var accessToken string
|
||||
if accessToken, err = o.GetAccessToken(); err != nil {
|
||||
return
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(getJsErrDetailURL, accessToken), req); err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "GetJsErrDetail")
|
||||
return
|
||||
}
|
||||
|
||||
// GetJsErrListRequest 查询错误列表请求
|
||||
type GetJsErrListRequest struct {
|
||||
AppVersion string `json:"appVersion"`
|
||||
ErrType string `json:"errType"`
|
||||
StartTime string `json:"startTime"`
|
||||
EndTime string `json:"endTime"`
|
||||
Keyword string `json:"keyword"`
|
||||
OpenID string `json:"openid"`
|
||||
OrderBy string `json:"orderby"`
|
||||
Desc string `json:"desc"`
|
||||
Offset int64 `json:"offset"`
|
||||
Limit int64 `json:"limit"`
|
||||
}
|
||||
|
||||
// GetJsErrListResponse 查询错误列表响应
|
||||
type GetJsErrListResponse struct {
|
||||
util.CommonError
|
||||
TotalCount int64 `json:"totalCount"`
|
||||
OpenID string `json:"openid"`
|
||||
Data []JsErrListData `json:"data"`
|
||||
}
|
||||
|
||||
// JsErrListData 错误列表
|
||||
type JsErrListData struct {
|
||||
ErrorMsgMd5 string `json:"errorMsgMd5"`
|
||||
ErrorMsg string `json:"errorMsg"`
|
||||
Uv int64 `json:"uv"`
|
||||
Pv int64 `json:"pv"`
|
||||
ErrorStackMd5 string `json:"errorStackMd5"`
|
||||
ErrorStack string `json:"errorStack"`
|
||||
PvPercent string `json:"pvPercent"`
|
||||
UvPercent string `json:"uvPercent"`
|
||||
}
|
||||
|
||||
// GetJsErrList 查询错误列表
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/getJsErrList.html
|
||||
func (o *Operation) GetJsErrList(req *GetJsErrListRequest) (res GetJsErrListResponse, err error) {
|
||||
var accessToken string
|
||||
if accessToken, err = o.GetAccessToken(); err != nil {
|
||||
return
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(getJsErrListURL, accessToken), req); err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "GetJsErrList")
|
||||
return
|
||||
}
|
||||
|
||||
// GetGrayReleasePlanResponse 获取分阶段发布详情响应
|
||||
type GetGrayReleasePlanResponse struct {
|
||||
util.CommonError
|
||||
GrayReleasePlan GrayReleasePlanDetail `json:"gray_release_plan"`
|
||||
}
|
||||
|
||||
// GrayReleasePlanDetail 分阶段发布计划详情
|
||||
type GrayReleasePlanDetail struct {
|
||||
Status int64 `json:"status"`
|
||||
CreateTimestamp int64 `json:"create_timestamp"`
|
||||
GrayPercentage int64 `json:"gray_percentage"`
|
||||
SupportExperiencerFirst bool `json:"support_experiencer_first"`
|
||||
SupportDebugerFirst bool `json:"support_debuger_first"`
|
||||
}
|
||||
|
||||
// GetGrayReleasePlan 获取分阶段发布详情
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/getGrayReleasePlan.html
|
||||
func (o *Operation) GetGrayReleasePlan() (res GetGrayReleasePlanResponse, err error) {
|
||||
var accessToken string
|
||||
if accessToken, err = o.GetAccessToken(); err != nil {
|
||||
return
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(getGrayReleasePlanURL, accessToken)); err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "GetGrayReleasePlan")
|
||||
return
|
||||
}
|
||||
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
|
||||
}
|
||||
|
||||
@@ -54,6 +54,8 @@ type QRCoder struct {
|
||||
IsHyaline bool `json:"is_hyaline,omitempty"`
|
||||
// envVersion 要打开的小程序版本。正式版为 "release",体验版为 "trial",开发版为 "develop"
|
||||
EnvVersion string `json:"env_version,omitempty"`
|
||||
// ShowSplashAd 控制通过该小程序码进入小程序是否展示封面广告1、默认为true,展示封面广告2、传入为false时,不展示封面广告
|
||||
ShowSplashAd bool `json:"show_splash_ad,omitempty"`
|
||||
}
|
||||
|
||||
// fetchCode 请求并返回二维码二进制数据
|
||||
|
||||
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
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
package security
|
||||
|
||||
import (
|
||||
context2 "context"
|
||||
"fmt"
|
||||
"strconv"
|
||||
|
||||
@@ -51,12 +52,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 图片/音频异步校验请求参数
|
||||
@@ -69,7 +65,12 @@ type MediaCheckAsyncRequest struct {
|
||||
|
||||
// MediaCheckAsync 异步校验图片/音频是否含有违法违规内容
|
||||
func (security *Security) MediaCheckAsync(in *MediaCheckAsyncRequest) (traceID string, err error) {
|
||||
accessToken, err := security.GetAccessToken()
|
||||
return security.MediaCheckAsyncContext(context2.Background(), in)
|
||||
}
|
||||
|
||||
// MediaCheckAsyncContext 异步校验图片/音频是否含有违法违规内容
|
||||
func (security *Security) MediaCheckAsyncContext(ctx context2.Context, in *MediaCheckAsyncRequest) (traceID string, err error) {
|
||||
accessToken, err := security.GetAccessTokenContext(ctx)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
@@ -82,7 +83,7 @@ func (security *Security) MediaCheckAsync(in *MediaCheckAsyncRequest) (traceID s
|
||||
req.Version = 2
|
||||
|
||||
uri := fmt.Sprintf(mediaCheckAsyncURL, accessToken)
|
||||
response, err := util.PostJSON(uri, req)
|
||||
response, err := util.PostJSONContext(ctx, uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
@@ -93,12 +94,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 校验一张图片是否含有违法违规内容(同步)
|
||||
@@ -232,7 +228,12 @@ func (security *Security) MsgCheckV1(content string) (res MsgCheckResponse, err
|
||||
|
||||
// MsgCheck 检查一段文本是否含有违法违规内容
|
||||
func (security *Security) MsgCheck(in *MsgCheckRequest) (res MsgCheckResponse, err error) {
|
||||
accessToken, err := security.GetAccessToken()
|
||||
return security.MsgCheckContext(context2.Background(), in)
|
||||
}
|
||||
|
||||
// MsgCheckContext 检查一段文本是否含有违法违规内容
|
||||
func (security *Security) MsgCheckContext(ctx context2.Context, in *MsgCheckRequest) (res MsgCheckResponse, err error) {
|
||||
accessToken, err := security.GetAccessTokenContext(ctx)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
@@ -245,7 +246,7 @@ func (security *Security) MsgCheck(in *MsgCheckRequest) (res MsgCheckResponse, e
|
||||
req.Version = 2
|
||||
|
||||
uri := fmt.Sprintf(msgCheckURL, accessToken)
|
||||
response, err := util.PostJSON(uri, req)
|
||||
response, err := util.PostJSONContext(ctx, uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
@@ -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,
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package subscribe
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
@@ -11,22 +12,30 @@ const (
|
||||
// 发送订阅消息
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.send.html
|
||||
subscribeSendURL = "https://api.weixin.qq.com/cgi-bin/message/subscribe/send"
|
||||
|
||||
// 获取当前帐号下的个人模板列表
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.getTemplateList.html
|
||||
getTemplateURL = "https://api.weixin.qq.com/wxaapi/newtmpl/gettemplate"
|
||||
|
||||
// 添加订阅模板
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.addTemplate.html
|
||||
addTemplateURL = "https://api.weixin.qq.com/wxaapi/newtmpl/addtemplate"
|
||||
|
||||
// 删除私有模板
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.deleteTemplate.html
|
||||
delTemplateURL = "https://api.weixin.qq.com/wxaapi/newtmpl/deltemplate"
|
||||
|
||||
// 统一服务消息
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/uniform-message/uniformMessage.send.html
|
||||
uniformMessageSend = "https://api.weixin.qq.com/cgi-bin/message/wxopen/template/uniform_send"
|
||||
// getCategoryURL 获取类目
|
||||
getCategoryURL = "https://api.weixin.qq.com/wxaapi/newtmpl/getcategory?access_token=%s"
|
||||
// getPubTemplateKeyWordsByIDURL 获取关键词列表
|
||||
getPubTemplateKeyWordsByIDURL = "https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatekeywords?access_token=%s&tid=%s"
|
||||
// getPubTemplateTitleListURL 获取所属类目下的公共模板
|
||||
getPubTemplateTitleListURL = "https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatetitles?access_token=%s&ids=%s&start=%d&limit=%d"
|
||||
// setUserNotifyURL 激活与更新服务卡片
|
||||
setUserNotifyURL = "https://api.weixin.qq.com/wxa/set_user_notify?access_token=%s"
|
||||
// setUserNotifyExtURL 更新服务卡片扩展信息
|
||||
setUserNotifyExtURL = "https://api.weixin.qq.com/wxa/set_user_notifyext?access_token=%s"
|
||||
// getUserNotifyURL 查询服务卡片状态
|
||||
getUserNotifyURL = "https://api.weixin.qq.com/wxa/get_user_notify?access_token=%s"
|
||||
)
|
||||
|
||||
// Subscribe 订阅消息
|
||||
@@ -57,11 +66,18 @@ type DataItem struct {
|
||||
|
||||
// TemplateItem template item
|
||||
type TemplateItem struct {
|
||||
PriTmplID string `json:"priTmplId"`
|
||||
Title string `json:"title"`
|
||||
Content string `json:"content"`
|
||||
Example string `json:"example"`
|
||||
Type int64 `json:"type"`
|
||||
PriTmplID string `json:"priTmplId"`
|
||||
Title string `json:"title"`
|
||||
Content string `json:"content"`
|
||||
Example string `json:"example"`
|
||||
Type int64 `json:"type"`
|
||||
KeywordEnumValueList []KeywordEnumValue `json:"keywordEnumValueList"`
|
||||
}
|
||||
|
||||
// KeywordEnumValue 枚举参数值范围
|
||||
type KeywordEnumValue struct {
|
||||
EnumValueList []string `json:"enumValueList"`
|
||||
KeywordCode string `json:"keywordCode"`
|
||||
}
|
||||
|
||||
// TemplateList template list
|
||||
@@ -70,6 +86,13 @@ type TemplateList struct {
|
||||
Data []TemplateItem `json:"data"`
|
||||
}
|
||||
|
||||
// resTemplateSend 发送获取 msg id
|
||||
type resTemplateSend struct {
|
||||
util.CommonError
|
||||
|
||||
MsgID int64 `json:"msgid"`
|
||||
}
|
||||
|
||||
// Send 发送订阅消息
|
||||
func (s *Subscribe) Send(msg *Message) (err error) {
|
||||
var accessToken string
|
||||
@@ -85,6 +108,33 @@ func (s *Subscribe) Send(msg *Message) (err error) {
|
||||
return util.DecodeWithCommonError(response, "Send")
|
||||
}
|
||||
|
||||
// SendGetMsgID 发送订阅消息返回 msgid
|
||||
func (s *Subscribe) SendGetMsgID(msg *Message) (msgID int64, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = s.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", subscribeSendURL, accessToken)
|
||||
response, err := util.PostJSON(uri, msg)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var result resTemplateSend
|
||||
if err = json.Unmarshal(response, &result); err != nil {
|
||||
return
|
||||
}
|
||||
if result.ErrCode != 0 {
|
||||
err = fmt.Errorf("template msg send error : errcode=%v , errmsg=%v", result.ErrCode, result.ErrMsg)
|
||||
return
|
||||
}
|
||||
|
||||
msgID = result.MsgID
|
||||
|
||||
return
|
||||
}
|
||||
|
||||
// ListTemplates 获取当前帐号下的个人模板列表
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.getTemplateList.html
|
||||
func (s *Subscribe) ListTemplates() (*TemplateList, error) {
|
||||
@@ -168,11 +218,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 删除私有模板
|
||||
@@ -193,3 +239,200 @@ func (s *Subscribe) Delete(templateID string) (err error) {
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "DeleteSubscribe")
|
||||
}
|
||||
|
||||
// GetCategoryResponse 获取类目响应
|
||||
type GetCategoryResponse struct {
|
||||
util.CommonError
|
||||
Data []Category `json:"data"`
|
||||
}
|
||||
|
||||
// Category 类目
|
||||
type Category struct {
|
||||
ID int64 `json:"id"`
|
||||
Name string `json:"name"`
|
||||
}
|
||||
|
||||
// GetCategory 获取类目
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/subscribe-message/getCategory.html
|
||||
func (s *Subscribe) GetCategory() ([]Category, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = s.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(getCategoryURL, accessToken)); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &GetCategoryResponse{}
|
||||
err = util.DecodeWithError(response, result, "GetCategory")
|
||||
return result.Data, err
|
||||
}
|
||||
|
||||
// GetPubTemplateKeywordsByIDResponse 获取关键词列表响应
|
||||
type GetPubTemplateKeywordsByIDResponse struct {
|
||||
util.CommonError
|
||||
Count int64 `json:"count"`
|
||||
Data []PubTemplateKeywords `json:"data"`
|
||||
}
|
||||
|
||||
// PubTemplateKeywords 关键词
|
||||
type PubTemplateKeywords struct {
|
||||
KID int64 `json:"kid"`
|
||||
Name string `json:"name"`
|
||||
Example string `json:"example"`
|
||||
Rule string `json:"rule"`
|
||||
}
|
||||
|
||||
// GetPubTemplateKeywordsByID 获取关键词列表
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/subscribe-message/getPubTemplateKeyWordsById.html
|
||||
func (s *Subscribe) GetPubTemplateKeywordsByID(tid string) (*GetPubTemplateKeywordsByIDResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = s.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(getPubTemplateKeyWordsByIDURL, accessToken, tid)); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &GetPubTemplateKeywordsByIDResponse{}
|
||||
err = util.DecodeWithError(response, result, "GetPubTemplateKeywordsByID")
|
||||
return result, err
|
||||
}
|
||||
|
||||
// GetPubTemplateTitleListRequest 获取所属类目下的公共模板请求
|
||||
type GetPubTemplateTitleListRequest struct {
|
||||
Start int64
|
||||
Limit int64
|
||||
IDs string
|
||||
}
|
||||
|
||||
// GetPubTemplateTitleListResponse 获取所属类目下的公共模板响应
|
||||
type GetPubTemplateTitleListResponse struct {
|
||||
util.CommonError
|
||||
Count int64 `json:"count"`
|
||||
Data []PubTemplateTitle `json:"data"`
|
||||
}
|
||||
|
||||
// PubTemplateTitle 模板标题
|
||||
type PubTemplateTitle struct {
|
||||
Type int64 `json:"type"`
|
||||
TID string `json:"tid"`
|
||||
Title string `json:"title"`
|
||||
CategoryID string `json:"categoryId"`
|
||||
}
|
||||
|
||||
// GetPubTemplateTitleList 获取所属类目下的公共模板
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/subscribe-message/getPubTemplateTitleList.html
|
||||
func (s *Subscribe) GetPubTemplateTitleList(req *GetPubTemplateTitleListRequest) (*GetPubTemplateTitleListResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = s.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(getPubTemplateTitleListURL, accessToken, req.IDs, req.Start, req.Limit)); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &GetPubTemplateTitleListResponse{}
|
||||
err = util.DecodeWithError(response, result, "GetPubTemplateTitleList")
|
||||
return result, err
|
||||
}
|
||||
|
||||
// SetUserNotifyRequest 激活与更新服务卡片请求
|
||||
type SetUserNotifyRequest struct {
|
||||
OpenID string `json:"openid"`
|
||||
NotifyType int64 `json:"notify_type"`
|
||||
NotifyCode string `json:"notify_code"`
|
||||
ContentJSON string `json:"content_json"`
|
||||
CheckJSON string `json:"check_json,omitempty"`
|
||||
}
|
||||
|
||||
// SetUserNotify 激活与更新服务卡片
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/subscribe-message/setUserNotify.html
|
||||
func (s *Subscribe) SetUserNotify(req *SetUserNotifyRequest) error {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = s.GetAccessToken(); err != nil {
|
||||
return err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(setUserNotifyURL, accessToken), req); err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "SetUserNotify")
|
||||
}
|
||||
|
||||
// SetUserNotifyExtRequest 更新服务卡片扩展信息请求
|
||||
type SetUserNotifyExtRequest struct {
|
||||
OpenID string `json:"openid"`
|
||||
NotifyType int64 `json:"notify_type"`
|
||||
NotifyCode string `json:"notify_code"`
|
||||
ExtJSON string `json:"ext_json"`
|
||||
}
|
||||
|
||||
// SetUserNotifyExt 更新服务卡片扩展信息
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/subscribe-message/setUserNotifyExt.html
|
||||
func (s *Subscribe) SetUserNotifyExt(req *SetUserNotifyExtRequest) error {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = s.GetAccessToken(); err != nil {
|
||||
return err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(setUserNotifyExtURL, accessToken), req); err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "SetUserNotifyExt")
|
||||
}
|
||||
|
||||
// GetUserNotifyRequest 查询服务卡片状态请求
|
||||
type GetUserNotifyRequest struct {
|
||||
OpenID string `json:"openid"`
|
||||
NotifyType int64 `json:"notify_type"`
|
||||
NotifyCode string `json:"notify_code"`
|
||||
}
|
||||
|
||||
// GetUserNotifyResponse 查询服务卡片状态响应
|
||||
type GetUserNotifyResponse struct {
|
||||
util.CommonError
|
||||
NotifyInfo NotifyInfo `json:"notify_info"`
|
||||
}
|
||||
|
||||
// NotifyInfo 卡片状态
|
||||
type NotifyInfo struct {
|
||||
NotifyType int64 `json:"notify_type"`
|
||||
ContentJSON string `json:"content_json"`
|
||||
CodeState int64 `json:"code_state"`
|
||||
CodeExpireTime int64 `json:"code_expire_time"`
|
||||
}
|
||||
|
||||
// GetUserNotify 查询服务卡片状态
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/subscribe-message/getUserNotify.html
|
||||
func (s *Subscribe) GetUserNotify(req *GetUserNotifyRequest) (*GetUserNotifyResponse, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = s.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(getUserNotifyURL, accessToken), req); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &GetUserNotifyResponse{}
|
||||
err = util.DecodeWithError(response, result, "GetUserNotify")
|
||||
return result, err
|
||||
}
|
||||
|
||||
@@ -6,7 +6,13 @@ import (
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const queryURL = "https://api.weixin.qq.com/wxa/query_urllink"
|
||||
const queryURL = "https://api.weixin.qq.com/wxa/query_urllink?access_token=%s"
|
||||
|
||||
// ULQueryRequest 查询加密URLLink请求
|
||||
type ULQueryRequest struct {
|
||||
URLLink string `json:"url_link"`
|
||||
QueryType int `json:"query_type"`
|
||||
}
|
||||
|
||||
// ULQueryResult 返回的结果
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-link/urllink.query.html 返回值
|
||||
@@ -28,25 +34,35 @@ type ULQueryResult struct {
|
||||
ResourceAppid string `json:"resource_appid"`
|
||||
} `json:"cloud_base"`
|
||||
} `json:"url_link_info"`
|
||||
VisitOpenid string `json:"visit_openid"`
|
||||
VisitOpenid string `json:"visit_openid"`
|
||||
QuotaInfo QuotaInfo `json:"quota_info"`
|
||||
}
|
||||
|
||||
// QuotaInfo quota 配置
|
||||
type QuotaInfo struct {
|
||||
RemainVisitQuota int64 `json:"remain_visit_quota"`
|
||||
}
|
||||
|
||||
// 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
|
||||
return u.QueryWithType(&ULQueryRequest{URLLink: urlLink})
|
||||
}
|
||||
|
||||
// QueryWithType 查询加密URLLink
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/qrcode-link/url-link/queryUrlLink.html
|
||||
func (u *URLLink) QueryWithType(req *ULQueryRequest) (*ULQueryResult, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = u.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(queryURL, accessToken), req); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &ULQueryResult{}
|
||||
err = util.DecodeWithError(response, result, "URLLink.Query")
|
||||
return result, err
|
||||
}
|
||||
|
||||
@@ -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
|
||||
}
|
||||
|
||||
@@ -14,7 +14,8 @@ const (
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-scheme/urlscheme.query.html#参数
|
||||
type QueryScheme struct {
|
||||
// 小程序 scheme 码
|
||||
Scheme string `json:"scheme"`
|
||||
Scheme string `json:"scheme"`
|
||||
QueryType int `json:"query_type"`
|
||||
}
|
||||
|
||||
// SchemeInfo scheme 配置
|
||||
@@ -33,38 +34,47 @@ type SchemeInfo struct {
|
||||
EnvVersion EnvVersion `json:"env_version"`
|
||||
}
|
||||
|
||||
// resQueryScheme 返回结构体
|
||||
// QuotaInfo quota 配置
|
||||
type QuotaInfo struct {
|
||||
RemainVisitQuota int64 `json:"remain_visit_quota"`
|
||||
}
|
||||
|
||||
// ResQueryScheme 返回结构体
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-scheme/urlscheme.query.html#参数
|
||||
type resQueryScheme struct {
|
||||
type ResQueryScheme struct {
|
||||
// 通用错误
|
||||
*util.CommonError
|
||||
util.CommonError
|
||||
// scheme 配置
|
||||
SchemeInfo SchemeInfo `json:"scheme_info"`
|
||||
// 访问该链接的openid,没有用户访问过则为空字符串
|
||||
VisitOpenid string `json:"visit_openid"`
|
||||
VisitOpenid string `json:"visit_openid"`
|
||||
QuotaInfo QuotaInfo `json:"quota_info"`
|
||||
}
|
||||
|
||||
// QueryScheme 查询小程序 scheme 码
|
||||
func (u *URLScheme) QueryScheme(querySchemeParams QueryScheme) (schemeInfo SchemeInfo, visitOpenid string, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = u.GetAccessToken()
|
||||
res, err := u.QuerySchemeWithRes(querySchemeParams)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
urlStr := fmt.Sprintf(querySchemeURL, accessToken)
|
||||
var response []byte
|
||||
response, err = util.PostJSON(urlStr, querySchemeParams)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
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
|
||||
}
|
||||
|
||||
// QuerySchemeWithRes 查询scheme码
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/qrcode-link/url-scheme/queryScheme.html
|
||||
func (u *URLScheme) QuerySchemeWithRes(req QueryScheme) (*ResQueryScheme, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = u.GetAccessToken(); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(querySchemeURL, accessToken), req); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &ResQueryScheme{}
|
||||
err = util.DecodeWithError(response, result, "QueryScheme")
|
||||
return result, err
|
||||
}
|
||||
|
||||
@@ -17,7 +17,12 @@ func NewURLScheme(ctx *context.Context) *URLScheme {
|
||||
return &URLScheme{Context: ctx}
|
||||
}
|
||||
|
||||
const generateURL = "https://api.weixin.qq.com/wxa/generatescheme"
|
||||
const (
|
||||
// generateURL 获取加密scheme码
|
||||
generateURL = "https://api.weixin.qq.com/wxa/generatescheme"
|
||||
// generateNFCURL 获取 NFC 的小程序 scheme
|
||||
generateNFCURL = "https://api.weixin.qq.com/wxa/generatenfcscheme?access_token=%s"
|
||||
)
|
||||
|
||||
// TExpireType 失效类型 (指定时间戳/指定间隔)
|
||||
type TExpireType int
|
||||
@@ -50,10 +55,13 @@ type JumpWxa struct {
|
||||
// USParams 请求参数
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-scheme/urlscheme.generate.html#请求参数
|
||||
type USParams struct {
|
||||
JumpWxa *JumpWxa `json:"jump_wxa"`
|
||||
ExpireType TExpireType `json:"expire_type"`
|
||||
ExpireTime int64 `json:"expire_time"`
|
||||
ExpireInterval int `json:"expire_interval"`
|
||||
JumpWxa *JumpWxa `json:"jump_wxa,omitempty"`
|
||||
ExpireType TExpireType `json:"expire_type,omitempty"`
|
||||
ExpireTime int64 `json:"expire_time,omitempty"`
|
||||
ExpireInterval int `json:"expire_interval,omitempty"`
|
||||
IsExpire bool `json:"is_expire,omitempty"`
|
||||
ModelID string `json:"model_id,omitempty"`
|
||||
Sn string `json:"sn,omitempty"`
|
||||
}
|
||||
|
||||
// USResult 返回的结果
|
||||
@@ -78,8 +86,24 @@ func (u *URLScheme) Generate(params *USParams) (string, error) {
|
||||
}
|
||||
var resp USResult
|
||||
err = util.DecodeWithError(response, &resp, "URLScheme.Generate")
|
||||
if err != nil {
|
||||
return resp.OpenLink, err
|
||||
}
|
||||
|
||||
// GenerateNFC 获取 NFC 的小程序 scheme
|
||||
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/qrcode-link/url-scheme/generateNFCScheme.html
|
||||
func (u *URLScheme) GenerateNFC(params *USParams) (string, error) {
|
||||
var (
|
||||
accessToken string
|
||||
err error
|
||||
)
|
||||
if accessToken, err = u.GetAccessToken(); err != nil {
|
||||
return "", err
|
||||
}
|
||||
return resp.OpenLink, nil
|
||||
var response []byte
|
||||
if response, err = util.PostJSON(fmt.Sprintf(generateNFCURL, accessToken), params); err != nil {
|
||||
return "", err
|
||||
}
|
||||
result := &USResult{}
|
||||
err = util.DecodeWithError(response, result, "URLScheme.GenerateNFC")
|
||||
return result.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,
|
||||
|
||||
@@ -11,4 +11,5 @@ type Config struct {
|
||||
Token string `json:"token"` // token
|
||||
EncodingAESKey string `json:"encoding_aes_key"` // EncodingAESKey
|
||||
Cache cache.Cache
|
||||
UseStableAK bool // use the stable access_token
|
||||
}
|
||||
|
||||
@@ -72,11 +72,7 @@ func (csm *Manager) List() (customerServiceList []*KeFuInfo, err error) {
|
||||
}
|
||||
var res resKeFuList
|
||||
err = util.DecodeWithError(response, &res, "ListCustomerService")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
customerServiceList = res.KfList
|
||||
return
|
||||
return res.KfList, err
|
||||
}
|
||||
|
||||
// KeFuOnlineInfo 客服在线信息
|
||||
@@ -107,11 +103,7 @@ func (csm *Manager) OnlineList() (customerServiceOnlineList []*KeFuOnlineInfo, e
|
||||
}
|
||||
var res resKeFuOnlineList
|
||||
err = util.DecodeWithError(response, &res, "ListOnlineCustomerService")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
customerServiceOnlineList = res.KfOnlineList
|
||||
return
|
||||
return res.KfOnlineList, err
|
||||
}
|
||||
|
||||
// Add 添加客服账号
|
||||
|
||||
@@ -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 发布列表
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package js
|
||||
|
||||
import (
|
||||
context2 "context"
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/credential"
|
||||
@@ -39,14 +40,31 @@ func (js *Js) SetJsTicketHandle(ticketHandle credential.JsTicketHandle) {
|
||||
// GetConfig 获取jssdk需要的配置参数
|
||||
// uri 为当前网页地址
|
||||
func (js *Js) GetConfig(uri string) (config *Config, err error) {
|
||||
config = new(Config)
|
||||
return js.GetConfigContext(context2.Background(), uri)
|
||||
}
|
||||
|
||||
// GetConfigContext 新方法,允许传入上下文,避免协程泄漏
|
||||
func (js *Js) GetConfigContext(ctx context2.Context, uri string) (config *Config, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = js.GetAccessToken()
|
||||
// 类型断言,如果断言成功,调用安全的 GetAccessTokenContext 方法
|
||||
if ctxHandle, ok := js.Context.AccessTokenHandle.(credential.AccessTokenContextHandle); ok {
|
||||
accessToken, err = ctxHandle.GetAccessTokenContext(ctx)
|
||||
} else {
|
||||
// 如果没有实现 AccessTokenContextHandle 接口,调用旧的 GetAccessToken 方法
|
||||
accessToken, err = js.Context.GetAccessToken()
|
||||
}
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var ticketStr string
|
||||
ticketStr, err = js.GetTicket(accessToken)
|
||||
// 类型断言 jsTicket
|
||||
if ticketCtxHandle, ok := js.JsTicketHandle.(credential.JsTicketContextHandle); ok {
|
||||
ticketStr, err = ticketCtxHandle.GetTicketContext(ctx, accessToken)
|
||||
} else {
|
||||
// 如果没有实现 JsTicketContextHandle 接口,调用旧的 GetTicket 方法
|
||||
ticketStr, err = js.GetTicket(accessToken)
|
||||
}
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
@@ -56,6 +74,7 @@ func (js *Js) GetConfig(uri string) (config *Config, err error) {
|
||||
str := fmt.Sprintf("jsapi_ticket=%s&noncestr=%s×tamp=%d&url=%s", ticketStr, nonceStr, timestamp, uri)
|
||||
sigStr := util.Signature(str)
|
||||
|
||||
config = new(Config)
|
||||
config.AppID = js.AppID
|
||||
config.NonceStr = nonceStr
|
||||
config.Timestamp = timestamp
|
||||
|
||||
@@ -4,6 +4,9 @@ import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"path"
|
||||
|
||||
"github.com/silenceper/wechat/v2/officialaccount/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
@@ -27,7 +30,7 @@ const (
|
||||
PermanentMaterialTypeImage PermanentMaterialType = "image"
|
||||
// PermanentMaterialTypeVideo 永久素材视频类型(video)
|
||||
PermanentMaterialTypeVideo PermanentMaterialType = "video"
|
||||
// PermanentMaterialTypeVoice 永久素材语音类型 (voice)
|
||||
// PermanentMaterialTypeVoice 永久素材语音类型(voice)
|
||||
PermanentMaterialTypeVoice PermanentMaterialType = "voice"
|
||||
// PermanentMaterialTypeNews 永久素材图文类型(news)
|
||||
PermanentMaterialTypeNews PermanentMaterialType = "news"
|
||||
@@ -160,8 +163,8 @@ type resAddMaterial struct {
|
||||
URL string `json:"url"`
|
||||
}
|
||||
|
||||
// AddMaterial 上传永久性素材(处理视频需要单独上传)
|
||||
func (material *Material) AddMaterial(mediaType MediaType, filename string) (mediaID string, url string, err error) {
|
||||
// AddMaterialFromReader 上传永久性素材(处理视频需要单独上传),从 io.Reader 中读取
|
||||
func (material *Material) AddMaterialFromReader(mediaType MediaType, filePath string, reader io.Reader) (mediaID string, url string, err error) {
|
||||
if mediaType == MediaTypeVideo {
|
||||
err = errors.New("永久视频素材上传使用 AddVideo 方法")
|
||||
return
|
||||
@@ -173,8 +176,10 @@ func (material *Material) AddMaterial(mediaType MediaType, filename string) (med
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf("%s?access_token=%s&type=%s", addMaterialURL, accessToken, mediaType)
|
||||
// 获取文件名
|
||||
filename := path.Base(filePath)
|
||||
var response []byte
|
||||
response, err = util.PostFile("media", filename, uri)
|
||||
response, err = util.PostFileFromReader("media", filePath, filename, uri, reader)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
@@ -192,13 +197,24 @@ func (material *Material) AddMaterial(mediaType MediaType, filename string) (med
|
||||
return
|
||||
}
|
||||
|
||||
// AddMaterial 上传永久性素材(处理视频需要单独上传)
|
||||
func (material *Material) AddMaterial(mediaType MediaType, filename string) (mediaID string, url string, err error) {
|
||||
f, err := os.Open(filename)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
defer func() { _ = f.Close() }()
|
||||
|
||||
return material.AddMaterialFromReader(mediaType, filename, f)
|
||||
}
|
||||
|
||||
type reqVideo struct {
|
||||
Title string `json:"title"`
|
||||
Introduction string `json:"introduction"`
|
||||
}
|
||||
|
||||
// AddVideo 永久视频素材文件上传
|
||||
func (material *Material) AddVideo(filename, title, introduction string) (mediaID string, url string, err error) {
|
||||
// AddVideoFromReader 永久视频素材文件上传,从 io.Reader 中读取
|
||||
func (material *Material) AddVideoFromReader(filePath, title, introduction string, reader io.Reader) (mediaID string, url string, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = material.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -216,16 +232,19 @@ func (material *Material) AddVideo(filename, title, introduction string) (mediaI
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
fileName := path.Base(filePath)
|
||||
fields := []util.MultipartFormField{
|
||||
{
|
||||
IsFile: true,
|
||||
Fieldname: "media",
|
||||
Filename: filename,
|
||||
IsFile: true,
|
||||
Fieldname: "media",
|
||||
FilePath: filePath,
|
||||
Filename: fileName,
|
||||
FileReader: reader,
|
||||
},
|
||||
{
|
||||
IsFile: false,
|
||||
Fieldname: "description",
|
||||
Filename: fileName,
|
||||
Value: fieldValue,
|
||||
},
|
||||
}
|
||||
@@ -250,6 +269,17 @@ func (material *Material) AddVideo(filename, title, introduction string) (mediaI
|
||||
return
|
||||
}
|
||||
|
||||
// AddVideo 永久视频素材文件上传
|
||||
func (material *Material) AddVideo(directory, title, introduction string) (mediaID string, url string, err error) {
|
||||
f, err := os.Open(directory)
|
||||
if err != nil {
|
||||
return "", "", err
|
||||
}
|
||||
defer func() { _ = f.Close() }()
|
||||
|
||||
return material.AddVideoFromReader(directory, title, introduction, f)
|
||||
}
|
||||
|
||||
type reqDeleteMaterial struct {
|
||||
MediaID string `json:"media_id"`
|
||||
}
|
||||
@@ -278,7 +308,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 +317,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"`
|
||||
@@ -337,7 +367,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()
|
||||
|
||||
@@ -3,6 +3,7 @@ package material
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
@@ -62,6 +63,38 @@ func (material *Material) MediaUpload(mediaType MediaType, filename string) (med
|
||||
return
|
||||
}
|
||||
|
||||
// MediaUploadFromReader 临时素材上传
|
||||
func (material *Material) MediaUploadFromReader(mediaType MediaType, filename string, reader io.Reader) (media Media, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = material.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf("%s?access_token=%s&type=%s", mediaUploadURL, accessToken, mediaType)
|
||||
|
||||
var byteData []byte
|
||||
byteData, err = io.ReadAll(reader)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
response, err = util.PostFileByStream("media", filename, uri, byteData)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
err = json.Unmarshal(response, &media)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
if media.ErrCode != 0 {
|
||||
err = fmt.Errorf("MediaUpload error : errcode=%v , errmsg=%v", media.ErrCode, media.ErrMsg)
|
||||
return
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// GetMediaURL 返回临时素材的下载地址供用户自己处理
|
||||
// NOTICE: URL 不可公开,因为含access_token 需要立即另存文件
|
||||
func (material *Material) GetMediaURL(mediaID string) (mediaURL string, err error) {
|
||||
|
||||
@@ -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"
|
||||
@@ -91,7 +91,7 @@ const (
|
||||
const (
|
||||
// 微信开放平台需要用到
|
||||
|
||||
// InfoTypeVerifyTicket 返回ticket
|
||||
// InfoTypeVerifyTicket 返回 ticket
|
||||
InfoTypeVerifyTicket InfoType = "component_verify_ticket"
|
||||
// InfoTypeAuthorized 授权
|
||||
InfoTypeAuthorized InfoType = "authorized"
|
||||
@@ -108,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"`
|
||||
@@ -123,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"`
|
||||
@@ -165,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"`
|
||||
|
||||
// 第三方平台相关
|
||||
@@ -195,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"`
|
||||
@@ -213,15 +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 的列表,可通过获取永久素材接口拉取截图内容
|
||||
// 小程序审核通知
|
||||
SuccTime int `xml:"SuccTime"` // 审核成功时的时间戳
|
||||
FailTime int `xml:"FailTime"` // 审核不通过的时间戳
|
||||
DelayTime int `xml:"DelayTime"` // 审核延后时的时间戳
|
||||
Reason string `xml:"Reason"` // 审核不通过的原因
|
||||
ScreenShot string `xml:"ScreenShot"` // 审核不通过的截图示例。用 | 分隔的 media_id 的列表,可通过获取永久素材接口拉取截图内容
|
||||
}
|
||||
|
||||
// SubscribeMsgPopupEvent 订阅通知事件推送的消息体
|
||||
@@ -269,7 +282,7 @@ type ResponseEncryptedXMLMsg struct {
|
||||
Nonce string `xml:"Nonce" json:"Nonce"`
|
||||
}
|
||||
|
||||
// CDATA 使用该类型,在序列化为 xml 文本时文本会被解析器忽略
|
||||
// CDATA 使用该类型,在序列化为 xml 文本时文本会被解析器忽略
|
||||
type CDATA string
|
||||
|
||||
// MarshalXML 实现自己的序列化方法
|
||||
|
||||
@@ -90,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 {
|
||||
@@ -123,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 删除私有模板
|
||||
@@ -175,11 +167,7 @@ func (tpl *Subscribe) GetCategory() (categoryList []*PublicTemplateCategory, err
|
||||
}
|
||||
var result resSubscribeCategoryList
|
||||
err = util.DecodeWithError(response, &result, "GetCategory")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
categoryList = result.CategoryList
|
||||
return
|
||||
return result.CategoryList, err
|
||||
}
|
||||
|
||||
// PublicTemplateKeyWords 模板中的关键词
|
||||
@@ -210,11 +198,7 @@ func (tpl *Subscribe) GetPubTplKeyWordsByID(titleID string) (keyWordsList []*Pub
|
||||
}
|
||||
var result resPublicTemplateKeyWordsList
|
||||
err = util.DecodeWithError(response, &result, "GetPublicTemplateKeyWords")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
keyWordsList = result.KeyWordsList
|
||||
return
|
||||
return result.KeyWordsList, err
|
||||
}
|
||||
|
||||
// PublicTemplateTitle 类目下的公共模板
|
||||
@@ -246,10 +230,5 @@ func (tpl *Subscribe) GetPublicTemplateTitleList(ids string, start int, limit in
|
||||
}
|
||||
var result resPublicTemplateTitleList
|
||||
err = util.DecodeWithError(response, &result, "GetPublicTemplateTitle")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
count = result.Count
|
||||
templateTitleList = result.TemplateTitleList
|
||||
return
|
||||
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必须与发模板消息的公众号是绑定关联关系)
|
||||
@@ -60,15 +61,15 @@ func (tpl *Template) Send(msg *TemplateMessage) (msgID int64, err error) {
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", templateSendURL, accessToken)
|
||||
var response []byte
|
||||
response, err = util.PostJSON(uri, msg)
|
||||
if err != nil {
|
||||
var (
|
||||
uri = fmt.Sprintf("%s?access_token=%s", templateSendURL, accessToken)
|
||||
response []byte
|
||||
)
|
||||
if response, err = util.PostJSON(uri, msg); err != nil {
|
||||
return
|
||||
}
|
||||
var result resTemplateSend
|
||||
err = json.Unmarshal(response, &result)
|
||||
if err != nil {
|
||||
if err = json.Unmarshal(response, &result); err != nil {
|
||||
return
|
||||
}
|
||||
if result.ErrCode != 0 {
|
||||
@@ -102,19 +103,16 @@ func (tpl *Template) List() (templateList []*TemplateItem, err error) {
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", templateListURL, accessToken)
|
||||
var response []byte
|
||||
response, err = util.HTTPGet(uri)
|
||||
if err != nil {
|
||||
var (
|
||||
uri = fmt.Sprintf("%s?access_token=%s", templateListURL, accessToken)
|
||||
response []byte
|
||||
)
|
||||
if response, err = util.HTTPGet(uri); err != nil {
|
||||
return
|
||||
}
|
||||
var res resTemplateList
|
||||
err = util.DecodeWithError(response, &res, "ListTemplate")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
templateList = res.TemplateList
|
||||
return
|
||||
return res.TemplateList, err
|
||||
}
|
||||
|
||||
type resTemplateAdd struct {
|
||||
@@ -124,29 +122,26 @@ type resTemplateAdd struct {
|
||||
}
|
||||
|
||||
// Add 添加模板.
|
||||
func (tpl *Template) Add(shortID string) (templateID string, err error) {
|
||||
func (tpl *Template) Add(shortID string, keyNameList []string) (templateID string, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = tpl.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
var msg = struct {
|
||||
ShortID string `json:"template_id_short"`
|
||||
}{ShortID: shortID}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", templateAddURL, accessToken)
|
||||
var response []byte
|
||||
response, err = util.PostJSON(uri, msg)
|
||||
if err != nil {
|
||||
var (
|
||||
msg = struct {
|
||||
ShortID string `json:"template_id_short"`
|
||||
KeyNameList []string `json:"keyword_name_list"`
|
||||
}{ShortID: shortID, KeyNameList: keyNameList}
|
||||
uri = fmt.Sprintf("%s?access_token=%s", templateAddURL, accessToken)
|
||||
response []byte
|
||||
)
|
||||
if response, err = util.PostJSON(uri, msg); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var result resTemplateAdd
|
||||
err = util.DecodeWithError(response, &result, "AddTemplate")
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
templateID = result.TemplateID
|
||||
return
|
||||
return result.TemplateID, err
|
||||
}
|
||||
|
||||
// Delete 删除私有模板.
|
||||
@@ -156,14 +151,14 @@ func (tpl *Template) Delete(templateID string) (err error) {
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
var msg = struct {
|
||||
TemplateID string `json:"template_id"`
|
||||
}{TemplateID: templateID}
|
||||
|
||||
uri := fmt.Sprintf("%s?access_token=%s", templateDelURL, accessToken)
|
||||
var response []byte
|
||||
response, err = util.PostJSON(uri, msg)
|
||||
if err != nil {
|
||||
var (
|
||||
msg = struct {
|
||||
TemplateID string `json:"template_id"`
|
||||
}{TemplateID: templateID}
|
||||
uri = fmt.Sprintf("%s?access_token=%s", templateDelURL, accessToken)
|
||||
response []byte
|
||||
)
|
||||
if response, err = util.PostJSON(uri, msg); err != nil {
|
||||
return
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "DeleteTemplate")
|
||||
|
||||
@@ -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
|
||||
}
|
||||
|
||||
@@ -4,6 +4,7 @@ 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"
|
||||
@@ -48,7 +49,13 @@ type OfficialAccount struct {
|
||||
|
||||
// NewOfficialAccount 实例化公众号API
|
||||
func NewOfficialAccount(cfg *config.Config) *OfficialAccount {
|
||||
defaultAkHandle := credential.NewDefaultAccessToken(cfg.AppID, cfg.AppSecret, credential.CacheKeyOfficialAccountPrefix, cfg.Cache)
|
||||
var defaultAkHandle credential.AccessTokenContextHandle
|
||||
const cacheKeyPrefix = credential.CacheKeyOfficialAccountPrefix
|
||||
if cfg.UseStableAK {
|
||||
defaultAkHandle = credential.NewStableAccessToken(cfg.AppID, cfg.AppSecret, cacheKeyPrefix, cfg.Cache)
|
||||
} else {
|
||||
defaultAkHandle = credential.NewDefaultAccessToken(cfg.AppID, cfg.AppSecret, cacheKeyPrefix, cfg.Cache)
|
||||
}
|
||||
ctx := &context.Context{
|
||||
Config: cfg,
|
||||
AccessTokenHandle: defaultAkHandle,
|
||||
@@ -212,3 +219,8 @@ func (officialAccount *OfficialAccount) GetSubscribe() *message.Subscribe {
|
||||
func (officialAccount *OfficialAccount) GetCustomerServiceManager() *customerservice.Manager {
|
||||
return customerservice.NewCustomerServiceManager(officialAccount.ctx)
|
||||
}
|
||||
|
||||
// GetOpenAPI openApi管理接口
|
||||
func (officialAccount *OfficialAccount) GetOpenAPI() *openapi.OpenAPI {
|
||||
return openapi.NewOpenAPI(officialAccount.ctx)
|
||||
}
|
||||
|
||||
@@ -73,7 +73,7 @@ func (srv *Server) Serve() error {
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// 非安全模式下,请求处理方法返回为nil则直接回复success给微信服务器
|
||||
// 非安全模式下,请求处理方法返回为 nil 则直接回复 success 给微信服务器
|
||||
if response == nil && !srv.isSafeMode {
|
||||
srv.String("success")
|
||||
return nil
|
||||
@@ -198,7 +198,7 @@ func (srv *Server) parseRequestMessage(rawXMLMsgBytes []byte) (msg *message.MixM
|
||||
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() {
|
||||
@@ -284,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))
|
||||
|
||||
@@ -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,7 +2,7 @@ package account
|
||||
|
||||
import "github.com/silenceper/wechat/v2/openplatform/context"
|
||||
|
||||
// Account 开放平台张哈管理
|
||||
// Account 开放平台帐号管理
|
||||
// TODO 实现方法
|
||||
type Account struct {
|
||||
*context.Context
|
||||
|
||||
@@ -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"
|
||||
)
|
||||
|
||||
@@ -18,6 +20,7 @@ const (
|
||||
getComponentInfoURL = "https://api.weixin.qq.com/cgi-bin/component/api_get_authorizer_info?component_access_token=%s"
|
||||
componentLoginURL = "https://mp.weixin.qq.com/cgi-bin/componentloginpage?component_appid=%s&pre_auth_code=%s&redirect_uri=%s&auth_type=%d&biz_appid=%s"
|
||||
bindComponentURL = "https://mp.weixin.qq.com/safe/bindcomponent?action=bindcomponent&auth_type=%d&no_scan=1&component_appid=%s&pre_auth_code=%s&redirect_uri=%s&biz_appid=%s#wechat_redirect"
|
||||
bindComponentURLV2 = "https://open.weixin.qq.com/wxaopen/safe/bindcomponent?action=bindcomponent&auth_type=%d&no_scan=1&component_appid=%s&pre_auth_code=%s&redirect_uri=%s&biz_appid=%s#wechat_redirect"
|
||||
// TODO 获取授权方选项信息
|
||||
// getComponentConfigURL = "https://api.weixin.qq.com/cgi-bin/component/api_get_authorizer_option?component_access_token=%s"
|
||||
// TODO 获取已授权的账号信息
|
||||
@@ -31,24 +34,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 +72,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 +93,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 +101,57 @@ 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)
|
||||
}
|
||||
|
||||
// GetBindComponentURLV2Context 获取新版本第三方公众号授权链接(链接跳转,适用移动端)
|
||||
func (ctx *Context) GetBindComponentURLV2Context(stdCtx context.Context, redirectURI string, authType int, bizAppID string) (string, error) {
|
||||
code, err := ctx.GetPreCodeContext(stdCtx)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return fmt.Sprintf(bindComponentURLV2, authType, ctx.AppID, code, url.QueryEscape(redirectURI), bizAppID), nil
|
||||
}
|
||||
|
||||
// GetBindComponentURLV2 获取新版本第三方公众号授权链接(链接跳转,适用移动端)
|
||||
func (ctx *Context) GetBindComponentURLV2(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 +176,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 +188,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 +208,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 +226,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,20 +237,44 @@ 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
|
||||
}
|
||||
refreshTokenKey := "authorizer_refresh_token_" + appid
|
||||
if err := cache.SetContext(stdCtx, ctx.Cache, refreshTokenKey, ret.RefreshToken, 10*365*24*60*60*time.Second); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return ret, nil
|
||||
}
|
||||
|
||||
// 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 := cache.GetContext(stdCtx, ctx.Cache, authrTokenKey)
|
||||
if val == nil {
|
||||
refreshTokenKey := "authorizer_refresh_token_" + appid
|
||||
val := cache.GetContext(stdCtx, ctx.Cache, refreshTokenKey)
|
||||
if val == nil {
|
||||
return "", fmt.Errorf("cannot get authorizer %s refresh token", appid)
|
||||
}
|
||||
token, err := ctx.RefreshAuthrTokenContext(stdCtx, appid, val.(string))
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
return token.AccessToken, nil
|
||||
}
|
||||
|
||||
return val.(string), nil
|
||||
}
|
||||
|
||||
// GetAuthrAccessToken 获取授权方AccessToken
|
||||
func (ctx *Context) GetAuthrAccessToken(appid string) (string, error) {
|
||||
authrTokenKey := "authorizer_access_token_" + appid
|
||||
val := ctx.Cache.Get(authrTokenKey)
|
||||
if val == nil {
|
||||
return "", fmt.Errorf("cannot get authorizer %s access token", appid)
|
||||
}
|
||||
return val.(string), nil
|
||||
return ctx.GetAuthrAccessTokenContext(context.Background(), appid)
|
||||
}
|
||||
|
||||
// AuthorizerInfo 授权方详细信息
|
||||
@@ -258,9 +326,9 @@ type CategoriesInfo struct {
|
||||
Second string `wx:"second"`
|
||||
}
|
||||
|
||||
// GetAuthrInfo 获取授权方的帐号基本信息
|
||||
func (ctx *Context) GetAuthrInfo(appid string) (*AuthorizerInfo, *AuthBaseInfo, error) {
|
||||
cat, err := ctx.GetComponentAccessToken()
|
||||
// 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
|
||||
}
|
||||
@@ -271,7 +339,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
|
||||
}
|
||||
@@ -286,3 +354,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 基础信息设置
|
||||
@@ -51,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,7 @@
|
||||
package miniprogram
|
||||
|
||||
import (
|
||||
originalContext "context"
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/credential"
|
||||
@@ -37,6 +38,22 @@ func (miniProgram *MiniProgram) GetAccessToken() (string, error) {
|
||||
return akRes.AccessToken, nil
|
||||
}
|
||||
|
||||
// GetAccessTokenContext 利用ctx获取ak
|
||||
func (miniProgram *MiniProgram) GetAccessTokenContext(ctx originalContext.Context) (string, error) {
|
||||
ak, akErr := miniProgram.openContext.GetAuthrAccessTokenContext(ctx, 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().RefreshAuthrTokenContext(ctx, 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
|
||||
@@ -68,7 +85,7 @@ func (miniProgram *MiniProgram) GetBasic() *basic.Basic {
|
||||
// GetURLLink 小程序URL Link接口 调用前需确认已调用 SetAuthorizerRefreshToken 避免由于缓存中 authorizer_access_token 过期执行中断
|
||||
func (miniProgram *MiniProgram) GetURLLink() *urllink.URLLink {
|
||||
return urllink.NewURLLink(&miniContext.Context{
|
||||
AccessTokenHandle: miniProgram,
|
||||
AccessTokenContextHandle: miniProgram,
|
||||
})
|
||||
}
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package js
|
||||
|
||||
import (
|
||||
context2 "context"
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/credential"
|
||||
@@ -32,14 +33,31 @@ func (js *Js) SetJsTicketHandle(ticketHandle credential.JsTicketHandle) {
|
||||
// GetConfig 第三方平台 - 获取jssdk需要的配置参数
|
||||
// uri 为当前网页地址
|
||||
func (js *Js) GetConfig(uri, appid string) (config *officialJs.Config, err error) {
|
||||
config = new(officialJs.Config)
|
||||
return js.GetConfigContext(context2.Background(), uri, appid)
|
||||
}
|
||||
|
||||
// GetConfigContext 新方法,允许传入上下文,避免协程泄漏
|
||||
func (js *Js) GetConfigContext(ctx context2.Context, uri, appid string) (config *officialJs.Config, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = js.GetAccessToken()
|
||||
// 类型断言,如果断言成功,调用安全的 GetAccessTokenContext 方法
|
||||
if ctxHandle, ok := js.Context.AccessTokenHandle.(credential.AccessTokenContextHandle); ok {
|
||||
accessToken, err = ctxHandle.GetAccessTokenContext(ctx)
|
||||
} else {
|
||||
// 如果没有实现 AccessTokenContextHandle 接口,调用旧的 GetAccessToken 方法
|
||||
accessToken, err = js.Context.GetAccessToken()
|
||||
}
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var ticketStr string
|
||||
ticketStr, err = js.GetTicket(accessToken)
|
||||
// 类型断言 jsTicket
|
||||
if ticketCtxHandle, ok := js.JsTicketHandle.(credential.JsTicketContextHandle); ok {
|
||||
ticketStr, err = ticketCtxHandle.GetTicketContext(ctx, accessToken)
|
||||
} else {
|
||||
// 如果没有实现 JsTicketContextHandle 接口,调用旧的 GetTicket 方法
|
||||
ticketStr, err = js.GetTicket(accessToken)
|
||||
}
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
@@ -49,6 +67,7 @@ func (js *Js) GetConfig(uri, appid string) (config *officialJs.Config, err error
|
||||
str := fmt.Sprintf("jsapi_ticket=%s&noncestr=%s×tamp=%d&url=%s", ticketStr, nonceStr, timestamp, uri)
|
||||
sigStr := util.Signature(str)
|
||||
|
||||
config = new(officialJs.Config)
|
||||
config.AppID = appid
|
||||
config.NonceStr = nonceStr
|
||||
config.Timestamp = timestamp
|
||||
|
||||
147
openplatform/officialaccount/js/js_test.go
Normal file
147
openplatform/officialaccount/js/js_test.go
Normal file
@@ -0,0 +1,147 @@
|
||||
// 验证 js.GetConfigContext 是否能正确传递上下文到 HTTP 请求,确保上下文正确传播,防止在获取 JSSDK 配置时发生协程泄露。
|
||||
package js
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
context2 "context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"testing"
|
||||
|
||||
"github.com/silenceper/wechat/v2/cache"
|
||||
"github.com/silenceper/wechat/v2/credential"
|
||||
"github.com/silenceper/wechat/v2/officialaccount/config"
|
||||
"github.com/silenceper/wechat/v2/officialaccount/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
// mockAccessTokenHandle 模拟 AccessTokenHandle
|
||||
type mockAccessTokenHandle struct{}
|
||||
|
||||
func (m *mockAccessTokenHandle) GetAccessToken() (string, error) {
|
||||
return "mock-access-token", nil
|
||||
}
|
||||
|
||||
func (m *mockAccessTokenHandle) GetAccessTokenContext(_ context2.Context) (string, error) {
|
||||
return "mock-access-token", nil
|
||||
}
|
||||
|
||||
// contextCheckingRoundTripper 自定义 RoundTripper 用于检查 context
|
||||
type contextCheckingRoundTripper struct {
|
||||
originalCtx context2.Context
|
||||
t *testing.T
|
||||
key interface{}
|
||||
expectedVal interface{}
|
||||
}
|
||||
|
||||
func (rt *contextCheckingRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
|
||||
// 获取请求中的 context
|
||||
reqCtx := req.Context()
|
||||
|
||||
// 打印 context 比较结果
|
||||
rt.t.Logf("比较上下文的内存地址:\n")
|
||||
if reqCtx == rt.originalCtx {
|
||||
rt.t.Logf("上下文具有相同的内存地址。原始上下文: %p, 请求上下文: %p\n", rt.originalCtx, reqCtx)
|
||||
} else {
|
||||
rt.t.Logf("上下文具有不同的内存地址。原始上下文: %p, 请求上下文: %p\n", rt.originalCtx, reqCtx)
|
||||
}
|
||||
|
||||
// 检查 context 中的键值对
|
||||
if rt.key != nil {
|
||||
value := reqCtx.Value(rt.key)
|
||||
rt.t.Logf("检查请求上下文中的键 %v:\n", rt.key)
|
||||
if value != rt.expectedVal {
|
||||
rt.t.Errorf("上下文键 %v 的值不匹配: 预期 %v, 实际 %v\n", rt.key, rt.expectedVal, value)
|
||||
} else {
|
||||
rt.t.Logf("上下文键 %v 的值匹配: 预期 %v, 实际 %v\n", rt.key, rt.expectedVal, value)
|
||||
}
|
||||
}
|
||||
|
||||
// 检查上下文是否已取消
|
||||
select {
|
||||
case <-reqCtx.Done():
|
||||
return nil, reqCtx.Err() // 返回上下文取消错误
|
||||
default:
|
||||
// 返回模拟的 HTTP 响应,包含有效的 JSON
|
||||
responseBody := `{"ticket":"mock-ticket","expires_in":7200}`
|
||||
response := &http.Response{
|
||||
Status: "200 OK",
|
||||
StatusCode: http.StatusOK,
|
||||
Proto: "HTTP/1.1",
|
||||
ProtoMajor: 1,
|
||||
ProtoMinor: 1,
|
||||
Body: io.NopCloser(bytes.NewReader([]byte(responseBody))),
|
||||
ContentLength: int64(len(responseBody)),
|
||||
Header: make(http.Header),
|
||||
}
|
||||
response.Header.Set("Content-Type", "application/json")
|
||||
return response, nil
|
||||
}
|
||||
}
|
||||
|
||||
// contextKey 定义自定义上下文键类型,避免使用内置 string 类型
|
||||
type contextKey string
|
||||
|
||||
// setupJsInstance 初始化 Js 实例和 HTTP 客户端
|
||||
func setupJsInstance(t *testing.T, ctx context2.Context, key, val interface{}) (*Js, func()) {
|
||||
cfg := &config.Config{
|
||||
AppID: "test-app-id",
|
||||
AppSecret: "test-app-secret",
|
||||
Cache: cache.NewMemory(),
|
||||
}
|
||||
cacheKey := fmt.Sprintf("%s_jsapi_ticket_%s", credential.CacheKeyOfficialAccountPrefix, cfg.AppID)
|
||||
if err := cfg.Cache.Delete(cacheKey); err != nil {
|
||||
t.Fatalf("清除缓存失败: %v", err)
|
||||
}
|
||||
t.Log("清除 jsapi_ticket 的缓存:", cacheKey)
|
||||
|
||||
ctxHandle := &context.Context{Config: cfg, AccessTokenHandle: &mockAccessTokenHandle{}}
|
||||
jsInstance := NewJs(ctxHandle, cfg.AppID)
|
||||
jsInstance.SetJsTicketHandle(credential.NewDefaultJsTicket(cfg.AppID, credential.CacheKeyOfficialAccountPrefix, cfg.Cache))
|
||||
|
||||
originalClient := util.DefaultHTTPClient
|
||||
util.DefaultHTTPClient = &http.Client{
|
||||
Transport: &contextCheckingRoundTripper{originalCtx: ctx, t: t, key: key, expectedVal: val},
|
||||
}
|
||||
return jsInstance, func() { util.DefaultHTTPClient = originalClient }
|
||||
}
|
||||
|
||||
// TestGetConfigContext 测试GetConfigContext的上下文传递和取消行为。
|
||||
func TestGetConfigContext(t *testing.T) {
|
||||
t.Run("ContextPassing", func(t *testing.T) {
|
||||
ctxKey := contextKey("testKey111") // 使用自定义类型 contextKey
|
||||
ctxValue := "testValue222"
|
||||
ctx := context2.WithValue(context2.Background(), ctxKey, ctxValue)
|
||||
t.Logf("创建的测试上下文: %p, 添加的键值对: %v=%v\n", ctx, ctxKey, ctxValue)
|
||||
|
||||
jsInstance, cleanup := setupJsInstance(t, ctx, ctxKey, ctxValue)
|
||||
defer cleanup()
|
||||
t.Log("调用 GetConfigContext")
|
||||
config2, err := jsInstance.GetConfigContext(ctx, "https://www.baidu.com", "test-app-id")
|
||||
if err != nil {
|
||||
t.Fatalf("GetConfigContext 失败: %v", err)
|
||||
}
|
||||
if config2.AppID != "test-app-id" {
|
||||
t.Errorf("预期 AppID 为 %s,实际为 %s", "test-app-id", config2.AppID)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("ContextCancellation", func(t *testing.T) {
|
||||
ctx, cancel := context2.WithCancel(context2.Background())
|
||||
defer cancel()
|
||||
|
||||
jsInstance, cleanup := setupJsInstance(t, ctx, nil, nil)
|
||||
defer cleanup()
|
||||
|
||||
cancel()
|
||||
t.Log("调用 GetConfigContext(已取消上下文)")
|
||||
_, err := jsInstance.GetConfigContext(ctx, "https://www.baidu.com", "test-app-id")
|
||||
if err == nil {
|
||||
t.Error("预期上下文取消错误,但 GetConfigContext 未返回错误")
|
||||
} else if !errors.Is(err, context2.Canceled) {
|
||||
t.Errorf("预期错误为 context.Canceled,实际为: %v", err)
|
||||
}
|
||||
})
|
||||
}
|
||||
@@ -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,
|
||||
}
|
||||
|
||||
@@ -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"
|
||||
)
|
||||
@@ -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
|
||||
}
|
||||
@@ -6,7 +6,7 @@ import (
|
||||
"reflect"
|
||||
)
|
||||
|
||||
// CommonError 微信返回的通用错误json
|
||||
// CommonError 微信返回的通用错误 json
|
||||
type CommonError struct {
|
||||
apiName string
|
||||
ErrCode int64 `json:"errcode"`
|
||||
@@ -17,7 +17,7 @@ func (c *CommonError) Error() string {
|
||||
return fmt.Sprintf("%s Error , errcode=%d , errmsg=%s", c.apiName, c.ErrCode, c.ErrMsg)
|
||||
}
|
||||
|
||||
// NewCommonError 新建CommonError错误,对于无errcode和errmsg的返回也可以返回该通用错误
|
||||
// NewCommonError 新建 CommonError 错误,对于无 errcode 和 errmsg 的返回也可以返回该通用错误
|
||||
func NewCommonError(apiName string, code int64, msg string) *CommonError {
|
||||
return &CommonError{
|
||||
apiName: apiName,
|
||||
@@ -26,7 +26,7 @@ func NewCommonError(apiName string, code int64, msg string) *CommonError {
|
||||
}
|
||||
}
|
||||
|
||||
// DecodeWithCommonError 将返回值按照CommonError解析
|
||||
// DecodeWithCommonError 将返回值按照 CommonError 解析
|
||||
func DecodeWithCommonError(response []byte, apiName string) (err error) {
|
||||
var commError CommonError
|
||||
err = json.Unmarshal(response, &commError)
|
||||
@@ -68,3 +68,18 @@ func DecodeWithError(response []byte, obj interface{}, apiName string) error {
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// HandleFileResponse 通用处理微信等接口返回:有时 JSON 错误,有时文件内容
|
||||
func HandleFileResponse(response []byte, apiName string) ([]byte, error) {
|
||||
var commErr CommonError
|
||||
if err := json.Unmarshal(response, &commErr); err == nil {
|
||||
// 能解析成 JSON,判断是否为错误
|
||||
if commErr.ErrCode != 0 {
|
||||
commErr.apiName = apiName
|
||||
return nil, &commErr
|
||||
}
|
||||
// 能解析成 JSON 且没错误码,极少情况(比如微信返回的业务数据是 JSON 但无 errcode 字段),可根据需要调整
|
||||
}
|
||||
// 不能解析成 JSON,或没错误码,直接返回原始内容
|
||||
return response, nil
|
||||
}
|
||||
|
||||
153
util/http.go
153
util/http.go
@@ -17,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)
|
||||
@@ -24,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
|
||||
}
|
||||
@@ -47,6 +63,9 @@ func HTTPPost(uri string, data string) ([]byte, error) {
|
||||
|
||||
// HTTPPostContext post 请求
|
||||
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 {
|
||||
@@ -57,7 +76,7 @@ func HTTPPostContext(ctx context.Context, uri string, data []byte, header map[st
|
||||
request.Header.Set(key, value)
|
||||
}
|
||||
|
||||
response, err := http.DefaultClient.Do(request)
|
||||
response, err := DefaultHTTPClient.Do(request)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
@@ -69,8 +88,11 @@ func HTTPPostContext(ctx context.Context, uri string, data []byte, header map[st
|
||||
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)
|
||||
@@ -78,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
|
||||
}
|
||||
@@ -90,7 +117,12 @@ func PostJSON(uri string, obj interface{}) ([]byte, error) {
|
||||
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)
|
||||
@@ -100,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
|
||||
}
|
||||
@@ -114,13 +146,41 @@ func PostJSONWithRespContentType(uri string, obj interface{}) ([]byte, string, e
|
||||
return responseData, contentType, err
|
||||
}
|
||||
|
||||
// PostFileByStream 上传文件
|
||||
func PostFileByStream(fieldName, fileName, uri string, byteData []byte) ([]byte, error) {
|
||||
fields := []MultipartFormField{
|
||||
{
|
||||
IsFile: false,
|
||||
Fieldname: fieldName,
|
||||
Filename: fileName,
|
||||
Value: byteData,
|
||||
},
|
||||
}
|
||||
return PostMultipartForm(fields, uri)
|
||||
}
|
||||
|
||||
// PostFile 上传文件
|
||||
func PostFile(fieldName, filename, uri string) ([]byte, error) {
|
||||
func PostFile(fieldName, filePath, uri string) ([]byte, error) {
|
||||
fields := []MultipartFormField{
|
||||
{
|
||||
IsFile: true,
|
||||
Fieldname: fieldName,
|
||||
Filename: filename,
|
||||
FilePath: filePath,
|
||||
Filename: filePath,
|
||||
},
|
||||
}
|
||||
return PostMultipartForm(fields, uri)
|
||||
}
|
||||
|
||||
// PostFileFromReader 上传文件,从 io.Reader 中读取
|
||||
func PostFileFromReader(filedName, filePath, fileName, uri string, reader io.Reader) ([]byte, error) {
|
||||
fields := []MultipartFormField{
|
||||
{
|
||||
IsFile: true,
|
||||
Fieldname: filedName,
|
||||
FilePath: filePath,
|
||||
Filename: fileName,
|
||||
FileReader: reader,
|
||||
},
|
||||
}
|
||||
return PostMultipartForm(fields, uri)
|
||||
@@ -128,14 +188,19 @@ func PostFile(fieldName, filename, uri string) ([]byte, error) {
|
||||
|
||||
// MultipartFormField 保存文件或其他字段信息
|
||||
type MultipartFormField struct {
|
||||
IsFile bool
|
||||
Fieldname string
|
||||
Value []byte
|
||||
Filename string
|
||||
IsFile bool
|
||||
Fieldname string
|
||||
Value []byte
|
||||
FilePath string
|
||||
Filename string
|
||||
FileReader io.Reader
|
||||
}
|
||||
|
||||
// PostMultipartForm 上传文件或其他多个字段
|
||||
func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte, err error) {
|
||||
if uriModifier != nil {
|
||||
uri = uriModifier(uri)
|
||||
}
|
||||
bodyBuf := &bytes.Buffer{}
|
||||
bodyWriter := multipart.NewWriter(bodyBuf)
|
||||
|
||||
@@ -147,18 +212,24 @@ func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte
|
||||
return
|
||||
}
|
||||
|
||||
fh, e := os.Open(field.Filename)
|
||||
if e != nil {
|
||||
err = fmt.Errorf("error opening file , err=%v", e)
|
||||
return
|
||||
}
|
||||
defer fh.Close()
|
||||
|
||||
if _, err = io.Copy(fileWriter, fh); err != nil {
|
||||
return
|
||||
if field.FileReader == nil {
|
||||
fh, e := os.Open(field.FilePath)
|
||||
if e != nil {
|
||||
err = fmt.Errorf("error opening file , err=%v", e)
|
||||
return
|
||||
}
|
||||
_, err = io.Copy(fileWriter, fh)
|
||||
_ = fh.Close()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
} else {
|
||||
if _, err = io.Copy(fileWriter, field.FileReader); err != nil {
|
||||
return
|
||||
}
|
||||
}
|
||||
} else {
|
||||
partWriter, e := bodyWriter.CreateFormField(field.Fieldname)
|
||||
partWriter, e := bodyWriter.CreateFormFile(field.Fieldname, field.Filename)
|
||||
if e != nil {
|
||||
err = e
|
||||
return
|
||||
@@ -173,14 +244,14 @@ 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
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
if resp.StatusCode != http.StatusOK {
|
||||
return nil, err
|
||||
return nil, fmt.Errorf("http code error : uri=%v , statusCode=%v", uri, resp.StatusCode)
|
||||
}
|
||||
respBody, err = io.ReadAll(resp.Body)
|
||||
return
|
||||
@@ -188,13 +259,16 @@ func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte
|
||||
|
||||
// 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
|
||||
}
|
||||
@@ -206,7 +280,7 @@ func PostXML(uri string, obj interface{}) ([]byte, error) {
|
||||
return io.ReadAll(response.Body)
|
||||
}
|
||||
|
||||
// httpWithTLS CA证书
|
||||
// httpWithTLS CA 证书
|
||||
func httpWithTLS(rootCa, key string) (*http.Client, error) {
|
||||
var client *http.Client
|
||||
certData, err := os.ReadFile(rootCa)
|
||||
@@ -217,15 +291,27 @@ func httpWithTLS(rootCa, key string) (*http.Client, error) {
|
||||
config := &tls.Config{
|
||||
Certificates: []tls.Certificate{cert},
|
||||
}
|
||||
tr := &http.Transport{
|
||||
TLSClientConfig: config,
|
||||
DisableCompression: true,
|
||||
|
||||
// 安全地获取 *http.Transport
|
||||
var trans *http.Transport
|
||||
// 尝试从 DefaultHTTPClient 获取 Transport,如果失败则使用默认值
|
||||
if DefaultHTTPClient.Transport != nil {
|
||||
if t, ok := DefaultHTTPClient.Transport.(*http.Transport); ok {
|
||||
trans = t.Clone()
|
||||
}
|
||||
}
|
||||
client = &http.Client{Transport: tr}
|
||||
// 如果无法获取有效的 Transport,使用默认值
|
||||
if trans == nil {
|
||||
trans = http.DefaultTransport.(*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() {
|
||||
@@ -249,6 +335,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
|
||||
|
||||
81
util/http_test.go
Normal file
81
util/http_test.go
Normal file
@@ -0,0 +1,81 @@
|
||||
package util
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// TestHttpWithTLS_NilTransport tests the scenario where DefaultHTTPClient.Transport is nil
|
||||
func TestHttpWithTLS_NilTransport(t *testing.T) {
|
||||
// Save original transport
|
||||
originalTransport := DefaultHTTPClient.Transport
|
||||
defer func() {
|
||||
DefaultHTTPClient.Transport = originalTransport
|
||||
}()
|
||||
|
||||
// Set Transport to nil to simulate the bug scenario
|
||||
DefaultHTTPClient.Transport = nil
|
||||
|
||||
// This should not panic after the fix
|
||||
// Note: This will fail due to invalid cert path, but shouldn't panic on type assertion
|
||||
_, err := httpWithTLS("./testdata/invalid_cert.p12", "password")
|
||||
|
||||
// We expect an error (cert file not found), but NOT a panic
|
||||
if err == nil {
|
||||
t.Error("Expected error due to invalid cert path, but got nil")
|
||||
}
|
||||
}
|
||||
|
||||
// TestHttpWithTLS_CustomTransport tests the scenario where DefaultHTTPClient has a custom Transport
|
||||
func TestHttpWithTLS_CustomTransport(t *testing.T) {
|
||||
// Save original transport
|
||||
originalTransport := DefaultHTTPClient.Transport
|
||||
defer func() {
|
||||
DefaultHTTPClient.Transport = originalTransport
|
||||
}()
|
||||
|
||||
// Set a custom http.Transport
|
||||
customTransport := &http.Transport{
|
||||
MaxIdleConns: 100,
|
||||
}
|
||||
DefaultHTTPClient.Transport = customTransport
|
||||
|
||||
// This should not panic
|
||||
_, err := httpWithTLS("./testdata/invalid_cert.p12", "password")
|
||||
|
||||
// We expect an error (cert file not found), but NOT a panic
|
||||
if err == nil {
|
||||
t.Error("Expected error due to invalid cert path, but got nil")
|
||||
}
|
||||
}
|
||||
|
||||
// CustomRoundTripper is a custom implementation of http.RoundTripper
|
||||
type CustomRoundTripper struct{}
|
||||
|
||||
func (c *CustomRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
|
||||
return http.DefaultTransport.RoundTrip(req)
|
||||
}
|
||||
|
||||
// TestHttpWithTLS_CustomRoundTripper tests the edge case where DefaultHTTPClient has a custom RoundTripper
|
||||
// that is NOT *http.Transport
|
||||
func TestHttpWithTLS_CustomRoundTripper(t *testing.T) {
|
||||
// Save original transport
|
||||
originalTransport := DefaultHTTPClient.Transport
|
||||
defer func() {
|
||||
DefaultHTTPClient.Transport = originalTransport
|
||||
}()
|
||||
|
||||
// Set a custom RoundTripper that is NOT *http.Transport
|
||||
customRoundTripper := &CustomRoundTripper{}
|
||||
DefaultHTTPClient.Transport = customRoundTripper
|
||||
|
||||
// Create a recovery handler to catch potential panic
|
||||
defer func() {
|
||||
if r := recover(); r != nil {
|
||||
t.Errorf("httpWithTLS panicked with custom RoundTripper: %v", r)
|
||||
}
|
||||
}()
|
||||
|
||||
// This might panic if the code doesn't handle non-*http.Transport RoundTripper properly
|
||||
_, _ = httpWithTLS("./testdata/invalid_cert.p12", "password")
|
||||
}
|
||||
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")
|
||||
}
|
||||
}
|
||||
15
wechat.go
15
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,7 +42,7 @@ func NewWechat() *Wechat {
|
||||
return &Wechat{}
|
||||
}
|
||||
|
||||
// SetCache 设置cache
|
||||
// SetCache 设置 cache
|
||||
func (wc *Wechat) SetCache(cache cache.Cache) {
|
||||
wc.cache = cache
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
|
||||
@@ -7,11 +7,36 @@ import (
|
||||
)
|
||||
|
||||
const (
|
||||
// DepartmentSimpleListURL 获取子部门ID列表
|
||||
DepartmentSimpleListURL = "https://qyapi.weixin.qq.com/cgi-bin/department/simplelist?access_token=%s&id=%d"
|
||||
// departmentCreateURL 创建部门
|
||||
departmentCreateURL = "https://qyapi.weixin.qq.com/cgi-bin/department/create?access_token=%s"
|
||||
// departmentUpdateURL 更新部门
|
||||
departmentUpdateURL = "https://qyapi.weixin.qq.com/cgi-bin/department/update?access_token=%s"
|
||||
// departmentDeleteURL 删除部门
|
||||
departmentDeleteURL = "https://qyapi.weixin.qq.com/cgi-bin/department/delete?access_token=%s&id=%d"
|
||||
// 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 获取单个部门详情
|
||||
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
|
||||
@@ -23,8 +48,90 @@ type (
|
||||
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
|
||||
}
|
||||
|
||||
// DepartmentUpdateRequest 更新部门请求
|
||||
type DepartmentUpdateRequest struct {
|
||||
ID int `json:"id"`
|
||||
Name string `json:"name,omitempty"`
|
||||
NameEn string `json:"name_en,omitempty"`
|
||||
ParentID int `json:"parentid,omitempty"`
|
||||
Order int `json:"order,omitempty"`
|
||||
}
|
||||
|
||||
// DepartmentUpdate 更新部门
|
||||
// see https://developer.work.weixin.qq.com/document/path/90206
|
||||
func (r *Client) DepartmentUpdate(req *DepartmentUpdateRequest) 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(departmentUpdateURL, accessToken), req); err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "DepartmentUpdate")
|
||||
}
|
||||
|
||||
// DepartmentDelete 删除部门
|
||||
// @see https://developer.work.weixin.qq.com/document/path/90207
|
||||
func (r *Client) DepartmentDelete(departmentID 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(departmentDeleteURL, accessToken, departmentID)); err != nil {
|
||||
return err
|
||||
}
|
||||
return util.DecodeWithCommonError(response, "DepartmentDelete")
|
||||
}
|
||||
|
||||
// DepartmentSimpleList 获取子部门ID列表
|
||||
// see https://developer.work.weixin.qq.com/document/path/95350
|
||||
func (r *Client) DepartmentSimpleList(departmentID int) ([]*DepartmentID, error) {
|
||||
@@ -36,12 +143,67 @@ func (r *Client) DepartmentSimpleList(departmentID int) ([]*DepartmentID, error)
|
||||
return nil, err
|
||||
}
|
||||
var response []byte
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(DepartmentSimpleListURL, accessToken, departmentID)); err != nil {
|
||||
if response, err = util.HTTPGet(fmt.Sprintf(departmentSimpleListURL, accessToken, departmentID)); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
result := &DepartmentSimpleListResponse{}
|
||||
if err = util.DecodeWithError(response, result, "DepartmentSimpleList"); err != nil {
|
||||
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
|
||||
}
|
||||
return result.DepartmentID, nil
|
||||
|
||||
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
|
||||
}
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user