mirror of
https://github.com/silenceper/wechat.git
synced 2026-02-04 12:52:27 +08:00
Compare commits
213 Commits
v2.0.9-rc.
...
v2.1.10-rc
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
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 | ||
|
|
3cb741ae1a | ||
|
|
da3859261b | ||
|
|
86ceb6af2f | ||
|
|
243f8198ae | ||
|
|
2bc0536c02 | ||
|
|
bbbada1b44 | ||
|
|
5380d5bee7 | ||
|
|
a03f3f9f32 | ||
|
|
9d8b803b33 | ||
|
|
5e0c31bfa9 | ||
|
|
9ad8981ff0 | ||
|
|
57fd96454c | ||
|
|
d09d706946 | ||
|
|
88fc6465bb | ||
|
|
b3cb101899 | ||
|
|
86e036a55b | ||
|
|
a8f7a24ff6 | ||
|
|
df62164811 | ||
|
|
0160f99045 | ||
|
|
430c60a36e | ||
|
|
cac3072199 | ||
|
|
37f9e981d6 | ||
|
|
a07c50fda7 | ||
|
|
eb3dbf1646 | ||
|
|
27e18b6958 | ||
|
|
252fc4838b | ||
|
|
fdaffb6aa2 | ||
|
|
108a65ecf3 | ||
|
|
cc9be30ed1 | ||
|
|
adf142dac2 | ||
|
|
ded5a10f9f | ||
|
|
e1307648fd | ||
|
|
c6325ace85 | ||
|
|
f2e7979a9f | ||
|
|
890e9fed43 | ||
|
|
3cbc95732a | ||
|
|
182339c00f | ||
|
|
e952b1d55a | ||
|
|
4b972c740f | ||
|
|
d5e7c8043e | ||
|
|
56350c3655 | ||
|
|
538c0b4e5f | ||
|
|
8fe9e6dcb6 | ||
|
|
8e81a416c5 | ||
|
|
1b5c5fba67 | ||
|
|
5c4b28acee | ||
|
|
80ce4aefc4 | ||
|
|
0d915d203b | ||
|
|
172c4abde5 | ||
|
|
2f898f80f6 | ||
|
|
4721f7567b | ||
|
|
9cecda0469 | ||
|
|
83e223999b | ||
|
|
e068d53dcb | ||
|
|
8c87c49f2a | ||
|
|
74053fe6ef | ||
|
|
566c3c27cb | ||
|
|
dc24ad4262 | ||
|
|
05ec6a42ae | ||
|
|
efad41bcda | ||
|
|
3fb288d932 | ||
|
|
f5f401e76c | ||
|
|
ab4f427647 | ||
|
|
a9ae64ef63 | ||
|
|
83621a38c6 | ||
|
|
4937f019a0 | ||
|
|
e9489625c6 | ||
|
|
f74869e61c | ||
|
|
fd96154231 | ||
|
|
8621e06a01 | ||
|
|
1e2f909f34 | ||
|
|
00b13cda0d | ||
|
|
c021336a3c | ||
|
|
9294950ab5 | ||
|
|
d776f5c400 | ||
|
|
bc9f483c8e | ||
|
|
d3d91b8d29 | ||
|
|
96c1f98944 | ||
|
|
47adf42208 | ||
|
|
39ed108b11 | ||
|
|
f767b72872 | ||
|
|
d3f1a83d46 | ||
|
|
db205405ee | ||
|
|
e1ef3ea160 | ||
|
|
b9f0e8368d | ||
|
|
9335b13807 |
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
|
||||
|
||||
1
.github/ISSUE_TEMPLATE.md
vendored
1
.github/ISSUE_TEMPLATE.md
vendored
@@ -1,2 +1,3 @@
|
||||
## 问题及现象
|
||||
|
||||
<!-- 描述你的问题现象,报错**贴截图**粘贴或者贴具体信息,提供**必要的代码段**
|
||||
|
||||
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 }}
|
||||
33
.github/workflows/go.yml
vendored
33
.github/workflows/go.yml
vendored
@@ -2,24 +2,29 @@ name: Go
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ master,release-*,v2 ]
|
||||
branches: [ master,release-*,v2,feature/**,fix/** ]
|
||||
pull_request:
|
||||
branches: [ master,release-*,v2 ]
|
||||
branches: [ master,release-*,v2,feature/**,fix/** ]
|
||||
|
||||
jobs:
|
||||
golangci:
|
||||
strategy:
|
||||
matrix:
|
||||
go-version: [1.15.x]
|
||||
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/checkout@v2
|
||||
- name: Setup Golang ${{ matrix.go-version }}
|
||||
uses: actions/setup-go@v5
|
||||
with:
|
||||
go-version: ${{ matrix.go-version }}
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
- name: golangci-lint
|
||||
uses: golangci/golangci-lint-action@v2
|
||||
uses: golangci/golangci-lint-action@v4
|
||||
with:
|
||||
# Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
|
||||
version: v1.31
|
||||
version: v1.52.2
|
||||
build:
|
||||
name: Test
|
||||
runs-on: ubuntu-latest
|
||||
@@ -27,18 +32,24 @@ jobs:
|
||||
redis:
|
||||
image: redis
|
||||
ports:
|
||||
- 6379:6379
|
||||
- 6379:6379
|
||||
options: --entrypoint redis-server
|
||||
memcached:
|
||||
image: memcached
|
||||
ports:
|
||||
- 11211:11211
|
||||
|
||||
# strategy set
|
||||
strategy:
|
||||
matrix:
|
||||
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: ^1.13
|
||||
go-version: ${{ matrix.go }}
|
||||
id: go
|
||||
- name: Test
|
||||
run: go test -v -race ./...
|
||||
run: go test -v -race ./...
|
||||
@@ -36,8 +36,13 @@ linters:
|
||||
- whitespace
|
||||
|
||||
issues:
|
||||
# Excluding configuration per-path, per-linter, per-text and per-source
|
||||
include:
|
||||
- EXC0002 # disable excluding of issues about comments from golint
|
||||
exclude-rules:
|
||||
- linters:
|
||||
- stylecheck
|
||||
text: "ST1000:"
|
||||
# Excluding configuration per-path, per-linter, per-text and per-source
|
||||
- path: _test\.go
|
||||
linters:
|
||||
- gomnd
|
||||
@@ -50,12 +55,12 @@ issues:
|
||||
linters-settings:
|
||||
funlen:
|
||||
lines: 66
|
||||
statements: 40
|
||||
statements: 50
|
||||
|
||||
issues:
|
||||
include:
|
||||
- EXC0002 # disable excluding of issues about comments from golint
|
||||
exclude-rules:
|
||||
- linters:
|
||||
- stylecheck
|
||||
text: "ST1000:"
|
||||
#issues:
|
||||
# include:
|
||||
# - EXC0002 # disable excluding of issues about comments from golint
|
||||
# exclude-rules:
|
||||
# - linters:
|
||||
# - stylecheck
|
||||
# text: "ST1000:"
|
||||
|
||||
37
README.md
37
README.md
@@ -1,18 +1,22 @@
|
||||
# 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版本
|
||||
|
||||
|
||||
## 文档 && 例子
|
||||
|
||||
[API列表](https://github.com/silenceper/wechat/tree/v2/doc/api)
|
||||
|
||||
[Wechat SDK 2.0 文档](https://silenceper.com/wechat)
|
||||
|
||||
[Wechat SDK 2.0 例子](https://github.com/gowechat/example)
|
||||
|
||||
## 快速开始
|
||||
|
||||
```
|
||||
import "github.com/silenceper/wechat/v2"
|
||||
```
|
||||
@@ -20,40 +24,41 @@ import "github.com/silenceper/wechat/v2"
|
||||
以下是一个微信公众号处理消息接收以及回复的例子:
|
||||
|
||||
```go
|
||||
//使用memcache保存access_token,也可选择redis或自定义cache
|
||||
// 使用memcache保存access_token,也可选择redis或自定义cache
|
||||
wc := wechat.NewWechat()
|
||||
memory := cache.NewMemory()
|
||||
cfg := &offConfig.Config{
|
||||
AppID: "xxx",
|
||||
AppSecret: "xxx",
|
||||
Token: "xxx",
|
||||
//EncodingAESKey: "xxxx",
|
||||
// EncodingAESKey: "xxxx",
|
||||
Cache: memory,
|
||||
}
|
||||
officialAccount := wc.GetOfficialAccount(cfg)
|
||||
|
||||
// 传入request和responseWriter
|
||||
server := officialAccount.GetServer(req, rw)
|
||||
//设置接收消息的处理方法
|
||||
// 设置接收消息的处理方法
|
||||
server.SetMessageHandler(func(msg *message.MixMessage) *message.Reply {
|
||||
|
||||
//回复消息:演示回复用户发送的消息
|
||||
// 回复消息:演示回复用户发送的消息
|
||||
text := message.NewText(msg.Content)
|
||||
return &message.Reply{MsgType: message.MsgTypeText, MsgData: text}
|
||||
})
|
||||
|
||||
//处理消息接收以及回复
|
||||
// 处理消息接收以及回复
|
||||
err := server.Serve()
|
||||
if err != nil {
|
||||
fmt.Println(err)
|
||||
return
|
||||
}
|
||||
//发送回复的消息
|
||||
// 发送回复的消息
|
||||
server.Send()
|
||||
|
||||
```
|
||||
|
||||
## 目录说明
|
||||
|
||||
- officialaccount: 微信公众号API
|
||||
- miniprogram: 小程序API
|
||||
- minigame:小游戏API
|
||||
@@ -61,12 +66,22 @@ server.Send()
|
||||
- openplatform:开放平台API
|
||||
- work:企业微信
|
||||
- aispeech:智能对话
|
||||
- doc: api文档
|
||||
|
||||
## 贡献
|
||||
|
||||
- 在[API列表](https://github.com/silenceper/wechat/tree/v2/doc/api)中查看哪些API未实现
|
||||
- 提交issue,描述需要贡献的内容
|
||||
- 完成更改后,提交PR
|
||||
|
||||
## 公众号
|
||||
|
||||
## 感谢以下贡献者
|
||||
|
||||
<a href="https://opencollective.com/gowechat"><img src="https://opencollective.com/gowechat/contributors.svg?width=890" /></a>
|
||||
|
||||
|
||||
## 作者公众号
|
||||
|
||||

|
||||
|
||||
## License
|
||||
|
||||
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)
|
||||
}
|
||||
|
||||
10
cache/memory.go
vendored
10
cache/memory.go
vendored
@@ -5,7 +5,7 @@ import (
|
||||
"time"
|
||||
)
|
||||
|
||||
//Memory struct contains *memcache.Client
|
||||
// Memory struct contains *memcache.Client
|
||||
type Memory struct {
|
||||
sync.Mutex
|
||||
|
||||
@@ -17,14 +17,14 @@ type data struct {
|
||||
Expired time.Time
|
||||
}
|
||||
|
||||
//NewMemory create new memcache
|
||||
// NewMemory create new memcache
|
||||
func NewMemory() *Memory {
|
||||
return &Memory{
|
||||
data: map[string]*data{},
|
||||
}
|
||||
}
|
||||
|
||||
//Get return cached value
|
||||
// Get return cached value
|
||||
func (mem *Memory) Get(key string) interface{} {
|
||||
if ret, ok := mem.data[key]; ok {
|
||||
if ret.Expired.Before(time.Now()) {
|
||||
@@ -48,7 +48,7 @@ func (mem *Memory) IsExist(key string) bool {
|
||||
return false
|
||||
}
|
||||
|
||||
//Set cached value with key and expire time.
|
||||
// Set cached value with key and expire time.
|
||||
func (mem *Memory) Set(key string, val interface{}, timeout time.Duration) (err error) {
|
||||
mem.Lock()
|
||||
defer mem.Unlock()
|
||||
@@ -60,7 +60,7 @@ func (mem *Memory) Set(key string, val interface{}, timeout time.Duration) (err
|
||||
return nil
|
||||
}
|
||||
|
||||
//Delete delete value in memcache.
|
||||
// Delete delete value in memcache.
|
||||
func (mem *Memory) Delete(key string) error {
|
||||
mem.deleteKey(key)
|
||||
return nil
|
||||
|
||||
160
cache/redis.go
vendored
160
cache/redis.go
vendored
@@ -1,111 +1,109 @@
|
||||
package cache
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"context"
|
||||
"crypto/tls"
|
||||
"net"
|
||||
"time"
|
||||
|
||||
"github.com/gomodule/redigo/redis"
|
||||
"github.com/go-redis/redis/v8"
|
||||
)
|
||||
|
||||
//Redis redis cache
|
||||
// Redis .redis cache
|
||||
type Redis struct {
|
||||
conn *redis.Pool
|
||||
ctx context.Context
|
||||
conn redis.UniversalClient
|
||||
}
|
||||
|
||||
//RedisOpts redis 连接属性
|
||||
// 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" yml:"host"`
|
||||
Username string `json:"username" yaml:"username"`
|
||||
Password string `json:"password" yml:"password"`
|
||||
Database int `json:"database" yml:"database"`
|
||||
MaxIdle int `json:"max_idle" yml:"max_idle"`
|
||||
MaxActive int `json:"max_active" yml:"max_active"`
|
||||
IdleTimeout int `json:"idle_timeout" yml:"idle_timeout"` // second
|
||||
UseTLS bool `json:"use_tls" yml:"use_tls"` // 是否使用TLS
|
||||
}
|
||||
|
||||
//NewRedis 实例化
|
||||
func NewRedis(opts *RedisOpts) *Redis {
|
||||
pool := &redis.Pool{
|
||||
MaxActive: opts.MaxActive,
|
||||
MaxIdle: opts.MaxIdle,
|
||||
IdleTimeout: time.Second * time.Duration(opts.IdleTimeout),
|
||||
Dial: func() (redis.Conn, error) {
|
||||
return redis.Dial("tcp", opts.Host,
|
||||
redis.DialDatabase(opts.Database),
|
||||
redis.DialPassword(opts.Password),
|
||||
)
|
||||
},
|
||||
TestOnBorrow: func(conn redis.Conn, t time.Time) error {
|
||||
if time.Since(t) < time.Minute {
|
||||
return nil
|
||||
}
|
||||
_, err := conn.Do("PING")
|
||||
return err
|
||||
},
|
||||
// NewRedis 实例化
|
||||
func NewRedis(ctx context.Context, opts *RedisOpts) *Redis {
|
||||
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,
|
||||
}
|
||||
return &Redis{pool}
|
||||
|
||||
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}
|
||||
}
|
||||
|
||||
//SetRedisPool 设置redis连接池
|
||||
func (r *Redis) SetRedisPool(pool *redis.Pool) {
|
||||
r.conn = pool
|
||||
}
|
||||
|
||||
//SetConn 设置conn
|
||||
func (r *Redis) SetConn(conn *redis.Pool) {
|
||||
// SetConn 设置conn
|
||||
func (r *Redis) SetConn(conn redis.UniversalClient) {
|
||||
r.conn = conn
|
||||
}
|
||||
|
||||
//Get 获取一个值
|
||||
// SetRedisCtx 设置redis ctx 参数
|
||||
func (r *Redis) SetRedisCtx(ctx context.Context) {
|
||||
r.ctx = ctx
|
||||
}
|
||||
|
||||
// Get 获取一个值
|
||||
func (r *Redis) Get(key string) interface{} {
|
||||
conn := r.conn.Get()
|
||||
defer conn.Close()
|
||||
|
||||
var data []byte
|
||||
var err error
|
||||
if data, err = redis.Bytes(conn.Do("GET", key)); err != nil {
|
||||
return nil
|
||||
}
|
||||
var reply interface{}
|
||||
if err = json.Unmarshal(data, &reply); err != nil {
|
||||
return nil
|
||||
}
|
||||
|
||||
return reply
|
||||
return r.GetContext(r.ctx, key)
|
||||
}
|
||||
|
||||
//Set 设置一个值
|
||||
func (r *Redis) Set(key string, val interface{}, timeout time.Duration) (err error) {
|
||||
conn := r.conn.Get()
|
||||
defer conn.Close()
|
||||
|
||||
var data []byte
|
||||
if data, err = json.Marshal(val); err != nil {
|
||||
return
|
||||
// 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
|
||||
}
|
||||
|
||||
_, err = conn.Do("SETEX", key, int64(timeout/time.Second), data)
|
||||
|
||||
return
|
||||
return result
|
||||
}
|
||||
|
||||
//IsExist 判断key是否存在
|
||||
// Set 设置一个值
|
||||
func (r *Redis) Set(key string, val interface{}, timeout time.Duration) error {
|
||||
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 {
|
||||
conn := r.conn.Get()
|
||||
defer conn.Close()
|
||||
|
||||
a, _ := conn.Do("EXISTS", key)
|
||||
i := a.(int64)
|
||||
return i > 0
|
||||
return r.IsExistContext(r.ctx, key)
|
||||
}
|
||||
|
||||
//Delete 删除
|
||||
// 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 {
|
||||
conn := r.conn.Get()
|
||||
defer conn.Close()
|
||||
|
||||
if _, err := conn.Do("DEL", key); err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
return r.DeleteContext(r.ctx, key)
|
||||
}
|
||||
|
||||
// DeleteContext 删除
|
||||
func (r *Redis) DeleteContext(ctx context.Context, key string) error {
|
||||
return r.conn.Del(ctx, key).Err()
|
||||
}
|
||||
|
||||
33
cache/redis_test.go
vendored
33
cache/redis_test.go
vendored
@@ -1,33 +1,46 @@
|
||||
package cache
|
||||
|
||||
import (
|
||||
"context"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/alicebob/miniredis/v2"
|
||||
)
|
||||
|
||||
func TestRedis(t *testing.T) {
|
||||
opts := &RedisOpts{
|
||||
Host: "127.0.0.1:6379",
|
||||
server, err := miniredis.Run()
|
||||
if err != nil {
|
||||
t.Error("miniredis.Run Error", err)
|
||||
}
|
||||
redis := NewRedis(opts)
|
||||
t.Cleanup(server.Close)
|
||||
var (
|
||||
timeoutDuration = time.Second
|
||||
ctx = context.Background()
|
||||
opts = &RedisOpts{
|
||||
Host: server.Addr(),
|
||||
}
|
||||
redis = NewRedis(ctx, opts)
|
||||
val = "silenceper"
|
||||
key = "username"
|
||||
)
|
||||
redis.SetConn(redis.conn)
|
||||
var err error
|
||||
timeoutDuration := 1 * time.Second
|
||||
redis.SetRedisCtx(ctx)
|
||||
|
||||
if err = redis.Set("username", "silenceper", timeoutDuration); err != nil {
|
||||
if err = redis.Set(key, val, timeoutDuration); err != nil {
|
||||
t.Error("set Error", err)
|
||||
}
|
||||
|
||||
if !redis.IsExist("username") {
|
||||
if !redis.IsExist(key) {
|
||||
t.Error("IsExist Error")
|
||||
}
|
||||
|
||||
name := redis.Get("username").(string)
|
||||
if name != "silenceper" {
|
||||
name := redis.Get(key).(string)
|
||||
if name != val {
|
||||
t.Error("get Error")
|
||||
}
|
||||
|
||||
if err = redis.Delete("username"); err != nil {
|
||||
if err = redis.Delete(key); err != nil {
|
||||
t.Errorf("delete Error , err=%v", err)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,6 +1,24 @@
|
||||
package credential
|
||||
|
||||
//AccessTokenHandle AccessToken 接口
|
||||
import "context"
|
||||
|
||||
// AccessTokenHandle AccessToken 接口
|
||||
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
|
||||
GetAccessTokenContext(ctx context.Context) (accessToken string, err error)
|
||||
}
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package credential
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"sync"
|
||||
@@ -11,19 +12,21 @@ 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 微信公众号cache key前缀
|
||||
CacheKeyOfficialAccountPrefix = "gowechat_officialaccount_"
|
||||
//CacheKeyMiniProgramPrefix 小程序cache key前缀
|
||||
// CacheKeyMiniProgramPrefix 小程序cache key前缀
|
||||
CacheKeyMiniProgramPrefix = "gowechat_miniprogram_"
|
||||
//CacheKeyWorkPrefix 企业微信cache key前缀
|
||||
// CacheKeyWorkPrefix 企业微信cache key前缀
|
||||
CacheKeyWorkPrefix = "gowechat_work_"
|
||||
)
|
||||
|
||||
//DefaultAccessToken 默认AccessToken 获取
|
||||
// DefaultAccessToken 默认AccessToken 获取
|
||||
type DefaultAccessToken struct {
|
||||
appID string
|
||||
appSecret string
|
||||
@@ -32,8 +35,8 @@ type DefaultAccessToken struct {
|
||||
accessTokenLock *sync.Mutex
|
||||
}
|
||||
|
||||
//NewDefaultAccessToken new DefaultAccessToken
|
||||
func NewDefaultAccessToken(appID, appSecret, cacheKeyPrefix string, cache cache.Cache) AccessTokenHandle {
|
||||
// NewDefaultAccessToken new DefaultAccessToken
|
||||
func NewDefaultAccessToken(appID, appSecret, cacheKeyPrefix string, cache cache.Cache) AccessTokenContextHandle {
|
||||
if cache == nil {
|
||||
panic("cache is ineed")
|
||||
}
|
||||
@@ -46,7 +49,7 @@ func NewDefaultAccessToken(appID, appSecret, cacheKeyPrefix string, cache cache.
|
||||
}
|
||||
}
|
||||
|
||||
//ResAccessToken struct
|
||||
// ResAccessToken struct
|
||||
type ResAccessToken struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -54,77 +57,196 @@ type ResAccessToken struct {
|
||||
ExpiresIn int64 `json:"expires_in"`
|
||||
}
|
||||
|
||||
//GetAccessToken 获取access_token,先从cache中获取,没有则从服务端获取
|
||||
// GetAccessToken 获取access_token,先从cache中获取,没有则从服务端获取
|
||||
func (ak *DefaultAccessToken) GetAccessToken() (accessToken string, err error) {
|
||||
return ak.GetAccessTokenContext(context.Background())
|
||||
}
|
||||
|
||||
// GetAccessTokenContext 获取access_token,先从cache中获取,没有则从服务端获取
|
||||
func (ak *DefaultAccessToken) GetAccessTokenContext(ctx context.Context) (accessToken string, err error) {
|
||||
// 先从cache中取
|
||||
accessTokenCacheKey := fmt.Sprintf("%s_access_token_%s", ak.cacheKeyPrefix, ak.appID)
|
||||
|
||||
if val := ak.cache.Get(accessTokenCacheKey); val != nil {
|
||||
return val.(string), nil
|
||||
if accessToken = val.(string); accessToken != "" {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
//加上lock,是为了防止在并发获取token时,cache刚好失效,导致从微信服务器上获取到不同token
|
||||
// 加上lock,是为了防止在并发获取token时,cache刚好失效,导致从微信服务器上获取到不同token
|
||||
ak.accessTokenLock.Lock()
|
||||
defer ak.accessTokenLock.Unlock()
|
||||
|
||||
// 双检,防止重复从微信服务器获取
|
||||
if val := ak.cache.Get(accessTokenCacheKey); val != nil {
|
||||
return val.(string), nil
|
||||
if accessToken = val.(string); accessToken != "" {
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
//cache失效,从微信服务器获取
|
||||
// cache失效,从微信服务器获取
|
||||
var resAccessToken ResAccessToken
|
||||
resAccessToken, err = GetTokenFromServer(fmt.Sprintf(accessTokenURL, ak.appID, ak.appSecret))
|
||||
if err != nil {
|
||||
if resAccessToken, err = GetTokenFromServerContext(ctx, fmt.Sprintf(accessTokenURL, ak.appID, ak.appSecret)); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
expires := resAccessToken.ExpiresIn - 1500
|
||||
err = ak.cache.Set(accessTokenCacheKey, resAccessToken.AccessToken, time.Duration(expires)*time.Second)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
accessToken = resAccessToken.AccessToken
|
||||
return
|
||||
}
|
||||
|
||||
//WorkAccessToken 企业微信AccessToken 获取
|
||||
type WorkAccessToken struct {
|
||||
CorpID string
|
||||
CorpSecret string
|
||||
// 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
|
||||
}
|
||||
|
||||
//NewWorkAccessToken new WorkAccessToken
|
||||
func NewWorkAccessToken(corpID, corpSecret, cacheKeyPrefix string, cache cache.Cache) AccessTokenHandle {
|
||||
// NewStableAccessToken new StableAccessToken
|
||||
func NewStableAccessToken(appID, appSecret, cacheKeyPrefix string, cache cache.Cache) AccessTokenContextHandle {
|
||||
if cache == nil {
|
||||
panic("cache the not exist")
|
||||
panic("cache is need")
|
||||
}
|
||||
return &WorkAccessToken{
|
||||
CorpID: corpID,
|
||||
CorpSecret: corpSecret,
|
||||
return &StableAccessToken{
|
||||
appID: appID,
|
||||
appSecret: appSecret,
|
||||
cache: cache,
|
||||
cacheKeyPrefix: cacheKeyPrefix,
|
||||
accessTokenLock: new(sync.Mutex),
|
||||
}
|
||||
}
|
||||
|
||||
//GetAccessToken 企业微信获取access_token,先从cache中获取,没有则从服务端获取
|
||||
func (ak *WorkAccessToken) GetAccessToken() (accessToken string, err error) {
|
||||
//加上lock,是为了防止在并发获取token时,cache刚好失效,导致从微信服务器上获取到不同token
|
||||
// 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()
|
||||
accessTokenCacheKey := fmt.Sprintf("%s_access_token_%s", ak.cacheKeyPrefix, ak.CorpID)
|
||||
|
||||
// 双检,防止重复从微信服务器获取
|
||||
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, 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 is needed")
|
||||
}
|
||||
return &WorkAccessToken{
|
||||
CorpID: corpID,
|
||||
CorpSecret: corpSecret,
|
||||
AgentID: agentID,
|
||||
cache: cache,
|
||||
cacheKeyPrefix: cacheKeyPrefix,
|
||||
accessTokenLock: new(sync.Mutex),
|
||||
}
|
||||
}
|
||||
|
||||
// GetAccessToken 企业微信获取access_token,先从cache中获取,没有则从服务端获取
|
||||
func (ak *WorkAccessToken) GetAccessToken() (accessToken string, err error) {
|
||||
return ak.GetAccessTokenContext(context.Background())
|
||||
}
|
||||
|
||||
// GetAccessTokenContext 企业微信获取access_token,先从cache中获取,没有则从服务端获取
|
||||
func (ak *WorkAccessToken) GetAccessTokenContext(ctx context.Context) (accessToken string, err error) {
|
||||
// 加上lock,是为了防止在并发获取token时,cache刚好失效,导致从微信服务器上获取到不同token
|
||||
ak.accessTokenLock.Lock()
|
||||
defer ak.accessTokenLock.Unlock()
|
||||
|
||||
// 构建缓存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)
|
||||
return
|
||||
}
|
||||
|
||||
//cache失效,从微信服务器获取
|
||||
// cache失效,从微信服务器获取
|
||||
var resAccessToken ResAccessToken
|
||||
resAccessToken, err = GetTokenFromServer(fmt.Sprintf(workAccessTokenURL, ak.CorpID, ak.CorpSecret))
|
||||
resAccessToken, err = GetTokenFromServerContext(ctx, fmt.Sprintf(workAccessTokenURL, ak.CorpID, ak.CorpSecret))
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
@@ -134,14 +256,20 @@ func (ak *WorkAccessToken) GetAccessToken() (accessToken string, err error) {
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
accessToken = resAccessToken.AccessToken
|
||||
return
|
||||
}
|
||||
|
||||
//GetTokenFromServer 强制从微信服务器获取token
|
||||
// GetTokenFromServer 强制从微信服务器获取token
|
||||
func GetTokenFromServer(url string) (resAccessToken ResAccessToken, err error) {
|
||||
return GetTokenFromServerContext(context.Background(), url)
|
||||
}
|
||||
|
||||
// GetTokenFromServerContext 强制从微信服务器获取token
|
||||
func GetTokenFromServerContext(ctx context.Context, url string) (resAccessToken ResAccessToken, err error) {
|
||||
var body []byte
|
||||
body, err = util.HTTPGet(url)
|
||||
body, err = util.HTTPGetContext(ctx, url)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
@@ -7,6 +7,7 @@ import (
|
||||
"gopkg.in/h2non/gock.v1"
|
||||
)
|
||||
|
||||
// TestGetTicketFromServer .
|
||||
func TestGetTicketFromServer(t *testing.T) {
|
||||
defer gock.Off()
|
||||
gock.New(getTicketURL).Reply(200).JSON(&ResTicket{Ticket: "mock-ticket", ExpiresIn: 10})
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package credential
|
||||
|
||||
import (
|
||||
context2 "context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"sync"
|
||||
@@ -10,19 +11,19 @@ import (
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
//获取ticket的url
|
||||
// getTicketURL 获取ticket的url
|
||||
const getTicketURL = "https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=%s&type=jsapi"
|
||||
|
||||
//DefaultJsTicket 默认获取js ticket方法
|
||||
// DefaultJsTicket 默认获取js ticket方法
|
||||
type DefaultJsTicket struct {
|
||||
appID string
|
||||
cacheKeyPrefix string
|
||||
cache cache.Cache
|
||||
//jsAPITicket 读写锁 同一个AppID一个
|
||||
// jsAPITicket 读写锁 同一个AppID一个
|
||||
jsAPITicketLock *sync.Mutex
|
||||
}
|
||||
|
||||
//NewDefaultJsTicket new
|
||||
// NewDefaultJsTicket new
|
||||
func NewDefaultJsTicket(appID string, cacheKeyPrefix string, cache cache.Cache) JsTicketHandle {
|
||||
return &DefaultJsTicket{
|
||||
appID: appID,
|
||||
@@ -40,9 +41,19 @@ type ResTicket struct {
|
||||
ExpiresIn int64 `json:"expires_in"`
|
||||
}
|
||||
|
||||
//GetTicket 获取jsapi_ticket
|
||||
// GetTicket 获取jsapi_ticket
|
||||
func (js *DefaultJsTicket) GetTicket(accessToken string) (ticketStr string, err error) {
|
||||
//先从cache中取
|
||||
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 {
|
||||
return val.(string), 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
|
||||
|
||||
//JsTicketHandle js ticket获取
|
||||
import context2 "context"
|
||||
|
||||
// JsTicketHandle js ticket获取
|
||||
type JsTicketHandle interface {
|
||||
//GetTicket 获取ticket
|
||||
// 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
|
||||
}
|
||||
2
doc.go
2
doc.go
@@ -7,4 +7,6 @@ Package wechat provide wechat sdk for go
|
||||
更多信息:https://github.com/silenceper/wechat
|
||||
|
||||
*/
|
||||
|
||||
// Package wechat provide wechat sdk for go
|
||||
package wechat
|
||||
|
||||
17
doc/api/README.md
Normal file
17
doc/api/README.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# API 文档
|
||||
|
||||
已完成以及未完成API列表汇总
|
||||
|
||||
如果有兴趣参与贡献,可以在具体的API表格后面标识自己为贡献者以及完成时间,例如:
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |贡献者|完成时间|
|
||||
| :---------------------: | -------- | :------------------------- | ---------- | -------- |-------- |-------- |
|
||||
| 获取公众号类目 | GET | /wxaapi/newtmpl/getcategory | NO | |silenceper| 2021-12-20|
|
||||
|
||||
- [微信公众号](./officialaccount.md)
|
||||
- [小程序](./miniprogram.md)
|
||||
- [小游戏](./minigame.md)
|
||||
- [开放平台](./oplatform.md)
|
||||
- [微信支付](./wxpay.md)
|
||||
- [企业微信](./work.md)
|
||||
- [智能对话](./aispeech.md)
|
||||
3
doc/api/aispeech.md
Normal file
3
doc/api/aispeech.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# 智能对话
|
||||
|
||||
TODO
|
||||
3
doc/api/minigame.md
Normal file
3
doc/api/minigame.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# 小游戏
|
||||
|
||||
TODO
|
||||
50
doc/api/miniprogram.md
Normal file
50
doc/api/miniprogram.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# 小程序
|
||||
|
||||
## 基础接口
|
||||
|
||||
TODO
|
||||
|
||||
## 内容安全
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/sec-check/security.mediaCheckAsync.html)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| :-------------------------------: | -------- | :------------------------------- | ---------- | -------------------------------------- |
|
||||
| 异步校验图片/音频 <sub>v1.0</sub> | POST | /wxa/media_check_async | YES | (security *Security) MediaCheckAsyncV1 |
|
||||
| 同步校验一张图片 <sub>v1.0</sub> | POST | /wxa/img_sec_check | YES | (security *Security) ImageCheckV1 |
|
||||
| 异步校验图片/音频 | POST | /wxa/media_check_async?version=2 | YES | (security *Security) MediaCheckAsync |
|
||||
| 同步检查一段文本 <sub>v1.0</sub> | POST | /wxa/msg_sec_check | YES | (security *Security) MsgCheckV1 |
|
||||
| 同步检查一段文本 | POST | /wxa/msg_sec_check?version=2 | YES | (security *Security) MsgCheck |
|
||||
|
||||
|
||||
## OCR
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/ocr/ocr.bankcard.html)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| :------------: | -------- | :--------------------- | ---------- | -------- |
|
||||
| 银行卡识别 | POST | /cv/ocr/bankcard | | |
|
||||
| 营业执照识别 | POST | /cv/ocr/bizlicense | | |
|
||||
| 驾驶证识别 | POST | /cv/ocr/drivinglicense | | |
|
||||
| 身份证识别 | POST | /cv/ocr/idcard | | |
|
||||
| 通用印刷体识别 | POST | /cv/ocr/comm | | |
|
||||
| 行驶证识别 | POST | /cv/ocr/driving | | |
|
||||
|
||||
|
||||
## 手机号
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/phonenumber/phonenumber.getPhoneNumber.html)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| :----------------: | -------- | :------------------------------- | ---------- | ----------------------------------- |
|
||||
| code换取用户手机号 | POST | /wxa/business/getuserphonenumber | YES | (business *Business) GetPhoneNumber |
|
||||
|
||||
|
||||
## 安全风控
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/safety-control-capability/riskControl.getUserRiskRank.html)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| :----------------: | -------- | :------------------- | ---------- | ------------------------------------------ |
|
||||
| 获取用户的安全等级 | POST | /wxa/getuserriskrank | YES | (riskControl *RiskControl) GetUserRiskRank |
|
||||
|
||||
238
doc/api/officialaccount.md
Normal file
238
doc/api/officialaccount.md
Normal file
@@ -0,0 +1,238 @@
|
||||
# 微信公众号 API 列表
|
||||
|
||||
## 基础接口
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Get_access_token.html)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| :-----------------------: | -------- | :------------------------- | ---------- | -------- |
|
||||
| 获取 Access token | GET | /cgi-bin/token | YES | |
|
||||
| 获取微信服务器 IP 地址 | GET | /cgi-bin/get_api_domain_ip | YES | |
|
||||
| 获取微信 callback IP 地址 | GET | /cgi-bin/getcallbackip | YES | |
|
||||
| 清理接口调用次数 | POST | /cgi-bin/clear_quota | YES | |
|
||||
|
||||
## 订阅通知
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| -------------------- | -------- | -------------------------------------- | ---------- | -------------------------------------------- |
|
||||
| 选用模板 | POST | /wxaapi/newtmpl/addtemplate | YES | (tpl \*Subscribe) Add |
|
||||
| 删除模板 | POST | /wxaapi/newtmpl/deltemplate | YES | (tpl \*Subscribe) Delete |
|
||||
| 获取公众号类目 | GET | /wxaapi/newtmpl/getcategory | YES | (tpl \*Subscribe) GetCategory |
|
||||
| 获取模板中的关键词 | GET | /wxaapi/newtmpl/getpubtemplatekeywords | YES | (tpl \*Subscribe) GetPubTplKeyWordsByID |
|
||||
| 获取类目下的公共模板 | GET | /wxaapi/newtmpl/getpubtemplatetitles | YES | (tpl \*Subscribe) GetPublicTemplateTitleList |
|
||||
| 获取私有模板列表 | GET | /wxaapi/newtmpl/gettemplate | YES | (tpl \*Subscribe) List() |
|
||||
| 发送订阅通知 | POST | /cgi-bin/message/subscribe/bizsend | YES | (tpl \*Subscribe) Send |
|
||||
|
||||
## 客服消息
|
||||
|
||||
### PC 客服能力
|
||||
|
||||
#### 客服管理
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Customer_Service/Customer_Service_Management.html)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| ---------------- | --------- | -------------------------------------- | ---------- | -------------------------------- |
|
||||
| 获取客服基本信息 | GET | /cgi-bin/customservice/getkflist | YES | (csm \*Manager) List |
|
||||
| 添加客服帐号 | POST | /customservice/kfaccount/add | YES | (csm \*Manager) Add |
|
||||
| 邀请绑定客服帐号 | POST | /customservice/kfaccount/inviteworker | YES | (csm \*Manager) InviteBind |
|
||||
| 设置客服信息 | POST | /customservice/kfaccount/update | YES | (csm \*Manager) Update |
|
||||
| 上传客服头像 | POST/FORM | /customservice/kfaccount/uploadheadimg | YES | (csm \*Manager) UploadHeadImg |
|
||||
| 删除客服帐号 | POST | /customservice/kfaccount/del | YES | (csm \*Manager) Delete |
|
||||
| 获取在线客服 | POST | /cgi-bin/customservice/getonlinekflist | YES | (csm \*Manager) OnlineList |
|
||||
| 下发客服输入状态 | POST | /cgi-bin/message/custom/typing | YES | (csm \*Manager) SendTypingStatus |
|
||||
|
||||
#### 会话控制
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Customer_Service/Session_control.html)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| ------------------ | -------- | --------------------------------------- | ---------- | -------- |
|
||||
| 创建会话 | POST | /customservice/kfsession/create | NO | |
|
||||
| 获取客户会话状态 | GET | /customservice/kfsession/getsession | NO | |
|
||||
| 获取客服会话列表 | GET | /customservice/kfsession/getsessionlist | NO | |
|
||||
| 获取未接入会话列表 | POST | /customservice/kfsession/getwaitcase | NO | |
|
||||
|
||||
#### 获取聊天记录
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Customer_Service/Obtain_chat_transcript.html)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| ------------ | -------- | ----------------------------------- | ---------- | -------- |
|
||||
| 获取聊天记录 | POST | /customservice/msgrecord/getmsglist | NO | |
|
||||
|
||||
### 对话能力
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide.html)
|
||||
|
||||
#### 顾问管理
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| ------------------------------ | -------- | -------------------------------------- | ---------- | -------- |
|
||||
| 添加顾问 | POST | /cgi-bin/guide/addguideacct | NO | |
|
||||
| 获取顾问信息 | POST | /cgi-bin/guide/getguideacct | NO | |
|
||||
| 修改顾问信息 | POST | /cgi-bin/guide/updateguideacct | NO | |
|
||||
| 删除顾问 | POST | /cgi-bin/guide/delguideacct | NO | |
|
||||
| 获取服务号顾问列表 | POST | /cgi-bin/guide/getguideacctlist | NO | |
|
||||
| 生成顾问二维码 | POST | /cgi-bin/guide/guidecreateqrcode | NO | |
|
||||
| 获取顾问聊天记录 | POST | /cgi-bin/guide/getguidebuyerchatrecord | NO | |
|
||||
| 设置快捷回复与关注自动回复 | POST | /cgi-bin/guide/setguideconfig | NO | |
|
||||
| 获取快捷回复与关注自动回复 | POST | /cgi-bin/guide/getguideconfig | NO | |
|
||||
| 设置敏感词与离线自动回复 | POST | /cgi-bin/guide/setguideacctconfig | NO | |
|
||||
| 获取离线自动回复与敏感词 | POST | /cgi-bin/guide/getguideacctconfig | NO | |
|
||||
| 允许微信用户复制小程序页面路径 | POST | /cgi-bin/guide/pushshowwxapathmenu | NO | |
|
||||
| 新建顾问分组 | POST | /cgi-bin/guide/newguidegroup | NO | |
|
||||
| 获取顾问分组列表 | POST | /cgi-bin/guide/getguidegrouplist | NO | |
|
||||
| 获取顾问分组信息 | POST | /cgi-bin/guide/getgroupinfo | NO | |
|
||||
| 分组内添加顾问 | POST | /cgi-bin/guide/addguide2guidegroup | NO | |
|
||||
| 分组内删除顾问 | POST | /cgi-bin/guide/delguide2guidegroup | NO | |
|
||||
| 获取顾问所在分组 | POST | /cgi-bin/guide/getgroupbyguide | NO | |
|
||||
| 删除指定顾问分组 | POST | /cgi-bin/guide/delguidegroup | NO | |
|
||||
|
||||
#### 客户管理
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| ------------------------ | -------- | ------------------------------------------- | ---------- | -------- |
|
||||
| 为顾问分配客户 | POST | /cgi-bin/guide/addguidebuyerrelation | NO | |
|
||||
| 为顾问移除客户 | POST | /cgi-bin/guide/delguidebuyerrelation | NO | |
|
||||
| 获取顾问的客户列表 | POST | /cgi-bin/guide/getguidebuyerrelationlist | NO | |
|
||||
| 为客户更换顾问 | POST | /cgi-bin/guide/rebindguideacctforbuyer | NO | |
|
||||
| 修改客户昵称 | POST | /cgi-bin/guide/updateguidebuyerrelation | NO | |
|
||||
| 查询客户所属顾问 | POST | /cgi-bin/guide/getguidebuyerrelationbybuyer | NO | |
|
||||
| 查询指定顾问和客户的关系 | POST | /cgi-bin/guide/getguidebuyerrelation | NO | |
|
||||
|
||||
#### 标签管理
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| ------------------ | -------- | -------------------------------------- | ---------- | -------- |
|
||||
| 新建标签类型 | POST | /cgi-bin/guide/newguidetagoption | NO | |
|
||||
| 删除标签类型 | POST | /cgi-bin/guide/delguidetagoption | NO | |
|
||||
| 为标签添加可选值 | POST | /cgi-bin/guide/addguidetagoption | NO | |
|
||||
| 获取标签和可选值 | POST | /cgi-bin/guide/getguidetagoption | NO | |
|
||||
| 为客户设置标签 | POST | /cgi-bin/guide/addguidebuyertag | NO | |
|
||||
| 查询客户标签 | POST | /cgi-bin/guide/getguidebuyertag | NO | |
|
||||
| 根据标签值筛选客户 | POST | /cgi-bin/guide/queryguidebuyerbytag | NO | |
|
||||
| 删除客户标签 | POST | /cgi-bin/guide/delguidebuyertag | NO | |
|
||||
| 设置自定义客户信息 | POST | /cgi-bin/guide/addguidebuyerdisplaytag | NO | |
|
||||
| 获取自定义客户信息 | POST | /cgi-bin/guide/getguidebuyerdisplaytag | NO | |
|
||||
|
||||
#### 素材管理
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| ------------------ | -------- | ------------------------------------ | ---------- | -------- |
|
||||
| 添加小程序卡片素材 | POST | /cgi-bin/guide/setguidecardmaterial | NO | |
|
||||
| 查询小程序卡片素材 | POST | /cgi-bin/guide/getguidecardmaterial | NO | |
|
||||
| 删除小程序卡片素材 | POST | /cgi-bin/guide/delguidecardmaterial | NO | |
|
||||
| 添加图片素材 | POST | /cgi-bin/guide/setguideimagematerial | NO | |
|
||||
| 查询图片素材 | POST | /cgi-bin/guide/getguideimagematerial | NO | |
|
||||
| 删除图片素材 | POST | /cgi-bin/guide/delguideimagematerial | NO | |
|
||||
| 添加文字素材 | POST | /cgi-bin/guide/setguidewordmaterial | NO | |
|
||||
| 查询文字素材 | POST | /cgi-bin/guide/getguidewordmaterial | NO | |
|
||||
| 删除文字素材 | POST | /cgi-bin/guide/delguidewordmaterial | NO | |
|
||||
|
||||
#### 群发任务管理
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/task-account/shopping-guide.addGuideMassendJob.html)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| -------------------- | -------- | ------------------------------------- | ---------- | -------- |
|
||||
| 添加群发任务 | POST | /cgi-bin/guide/addguidemassendjob | NO | |
|
||||
| 获取群发任务列表 | POST | /cgi-bin/guide/getguidemassendjoblist | NO | |
|
||||
| 获取指定群发任务信息 | POST | /cgi-bin/guide/getguidemassendjob | NO | |
|
||||
| 修改群发任务 | POST | /cgi-bin/guide/updateguidemassendjob | NO | |
|
||||
| 取消群发任务 | POST | /cgi-bin/guide/cancelguidemassendjob | NO | |
|
||||
|
||||
## 微信网页开发
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_webpage_authorization.html)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| ----------------------------------------------------------------------- | -------- | --------------------------------------------------- | ---------- | ------------------------------------ |
|
||||
| 获取跳转的 url 地址 | GET | https://open.weixin.qq.com/connect/oauth2/authorize | YES | (oauth \*Oauth) GetRedirectURL |
|
||||
| 获取网页应用跳转的 url 地址 | GET | https://open.weixin.qq.com/connect/qrconnect | YES | (oauth \*Oauth) GetWebAppRedirectURL |
|
||||
| 通过网页授权的 code 换取 access_token(区别于 context 中的 access_token) | GET | /sns/oauth2/access_token | YES | (oauth \*Oauth) GetUserAccessToken |
|
||||
| 刷新 access_token | GET | /sns/oauth2/refresh_token? | YES | (oauth \*Oauth) RefreshAccessToken |
|
||||
| 检验 access_token 是否有效 | GET | /sns/auth | YES | (oauth \*Oauth) CheckAccessToken( |
|
||||
| 拉取用户信息(需 scope 为 snsapi_userinfo) | GET | /sns/userinfo | YES | (oauth \*Oauth) GetUserInfo |
|
||||
| 获取 jssdk 需要的配置参数 | GET | /cgi-bin/ticket/getticket | YES | (js \*Js) GetConfig |
|
||||
|
||||
## 素材管理
|
||||
|
||||
## 草稿箱
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Draft_Box/Add_draft.html)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| --------------------------- | -------- | ------------------------------------------------------------ | ---------- | ----------------------------- |
|
||||
| 新建草稿 | POST | /cgi-bin/draft/add | YES | (draft \*Draft) AddDraft |
|
||||
| 获取草稿 | POST | /cgi-bin/draft/get | YES | (draft \*Draft) GetDraft |
|
||||
| 删除草稿 | POST | /cgi-bin/draft/delete | YES | (draft \*Draft) DeleteDraft |
|
||||
| 修改草稿 | POST | /cgi-bin/draft/update | YES | (draft \*Draft) UpdateDraft |
|
||||
| 获取草稿总数 | GET | /cgi-bin/draft/count | YES | (draft \*Draft) CountDraft |
|
||||
| 获取草稿列表 | POST | /cgi-bin/draft/batchget | YES | (draft \*Draft) PaginateDraft |
|
||||
| MP 端开关(仅内测期间使用) | POST | /cgi-bin/draft/switch<br />/cgi-bin/draft/switch?checkonly=1 | NO | |
|
||||
|
||||
## 发布能力
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/doc/offiaccount/Publish/Publish.html)
|
||||
|
||||
说明:「发表记录」包括群发和发布。
|
||||
|
||||
注意:该接口,只能处理 "发布" 相关的信息,无法操作和获取 "群发" 相关内容!
|
||||
|
||||
- 群发:主动推送给粉丝,历史消息可看,被搜一搜收录,可以限定部分的粉丝接收到。
|
||||
- 发布:不会主动推给粉丝,历史消息列表看不到,但是是公开给所有人的文章。也不会占用群发的次数。每天可以发布多篇内容。可以用于自动回复、自定义菜单、页面模板和话题中,发布成功时会生成一个永久链接。
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| ------------------------------ | -------- | ------------------------------- | ---------- | ---------------------------------------- |
|
||||
| 发布接口 | POST | /cgi-bin/freepublish/submit | YES | (freePublish \*FreePublish) Publish |
|
||||
| 发布状态轮询接口 | POST | /cgi-bin/freepublish/get | YES | (freePublish \*FreePublish) SelectStatus |
|
||||
| 事件推送发布结果 | | | YES | EventPublishJobFinish |
|
||||
| 删除发布 | POST | /cgi-bin/freepublish/delete | YES | (freePublish \*FreePublish) Delete |
|
||||
| 通过 article_id 获取已发布文章 | POST | /cgi-bin/freepublish/getarticle | YES | (freePublish \*FreePublish) First |
|
||||
| 获取成功发布列表 | POST | /cgi-bin/freepublish/batchget | YES | (freePublish \*FreePublish) Paginate |
|
||||
|
||||
## 图文消息留言管理
|
||||
|
||||
## 用户管理
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |
|
||||
| ------------------------------------------ | -------- | -------------------------------------- | ---------- | ---------------------------------- |
|
||||
| 获取指定 OpenID 变化列表(公众号账号迁移) | POST | /cgi-bin/changeopenid | YES | (user \*User) ListChangeOpenIDs |
|
||||
| 获取所有用户 OpenID 列表(公众号账号迁移) | | | YES | (user \*User) ListAllChangeOpenIDs |
|
||||
| 获取用户基本信息 | GET | /cgi-bin/user/info | YES | (user \*User) GetUserInfo |
|
||||
| 设置用户备注名 | POST | /cgi-bin/user/info/updateremark | YES | (user \*User) UpdateRemark |
|
||||
| 获取用户列表 | GET | /cgi-bin/user/get | YES | (user \*User) ListUserOpenIDs |
|
||||
| 获取所有用户 OpenID 列表 | | | YES | (user \*User) ListAllUserOpenIDs |
|
||||
| 获取公众号的黑名单列表 | POST | /cgi-bin/tags/members/getblacklist | YES | (user \*User) GetBlackList |
|
||||
| 获取公众号的所有黑名单列表 | | | YES | (user \*User) GetAllBlackList |
|
||||
| 拉黑用户 | POST | /cgi-bin/tags/members/batchblacklist | YES | (user \*User) BatchBlackList |
|
||||
| 取消拉黑用户 | POST | /cgi-bin/tags/members/batchunblacklist | YES | (user \*User) BatchUnBlackList |
|
||||
| 创建标签 | POST | /cgi-bin/tags/create | YES | (user \*User) CreateTag |
|
||||
| 删除标签 | POST | /cgi-bin/tags/delete | YES | (user \*User) DeleteTag |
|
||||
| 编辑标签 | POST | /cgi-bin/tags/update | YES | (user \*User) UpdateTag |
|
||||
| 获取公众号已创建的标签 | GET | /cgi-bin/tags/get | YES | (user \*User) GetTag |
|
||||
| 获取标签下粉丝列表 | POST | /cgi-bin/user/tag/get | YES | (user \*User) OpenIDListByTag |
|
||||
| 批量为用户打标签 | POST | /cgi-bin/tags/members/batchtagging | YES | (user \*User) BatchTag |
|
||||
| 批量为用户取消标签 | POST | /cgi-bin/tags/members/batchuntagging | YES | (user \*User) BatchUntag |
|
||||
| 获取用户身上的标签列表 | POST | /cgi-bin/tags/getidlist | YES | (user \*User) UserTidList |
|
||||
|
||||
## 账号管理
|
||||
|
||||
## 数据统计
|
||||
|
||||
## 微信卡券
|
||||
|
||||
## 微信门店
|
||||
|
||||
## 智能接口
|
||||
|
||||
## 微信设备功能
|
||||
|
||||
## 微信“一物一码”
|
||||
|
||||
## 微信发票
|
||||
|
||||
## 微信非税缴费
|
||||
1
doc/api/oplatform.md
Normal file
1
doc/api/oplatform.md
Normal file
@@ -0,0 +1 @@
|
||||
# 开放平台
|
||||
131
doc/api/work.md
Normal file
131
doc/api/work.md
Normal file
@@ -0,0 +1,131 @@
|
||||
# 企业微信
|
||||
|
||||
host: https://qyapi.weixin.qq.com/
|
||||
|
||||
## 微信客服
|
||||
|
||||
[官方文档](https://work.weixin.qq.com/api/doc/90000/90135/94638)
|
||||
|
||||
### 客服账号管理
|
||||
|
||||
[官方文档](https://open.work.weixin.qq.com/api/doc/90001/90143/94684)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |贡献者 |
|
||||
| :--------------: | -------- | :-------------------------- | ---------- | -------------------------------|------------|
|
||||
| 添加客服帐号 | POST | /cgi-bin/kf/account/add | YES | (r *Client) AccountAdd | NICEXAI |
|
||||
| 删除客服帐号 | POST | /cgi-bin/kf/account/del | YES | (r *Client) AccountDel | NICEXAI |
|
||||
| 修改客服帐号 | POST | /cgi-bin/kf/account/update | YES | (r *Client) AccountUpdate | NICEXAI |
|
||||
| 获取客服帐号列表 | GET | /cgi-bin/kf/account/list | YES | (r *Client) AccountList | NICEXAI |
|
||||
| 获取客服帐号链接 | GET | /cgi-bin/kf/add_contact_way | YES | (r *Client) AddContactWay | NICEXAI |
|
||||
|
||||
### 接待人员列表
|
||||
|
||||
[官方文档](https://open.work.weixin.qq.com/api/doc/90001/90143/94693)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |贡献者 |
|
||||
| :--------------: | -------- | :-------------------------- | ---------- | -------------------------------|------------|
|
||||
| 添加接待人员 | POST | /cgi-bin/kf/servicer/add | YES | (r *Client) ReceptionistAdd | NICEXAI |
|
||||
| 删除接待人员 | POST | /cgi-bin/kf/servicer/del | YES | (r *Client) ReceptionistDel | NICEXAI |
|
||||
| 获取接待人员列表 | GET | /cgi-bin/kf/servicer/list | YES | (r *Client) ReceptionistList | NICEXAI |
|
||||
|
||||
### 会话分配与消息收发
|
||||
|
||||
[官方文档](https://open.work.weixin.qq.com/api/doc/90001/90143/94694)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |贡献者 |
|
||||
| :--------------: | -------- | :-------------------------------| ---------- | ------------------------------- |------------|
|
||||
| 获取会话状态 | POST | /cgi-bin/kf/service_state/get | YES | (r *Client) ServiceStateGet | NICEXAI |
|
||||
| 变更会话状态 | POST | /cgi-bin/kf/service_state/trans | YES | (r *Client) ServiceStateTrans | NICEXAI |
|
||||
| 读取消息 | POST | /cgi-bin/kf/sync_msg | YES | (r *Client) SyncMsg | NICEXAI |
|
||||
| 发送消息 | POST | /cgi-bin/kf/send_msg | YES | (r *Client) SendMsg | NICEXAI |
|
||||
| 发送事件响应消息 | POST | /cgi-bin/kf/send_msg_on_event | YES | (r *Client) SendMsgOnEvent | NICEXAI |
|
||||
|
||||
### 升级服务配置
|
||||
|
||||
[官方文档](https://open.work.weixin.qq.com/api/doc/90001/90143/94702)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 |贡献者 |
|
||||
| :--------------: | -------- | :-------------------------------------------------| ---------- | ------------------------------- |------------|
|
||||
| 获取配置的专员与客户群 | POST | /cgi-bin/kf/customer/get_upgrade_service_config | YES | (r *Client) UpgradeServiceConfig | NICEXAI |
|
||||
| 为客户升级为专员或客户群服务 | POST | /cgi-bin/kf/customer/upgrade_service | YES | (r *Client) UpgradeService | NICEXAI |
|
||||
| 为客户取消推荐 | POST | /cgi-bin/kf/customer/cancel_upgrade_service | YES | (r *Client) UpgradeServiceCancel | NICEXAI |
|
||||
|
||||
### 其他基础信息获取
|
||||
|
||||
[官方文档](https://open.work.weixin.qq.com/api/doc/90001/90143/95148)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 |
|
||||
| :--------------: | -------- | :---------------------------------------| ---------- | ------------------------------- |------------|
|
||||
| 获取客户基础信息 | POST | /cgi-bin/kf/customer/batchget | YES | (r *Client) CustomerBatchGet | NICEXAI |
|
||||
| 获取视频号绑定状态 | GET | /cgi-bin/kf/get_corp_qualification | YES | (r *Client) GetCorpQualification | NICEXAI |
|
||||
|
||||
### 客户联系
|
||||
[官方文档](https://developer.work.weixin.qq.com/document/path/92132/92133/92228)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 |
|
||||
|:------------------------:| -------- |:-------------------------------------------------------------| ---------- | ------------------------------- |----------|
|
||||
| 获取「联系客户统计」数据 | POST | /cgi-bin/externalcontact/get_user_behavior_data | YES | (r *Client) GetUserBehaviorData | MARKWANG |
|
||||
| 获取「群聊数据统计」数据 (按群主聚合的方式) | POST | /cgi-bin/externalcontact/groupchat/statistic | YES | (r *Client) GetGroupChatStat | MARKWANG |
|
||||
| 获取「群聊数据统计」数据 (按自然日聚合的方式) | POST | /cgi-bin/externalcontact/groupchat/statistic_group_by_day | YES | (r *Client) GetGroupChatStatByDay | MARKWANG |
|
||||
| 配置客户联系「联系我」方式 | POST | /cgi-bin/externalcontact/add_contact_way | YES | (r *Client) AddContactWay | MARKWANG |
|
||||
| 获取企业已配置的「联系我」方式 | POST | /cgi-bin/externalcontact/get_contact_way | YES | (r *Client) GetContactWay | MARKWANG |
|
||||
| 更新企业已配置的「联系我」方式 | POST | /cgi-bin/externalcontact/update_contact_way | YES | (r *Client) UpdateContactWay | MARKWANG |
|
||||
| 获取企业已配置的「联系我」列表 | POST | /cgi-bin/externalcontact/list_contact_way | YES | (r *Client) ListContactWay | MARKWANG |
|
||||
| 删除企业已配置的「联系我」方式 | POST | /cgi-bin/externalcontact/del_contact_way | YES | (r *Client) DelContactWay | MARKWANG |
|
||||
| 创建企业群发 | POST | /cgi-bin/externalcontact/add_msg_template | YES | (r *Client) AddMsgTemplate | MARKWANG |
|
||||
| 获取群发记录列表 | POST | /cgi-bin/externalcontact/get_groupmsg_list_v2 | YES | (r *Client) GetGroupMsgListV2 | MARKWANG |
|
||||
| 获取群发成员发送任务列表 | POST | /cgi-bin/externalcontact/get_groupmsg_task | YES | (r *Client) GetGroupMsgTask | MARKWANG |
|
||||
| 获取企业群发成员执行结果 | POST | /cgi-bin/externalcontact/get_groupmsg_send_result | YES | (r *Client) GetGroupMsgSendResult | MARKWANG |
|
||||
| 发送新客户欢迎语 | POST | /cgi-bin/externalcontact/send_welcome_msg | YES | (r *Client) SendWelcomeMsg | MARKWANG |
|
||||
| 添加入群欢迎语素材 | POST | /cgi-bin/externalcontact/group_welcome_template/add | YES | (r *Client) AddGroupWelcomeTemplate | MARKWANG |
|
||||
| 编辑入群欢迎语素材 | POST | /cgi-bin/externalcontact/group_welcome_template/edit | YES | (r *Client) EditGroupWelcomeTemplate | MARKWANG |
|
||||
| 获取入群欢迎语素材 | POST | /cgi-bin/externalcontact/group_welcome_template/get | YES | (r *Client) GetGroupWelcomeTemplate | MARKWANG |
|
||||
| 删除入群欢迎语素材 | POST | /cgi-bin/externalcontact/group_welcome_template/del | YES | (r *Client) DelGroupWelcomeTemplate | MARKWANG |
|
||||
|
||||
## 通讯录管理
|
||||
[官方文档](https://developer.work.weixin.qq.com/document/path/90193)
|
||||
|
||||
### 部门管理
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 |
|
||||
|:---------:|------|:----------------------------------------| ---------- | ------------------------------- |----------|
|
||||
| 获取子部门ID列表 | GET | /cgi-bin/department/simplelist | YES | (r *Client) DepartmentSimpleList| MARKWANG |
|
||||
| 获取部门列表 | GET | /cgi-bin/department/list | YES | (r *Client) DepartmentList| just5325, ourines |
|
||||
| 获取部门成员 | GET | /cgi-bin/user/simplelist | YES | (r *Client) UserSimpleList | MARKWANG |
|
||||
| 获取成员ID列表 | Post | /cgi-bin/user/list_id | YES | (r *Client) UserListId | MARKWANG |
|
||||
|
||||
|
||||
|
||||
## 素材管理
|
||||
[官方文档](https://developer.work.weixin.qq.com/document/path/91054)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 |
|
||||
|:---------:|------|:----------------------------------------| ---------- | ------------------------------- |----------|
|
||||
| 上传图片 | POST | /cgi-bin/media/uploadimg | YES | (r *Client) UploadImg| MARKWANG |
|
||||
|
||||
### 成员管理
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 |
|
||||
| -------- | -------- | ----------------- | ---------- | ------------------- | -------- |
|
||||
| 读取成员 | GET | /cgi-bin/user/get | YES | (r *Client) UserGet | chcthink |
|
||||
|
||||
|
||||
## 群机器人
|
||||
|
||||
[官方文档](https://developer.work.weixin.qq.com/document/path/91770)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 |
|
||||
| ---------------- | -------- | --------------------- | ---------- | -------------------------- | -------- |
|
||||
| 群机器人发送消息 | POST | /cgi-bin/webhook/send | YES | (r *Client) RobotBroadcast | chcthink |
|
||||
|
||||
## 打卡
|
||||
|
||||
[官方文档](https://developer.work.weixin.qq.com/document/path/96497)
|
||||
|
||||
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 |
|
||||
|----------| -------- | --------------------- | ---------- | -------------------------- |---------|
|
||||
| 获取打卡日报数据 | POST | /cgi-bin/checkin/getcheckin_daydata | YES | (r *Client) GetDayData | Thinker |
|
||||
| 获取打卡月报数据 | POST | /cgi-bin/checkin/getcheckin_monthdata | YES | (r *Client) GetMonthData | Thinker |
|
||||
|
||||
## 应用管理
|
||||
TODO
|
||||
3
doc/api/wxpay.md
Normal file
3
doc/api/wxpay.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# 微信支付
|
||||
|
||||
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 对应的请求详情
|
||||
}
|
||||
22
go.mod
22
go.mod
@@ -1,18 +1,16 @@
|
||||
module github.com/silenceper/wechat/v2
|
||||
|
||||
go 1.14
|
||||
go 1.16
|
||||
|
||||
require (
|
||||
github.com/bradfitz/gomemcache v0.0.0-20190913173617-a41fca850d0b
|
||||
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/gomodule/redigo v1.8.4
|
||||
github.com/kr/text v0.2.0 // indirect
|
||||
github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
|
||||
github.com/sirupsen/logrus v1.8.1
|
||||
github.com/spf13/cast v1.3.1
|
||||
github.com/stretchr/testify v1.7.0
|
||||
golang.org/x/crypto v0.0.0-20210220033148-5ea612d1eb83
|
||||
golang.org/x/sys v0.0.0-20210309074719-68d13333faf2 // indirect
|
||||
gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect
|
||||
gopkg.in/h2non/gock.v1 v1.0.15
|
||||
github.com/go-redis/redis/v8 v8.11.5
|
||||
github.com/sirupsen/logrus v1.9.0
|
||||
github.com/spf13/cast v1.4.1
|
||||
github.com/stretchr/testify v1.7.1
|
||||
github.com/tidwall/gjson v1.14.1
|
||||
golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d
|
||||
gopkg.in/h2non/gock.v1 v1.1.2
|
||||
)
|
||||
|
||||
150
go.sum
150
go.sum
@@ -1,49 +1,147 @@
|
||||
github.com/bradfitz/gomemcache v0.0.0-20190913173617-a41fca850d0b h1:L/QXpzIa3pOvUGt1D1lA5KjYhPBAN/3iWdP7xeFS9F0=
|
||||
github.com/bradfitz/gomemcache v0.0.0-20190913173617-a41fca850d0b/go.mod h1:H0wQNHz2YrLsuXOZozoeDmnHXkNCRmMW0gwFWDfEZDA=
|
||||
github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
|
||||
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=
|
||||
github.com/cespare/xxhash/v2 v2.1.2/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
|
||||
github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI=
|
||||
github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI=
|
||||
github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU=
|
||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78=
|
||||
github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc=
|
||||
github.com/fatih/structs v1.1.0 h1:Q7juDM0QtcnhCpeyLGQKyg4TOIghuNXrkL32pHAUMxo=
|
||||
github.com/fatih/structs v1.1.0/go.mod h1:9NiDSp5zOcgEDl+j00MP/WkGVPOlPRLejGD8Ga6PJ7M=
|
||||
github.com/gomodule/redigo v1.8.4 h1:Z5JUg94HMTR1XpwBaSH4vq3+PNSIykBLxMdglbw10gg=
|
||||
github.com/gomodule/redigo v1.8.4/go.mod h1:P9dn9mFrCBvWhGE1wpxx6fgq7BAeLBk+UUUzlpkBYO0=
|
||||
github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
|
||||
github.com/fsnotify/fsnotify v1.4.9 h1:hsms1Qyu0jgnwNXIxa+/V/PDsU6CfLf6CNO8H7IWoS4=
|
||||
github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ=
|
||||
github.com/go-redis/redis/v8 v8.11.5 h1:AcZZR7igkdvfVmQTPnu9WE37LRrO/YrBH5zWyjDC0oI=
|
||||
github.com/go-redis/redis/v8 v8.11.5/go.mod h1:gREzHqY1hg6oD9ngVRbLStwAWKhA0FEgq8Jd4h5lpwo=
|
||||
github.com/go-task/slim-sprig v0.0.0-20210107165309-348f09dbbbc0/go.mod h1:fyg7847qk6SyHyPtNmDHnmrv/HOrqktSC+C9fM+CJOE=
|
||||
github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
|
||||
github.com/golang/protobuf v1.4.0-rc.1/go.mod h1:ceaxUfeHdC40wWswd/P6IGgMaK3YpKi5j83Wpe3EHw8=
|
||||
github.com/golang/protobuf v1.4.0-rc.1.0.20200221234624-67d41d38c208/go.mod h1:xKAWHe0F5eneWXFV3EuXVDTCmh+JuBKY0li0aMyXATA=
|
||||
github.com/golang/protobuf v1.4.0-rc.2/go.mod h1:LlEzMj4AhA7rCAGe4KMBDvJI+AwstrUpVNzEA03Pprs=
|
||||
github.com/golang/protobuf v1.4.0-rc.4.0.20200313231945-b860323f09d0/go.mod h1:WU3c8KckQ9AFe+yFwt9sWVRKCVIyN9cPHBJSNnbL67w=
|
||||
github.com/golang/protobuf v1.4.0/go.mod h1:jodUvKwWbYaEsadDk5Fwe5c77LiNKVO9IDvqG2KuDX0=
|
||||
github.com/golang/protobuf v1.4.2/go.mod h1:oDoupMAO8OvCJWAcko0GGGIgR6R6ocIYbsSw735rRwI=
|
||||
github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
|
||||
github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
|
||||
github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
|
||||
github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
|
||||
github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
|
||||
github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
|
||||
github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE=
|
||||
github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 h1:2VTzZjLZBgl62/EtslCrtky5vbi9dd7HrQPQIx6wqiw=
|
||||
github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542/go.mod h1:Ow0tF8D4Kplbc8s8sSb3V2oUCygFHVp8gC3Dn6U4MNI=
|
||||
github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
|
||||
github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
|
||||
github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
|
||||
github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
|
||||
github.com/hpcloud/tail v1.0.0/go.mod h1:ab1qPbhIpdTxEkNHXyeSf5vhxWSCs/tWer42PpOxQnU=
|
||||
github.com/ianlancetaylor/demangle v0.0.0-20200824232613-28f6c0f3b639/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc=
|
||||
github.com/nbio/st v0.0.0-20140626010706-e9e8d9816f32 h1:W6apQkHrMkS0Muv8G/TipAy/FJl/rCYT0+EuS8+Z0z4=
|
||||
github.com/nbio/st v0.0.0-20140626010706-e9e8d9816f32/go.mod h1:9wM+0iRr9ahx58uYLpLIr5fm8diHn0JbqRycJi6w0Ms=
|
||||
github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs=
|
||||
github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
|
||||
github.com/nxadm/tail v1.4.4/go.mod h1:kenIhsEOeOJmVchQTgglprH7qJGnHDVpk1VPCcaMI8A=
|
||||
github.com/nxadm/tail v1.4.8 h1:nPr65rt6Y5JFSKQO7qToXr7pePgD6Gwiw05lkbyAQTE=
|
||||
github.com/nxadm/tail v1.4.8/go.mod h1:+ncqLTQzXmGhMZNUePPaPqPvBxHAIsmXswZKocGu+AU=
|
||||
github.com/onsi/ginkgo v1.6.0/go.mod h1:lLunBs/Ym6LB5Z9jYTR76FiuTmxDTDusOGeTQH+WWjE=
|
||||
github.com/onsi/ginkgo v1.12.1/go.mod h1:zj2OWP4+oCPe1qIXoGWkgMRwljMUYCdkwsT2108oapk=
|
||||
github.com/onsi/ginkgo v1.16.4/go.mod h1:dX+/inL/fNMqNlz0e9LfyB9TswhZpCVdJM/Z6Vvnwo0=
|
||||
github.com/onsi/ginkgo v1.16.5 h1:8xi0RTUf59SOSfEtZMvwTvXYMzG4gV23XVHOZiXNtnE=
|
||||
github.com/onsi/ginkgo v1.16.5/go.mod h1:+E8gABHa3K6zRBolWtd+ROzc/U5bkGt0FwiG042wbpU=
|
||||
github.com/onsi/ginkgo/v2 v2.0.0/go.mod h1:vw5CSIxN1JObi/U8gcbwft7ZxR2dgaR70JSE3/PpL4c=
|
||||
github.com/onsi/gomega v1.7.1/go.mod h1:XdKZgCCFLUoM/7CFJVPcG8C1xQ1AJ0vpAezJrB7JYyY=
|
||||
github.com/onsi/gomega v1.10.1/go.mod h1:iN09h71vgCQne3DLsj+A5owkum+a2tYe+TOCB1ybHNo=
|
||||
github.com/onsi/gomega v1.17.0/go.mod h1:HnhC7FXeEQY45zxNK3PPoIUhzk/80Xly9PcubAlGdZY=
|
||||
github.com/onsi/gomega v1.18.1 h1:M1GfJqGRrBrrGGsbxzV5dqM2U2ApXefZCQpkukxYRLE=
|
||||
github.com/onsi/gomega v1.18.1/go.mod h1:0q+aL8jAiMXy9hbwj2mr5GziHiwhAIQpFmmtT5hitRs=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/sirupsen/logrus v1.8.1 h1:dJKuHgqk1NNQlqoA6BTlM1Wf9DOH3NBjQyu0h9+AZZE=
|
||||
github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
|
||||
github.com/spf13/cast v1.3.1 h1:nFm6S0SMdyzrzcmThSipiEubIDy8WEXKNZ0UOgiRpng=
|
||||
github.com/spf13/cast v1.3.1/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
|
||||
github.com/sirupsen/logrus v1.9.0 h1:trlNQbNUG3OdDrDil03MCb1H2o9nJ1x4/5LYw7byDE0=
|
||||
github.com/sirupsen/logrus v1.9.0/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
|
||||
github.com/spf13/cast v1.4.1 h1:s0hze+J0196ZfEMTs80N7UlFt0BDuQ7Q+JDnHiMWKdA=
|
||||
github.com/spf13/cast v1.4.1/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE=
|
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
|
||||
github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
|
||||
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
|
||||
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||
github.com/stretchr/testify v1.7.1 h1:5TQK59W5E3v0r2duFAb7P95B6hEeOyEnHRa8MjYSMTY=
|
||||
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||
github.com/tidwall/gjson v1.14.1 h1:iymTbGkQBhveq21bEvAQ81I0LEBork8BFe1CUZXdyuo=
|
||||
github.com/tidwall/gjson v1.14.1/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
|
||||
github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA=
|
||||
github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM=
|
||||
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-20210220033148-5ea612d1eb83 h1:/ZScEX8SfEmUGRHs0gxpqteO5nfNW6axyZbBdw9A12g=
|
||||
golang.org/x/crypto v0.0.0-20210220033148-5ea612d1eb83/go.mod h1:jdWPYTVW3xRLrWPugEBEK3UY2ZEsg3UU495nc5E+M+I=
|
||||
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
|
||||
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
|
||||
golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d h1:sK3txAijHtOK88l68nt020reeT1ZdKLIYetKl95FzVY=
|
||||
golang.org/x/crypto v0.0.0-20220622213112-05595931fe9d/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4=
|
||||
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
|
||||
golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
|
||||
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
|
||||
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
|
||||
golang.org/x/net v0.0.0-20200520004742-59133d7f0dd7/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
|
||||
golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
|
||||
golang.org/x/net v0.0.0-20210428140749-89ef3d95e781/go.mod h1:OJAsFXCWl8Ukc7SiCT/9KSuxbyM7479/AVlXFRxuMCk=
|
||||
golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2 h1:CIJ76btIcR3eFI5EgSo6k1qKw9KJexJuRLI9G7Hp5wE=
|
||||
golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
|
||||
golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||
golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20190204203706-41f3e6584952/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||
golang.org/x/sys v0.0.0-20191026070338-33540a1f6037/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20210309074719-68d13333faf2 h1:46ULzRKLh1CwgRq2dC5SlBzEqqNCi8rreOZnNrbqcIY=
|
||||
golang.org/x/sys v0.0.0-20210309074719-68d13333faf2/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/term v0.0.0-20201117132131-f5c789dd3221/go.mod h1:Nr5EML6q2oocZ2LXRh80K7BxOlk5/8JxuGnuhpl+muw=
|
||||
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20190904154756-749cb33beabd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20191005200804-aed5e4c7ecf9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20191120155948-bd437916bb0e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20191204072324-ce4227a45e2e/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20200323222414-85ca7c5b95cd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20210112080510-489259a85091/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
|
||||
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=
|
||||
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
|
||||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
|
||||
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||
golang.org/x/text v0.3.6 h1:aRYxNxv6iGQlyVaZmk6ZgYEDa+Jg18DxebPSrd6bg1M=
|
||||
golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
|
||||
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
|
||||
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
|
||||
golang.org/x/tools v0.0.0-20201224043029-2b0845dc783e/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
|
||||
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||
google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8=
|
||||
google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0=
|
||||
google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM=
|
||||
google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miEFZTKqfCUM6K7xSMQL9OKL/b6hQv+e19PK+JZNE=
|
||||
google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo=
|
||||
google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
|
||||
google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
|
||||
google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU=
|
||||
gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/h2non/gock.v1 v1.0.15 h1:SzLqcIlb/fDfg7UvukMpNcWsu7sI5tWwL+KCATZqks0=
|
||||
gopkg.in/h2non/gock.v1 v1.0.15/go.mod h1:sX4zAkdYX1TRGJ2JY156cFspQn4yRWn6p9EMdODlynE=
|
||||
gopkg.in/fsnotify.v1 v1.4.7/go.mod h1:Tz8NjZHkW78fSQdbUxIjBTcgA1z1m8ZHf0WmKUhAMys=
|
||||
gopkg.in/h2non/gock.v1 v1.1.2 h1:jBbHXgGBK/AoPVfJh5x4r/WxIrElvbLel8TCZkkZJoY=
|
||||
gopkg.in/h2non/gock.v1 v1.1.2/go.mod h1:n7UGz/ckNChHiK05rDoiC4MYSunEC/lyaUm2WWaDva0=
|
||||
gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7 h1:uRGJdciOHaEIrze2W8Q3AKkepLTh2hOroT7a+7czfdQ=
|
||||
gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7/go.mod h1:dt/ZhP58zS4L8KSrWDmTeBkI65Dw0HsyUHuEVlX15mw=
|
||||
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
|
||||
gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
|
||||
gopkg.in/yaml.v2 v2.3.0/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
|
||||
gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
|
||||
gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
|
||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||
|
||||
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)
|
||||
}
|
||||
@@ -3,6 +3,7 @@
|
||||
[官方文档](https://developers.weixin.qq.com/minigame/dev/api-backend/)
|
||||
|
||||
## 快速入门
|
||||
|
||||
```go
|
||||
|
||||
```
|
||||
@@ -2,11 +2,12 @@
|
||||
|
||||
[官方文档](https://developers.weixin.qq.com/miniprogram/dev/framework/)
|
||||
|
||||
|
||||
## 包说明
|
||||
- analysis 数据分析相关API
|
||||
|
||||
- analysis 数据分析相关 API
|
||||
|
||||
## 快速入门
|
||||
|
||||
```go
|
||||
wc := wechat.NewWechat()
|
||||
memory := cache.NewMemory()
|
||||
@@ -17,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,14 +30,16 @@ 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 数据分析
|
||||
// Analysis analyis 数据分析
|
||||
type Analysis struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
//NewAnalysis new
|
||||
// NewAnalysis new
|
||||
func NewAnalysis(ctx *context.Context) *Analysis {
|
||||
return &Analysis{ctx}
|
||||
}
|
||||
@@ -190,9 +192,9 @@ func (analysis *Analysis) GetAnalysisWeeklyVisitTrend(beginDate, endDate string)
|
||||
|
||||
// UserPortraitItem 用户画像项目
|
||||
type UserPortraitItem struct {
|
||||
ID int `json:"id"` // 属性值id
|
||||
Name string `json:"name"` // 属性值名称
|
||||
AccessSourceVisitUV int `json:"access_source_visit_uv"` // 该场景访问uv
|
||||
ID int `json:"id"` // 属性值id
|
||||
Name string `json:"name"` // 属性值名称
|
||||
Value int `json:"value"` // 该场景访问uv
|
||||
}
|
||||
|
||||
// UserPortrait 用户画像
|
||||
@@ -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
|
||||
}
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package auth
|
||||
|
||||
import (
|
||||
context2 "context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
|
||||
@@ -9,15 +10,30 @@ 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 登录/用户信息
|
||||
// Auth 登录/用户信息
|
||||
type Auth struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
//NewAuth new auth
|
||||
// NewAuth new auth
|
||||
func NewAuth(ctx *context.Context) *Auth {
|
||||
return &Auth{ctx}
|
||||
}
|
||||
@@ -31,16 +47,26 @@ type ResCode2Session struct {
|
||||
UnionID string `json:"unionid"` // 用户在开放平台的唯一标识符,在满足UnionID下发条件的情况下会返回
|
||||
}
|
||||
|
||||
//Code2Session 登录凭证校验。
|
||||
// RspCheckEncryptedData .
|
||||
type RspCheckEncryptedData struct {
|
||||
util.CommonError
|
||||
|
||||
Vaild bool `json:"vaild"` // 是否是合法的数据
|
||||
CreateTime uint64 `json:"create_time"` // 加密数据生成的时间戳
|
||||
}
|
||||
|
||||
// Code2Session 登录凭证校验。
|
||||
func (auth *Auth) Code2Session(jsCode string) (result ResCode2Session, err error) {
|
||||
urlStr := fmt.Sprintf(code2SessionURL, auth.AppID, auth.AppSecret, jsCode)
|
||||
return auth.Code2SessionContext(context2.Background(), jsCode)
|
||||
}
|
||||
|
||||
// Code2SessionContext 登录凭证校验。
|
||||
func (auth *Auth) Code2SessionContext(ctx context2.Context, jsCode string) (result ResCode2Session, err error) {
|
||||
var response []byte
|
||||
response, err = util.HTTPGet(urlStr)
|
||||
if err != nil {
|
||||
if response, err = util.HTTPGetContext(ctx, fmt.Sprintf(code2SessionURL, auth.AppID, auth.AppSecret, jsCode)); err != nil {
|
||||
return
|
||||
}
|
||||
err = json.Unmarshal(response, &result)
|
||||
if err != nil {
|
||||
if err = json.Unmarshal(response, &result); err != nil {
|
||||
return
|
||||
}
|
||||
if result.ErrCode != 0 {
|
||||
@@ -50,7 +76,232 @@ func (auth *Auth) Code2Session(jsCode string) (result ResCode2Session, err error
|
||||
return
|
||||
}
|
||||
|
||||
//GetPaidUnionID 用户支付完成后,获取该用户的 UnionId,无需用户授权
|
||||
func (auth *Auth) GetPaidUnionID() {
|
||||
//TODO
|
||||
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,无需用户授权
|
||||
// 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天生成的加密数据
|
||||
func (auth *Auth) CheckEncryptedData(encryptedMsgHash string) (result RspCheckEncryptedData, err error) {
|
||||
return auth.CheckEncryptedDataContext(context2.Background(), encryptedMsgHash)
|
||||
}
|
||||
|
||||
// CheckEncryptedDataContext .检查加密信息是否由微信生成(当前只支持手机号加密数据),只能检测最近3天生成的加密数据
|
||||
func (auth *Auth) CheckEncryptedDataContext(ctx context2.Context, encryptedMsgHash string) (result RspCheckEncryptedData, err error) {
|
||||
var response []byte
|
||||
var (
|
||||
at string
|
||||
)
|
||||
if at, err = auth.GetAccessTokenContext(ctx); err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 由于GetPhoneNumberContext需要传入JSON,所以HTTPPostContext入参改为[]byte
|
||||
if response, err = util.HTTPPostContext(ctx, fmt.Sprintf(checkEncryptedDataURL, at), []byte("encrypted_msg_hash="+encryptedMsgHash), nil); err != nil {
|
||||
return
|
||||
}
|
||||
if err = util.DecodeWithError(response, &result, "CheckEncryptedDataAuth"); err != nil {
|
||||
return
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
// GetPhoneNumberResponse 新版获取用户手机号响应结构体
|
||||
type GetPhoneNumberResponse struct {
|
||||
util.CommonError
|
||||
|
||||
PhoneInfo PhoneInfo `json:"phone_info"`
|
||||
}
|
||||
|
||||
// PhoneInfo 获取用户手机号内容
|
||||
type PhoneInfo struct {
|
||||
PhoneNumber string `json:"phoneNumber"` // 用户绑定的手机号
|
||||
PurePhoneNumber string `json:"purePhoneNumber"` // 没有区号的手机号
|
||||
CountryCode string `json:"countryCode"` // 区号
|
||||
WaterMark struct {
|
||||
Timestamp int64 `json:"timestamp"`
|
||||
AppID string `json:"appid"`
|
||||
} `json:"watermark"` // 数据水印
|
||||
}
|
||||
|
||||
// GetPhoneNumberContext 小程序通过code获取用户手机号
|
||||
func (auth *Auth) GetPhoneNumberContext(ctx context2.Context, code string) (*GetPhoneNumberResponse, error) {
|
||||
var response []byte
|
||||
var (
|
||||
at string
|
||||
err error
|
||||
)
|
||||
if at, err = auth.GetAccessTokenContext(ctx); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
body := map[string]interface{}{
|
||||
"code": code,
|
||||
}
|
||||
|
||||
bodyBytes, err := json.Marshal(body)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
header := map[string]string{"Content-Type": "application/json;charset=utf-8"}
|
||||
if response, err = util.HTTPPostContext(ctx, fmt.Sprintf(getPhoneNumber, at), bodyBytes, header); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
var result GetPhoneNumberResponse
|
||||
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
|
||||
}
|
||||
|
||||
13
miniprogram/business/business.go
Normal file
13
miniprogram/business/business.go
Normal file
@@ -0,0 +1,13 @@
|
||||
package business
|
||||
|
||||
import "github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
|
||||
// Business 业务
|
||||
type Business struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewBusiness init
|
||||
func NewBusiness(ctx *context.Context) *Business {
|
||||
return &Business{ctx}
|
||||
}
|
||||
55
miniprogram/business/phone_number.go
Normal file
55
miniprogram/business/phone_number.go
Normal file
@@ -0,0 +1,55 @@
|
||||
package business
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
getPhoneNumberURL = "https://api.weixin.qq.com/wxa/business/getuserphonenumber?access_token=%s"
|
||||
)
|
||||
|
||||
// GetPhoneNumberRequest 获取手机号请求
|
||||
type GetPhoneNumberRequest struct {
|
||||
Code string `json:"code"` // 手机号获取凭证
|
||||
}
|
||||
|
||||
// PhoneInfo 手机号信息
|
||||
type PhoneInfo struct {
|
||||
PhoneNumber string `json:"phoneNumber"` // 用户绑定的手机号(国外手机号会有区号)
|
||||
PurePhoneNumber string `json:"purePhoneNumber"` // 没有区号的手机号
|
||||
CountryCode string `json:"countryCode"` // 区号
|
||||
Watermark struct {
|
||||
AppID string `json:"appid"` // 小程序appid
|
||||
Timestamp int64 `json:"timestamp"` // 用户获取手机号操作的时间戳
|
||||
} `json:"watermark"`
|
||||
}
|
||||
|
||||
// GetPhoneNumber code换取用户手机号。 每个code只能使用一次,code的有效期为5min
|
||||
func (business *Business) GetPhoneNumber(in *GetPhoneNumberRequest) (info PhoneInfo, err error) {
|
||||
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.PostJSONContext(ctx, uri, in)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
var resp struct {
|
||||
util.CommonError
|
||||
PhoneInfo PhoneInfo `json:"phone_info"`
|
||||
}
|
||||
err = util.DecodeWithError(response, &resp, "business.GetPhoneNumber")
|
||||
return resp.PhoneInfo, err
|
||||
}
|
||||
@@ -1,13 +1,18 @@
|
||||
// Package config 小程序config配置
|
||||
// Package config 小程序 config 配置
|
||||
package config
|
||||
|
||||
import (
|
||||
"github.com/silenceper/wechat/v2/cache"
|
||||
)
|
||||
|
||||
// Config config for 小程序
|
||||
// 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
|
||||
}
|
||||
|
||||
@@ -12,18 +12,20 @@ const (
|
||||
checkImageURL = "https://api.weixin.qq.com/wxa/img_sec_check?access_token=%s"
|
||||
)
|
||||
|
||||
//Content 内容安全
|
||||
// Content 内容安全
|
||||
type Content struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
//NewContent 内容安全接口
|
||||
// NewContent 内容安全接口
|
||||
func NewContent(ctx *context.Context) *Content {
|
||||
return &Content{ctx}
|
||||
}
|
||||
|
||||
//CheckText 检测文字
|
||||
//@text 需要检测的文字
|
||||
// CheckText 检测文字
|
||||
// @text 需要检测的文字
|
||||
// Deprecated
|
||||
// 采用 security.MsgCheckV1 替代,返回值更加丰富
|
||||
func (content *Content) CheckText(text string) error {
|
||||
accessToken, err := content.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -41,9 +43,11 @@ func (content *Content) CheckText(text string) error {
|
||||
return util.DecodeWithCommonError(response, "ContentCheckText")
|
||||
}
|
||||
|
||||
//CheckImage 检测图片
|
||||
//所传参数为要检测的图片文件的绝对路径,图片格式支持PNG、JPEG、JPG、GIF, 像素不超过 750 x 1334,同时文件大小以不超过 300K 为宜,否则可能报错
|
||||
//@media 图片文件的绝对路径
|
||||
// CheckImage 检测图片
|
||||
// 所传参数为要检测的图片文件的绝对路径,图片格式支持PNG、JPEG、JPG、GIF, 像素不超过 750 x 1334,同时文件大小以不超过 300K 为宜,否则可能报错
|
||||
// @media 图片文件的绝对路径
|
||||
// Deprecated
|
||||
// 采用 security.ImageCheckV1 替代,返回值更加丰富
|
||||
func (content *Content) CheckImage(media string) error {
|
||||
accessToken, err := content.GetAccessToken()
|
||||
if err != nil {
|
||||
|
||||
@@ -8,5 +8,5 @@ import (
|
||||
// Context struct
|
||||
type Context struct {
|
||||
*config.Config
|
||||
credential.AccessTokenHandle
|
||||
credential.AccessTokenContextHandle
|
||||
}
|
||||
|
||||
@@ -6,16 +6,17 @@ import (
|
||||
"encoding/base64"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
)
|
||||
|
||||
//Encryptor struct
|
||||
// Encryptor struct
|
||||
type Encryptor struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
//NewEncryptor 实例
|
||||
// NewEncryptor 实例
|
||||
func NewEncryptor(context *context.Context) *Encryptor {
|
||||
basic := new(Encryptor)
|
||||
basic.Context = context
|
||||
@@ -90,6 +91,9 @@ func GetCipherText(sessionKey, encryptedData, iv string) ([]byte, error) {
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if len(ivBytes) != aes.BlockSize {
|
||||
return nil, fmt.Errorf("bad iv length %d", len(ivBytes))
|
||||
}
|
||||
block, err := aes.NewCipher(aesKey)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
|
||||
15
miniprogram/encryptor/encryptor_test.go
Normal file
15
miniprogram/encryptor/encryptor_test.go
Normal file
@@ -0,0 +1,15 @@
|
||||
package encryptor
|
||||
|
||||
import (
|
||||
"encoding/base64"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
func TestGetCipherText_BadIV(t *testing.T) {
|
||||
keyData := base64.StdEncoding.EncodeToString([]byte("1234567890123456"))
|
||||
badData := base64.StdEncoding.EncodeToString([]byte("1"))
|
||||
_, err := GetCipherText(keyData, badData, badData)
|
||||
assert.Error(t, err)
|
||||
}
|
||||
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}
|
||||
}
|
||||
@@ -12,14 +12,20 @@ type EventType string
|
||||
type InfoType string
|
||||
|
||||
const (
|
||||
//MsgTypeText 文本消息
|
||||
// MsgTypeText 文本消息
|
||||
MsgTypeText MsgType = "text"
|
||||
//MsgTypeImage 图片消息
|
||||
// MsgTypeImage 图片消息
|
||||
MsgTypeImage = "image"
|
||||
//MsgTypeLink 图文链接
|
||||
// MsgTypeLink 图文链接
|
||||
MsgTypeLink = "link"
|
||||
//MsgTypeMiniProgramPage 小程序卡片
|
||||
// MsgTypeMiniProgramPage 小程序卡片
|
||||
MsgTypeMiniProgramPage = "miniprogrampage"
|
||||
// MsgTypeEvent 事件
|
||||
MsgTypeEvent MsgType = "event"
|
||||
// DataTypeXML XML 格式数据
|
||||
DataTypeXML = "xml"
|
||||
// DataTypeJSON JSON 格式数据
|
||||
DataTypeJSON = "json"
|
||||
)
|
||||
|
||||
// CommonToken 消息中通用的结构
|
||||
|
||||
@@ -11,29 +11,29 @@ const (
|
||||
customerSendMessage = "https://api.weixin.qq.com/cgi-bin/message/custom/send"
|
||||
)
|
||||
|
||||
//Manager 消息管理者,可以发送消息
|
||||
// Manager 消息管理者,可以发送消息
|
||||
type Manager struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
//NewCustomerMessageManager 实例化消息管理者
|
||||
// NewCustomerMessageManager 实例化消息管理者
|
||||
func NewCustomerMessageManager(context *context.Context) *Manager {
|
||||
return &Manager{
|
||||
context,
|
||||
}
|
||||
}
|
||||
|
||||
//MediaText 文本消息的文字
|
||||
// MediaText 文本消息的文字
|
||||
type MediaText struct {
|
||||
Content string `json:"content"`
|
||||
}
|
||||
|
||||
//MediaResource 消息使用的临时素材id
|
||||
// MediaResource 消息使用的临时素材 id
|
||||
type MediaResource struct {
|
||||
MediaID string `json:"media_id"`
|
||||
}
|
||||
|
||||
//MediaMiniprogrampage 小程序卡片
|
||||
// MediaMiniprogrampage 小程序卡片
|
||||
type MediaMiniprogrampage struct {
|
||||
Title string `json:"title"`
|
||||
Appid string `json:"appid"`
|
||||
@@ -49,17 +49,17 @@ type MediaLink struct {
|
||||
ThumbURL string `json:"thumb_url"`
|
||||
}
|
||||
|
||||
//CustomerMessage 客服消息
|
||||
// CustomerMessage 客服消息
|
||||
type CustomerMessage struct {
|
||||
ToUser string `json:"touser"` //接受者OpenID
|
||||
Msgtype MsgType `json:"msgtype"` //客服消息类型
|
||||
Text *MediaText `json:"text,omitempty"` //可选
|
||||
Image *MediaResource `json:"image,omitempty"` //可选
|
||||
Link *MediaLink `json:"link,omitempty"` //可选
|
||||
Miniprogrampage *MediaMiniprogrampage `json:"miniprogrampage,omitempty"` //可选
|
||||
ToUser string `json:"touser"` // 接受者 OpenID
|
||||
Msgtype MsgType `json:"msgtype"` // 客服消息类型
|
||||
Text *MediaText `json:"text,omitempty"` // 可选
|
||||
Image *MediaResource `json:"image,omitempty"` // 可选
|
||||
Link *MediaLink `json:"link,omitempty"` // 可选
|
||||
Miniprogrampage *MediaMiniprogrampage `json:"miniprogrampage,omitempty"` // 可选
|
||||
}
|
||||
|
||||
//NewCustomerTextMessage 文本消息结构体构造方法
|
||||
// NewCustomerTextMessage 文本消息结构体构造方法
|
||||
func NewCustomerTextMessage(toUser, text string) *CustomerMessage {
|
||||
return &CustomerMessage{
|
||||
ToUser: toUser,
|
||||
@@ -70,7 +70,7 @@ func NewCustomerTextMessage(toUser, text string) *CustomerMessage {
|
||||
}
|
||||
}
|
||||
|
||||
//NewCustomerImgMessage 图片消息的构造方法
|
||||
// NewCustomerImgMessage 图片消息的构造方法
|
||||
func NewCustomerImgMessage(toUser, mediaID string) *CustomerMessage {
|
||||
return &CustomerMessage{
|
||||
ToUser: toUser,
|
||||
@@ -81,7 +81,7 @@ func NewCustomerImgMessage(toUser, mediaID string) *CustomerMessage {
|
||||
}
|
||||
}
|
||||
|
||||
//NewCustomerLinkMessage 图文链接消息的构造方法
|
||||
// NewCustomerLinkMessage 图文链接消息的构造方法
|
||||
func NewCustomerLinkMessage(toUser, title, description, url, thumbURL string) *CustomerMessage {
|
||||
return &CustomerMessage{
|
||||
ToUser: toUser,
|
||||
@@ -95,7 +95,7 @@ func NewCustomerLinkMessage(toUser, title, description, url, thumbURL string) *C
|
||||
}
|
||||
}
|
||||
|
||||
//NewCustomerMiniprogrampageMessage 小程序卡片消息的构造方法
|
||||
// NewCustomerMiniprogrampageMessage 小程序卡片消息的构造方法
|
||||
func NewCustomerMiniprogrampageMessage(toUser, title, pagepath, thumbMediaID string) *CustomerMessage {
|
||||
return &CustomerMessage{
|
||||
ToUser: toUser,
|
||||
@@ -108,7 +108,7 @@ func NewCustomerMiniprogrampageMessage(toUser, title, pagepath, thumbMediaID str
|
||||
}
|
||||
}
|
||||
|
||||
//Send 发送客服消息
|
||||
// Send 发送客服消息
|
||||
func (manager *Manager) Send(msg *CustomerMessage) error {
|
||||
accessToken, err := manager.Context.GetAccessToken()
|
||||
if err != nil {
|
||||
|
||||
579
miniprogram/message/message.go
Normal file
579
miniprogram/message/message.go
Normal file
@@ -0,0 +1,579 @@
|
||||
package message
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"encoding/xml"
|
||||
"errors"
|
||||
"io"
|
||||
"net/http"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"github.com/tidwall/gjson"
|
||||
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/security"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
// ConfirmReceiveMethod 确认收货方式
|
||||
type ConfirmReceiveMethod int8
|
||||
|
||||
const (
|
||||
// EventTypeTradeManageRemindAccessAPI 提醒接入发货信息管理服务 API
|
||||
// 小程序完成账期授权时/小程序产生第一笔交易时/已产生交易但从未发货的小程序,每天一次
|
||||
EventTypeTradeManageRemindAccessAPI EventType = "trade_manage_remind_access_api"
|
||||
// EventTypeTradeManageRemindShipping 提醒需要上传发货信息
|
||||
// 曾经发过货的小程序,订单超过 48 小时未发货时
|
||||
EventTypeTradeManageRemindShipping EventType = "trade_manage_remind_shipping"
|
||||
// EventTypeTradeManageOrderSettlement 订单将要结算或已经结算
|
||||
// 订单完成发货时/订单结算时
|
||||
EventTypeTradeManageOrderSettlement EventType = "trade_manage_order_settlement"
|
||||
// EventTypeAddExpressPath 运单轨迹更新事件
|
||||
EventTypeAddExpressPath EventType = "add_express_path"
|
||||
// EventTypeSecvodUpload 短剧媒资上传完成事件
|
||||
EventTypeSecvodUpload EventType = "secvod_upload_event"
|
||||
// EventTypeSecvodAudit 短剧媒资审核状态事件
|
||||
EventTypeSecvodAudit EventType = "secvod_audit_event"
|
||||
// EventTypeWxaMediaCheck 媒体内容安全异步审查结果通知
|
||||
EventTypeWxaMediaCheck EventType = "wxa_media_check"
|
||||
// EventTypeXpayGoodsDeliverNotify 道具发货推送事件
|
||||
EventTypeXpayGoodsDeliverNotify EventType = "xpay_goods_deliver_notify"
|
||||
// EventTypeXpayCoinPayNotify 代币支付推送事件
|
||||
EventTypeXpayCoinPayNotify EventType = "xpay_coin_pay_notify"
|
||||
// EventSubscribePopup 用户操作订阅通知弹窗事件推送,用户在图文等场景内订阅通知的操作
|
||||
EventSubscribePopup EventType = "subscribe_msg_popup_event"
|
||||
// EventSubscribeMsgChange 用户管理订阅通知,用户在服务通知管理页面做通知管理时的操作
|
||||
EventSubscribeMsgChange EventType = "subscribe_msg_change_event"
|
||||
// EventSubscribeMsgSent 发送订阅通知,调用 bizsend 接口发送通知
|
||||
EventSubscribeMsgSent EventType = "subscribe_msg_sent_event"
|
||||
// ConfirmReceiveMethodAuto 自动确认收货
|
||||
ConfirmReceiveMethodAuto ConfirmReceiveMethod = 1
|
||||
// ConfirmReceiveMethodManual 手动确认收货
|
||||
ConfirmReceiveMethodManual ConfirmReceiveMethod = 2
|
||||
)
|
||||
|
||||
const (
|
||||
// InfoTypeAcceptSubscribeMessage 接受订阅通知
|
||||
InfoTypeAcceptSubscribeMessage InfoType = "accept"
|
||||
// InfoTypeRejectSubscribeMessage 拒绝订阅通知
|
||||
InfoTypeRejectSubscribeMessage InfoType = "reject"
|
||||
)
|
||||
|
||||
// PushReceiver 接收消息推送
|
||||
// 暂仅支付 Aes 加密方式
|
||||
type PushReceiver struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewPushReceiver 实例化
|
||||
func NewPushReceiver(ctx *context.Context) *PushReceiver {
|
||||
return &PushReceiver{
|
||||
Context: ctx,
|
||||
}
|
||||
}
|
||||
|
||||
// GetMsg 获取接收到的消息 (如果是加密的返回解密数据)
|
||||
func (receiver *PushReceiver) GetMsg(r *http.Request) (string, []byte, error) {
|
||||
// 判断请求格式
|
||||
var dataType string
|
||||
contentType := r.Header.Get("Content-Type")
|
||||
if strings.HasPrefix(contentType, "text/xml") {
|
||||
// xml 格式
|
||||
dataType = DataTypeXML
|
||||
} else {
|
||||
// json 格式
|
||||
dataType = DataTypeJSON
|
||||
}
|
||||
|
||||
// 读取参数,验证签名
|
||||
signature := r.FormValue("signature")
|
||||
timestamp := r.FormValue("timestamp")
|
||||
nonce := r.FormValue("nonce")
|
||||
encryptType := r.FormValue("encrypt_type")
|
||||
// 验证签名
|
||||
tmpArr := []string{
|
||||
receiver.Token,
|
||||
timestamp,
|
||||
nonce,
|
||||
}
|
||||
sort.Strings(tmpArr)
|
||||
tmpSignature := util.Signature(tmpArr...)
|
||||
if tmpSignature != signature {
|
||||
return dataType, nil, errors.New("signature error")
|
||||
}
|
||||
|
||||
if encryptType == "aes" {
|
||||
// 解密
|
||||
var reqData DataReceived
|
||||
if dataType == DataTypeXML {
|
||||
if err := xml.NewDecoder(r.Body).Decode(&reqData); err != nil {
|
||||
return dataType, nil, err
|
||||
}
|
||||
} else {
|
||||
if err := json.NewDecoder(r.Body).Decode(&reqData); err != nil {
|
||||
return dataType, nil, err
|
||||
}
|
||||
}
|
||||
_, rawMsgBytes, err := util.DecryptMsg(receiver.AppID, reqData.Encrypt, receiver.EncodingAESKey)
|
||||
return dataType, rawMsgBytes, err
|
||||
}
|
||||
// 不加密
|
||||
byteData, err := io.ReadAll(r.Body)
|
||||
return dataType, byteData, err
|
||||
}
|
||||
|
||||
// GetMsgData 获取接收到的消息 (解密数据)
|
||||
func (receiver *PushReceiver) GetMsgData(r *http.Request) (MsgType, EventType, PushData, error) {
|
||||
dataType, decryptMsg, err := receiver.GetMsg(r)
|
||||
if err != nil {
|
||||
return "", "", nil, err
|
||||
}
|
||||
var (
|
||||
msgType MsgType
|
||||
eventType EventType
|
||||
)
|
||||
if dataType == DataTypeXML {
|
||||
var commonToken CommonPushData
|
||||
if err := xml.Unmarshal(decryptMsg, &commonToken); err != nil {
|
||||
return "", "", nil, err
|
||||
}
|
||||
msgType, eventType = commonToken.MsgType, commonToken.Event
|
||||
} else {
|
||||
var commonToken CommonPushData
|
||||
if err := json.Unmarshal(decryptMsg, &commonToken); err != nil {
|
||||
return "", "", nil, err
|
||||
}
|
||||
msgType, eventType = commonToken.MsgType, commonToken.Event
|
||||
}
|
||||
if msgType == MsgTypeEvent {
|
||||
pushData, err := receiver.getEvent(dataType, eventType, decryptMsg)
|
||||
// 暂不支持其他事件类型
|
||||
return msgType, eventType, pushData, err
|
||||
}
|
||||
// 暂不支持其他消息类型
|
||||
return msgType, eventType, decryptMsg, nil
|
||||
}
|
||||
|
||||
// getEvent 获取事件推送的数据
|
||||
func (receiver *PushReceiver) getEvent(dataType string, eventType EventType, decryptMsg []byte) (PushData, error) {
|
||||
switch eventType {
|
||||
case EventTypeTradeManageRemindAccessAPI:
|
||||
// 提醒接入发货信息管理服务 API
|
||||
var pushData PushDataRemindAccessAPI
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventTypeTradeManageRemindShipping:
|
||||
// 提醒需要上传发货信息
|
||||
var pushData PushDataRemindShipping
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventTypeTradeManageOrderSettlement:
|
||||
// 订单将要结算或已经结算
|
||||
var pushData PushDataOrderSettlement
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventTypeWxaMediaCheck:
|
||||
// 媒体内容安全异步审查结果通知
|
||||
var pushData MediaCheckAsyncData
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventTypeAddExpressPath:
|
||||
// 运单轨迹更新
|
||||
var pushData PushDataAddExpressPath
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventTypeSecvodUpload:
|
||||
// 短剧媒资上传完成
|
||||
var pushData PushDataSecVodUpload
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventTypeSecvodAudit:
|
||||
// 短剧媒资审核状态
|
||||
var pushData PushDataSecVodAudit
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventTypeXpayGoodsDeliverNotify:
|
||||
// 道具发货推送事件
|
||||
var pushData PushDataXpayGoodsDeliverNotify
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventTypeXpayCoinPayNotify:
|
||||
// 代币支付推送事件
|
||||
var pushData PushDataXpayCoinPayNotify
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
return &pushData, err
|
||||
case EventSubscribePopup:
|
||||
// 用户操作订阅通知弹窗事件推送
|
||||
return receiver.unmarshalSubscribePopup(dataType, decryptMsg)
|
||||
case EventSubscribeMsgChange:
|
||||
// 用户管理订阅通知事件推送
|
||||
return receiver.unmarshalSubscribeMsgChange(dataType, decryptMsg)
|
||||
case EventSubscribeMsgSent:
|
||||
// 用户发送订阅通知事件推送
|
||||
return receiver.unmarshalSubscribeMsgSent(dataType, decryptMsg)
|
||||
}
|
||||
// 暂不支持其他事件类型,直接返回解密后的数据,由调用方处理
|
||||
return decryptMsg, nil
|
||||
}
|
||||
|
||||
// unmarshal 解析推送的数据
|
||||
func (receiver *PushReceiver) unmarshal(dataType string, decryptMsg []byte, pushData interface{}) error {
|
||||
if dataType == DataTypeXML {
|
||||
return xml.Unmarshal(decryptMsg, pushData)
|
||||
}
|
||||
return json.Unmarshal(decryptMsg, pushData)
|
||||
}
|
||||
|
||||
// unmarshalSubscribePopup
|
||||
func (receiver *PushReceiver) unmarshalSubscribePopup(dataType string, decryptMsg []byte) (PushData, error) {
|
||||
var pushData PushDataSubscribePopup
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
if err == nil {
|
||||
listData := gjson.Get(string(decryptMsg), "List")
|
||||
if listData.IsObject() {
|
||||
listItem := SubscribeMsgPopupEventList{}
|
||||
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItem); parseErr != nil {
|
||||
return &pushData, parseErr
|
||||
}
|
||||
pushData.SetSubscribeMsgPopupEvents([]SubscribeMsgPopupEventList{listItem})
|
||||
} else if listData.IsArray() {
|
||||
listItems := make([]SubscribeMsgPopupEventList, 0)
|
||||
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItems); parseErr != nil {
|
||||
return &pushData, parseErr
|
||||
}
|
||||
pushData.SetSubscribeMsgPopupEvents(listItems)
|
||||
}
|
||||
}
|
||||
|
||||
return &pushData, err
|
||||
}
|
||||
|
||||
// unmarshalSubscribeMsgChange 解析用户管理订阅通知事件推送
|
||||
func (receiver *PushReceiver) unmarshalSubscribeMsgChange(dataType string, decryptMsg []byte) (PushData, error) {
|
||||
var pushData PushDataSubscribeMsgChange
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
if err == nil {
|
||||
listData := gjson.Get(string(decryptMsg), "List")
|
||||
if listData.IsObject() {
|
||||
listItem := SubscribeMsgChangeList{}
|
||||
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItem); parseErr != nil {
|
||||
return &pushData, parseErr
|
||||
}
|
||||
pushData.SetSubscribeMsgChangeEvents([]SubscribeMsgChangeList{listItem})
|
||||
} else if listData.IsArray() {
|
||||
listItems := make([]SubscribeMsgChangeList, 0)
|
||||
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItems); parseErr != nil {
|
||||
return &pushData, parseErr
|
||||
}
|
||||
pushData.SetSubscribeMsgChangeEvents(listItems)
|
||||
}
|
||||
}
|
||||
return &pushData, err
|
||||
}
|
||||
|
||||
// unmarshalSubscribeMsgSent 解析用户发送订阅通知事件推送
|
||||
func (receiver *PushReceiver) unmarshalSubscribeMsgSent(dataType string, decryptMsg []byte) (PushData, error) {
|
||||
var pushData PushDataSubscribeMsgSent
|
||||
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
|
||||
if err == nil {
|
||||
listData := gjson.Get(string(decryptMsg), "List")
|
||||
if listData.IsObject() {
|
||||
listItem := SubscribeMsgSentList{}
|
||||
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItem); parseErr != nil {
|
||||
return &pushData, parseErr
|
||||
}
|
||||
pushData.SetSubscribeMsgSentEvents([]SubscribeMsgSentList{listItem})
|
||||
} else if listData.IsArray() {
|
||||
listItems := make([]SubscribeMsgSentList, 0)
|
||||
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItems); parseErr != nil {
|
||||
return &pushData, parseErr
|
||||
}
|
||||
pushData.SetSubscribeMsgSentEvents(listItems)
|
||||
}
|
||||
}
|
||||
return &pushData, err
|
||||
}
|
||||
|
||||
// DataReceived 接收到的数据
|
||||
type DataReceived struct {
|
||||
Encrypt string `json:"Encrypt" xml:"Encrypt"` // 加密的消息体
|
||||
}
|
||||
|
||||
// PushData 推送的数据 (已转对应的结构体)
|
||||
type PushData interface{}
|
||||
|
||||
// CommonPushData 推送数据通用部分
|
||||
type CommonPushData struct {
|
||||
XMLName xml.Name `json:"-" xml:"xml"`
|
||||
MsgType MsgType `json:"MsgType" xml:"MsgType"` // 消息类型,为固定值 "event"
|
||||
Event EventType `json:"Event" xml:"Event"` // 事件类型
|
||||
ToUserName string `json:"ToUserName" xml:"ToUserName"` // 小程序的原始 ID
|
||||
FromUserName string `json:"FromUserName" xml:"FromUserName"` // 发送方账号(一个 OpenID,此时发送方是系统账号)
|
||||
CreateTime int64 `json:"CreateTime" xml:"CreateTime"` // 消息创建时间(整型),时间戳
|
||||
}
|
||||
|
||||
// MediaCheckAsyncData 媒体内容安全异步审查结果通知
|
||||
type MediaCheckAsyncData struct {
|
||||
CommonPushData
|
||||
Appid string `json:"appid" xml:"appid"`
|
||||
TraceID string `json:"trace_id" xml:"trace_id"`
|
||||
Version int `json:"version" xml:"version"`
|
||||
Detail []*MediaCheckDetail `json:"detail" xml:"detail"`
|
||||
Errcode int `json:"errcode" xml:"errcode"`
|
||||
Errmsg string `json:"errmsg" xml:"errmsg"`
|
||||
Result MediaCheckAsyncResult `json:"result" xml:"result"`
|
||||
}
|
||||
|
||||
// MediaCheckDetail 检测结果详情
|
||||
type MediaCheckDetail struct {
|
||||
Strategy string `json:"strategy" xml:"strategy"`
|
||||
Errcode int `json:"errcode" xml:"errcode"`
|
||||
Suggest security.CheckSuggest `json:"suggest" xml:"suggest"`
|
||||
Label int `json:"label" xml:"label"`
|
||||
Prob int `json:"prob" xml:"prob"`
|
||||
}
|
||||
|
||||
// MediaCheckAsyncResult 检测结果
|
||||
type MediaCheckAsyncResult struct {
|
||||
Suggest security.CheckSuggest `json:"suggest" xml:"suggest"`
|
||||
Label security.CheckLabel `json:"label" xml:"label"`
|
||||
}
|
||||
|
||||
// PushDataOrderSettlement 订单将要结算或已经结算通知
|
||||
type PushDataOrderSettlement struct {
|
||||
CommonPushData
|
||||
TransactionID string `json:"transaction_id" xml:"transaction_id"` // 支付订单号
|
||||
MerchantID string `json:"merchant_id" xml:"merchant_id"` // 商户号
|
||||
SubMerchantID string `json:"sub_merchant_id" xml:"sub_merchant_id"` // 子商户号
|
||||
MerchantTradeNo string `json:"merchant_trade_no" xml:"merchant_trade_no"` // 商户订单号
|
||||
PayTime int64 `json:"pay_time" xml:"pay_time"` // 支付成功时间,秒级时间戳
|
||||
ShippedTime int64 `json:"shipped_time" xml:"shipped_time"` // 发货时间,秒级时间戳
|
||||
EstimatedSettlementTime int64 `json:"estimated_settlement_time" xml:"estimated_settlement_time"` // 预计结算时间,秒级时间戳。发货时推送才有该字段
|
||||
ConfirmReceiveMethod ConfirmReceiveMethod `json:"confirm_receive_method" xml:"confirm_receive_method"` // 确认收货方式:1. 自动确认收货;2. 手动确认收货。结算时推送才有该字段
|
||||
ConfirmReceiveTime int64 `json:"confirm_receive_time" xml:"confirm_receive_time"` // 确认收货时间,秒级时间戳。结算时推送才有该字段
|
||||
SettlementTime int64 `json:"settlement_time" xml:"settlement_time"` // 订单结算时间,秒级时间戳。结算时推送才有该字段
|
||||
}
|
||||
|
||||
// PushDataRemindShipping 提醒需要上传发货信息
|
||||
type PushDataRemindShipping struct {
|
||||
CommonPushData
|
||||
TransactionID string `json:"transaction_id" xml:"transaction_id"` // 微信支付订单号
|
||||
MerchantID string `json:"merchant_id" xml:"merchant_id"` // 商户号
|
||||
SubMerchantID string `json:"sub_merchant_id" xml:"sub_merchant_id"` // 子商户号
|
||||
MerchantTradeNo string `json:"merchant_trade_no" xml:"merchant_trade_no"` // 商户订单号
|
||||
PayTime int64 `json:"pay_time" xml:"pay_time"` // 支付成功时间,秒级时间戳
|
||||
Msg string `json:"msg" xml:"msg"` // 消息文本内容
|
||||
}
|
||||
|
||||
// PushDataRemindAccessAPI 提醒接入发货信息管理服务 API 信息
|
||||
type PushDataRemindAccessAPI struct {
|
||||
CommonPushData
|
||||
Msg string `json:"msg" xml:"msg"` // 消息文本内容
|
||||
}
|
||||
|
||||
// PushDataAddExpressPath 运单轨迹更新信息
|
||||
type PushDataAddExpressPath struct {
|
||||
CommonPushData
|
||||
DeliveryID string `json:"DeliveryID" xml:"DeliveryID"` // 快递公司 ID
|
||||
WayBillID string `json:"WaybillId" xml:"WaybillId"` // 运单 ID
|
||||
OrderID string `json:"OrderId" xml:"OrderId"` // 订单 ID
|
||||
Version int `json:"Version" xml:"Version"` // 轨迹版本号(整型)
|
||||
Count int `json:"Count" xml:"Count"` // 轨迹节点数(整型)
|
||||
Actions []*PushDataAddExpressPathAction `json:"Actions" xml:"Actions"` // 轨迹节点列表
|
||||
}
|
||||
|
||||
// PushDataAddExpressPathAction 轨迹节点
|
||||
type PushDataAddExpressPathAction struct {
|
||||
ActionTime int64 `json:"ActionTime" xml:"ActionTime"` // 轨迹节点 Unix 时间戳
|
||||
ActionType int `json:"ActionType" xml:"ActionType"` // 轨迹节点类型
|
||||
ActionMsg string `json:"ActionMsg" xml:"ActionMsg"` // 轨迹节点详情
|
||||
}
|
||||
|
||||
// PushDataSecVodUpload 短剧媒资上传完成
|
||||
type PushDataSecVodUpload struct {
|
||||
CommonPushData
|
||||
UploadEvent SecVodUploadEvent `json:"upload_event" xml:"upload_event"` // 上传完成事件
|
||||
}
|
||||
|
||||
// SecVodUploadEvent 短剧媒资上传完成事件
|
||||
type SecVodUploadEvent struct {
|
||||
MediaID int64 `json:"media_id" xml:"media_id"` // 媒资 id
|
||||
SourceContext string `json:"source_context" xml:"source_context"` // 透传上传接口中开发者设置的值。
|
||||
ErrCode int `json:"errcode" xml:"errcode"` // 错误码,上传失败时该值非
|
||||
ErrMsg string `json:"errmsg" xml:"errmsg"` // 错误提示
|
||||
}
|
||||
|
||||
// PushDataSecVodAudit 短剧媒资审核状态
|
||||
type PushDataSecVodAudit struct {
|
||||
CommonPushData
|
||||
AuditEvent SecVodAuditEvent `json:"audit_event" xml:"audit_event"` // 审核状态事件
|
||||
}
|
||||
|
||||
// SecVodAuditEvent 短剧媒资审核状态事件
|
||||
type SecVodAuditEvent struct {
|
||||
DramaID int64 `json:"drama_id" xml:"drama_id"` // 剧目 id
|
||||
SourceContext string `json:"source_context" xml:"source_context"` // 透传上传接口中开发者设置的值
|
||||
AuditDetail DramaAuditDetail `json:"audit_detail" xml:"audit_detail"` // 剧目审核结果,单独每一集的审核结果可以根据 drama_id 查询剧集详情得到
|
||||
}
|
||||
|
||||
// DramaAuditDetail 剧目审核结果
|
||||
type DramaAuditDetail struct {
|
||||
Status int `json:"status" xml:"status"` // 审核状态,0 为无效值;1 为审核中;2 为最终失败;3 为审核通过;4 为驳回重填
|
||||
CreateTime int64 `json:"create_time" xml:"create_time"` // 提审时间戳
|
||||
AuditTime int64 `json:"audit_time" xml:"audit_time"` // 审核时间戳
|
||||
}
|
||||
|
||||
// PushDataXpayGoodsDeliverNotify 道具发货推送
|
||||
type PushDataXpayGoodsDeliverNotify struct {
|
||||
CommonPushData
|
||||
OpenID string `json:"OpenId" xml:"OpenId"` // 用户 openid
|
||||
OutTradeNo string `json:"OutTradeNo" xml:"OutTradeNo"` // 业务订单号
|
||||
Env int `json:"Env" xml:"Env"` // ,环境配置 0:现网环境(也叫正式环境)1:沙箱环境
|
||||
WeChatPayInfo WeChatPayInfo `json:"WeChatPayInfo" xml:"WeChatPayInfo"` // 微信支付信息 非微信支付渠道可能没有
|
||||
GoodsInfo GoodsInfo `json:"GoodsInfo" xml:"GoodsInfo"` // 道具参数信息
|
||||
}
|
||||
|
||||
// WeChatPayInfo 微信支付信息
|
||||
type WeChatPayInfo struct {
|
||||
MchOrderNo string `json:"MchOrderNo" xml:"MchOrderNo"` // 微信支付商户单号
|
||||
TransactionID string `json:"TransactionId" xml:"TransactionId"` // 交易单号(微信支付订单号)
|
||||
PaidTime int64 `json:"PaidTime" xml:"PaidTime"` // 用户支付时间,Linux 秒级时间戳
|
||||
}
|
||||
|
||||
// GoodsInfo 道具参数信息
|
||||
type GoodsInfo struct {
|
||||
ProductID string `json:"ProductId" xml:"ProductId"` // 道具 ID
|
||||
Quantity int `json:"Quantity" xml:"Quantity"` // 数量
|
||||
OrigPrice int64 `json:"OrigPrice" xml:"OrigPrice"` // 物品原始价格(单位:分)
|
||||
ActualPrice int64 `json:"ActualPrice" xml:"ActualPrice"` // 物品实际支付价格(单位:分)
|
||||
Attach string `json:"Attach" xml:"Attach"` // 透传信息
|
||||
}
|
||||
|
||||
// PushDataXpayCoinPayNotify 代币支付推送
|
||||
type PushDataXpayCoinPayNotify struct {
|
||||
CommonPushData
|
||||
OpenID string `json:"OpenId" xml:"OpenId"` // 用户 openid
|
||||
OutTradeNo string `json:"OutTradeNo" xml:"OutTradeNo"` // 业务订单号
|
||||
Env int `json:"Env" xml:"Env"` // ,环境配置 0:现网环境(也叫正式环境)1:沙箱环境
|
||||
WeChatPayInfo WeChatPayInfo `json:"WeChatPayInfo" xml:"WeChatPayInfo"` // 微信支付信息 非微信支付渠道可能没有
|
||||
CoinInfo CoinInfo `json:"CoinInfo" xml:"CoinInfo"` // 代币参数信息
|
||||
}
|
||||
|
||||
// CoinInfo 代币参数信息
|
||||
type CoinInfo struct {
|
||||
Quantity int `json:"Quantity" xml:"Quantity"` // 数量
|
||||
OrigPrice int64 `json:"OrigPrice" xml:"OrigPrice"` // 物品原始价格(单位:分)
|
||||
ActualPrice int64 `json:"ActualPrice" xml:"ActualPrice"` // 物品实际支付价格(单位:分)
|
||||
Attach string `json:"Attach" xml:"Attach"` // 透传信息
|
||||
}
|
||||
|
||||
// PushDataSubscribePopup 用户操作订阅通知弹窗事件推送
|
||||
type PushDataSubscribePopup struct {
|
||||
CommonPushData
|
||||
subscribeMsgPopupEventList []SubscribeMsgPopupEventList `json:"-"`
|
||||
SubscribeMsgPopupEvent SubscribeMsgPopupEvent `xml:"SubscribeMsgPopupEvent"`
|
||||
}
|
||||
|
||||
// SubscribeMsgPopupEvent 用户操作订阅通知弹窗消息回调
|
||||
type SubscribeMsgPopupEvent struct {
|
||||
List []SubscribeMsgPopupEventList `xml:"List"`
|
||||
}
|
||||
|
||||
// SubscribeMsgPopupEventList 订阅消息事件列表
|
||||
type SubscribeMsgPopupEventList struct {
|
||||
TemplateID string `xml:"TemplateId" json:"TemplateId"`
|
||||
SubscribeStatusString string `xml:"SubscribeStatusString" json:"SubscribeStatusString"`
|
||||
PopupScene string `xml:"PopupScene" json:"PopupScene"`
|
||||
}
|
||||
|
||||
// SetSubscribeMsgPopupEvents 设置订阅消息事件
|
||||
func (s *PushDataSubscribePopup) SetSubscribeMsgPopupEvents(list []SubscribeMsgPopupEventList) {
|
||||
s.subscribeMsgPopupEventList = list
|
||||
}
|
||||
|
||||
// GetSubscribeMsgPopupEvents 获取订阅消息事件数据
|
||||
func (s *PushDataSubscribePopup) GetSubscribeMsgPopupEvents() []SubscribeMsgPopupEventList {
|
||||
if s.subscribeMsgPopupEventList != nil {
|
||||
return s.subscribeMsgPopupEventList
|
||||
}
|
||||
|
||||
if s.SubscribeMsgPopupEvent.List == nil || len(s.SubscribeMsgPopupEvent.List) < 1 {
|
||||
return nil
|
||||
}
|
||||
return s.SubscribeMsgPopupEvent.List
|
||||
}
|
||||
|
||||
// PushDataSubscribeMsgChange 用户管理订阅通知事件推送
|
||||
type PushDataSubscribeMsgChange struct {
|
||||
CommonPushData
|
||||
SubscribeMsgChangeEvent SubscribeMsgChangeEvent `xml:"SubscribeMsgChangeEvent"`
|
||||
subscribeMsgChangeList []SubscribeMsgChangeList `json:"-"`
|
||||
}
|
||||
|
||||
// SubscribeMsgChangeEvent 用户管理订阅通知回调
|
||||
type SubscribeMsgChangeEvent struct {
|
||||
List []SubscribeMsgChangeList `xml:"List" json:"List"`
|
||||
}
|
||||
|
||||
// SubscribeMsgChangeList 订阅消息事件列表
|
||||
type SubscribeMsgChangeList struct {
|
||||
TemplateID string `xml:"TemplateId" json:"TemplateId"`
|
||||
SubscribeStatusString string `xml:"SubscribeStatusString" json:"SubscribeStatusString"`
|
||||
}
|
||||
|
||||
// SetSubscribeMsgChangeEvents 设置订阅消息事件
|
||||
func (s *PushDataSubscribeMsgChange) SetSubscribeMsgChangeEvents(list []SubscribeMsgChangeList) {
|
||||
s.subscribeMsgChangeList = list
|
||||
}
|
||||
|
||||
// GetSubscribeMsgChangeEvents 获取订阅消息事件数据
|
||||
func (s *PushDataSubscribeMsgChange) GetSubscribeMsgChangeEvents() []SubscribeMsgChangeList {
|
||||
if s.subscribeMsgChangeList != nil {
|
||||
return s.subscribeMsgChangeList
|
||||
}
|
||||
|
||||
if s.SubscribeMsgChangeEvent.List == nil || len(s.SubscribeMsgChangeEvent.List) < 1 {
|
||||
return nil
|
||||
}
|
||||
|
||||
return s.SubscribeMsgChangeEvent.List
|
||||
}
|
||||
|
||||
// PushDataSubscribeMsgSent 用户发送订阅通知事件推送
|
||||
type PushDataSubscribeMsgSent struct {
|
||||
CommonPushData
|
||||
SubscribeMsgSentEvent SubscribeMsgSentEvent `xml:"SubscribeMsgSentEvent"`
|
||||
subscribeMsgSentEventList []SubscribeMsgSentList `json:"-"`
|
||||
}
|
||||
|
||||
// SubscribeMsgSentEvent 用户发送订阅通知回调
|
||||
type SubscribeMsgSentEvent struct {
|
||||
List []SubscribeMsgSentList `xml:"List" json:"List"`
|
||||
}
|
||||
|
||||
// SubscribeMsgSentList 订阅消息事件列表
|
||||
type SubscribeMsgSentList struct {
|
||||
TemplateID string `xml:"TemplateId" json:"TemplateId"`
|
||||
MsgID string `xml:"MsgID" json:"MsgID"`
|
||||
ErrorCode int `xml:"ErrorCode" json:"ErrorCode"`
|
||||
ErrorStatus string `xml:"ErrorStatus" json:"ErrorStatus"`
|
||||
}
|
||||
|
||||
// SetSubscribeMsgSentEvents 设置订阅消息事件
|
||||
func (s *PushDataSubscribeMsgSent) SetSubscribeMsgSentEvents(list []SubscribeMsgSentList) {
|
||||
s.subscribeMsgSentEventList = list
|
||||
}
|
||||
|
||||
// GetSubscribeMsgSentEvents 获取订阅消息事件数据
|
||||
func (s *PushDataSubscribeMsgSent) GetSubscribeMsgSentEvents() []SubscribeMsgSentList {
|
||||
if s.subscribeMsgSentEventList != nil {
|
||||
return s.subscribeMsgSentEventList
|
||||
}
|
||||
|
||||
if s.SubscribeMsgSentEvent.List == nil || len(s.SubscribeMsgSentEvent.List) < 1 {
|
||||
return nil
|
||||
}
|
||||
|
||||
return s.SubscribeMsgSentEvent.List
|
||||
}
|
||||
15
miniprogram/message/reply.go
Normal file
15
miniprogram/message/reply.go
Normal file
@@ -0,0 +1,15 @@
|
||||
package message
|
||||
|
||||
import "errors"
|
||||
|
||||
// ErrInvalidReply 无效的回复
|
||||
var ErrInvalidReply = errors.New("无效的回复信息")
|
||||
|
||||
// ErrUnsupportedReply 不支持的回复类型
|
||||
var ErrUnsupportedReply = errors.New("不支持的回复消息")
|
||||
|
||||
// Reply 消息回复
|
||||
type Reply struct {
|
||||
MsgType MsgType
|
||||
MsgData interface{}
|
||||
}
|
||||
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,37 +2,64 @@ 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"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/config"
|
||||
"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/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"
|
||||
"github.com/silenceper/wechat/v2/miniprogram/subscribe"
|
||||
"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
|
||||
@@ -45,27 +72,37 @@ func (miniProgram *MiniProgram) GetEncryptor() *encryptor.Encryptor {
|
||||
return encryptor.NewEncryptor(miniProgram.ctx)
|
||||
}
|
||||
|
||||
//GetAuth 登录/用户信息相关接口
|
||||
// GetAuth 登录/用户信息相关接口
|
||||
func (miniProgram *MiniProgram) GetAuth() *auth.Auth {
|
||||
return auth.NewAuth(miniProgram.ctx)
|
||||
}
|
||||
|
||||
//GetAnalysis 数据分析
|
||||
// GetAnalysis 数据分析
|
||||
func (miniProgram *MiniProgram) GetAnalysis() *analysis.Analysis {
|
||||
return analysis.NewAnalysis(miniProgram.ctx)
|
||||
}
|
||||
|
||||
//GetQRCode 小程序码相关API
|
||||
// GetBusiness 业务接口
|
||||
func (miniProgram *MiniProgram) GetBusiness() *business.Business {
|
||||
return business.NewBusiness(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetPrivacy 小程序隐私协议相关 API
|
||||
func (miniProgram *MiniProgram) GetPrivacy() *privacy.Privacy {
|
||||
return privacy.NewPrivacy(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// 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)
|
||||
}
|
||||
|
||||
//GetSubscribe 小程序订阅消息
|
||||
// GetSubscribe 小程序订阅消息
|
||||
func (miniProgram *MiniProgram) GetSubscribe() *subscribe.Subscribe {
|
||||
return subscribe.NewSubscribe(miniProgram.ctx)
|
||||
}
|
||||
@@ -84,3 +121,73 @@ func (miniProgram *MiniProgram) GetWeRun() *werun.WeRun {
|
||||
func (miniProgram *MiniProgram) GetContentSecurity() *content.Content {
|
||||
return content.NewContent(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetURLLink 小程序 URL Link 接口
|
||||
func (miniProgram *MiniProgram) GetURLLink() *urllink.URLLink {
|
||||
return urllink.NewURLLink(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetRiskControl 安全风控接口
|
||||
func (miniProgram *MiniProgram) GetRiskControl() *riskcontrol.RiskControl {
|
||||
return riskcontrol.NewRiskControl(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetSecurity 内容安全接口
|
||||
func (miniProgram *MiniProgram) GetSecurity() *security.Security {
|
||||
return security.NewSecurity(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// GetShortLink 小程序短链接口
|
||||
func (miniProgram *MiniProgram) GetShortLink() *shortlink.ShortLink {
|
||||
return shortlink.NewShortLink(miniProgram.ctx)
|
||||
}
|
||||
|
||||
// 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)
|
||||
}
|
||||
|
||||
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"` // 收货时间,时间戳形式
|
||||
}
|
||||
157
miniprogram/privacy/privacy.go
Normal file
157
miniprogram/privacy/privacy.go
Normal file
@@ -0,0 +1,157 @@
|
||||
package privacy
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
// Privacy 小程序授权隐私设置
|
||||
type Privacy struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewPrivacy 实例化小程序隐私接口
|
||||
// 文档地址 https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/privacy_config/set_privacy_setting.html
|
||||
func NewPrivacy(context *context.Context) *Privacy {
|
||||
if context == nil {
|
||||
panic("NewPrivacy got a nil context")
|
||||
}
|
||||
return &Privacy{
|
||||
context,
|
||||
}
|
||||
}
|
||||
|
||||
// OwnerSetting 收集方(开发者)信息配置
|
||||
type OwnerSetting struct {
|
||||
ContactEmail string `json:"contact_email"`
|
||||
ContactPhone string `json:"contact_phone"`
|
||||
ContactQQ string `json:"contact_qq"`
|
||||
ContactWeixin string `json:"contact_weixin"`
|
||||
ExtFileMediaID string `json:"ext_file_media_id"`
|
||||
NoticeMethod string `json:"notice_method"`
|
||||
StoreExpireTimestamp string `json:"store_expire_timestamp"`
|
||||
}
|
||||
|
||||
// SettingItem 收集权限的配置
|
||||
type SettingItem struct {
|
||||
PrivacyKey string `json:"privacy_key"`
|
||||
PrivacyText string `json:"privacy_text"`
|
||||
}
|
||||
|
||||
// SetPrivacySettingRequest 设置权限的请求参数
|
||||
type SetPrivacySettingRequest struct {
|
||||
PrivacyVer int `json:"privacy_ver"`
|
||||
OwnerSetting OwnerSetting `json:"owner_setting"`
|
||||
SettingList []SettingItem `json:"setting_list"`
|
||||
}
|
||||
|
||||
const (
|
||||
setPrivacySettingURL = "https://api.weixin.qq.com/cgi-bin/component/setprivacysetting"
|
||||
getPrivacySettingURL = "https://api.weixin.qq.com/cgi-bin/component/getprivacysetting"
|
||||
uploadPrivacyExtFileURL = "https://api.weixin.qq.com/cgi-bin/component/uploadprivacyextfile"
|
||||
|
||||
// PrivacyV1 用户隐私保护指引的版本,1表示现网版本。
|
||||
PrivacyV1 = 1
|
||||
// PrivacyV2 2表示开发版。默认是2开发版。
|
||||
PrivacyV2 = 2
|
||||
)
|
||||
|
||||
// GetPrivacySettingResponse 获取权限配置的响应结果
|
||||
type GetPrivacySettingResponse struct {
|
||||
util.CommonError
|
||||
CodeExist int `json:"code_exist"`
|
||||
PrivacyList []string `json:"privacy_list"`
|
||||
SettingList []SettingResponseItem `json:"setting_list"`
|
||||
UpdateTime int64 `json:"update_time"`
|
||||
OwnerSetting OwnerSetting `json:"owner_setting"`
|
||||
PrivacyDesc DescList `json:"privacy_desc"`
|
||||
}
|
||||
|
||||
// SettingResponseItem 获取权限设置的响应明细
|
||||
type SettingResponseItem struct {
|
||||
PrivacyKey string `json:"privacy_key"`
|
||||
PrivacyText string `json:"privacy_text"`
|
||||
PrivacyLabel string `json:"privacy_label"`
|
||||
}
|
||||
|
||||
// DescList 权限列表(保持与官方一致)
|
||||
type DescList struct {
|
||||
PrivacyDescList []Desc `json:"privacy_desc_list"`
|
||||
}
|
||||
|
||||
// Desc 权限列表明细(保持与官方一致)
|
||||
type Desc struct {
|
||||
PrivacyDesc string `json:"privacy_desc"`
|
||||
PrivacyKey string `json:"privacy_key"`
|
||||
}
|
||||
|
||||
// GetPrivacySetting 获取小程序权限配置
|
||||
func (s *Privacy) GetPrivacySetting(privacyVer int) (GetPrivacySettingResponse, error) {
|
||||
accessToken, err := s.GetAccessToken()
|
||||
if err != nil {
|
||||
return GetPrivacySettingResponse{}, err
|
||||
}
|
||||
|
||||
response, err := util.PostJSON(fmt.Sprintf("%s?access_token=%s", getPrivacySettingURL, accessToken), map[string]int{
|
||||
"privacy_ver": privacyVer,
|
||||
})
|
||||
if err != nil {
|
||||
return GetPrivacySettingResponse{}, err
|
||||
}
|
||||
// 返回错误信息
|
||||
var result GetPrivacySettingResponse
|
||||
err = util.DecodeWithError(response, &result, "getprivacysetting")
|
||||
return result, err
|
||||
}
|
||||
|
||||
// SetPrivacySetting 更新小程序权限配置
|
||||
func (s *Privacy) SetPrivacySetting(privacyVer int, ownerSetting OwnerSetting, settingList []SettingItem) error {
|
||||
if privacyVer == PrivacyV1 && len(settingList) > 0 {
|
||||
return errors.New("当privacy_ver传2或者不传时,setting_list是必填;当privacy_ver传1时,该参数不可传")
|
||||
}
|
||||
accessToken, err := s.GetAccessToken()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
response, err := util.PostJSON(fmt.Sprintf("%s?access_token=%s", setPrivacySettingURL, accessToken), SetPrivacySettingRequest{
|
||||
PrivacyVer: privacyVer,
|
||||
OwnerSetting: ownerSetting,
|
||||
SettingList: settingList,
|
||||
})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// 返回错误信息
|
||||
return util.DecodeWithCommonError(response, "setprivacysetting")
|
||||
}
|
||||
|
||||
// UploadPrivacyExtFileResponse 上传权限定义模板响应参数
|
||||
type UploadPrivacyExtFileResponse struct {
|
||||
util.CommonError
|
||||
ExtFileMediaID string `json:"ext_file_media_id"`
|
||||
}
|
||||
|
||||
// UploadPrivacyExtFile 上传权限定义模板
|
||||
func (s *Privacy) UploadPrivacyExtFile(fileData []byte) (UploadPrivacyExtFileResponse, error) {
|
||||
accessToken, err := s.GetAccessToken()
|
||||
if err != nil {
|
||||
return UploadPrivacyExtFileResponse{}, err
|
||||
}
|
||||
|
||||
response, err := util.PostJSON(fmt.Sprintf("%s?access_token=%s", uploadPrivacyExtFileURL, accessToken), map[string][]byte{
|
||||
"file": fileData,
|
||||
})
|
||||
if err != nil {
|
||||
return UploadPrivacyExtFileResponse{}, err
|
||||
}
|
||||
|
||||
// 返回错误信息
|
||||
var result UploadPrivacyExtFileResponse
|
||||
err = util.DecodeWithError(response, &result, "setprivacysetting")
|
||||
return result, err
|
||||
}
|
||||
@@ -15,12 +15,12 @@ const (
|
||||
getWXACodeUnlimitURL = "https://api.weixin.qq.com/wxa/getwxacodeunlimit?access_token=%s"
|
||||
)
|
||||
|
||||
//QRCode struct
|
||||
// QRCode struct
|
||||
type QRCode struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
//NewQRCode 实例
|
||||
// NewQRCode 实例
|
||||
func NewQRCode(context *context.Context) *QRCode {
|
||||
qrCode := new(QRCode)
|
||||
qrCode.Context = context
|
||||
@@ -40,16 +40,22 @@ type QRCoder struct {
|
||||
Page string `json:"page,omitempty"`
|
||||
// path 扫码进入的小程序页面路径
|
||||
Path string `json:"path,omitempty"`
|
||||
// checkPath 检查page 是否存在,为 true 时 page 必须是已经发布的小程序存在的页面(否则报错);为 false 时允许小程序未发布或者 page 不存在, 但page 有数量上限(60000个)请勿滥用,默认true
|
||||
CheckPath *bool `json:"check_path,omitempty"`
|
||||
// width 图片宽度
|
||||
Width int `json:"width,omitempty"`
|
||||
// scene 最大32个可见字符,只支持数字,大小写英文以及部分特殊字符:!#$&'()*+,/:;=?@-._~,其它字符请自行编码为合法字符(因不支持%,中文无法使用 urlencode 处理,请使用其他编码方式)
|
||||
Scene string `json:"scene,omitempty"`
|
||||
// autoColor 自动配置线条颜色,如果颜色依然是黑色,则说明不建议配置主色调
|
||||
// autoColor 自动配置线条颜色,如果颜色依然是黑色,则说明不建议配置主色调,默认false
|
||||
AutoColor bool `json:"auto_color,omitempty"`
|
||||
// lineColor AutoColor 为 false 时生效,使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"},十进制表示
|
||||
LineColor Color `json:"line_color,omitempty"`
|
||||
// isHyaline 是否需要透明底色
|
||||
LineColor *Color `json:"line_color,omitempty"`
|
||||
// isHyaline 是否需要透明底色,默认false
|
||||
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
|
||||
}
|
||||
60
miniprogram/riskcontrol/riskcontrol.go
Normal file
60
miniprogram/riskcontrol/riskcontrol.go
Normal file
@@ -0,0 +1,60 @@
|
||||
package riskcontrol
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
getUserRiskRankURL = "https://api.weixin.qq.com/wxa/getuserriskrank?access_token=%s"
|
||||
)
|
||||
|
||||
// RiskControl 安全风控
|
||||
type RiskControl struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewRiskControl init
|
||||
func NewRiskControl(ctx *context.Context) *RiskControl {
|
||||
return &RiskControl{ctx}
|
||||
}
|
||||
|
||||
// UserRiskRankRequest 获取用户安全等级请求
|
||||
type UserRiskRankRequest struct {
|
||||
AppID string `json:"appid"` // 小程序 app id
|
||||
OpenID string `json:"openid"` // 用户的 openid
|
||||
Scene uint8 `json:"scene"` // 场景值,0:注册,1:营销作弊
|
||||
ClientIP string `json:"client_ip"` // 用户访问源ip
|
||||
|
||||
Mobile string `json:"mobile_no"` // 用户手机号
|
||||
Email string `json:"email_address"` // 用户邮箱地址
|
||||
ExtendedInfo string `json:"extended_info"` // 额外补充信息
|
||||
IsTest bool `json:"is_test"` // false:正式调用,true:测试调用
|
||||
}
|
||||
|
||||
// UserRiskRank 用户安全等级
|
||||
type UserRiskRank struct {
|
||||
util.CommonError
|
||||
UnionID int64 `json:"union_id"` // 唯一请求标识
|
||||
RiskRank uint8 `json:"risk_rank"` // 用户风险等级
|
||||
}
|
||||
|
||||
// GetUserRiskRank 根据提交的用户信息数据获取用户的安全等级 risk_rank,无需用户授权。
|
||||
func (riskControl *RiskControl) GetUserRiskRank(in *UserRiskRankRequest) (res UserRiskRank, err error) {
|
||||
accessToken, err := riskControl.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(getUserRiskRankURL, accessToken)
|
||||
response, err := util.PostJSON(uri, in)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &res, "GetUserRiskRank")
|
||||
return
|
||||
}
|
||||
257
miniprogram/security/security.go
Normal file
257
miniprogram/security/security.go
Normal file
@@ -0,0 +1,257 @@
|
||||
package security
|
||||
|
||||
import (
|
||||
context2 "context"
|
||||
"fmt"
|
||||
"strconv"
|
||||
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
mediaCheckAsyncURL = "https://api.weixin.qq.com/wxa/media_check_async?access_token=%s"
|
||||
imageCheckURL = "https://api.weixin.qq.com/wxa/img_sec_check?access_token=%s"
|
||||
msgCheckURL = "https://api.weixin.qq.com/wxa/msg_sec_check?access_token=%s"
|
||||
)
|
||||
|
||||
// Security 内容安全
|
||||
type Security struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewSecurity init
|
||||
func NewSecurity(ctx *context.Context) *Security {
|
||||
return &Security{ctx}
|
||||
}
|
||||
|
||||
// MediaCheckAsyncV1Request 图片/音频异步校验请求参数
|
||||
type MediaCheckAsyncV1Request struct {
|
||||
MediaURL string `json:"media_url"` // 要检测的图片或音频的url,支持图片格式包括jpg, jepg, png, bmp, gif(取首帧),支持的音频格式包括mp3, aac, ac3, wma, flac, vorbis, opus, wav
|
||||
MediaType uint8 `json:"media_type"` // 1:音频;2:图片
|
||||
}
|
||||
|
||||
// MediaCheckAsyncV1 异步校验图片/音频是否含有违法违规内容
|
||||
// Deprecated
|
||||
// 在2021年9月1日停止更新,请尽快更新至 2.0 接口。建议使用 MediaCheckAsync
|
||||
func (security *Security) MediaCheckAsyncV1(in *MediaCheckAsyncV1Request) (traceID string, err error) {
|
||||
accessToken, err := security.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(mediaCheckAsyncURL, accessToken)
|
||||
response, err := util.PostJSON(uri, in)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
var res struct {
|
||||
util.CommonError
|
||||
TraceID string `json:"trace_id"`
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "MediaCheckAsyncV1")
|
||||
return res.TraceID, err
|
||||
}
|
||||
|
||||
// MediaCheckAsyncRequest 图片/音频异步校验请求参数
|
||||
type MediaCheckAsyncRequest struct {
|
||||
MediaURL string `json:"media_url"` // 要检测的图片或音频的url,支持图片格式包括jpg, jepg, png, bmp, gif(取首帧),支持的音频格式包括mp3, aac, ac3, wma, flac, vorbis, opus, wav
|
||||
MediaType uint8 `json:"media_type"` // 1:音频;2:图片
|
||||
OpenID string `json:"openid"` // 用户的openid(用户需在近两小时访问过小程序)
|
||||
Scene uint8 `json:"scene"` // 场景枚举值(1 资料;2 评论;3 论坛;4 社交日志)
|
||||
}
|
||||
|
||||
// MediaCheckAsync 异步校验图片/音频是否含有违法违规内容
|
||||
func (security *Security) MediaCheckAsync(in *MediaCheckAsyncRequest) (traceID string, err error) {
|
||||
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
|
||||
}
|
||||
|
||||
var req struct {
|
||||
MediaCheckAsyncRequest
|
||||
Version uint `json:"version"` // 接口版本号,2.0版本为固定值2
|
||||
}
|
||||
req.MediaCheckAsyncRequest = *in
|
||||
req.Version = 2
|
||||
|
||||
uri := fmt.Sprintf(mediaCheckAsyncURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
var res struct {
|
||||
util.CommonError
|
||||
TraceID string `json:"trace_id"`
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "MediaCheckAsync")
|
||||
return res.TraceID, err
|
||||
}
|
||||
|
||||
// ImageCheckV1 校验一张图片是否含有违法违规内容(同步)
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/framework/security.imgSecCheck.html
|
||||
// Deprecated
|
||||
// 在2021年9月1日停止更新。建议使用 MediaCheckAsync
|
||||
func (security *Security) ImageCheckV1(filename string) (err error) {
|
||||
accessToken, err := security.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf(imageCheckURL, accessToken)
|
||||
response, err := util.PostFile("media", filename, uri)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
return util.DecodeWithCommonError(response, "ImageCheckV1")
|
||||
}
|
||||
|
||||
// CheckSuggest 检查建议
|
||||
type CheckSuggest string
|
||||
|
||||
const (
|
||||
// CheckSuggestRisky 违规风险建议
|
||||
CheckSuggestRisky CheckSuggest = "risky"
|
||||
// CheckSuggestPass 安全
|
||||
CheckSuggestPass CheckSuggest = "pass"
|
||||
// CheckSuggestReview 需要审查
|
||||
CheckSuggestReview CheckSuggest = "review"
|
||||
)
|
||||
|
||||
// MsgScene 文本场景
|
||||
type MsgScene uint8
|
||||
|
||||
const (
|
||||
// MsgSceneMaterial 资料文件检查场景
|
||||
MsgSceneMaterial MsgScene = iota + 1
|
||||
// MsgSceneComment 评论
|
||||
MsgSceneComment
|
||||
// MsgSceneForum 论坛
|
||||
MsgSceneForum
|
||||
// MsgSceneSocialLog 社交日志
|
||||
MsgSceneSocialLog
|
||||
)
|
||||
|
||||
// CheckLabel 检查命中标签
|
||||
type CheckLabel int
|
||||
|
||||
func (cl CheckLabel) String() string {
|
||||
switch cl {
|
||||
case 100:
|
||||
return "正常"
|
||||
case 10001:
|
||||
return "广告"
|
||||
case 20001:
|
||||
return "时政"
|
||||
case 20002:
|
||||
return "色情"
|
||||
case 20003:
|
||||
return "辱骂"
|
||||
case 20006:
|
||||
return "违法犯罪"
|
||||
case 20008:
|
||||
return "欺诈"
|
||||
case 20012:
|
||||
return "低俗"
|
||||
case 20013:
|
||||
return "版权"
|
||||
case 21000:
|
||||
return "其他"
|
||||
default:
|
||||
return strconv.Itoa(int(cl))
|
||||
}
|
||||
}
|
||||
|
||||
// MsgCheckRequest 文本检查请求
|
||||
type MsgCheckRequest struct {
|
||||
OpenID string `json:"openid"` // 用户的openid(用户需在近两小时访问过小程序)
|
||||
Scene MsgScene `json:"scene"` // 场景枚举值(1 资料;2 评论;3 论坛;4 社交日志)
|
||||
Content string `json:"content"` // 需检测的文本内容,文本字数的上限为 2500 字,需使用 UTF-8 编码
|
||||
Nickname string `json:"nickname"` // (非必填)用户昵称,需使用UTF-8编码
|
||||
Title string `json:"title"` // (非必填)文本标题,需使用UTF-8编码
|
||||
Signature string `json:"signature"` // (非必填)个性签名,该参数仅在资料类场景有效(scene=1),需使用UTF-8编码
|
||||
}
|
||||
|
||||
// MsgCheckResponse 文本检查响应
|
||||
type MsgCheckResponse struct {
|
||||
util.CommonError
|
||||
TraceID string `json:"trace_id"` // 唯一请求标识
|
||||
Result struct {
|
||||
Suggest CheckSuggest `json:"suggest"` // 建议
|
||||
Label CheckLabel `json:"label"` // 命中标签
|
||||
} `json:"result"` // 综合结果
|
||||
Detail []struct {
|
||||
ErrCode int64 `json:"errcode"` // 错误码,仅当该值为0时,该项结果有效
|
||||
Strategy string `json:"strategy"` // 策略类型
|
||||
Suggest string `json:"suggest"` // 建议
|
||||
Label CheckLabel `json:"label"` // 命中标签
|
||||
Prob uint `json:"prob"` // 置信度。0-100,越高代表越有可能属于当前返回的标签(label)
|
||||
Keyword string `json:"keyword"` // 命中的自定义关键词
|
||||
} `json:"detail"` // 详细检测结果
|
||||
}
|
||||
|
||||
// MsgCheckV1 检查一段文本是否含有违法违规内容
|
||||
// Deprecated
|
||||
// 在2021年9月1日停止更新,请尽快更新至 2.0 接口。建议使用 MsgCheck
|
||||
func (security *Security) MsgCheckV1(content string) (res MsgCheckResponse, err error) {
|
||||
accessToken, err := security.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var req struct {
|
||||
Content string `json:"content"`
|
||||
}
|
||||
req.Content = content
|
||||
|
||||
uri := fmt.Sprintf(msgCheckURL, accessToken)
|
||||
response, err := util.PostJSON(uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &res, "security.MsgCheckV1")
|
||||
return
|
||||
}
|
||||
|
||||
// MsgCheck 检查一段文本是否含有违法违规内容
|
||||
func (security *Security) MsgCheck(in *MsgCheckRequest) (res MsgCheckResponse, err error) {
|
||||
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
|
||||
}
|
||||
|
||||
var req struct {
|
||||
MsgCheckRequest
|
||||
Version uint `json:"version"`
|
||||
}
|
||||
req.MsgCheckRequest = *in
|
||||
req.Version = 2
|
||||
|
||||
uri := fmt.Sprintf(msgCheckURL, accessToken)
|
||||
response, err := util.PostJSONContext(ctx, uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
err = util.DecodeWithError(response, &res, "security.MsgCheck")
|
||||
return
|
||||
}
|
||||
82
miniprogram/shortlink/shortlink.go
Normal file
82
miniprogram/shortlink/shortlink.go
Normal file
@@ -0,0 +1,82 @@
|
||||
package shortlink
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
generateShortLinkURL = "https://api.weixin.qq.com/wxa/genwxashortlink?access_token=%s"
|
||||
)
|
||||
|
||||
// ShortLink 短链接
|
||||
type ShortLink struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewShortLink 实例
|
||||
func NewShortLink(ctx *context.Context) *ShortLink {
|
||||
return &ShortLink{ctx}
|
||||
}
|
||||
|
||||
// ShortLinker 请求结构体
|
||||
type ShortLinker struct {
|
||||
|
||||
// pageUrl 通过 Short Link 进入的小程序页面路径,必须是已经发布的小程序存在的页面,可携带 query,最大 1024 个字符
|
||||
PageURL string `json:"page_url"`
|
||||
|
||||
// pageTitle 页面标题,不能包含违法信息,超过 20 字符会用... 截断代替
|
||||
PageTitle string `json:"page_title"`
|
||||
|
||||
// isPermanent 生成的 Short Link 类型,短期有效:false,永久有效:true
|
||||
IsPermanent bool `json:"is_permanent,omitempty"`
|
||||
}
|
||||
|
||||
// resShortLinker 返回结构体
|
||||
type resShortLinker struct {
|
||||
// 通用错误
|
||||
util.CommonError
|
||||
|
||||
// 返回的 shortLink
|
||||
Link string `json:"link"`
|
||||
}
|
||||
|
||||
// Generate 生成 shortLink
|
||||
func (shortLink *ShortLink) generate(shortLinkParams ShortLinker) (string, error) {
|
||||
var accessToken string
|
||||
accessToken, err := shortLink.GetAccessToken()
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
urlStr := fmt.Sprintf(generateShortLinkURL, accessToken)
|
||||
response, err := util.PostJSON(urlStr, shortLinkParams)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
// 使用通用方法返回错误
|
||||
var res resShortLinker
|
||||
err = util.DecodeWithError(response, &res, "GenerateShortLink")
|
||||
return res.Link, err
|
||||
}
|
||||
|
||||
// GenerateShortLinkPermanent 生成永久 shortLink
|
||||
func (shortLink *ShortLink) GenerateShortLinkPermanent(PageURL, pageTitle string) (string, error) {
|
||||
return shortLink.generate(ShortLinker{
|
||||
PageURL: PageURL,
|
||||
PageTitle: pageTitle,
|
||||
IsPermanent: true,
|
||||
})
|
||||
}
|
||||
|
||||
// GenerateShortLinkTemp 生成临时 shortLink
|
||||
func (shortLink *ShortLink) GenerateShortLinkTemp(PageURL, pageTitle string) (string, error) {
|
||||
return shortLink.generate(ShortLinker{
|
||||
PageURL: PageURL,
|
||||
PageTitle: pageTitle,
|
||||
IsPermanent: false,
|
||||
})
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
package subscribe
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
@@ -8,25 +9,33 @@ import (
|
||||
)
|
||||
|
||||
const (
|
||||
//发送订阅消息
|
||||
//https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.send.html
|
||||
// 发送订阅消息
|
||||
// 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 订阅消息
|
||||
@@ -41,35 +50,49 @@ func NewSubscribe(ctx *context.Context) *Subscribe {
|
||||
|
||||
// Message 订阅消息请求参数
|
||||
type Message struct {
|
||||
ToUser string `json:"touser"` //必选,接收者(用户)的 openid
|
||||
TemplateID string `json:"template_id"` //必选,所需下发的订阅模板id
|
||||
Page string `json:"page"` //可选,点击模板卡片后的跳转页面,仅限本小程序内的页面。支持带参数,(示例index?foo=bar)。该字段不填则模板无跳转。
|
||||
Data map[string]*DataItem `json:"data"` //必选, 模板内容
|
||||
MiniprogramState string `json:"miniprogram_state"` //可选,跳转小程序类型:developer为开发版;trial为体验版;formal为正式版;默认为正式版
|
||||
Lang string `json:"lang"` //入小程序查看”的语言类型,支持zh_CN(简体中文)、en_US(英文)、zh_HK(繁体中文)、zh_TW(繁体中文),默认为zh_CN
|
||||
ToUser string `json:"touser"` // 必选,接收者(用户)的 openid
|
||||
TemplateID string `json:"template_id"` // 必选,所需下发的订阅模板id
|
||||
Page string `json:"page"` // 可选,点击模板卡片后的跳转页面,仅限本小程序内的页面。支持带参数,(示例index?foo=bar)。该字段不填则模板无跳转。
|
||||
Data map[string]*DataItem `json:"data"` // 必选, 模板内容
|
||||
MiniprogramState string `json:"miniprogram_state"` // 可选,跳转小程序类型:developer为开发版;trial为体验版;formal为正式版;默认为正式版
|
||||
Lang string `json:"lang"` // 入小程序查看”的语言类型,支持zh_CN(简体中文)、en_US(英文)、zh_HK(繁体中文)、zh_TW(繁体中文),默认为zh_CN
|
||||
}
|
||||
|
||||
//DataItem 模版内某个 .DATA 的值
|
||||
// DataItem 模版内某个 .DATA 的值
|
||||
type DataItem struct {
|
||||
Value interface{} `json:"value"`
|
||||
Color string `json:"color"`
|
||||
}
|
||||
|
||||
//TemplateItem template item
|
||||
// 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"`
|
||||
}
|
||||
|
||||
//TemplateList template list
|
||||
// KeywordEnumValue 枚举参数值范围
|
||||
type KeywordEnumValue struct {
|
||||
EnumValueList []string `json:"enumValueList"`
|
||||
KeywordCode string `json:"keywordCode"`
|
||||
}
|
||||
|
||||
// TemplateList template list
|
||||
type TemplateList struct {
|
||||
util.CommonError
|
||||
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,7 +108,34 @@ func (s *Subscribe) Send(msg *Message) (err error) {
|
||||
return util.DecodeWithCommonError(response, "Send")
|
||||
}
|
||||
|
||||
//ListTemplates 获取当前帐号下的个人模板列表
|
||||
// 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) {
|
||||
accessToken, err := s.GetAccessToken()
|
||||
@@ -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
|
||||
}
|
||||
|
||||
@@ -21,7 +21,9 @@ wcTcb := wc.GetTcb()
|
||||
```
|
||||
|
||||
### 举例
|
||||
|
||||
#### 触发云函数
|
||||
|
||||
```golang
|
||||
res, err := wcTcb.InvokeCloudFunction("test-xxxx", "add", `{"a":1,"b":2}`)
|
||||
if err != nil {
|
||||
|
||||
@@ -7,17 +7,18 @@ import (
|
||||
)
|
||||
|
||||
const (
|
||||
//触发云函数
|
||||
// 触发云函数
|
||||
invokeCloudFunctionURL = "https://api.weixin.qq.com/tcb/invokecloudfunction"
|
||||
)
|
||||
|
||||
//InvokeCloudFunctionRes 云函数调用返回结果
|
||||
// InvokeCloudFunctionRes 云函数调用返回结果
|
||||
type InvokeCloudFunctionRes struct {
|
||||
util.CommonError
|
||||
RespData string `json:"resp_data"` //云函数返回的buffer
|
||||
RespData string `json:"resp_data"` // 云函数返回的buffer
|
||||
}
|
||||
|
||||
//InvokeCloudFunction 云函数调用
|
||||
// InvokeCloudFunction 云函数调用
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/functions/invokeCloudFunction.html
|
||||
func (tcb *Tcb) InvokeCloudFunction(env, name, args string) (*InvokeCloudFunctionRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
|
||||
@@ -7,191 +7,192 @@ import (
|
||||
)
|
||||
|
||||
const (
|
||||
//数据库导入
|
||||
// 数据库导入
|
||||
databaseMigrateImportURL = "https://api.weixin.qq.com/tcb/databasemigrateimport"
|
||||
//数据库导出
|
||||
// 数据库导出
|
||||
databaseMigrateExportURL = "https://api.weixin.qq.com/tcb/databasemigrateexport"
|
||||
//数据库迁移状态查询
|
||||
// 数据库迁移状态查询
|
||||
databaseMigrateQueryInfoURL = "https://api.weixin.qq.com/tcb/databasemigratequeryinfo"
|
||||
//变更数据库索引
|
||||
// 变更数据库索引
|
||||
updateIndexURL = "https://api.weixin.qq.com/tcb/updateindex"
|
||||
//新增集合
|
||||
// 新增集合
|
||||
databaseCollectionAddURL = "https://api.weixin.qq.com/tcb/databasecollectionadd"
|
||||
//删除集合
|
||||
// 删除集合
|
||||
databaseCollectionDeleteURL = "https://api.weixin.qq.com/tcb/databasecollectiondelete"
|
||||
//获取特定云环境下集合信息
|
||||
// 获取特定云环境下集合信息
|
||||
databaseCollectionGetURL = "https://api.weixin.qq.com/tcb/databasecollectionget"
|
||||
//数据库插入记录
|
||||
// 数据库插入记录
|
||||
databaseAddURL = "https://api.weixin.qq.com/tcb/databaseadd"
|
||||
//数据库删除记录
|
||||
// 数据库删除记录
|
||||
databaseDeleteURL = "https://api.weixin.qq.com/tcb/databasedelete"
|
||||
//数据库更新记录
|
||||
// 数据库更新记录
|
||||
databaseUpdateURL = "https://api.weixin.qq.com/tcb/databaseupdate"
|
||||
//数据库查询记录
|
||||
// 数据库查询记录
|
||||
databaseQueryURL = "https://api.weixin.qq.com/tcb/databasequery"
|
||||
//统计集合记录数或统计查询语句对应的结果记录数
|
||||
// 统计集合记录数或统计查询语句对应的结果记录数
|
||||
databaseCountURL = "https://api.weixin.qq.com/tcb/databasecount"
|
||||
|
||||
//ConflictModeInster 冲突处理模式 插入
|
||||
// ConflictModeInster 冲突处理模式 插入
|
||||
ConflictModeInster ConflictMode = 1
|
||||
//ConflictModeUpsert 冲突处理模式 更新
|
||||
// ConflictModeUpsert 冲突处理模式 更新
|
||||
ConflictModeUpsert ConflictMode = 2
|
||||
|
||||
//FileTypeJSON 的合法值 json
|
||||
// FileTypeJSON 的合法值 json
|
||||
FileTypeJSON FileType = 1
|
||||
//FileTypeCsv 的合法值 csv
|
||||
// FileTypeCsv 的合法值 csv
|
||||
FileTypeCsv FileType = 2
|
||||
)
|
||||
|
||||
//ConflictMode 冲突处理模式
|
||||
// ConflictMode 冲突处理模式
|
||||
type ConflictMode int
|
||||
|
||||
//FileType 文件上传和导出的允许文件类型
|
||||
// FileType 文件上传和导出的允许文件类型
|
||||
type FileType int
|
||||
|
||||
//ValidDirections 合法的direction值
|
||||
// ValidDirections 合法的direction值
|
||||
var ValidDirections = []string{"1", "-1", "2dsphere"}
|
||||
|
||||
//DatabaseMigrateExportReq 数据库出 请求参数
|
||||
// DatabaseMigrateExportReq 数据库出 请求参数
|
||||
type DatabaseMigrateExportReq struct {
|
||||
Env string `json:"env,omitempty"` //云环境ID
|
||||
FilePath string `json:"file_path,omitempty"` //导出文件路径(导入文件需先上传到同环境的存储中,可使用开发者工具或 HTTP API的上传文件 API上传)
|
||||
FileType FileType `json:"file_type,omitempty"` //导出文件类型,文件格式参考数据库导入指引中的文件格式部分 1:json 2:csv
|
||||
Query string `json:"query,omitempty"` //导出条件
|
||||
Env string `json:"env,omitempty"` // 云环境ID
|
||||
FilePath string `json:"file_path,omitempty"` // 导出文件路径(导入文件需先上传到同环境的存储中,可使用开发者工具或 HTTP API的上传文件 API上传)
|
||||
FileType FileType `json:"file_type,omitempty"` // 导出文件类型,文件格式参考数据库导入指引中的文件格式部分 1:json 2:csv
|
||||
Query string `json:"query,omitempty"` // 导出条件
|
||||
}
|
||||
|
||||
//DatabaseMigrateExportRes 数据库导出 返回结果
|
||||
// DatabaseMigrateExportRes 数据库导出 返回结果
|
||||
type DatabaseMigrateExportRes struct {
|
||||
util.CommonError
|
||||
JobID int64 `json:"job_id"` //导出任务ID,可使用数据库迁移进度查询 API 查询导入进度及结果
|
||||
JobID int64 `json:"job_id"` // 导出任务ID,可使用数据库迁移进度查询 API 查询导入进度及结果
|
||||
}
|
||||
|
||||
//DatabaseMigrateImportReq 数据库导入 请求参数
|
||||
// DatabaseMigrateImportReq 数据库导入 请求参数
|
||||
type DatabaseMigrateImportReq struct {
|
||||
Env string `json:"env,omitempty"` //云环境ID
|
||||
CollectionName string `json:"collection_name,omitempty"` //集合名称
|
||||
FilePath string `json:"file_path,omitempty"` //导出文件路径(文件会导出到同环境的云存储中,可使用获取下载链接 API 获取下载链接)
|
||||
FileType FileType `json:"file_type,omitempty"` //导入文件类型,文件格式参考数据库导入指引中的文件格式部分 1:json 2:csv
|
||||
StopOnError bool `json:"stop_on_error,omitempty"` //是否在遇到错误时停止导入
|
||||
ConflictMode ConflictMode `json:"conflict_mode,omitempty"` //冲突处理模式 1:inster 2:UPSERT
|
||||
Env string `json:"env,omitempty"` // 云环境ID
|
||||
CollectionName string `json:"collection_name,omitempty"` // 集合名称
|
||||
FilePath string `json:"file_path,omitempty"` // 导出文件路径(文件会导出到同环境的云存储中,可使用获取下载链接 API 获取下载链接)
|
||||
FileType FileType `json:"file_type,omitempty"` // 导入文件类型,文件格式参考数据库导入指引中的文件格式部分 1:json 2:csv
|
||||
StopOnError bool `json:"stop_on_error,omitempty"` // 是否在遇到错误时停止导入
|
||||
ConflictMode ConflictMode `json:"conflict_mode,omitempty"` // 冲突处理模式 1:inster 2:UPSERT
|
||||
}
|
||||
|
||||
//DatabaseMigrateImportRes 数据库导入 返回结果
|
||||
// DatabaseMigrateImportRes 数据库导入 返回结果
|
||||
type DatabaseMigrateImportRes struct {
|
||||
util.CommonError
|
||||
JobID int64 `json:"job_id"` //导入任务ID,可使用数据库迁移进度查询 API 查询导入进度及结果
|
||||
JobID int64 `json:"job_id"` // 导入任务ID,可使用数据库迁移进度查询 API 查询导入进度及结果
|
||||
}
|
||||
|
||||
//DatabaseMigrateQueryInfoRes 数据库迁移状态查询
|
||||
// DatabaseMigrateQueryInfoRes 数据库迁移状态查询
|
||||
type DatabaseMigrateQueryInfoRes struct {
|
||||
util.CommonError
|
||||
Status string `json:"status"` //导出状态
|
||||
RecordSuccess int64 `json:"record_success"` //导出成功记录数
|
||||
RecordFail int64 `json:"record_fail"` //导出失败记录数
|
||||
ErrMsg string `json:"err_msg"` //导出错误信息
|
||||
FileURL string `json:"file_url"` //导出文件下载地址
|
||||
Status string `json:"status"` // 导出状态
|
||||
RecordSuccess int64 `json:"record_success"` // 导出成功记录数
|
||||
RecordFail int64 `json:"record_fail"` // 导出失败记录数
|
||||
ErrMsg string `json:"err_msg"` // 导出错误信息
|
||||
FileURL string `json:"file_url"` // 导出文件下载地址
|
||||
}
|
||||
|
||||
//UpdateIndexReq 变更数据库索引 请求参数
|
||||
// UpdateIndexReq 变更数据库索引 请求参数
|
||||
type UpdateIndexReq struct {
|
||||
Env string `json:"env,omitempty"` //云环境ID
|
||||
CollectionName string `json:"collection_name,omitempty"` //集合名称
|
||||
CreateIndexes []CreateIndex `json:"create_indexes,omitempty"` //新增索引
|
||||
DropIndexes []DropIndex `json:"drop_indexes,omitempty"` //删除索引
|
||||
Env string `json:"env,omitempty"` // 云环境ID
|
||||
CollectionName string `json:"collection_name,omitempty"` // 集合名称
|
||||
CreateIndexes []CreateIndex `json:"create_indexes,omitempty"` // 新增索引
|
||||
DropIndexes []DropIndex `json:"drop_indexes,omitempty"` // 删除索引
|
||||
}
|
||||
|
||||
//CreateIndex 新增索引
|
||||
// CreateIndex 新增索引
|
||||
type CreateIndex struct {
|
||||
Name string `json:"name,omitempty"` //索引名
|
||||
Unique bool `json:"unique,omitempty"` //是否唯一
|
||||
Keys []CreateIndexKey `json:"keys,omitempty"` //索引字段
|
||||
Name string `json:"name,omitempty"` // 索引名
|
||||
Unique bool `json:"unique,omitempty"` // 是否唯一
|
||||
Keys []CreateIndexKey `json:"keys,omitempty"` // 索引字段
|
||||
}
|
||||
|
||||
//CreateIndexKey create index key
|
||||
// CreateIndexKey create index key
|
||||
type CreateIndexKey struct {
|
||||
Name string `json:"name,omitempty"` //字段名
|
||||
Direction string `json:"direction,omitempty"` //字段排序
|
||||
Name string `json:"name,omitempty"` // 字段名
|
||||
Direction string `json:"direction,omitempty"` // 字段排序
|
||||
}
|
||||
|
||||
//DropIndex 删除索引
|
||||
// DropIndex 删除索引
|
||||
type DropIndex struct {
|
||||
Name string `json:"name,omitempty"`
|
||||
}
|
||||
|
||||
//DatabaseCollectionReq 新增/删除集合请求参数
|
||||
// DatabaseCollectionReq 新增/删除集合请求参数
|
||||
type DatabaseCollectionReq struct {
|
||||
Env string `json:"env,omitempty"` //云环境ID
|
||||
CollectionName string `json:"collection_name,omitempty"` //集合名称
|
||||
Env string `json:"env,omitempty"` // 云环境ID
|
||||
CollectionName string `json:"collection_name,omitempty"` // 集合名称
|
||||
}
|
||||
|
||||
//DatabaseCollectionGetReq 获取特定云环境下集合信息请求
|
||||
// DatabaseCollectionGetReq 获取特定云环境下集合信息请求
|
||||
type DatabaseCollectionGetReq struct {
|
||||
Env string `json:"env,omitempty"` //云环境ID
|
||||
Limit int64 `json:"limit,omitempty"` //获取数量限制
|
||||
Offset int64 `json:"offset,omitempty"` //偏移量
|
||||
Env string `json:"env,omitempty"` // 云环境ID
|
||||
Limit int64 `json:"limit,omitempty"` // 获取数量限制
|
||||
Offset int64 `json:"offset,omitempty"` // 偏移量
|
||||
}
|
||||
|
||||
//DatabaseCollectionGetRes 获取特定云环境下集合信息结果
|
||||
// DatabaseCollectionGetRes 获取特定云环境下集合信息结果
|
||||
type DatabaseCollectionGetRes struct {
|
||||
util.CommonError
|
||||
Pager struct {
|
||||
Limit int64 `json:"limit"` //单次查询限制
|
||||
Offset int64 `json:"offset"` //偏移量
|
||||
Total int64 `json:"total"` //符合查询条件的记录总数
|
||||
Limit int64 `json:"limit"` // 单次查询限制
|
||||
Offset int64 `json:"offset"` // 偏移量
|
||||
Total int64 `json:"total"` // 符合查询条件的记录总数
|
||||
} `json:"pager"`
|
||||
Collections []struct {
|
||||
Name string `json:"name"` //集合名
|
||||
Count int64 `json:"count"` //表中文档数量
|
||||
Size int64 `json:"size"` //表的大小(即表中文档总大小),单位:字节
|
||||
IndexCount int64 `json:"index_count"` //索引数量
|
||||
IndexSize int64 `json:"index_size"` //索引占用大小,单位:字节
|
||||
Name string `json:"name"` // 集合名
|
||||
Count int64 `json:"count"` // 表中文档数量
|
||||
Size int64 `json:"size"` // 表的大小(即表中文档总大小),单位:字节
|
||||
IndexCount int64 `json:"index_count"` // 索引数量
|
||||
IndexSize int64 `json:"index_size"` // 索引占用大小,单位:字节
|
||||
} `json:"collections"`
|
||||
}
|
||||
|
||||
//DatabaseReq 数据库插入/删除/更新/查询/统计记录请求参数
|
||||
// DatabaseReq 数据库插入/删除/更新/查询/统计记录请求参数
|
||||
type DatabaseReq struct {
|
||||
Env string `json:"env,omitempty"` //云环境ID
|
||||
Query string `json:"query,omitempty"` //数据库操作语句
|
||||
Env string `json:"env,omitempty"` // 云环境ID
|
||||
Query string `json:"query,omitempty"` // 数据库操作语句
|
||||
}
|
||||
|
||||
//DatabaseAddRes 数据库插入记录返回结果
|
||||
// DatabaseAddRes 数据库插入记录返回结果
|
||||
type DatabaseAddRes struct {
|
||||
util.CommonError
|
||||
IDList []string `json:"id_list"` //插入成功的数据集合主键_id。
|
||||
IDList []string `json:"id_list"` // 插入成功的数据集合主键_id。
|
||||
}
|
||||
|
||||
//DatabaseDeleteRes 数据库删除记录返回结果
|
||||
// DatabaseDeleteRes 数据库删除记录返回结果
|
||||
type DatabaseDeleteRes struct {
|
||||
util.CommonError
|
||||
Deleted int64 `json:"deleted"` //删除记录数量
|
||||
Deleted int64 `json:"deleted"` // 删除记录数量
|
||||
}
|
||||
|
||||
//DatabaseUpdateRes 数据库更新记录返回结果
|
||||
// DatabaseUpdateRes 数据库更新记录返回结果
|
||||
type DatabaseUpdateRes struct {
|
||||
util.CommonError
|
||||
Matched int64 `json:"matched"` //更新条件匹配到的结果数
|
||||
Modified int64 `json:"modified"` //修改的记录数,注意:使用set操作新插入的数据不计入修改数目
|
||||
Matched int64 `json:"matched"` // 更新条件匹配到的结果数
|
||||
Modified int64 `json:"modified"` // 修改的记录数,注意:使用set操作新插入的数据不计入修改数目
|
||||
ID string `json:"id"`
|
||||
}
|
||||
|
||||
//DatabaseQueryRes 数据库查询记录 返回结果
|
||||
// DatabaseQueryRes 数据库查询记录 返回结果
|
||||
type DatabaseQueryRes struct {
|
||||
util.CommonError
|
||||
Pager struct {
|
||||
Limit int64 `json:"limit"` //单次查询限制
|
||||
Offset int64 `json:"offset"` //偏移量
|
||||
Total int64 `json:"total"` //符合查询条件的记录总数
|
||||
Limit int64 `json:"limit"` // 单次查询限制
|
||||
Offset int64 `json:"offset"` // 偏移量
|
||||
Total int64 `json:"total"` // 符合查询条件的记录总数
|
||||
} `json:"pager"`
|
||||
Data []string `json:"data"`
|
||||
}
|
||||
|
||||
//DatabaseCountRes 统计集合记录数或统计查询语句对应的结果记录数 返回结果
|
||||
// DatabaseCountRes 统计集合记录数或统计查询语句对应的结果记录数 返回结果
|
||||
type DatabaseCountRes struct {
|
||||
util.CommonError
|
||||
Count int64 `json:"count"` //记录数量
|
||||
Count int64 `json:"count"` // 记录数量
|
||||
}
|
||||
|
||||
//DatabaseMigrateImport 数据库导入
|
||||
// DatabaseMigrateImport 数据库导入
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateImport.html
|
||||
func (tcb *Tcb) DatabaseMigrateImport(req *DatabaseMigrateImportReq) (*DatabaseMigrateImportRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -208,7 +209,8 @@ func (tcb *Tcb) DatabaseMigrateImport(req *DatabaseMigrateImportReq) (*DatabaseM
|
||||
return databaseMigrateImportRes, err
|
||||
}
|
||||
|
||||
//DatabaseMigrateExport 数据库导出
|
||||
// DatabaseMigrateExport 数据库导出
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateExport.html
|
||||
func (tcb *Tcb) DatabaseMigrateExport(req *DatabaseMigrateExportReq) (*DatabaseMigrateExportRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -225,7 +227,8 @@ func (tcb *Tcb) DatabaseMigrateExport(req *DatabaseMigrateExportReq) (*DatabaseM
|
||||
return databaseMigrateExportRes, err
|
||||
}
|
||||
|
||||
//DatabaseMigrateQueryInfo 数据库迁移状态查询
|
||||
// DatabaseMigrateQueryInfo 数据库迁移状态查询
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateQueryInfo.html
|
||||
func (tcb *Tcb) DatabaseMigrateQueryInfo(env string, jobID int64) (*DatabaseMigrateQueryInfoRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -245,8 +248,8 @@ func (tcb *Tcb) DatabaseMigrateQueryInfo(env string, jobID int64) (*DatabaseMigr
|
||||
return databaseMigrateQueryInfoRes, err
|
||||
}
|
||||
|
||||
//UpdateIndex 变更数据库索引
|
||||
//https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/updateIndex.html
|
||||
// UpdateIndex 变更数据库索引
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/updateIndex.html
|
||||
func (tcb *Tcb) UpdateIndex(req *UpdateIndexReq) error {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -260,7 +263,8 @@ func (tcb *Tcb) UpdateIndex(req *UpdateIndexReq) error {
|
||||
return util.DecodeWithCommonError(response, "UpdateIndex")
|
||||
}
|
||||
|
||||
//DatabaseCollectionAdd 新增集合
|
||||
// DatabaseCollectionAdd 新增集合
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionAdd.html
|
||||
func (tcb *Tcb) DatabaseCollectionAdd(env, collectionName string) error {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -278,7 +282,8 @@ func (tcb *Tcb) DatabaseCollectionAdd(env, collectionName string) error {
|
||||
return util.DecodeWithCommonError(response, "DatabaseCollectionAdd")
|
||||
}
|
||||
|
||||
//DatabaseCollectionDelete 删除集合
|
||||
// DatabaseCollectionDelete 删除集合
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionDelete.html
|
||||
func (tcb *Tcb) DatabaseCollectionDelete(env, collectionName string) error {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -296,7 +301,8 @@ func (tcb *Tcb) DatabaseCollectionDelete(env, collectionName string) error {
|
||||
return util.DecodeWithCommonError(response, "DatabaseCollectionDelete")
|
||||
}
|
||||
|
||||
//DatabaseCollectionGet 获取特定云环境下集合信息
|
||||
// DatabaseCollectionGet 获取特定云环境下集合信息
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionGet.html
|
||||
func (tcb *Tcb) DatabaseCollectionGet(env string, limit, offset int64) (*DatabaseCollectionGetRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -317,7 +323,8 @@ func (tcb *Tcb) DatabaseCollectionGet(env string, limit, offset int64) (*Databas
|
||||
return databaseCollectionGetRes, err
|
||||
}
|
||||
|
||||
//DatabaseAdd 数据库插入记录
|
||||
// DatabaseAdd 数据库插入记录
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseAdd.html
|
||||
func (tcb *Tcb) DatabaseAdd(env, query string) (*DatabaseAddRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -337,7 +344,8 @@ func (tcb *Tcb) DatabaseAdd(env, query string) (*DatabaseAddRes, error) {
|
||||
return databaseAddRes, err
|
||||
}
|
||||
|
||||
//DatabaseDelete 数据库插入记录
|
||||
// DatabaseDelete 数据库插入记录
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseDelete.html
|
||||
func (tcb *Tcb) DatabaseDelete(env, query string) (*DatabaseDeleteRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -357,7 +365,8 @@ func (tcb *Tcb) DatabaseDelete(env, query string) (*DatabaseDeleteRes, error) {
|
||||
return databaseDeleteRes, err
|
||||
}
|
||||
|
||||
//DatabaseUpdate 数据库插入记录
|
||||
// DatabaseUpdate 数据库插入记录
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseUpdate.html
|
||||
func (tcb *Tcb) DatabaseUpdate(env, query string) (*DatabaseUpdateRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -377,7 +386,8 @@ func (tcb *Tcb) DatabaseUpdate(env, query string) (*DatabaseUpdateRes, error) {
|
||||
return databaseUpdateRes, err
|
||||
}
|
||||
|
||||
//DatabaseQuery 数据库查询记录
|
||||
// DatabaseQuery 数据库查询记录
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseQuery.html
|
||||
func (tcb *Tcb) DatabaseQuery(env, query string) (*DatabaseQueryRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -397,7 +407,8 @@ func (tcb *Tcb) DatabaseQuery(env, query string) (*DatabaseQueryRes, error) {
|
||||
return databaseQueryRes, err
|
||||
}
|
||||
|
||||
//DatabaseCount 统计集合记录数或统计查询语句对应的结果记录数
|
||||
// DatabaseCount 统计集合记录数或统计查询语句对应的结果记录数
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCount.html
|
||||
func (tcb *Tcb) DatabaseCount(env, query string) (*DatabaseCountRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
|
||||
@@ -7,60 +7,60 @@ import (
|
||||
)
|
||||
|
||||
const (
|
||||
//获取文件上传链接
|
||||
// 获取文件上传链接
|
||||
uploadFilePathURL = "https://api.weixin.qq.com/tcb/uploadfile"
|
||||
//获取文件下载链接
|
||||
// 获取文件下载链接
|
||||
batchDownloadFileURL = "https://api.weixin.qq.com/tcb/batchdownloadfile"
|
||||
//删除文件链接
|
||||
// 删除文件链接
|
||||
batchDeleteFileURL = "https://api.weixin.qq.com/tcb/batchdeletefile"
|
||||
)
|
||||
|
||||
//UploadFileReq 上传文件请求值
|
||||
// UploadFileReq 上传文件请求值
|
||||
type UploadFileReq struct {
|
||||
Env string `json:"env,omitempty"`
|
||||
Path string `json:"path,omitempty"`
|
||||
}
|
||||
|
||||
//UploadFileRes 上传文件返回结果
|
||||
// UploadFileRes 上传文件返回结果
|
||||
type UploadFileRes struct {
|
||||
util.CommonError
|
||||
URL string `json:"url"` //上传url
|
||||
Token string `json:"token"` //token
|
||||
Authorization string `json:"authorization"` //authorization
|
||||
FileID string `json:"file_id"` //文件ID
|
||||
CosFileID string `json:"cos_file_id"` //cos文件ID
|
||||
URL string `json:"url"` // 上传url
|
||||
Token string `json:"token"` // token
|
||||
Authorization string `json:"authorization"` // authorization
|
||||
FileID string `json:"file_id"` // 文件ID
|
||||
CosFileID string `json:"cos_file_id"` // cos文件ID
|
||||
}
|
||||
|
||||
//BatchDownloadFileReq 上传文件请求值
|
||||
// BatchDownloadFileReq 上传文件请求值
|
||||
type BatchDownloadFileReq struct {
|
||||
Env string `json:"env,omitempty"`
|
||||
FileList []*DownloadFile `json:"file_list,omitempty"`
|
||||
}
|
||||
|
||||
//DownloadFile 文件信息
|
||||
// DownloadFile 文件信息
|
||||
type DownloadFile struct {
|
||||
FileID string `json:"fileid"` //文件ID
|
||||
MaxAge int64 `json:"max_age"` //下载链接有效期
|
||||
FileID string `json:"fileid"` // 文件ID
|
||||
MaxAge int64 `json:"max_age"` // 下载链接有效期
|
||||
}
|
||||
|
||||
//BatchDownloadFileRes 上传文件返回结果
|
||||
// BatchDownloadFileRes 上传文件返回结果
|
||||
type BatchDownloadFileRes struct {
|
||||
util.CommonError
|
||||
FileList []struct {
|
||||
FileID string `json:"file_id"` //文件ID
|
||||
DownloadURL string `json:"download_url"` //下载链接
|
||||
Status int64 `json:"status"` //状态码
|
||||
ErrMsg string `json:"errmsg"` //该文件错误信息
|
||||
FileID string `json:"file_id"` // 文件ID
|
||||
DownloadURL string `json:"download_url"` // 下载链接
|
||||
Status int64 `json:"status"` // 状态码
|
||||
ErrMsg string `json:"errmsg"` // 该文件错误信息
|
||||
} `json:"file_list"`
|
||||
}
|
||||
|
||||
//BatchDeleteFileReq 批量删除文件请求参数
|
||||
// BatchDeleteFileReq 批量删除文件请求参数
|
||||
type BatchDeleteFileReq struct {
|
||||
Env string `json:"env,omitempty"`
|
||||
FileIDList []string `json:"fileid_list,omitempty"`
|
||||
}
|
||||
|
||||
//BatchDeleteFileRes 批量删除文件返回结果
|
||||
// BatchDeleteFileRes 批量删除文件返回结果
|
||||
type BatchDeleteFileRes struct {
|
||||
util.CommonError
|
||||
DeleteList []struct {
|
||||
@@ -70,7 +70,8 @@ type BatchDeleteFileRes struct {
|
||||
} `json:"delete_list"`
|
||||
}
|
||||
|
||||
//UploadFile 上传文件
|
||||
// UploadFile 上传文件
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/uploadFile.html
|
||||
func (tcb *Tcb) UploadFile(env, path string) (*UploadFileRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -91,7 +92,8 @@ func (tcb *Tcb) UploadFile(env, path string) (*UploadFileRes, error) {
|
||||
return uploadFileRes, err
|
||||
}
|
||||
|
||||
//BatchDownloadFile 获取文件下载链接
|
||||
// BatchDownloadFile 获取文件下载链接
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/batchDownloadFile.html
|
||||
func (tcb *Tcb) BatchDownloadFile(env string, fileList []*DownloadFile) (*BatchDownloadFileRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
@@ -112,7 +114,8 @@ func (tcb *Tcb) BatchDownloadFile(env string, fileList []*DownloadFile) (*BatchD
|
||||
return batchDownloadFileRes, err
|
||||
}
|
||||
|
||||
//BatchDeleteFile 批量删除文件
|
||||
// BatchDeleteFile 批量删除文件
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/batchDeleteFile.html
|
||||
func (tcb *Tcb) BatchDeleteFile(env string, fileIDList []string) (*BatchDeleteFileRes, error) {
|
||||
accessToken, err := tcb.GetAccessToken()
|
||||
|
||||
@@ -2,12 +2,12 @@ package tcb
|
||||
|
||||
import "github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
|
||||
//Tcb Tencent Cloud Base
|
||||
// Tcb Tencent Cloud Base
|
||||
type Tcb struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
//NewTcb new Tencent Cloud Base
|
||||
// NewTcb new Tencent Cloud Base
|
||||
func NewTcb(context *context.Context) *Tcb {
|
||||
return &Tcb{
|
||||
context,
|
||||
|
||||
68
miniprogram/urllink/query.go
Normal file
68
miniprogram/urllink/query.go
Normal file
@@ -0,0 +1,68 @@
|
||||
package urllink
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
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 返回值
|
||||
type ULQueryResult struct {
|
||||
util.CommonError
|
||||
|
||||
URLLinkInfo struct {
|
||||
Appid string `json:"appid"`
|
||||
Path string `json:"path"`
|
||||
Query string `json:"query"`
|
||||
CreateTime int64 `json:"create_time"`
|
||||
ExpireTime int64 `json:"expire_time"`
|
||||
EnvVersion string `json:"env_version"`
|
||||
CloudBase struct {
|
||||
Env string `json:"env"`
|
||||
Domain string `json:"domain"`
|
||||
Path string `json:"path"`
|
||||
Query string `json:"query"`
|
||||
ResourceAppid string `json:"resource_appid"`
|
||||
} `json:"cloud_base"`
|
||||
} `json:"url_link_info"`
|
||||
VisitOpenid string `json:"visit_openid"`
|
||||
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) {
|
||||
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
|
||||
}
|
||||
69
miniprogram/urllink/urllink.go
Normal file
69
miniprogram/urllink/urllink.go
Normal file
@@ -0,0 +1,69 @@
|
||||
package urllink
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
// URLLink 小程序 URL Link
|
||||
type URLLink struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewURLLink 实例化
|
||||
func NewURLLink(ctx *context.Context) *URLLink {
|
||||
return &URLLink{Context: ctx}
|
||||
}
|
||||
|
||||
const generateURL = "https://api.weixin.qq.com/wxa/generate_urllink"
|
||||
|
||||
// TExpireType 失效类型 (指定时间戳/指定间隔)
|
||||
type TExpireType int
|
||||
|
||||
const (
|
||||
// ExpireTypeTime 指定时间戳后失效
|
||||
ExpireTypeTime TExpireType = 0
|
||||
|
||||
// ExpireTypeInterval 间隔指定天数后失效
|
||||
ExpireTypeInterval TExpireType = 1
|
||||
)
|
||||
|
||||
// ULParams 请求参数
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-link/urllink.generate.html#请求参数
|
||||
type ULParams struct {
|
||||
Path string `json:"path"`
|
||||
Query string `json:"query"`
|
||||
// envVersion 要打开的小程序版本。正式版为 "release",体验版为 "trial",开发版为 "develop"
|
||||
EnvVersion string `json:"env_version,omitempty"`
|
||||
IsExpire bool `json:"is_expire"`
|
||||
ExpireType TExpireType `json:"expire_type"`
|
||||
ExpireTime int64 `json:"expire_time"`
|
||||
ExpireInterval int `json:"expire_interval"`
|
||||
}
|
||||
|
||||
// ULResult 返回的结果
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-link/urllink.generate.html#返回值
|
||||
type ULResult struct {
|
||||
util.CommonError
|
||||
|
||||
URLLink string `json:"url_link"`
|
||||
}
|
||||
|
||||
// Generate 生成url link
|
||||
func (u *URLLink) Generate(params *ULParams) (string, error) {
|
||||
accessToken, err := u.GetAccessToken()
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf("%s?access_token=%s", generateURL, accessToken)
|
||||
response, err := util.PostJSON(uri, params)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
var resp ULResult
|
||||
err = util.DecodeWithError(response, &resp, "URLLink.Generate")
|
||||
return resp.URLLink, err
|
||||
}
|
||||
80
miniprogram/urlscheme/query.go
Normal file
80
miniprogram/urlscheme/query.go
Normal file
@@ -0,0 +1,80 @@
|
||||
package urlscheme
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
querySchemeURL = "https://api.weixin.qq.com/wxa/queryscheme?access_token=%s"
|
||||
)
|
||||
|
||||
// QueryScheme 获取小程序访问scheme
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-scheme/urlscheme.query.html#参数
|
||||
type QueryScheme struct {
|
||||
// 小程序 scheme 码
|
||||
Scheme string `json:"scheme"`
|
||||
QueryType int `json:"query_type"`
|
||||
}
|
||||
|
||||
// SchemeInfo scheme 配置
|
||||
type SchemeInfo struct {
|
||||
// 小程序 appid。
|
||||
AppID string `json:"appid"`
|
||||
// 小程序页面路径。
|
||||
Path string `json:"path"`
|
||||
// 小程序页面query。
|
||||
Query string `json:"query"`
|
||||
// 创建时间,为 Unix 时间戳。
|
||||
CreateTime int64 `json:"create_time"`
|
||||
// 到期失效时间,为 Unix 时间戳,0 表示永久生效
|
||||
ExpireTime int64 `json:"expire_time"`
|
||||
// 要打开的小程序版本。正式版为"release",体验版为"trial",开发版为"develop"。
|
||||
EnvVersion EnvVersion `json:"env_version"`
|
||||
}
|
||||
|
||||
// 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 {
|
||||
// 通用错误
|
||||
util.CommonError
|
||||
// scheme 配置
|
||||
SchemeInfo SchemeInfo `json:"scheme_info"`
|
||||
// 访问该链接的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) {
|
||||
res, err := u.QuerySchemeWithRes(querySchemeParams)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
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
|
||||
}
|
||||
109
miniprogram/urlscheme/urlscheme.go
Normal file
109
miniprogram/urlscheme/urlscheme.go
Normal file
@@ -0,0 +1,109 @@
|
||||
package urlscheme
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/miniprogram/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
// URLScheme 小程序 URL Scheme
|
||||
type URLScheme struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewURLScheme 实例化
|
||||
func NewURLScheme(ctx *context.Context) *URLScheme {
|
||||
return &URLScheme{Context: ctx}
|
||||
}
|
||||
|
||||
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
|
||||
|
||||
// EnvVersion 要打开的小程序版本
|
||||
type EnvVersion string
|
||||
|
||||
const (
|
||||
// ExpireTypeTime 指定时间戳后失效
|
||||
ExpireTypeTime TExpireType = 0
|
||||
// ExpireTypeInterval 间隔指定天数后失效
|
||||
ExpireTypeInterval TExpireType = 1
|
||||
|
||||
// EnvVersionRelease 正式版为"release"
|
||||
EnvVersionRelease EnvVersion = "release"
|
||||
// EnvVersionTrial 体验版为"trial"
|
||||
EnvVersionTrial EnvVersion = "trial"
|
||||
// EnvVersionDevelop 开发版为"develop"
|
||||
EnvVersionDevelop EnvVersion = "develop"
|
||||
)
|
||||
|
||||
// JumpWxa 跳转到的目标小程序信息
|
||||
type JumpWxa struct {
|
||||
Path string `json:"path"`
|
||||
Query string `json:"query"`
|
||||
// envVersion 要打开的小程序版本。正式版为 "release",体验版为 "trial",开发版为 "develop"
|
||||
EnvVersion EnvVersion `json:"env_version,omitempty"`
|
||||
}
|
||||
|
||||
// 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,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 返回的结果
|
||||
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-scheme/urlscheme.generate.html#返回值
|
||||
type USResult struct {
|
||||
util.CommonError
|
||||
|
||||
OpenLink string `json:"openlink"`
|
||||
}
|
||||
|
||||
// Generate 生成url link
|
||||
func (u *URLScheme) Generate(params *USParams) (string, error) {
|
||||
accessToken, err := u.GetAccessToken()
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
uri := fmt.Sprintf("%s?access_token=%s", generateURL, accessToken)
|
||||
response, err := util.PostJSON(uri, params)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
var resp USResult
|
||||
err = util.DecodeWithError(response, &resp, "URLScheme.Generate")
|
||||
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
|
||||
}
|
||||
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
|
||||
}
|
||||
@@ -8,34 +8,34 @@ import (
|
||||
)
|
||||
|
||||
var (
|
||||
//获取微信服务器IP地址
|
||||
//文档:https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Get_the_WeChat_server_IP_address.html
|
||||
// 获取微信服务器IP地址
|
||||
// 文档:https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Get_the_WeChat_server_IP_address.html
|
||||
getCallbackIPURL = "https://api.weixin.qq.com/cgi-bin/getcallbackip"
|
||||
getAPIDomainIPURL = "https://api.weixin.qq.com/cgi-bin/get_api_domain_ip"
|
||||
|
||||
//清理接口调用次数
|
||||
// 清理接口调用次数
|
||||
clearQuotaURL = "https://api.weixin.qq.com/cgi-bin/clear_quota"
|
||||
)
|
||||
|
||||
//Basic struct
|
||||
// Basic struct
|
||||
type Basic struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
//NewBasic 实例
|
||||
// NewBasic 实例
|
||||
func NewBasic(context *context.Context) *Basic {
|
||||
basic := new(Basic)
|
||||
basic.Context = context
|
||||
return basic
|
||||
}
|
||||
|
||||
//IPListRes 获取微信服务器IP地址 返回结果
|
||||
// IPListRes 获取微信服务器IP地址 返回结果
|
||||
type IPListRes struct {
|
||||
util.CommonError
|
||||
IPList []string `json:"ip_list"`
|
||||
}
|
||||
|
||||
//GetCallbackIP 获取微信callback IP地址
|
||||
// GetCallbackIP 获取微信callback IP地址
|
||||
func (basic *Basic) GetCallbackIP() ([]string, error) {
|
||||
ak, err := basic.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -51,7 +51,7 @@ func (basic *Basic) GetCallbackIP() ([]string, error) {
|
||||
return ipListRes.IPList, err
|
||||
}
|
||||
|
||||
//GetAPIDomainIP 获取微信API接口 IP地址
|
||||
// GetAPIDomainIP 获取微信API接口 IP地址
|
||||
func (basic *Basic) GetAPIDomainIP() ([]string, error) {
|
||||
ak, err := basic.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -67,7 +67,7 @@ func (basic *Basic) GetAPIDomainIP() ([]string, error) {
|
||||
return ipListRes.IPList, err
|
||||
}
|
||||
|
||||
//ClearQuota 清理接口调用次数
|
||||
// ClearQuota 清理接口调用次数
|
||||
func (basic *Basic) ClearQuota() error {
|
||||
ak, err := basic.GetAccessToken()
|
||||
if err != nil {
|
||||
|
||||
@@ -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
|
||||
}
|
||||
|
||||
@@ -17,42 +17,42 @@ const (
|
||||
setSpeedSendURL = "https://api.weixin.qq.com/cgi-bin/message/mass/speed/set"
|
||||
)
|
||||
|
||||
//MsgType 发送消息类型
|
||||
// MsgType 发送消息类型
|
||||
type MsgType string
|
||||
|
||||
const (
|
||||
//MsgTypeNews 图文消息
|
||||
// MsgTypeNews 图文消息
|
||||
MsgTypeNews MsgType = "mpnews"
|
||||
//MsgTypeText 文本
|
||||
// MsgTypeText 文本
|
||||
MsgTypeText MsgType = "text"
|
||||
//MsgTypeVoice 语音/音频
|
||||
// MsgTypeVoice 语音/音频
|
||||
MsgTypeVoice MsgType = "voice"
|
||||
//MsgTypeImage 图片
|
||||
// MsgTypeImage 图片
|
||||
MsgTypeImage MsgType = "image"
|
||||
//MsgTypeVideo 视频
|
||||
// MsgTypeVideo 视频
|
||||
MsgTypeVideo MsgType = "mpvideo"
|
||||
//MsgTypeWxCard 卡券
|
||||
// MsgTypeWxCard 卡券
|
||||
MsgTypeWxCard MsgType = "wxcard"
|
||||
)
|
||||
|
||||
//Broadcast 群发消息
|
||||
// Broadcast 群发消息
|
||||
type Broadcast struct {
|
||||
*context.Context
|
||||
preview bool
|
||||
}
|
||||
|
||||
//NewBroadcast new
|
||||
// NewBroadcast new
|
||||
func NewBroadcast(ctx *context.Context) *Broadcast {
|
||||
return &Broadcast{ctx, false}
|
||||
}
|
||||
|
||||
//User 发送的用户
|
||||
// User 发送的用户
|
||||
type User struct {
|
||||
TagID int64
|
||||
OpenID []string
|
||||
}
|
||||
|
||||
//Result 群发返回结果
|
||||
// Result 群发返回结果
|
||||
type Result struct {
|
||||
util.CommonError
|
||||
MsgID int64 `json:"msg_id"`
|
||||
@@ -60,34 +60,38 @@ type Result struct {
|
||||
MsgStatus string `json:"msg_status"`
|
||||
}
|
||||
|
||||
//SpeedResult 群发速度返回结果
|
||||
// SpeedResult 群发速度返回结果
|
||||
type SpeedResult struct {
|
||||
util.CommonError
|
||||
Speed int64 `json:"speed"`
|
||||
RealSpeed int64 `json:"realspeed"`
|
||||
}
|
||||
|
||||
//sendRequest 发送请求的数据
|
||||
// sendRequest 发送请求的数据
|
||||
type sendRequest struct {
|
||||
//根据tag获全部发送
|
||||
// 根据tag获全部发送
|
||||
Filter map[string]interface{} `json:"filter,omitempty"`
|
||||
//根据OpenID发送
|
||||
// 根据OpenID发送
|
||||
ToUser interface{} `json:"touser,omitempty"`
|
||||
//发送文本
|
||||
// 发送文本
|
||||
Text map[string]interface{} `json:"text,omitempty"`
|
||||
//发送图文消息
|
||||
// 发送图文消息
|
||||
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"`
|
||||
//发送卡券
|
||||
// 发送卡券
|
||||
WxCard map[string]interface{} `json:"wxcard,omitempty"`
|
||||
MsgType MsgType `json:"msgtype"`
|
||||
SendIgnoreReprint int32 `json:"send_ignore_reprint,omitempty"`
|
||||
}
|
||||
|
||||
//Image 发送图片
|
||||
// Image 发送图片
|
||||
type Image struct {
|
||||
MediaIDs []string `json:"media_ids"`
|
||||
Recommend string `json:"recommend"`
|
||||
@@ -95,10 +99,10 @@ type Image struct {
|
||||
OnlyFansCanComment int32 `json:"only_fans_can_comment"`
|
||||
}
|
||||
|
||||
//SendText 群发文本
|
||||
//user 为nil,表示全员发送
|
||||
//&User{TagID:2} 根据tag发送
|
||||
//&User{OpenID:[]string("xxx","xxx")} 根据openid发送
|
||||
// SendText 群发文本
|
||||
// user 为nil,表示全员发送
|
||||
// &User{TagID:2} 根据tag发送
|
||||
// &User{OpenID:[]string("xxx","xxx")} 根据openid发送
|
||||
func (broadcast *Broadcast) SendText(user *User, content string) (*Result, error) {
|
||||
ak, err := broadcast.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -122,7 +126,7 @@ func (broadcast *Broadcast) SendText(user *User, content string) (*Result, error
|
||||
return res, err
|
||||
}
|
||||
|
||||
//SendNews 发送图文
|
||||
// SendNews 发送图文
|
||||
func (broadcast *Broadcast) SendNews(user *User, mediaID string, ignoreReprint bool) (*Result, error) {
|
||||
ak, err := broadcast.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -149,7 +153,7 @@ func (broadcast *Broadcast) SendNews(user *User, mediaID string, ignoreReprint b
|
||||
return res, err
|
||||
}
|
||||
|
||||
//SendVoice 发送语音
|
||||
// SendVoice 发送语音
|
||||
func (broadcast *Broadcast) SendVoice(user *User, mediaID string) (*Result, error) {
|
||||
ak, err := broadcast.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -173,7 +177,7 @@ func (broadcast *Broadcast) SendVoice(user *User, mediaID string) (*Result, erro
|
||||
return res, err
|
||||
}
|
||||
|
||||
//SendImage 发送图片
|
||||
// SendImage 发送图片
|
||||
func (broadcast *Broadcast) SendImage(user *User, images *Image) (*Result, error) {
|
||||
ak, err := broadcast.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -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)
|
||||
@@ -195,7 +205,7 @@ func (broadcast *Broadcast) SendImage(user *User, images *Image) (*Result, error
|
||||
return res, err
|
||||
}
|
||||
|
||||
//SendVideo 发送视频
|
||||
// SendVideo 发送视频
|
||||
func (broadcast *Broadcast) SendVideo(user *User, mediaID string, title, description string) (*Result, error) {
|
||||
ak, err := broadcast.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -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,
|
||||
@@ -221,7 +231,7 @@ func (broadcast *Broadcast) SendVideo(user *User, mediaID string, title, descrip
|
||||
return res, err
|
||||
}
|
||||
|
||||
//SendWxCard 发送卡券
|
||||
// SendWxCard 发送卡券
|
||||
func (broadcast *Broadcast) SendWxCard(user *User, cardID string) (*Result, error) {
|
||||
ak, err := broadcast.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -245,7 +255,7 @@ func (broadcast *Broadcast) SendWxCard(user *User, cardID string) (*Result, erro
|
||||
return res, err
|
||||
}
|
||||
|
||||
//Delete 删除群发消息
|
||||
// Delete 删除群发消息
|
||||
func (broadcast *Broadcast) Delete(msgID int64, articleIDx int64) error {
|
||||
ak, err := broadcast.GetAccessToken()
|
||||
if err != nil {
|
||||
|
||||
@@ -4,11 +4,12 @@ import (
|
||||
"github.com/silenceper/wechat/v2/cache"
|
||||
)
|
||||
|
||||
// Config config for 微信公众号
|
||||
// Config .config for 微信公众号
|
||||
type Config struct {
|
||||
AppID string `json:"app_id"` //appid
|
||||
AppSecret string `json:"app_secret"` //appsecret
|
||||
Token string `json:"token"` //token
|
||||
EncodingAESKey string `json:"encoding_aes_key"` //EncodingAESKey
|
||||
AppID string `json:"app_id"` // appid
|
||||
AppSecret string `json:"app_secret"` // appsecret
|
||||
Token string `json:"token"` // token
|
||||
EncodingAESKey string `json:"encoding_aes_key"` // EncodingAESKey
|
||||
Cache cache.Cache
|
||||
UseStableAK bool // use the stable access_token
|
||||
}
|
||||
|
||||
245
officialaccount/customerservice/manager.go
Normal file
245
officialaccount/customerservice/manager.go
Normal file
@@ -0,0 +1,245 @@
|
||||
package customerservice
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/officialaccount/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
// TypingStatus 输入状态类型
|
||||
type TypingStatus string
|
||||
|
||||
const (
|
||||
customerServiceListURL = "https://api.weixin.qq.com/cgi-bin/customservice/getkflist"
|
||||
customerServiceOnlineListURL = "https://api.weixin.qq.com/cgi-bin/customservice/getonlinekflist"
|
||||
customerServiceAddURL = "https://api.weixin.qq.com/customservice/kfaccount/add"
|
||||
customerServiceUpdateURL = "https://api.weixin.qq.com/customservice/kfaccount/update"
|
||||
customerServiceDeleteURL = "https://api.weixin.qq.com/customservice/kfaccount/del"
|
||||
customerServiceInviteURL = "https://api.weixin.qq.com/customservice/kfaccount/inviteworker"
|
||||
customerServiceUploadHeadImg = "https://api.weixin.qq.com/customservice/kfaccount/uploadheadimg"
|
||||
customerServiceTypingURL = "https://api.weixin.qq.com/cgi-bin/message/custom/typing"
|
||||
)
|
||||
|
||||
const (
|
||||
// Typing 表示正在输入状态
|
||||
Typing TypingStatus = "Typing"
|
||||
// CancelTyping 表示取消正在输入状态
|
||||
CancelTyping TypingStatus = "CancelTyping"
|
||||
)
|
||||
|
||||
// Manager 客服管理者,可以管理客服
|
||||
type Manager struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewCustomerServiceManager 实例化客服管理
|
||||
func NewCustomerServiceManager(ctx *context.Context) *Manager {
|
||||
csm := new(Manager)
|
||||
csm.Context = ctx
|
||||
return csm
|
||||
}
|
||||
|
||||
// KeFuInfo 客服基本信息
|
||||
type KeFuInfo struct {
|
||||
KfAccount string `json:"kf_account"` // 完整客服帐号,格式为:帐号前缀@公众号微信号
|
||||
KfNick string `json:"kf_nick"` // 客服昵称
|
||||
KfID int `json:"kf_id"` // 客服编号
|
||||
KfHeadImgURL string `json:"kf_headimgurl"` // 客服头像
|
||||
KfWX string `json:"kf_wx"` // 如果客服帐号已绑定了客服人员微信号, 则此处显示微信号
|
||||
InviteWX string `json:"invite_wx"` // 如果客服帐号尚未绑定微信号,但是已经发起了一个绑定邀请, 则此处显示绑定邀请的微信号
|
||||
InviteExpTime int `json:"invite_expire_time"` // 如果客服帐号尚未绑定微信号,但是已经发起过一个绑定邀请, 邀请的过期时间,为unix 时间戳
|
||||
InviteStatus string `json:"invite_status"` // 邀请的状态,有等待确认“waiting”,被拒绝“rejected”, 过期“expired”
|
||||
}
|
||||
|
||||
type resKeFuList struct {
|
||||
util.CommonError
|
||||
KfList []*KeFuInfo `json:"kf_list"`
|
||||
}
|
||||
|
||||
// List 获取所有客服基本信息
|
||||
func (csm *Manager) List() (customerServiceList []*KeFuInfo, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = csm.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", customerServiceListURL, accessToken)
|
||||
var response []byte
|
||||
response, err = util.HTTPGet(uri)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
var res resKeFuList
|
||||
err = util.DecodeWithError(response, &res, "ListCustomerService")
|
||||
return res.KfList, err
|
||||
}
|
||||
|
||||
// KeFuOnlineInfo 客服在线信息
|
||||
type KeFuOnlineInfo struct {
|
||||
KfAccount string `json:"kf_account"`
|
||||
Status int `json:"status"`
|
||||
KfID int `json:"kf_id"`
|
||||
AcceptedCase int `json:"accepted_case"`
|
||||
}
|
||||
|
||||
type resKeFuOnlineList struct {
|
||||
util.CommonError
|
||||
KfOnlineList []*KeFuOnlineInfo `json:"kf_online_list"`
|
||||
}
|
||||
|
||||
// OnlineList 获取在线客服列表
|
||||
func (csm *Manager) OnlineList() (customerServiceOnlineList []*KeFuOnlineInfo, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = csm.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", customerServiceOnlineListURL, accessToken)
|
||||
var response []byte
|
||||
response, err = util.HTTPGet(uri)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
var res resKeFuOnlineList
|
||||
err = util.DecodeWithError(response, &res, "ListOnlineCustomerService")
|
||||
return res.KfOnlineList, err
|
||||
}
|
||||
|
||||
// Add 添加客服账号
|
||||
func (csm *Manager) Add(kfAccount, nickName string) (err error) {
|
||||
// kfAccount:完整客服帐号,格式为:帐号前缀@公众号微信号,帐号前缀最多10个字符,必须是英文、数字字符或者下划线,后缀为公众号微信号,长度不超过30个字符
|
||||
// nickName:客服昵称,最长16个字
|
||||
// 参数此处均不做校验
|
||||
var accessToken string
|
||||
accessToken, err = csm.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", customerServiceAddURL, accessToken)
|
||||
data := struct {
|
||||
KfAccount string `json:"kf_account"`
|
||||
NickName string `json:"nickname"`
|
||||
}{
|
||||
KfAccount: kfAccount,
|
||||
NickName: nickName,
|
||||
}
|
||||
var response []byte
|
||||
response, err = util.PostJSON(uri, data)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithCommonError(response, "AddCustomerService")
|
||||
return
|
||||
}
|
||||
|
||||
// Update 修改客服账号
|
||||
func (csm *Manager) Update(kfAccount, nickName string) (err error) {
|
||||
var accessToken string
|
||||
accessToken, err = csm.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", customerServiceUpdateURL, accessToken)
|
||||
data := struct {
|
||||
KfAccount string `json:"kf_account"`
|
||||
NickName string `json:"nickname"`
|
||||
}{
|
||||
KfAccount: kfAccount,
|
||||
NickName: nickName,
|
||||
}
|
||||
var response []byte
|
||||
response, err = util.PostJSON(uri, data)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithCommonError(response, "UpdateCustomerService")
|
||||
return
|
||||
}
|
||||
|
||||
// Delete 删除客服帐号
|
||||
func (csm *Manager) Delete(kfAccount string) (err error) {
|
||||
var accessToken string
|
||||
accessToken, err = csm.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", customerServiceDeleteURL, accessToken)
|
||||
data := struct {
|
||||
KfAccount string `json:"kf_account"`
|
||||
}{
|
||||
KfAccount: kfAccount,
|
||||
}
|
||||
var response []byte
|
||||
response, err = util.PostJSON(uri, data)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithCommonError(response, "DeleteCustomerService")
|
||||
return
|
||||
}
|
||||
|
||||
// InviteBind 邀请绑定客服帐号和微信号
|
||||
func (csm *Manager) InviteBind(kfAccount, inviteWX string) (err error) {
|
||||
var accessToken string
|
||||
accessToken, err = csm.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", customerServiceInviteURL, accessToken)
|
||||
data := struct {
|
||||
KfAccount string `json:"kf_account"`
|
||||
InviteWX string `json:"invite_wx"`
|
||||
}{
|
||||
KfAccount: kfAccount,
|
||||
InviteWX: inviteWX,
|
||||
}
|
||||
var response []byte
|
||||
response, err = util.PostJSON(uri, data)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithCommonError(response, "InviteBindCustomerService")
|
||||
return
|
||||
}
|
||||
|
||||
// UploadHeadImg 上传客服头像
|
||||
func (csm *Manager) UploadHeadImg(kfAccount, fileName string) (err error) {
|
||||
var accessToken string
|
||||
accessToken, err = csm.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s&kf_account=%s", customerServiceUploadHeadImg, accessToken, kfAccount)
|
||||
var response []byte
|
||||
response, err = util.PostFile("media", fileName, uri)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithCommonError(response, "UploadCustomerServiceHeadImg")
|
||||
return
|
||||
}
|
||||
|
||||
// SendTypingStatus 下发客服输入状态给用户
|
||||
func (csm *Manager) SendTypingStatus(openid string, cmd TypingStatus) (err error) {
|
||||
var accessToken string
|
||||
accessToken, err = csm.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
uri := fmt.Sprintf("%s?access_token=%s", customerServiceTypingURL, accessToken)
|
||||
data := struct {
|
||||
ToUser string `json:"touser"`
|
||||
Command string `json:"command"`
|
||||
}{
|
||||
ToUser: openid,
|
||||
Command: string(cmd),
|
||||
}
|
||||
var response []byte
|
||||
response, err = util.PostJSON(uri, data)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
err = util.DecodeWithCommonError(response, "SendTypingStatus")
|
||||
return
|
||||
}
|
||||
@@ -15,7 +15,7 @@ const (
|
||||
getUserShareHour = "https://api.weixin.qq.com/datacube/getusersharehour"
|
||||
)
|
||||
|
||||
//ResArticleSummary 获取图文群发每日数据响应
|
||||
// ResArticleSummary 获取图文群发每日数据响应
|
||||
type ResArticleSummary struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -34,7 +34,7 @@ type ResArticleSummary struct {
|
||||
} `json:"list"`
|
||||
}
|
||||
|
||||
//ResArticleTotal 获取图文群发总数据响应
|
||||
// ResArticleTotal 获取图文群发总数据响应
|
||||
type ResArticleTotal struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -46,7 +46,7 @@ type ResArticleTotal struct {
|
||||
} `json:"list"`
|
||||
}
|
||||
|
||||
//ArticleTotalDetails 获取图文群发总数据响应文字详情
|
||||
// ArticleTotalDetails 获取图文群发总数据响应文字详情
|
||||
type ArticleTotalDetails struct {
|
||||
StatDate string `json:"stat_date"`
|
||||
TargetUser int `json:"target_user"`
|
||||
@@ -76,7 +76,7 @@ type ArticleTotalDetails struct {
|
||||
FeedShareFromOtherCnt int `json:"feed_share_from_other_cnt"`
|
||||
}
|
||||
|
||||
//ResUserRead 获取图文统计数据响应
|
||||
// ResUserRead 获取图文统计数据响应
|
||||
type ResUserRead struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -94,7 +94,7 @@ type ResUserRead struct {
|
||||
} `json:"list"`
|
||||
}
|
||||
|
||||
//ResUserReadHour 获取图文统计分时数据
|
||||
// ResUserReadHour 获取图文统计分时数据
|
||||
type ResUserReadHour struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -113,7 +113,7 @@ type ResUserReadHour struct {
|
||||
} `json:"list"`
|
||||
}
|
||||
|
||||
//ResUserShare 获取图文分享转发数据
|
||||
// ResUserShare 获取图文分享转发数据
|
||||
type ResUserShare struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -125,7 +125,7 @@ type ResUserShare struct {
|
||||
} `json:"list"`
|
||||
}
|
||||
|
||||
//ResUserShareHour 获取图文分享转发分时数据
|
||||
// ResUserShareHour 获取图文分享转发分时数据
|
||||
type ResUserShareHour struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -138,7 +138,7 @@ type ResUserShareHour struct {
|
||||
} `json:"list"`
|
||||
}
|
||||
|
||||
//GetArticleSummary 获取图文群发每日数据
|
||||
// GetArticleSummary 获取图文群发每日数据
|
||||
func (cube *DataCube) GetArticleSummary(s string, e string) (resArticleSummary ResArticleSummary, err error) {
|
||||
accessToken, err := cube.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -160,7 +160,7 @@ func (cube *DataCube) GetArticleSummary(s string, e string) (resArticleSummary R
|
||||
return
|
||||
}
|
||||
|
||||
//GetArticleTotal 获取图文群发总数据
|
||||
// GetArticleTotal 获取图文群发总数据
|
||||
func (cube *DataCube) GetArticleTotal(s string, e string) (resArticleTotal ResArticleTotal, err error) {
|
||||
accessToken, err := cube.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -182,7 +182,7 @@ func (cube *DataCube) GetArticleTotal(s string, e string) (resArticleTotal ResAr
|
||||
return
|
||||
}
|
||||
|
||||
//GetUserRead 获取图文统计数据
|
||||
// GetUserRead 获取图文统计数据
|
||||
func (cube *DataCube) GetUserRead(s string, e string) (resUserRead ResUserRead, err error) {
|
||||
accessToken, err := cube.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -204,7 +204,7 @@ func (cube *DataCube) GetUserRead(s string, e string) (resUserRead ResUserRead,
|
||||
return
|
||||
}
|
||||
|
||||
//GetUserReadHour 获取图文统计分时数据
|
||||
// GetUserReadHour 获取图文统计分时数据
|
||||
func (cube *DataCube) GetUserReadHour(s string, e string) (resUserReadHour ResUserReadHour, err error) {
|
||||
accessToken, err := cube.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -226,7 +226,7 @@ func (cube *DataCube) GetUserReadHour(s string, e string) (resUserReadHour ResUs
|
||||
return
|
||||
}
|
||||
|
||||
//GetUserShare 获取图文分享转发数据
|
||||
// GetUserShare 获取图文分享转发数据
|
||||
func (cube *DataCube) GetUserShare(s string, e string) (resUserShare ResUserShare, err error) {
|
||||
accessToken, err := cube.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -248,7 +248,7 @@ func (cube *DataCube) GetUserShare(s string, e string) (resUserShare ResUserShar
|
||||
return
|
||||
}
|
||||
|
||||
//GetUserShareHour 获取图文分享转发分时数据
|
||||
// GetUserShareHour 获取图文分享转发分时数据
|
||||
func (cube *DataCube) GetUserShareHour(s string, e string) (resUserShareHour ResUserShareHour, err error) {
|
||||
accessToken, err := cube.GetAccessToken()
|
||||
if err != nil {
|
||||
|
||||
@@ -9,12 +9,12 @@ type reqDate struct {
|
||||
EndDate string `json:"end_date"`
|
||||
}
|
||||
|
||||
//DataCube 数据统计
|
||||
// DataCube 数据统计
|
||||
type DataCube struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
//NewCube 数据统计
|
||||
// NewCube 数据统计
|
||||
func NewCube(context *context.Context) *DataCube {
|
||||
dataCube := new(DataCube)
|
||||
dataCube.Context = context
|
||||
|
||||
@@ -11,7 +11,7 @@ const (
|
||||
getInterfaceSummaryHour = "https://api.weixin.qq.com/datacube/getinterfacesummaryhour"
|
||||
)
|
||||
|
||||
//ResInterfaceSummary 接口分析数据响应
|
||||
// ResInterfaceSummary 接口分析数据响应
|
||||
type ResInterfaceSummary struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -24,7 +24,7 @@ type ResInterfaceSummary struct {
|
||||
} `json:"list"`
|
||||
}
|
||||
|
||||
//ResInterfaceSummaryHour 接口分析分时数据响应
|
||||
// ResInterfaceSummaryHour 接口分析分时数据响应
|
||||
type ResInterfaceSummaryHour struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -38,7 +38,7 @@ type ResInterfaceSummaryHour struct {
|
||||
} `json:"list"`
|
||||
}
|
||||
|
||||
//GetInterfaceSummary 获取接口分析数据
|
||||
// GetInterfaceSummary 获取接口分析数据
|
||||
func (cube *DataCube) GetInterfaceSummary(s string, e string) (resInterfaceSummary ResInterfaceSummary, err error) {
|
||||
accessToken, err := cube.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -60,7 +60,7 @@ func (cube *DataCube) GetInterfaceSummary(s string, e string) (resInterfaceSumma
|
||||
return
|
||||
}
|
||||
|
||||
//GetInterfaceSummaryHour 获取接口分析分时数据
|
||||
// GetInterfaceSummaryHour 获取接口分析分时数据
|
||||
func (cube *DataCube) GetInterfaceSummaryHour(s string, e string) (resInterfaceSummaryHour ResInterfaceSummaryHour, err error) {
|
||||
accessToken, err := cube.GetAccessToken()
|
||||
if err != nil {
|
||||
|
||||
@@ -16,7 +16,7 @@ const (
|
||||
getUpstreamMsgDistMonth = "https://api.weixin.qq.com/datacube/getupstreammsgdistmonth"
|
||||
)
|
||||
|
||||
//ResUpstreamMsg 获取消息发送概况数据响应
|
||||
// ResUpstreamMsg 获取消息发送概况数据响应
|
||||
type ResUpstreamMsg struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -28,7 +28,7 @@ type ResUpstreamMsg struct {
|
||||
} `json:"list"`
|
||||
}
|
||||
|
||||
//ResUpstreamMsgHour 获取消息分送分时数据响应
|
||||
// ResUpstreamMsgHour 获取消息分送分时数据响应
|
||||
type ResUpstreamMsgHour struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -41,7 +41,7 @@ type ResUpstreamMsgHour struct {
|
||||
} `json:"list"`
|
||||
}
|
||||
|
||||
//ResUpstreamMsgWeek 获取消息发送周数据响应
|
||||
// ResUpstreamMsgWeek 获取消息发送周数据响应
|
||||
type ResUpstreamMsgWeek struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -53,7 +53,7 @@ type ResUpstreamMsgWeek struct {
|
||||
} `json:"list"`
|
||||
}
|
||||
|
||||
//ResUpstreamMsgMonth 获取消息发送月数据响应
|
||||
// ResUpstreamMsgMonth 获取消息发送月数据响应
|
||||
type ResUpstreamMsgMonth struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -65,7 +65,7 @@ type ResUpstreamMsgMonth struct {
|
||||
} `json:"list"`
|
||||
}
|
||||
|
||||
//ResUpstreamMsgDist 获取消息发送分布数据响应
|
||||
// ResUpstreamMsgDist 获取消息发送分布数据响应
|
||||
type ResUpstreamMsgDist struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -76,7 +76,7 @@ type ResUpstreamMsgDist struct {
|
||||
} `json:"list"`
|
||||
}
|
||||
|
||||
//ResUpstreamMsgDistWeek 获取消息发送分布周数据响应
|
||||
// ResUpstreamMsgDistWeek 获取消息发送分布周数据响应
|
||||
type ResUpstreamMsgDistWeek struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -87,7 +87,7 @@ type ResUpstreamMsgDistWeek struct {
|
||||
} `json:"list"`
|
||||
}
|
||||
|
||||
//ResUpstreamMsgDistMonth 获取消息发送分布月数据响应
|
||||
// ResUpstreamMsgDistMonth 获取消息发送分布月数据响应
|
||||
type ResUpstreamMsgDistMonth struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -98,7 +98,7 @@ type ResUpstreamMsgDistMonth struct {
|
||||
} `json:"list"`
|
||||
}
|
||||
|
||||
//GetUpstreamMsg 获取消息发送概况数据
|
||||
// GetUpstreamMsg 获取消息发送概况数据
|
||||
func (cube *DataCube) GetUpstreamMsg(s string, e string) (resUpstreamMsg ResUpstreamMsg, err error) {
|
||||
accessToken, err := cube.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -120,7 +120,7 @@ func (cube *DataCube) GetUpstreamMsg(s string, e string) (resUpstreamMsg ResUpst
|
||||
return
|
||||
}
|
||||
|
||||
//GetUpstreamMsgHour 获取消息分送分时数据
|
||||
// GetUpstreamMsgHour 获取消息分送分时数据
|
||||
func (cube *DataCube) GetUpstreamMsgHour(s string, e string) (resUpstreamMsgHour ResUpstreamMsgHour, err error) {
|
||||
accessToken, err := cube.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -142,7 +142,7 @@ func (cube *DataCube) GetUpstreamMsgHour(s string, e string) (resUpstreamMsgHour
|
||||
return
|
||||
}
|
||||
|
||||
//GetUpstreamMsgWeek 获取消息发送周数据
|
||||
// GetUpstreamMsgWeek 获取消息发送周数据
|
||||
func (cube *DataCube) GetUpstreamMsgWeek(s string, e string) (resUpstreamMsgWeek ResUpstreamMsgWeek, err error) {
|
||||
accessToken, err := cube.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -164,7 +164,7 @@ func (cube *DataCube) GetUpstreamMsgWeek(s string, e string) (resUpstreamMsgWeek
|
||||
return
|
||||
}
|
||||
|
||||
//GetUpstreamMsgMonth 获取消息发送月数据
|
||||
// GetUpstreamMsgMonth 获取消息发送月数据
|
||||
func (cube *DataCube) GetUpstreamMsgMonth(s string, e string) (resUpstreamMsgMonth ResUpstreamMsgMonth, err error) {
|
||||
accessToken, err := cube.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -186,7 +186,7 @@ func (cube *DataCube) GetUpstreamMsgMonth(s string, e string) (resUpstreamMsgMon
|
||||
return
|
||||
}
|
||||
|
||||
//GetUpstreamMsgDist 获取消息发送分布数据
|
||||
// GetUpstreamMsgDist 获取消息发送分布数据
|
||||
func (cube *DataCube) GetUpstreamMsgDist(s string, e string) (resUpstreamMsgDist ResUpstreamMsgDist, err error) {
|
||||
accessToken, err := cube.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -208,7 +208,7 @@ func (cube *DataCube) GetUpstreamMsgDist(s string, e string) (resUpstreamMsgDist
|
||||
return
|
||||
}
|
||||
|
||||
//GetUpstreamMsgDistWeek 获取消息发送分布周数据
|
||||
// GetUpstreamMsgDistWeek 获取消息发送分布周数据
|
||||
func (cube *DataCube) GetUpstreamMsgDistWeek(s string, e string) (resUpstreamMsgDistWeek ResUpstreamMsgDistWeek, err error) {
|
||||
accessToken, err := cube.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -230,7 +230,7 @@ func (cube *DataCube) GetUpstreamMsgDistWeek(s string, e string) (resUpstreamMsg
|
||||
return
|
||||
}
|
||||
|
||||
//GetUpstreamMsgDistMonth 获取消息发送分布月数据
|
||||
// GetUpstreamMsgDistMonth 获取消息发送分布月数据
|
||||
func (cube *DataCube) GetUpstreamMsgDistMonth(s string, e string) (resUpstreamMsgDistMonth ResUpstreamMsgDistMonth, err error) {
|
||||
accessToken, err := cube.GetAccessToken()
|
||||
if err != nil {
|
||||
|
||||
@@ -8,31 +8,31 @@ import (
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
//AdSlot 广告位类型
|
||||
// AdSlot 广告位类型
|
||||
type AdSlot string
|
||||
|
||||
const (
|
||||
//SlotIDBizBottom 公众号底部广告
|
||||
// SlotIDBizBottom 公众号底部广告
|
||||
SlotIDBizBottom AdSlot = "SLOT_ID_BIZ_BOTTOM"
|
||||
//SlotIDBizMidContext 公众号文中广告
|
||||
// SlotIDBizMidContext 公众号文中广告
|
||||
SlotIDBizMidContext AdSlot = "SLOT_ID_BIZ_MID_CONTEXT"
|
||||
//SlotIDBizVideoEnd 公众号视频后贴
|
||||
// SlotIDBizVideoEnd 公众号视频后贴
|
||||
SlotIDBizVideoEnd AdSlot = "SLOT_ID_BIZ_VIDEO_END"
|
||||
//SlotIDBizSponsor 公众号互选广告
|
||||
// SlotIDBizSponsor 公众号互选广告
|
||||
SlotIDBizSponsor AdSlot = "SLOT_ID_BIZ_SPONSOR"
|
||||
//SlotIDBizCps 公众号返佣商品
|
||||
// SlotIDBizCps 公众号返佣商品
|
||||
SlotIDBizCps AdSlot = "SLOT_ID_BIZ_CPS"
|
||||
//SlotIDWeappBanner 小程序banner
|
||||
// SlotIDWeappBanner 小程序banner
|
||||
SlotIDWeappBanner AdSlot = "SLOT_ID_WEAPP_BANNER"
|
||||
//SlotIDWeappRewardVideo 小程序激励视频
|
||||
// SlotIDWeappRewardVideo 小程序激励视频
|
||||
SlotIDWeappRewardVideo AdSlot = "SLOT_ID_WEAPP_REWARD_VIDEO"
|
||||
//SlotIDWeappInterstitial 小程序插屏广告
|
||||
// SlotIDWeappInterstitial 小程序插屏广告
|
||||
SlotIDWeappInterstitial AdSlot = "SLOT_ID_WEAPP_INTERSTITIAL"
|
||||
//SlotIDWeappVideoFeeds 小程序视频广告
|
||||
// SlotIDWeappVideoFeeds 小程序视频广告
|
||||
SlotIDWeappVideoFeeds AdSlot = "SLOT_ID_WEAPP_VIDEO_FEEDS"
|
||||
//SlotIDWeappVideoBegin 小程序视频前贴
|
||||
// SlotIDWeappVideoBegin 小程序视频前贴
|
||||
SlotIDWeappVideoBegin AdSlot = "SLOT_ID_WEAPP_VIDEO_BEGIN"
|
||||
//SlotIDWeappBox 小程序格子广告
|
||||
// SlotIDWeappBox 小程序格子广告
|
||||
SlotIDWeappBox AdSlot = "SLOT_ID_WEAPP_BOX"
|
||||
)
|
||||
|
||||
@@ -46,13 +46,13 @@ const (
|
||||
actionPublisherSettlement = "publisher_settlement"
|
||||
)
|
||||
|
||||
//BaseResp 错误信息
|
||||
// BaseResp 错误信息
|
||||
type BaseResp struct {
|
||||
ErrMsg string `json:"err_msg"`
|
||||
Ret int `json:"ret"`
|
||||
}
|
||||
|
||||
//ResPublisherAdPos 公众号分广告位数据响应
|
||||
// ResPublisherAdPos 公众号分广告位数据响应
|
||||
type ResPublisherAdPos struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -62,7 +62,7 @@ type ResPublisherAdPos struct {
|
||||
TotalNum int `json:"total_num"`
|
||||
}
|
||||
|
||||
//ResAdPosList 公众号分广告位列表
|
||||
// ResAdPosList 公众号分广告位列表
|
||||
type ResAdPosList struct {
|
||||
SlotID int64 `json:"slot_id"`
|
||||
AdSlot string `json:"ad_slot"`
|
||||
@@ -76,7 +76,7 @@ type ResAdPosList struct {
|
||||
Ecpm float64 `json:"ecpm"`
|
||||
}
|
||||
|
||||
//ResAdPosSummary 公众号分广告位概览
|
||||
// ResAdPosSummary 公众号分广告位概览
|
||||
type ResAdPosSummary struct {
|
||||
ReqSuccCount int `json:"req_succ_count"`
|
||||
ExposureCount int `json:"exposure_count"`
|
||||
@@ -87,7 +87,7 @@ type ResAdPosSummary struct {
|
||||
Ecpm float64 `json:"ecpm"`
|
||||
}
|
||||
|
||||
//ResPublisherCps 公众号返佣商品数据响应
|
||||
// ResPublisherCps 公众号返佣商品数据响应
|
||||
type ResPublisherCps struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -97,7 +97,7 @@ type ResPublisherCps struct {
|
||||
TotalNum int `json:"total_num"`
|
||||
}
|
||||
|
||||
//ResCpsList 公众号返佣商品列表
|
||||
// ResCpsList 公众号返佣商品列表
|
||||
type ResCpsList struct {
|
||||
Date string `json:"date"`
|
||||
ExposureCount int `json:"exposure_count"`
|
||||
@@ -109,7 +109,7 @@ type ResCpsList struct {
|
||||
TotalCommission int `json:"total_commission"`
|
||||
}
|
||||
|
||||
//ResCpsSummary 公众号返佣概览
|
||||
// ResCpsSummary 公众号返佣概览
|
||||
type ResCpsSummary struct {
|
||||
ExposureCount int `json:"exposure_count"`
|
||||
ClickCount int `json:"click_count"`
|
||||
@@ -120,7 +120,7 @@ type ResCpsSummary struct {
|
||||
TotalCommission int `json:"total_commission"`
|
||||
}
|
||||
|
||||
//ResPublisherSettlement 公众号结算收入数据及结算主体信息响应
|
||||
// ResPublisherSettlement 公众号结算收入数据及结算主体信息响应
|
||||
type ResPublisherSettlement struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -133,7 +133,7 @@ type ResPublisherSettlement struct {
|
||||
TotalNum int `json:"total_num"`
|
||||
}
|
||||
|
||||
//SettlementList 结算单列表
|
||||
// SettlementList 结算单列表
|
||||
type SettlementList struct {
|
||||
Date string `json:"date"`
|
||||
Zone string `json:"zone"`
|
||||
@@ -146,13 +146,13 @@ type SettlementList struct {
|
||||
SlotRevenue []SlotRevenue `json:"slot_revenue"`
|
||||
}
|
||||
|
||||
//SlotRevenue 产生收入的广告
|
||||
// SlotRevenue 产生收入的广告
|
||||
type SlotRevenue struct {
|
||||
SlotID string `json:"slot_id"`
|
||||
SlotSettledRevenue int `json:"slot_settled_revenue"`
|
||||
}
|
||||
|
||||
//ParamsPublisher 拉取数据参数
|
||||
// ParamsPublisher 拉取数据参数
|
||||
type ParamsPublisher struct {
|
||||
Action string `json:"action"`
|
||||
StartDate string `json:"start_date"`
|
||||
@@ -183,13 +183,10 @@ 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
|
||||
}
|
||||
|
||||
//GetPublisherAdPosGeneral 获取公众号分广告位数据
|
||||
// GetPublisherAdPosGeneral 获取公众号分广告位数据
|
||||
func (cube *DataCube) GetPublisherAdPosGeneral(startDate, endDate string, page, pageSize int, adSlot AdSlot) (resPublisherAdPos ResPublisherAdPos, err error) {
|
||||
params := ParamsPublisher{
|
||||
Action: actionPublisherAdPosGeneral,
|
||||
@@ -217,7 +214,7 @@ func (cube *DataCube) GetPublisherAdPosGeneral(startDate, endDate string, page,
|
||||
return
|
||||
}
|
||||
|
||||
//GetPublisherCpsGeneral 获取公众号返佣商品数据
|
||||
// GetPublisherCpsGeneral 获取公众号返佣商品数据
|
||||
func (cube *DataCube) GetPublisherCpsGeneral(startDate, endDate string, page, pageSize int) (resPublisherCps ResPublisherCps, err error) {
|
||||
params := ParamsPublisher{
|
||||
Action: actionPublisherCpsGeneral,
|
||||
@@ -244,7 +241,7 @@ func (cube *DataCube) GetPublisherCpsGeneral(startDate, endDate string, page, pa
|
||||
return
|
||||
}
|
||||
|
||||
//GetPublisherSettlement 获取公众号结算收入数据及结算主体信息
|
||||
// GetPublisherSettlement 获取公众号结算收入数据及结算主体信息
|
||||
func (cube *DataCube) GetPublisherSettlement(startDate, endDate string, page, pageSize int) (resPublisherSettlement ResPublisherSettlement, err error) {
|
||||
params := ParamsPublisher{
|
||||
Action: actionPublisherSettlement,
|
||||
|
||||
@@ -11,7 +11,7 @@ const (
|
||||
getUserAccumulate = "https://api.weixin.qq.com/datacube/getusercumulate"
|
||||
)
|
||||
|
||||
//ResUserSummary 获取用户增减数据响应
|
||||
// ResUserSummary 获取用户增减数据响应
|
||||
type ResUserSummary struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -23,7 +23,7 @@ type ResUserSummary struct {
|
||||
} `json:"list"`
|
||||
}
|
||||
|
||||
//ResUserAccumulate 获取累计用户数据响应
|
||||
// ResUserAccumulate 获取累计用户数据响应
|
||||
type ResUserAccumulate struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -33,7 +33,7 @@ type ResUserAccumulate struct {
|
||||
} `json:"list"`
|
||||
}
|
||||
|
||||
//GetUserSummary 获取用户增减数据
|
||||
// GetUserSummary 获取用户增减数据
|
||||
func (cube *DataCube) GetUserSummary(s string, e string) (resUserSummary ResUserSummary, err error) {
|
||||
accessToken, err := cube.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -55,7 +55,7 @@ func (cube *DataCube) GetUserSummary(s string, e string) (resUserSummary ResUser
|
||||
return
|
||||
}
|
||||
|
||||
//GetUserAccumulate 获取累计用户数据
|
||||
// GetUserAccumulate 获取累计用户数据
|
||||
func (cube *DataCube) GetUserAccumulate(s string, e string) (resUserAccumulate ResUserAccumulate, err error) {
|
||||
accessToken, err := cube.GetAccessToken()
|
||||
if err != nil {
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
//Package device 设备相关接口
|
||||
// Package device 设备相关接口
|
||||
package device
|
||||
|
||||
import (
|
||||
@@ -23,13 +23,13 @@ type reqDeviceAuthorize struct {
|
||||
// 请求操作的类型,限定取值为:0:设备授权(缺省值为0) 1:设备更新(更新已授权设备的各属性值)
|
||||
OpType string `json:"op_type,omitempty"`
|
||||
// 设备的产品编号(由微信硬件平台分配)。可在公众号设备功能管理页面查询。
|
||||
//当 op_type 为‘0’,product_id 为‘1’时,不要填写 product_id 字段(会引起不必要错误);
|
||||
//当 op_typy 为‘0’,product_id 不为‘1’时,必须填写 product_id 字段;
|
||||
//当 op_type 为 1 时,不要填写 product_id 字段。
|
||||
// 当 op_type 为‘0’,product_id 为‘1’时,不要填写 product_id 字段(会引起不必要错误);
|
||||
// 当 op_typy 为‘0’,product_id 不为‘1’时,必须填写 product_id 字段;
|
||||
// 当 op_type 为 1 时,不要填写 product_id 字段。
|
||||
ProductID string `json:"product_id,omitempty"`
|
||||
}
|
||||
|
||||
//ReqDevice 设备授权实体
|
||||
// ReqDevice 设备授权实体
|
||||
type ReqDevice struct {
|
||||
// 设备的 device id
|
||||
ID string `json:"id"`
|
||||
@@ -45,13 +45,13 @@ type ReqDevice struct {
|
||||
// 1:表示设备仅支持andiod classic bluetooth 1|2:表示设备支持android 和ios 两种classic bluetooth,但是客户端优先选择android classic bluetooth 协议,如果android classic bluetooth协议连接失败,再选择ios classic bluetooth协议进行连接
|
||||
// (注:安卓平台不同时支持BLE和classic类型)
|
||||
ConnectProtocol string `json:"connect_protocol"`
|
||||
//auth及通信的加密key,第三方需要将key烧制在设备上(128bit),格式采用16进制串的方式(长度为32字节),不需要0X前缀,如: 1234567890ABCDEF1234567890ABCDEF
|
||||
// auth及通信的加密key,第三方需要将key烧制在设备上(128bit),格式采用16进制串的方式(长度为32字节),不需要0X前缀,如: 1234567890ABCDEF1234567890ABCDEF
|
||||
AuthKey string `json:"auth_key"`
|
||||
// 断开策略,目前支持: 1:退出公众号页面时即断开连接 2:退出公众号之后保持连接不断开
|
||||
CloseStrategy string `json:"close_strategy"`
|
||||
//连接策略,32位整型,按bit位置位,目前仅第1bit和第3bit位有效(bit置0为无效,1为有效;第2bit已被废弃),且bit位可以按或置位(如1|4=5),各bit置位含义说明如下:
|
||||
//1:(第1bit置位)在公众号对话页面,不停的尝试连接设备
|
||||
//4:(第3bit置位)处于非公众号页面(如主界面等),微信自动连接。当用户切换微信到前台时,可能尝试去连接设备,连上后一定时间会断开
|
||||
// 连接策略,32位整型,按bit位置位,目前仅第1bit和第3bit位有效(bit置0为无效,1为有效;第2bit已被废弃),且bit位可以按或置位(如1|4=5),各bit置位含义说明如下:
|
||||
// 1:(第1bit置位)在公众号对话页面,不停的尝试连接设备
|
||||
// 4:(第3bit置位)处于非公众号页面(如主界面等),微信自动连接。当用户切换微信到前台时,可能尝试去连接设备,连上后一定时间会断开
|
||||
ConnStrategy string `json:"conn_strategy"`
|
||||
// auth version,设备和微信进行auth时,会根据该版本号来确认auth buf和auth key的格式(各version对应的auth buf及key的具体格式可以参看“客户端蓝牙外设协议”),该字段目前支持取值:
|
||||
// 0:不加密的version
|
||||
@@ -69,7 +69,7 @@ type ReqDevice struct {
|
||||
BleSimpleProtocol string `json:"ble_simple_protocol,omitempty"`
|
||||
}
|
||||
|
||||
//ResBaseInfo 授权回调实体
|
||||
// ResBaseInfo 授权回调实体
|
||||
type ResBaseInfo struct {
|
||||
BaseInfo struct {
|
||||
DeviceType string `json:"device_type"`
|
||||
|
||||
@@ -19,12 +19,12 @@ const (
|
||||
uriState = "https://api.weixin.qq.com/device/get_stat"
|
||||
)
|
||||
|
||||
//Device struct
|
||||
// Device struct
|
||||
type Device struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
//NewDevice 实例
|
||||
// NewDevice 实例
|
||||
func NewDevice(context *context.Context) *Device {
|
||||
device := new(Device)
|
||||
device.Context = context
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
package device
|
||||
|
||||
//MsgDevice 设备消息响应
|
||||
// MsgDevice 设备消息响应
|
||||
type MsgDevice struct {
|
||||
DeviceType string
|
||||
DeviceID string
|
||||
|
||||
@@ -7,7 +7,7 @@ import (
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
//ResCreateQRCode 获取二维码的返回实体
|
||||
// ResCreateQRCode 获取二维码的返回实体
|
||||
type ResCreateQRCode struct {
|
||||
util.CommonError
|
||||
DeviceNum int `json:"device_num"`
|
||||
@@ -42,7 +42,7 @@ func (d *Device) CreateQRCode(devices []string) (res ResCreateQRCode, err error)
|
||||
return
|
||||
}
|
||||
|
||||
//ResVerifyQRCode 验证授权结果实体
|
||||
// ResVerifyQRCode 验证授权结果实体
|
||||
type ResVerifyQRCode struct {
|
||||
util.CommonError
|
||||
DeviceType string `json:"device_type"`
|
||||
|
||||
214
officialaccount/draft/draft.go
Normal file
214
officialaccount/draft/draft.go
Normal file
@@ -0,0 +1,214 @@
|
||||
package draft
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/officialaccount/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
addURL = "https://api.weixin.qq.com/cgi-bin/draft/add" // 新建草稿
|
||||
getURL = "https://api.weixin.qq.com/cgi-bin/draft/get" // 获取草稿
|
||||
deleteURL = "https://api.weixin.qq.com/cgi-bin/draft/delete" // 删除草稿
|
||||
updateURL = "https://api.weixin.qq.com/cgi-bin/draft/update" // 修改草稿
|
||||
countURL = "https://api.weixin.qq.com/cgi-bin/draft/count" // 获取草稿总数
|
||||
paginateURL = "https://api.weixin.qq.com/cgi-bin/draft/batchget" // 获取草稿列表
|
||||
)
|
||||
|
||||
// Draft 草稿箱
|
||||
type Draft struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewDraft init
|
||||
func NewDraft(ctx *context.Context) *Draft {
|
||||
return &Draft{
|
||||
Context: ctx,
|
||||
}
|
||||
}
|
||||
|
||||
// Article 草稿
|
||||
type Article struct {
|
||||
Title string `json:"title"` // 标题
|
||||
Author string `json:"author"` // 作者
|
||||
Digest string `json:"digest"` // 图文消息的摘要,仅有单图文消息才有摘要,多图文此处为空。
|
||||
Content string `json:"content"` // 图文消息的具体内容,支持HTML标签,必须少于2万字符,小于1M,且去除JS
|
||||
ContentSourceURL string `json:"content_source_url"` // 图文消息的原文地址,即点击“阅读原文”后的URL
|
||||
ThumbMediaID string `json:"thumb_media_id"` // 图文消息的封面图片素材id(必须是永久MediaID)
|
||||
ShowCoverPic uint `json:"show_cover_pic"` // 是否显示封面,0为false,即不显示,1为true,即显示(默认)
|
||||
NeedOpenComment uint `json:"need_open_comment"` // 是否打开评论,0不打开(默认),1打开
|
||||
OnlyFansCanComment uint `json:"only_fans_can_comment"` // 是否粉丝才可评论,0所有人可评论(默认),1粉丝才可评论
|
||||
}
|
||||
|
||||
// AddDraft 新建草稿
|
||||
func (draft *Draft) AddDraft(articles []*Article) (mediaID string, err error) {
|
||||
accessToken, err := draft.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var req struct {
|
||||
Articles []*Article `json:"articles"`
|
||||
}
|
||||
req.Articles = articles
|
||||
|
||||
uri := fmt.Sprintf("%s?access_token=%s", addURL, accessToken)
|
||||
response, err := util.PostJSON(uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var res struct {
|
||||
util.CommonError
|
||||
MediaID string `json:"media_id"`
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "AddDraft")
|
||||
return res.MediaID, err
|
||||
}
|
||||
|
||||
// GetDraft 获取草稿
|
||||
func (draft *Draft) GetDraft(mediaID string) (articles []*Article, err error) {
|
||||
accessToken, err := draft.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var req struct {
|
||||
MediaID string `json:"media_id"`
|
||||
}
|
||||
req.MediaID = mediaID
|
||||
|
||||
uri := fmt.Sprintf("%s?access_token=%s", getURL, accessToken)
|
||||
response, err := util.PostJSON(uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var res struct {
|
||||
util.CommonError
|
||||
NewsItem []*Article `json:"news_item"`
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "GetDraft")
|
||||
return res.NewsItem, err
|
||||
}
|
||||
|
||||
// DeleteDraft 删除草稿
|
||||
func (draft *Draft) DeleteDraft(mediaID string) (err error) {
|
||||
accessToken, err := draft.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var req struct {
|
||||
MediaID string `json:"media_id"`
|
||||
}
|
||||
req.MediaID = mediaID
|
||||
|
||||
var response []byte
|
||||
uri := fmt.Sprintf("%s?access_token=%s", deleteURL, accessToken)
|
||||
response, err = util.PostJSON(uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithCommonError(response, "DeleteDraft")
|
||||
return
|
||||
}
|
||||
|
||||
// UpdateDraft 修改草稿
|
||||
// index 要更新的文章在图文消息中的位置(多图文消息时,此字段才有意义),第一篇为0
|
||||
func (draft *Draft) UpdateDraft(article *Article, mediaID string, index uint) (err error) {
|
||||
accessToken, err := draft.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var req struct {
|
||||
MediaID string `json:"media_id"`
|
||||
Index uint `json:"index"`
|
||||
Article *Article `json:"articles"`
|
||||
}
|
||||
req.MediaID = mediaID
|
||||
req.Index = index
|
||||
req.Article = article
|
||||
|
||||
uri := fmt.Sprintf("%s?access_token=%s", updateURL, accessToken)
|
||||
var response []byte
|
||||
response, err = util.PostJSON(uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithCommonError(response, "UpdateDraft")
|
||||
return
|
||||
}
|
||||
|
||||
// CountDraft 获取草稿总数
|
||||
func (draft *Draft) CountDraft() (total uint, err error) {
|
||||
accessToken, err := draft.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var response []byte
|
||||
uri := fmt.Sprintf("%s?access_token=%s", countURL, accessToken)
|
||||
response, err = util.HTTPGet(uri)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var res struct {
|
||||
util.CommonError
|
||||
Total uint `json:"total_count"`
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "CountDraft")
|
||||
return res.Total, err
|
||||
}
|
||||
|
||||
// ArticleList 草稿列表
|
||||
type ArticleList struct {
|
||||
util.CommonError
|
||||
TotalCount int64 `json:"total_count"` // 草稿素材的总数
|
||||
ItemCount int64 `json:"item_count"` // 本次调用获取的素材的数量
|
||||
Item []ArticleListItem `json:"item"`
|
||||
}
|
||||
|
||||
// ArticleListItem 用于 ArticleList 的 item 节点
|
||||
type ArticleListItem struct {
|
||||
MediaID string `json:"media_id"` // 图文消息的id
|
||||
Content ArticleListContent `json:"content"` // 内容
|
||||
UpdateTime int64 `json:"update_time"` // 这篇图文消息素材的最后更新时间
|
||||
}
|
||||
|
||||
// ArticleListContent 用于 ArticleListItem 的 content 节点
|
||||
type ArticleListContent struct {
|
||||
NewsItem []Article `json:"news_item"` // 这篇图文消息素材的内容
|
||||
}
|
||||
|
||||
// PaginateDraft 获取草稿列表
|
||||
func (draft *Draft) PaginateDraft(offset, count int64, noReturnContent bool) (list ArticleList, err error) {
|
||||
accessToken, err := draft.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var req struct {
|
||||
Count int64 `json:"count"`
|
||||
Offset int64 `json:"offset"`
|
||||
NoReturnContent bool `json:"no_content"`
|
||||
}
|
||||
req.Count = count
|
||||
req.Offset = offset
|
||||
req.NoReturnContent = noReturnContent
|
||||
|
||||
var response []byte
|
||||
uri := fmt.Sprintf("%s?access_token=%s", paginateURL, accessToken)
|
||||
response, err = util.PostJSON(uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &list, "PaginateDraft")
|
||||
return
|
||||
}
|
||||
238
officialaccount/freepublish/freepublish.go
Normal file
238
officialaccount/freepublish/freepublish.go
Normal file
@@ -0,0 +1,238 @@
|
||||
package freepublish
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/officialaccount/context"
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
const (
|
||||
publishURL = "https://api.weixin.qq.com/cgi-bin/freepublish/submit" // 发布接口
|
||||
selectStateURL = "https://api.weixin.qq.com/cgi-bin/freepublish/get" // 发布状态轮询接口
|
||||
deleteURL = "https://api.weixin.qq.com/cgi-bin/freepublish/delete" // 删除发布
|
||||
firstArticleURL = "https://api.weixin.qq.com/cgi-bin/freepublish/getarticle" // 通过 article_id 获取已发布文章
|
||||
paginateURL = "https://api.weixin.qq.com/cgi-bin/freepublish/batchget" // 获取成功发布列表
|
||||
)
|
||||
|
||||
// PublishStatus 发布状态
|
||||
type PublishStatus uint
|
||||
|
||||
const (
|
||||
// PublishStatusSuccess 0:成功
|
||||
PublishStatusSuccess PublishStatus = iota
|
||||
// PublishStatusPublishing 1:发布中
|
||||
PublishStatusPublishing
|
||||
// PublishStatusOriginalFail 2:原创失败
|
||||
PublishStatusOriginalFail
|
||||
// PublishStatusFail 3:常规失败
|
||||
PublishStatusFail
|
||||
// PublishStatusAuditRefused 4:平台审核不通过
|
||||
PublishStatusAuditRefused
|
||||
// PublishStatusUserDeleted 5:成功后用户删除所有文章
|
||||
PublishStatusUserDeleted
|
||||
// PublishStatusSystemBanned 6:成功后系统封禁所有文章
|
||||
PublishStatusSystemBanned
|
||||
)
|
||||
|
||||
// FreePublish 发布能力
|
||||
type FreePublish struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
// NewFreePublish init
|
||||
func NewFreePublish(ctx *context.Context) *FreePublish {
|
||||
return &FreePublish{
|
||||
Context: ctx,
|
||||
}
|
||||
}
|
||||
|
||||
// Publish 发布接口。需要先将图文素材以草稿的形式保存(见“草稿箱/新建草稿”,
|
||||
// 如需从已保存的草稿中选择,见“草稿箱/获取草稿列表”),选择要发布的草稿 media_id 进行发布
|
||||
func (freePublish *FreePublish) Publish(mediaID string) (publishID int64, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = freePublish.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var req struct {
|
||||
MediaID string `json:"media_id"`
|
||||
}
|
||||
req.MediaID = mediaID
|
||||
|
||||
var response []byte
|
||||
uri := fmt.Sprintf("%s?access_token=%s", publishURL, accessToken)
|
||||
response, err = util.PostJSON(uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var res struct {
|
||||
util.CommonError
|
||||
PublishID int64 `json:"publish_id"`
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "SubmitFreePublish")
|
||||
return res.PublishID, err
|
||||
}
|
||||
|
||||
// PublishStatusList 发布任务状态列表
|
||||
type PublishStatusList struct {
|
||||
util.CommonError
|
||||
PublishID int64 `json:"publish_id"` // 发布任务id
|
||||
PublishStatus PublishStatus `json:"publish_status"` // 发布状态
|
||||
ArticleID string `json:"article_id"` // 当发布状态为0时(即成功)时,返回图文的 article_id,可用于“客服消息”场景
|
||||
ArticleDetail PublishArticleDetail `json:"article_detail"` // 发布任务文章成功状态详情
|
||||
FailIndex []uint `json:"fail_idx"` // 当发布状态为2或4时,返回不通过的文章编号,第一篇为 1;其他发布状态则为空
|
||||
}
|
||||
|
||||
// PublishArticleDetail 发布任务成功详情
|
||||
type PublishArticleDetail struct {
|
||||
Count uint `json:"count"` // 当发布状态为0时(即成功)时,返回文章数量
|
||||
Items []PublishArticleItem `json:"item"`
|
||||
}
|
||||
|
||||
// PublishArticleItem 发布任务成功的文章内容
|
||||
type PublishArticleItem struct {
|
||||
Index uint `json:"idx"` // 当发布状态为0时(即成功)时,返回文章对应的编号
|
||||
ArticleURL string `json:"article_url"` // 当发布状态为0时(即成功)时,返回图文的永久链接
|
||||
}
|
||||
|
||||
// SelectStatus 发布状态轮询接口
|
||||
func (freePublish *FreePublish) SelectStatus(publishID int64) (list PublishStatusList, err error) {
|
||||
accessToken, err := freePublish.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var req struct {
|
||||
PublishID int64 `json:"publish_id"`
|
||||
}
|
||||
req.PublishID = publishID
|
||||
|
||||
var response []byte
|
||||
uri := fmt.Sprintf("%s?access_token=%s", selectStateURL, accessToken)
|
||||
response, err = util.PostJSON(uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &list, "SelectStatusFreePublish")
|
||||
return
|
||||
}
|
||||
|
||||
// Delete 删除发布。
|
||||
// index 要删除的文章在图文消息中的位置,第一篇编号为1,该字段不填或填0会删除全部文章
|
||||
// !!!此操作不可逆,请谨慎操作!!!删除后微信公众号后台仍然会有记录!!!
|
||||
func (freePublish *FreePublish) Delete(articleID string, index uint) (err error) {
|
||||
accessToken, err := freePublish.GetAccessToken()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
var req struct {
|
||||
ArticleID string `json:"article_id"`
|
||||
Index uint `json:"index"`
|
||||
}
|
||||
req.ArticleID = articleID
|
||||
req.Index = index
|
||||
|
||||
var response []byte
|
||||
uri := fmt.Sprintf("%s?access_token=%s", deleteURL, accessToken)
|
||||
response, err = util.PostJSON(uri, req)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return util.DecodeWithCommonError(response, "DeleteFreePublish")
|
||||
}
|
||||
|
||||
// Article 图文信息内容
|
||||
type Article struct {
|
||||
Title string `json:"title"` // 标题
|
||||
Author string `json:"author"` // 作者
|
||||
Digest string `json:"digest"` // 图文消息的摘要,仅有单图文消息才有摘要,多图文此处为空
|
||||
Content string `json:"content"` // 图文消息的具体内容,支持HTML标签,必须少于2万字符,小于1M,且此处会去除JS
|
||||
ContentSourceURL string `json:"content_source_url"` // 图文消息的原文地址,即点击“阅读原文”后的URL
|
||||
ThumbMediaID string `json:"thumb_media_id"` // 图文消息的封面图片素材id(一定是永久MediaID)
|
||||
ShowCoverPic uint `json:"show_cover_pic"` // 是否显示封面,0为false,即不显示,1为true,即显示(默认)
|
||||
NeedOpenComment uint `json:"need_open_comment"` // 是否打开评论,0不打开(默认),1打开
|
||||
OnlyFansCanComment uint `json:"only_fans_can_comment"` // 是否粉丝才可评论,0所有人可评论(默认),1粉丝才可评论
|
||||
URL string `json:"url"` // 图文消息的URL
|
||||
IsDeleted bool `json:"is_deleted"` // 该图文是否被删除
|
||||
}
|
||||
|
||||
// First 通过 article_id 获取已发布文章
|
||||
func (freePublish *FreePublish) First(articleID string) (list []Article, err error) {
|
||||
accessToken, err := freePublish.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var req struct {
|
||||
ArticleID string `json:"article_id"`
|
||||
}
|
||||
req.ArticleID = articleID
|
||||
|
||||
var response []byte
|
||||
uri := fmt.Sprintf("%s?access_token=%s", firstArticleURL, accessToken)
|
||||
response, err = util.PostJSON(uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var res struct {
|
||||
util.CommonError
|
||||
NewsItem []Article `json:"news_item"`
|
||||
}
|
||||
err = util.DecodeWithError(response, &res, "FirstFreePublish")
|
||||
return res.NewsItem, err
|
||||
}
|
||||
|
||||
// ArticleList 发布列表
|
||||
type ArticleList struct {
|
||||
util.CommonError
|
||||
TotalCount int64 `json:"total_count"` // 成功发布素材的总数
|
||||
ItemCount int64 `json:"item_count"` // 本次调用获取的素材的数量
|
||||
Item []ArticleListItem `json:"item"`
|
||||
}
|
||||
|
||||
// ArticleListItem 用于 ArticleList 的 item 节点
|
||||
type ArticleListItem struct {
|
||||
ArticleID string `json:"article_id"` // 成功发布的图文消息id
|
||||
Content ArticleListContent `json:"content"` // 内容
|
||||
UpdateTime int64 `json:"update_time"` // 这篇图文消息素材的最后更新时间
|
||||
}
|
||||
|
||||
// ArticleListContent 用于 ArticleListItem 的 content 节点
|
||||
type ArticleListContent struct {
|
||||
NewsItem []Article `json:"news_item"` // 这篇图文消息素材的内容
|
||||
}
|
||||
|
||||
// Paginate 获取成功发布列表
|
||||
func (freePublish *FreePublish) Paginate(offset, count int64, noReturnContent bool) (list ArticleList, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = freePublish.GetAccessToken()
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
var req struct {
|
||||
Count int64 `json:"count"`
|
||||
Offset int64 `json:"offset"`
|
||||
NoReturnContent bool `json:"no_content"`
|
||||
}
|
||||
req.Count = count
|
||||
req.Offset = offset
|
||||
req.NoReturnContent = noReturnContent
|
||||
|
||||
var response []byte
|
||||
uri := fmt.Sprintf("%s?access_token=%s", paginateURL, accessToken)
|
||||
response, err = util.PostJSON(uri, req)
|
||||
if err != nil {
|
||||
return
|
||||
}
|
||||
|
||||
err = util.DecodeWithError(response, &list, "PaginateFreePublish")
|
||||
return
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
package js
|
||||
|
||||
import (
|
||||
context2 "context"
|
||||
"fmt"
|
||||
|
||||
"github.com/silenceper/wechat/v2/credential"
|
||||
@@ -22,7 +23,7 @@ type Config struct {
|
||||
Signature string `json:"signature"`
|
||||
}
|
||||
|
||||
//NewJs init
|
||||
// NewJs init
|
||||
func NewJs(context *context.Context) *Js {
|
||||
js := new(Js)
|
||||
js.Context = context
|
||||
@@ -31,22 +32,39 @@ func NewJs(context *context.Context) *Js {
|
||||
return js
|
||||
}
|
||||
|
||||
//SetJsTicketHandle 自定义js ticket取值方式
|
||||
// SetJsTicketHandle 自定义js ticket取值方式
|
||||
func (js *Js) SetJsTicketHandle(ticketHandle credential.JsTicketHandle) {
|
||||
js.JsTicketHandle = ticketHandle
|
||||
}
|
||||
|
||||
//GetConfig 获取jssdk需要的配置参数
|
||||
//uri 为当前网页地址
|
||||
// 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"
|
||||
@@ -19,33 +22,33 @@ const (
|
||||
batchGetMaterialURL = "https://api.weixin.qq.com/cgi-bin/material/batchget_material"
|
||||
)
|
||||
|
||||
//PermanentMaterialType 永久素材类型
|
||||
// PermanentMaterialType 永久素材类型
|
||||
type PermanentMaterialType string
|
||||
|
||||
const (
|
||||
//PermanentMaterialTypeImage 永久素材图片类型(image)
|
||||
// PermanentMaterialTypeImage 永久素材图片类型(image)
|
||||
PermanentMaterialTypeImage PermanentMaterialType = "image"
|
||||
//PermanentMaterialTypeVideo 永久素材视频类型(video)
|
||||
// PermanentMaterialTypeVideo 永久素材视频类型(video)
|
||||
PermanentMaterialTypeVideo PermanentMaterialType = "video"
|
||||
//PermanentMaterialTypeVoice 永久素材语音类型 (voice)
|
||||
// PermanentMaterialTypeVoice 永久素材语音类型(voice)
|
||||
PermanentMaterialTypeVoice PermanentMaterialType = "voice"
|
||||
//PermanentMaterialTypeNews 永久素材图文类型(news)
|
||||
// PermanentMaterialTypeNews 永久素材图文类型(news)
|
||||
PermanentMaterialTypeNews PermanentMaterialType = "news"
|
||||
)
|
||||
|
||||
//Material 素材管理
|
||||
// Material 素材管理
|
||||
type Material struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
//NewMaterial init
|
||||
// NewMaterial init
|
||||
func NewMaterial(context *context.Context) *Material {
|
||||
material := new(Material)
|
||||
material.Context = context
|
||||
return material
|
||||
}
|
||||
|
||||
//Article 永久图文素材
|
||||
// Article 永久图文素材
|
||||
type Article struct {
|
||||
Title string `json:"title"`
|
||||
ThumbMediaID string `json:"thumb_media_id"`
|
||||
@@ -87,19 +90,19 @@ func (material *Material) GetNews(id string) ([]*Article, error) {
|
||||
return res.NewsItem, nil
|
||||
}
|
||||
|
||||
//reqArticles 永久性图文素材请求信息
|
||||
// reqArticles 永久性图文素材请求信息
|
||||
type reqArticles struct {
|
||||
Articles []*Article `json:"articles"`
|
||||
}
|
||||
|
||||
//resArticles 永久性图文素材返回结果
|
||||
// resArticles 永久性图文素材返回结果
|
||||
type resArticles struct {
|
||||
util.CommonError
|
||||
|
||||
MediaID string `json:"media_id"`
|
||||
}
|
||||
|
||||
//AddNews 新增永久图文素材
|
||||
// AddNews 新增永久图文素材
|
||||
func (material *Material) AddNews(articles []*Article) (mediaID string, err error) {
|
||||
req := &reqArticles{articles}
|
||||
|
||||
@@ -126,7 +129,7 @@ func (material *Material) AddNews(articles []*Article) (mediaID string, err erro
|
||||
return
|
||||
}
|
||||
|
||||
//reqUpdateArticle 更新永久性图文素材请求信息
|
||||
// reqUpdateArticle 更新永久性图文素材请求信息
|
||||
type reqUpdateArticle struct {
|
||||
MediaID string `json:"media_id"`
|
||||
Index int64 `json:"index"`
|
||||
@@ -152,7 +155,7 @@ func (material *Material) UpdateNews(article *Article, mediaID string, index int
|
||||
return util.DecodeWithCommonError(response, "UpdateNews")
|
||||
}
|
||||
|
||||
//resAddMaterial 永久性素材上传返回的结果
|
||||
// resAddMaterial 永久性素材上传返回的结果
|
||||
type resAddMaterial struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -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,11 +269,22 @@ 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"`
|
||||
}
|
||||
|
||||
//DeleteMaterial 删除永久素材
|
||||
// DeleteMaterial 删除永久素材
|
||||
func (material *Material) DeleteMaterial(mediaID string) error {
|
||||
accessToken, err := material.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -270,7 +300,7 @@ func (material *Material) DeleteMaterial(mediaID string) error {
|
||||
return util.DecodeWithCommonError(response, "DeleteMaterial")
|
||||
}
|
||||
|
||||
//ArticleList 永久素材列表
|
||||
// ArticleList 永久素材列表
|
||||
type ArticleList struct {
|
||||
util.CommonError
|
||||
TotalCount int64 `json:"total_count"`
|
||||
@@ -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"`
|
||||
@@ -302,6 +332,7 @@ type reqBatchGetMaterial struct {
|
||||
}
|
||||
|
||||
// BatchGetMaterial 批量获取永久素材
|
||||
//
|
||||
//reference:https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/Get_materials_list.html
|
||||
func (material *Material) BatchGetMaterial(permanentMaterialType PermanentMaterialType, offset, count int64) (list ArticleList, err error) {
|
||||
var accessToken string
|
||||
@@ -336,7 +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,21 +3,22 @@ package material
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
|
||||
"github.com/silenceper/wechat/v2/util"
|
||||
)
|
||||
|
||||
//MediaType 媒体文件类型
|
||||
// MediaType 媒体文件类型
|
||||
type MediaType string
|
||||
|
||||
const (
|
||||
//MediaTypeImage 媒体文件:图片
|
||||
// MediaTypeImage 媒体文件:图片
|
||||
MediaTypeImage MediaType = "image"
|
||||
//MediaTypeVoice 媒体文件:声音
|
||||
// MediaTypeVoice 媒体文件:声音
|
||||
MediaTypeVoice MediaType = "voice"
|
||||
//MediaTypeVideo 媒体文件:视频
|
||||
// MediaTypeVideo 媒体文件:视频
|
||||
MediaTypeVideo MediaType = "video"
|
||||
//MediaTypeThumb 媒体文件:缩略图
|
||||
// MediaTypeThumb 媒体文件:缩略图
|
||||
MediaTypeThumb MediaType = "thumb"
|
||||
)
|
||||
|
||||
@@ -27,7 +28,7 @@ const (
|
||||
mediaGetURL = "https://api.weixin.qq.com/cgi-bin/media/get"
|
||||
)
|
||||
|
||||
//Media 临时素材上传返回信息
|
||||
// Media 临时素材上传返回信息
|
||||
type Media struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -37,7 +38,7 @@ type Media struct {
|
||||
CreatedAt int64 `json:"created_at"`
|
||||
}
|
||||
|
||||
//MediaUpload 临时素材上传
|
||||
// MediaUpload 临时素材上传
|
||||
func (material *Material) MediaUpload(mediaType MediaType, filename string) (media Media, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = material.GetAccessToken()
|
||||
@@ -62,8 +63,40 @@ func (material *Material) MediaUpload(mediaType MediaType, filename string) (med
|
||||
return
|
||||
}
|
||||
|
||||
//GetMediaURL 返回临时素材的下载地址供用户自己处理
|
||||
//NOTICE: URL 不可公开,因为含access_token 需要立即另存文件
|
||||
// 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) {
|
||||
var accessToken string
|
||||
accessToken, err = material.GetAccessToken()
|
||||
@@ -74,14 +107,14 @@ func (material *Material) GetMediaURL(mediaID string) (mediaURL string, err erro
|
||||
return
|
||||
}
|
||||
|
||||
//resMediaImage 图片上传返回结果
|
||||
// resMediaImage 图片上传返回结果
|
||||
type resMediaImage struct {
|
||||
util.CommonError
|
||||
|
||||
URL string `json:"url"`
|
||||
}
|
||||
|
||||
//ImageUpload 图片上传
|
||||
// ImageUpload 图片上传
|
||||
func (material *Material) ImageUpload(filename string) (url string, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = material.GetAccessToken()
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
package menu
|
||||
|
||||
//Button 菜单按钮
|
||||
// Button 菜单按钮
|
||||
type Button struct {
|
||||
Type string `json:"type,omitempty"`
|
||||
Name string `json:"name,omitempty"`
|
||||
@@ -12,7 +12,7 @@ type Button struct {
|
||||
SubButtons []*Button `json:"sub_button,omitempty"`
|
||||
}
|
||||
|
||||
//SetSubButton 设置二级菜单
|
||||
// SetSubButton 设置二级菜单
|
||||
func (btn *Button) SetSubButton(name string, subButtons []*Button) *Button {
|
||||
btn.Name = name
|
||||
btn.SubButtons = subButtons
|
||||
@@ -23,7 +23,7 @@ func (btn *Button) SetSubButton(name string, subButtons []*Button) *Button {
|
||||
return btn
|
||||
}
|
||||
|
||||
//SetClickButton btn 为click类型
|
||||
// SetClickButton btn 为click类型
|
||||
func (btn *Button) SetClickButton(name, key string) *Button {
|
||||
btn.Type = "click"
|
||||
btn.Name = name
|
||||
@@ -34,7 +34,7 @@ func (btn *Button) SetClickButton(name, key string) *Button {
|
||||
return btn
|
||||
}
|
||||
|
||||
//SetViewButton view类型
|
||||
// SetViewButton view类型
|
||||
func (btn *Button) SetViewButton(name, url string) *Button {
|
||||
btn.Type = "view"
|
||||
btn.Name = name
|
||||
@@ -45,7 +45,7 @@ func (btn *Button) SetViewButton(name, url string) *Button {
|
||||
return btn
|
||||
}
|
||||
|
||||
//SetScanCodePushButton 扫码推事件
|
||||
// SetScanCodePushButton 扫码推事件
|
||||
func (btn *Button) SetScanCodePushButton(name, key string) *Button {
|
||||
btn.Type = "scancode_push"
|
||||
btn.Name = name
|
||||
@@ -56,7 +56,7 @@ func (btn *Button) SetScanCodePushButton(name, key string) *Button {
|
||||
return btn
|
||||
}
|
||||
|
||||
//SetScanCodeWaitMsgButton 设置 扫码推事件且弹出"消息接收中"提示框
|
||||
// SetScanCodeWaitMsgButton 设置 扫码推事件且弹出"消息接收中"提示框
|
||||
func (btn *Button) SetScanCodeWaitMsgButton(name, key string) *Button {
|
||||
btn.Type = "scancode_waitmsg"
|
||||
btn.Name = name
|
||||
@@ -68,7 +68,7 @@ func (btn *Button) SetScanCodeWaitMsgButton(name, key string) *Button {
|
||||
return btn
|
||||
}
|
||||
|
||||
//SetPicSysPhotoButton 设置弹出系统拍照发图按钮
|
||||
// SetPicSysPhotoButton 设置弹出系统拍照发图按钮
|
||||
func (btn *Button) SetPicSysPhotoButton(name, key string) *Button {
|
||||
btn.Type = "pic_sysphoto"
|
||||
btn.Name = name
|
||||
@@ -80,7 +80,7 @@ func (btn *Button) SetPicSysPhotoButton(name, key string) *Button {
|
||||
return btn
|
||||
}
|
||||
|
||||
//SetPicPhotoOrAlbumButton 设置弹出拍照或者相册发图类型按钮
|
||||
// SetPicPhotoOrAlbumButton 设置弹出拍照或者相册发图类型按钮
|
||||
func (btn *Button) SetPicPhotoOrAlbumButton(name, key string) *Button {
|
||||
btn.Type = "pic_photo_or_album"
|
||||
btn.Name = name
|
||||
@@ -92,7 +92,7 @@ func (btn *Button) SetPicPhotoOrAlbumButton(name, key string) *Button {
|
||||
return btn
|
||||
}
|
||||
|
||||
//SetPicWeixinButton 设置弹出微信相册发图器类型按钮
|
||||
// SetPicWeixinButton 设置弹出微信相册发图器类型按钮
|
||||
func (btn *Button) SetPicWeixinButton(name, key string) *Button {
|
||||
btn.Type = "pic_weixin"
|
||||
btn.Name = name
|
||||
@@ -104,7 +104,7 @@ func (btn *Button) SetPicWeixinButton(name, key string) *Button {
|
||||
return btn
|
||||
}
|
||||
|
||||
//SetLocationSelectButton 设置 弹出地理位置选择器 类型按钮
|
||||
// SetLocationSelectButton 设置 弹出地理位置选择器 类型按钮
|
||||
func (btn *Button) SetLocationSelectButton(name, key string) *Button {
|
||||
btn.Type = "location_select"
|
||||
btn.Name = name
|
||||
@@ -116,7 +116,7 @@ func (btn *Button) SetLocationSelectButton(name, key string) *Button {
|
||||
return btn
|
||||
}
|
||||
|
||||
//SetMediaIDButton 设置 下发消息(除文本消息) 类型按钮
|
||||
// SetMediaIDButton 设置 下发消息(除文本消息) 类型按钮
|
||||
func (btn *Button) SetMediaIDButton(name, mediaID string) *Button {
|
||||
btn.Type = "media_id"
|
||||
btn.Name = name
|
||||
@@ -128,7 +128,7 @@ func (btn *Button) SetMediaIDButton(name, mediaID string) *Button {
|
||||
return btn
|
||||
}
|
||||
|
||||
//SetViewLimitedButton 设置 跳转图文消息URL 类型按钮
|
||||
// SetViewLimitedButton 设置 跳转图文消息URL 类型按钮
|
||||
func (btn *Button) SetViewLimitedButton(name, mediaID string) *Button {
|
||||
btn.Type = "view_limited"
|
||||
btn.Name = name
|
||||
@@ -140,7 +140,7 @@ func (btn *Button) SetViewLimitedButton(name, mediaID string) *Button {
|
||||
return btn
|
||||
}
|
||||
|
||||
//SetMiniprogramButton 设置 跳转小程序 类型按钮 (公众号后台必须已经关联小程序)
|
||||
// SetMiniprogramButton 设置 跳转小程序 类型按钮 (公众号后台必须已经关联小程序)
|
||||
func (btn *Button) SetMiniprogramButton(name, url, appID, pagePath string) *Button {
|
||||
btn.Type = "miniprogram"
|
||||
btn.Name = name
|
||||
@@ -154,62 +154,62 @@ func (btn *Button) SetMiniprogramButton(name, url, appID, pagePath string) *Butt
|
||||
return btn
|
||||
}
|
||||
|
||||
//NewSubButton 二级菜单
|
||||
// NewSubButton 二级菜单
|
||||
func NewSubButton(name string, subButtons []*Button) *Button {
|
||||
return (&Button{}).SetSubButton(name, subButtons)
|
||||
}
|
||||
|
||||
//NewClickButton btn 为click类型
|
||||
// NewClickButton btn 为click类型
|
||||
func NewClickButton(name, key string) *Button {
|
||||
return (&Button{}).SetClickButton(name, key)
|
||||
}
|
||||
|
||||
//NewViewButton view类型
|
||||
// NewViewButton view类型
|
||||
func NewViewButton(name, url string) *Button {
|
||||
return (&Button{}).SetViewButton(name, url)
|
||||
}
|
||||
|
||||
//NewScanCodePushButton 扫码推事件
|
||||
// NewScanCodePushButton 扫码推事件
|
||||
func NewScanCodePushButton(name, key string) *Button {
|
||||
return (&Button{}).SetScanCodePushButton(name, key)
|
||||
}
|
||||
|
||||
//NewScanCodeWaitMsgButton 扫码推事件且弹出"消息接收中"提示框
|
||||
// NewScanCodeWaitMsgButton 扫码推事件且弹出"消息接收中"提示框
|
||||
func NewScanCodeWaitMsgButton(name, key string) *Button {
|
||||
return (&Button{}).SetScanCodeWaitMsgButton(name, key)
|
||||
}
|
||||
|
||||
//NewPicSysPhotoButton 弹出系统拍照发图按钮
|
||||
// NewPicSysPhotoButton 弹出系统拍照发图按钮
|
||||
func NewPicSysPhotoButton(name, key string) *Button {
|
||||
return (&Button{}).SetPicSysPhotoButton(name, key)
|
||||
}
|
||||
|
||||
//NewPicPhotoOrAlbumButton 弹出拍照或者相册发图类型按钮
|
||||
// NewPicPhotoOrAlbumButton 弹出拍照或者相册发图类型按钮
|
||||
func NewPicPhotoOrAlbumButton(name, key string) *Button {
|
||||
return (&Button{}).SetPicPhotoOrAlbumButton(name, key)
|
||||
}
|
||||
|
||||
//NewPicWeixinButton 弹出微信相册发图器类型按钮
|
||||
// NewPicWeixinButton 弹出微信相册发图器类型按钮
|
||||
func NewPicWeixinButton(name, key string) *Button {
|
||||
return (&Button{}).SetPicWeixinButton(name, key)
|
||||
}
|
||||
|
||||
//NewLocationSelectButton 弹出地理位置选择器 类型按钮
|
||||
// NewLocationSelectButton 弹出地理位置选择器 类型按钮
|
||||
func NewLocationSelectButton(name, key string) *Button {
|
||||
return (&Button{}).SetLocationSelectButton(name, key)
|
||||
}
|
||||
|
||||
//NewMediaIDButton 下发消息(除文本消息) 类型按钮
|
||||
// NewMediaIDButton 下发消息(除文本消息) 类型按钮
|
||||
func NewMediaIDButton(name, mediaID string) *Button {
|
||||
return (&Button{}).SetMediaIDButton(name, mediaID)
|
||||
}
|
||||
|
||||
//NewViewLimitedButton 跳转图文消息URL 类型按钮
|
||||
// NewViewLimitedButton 跳转图文消息URL 类型按钮
|
||||
func NewViewLimitedButton(name, mediaID string) *Button {
|
||||
return (&Button{}).SetViewLimitedButton(name, mediaID)
|
||||
}
|
||||
|
||||
//NewMiniprogramButton 跳转小程序 类型按钮 (公众号后台必须已经关联小程序)
|
||||
// NewMiniprogramButton 跳转小程序 类型按钮 (公众号后台必须已经关联小程序)
|
||||
func NewMiniprogramButton(name, url, appID, pagePath string) *Button {
|
||||
return (&Button{}).SetMiniprogramButton(name, url, appID, pagePath)
|
||||
}
|
||||
|
||||
@@ -18,42 +18,42 @@ const (
|
||||
menuSelfMenuInfoURL = "https://api.weixin.qq.com/cgi-bin/get_current_selfmenu_info"
|
||||
)
|
||||
|
||||
//Menu struct
|
||||
// Menu struct
|
||||
type Menu struct {
|
||||
*context.Context
|
||||
}
|
||||
|
||||
//reqMenu 设置菜单请求数据
|
||||
// reqMenu 设置菜单请求数据
|
||||
type reqMenu struct {
|
||||
Button []*Button `json:"button,omitempty"`
|
||||
MatchRule *MatchRule `json:"matchrule,omitempty"`
|
||||
}
|
||||
|
||||
//reqDeleteConditional 删除个性化菜单请求数据
|
||||
// reqDeleteConditional 删除个性化菜单请求数据
|
||||
type reqDeleteConditional struct {
|
||||
MenuID int64 `json:"menuid"`
|
||||
}
|
||||
|
||||
//reqMenuTryMatch 菜单匹配请求
|
||||
// reqMenuTryMatch 菜单匹配请求
|
||||
type reqMenuTryMatch struct {
|
||||
UserID string `json:"user_id"`
|
||||
}
|
||||
|
||||
//resConditionalMenu 个性化菜单返回结果
|
||||
// resConditionalMenu 个性化菜单返回结果
|
||||
type resConditionalMenu struct {
|
||||
Button []Button `json:"button"`
|
||||
MatchRule MatchRule `json:"matchrule"`
|
||||
MenuID int64 `json:"menuid"`
|
||||
}
|
||||
|
||||
//resMenuTryMatch 菜单匹配请求结果
|
||||
// resMenuTryMatch 菜单匹配请求结果
|
||||
type resMenuTryMatch struct {
|
||||
util.CommonError
|
||||
|
||||
Button []Button `json:"button"`
|
||||
}
|
||||
|
||||
//ResMenu 查询菜单的返回数据
|
||||
// ResMenu 查询菜单的返回数据
|
||||
type ResMenu struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -64,7 +64,7 @@ type ResMenu struct {
|
||||
Conditionalmenu []resConditionalMenu `json:"conditionalmenu"`
|
||||
}
|
||||
|
||||
//ResSelfMenuInfo 自定义菜单配置返回结果
|
||||
// ResSelfMenuInfo 自定义菜单配置返回结果
|
||||
type ResSelfMenuInfo struct {
|
||||
util.CommonError
|
||||
|
||||
@@ -74,7 +74,7 @@ type ResSelfMenuInfo struct {
|
||||
} `json:"selfmenu_info"`
|
||||
}
|
||||
|
||||
//SelfMenuButton 自定义菜单配置详情
|
||||
// SelfMenuButton 自定义菜单配置详情
|
||||
type SelfMenuButton struct {
|
||||
Type string `json:"type"`
|
||||
Name string `json:"name"`
|
||||
@@ -89,7 +89,7 @@ type SelfMenuButton struct {
|
||||
} `json:"news_info,omitempty"`
|
||||
}
|
||||
|
||||
//ButtonNew 图文消息菜单
|
||||
// ButtonNew 图文消息菜单
|
||||
type ButtonNew struct {
|
||||
Title string `json:"title"`
|
||||
Author string `json:"author"`
|
||||
@@ -100,7 +100,7 @@ type ButtonNew struct {
|
||||
SourceURL string `json:"source_url"`
|
||||
}
|
||||
|
||||
//MatchRule 个性化菜单规则
|
||||
// MatchRule 个性化菜单规则
|
||||
type MatchRule struct {
|
||||
GroupID string `json:"group_id,omitempty"`
|
||||
Sex string `json:"sex,omitempty"`
|
||||
@@ -111,14 +111,14 @@ type MatchRule struct {
|
||||
Language string `json:"language,omitempty"`
|
||||
}
|
||||
|
||||
//NewMenu 实例
|
||||
// NewMenu 实例
|
||||
func NewMenu(context *context.Context) *Menu {
|
||||
menu := new(Menu)
|
||||
menu.Context = context
|
||||
return menu
|
||||
}
|
||||
|
||||
//SetMenu 设置按钮
|
||||
// SetMenu 设置按钮
|
||||
func (menu *Menu) SetMenu(buttons []*Button) error {
|
||||
accessToken, err := menu.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -138,7 +138,7 @@ func (menu *Menu) SetMenu(buttons []*Button) error {
|
||||
return util.DecodeWithCommonError(response, "SetMenu")
|
||||
}
|
||||
|
||||
//SetMenuByJSON 设置按钮
|
||||
// SetMenuByJSON 设置按钮
|
||||
func (menu *Menu) SetMenuByJSON(jsonInfo string) error {
|
||||
accessToken, err := menu.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -155,7 +155,7 @@ func (menu *Menu) SetMenuByJSON(jsonInfo string) error {
|
||||
return util.DecodeWithCommonError(response, "SetMenuByJSON")
|
||||
}
|
||||
|
||||
//GetMenu 获取菜单配置
|
||||
// GetMenu 获取菜单配置
|
||||
func (menu *Menu) GetMenu() (resMenu ResMenu, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = menu.GetAccessToken()
|
||||
@@ -179,7 +179,7 @@ func (menu *Menu) GetMenu() (resMenu ResMenu, err error) {
|
||||
return
|
||||
}
|
||||
|
||||
//DeleteMenu 删除菜单
|
||||
// DeleteMenu 删除菜单
|
||||
func (menu *Menu) DeleteMenu() error {
|
||||
accessToken, err := menu.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -194,7 +194,7 @@ func (menu *Menu) DeleteMenu() error {
|
||||
return util.DecodeWithCommonError(response, "GetMenu")
|
||||
}
|
||||
|
||||
//AddConditional 添加个性化菜单
|
||||
// AddConditional 添加个性化菜单
|
||||
func (menu *Menu) AddConditional(buttons []*Button, matchRule *MatchRule) error {
|
||||
accessToken, err := menu.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -215,7 +215,7 @@ func (menu *Menu) AddConditional(buttons []*Button, matchRule *MatchRule) error
|
||||
return util.DecodeWithCommonError(response, "AddConditional")
|
||||
}
|
||||
|
||||
//AddConditionalByJSON 添加个性化菜单
|
||||
// AddConditionalByJSON 添加个性化菜单
|
||||
func (menu *Menu) AddConditionalByJSON(jsonInfo string) error {
|
||||
accessToken, err := menu.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -231,7 +231,7 @@ func (menu *Menu) AddConditionalByJSON(jsonInfo string) error {
|
||||
return util.DecodeWithCommonError(response, "AddConditional")
|
||||
}
|
||||
|
||||
//DeleteConditional 删除个性化菜单
|
||||
// DeleteConditional 删除个性化菜单
|
||||
func (menu *Menu) DeleteConditional(menuID int64) error {
|
||||
accessToken, err := menu.GetAccessToken()
|
||||
if err != nil {
|
||||
@@ -251,7 +251,7 @@ func (menu *Menu) DeleteConditional(menuID int64) error {
|
||||
return util.DecodeWithCommonError(response, "DeleteConditional")
|
||||
}
|
||||
|
||||
//MenuTryMatch 菜单匹配
|
||||
// MenuTryMatch 菜单匹配
|
||||
func (menu *Menu) MenuTryMatch(userID string) (buttons []Button, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = menu.GetAccessToken()
|
||||
@@ -278,7 +278,7 @@ func (menu *Menu) MenuTryMatch(userID string) (buttons []Button, err error) {
|
||||
return
|
||||
}
|
||||
|
||||
//GetCurrentSelfMenuInfo 获取自定义菜单配置接口
|
||||
// GetCurrentSelfMenuInfo 获取自定义菜单配置接口
|
||||
func (menu *Menu) GetCurrentSelfMenuInfo() (resSelfMenuInfo ResSelfMenuInfo, err error) {
|
||||
var accessToken string
|
||||
accessToken, err = menu.GetAccessToken()
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user