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

Compare commits

...

184 Commits

Author SHA1 Message Date
markwang
a07c50fda7 增加[企业微信-客户联系-统计管理]相关接口 (#598)
* 企业微信-客户联系-统计管理

* 企业微信-客户联系-统计管理

* 企业微信-客户联系-统计管理

* debug

* rollback

* json.Marshal错误输出

Co-authored-by: wang.yu <wangyu@uniondrug.com>
2022-08-08 16:57:41 +08:00
Wangrong
eb3dbf1646 增加订阅通知功能 (#599)
* fix issue #586 #543

* add officialaccount subscribe function

* update doc for officialaccount

* add comments

Co-authored-by: Wang Rong <wangron@tesla.com>
2022-08-08 10:03:56 +08:00
Wangrong
27e18b6958 fix officialaccount part in Issue 590 (#591)
* fix issue #586 #543

* fix issue #590 in officialaccount

Co-authored-by: Wang Rong <wangron@tesla.com>
2022-08-08 10:02:24 +08:00
Wangrong
252fc4838b Add Event Type (#596)
* fix issue #586 #543

* add EventViewMiniprogram wechat EventType

Co-authored-by: Wang Rong <wangron@tesla.com>
2022-08-04 20:33:27 +08:00
stepbystep2
fdaffb6aa2 fix: typo (#595) 2022-08-02 20:16:38 +08:00
stepbystep2
108a65ecf3 添加GetPhoneNumberContext方法 (#587) 2022-07-28 00:08:08 +08:00
Wangrong
cc9be30ed1 fix issue #586 #543 (#589)
Co-authored-by: Wang Rong <wangron@tesla.com>
2022-07-26 14:10:55 +08:00
houseme
adf142dac2 feat: modify redis version to v8.11.5 (#582)
* [feature] Format the code and improve Mini Program authorization to obtain openid(miniprogram/auth/auth.go Code2Session)

* [feature] CheckEncryptedData (https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/user-info/auth.checkEncryptedData.html)

* upgrade json error

* upgrade json error

* [feature] Wallet Transfer returns the pointer object

* feat:Adaptation of new go-redis components

* improve code

* feat:upgrade golangci-lint-action version

* fix

* test ci

* fix

* test ci

* fix

* test

* improve code

* feat:GetPhoneNumber return ptr

* fix: ptr Elem() error

* improve code

* improve code

* improve code

* improve code

* upgrade go version v1.15

* improve .golangci.yml

* feat:modify redis version v8.11.5

Co-authored-by: houseme <houseme@outlook.com>
2022-07-20 11:25:15 +08:00
theodore
ded5a10f9f 小程序服务商 - 获取 URL Link 及 查询小程序 url_link 配置 (#576)
* 小程序服务商 - 获取 URL Link 及 查询小程序 url_link 配置

* 格式化代码

* 规范调整
2022-06-29 00:12:50 +08:00
bailey5239
e1307648fd fix:企业微信-给外部联系人打标签-参数问题 (#577)
* fix:企业微信-给外部联系人打标签-参数问题

* Update tag.go

Co-authored-by: 俞彬彬 <shanshan82324650yu@163.com>
Co-authored-by: houseme <housemecn@gmail.com>
2022-06-28 10:21:37 +08:00
theodore
c6325ace85 补充获取授权方帐号基本信息中小程序相关信息 (#573) 2022-06-26 10:38:55 +08:00
sū hǎi
f2e7979a9f return *CommonError instead of errorString (#568) 2022-05-17 10:33:53 +08:00
Bryan
890e9fed43 企业微信 OAuth2:支持获取 ExternalUserID (#565) 2022-04-29 21:40:27 +08:00
Bryan
3cbc95732a 企业微信客服消息: 修复发送消息时 MsgID 为空会报错的问题 (#563) 2022-04-28 21:59:36 +08:00
bear
182339c00f 添加企业微信外部联系部分的 sdk (#562) 2022-04-27 23:50:28 +08:00
yucui xiao
e952b1d55a 微信小程序回调消息兼容json格式 (#560) 2022-04-26 15:59:51 +08:00
houseme
4b972c740f fix: ptr Elem() error (#561)
* [feature] Format the code and improve Mini Program authorization to obtain openid(miniprogram/auth/auth.go Code2Session)

* [feature] CheckEncryptedData (https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/user-info/auth.checkEncryptedData.html)

* upgrade json error

* upgrade json error

* [feature] Wallet Transfer returns the pointer object

* feat:Adaptation of new go-redis components

* improve code

* feat:upgrade golangci-lint-action version

* fix

* test ci

* fix

* test ci

* fix

* test

* improve code

* feat:GetPhoneNumber return ptr

* fix: ptr Elem() error

* improve code

Co-authored-by: houseme <houseme@outlook.com>
2022-04-26 11:10:24 +08:00
曹现峰
d5e7c8043e feat:add urlscheme.query (#553)
* add:urlscheme-query

* add:urlscheme-query

Co-authored-by: caoxianfeng <caoxianfeng@rcrai.com>
2022-04-23 22:18:14 +08:00
save95
56350c3655 add: [小程序] 增加 安全风控、内容安全1.0 & 2.0、code换取手机号 (#554)
* add: [小程序] 增加 安全风控、内容安全1.0 & 2.0、code换取手机号

* add: check suggest docs

* fix

* fix

Co-authored-by: luoyu <luoyu@medlinker.com>
2022-04-22 10:09:27 +08:00
iceman!
538c0b4e5f feat:获取小程序链接URLScheme (#551) 2022-04-21 16:01:38 +08:00
愉悦の祈
8fe9e6dcb6 fix: 统一服务信息,公众号消息模板字段bug (#547) 2022-04-20 19:32:59 +08:00
houseme
8e81a416c5 Adaptation of new go-redis components (#546)
* [feature] Format the code and improve Mini Program authorization to obtain openid(miniprogram/auth/auth.go Code2Session)

* [feature] CheckEncryptedData (https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/user-info/auth.checkEncryptedData.html)

* upgrade json error

* upgrade json error

* [feature] Wallet Transfer returns the pointer object

* feat:Adaptation of new go-redis components

* improve code

* feat:upgrade golangci-lint-action version

* fix

* test ci

* fix

* test ci

* fix

* test

* improve code

* feat:GetPhoneNumber return ptr

Co-authored-by: houseme <houseme@outlook.com>
2022-04-14 10:07:58 +08:00
lyj
1b5c5fba67 Bug fix: omitempty关键字,给它赋的值恰好等于默认空值的话,在转为 json 之后也不会输出这个 field (#539) 2022-02-28 10:38:46 +08:00
save95
5c4b28acee add: 增加公众号「发布能力」接口(#530) (#531)
* add: 增加公众号「发布能力」接口(#530)

* fix: go lint

* fix: 修复响应结构体及解析方式

* add: 增加公众号「草稿箱」接口(#530)

* fix: text

* mod: 增加 发布任务完成 消息事件

Co-authored-by: luoyu <luoyu@medlinker.com>
2022-02-14 10:19:55 +08:00
wby
80ce4aefc4 微信小程序新版获取手机号授权接口 (#528) 2022-01-11 18:22:07 +08:00
Afeyer
0d915d203b docs:更新会话存档README.md文件内的示例代码 (#527) 2022-01-09 13:02:48 +08:00
zxr615
172c4abde5 通过component_verify_ticket 获取 ComponentAccessToken 错误处理 (#521) 2022-01-05 09:13:25 +08:00
silenceper
2f898f80f6 fix SdkFileID (#520) 2021-12-31 11:35:05 +08:00
wby
4721f7567b 支持微信小程序隐私接口 (#518)
* save

* set privacy

* 完善小程序隐私设置接口

* fix privacy desc

* 移除gitpod定义文件,api响应解析改用公共方法

* use DecodeWithCommonError

* fix ci

* fix ci

* fix other package ci

* fix err
2021-12-28 14:34:50 +08:00
意琦行
9cecda0469 小程序码、URL Link 增加参数(#502,#512) (#514)
* 小程序码、URL Link 增加参数(#502,#512)

* gofmt
2021-12-07 19:05:37 +08:00
silenceper
83e223999b add .goreleaser.yml
Signed-off-by: silenceper <silenceper@gmail.com>
2021-12-06 11:32:49 +08:00
silenceper
e068d53dcb Create release.yml 2021-12-06 11:19:25 +08:00
杨成锴
8c87c49f2a update: 统一消息类型 (#511) 2021-12-03 20:45:11 +08:00
Afeyer
74053fe6ef feat: 微信客服会话变更事件支持查看客服账号ID (#510) 2021-11-15 19:16:12 +08:00
ixugo
566c3c27cb 增加订阅通知事件 (#509) 2021-11-15 17:06:50 +08:00
Afeyer
dc24ad4262 feat: 微信客服会话状态变更时支持发送回复语 (#505) 2021-11-15 17:05:13 +08:00
Afeyer
05ec6a42ae docs:更新接口消息发送限制说明文档 (#504) 2021-11-05 17:37:27 +08:00
Afeyer
efad41bcda pref: 优化全局错误提示 (#503) 2021-11-01 10:07:48 +08:00
Afeyer
3fb288d932 feat: 微信客服支持发送欢迎语 (#496) 2021-10-08 19:37:40 +08:00
Afeyer
f5f401e76c doc: 更新微信客服 API 文档 (#495)
* doc: 更新微信客服 API 文档

* chore: 解决【升级服务】标题显示异常的问题
2021-09-30 22:34:42 +08:00
Afeyer
ab4f427647 feat:微信客服支持获取视频号绑定状态 (#493) 2021-09-30 17:31:30 +08:00
silenceper
a9ae64ef63 add work api doc (#494) 2021-09-30 16:50:29 +08:00
silenceper
83621a38c6 Update README.md 2021-09-30 16:09:55 +08:00
silenceper
4937f019a0 梳理API列表 (#491)
* api梳理

* 完善客服管理api doc
2021-09-30 16:01:47 +08:00
Afeyer
e9489625c6 feat:微信客服支持通过接口转接人工会话 (#492) 2021-09-30 12:13:10 +08:00
houseme
f74869e61c Transfer to wallet returns pointer object (#489)
* [feature] Format the code and improve Mini Program authorization to obtain openid(miniprogram/auth/auth.go Code2Session)

* [feature] CheckEncryptedData (https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/user-info/auth.checkEncryptedData.html)

* upgrade json error

* upgrade json error

* [feature] Wallet Transfer returns the pointer object

Co-authored-by: houseme <houseme@outlook.com>
2021-09-27 19:35:16 +08:00
owen.gxz
fd96154231 增加注册审核事件推送消息 (#487)
* 消息类型增加快速注册企业小程序回调参数

* 代码格式化

* 更改常量名称

* 更改注解

Co-authored-by: 高震 <gaozhen@gaozhendeMacBook-Pro.local>
2021-09-26 14:15:31 +08:00
Afeyer
8621e06a01 feat: 完善微信客服常用的错误类型 (#486)
* feat:微信客服支持向客户发送欢迎语

* chore: go fmt file

* feat:移除空白文件

* doc:完善菜单消息内的注释文档

* feat: 完善微信客服常用的错误类型

* refactor: 优化SDK错误生成函数
2021-09-26 10:38:52 +08:00
okhowang
1e2f909f34 小程序auth增加Context接口 (#483) 2021-09-17 10:11:22 +08:00
okhowang
00b13cda0d 增加iv校验 (#482) 2021-09-16 12:21:40 +08:00
Afeyer
c021336a3c doc:完善菜单消息内的注释文档 (#479)
* feat:微信客服支持向客户发送欢迎语

* chore: go fmt file

* feat:移除空白文件

* doc:完善菜单消息内的注释文档
2021-09-13 19:20:16 +08:00
youkjw
9294950ab5 修复不传sign_type导致request sign_type无默认值的bug (#480)
* 接入关闭订单

* test

* 删除testing,过不了ci

* 避免err覆盖

* 修复不传sign_type导致request sign_type无默认值的bug

* 修复不传sign_type导致request sign_type无默认值的bug

Co-authored-by: liujianwei <liujianwei@linghit.com>
2021-09-13 18:58:56 +08:00
Afeyer
d776f5c400 feat:微信客服支持向客户发送欢迎语 (#478)
* feat:微信客服支持向客户发送欢迎语

* chore: go fmt file

* feat:移除空白文件
2021-09-13 10:07:18 +08:00
Afeyer
bc9f483c8e feat: 菜单消息支持发送结束文本 (#477)
* feat:菜单消息支持发送结束文本

Co-authored-by: Afeyer <afeyer@h5base.cn>
2021-09-10 10:08:49 +08:00
JerryTam
d3d91b8d29 实例化Redis新增dialOpts参数以支持redis更多拨号设置 (#475)
* 实例化Redis新dialOpts参数以支持redis更多拨号设置

* debug

* gofmt file

* remove go.mod empty line

Co-authored-by: Jerry <prc.tzy@gmail.com>
2021-09-09 12:22:02 +08:00
houseme
96c1f98944 [feature] Format the code and improve Mini Program authorization to o… (#473)
* [feature] Format the code and improve Mini Program authorization to obtain openid(miniprogram/auth/auth.go Code2Session)

* [feature] CheckEncryptedData (https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/user-info/auth.checkEncryptedData.html)

* upgrade json error

* upgrade json error

Co-authored-by: houseme <houseme@outlook.com>
2021-09-08 11:03:23 +08:00
George Wang
47adf42208 修复微信支付缺少notify_url的bug (#472) 2021-09-08 10:11:06 +08:00
youkjw
39ed108b11 接入微信关闭订单 (#471)
* 接入关闭订单

* test

* 删除testing,过不了ci

* 避免err覆盖

Co-authored-by: liujianwei <liujianwei@linghit.com>
2021-09-07 16:07:23 +08:00
George Wang
f767b72872 增加urllink (#465)
* 增加urllink

* urllink.Generate返回string作为结果
2021-09-06 20:53:29 +08:00
Daguang
d3f1a83d46 增加shortlink.generate (#467)
* init

* init

* init

* 小程序 shortLink
2021-09-06 12:19:17 +08:00
silenceper
db205405ee 针对会话存档,增加tags条件编译,避免默认编译不通过 (#460) 2021-09-03 16:47:06 +08:00
Afeyer
e1ef3ea160 feat:暴露接待人员ID到消息列表 (#461)
* 添加微信客服SDK

* polish:优化签名函数

* polish:优化注释内容

* polish:复用已有的Token以及CommonError,移除无用的输出

* polish:复用已有的消息加解密

* fix:修复错误信息被覆盖的问题

* polish:go fmt 文件

* polish:客服链接支持自定义参数并更新注释文档内容

* feat:支持微信客服回调请求的校验和消息的解析,复用原有的Signature和DecryptMsg方法

* feat:对外暴露SDKApiForbidden等错误

可以通过调用升级服务相关接口然后根据该错误判断微信客服配置来源

* feat:添加无效的open_kfid错误信息

* fix: 添加SDKApiNotOpen 错误信息

目前主要用于判断客户是否关闭了API授权,如果客户关闭了API功能导致服务异常,则可以引导用户执行相应的操作重新开启改功能

* feat:暴露接待人员ID到消息列表

无需对消息进行序列化即可直接获取接待人员ID,便于处理接待人员的相关业务,例如:统计接待人员当天应答次数

* feat: 添加SDKNotUseInWeCom错误信息

如果SDK输出当前错误,则说明用户在企业微信后台关闭了微信客服功能,需引导用户重新开启该功能

Co-authored-by: Afeyer <afeyer@h5base.cn>
2021-09-03 16:46:44 +08:00
silenceper
b9f0e8368d Update README.md (#457) 2021-08-31 20:29:49 +08:00
silenceper
9335b13807 Update README.md (#456) 2021-08-31 20:29:19 +08:00
silenceper
3afe499e70 update release-2.0 (#454)
* merge branch release-2.0 to v2 (#450)

* feat: add/delete subscribe template (#449)

* feat: 添加 SDKApiNotOpen 错误信息 (#448)

* 添加微信客服SDK

* polish:优化签名函数

* polish:优化注释内容

* polish:复用已有的Token以及CommonError,移除无用的输出

* polish:复用已有的消息加解密

* fix:修复错误信息被覆盖的问题

* polish:go fmt 文件

* polish:客服链接支持自定义参数并更新注释文档内容

* feat:支持微信客服回调请求的校验和消息的解析,复用原有的Signature和DecryptMsg方法

* feat:对外暴露SDKApiForbidden等错误

可以通过调用升级服务相关接口然后根据该错误判断微信客服配置来源

* feat:添加无效的open_kfid错误信息

* fix: 添加SDKApiNotOpen 错误信息

目前主要用于判断客户是否关闭了API授权,如果客户关闭了API功能导致服务异常,则可以引导用户执行相应的操作重新开启改功能

Co-authored-by: Afeyer <afeyer@h5base.cn>

Co-authored-by: ZmJ <wzmmmmj@gmail.com>
Co-authored-by: Afeyer <1500527791@qq.com>
Co-authored-by: Afeyer <afeyer@h5base.cn>

* Update go.yml (#452)

* 修正字段问题 (#451)

fix #443

* fix linux build failed when cgo disable (#453)

Co-authored-by: ZmJ <wzmmmmj@gmail.com>
Co-authored-by: Afeyer <1500527791@qq.com>
Co-authored-by: Afeyer <afeyer@h5base.cn>
2021-08-30 18:39:41 +08:00
Afeyer
beb2f9506d feat: 添加 SDKApiNotOpen 错误信息 (#448)
* 添加微信客服SDK

* polish:优化签名函数

* polish:优化注释内容

* polish:复用已有的Token以及CommonError,移除无用的输出

* polish:复用已有的消息加解密

* fix:修复错误信息被覆盖的问题

* polish:go fmt 文件

* polish:客服链接支持自定义参数并更新注释文档内容

* feat:支持微信客服回调请求的校验和消息的解析,复用原有的Signature和DecryptMsg方法

* feat:对外暴露SDKApiForbidden等错误

可以通过调用升级服务相关接口然后根据该错误判断微信客服配置来源

* feat:添加无效的open_kfid错误信息

* fix: 添加SDKApiNotOpen 错误信息

目前主要用于判断客户是否关闭了API授权,如果客户关闭了API功能导致服务异常,则可以引导用户执行相应的操作重新开启改功能

Co-authored-by: Afeyer <afeyer@h5base.cn>
2021-08-30 10:13:04 +08:00
ZmJ
b535cd116a feat: add/delete subscribe template (#449) 2021-08-30 10:12:23 +08:00
silenceper
3cfa9e6c71 企业会话存档只在linux平台支持 (#447) 2021-08-26 18:51:30 +08:00
80d91d8316 使用双检锁优化 Token 获取 (#444) 2021-08-26 10:34:24 +08:00
Afeyer
c61154105b feat:对外暴露SDKApiForbidden等错误 (#445)
* 添加微信客服SDK

* polish:优化签名函数

* polish:优化注释内容

* polish:复用已有的Token以及CommonError,移除无用的输出

* polish:复用已有的消息加解密

* fix:修复错误信息被覆盖的问题

* polish:go fmt 文件

* polish:客服链接支持自定义参数并更新注释文档内容

* feat:支持微信客服回调请求的校验和消息的解析,复用原有的Signature和DecryptMsg方法

* feat:对外暴露SDKApiForbidden等错误

可以通过调用升级服务相关接口然后根据该错误判断微信客服配置来源
2021-08-26 10:00:39 +08:00
ZmJ
d392ff776b 补充 添加/删除 公众号模板消息接口 (#440)
* provide add/delete officialaccount template api

* use util.DecodeWithError check errcode
2021-08-25 10:18:49 +08:00
George Wang
df82432f6c 增加订单查询接口中的trade_state参数 (#442) 2021-08-24 18:17:27 +08:00
Afeyer
917f1817e5 feat:支持微信客服回调请求的校验和消息的解析,复用原有的Signature和DecryptMsg方法 (#439)
* 添加微信客服SDK

* polish:优化签名函数

* polish:优化注释内容

* polish:复用已有的Token以及CommonError,移除无用的输出

* polish:复用已有的消息加解密

* fix:修复错误信息被覆盖的问题

* polish:go fmt 文件

* polish:客服链接支持自定义参数并更新注释文档内容

* feat:支持微信客服回调请求的校验和消息的解析,复用原有的Signature和DecryptMsg方法
2021-08-19 21:33:14 +08:00
Afeyer
6fdb986911 feat:微信客服链接支持自定义参数 (#438)
* 添加微信客服SDK

* polish:优化签名函数

* polish:优化注释内容

* polish:复用已有的Token以及CommonError,移除无用的输出

* polish:复用已有的消息加解密

* fix:修复错误信息被覆盖的问题

* polish:go fmt 文件

* polish:客服链接支持自定义参数并更新注释文档内容
2021-08-18 10:55:37 +08:00
Afeyer
8ceabc2d0b 添加微信客服SDK (#436)
* 添加微信客服SDK

* polish:优化签名函数

* polish:优化注释内容

* polish:复用已有的Token以及CommonError,移除无用的输出

* polish:复用已有的消息加解密

* fix:修复错误信息被覆盖的问题

* polish:go fmt 文件
2021-08-17 10:19:01 +08:00
ZmJ
fc1fc7e84e 快捷获取公众号订阅消息对象 (#435)
* 快捷获取公众号订阅消息对象

* fix: typo subscrib -> subscribe
2021-08-16 14:39:44 +08:00
notHugh
13611466f3 增加订单失效时间的参数 (#432)
* 增加订单失效时间的参数

* fix error
golangci-lint:
Function 'PrePayOrder' has too many statements

* 增加一个支持 APP 支付的 Bridge 函数
2021-08-16 14:36:57 +08:00
silenceper
08008e1c86 fix #417: CouponFeed0 CouponFeed1 CouponFeed2字段映射失败 (#427) 2021-07-30 14:23:47 +08:00
silenceper
01addecd53 Revert "fix #417: CouponFeed0 CouponFeed1 CouponFeed2字段映射失败 (#424)" (#426)
This reverts commit 4433fc18a6.
2021-07-30 14:19:52 +08:00
silenceper
4433fc18a6 fix #417: CouponFeed0 CouponFeed1 CouponFeed2字段映射失败 (#424) 2021-07-30 14:16:49 +08:00
silenceper
e8c90848e4 Update feature.md 2021-07-27 10:07:39 +08:00
silenceper
6df8453378 Update bug.md 2021-07-23 15:53:11 +08:00
silenceper
2ff99d41dc Update feature.md 2021-07-23 15:51:55 +08:00
silenceper
b1144e3a38 Update feature.md 2021-07-23 15:51:36 +08:00
silenceper
51778fab8f Update question.md 2021-07-23 15:50:37 +08:00
silenceper
6edaa7888a Rename api--.md to feature.md 2021-07-23 15:49:41 +08:00
silenceper
b27dca624f Rename ----.md to question.md 2021-07-23 15:49:30 +08:00
silenceper
3f9aed72cd Rename --bug.md to bug.md 2021-07-23 15:49:10 +08:00
silenceper
dc508f7341 Update issue templates 2021-07-23 15:46:36 +08:00
Afeyer
1005807328 添加企业微信会话存档SDK (#419)
* 添加企业微信会话存档SDK

* 更新说明文档

* 更新包名为msgaudit并更新说明文档

* 迁移会话存档SDK到work目录下

* 移动RSA文件到util并添加动态库文件

* 整合企业微信和会话存档配置文件

* 修复golangcli-lint提示中的错误

* 对整个项目进行gofmt

* 更新会话存档说明文档

* 会话存档消息获取是抛出error

* 更新会话存档说明文档

Co-authored-by: Afeyer <afeyer@h5base.cn>
2021-07-22 17:45:14 +08:00
从小就很酷
c1e4e2c9d0 增加企业微信 企业内部开发模块 (#418)
* 增加小程序内容安全接口

* 内容安全接口 按照golint规范进行优化

* 内容安全接口 按照golint规范进行优化

* 删除CheckImage中的输出代码

* 小程序内容安全接口

* 小程序内容安全接口

* 小程序内容安全接口
1:修改返回值 改为error异常统一返回

* 增加企业微信 企业内部开发模块
1:授权登录

* 增加企业微信 企业内部开发模块

* 修改参数为小写

* 优化参数格式

Co-authored-by: root <admin@example.com>
2021-07-16 10:28:54 +08:00
从小就很酷
c8522f1875 小程序内容安全 (#415)
* 增加小程序内容安全接口

* 内容安全接口 按照golint规范进行优化

* 内容安全接口 按照golint规范进行优化

* 删除CheckImage中的输出代码

* 小程序内容安全接口

* 小程序内容安全接口

* 小程序内容安全接口
1:修改返回值 改为error异常统一返回

Co-authored-by: root <admin@example.com>
2021-07-13 20:49:47 +08:00
silenceper
5d8fd1f5bd fix 恢复直接使用enc.SetEscapeHTML参数 (#412)
Co-authored-by: zhenlinwen <zhenlinwen@tencent.com>
2021-06-23 09:49:41 +08:00
HUCHAOQI
45caf61899 Silenceper release 2.0 (#408)
* feat(miniapp): 增加统一服务消息

* feat(miniapp): 增加获取微信运动数据接口

* refactor(werun): 更改werun的位置

* fix(lint): 更改stuct名称

Co-authored-by: hyperq <hyperq1g@gmail>
2021-06-10 10:28:01 +08:00
silenceper
b42f1e1a7f Update README.md (#407) 2021-06-08 11:52:03 +08:00
Lien Li
2f88fad0bd 支持解密 分享数据 得到 openGId (#406)
* 支持解密 分享数据 

https://developers.weixin.qq.com/miniprogram/dev/api/share/wx.getShareInfo.html

* fix fmt
2021-06-07 10:26:54 +08:00
Lien Li
13e5b3938b Update encryptor.go (#405) 2021-06-07 10:23:49 +08:00
MengYX
828ba7875b fix: incorrect redigo version (#404) 2021-06-07 10:04:45 +08:00
lanbiaowan
7a513080a8 addNews return error (#401)
Co-authored-by: p_biaolan <biao.lan@qingteng.cn>
2021-06-07 10:03:56 +08:00
faith
0e8fc3f88b [付款] pay.go 增加 GetTransfer 方法 (#400) 2021-05-28 09:39:32 +08:00
silenceper
c95b844c83 Update README.md 2021-05-26 15:19:04 +08:00
ForrestSu
34f1335d17 feat: 优化MixMessage采用指针传参,减少2次拷贝 (#394) 2021-04-18 18:55:32 +08:00
ForrestSu
fb1aa60ae8 feat(officialaccount): 补充群发消息event (#393)
* feat(officialaccount): 补充群发消息event

* feat: 解析群发结果通知中的成功失败数
2021-04-18 18:50:24 +08:00
ForrestSu
18abebe4de fix: 微信群发预览接口: 只支持单个用户,默认发给第一个 (#392) 2021-04-18 18:48:56 +08:00
silenceper
5472ac979b fix 修改参数类型为interface{},支持string和number (#390) 2021-04-12 16:06:14 +08:00
HUCHAOQI
5ec4cc2269 feat(miniapp): 增加统一服务消息 (#385)
Co-authored-by: hyperq <hyperq1g@gmail>
2021-04-12 15:56:10 +08:00
水煮牛肉
d1241790cb 增加ocr相关接口 (#388)
Co-authored-by: qiq@pvc123.com <qiq@pvc123.com>
2021-04-12 15:29:14 +08:00
Alfred
813684e555 fix: 微信支付退款请求参数签名类型不可选 (#383)
* fix: 微信支付退款请求参数签名类型不可选

* fix: 修复微信退款请求参数问题,out_trade_no OR transaction_id 不可选

* fix: 误删NotifyURL

* fix: 误删SignType

* fix: 修复 golangci-lint 失败

* refactor: 增加GetSignParam方法

* chore: 调整 go.mod

* refactor: 调整参数
2021-03-10 17:26:01 +08:00
Alfred
7ca0317d84 feat: 新增微信支付查询结果 (#380)
* feat: 增加微信支付查询结果

* feat: 增加微信支付查询结果

* fix: 修复golangci-lint失败

* fix: 修复golangci-lint失败

* refactor: 微信支付结果查询错误友好提示
2021-03-05 15:34:46 +08:00
baiyuxiong
ad3cc913b0 修改退款 bug 及增加付款到零钱的支付 (#373)
* fix refund bug and add transfer to wallet support

* fmt code

* fix golangci-lint

* fix golangci-lint
2021-03-05 11:46:13 +08:00
bugstark
64c2de7ab4 Add subscribe message #371 (#376)
* Fix subscribe #371

* Fix subscribe #371

* 规范struct元素名称
2021-03-05 11:27:05 +08:00
GargantuaX
e7fdcf9534 支持公众号账号迁移,获取openID变化接口 (#370)
* * 公众号菜单管理,set相关函数,返回btn本身,方便以字面量的方式创建多个菜单,更直观,方便管理

* * golangci-lint fix

* * 获取二维码ticket接口没有往上抛接口错误

* * 增加GetOpenID方法,以获取消息的生产用户openID

* * 支持公众号账号迁移,获取openID变化接口

* * bugfix

* * golint fix

* * golint fix
2021-03-01 15:38:54 +08:00
GargantuaX
05907d152e 消息增加GetOpenID方法 (#368)
* * 公众号菜单管理,set相关函数,返回btn本身,方便以字面量的方式创建多个菜单,更直观,方便管理

* * golangci-lint fix

* * 获取二维码ticket接口没有往上抛接口错误

* * 增加GetOpenID方法,以获取消息的生产用户openID
2021-02-19 15:50:02 +08:00
kaiiak
398f2ec6ae long url to short url (#367)
* long url to short url

* Decode by util.DecodeWithError
2021-02-08 09:42:46 +08:00
GargantuaX
e8fb058740 * 公众号菜单管理,增加new相关函数,老的set相关函数,返回btn本身,以便用字面量的方式创建多级菜单,更直观,方便管理 (#365)
* * 公众号菜单管理,set相关函数,返回btn本身,方便以字面量的方式创建多个菜单,更直观,方便管理

* * golangci-lint fix

* * 获取二维码ticket接口没有往上抛接口错误
2021-02-07 09:50:53 +08:00
LouGaZen
d5a67eaf29 微信支付 - 退款通知 (#359)
* 🆕 发起退款 - 添加notify_url参数

* 🆕 退款通知
2021-02-07 09:49:43 +08:00
mlboy
e5f0d5eab7 Update README.md (#358)
fix import
2021-01-26 14:11:38 +08:00
silenceper
2eae660002 修复SetMenuByJSON和AddConditionalByJSON报错 (#353)
* change PostJSON to HTTPPost

* change PostJSON to HTTPPost
2020-12-31 13:52:13 +08:00
silenceper
c0da806e03 update golangci (#349)
* update golangci
2020-11-26 12:25:57 +08:00
Che Kun
185baa5d12 公众号网页授权后获取用户基本信息支持语言入参 #344 (#345) 2020-11-26 12:09:58 +08:00
qufo
bf42c188cb Update README.md (#347)
fix typo
2020-11-21 22:06:01 +08:00
1307super
53b0f26688 增加群发消息的预览,群发状态,群发速度 (#332)
* 增加群发消息的预览,群发状态,群发速度

* Update broadcast.go

* Update broadcast.go

* 修复开放平台代公众号jssdk bug
2020-10-24 22:10:01 +08:00
Elvin
430277c947 #330 PreOrder增加H5支付的mweb_url字段 (#335) 2020-10-21 15:08:36 +08:00
NaRro
71e3ddaab3 fix(platform): 修复jsTicket使用了错误的appID的问题. (#331)
而第三方平台开发者代替公众号使用 JS SDK 的步骤如下:
1、在申请第三方平台时填写的网页开发域名,将作为旗下授权公众号的 JS SDK 安全域名(详情见“接入前必读”-“申请资料说明”)
2、在第三方平台的网页中正常引入 JS 文件
3、通过 config 接口注入权限验证配置,但在获取 jsapi_ticket 时,不通过公众号的 access_token 来获取,而是通过第三方平台的授权公众号 token(公众号授权给第三方平台后,第三方平台通过“接口说明”中的 api_authorizer_token 接口得到的 token),来获取 jsapi_ticket,然后使用这个 jsapi_ticket 来得到 signature,进行 JS SDK 的配置和开发。**注意 JS SDK 的其他配置中,其他信息均为正常的公众号的资料(而非第三方平台的)**。
4、通过 ready 接口处理成功验证
5、通过 error 接口处理失败验证

fix: #329.
2020-10-16 11:05:26 +08:00
huangx
0505969439 add CommonToken and MiniProgramMixMessage (#323)
Co-authored-by: huangxiang <huangxiang@didichuxing.com>
2020-08-29 18:50:48 +08:00
silenceper
3014901b48 补全 golint (#322) 2020-08-27 16:33:42 +08:00
huangx
2e191c0a44 feature: 小程序增加客服消息 (#319)
* add miniprogram customer_message

* fix golint comment

* rm unnecessary unmarshal in Send

Co-authored-by: huangxiang <huangxiang@didichuxing.com>
2020-08-27 13:46:36 +08:00
huangx
4c35924b8c feature: 公众号客服消息增加「小程序卡片消息」类型;添加 GetCustomerMessageManager (#320)
* fix officialaccount customer_message

* fix golint comment

Co-authored-by: huangxiang <huangxiang@didichuxing.com>
2020-08-25 19:41:53 +08:00
huangx
ed508654a1 bugfix officialaccount/message/template json non-pointer error (#318)
Co-authored-by: huangxiang <huangxiang@didichuxing.com>
2020-08-17 17:30:04 +08:00
huangx
a18fe5b58a add miniprogram/subscribe listTemplates (#314)
Co-authored-by: huangxiang <huangxiang@didichuxing.com>
2020-08-17 15:29:59 +08:00
huangx
a6eb2eedc3 check errcode in ListUserOpenIDs (#312)
Co-authored-by: huangxiang <huangxiang@didichuxing.com>
2020-08-11 09:46:59 +08:00
NaRro
404d522d09 feat: 增加获取第三方公众号授权链接的接口 (#310) 2020-08-08 16:57:31 +08:00
NaRro
6f2bd492fc fix: platform wx oauth and js config issue. (#302)
* fix: platform wx oauth and js config issue.

fix silenceper/wechat#301.

* fix: platform query auth code error not detected.

* feat: migrate platform oauth and js api.

* fix: func name
2020-08-01 20:44:01 +08:00
heyangfan
811d71c35b 标签管理 (#297)
* 用户标签管理

* 用户标签管理
修改错误注释

* 修复错误未处理的问题
修改Id 为ID

* 标签管理

* 改为user struct调用

* Id to ID

* OpenIDList 改为TagOpenIDList

* 修复部分问题

* TagID int变更为int32 与GetUserInfo接口返回的Tid 类型一致
2020-07-29 11:06:02 +08:00
silenceper
1fe872be66 缺失 commonError (#303) 2020-07-09 10:03:25 +08:00
Amor
ff38e6bac0 feat:add template list method (#298) 2020-07-07 19:08:02 +08:00
Amor
c956f416a5 fix:material url (#299) 2020-07-07 19:01:25 +08:00
Amor
5fea6d5965 feat:add material news update (#295) 2020-07-07 17:30:02 +08:00
Amor
a8763dd6c9 fix:material media type (#296) 2020-07-07 17:27:22 +08:00
Amor
df9889d982 feat: get material count (#292)
* feat: get material count
2020-07-06 20:03:43 +08:00
silenceper
7fe7e21cb2 add GetRefund (#286) 2020-06-24 17:43:35 +08:00
silenceper
a5c6eb300d Update README.md 2020-06-24 14:53:24 +08:00
silenceper
868b31cb3d fix golangci-lint failed (#284)
* fix golangci-lint error
2020-06-24 14:36:33 +08:00
silenceper
b5c70cc206 增加 golangci-lint actions (#268)
* Update go.yml
2020-06-24 14:19:48 +08:00
EvaCcino
69d0b94fdf fix:修复微信回调signType为空的问题 #282 (#283)
Co-authored-by: Avtion <manaitao@heywoods.cn>
2020-06-23 13:26:15 +08:00
huang wei
c14c020a3c fix some bugs (#277)
* fix payRequset xml marshal: root element should be xml

* support HMAC-SHA256 for unifiedorder api

* support HMAC-SHA256 for PaidVerifySign

* fix SignType is nil

* fix code style

* constantize SignType

* add comments

* fix code style
2020-06-14 23:23:58 +08:00
Liangwt
fe31f04640 增加微信公众号数据统计功能 (#279)
* * fix: 移除代码中的Println

* 增加公众号数据统计

* fix code style
2020-06-14 23:18:09 +08:00
silenceper
2ccc15b050 Add 贡献者 (#274) 2020-06-05 15:17:23 +08:00
silenceper
3d7d60644f 开发平台,将GetServer单独提取 (#273)
* 添加TODO:待完善接口

* 【模板消息】将message.DataItem改为message.TemplateDataItem

* fix PKG.DEV

* 增加一个 SetRedisPool 方法

* fix:模板消息推送增加一个TemplateMsgID

* fix 开放平台服务端处理
2020-06-05 14:21:49 +08:00
方航
5d9705ddc8 Update menu.go (#271)
* Update menu.go

json: cannot unmarshal string into Go struct field MatchRule.conditionalmenu.matchrule.group_id of type int32
接口返回是字符串
"matchrule": {
"group_id": "2"
}

结构体定义
//MatchRule 个性化菜单规则
type MatchRule struct {
GroupID int32 json:"group_id,omitempty"
...
}

* matchrule字段均是字符串

 "matchrule": {
        "tag_id": "2", 
        "sex": "1", 
        "country": "中国", 
        "province": "广东", 
        "city": "广州", 
        "client_platform_type": "2", 
        "language": "zh_CN"
    }
2020-05-31 17:40:29 +08:00
silenceper
63f2226974 Update README.md 2020-05-30 15:53:11 +08:00
silenceper
3a1221e7ed 添加小程序发送订阅消息 (#267) 2020-05-30 13:57:39 +08:00
silenceper
6c06c05233 增加一个 TemplateMsgID,适配微信微信msgID和msgId问题 (#266)
* 添加TODO:待完善接口

* 【模板消息】将message.DataItem改为message.TemplateDataItem

* fix PKG.DEV

* 增加一个 SetRedisPool 方法

* fix:模板消息推送增加一个TemplateMsgID
2020-05-30 13:32:11 +08:00
silenceper
2af3f42055 增加SetRedisPool方法 (#265)
* 添加TODO:待完善接口

* 【模板消息】将message.DataItem改为message.TemplateDataItem

* fix PKG.DEV

* 增加一个 SetRedisPool 方法
2020-05-30 12:38:51 +08:00
silenceper
c4cb394d80 Feature v2 (#264)
* 添加TODO:待完善接口

* 【模板消息】将message.DataItem改为message.TemplateDataItem

* fix PKG.DEV
2020-05-30 12:16:56 +08:00
silenceper
681e86e3d4 Update README.md 2020-05-30 11:59:49 +08:00
silenceper
6fe797765f Update README.md 2020-05-30 08:26:53 +08:00
silenceper
74e965b207 Update README.md 2020-05-30 08:25:04 +08:00
silenceper
0e23fa3fee 优化小程序解密 (#262) 2020-05-30 08:08:03 +08:00
silenceper
351cf65621 添加菜单-支持json方式 (#261) 2020-05-30 07:39:24 +08:00
silenceper
f3e3564178 实现批量获取素材 (#260) 2020-05-30 06:58:15 +08:00
silenceper
5e8e16444c 群发消息接口 (#259)
* 添加TODO:待完善接口

* 【模板消息】将message.DataItem改为message.TemplateDataItem

* 【群发消息】基本框架

* 群发消息-基本方法

* fix golint

* fix:SendWxCard log
2020-05-29 23:17:04 +08:00
silenceper
880ab20a6b Merge pull request #255 from silenceper/feature-v2
将原始消息内容暴露
2020-05-26 21:51:42 +08:00
silenceper
66369c9541 将原始消息内容暴露 2020-05-26 21:50:17 +08:00
silenceper
58092a21de testCase:使用gock模拟http接口数据 2020-05-25 23:27:24 +08:00
silenceper
01f83c20d5 Merge pull request #254 from silenceper/feature-v2
将获取AccessToken和jsTicket单独抽象为interface
2020-05-25 22:35:03 +08:00
silenceper
972dec0406 将小程序获取ak的方式也抽象出来 2020-05-25 22:00:51 +08:00
silenceper
b599e93c5b 将获取AccessToken和jsTicket单独抽象为interface 2020-05-25 21:55:42 +08:00
silenceper
f77ee8dd2e Merge pull request #251 from silenceper/feature-v2
添加版本说明
2020-05-24 22:23:48 +08:00
silenceper
c89d24990c 添加版本说明 2020-05-24 22:23:08 +08:00
silenceper
e6a61a5ec7 Merge pull request #249 from silenceper/feature-v2
fix readme
2020-05-24 21:38:06 +08:00
silenceper
4326efae54 fix readme 2020-05-24 21:37:16 +08:00
silenceper
5d3f4be9a2 Merge pull request #248 from silenceper/feature-v2
添加example链接
2020-05-24 21:35:48 +08:00
silenceper
9b5bb79a72 添加example链接 2020-05-24 21:34:53 +08:00
silenceper
a4a388aef7 Merge pull request #247 from silenceper/feature-v2
新增基础接口
2020-05-24 18:32:13 +08:00
silenceper
7a4230414d 1、新增基础接口-清理接口调用次数
2、fix 多客服消息转发文件名错误
2020-05-24 17:56:10 +08:00
silenceper
239fe1d758 Merge pull request #246 from silenceper/feature-getip
添加获取微信服务器IP接口
2020-05-24 16:27:15 +08:00
silenceper
3f7690cf24 Merge branch 'feature-getip' of https://github.com/silenceper/wechat into feature-getip 2020-05-24 01:43:55 +08:00
silenceper
2e94f61043 解决冲突 2020-05-24 01:43:27 +08:00
silenceper
a3ce22df79 添加获取微信服务器IP接口 2020-05-24 01:41:14 +08:00
silenceper
f9a2c15361 Merge pull request #243 from silenceper/silenceper-patch-2
Delete .travis.yml
2020-05-23 13:30:14 +08:00
silenceper
3360ee7752 Delete .travis.yml 2020-05-23 13:30:04 +08:00
silenceper
9c0cde64e5 Merge pull request #242 from silenceper/silenceper-patch-1
Update README.md
2020-05-23 13:24:14 +08:00
silenceper
748fe17e72 Update README.md 2020-05-23 13:15:08 +08:00
185 changed files with 11775 additions and 1327 deletions

View File

@@ -1,2 +1,3 @@
## 问题及现象 ## 问题及现象
<!-- 描述你的问题现象,报错**贴截图**粘贴或者贴具体信息,提供**必要的代码段** <!-- 描述你的问题现象,报错**贴截图**粘贴或者贴具体信息,提供**必要的代码段**

21
.github/ISSUE_TEMPLATE/bug.md vendored Normal file
View File

@@ -0,0 +1,21 @@
---
name: 报告Bug
about: 反馈BUG信息
title: "[BUG]"
labels: bug
assignees: ''
---
**描述**
**如何复现**
步骤:
1、
2、
**关联日志信息**
**使用的版本**
- SDK版本: [比如 v0.0.0]

15
.github/ISSUE_TEMPLATE/feature.md vendored Normal file
View File

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

15
.github/ISSUE_TEMPLATE/question.md vendored Normal file
View File

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

View File

@@ -2,49 +2,50 @@ name: Go
on: on:
push: push:
branches: [ master,release-* ] branches: [ master,release-*,v2 ]
pull_request: pull_request:
branches: [ master,release-* ] branches: [ master,release-*,v2 ]
jobs: jobs:
golangci:
strategy:
matrix:
go-version: [1.15.x,1.16.x,1.17.x]
name: golangci-lint
runs-on: ubuntu-latest
steps:
- uses: actions/setup-go@v2
- uses: actions/checkout@v2
- name: golangci-lint
uses: golangci/golangci-lint-action@v3.1.0
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
build: build:
name: Build name: Test
runs-on: ubuntu-latest runs-on: ubuntu-latest
services: services:
redis: redis:
image: redis image: redis
ports: ports:
- 6379:6379 - 6379:6379
options: --entrypoint redis-server options: --entrypoint redis-server
memcached: memcached:
image: memcached image: memcached
ports: ports:
- 11211:11211 - 11211:11211
steps:
# strategy set
strategy:
matrix:
go: ["1.15", "1.16", "1.17", "1.18"]
steps:
- uses: actions/checkout@v2
- name: Set up Go 1.x - name: Set up Go 1.x
uses: actions/setup-go@v2 uses: actions/setup-go@v2
with: with:
go-version: ^1.13 go-version: ${{ matrix.go }}
id: go id: go
- name: Check out code into the Go module directory
uses: actions/checkout@v2
- name: Get dependencies
run: |
go get -v -t -d ./...
if [ -f Gopkg.toml ]; then
curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
dep ensure
fi
- name: Lint Go Code
run: |
export PATH=$PATH:$(go env GOPATH)/bin # temporary fix. See https://github.com/actions/setup-go/issues/14
go get -u golang.org/x/lint/golint
go vet ./...
golint -set_exit_status $(go list ./...)
- name: Test - name: Test
run: go test -v -race ./... run: go test -v -race ./...

29
.github/workflows/release.yml vendored Normal file
View File

@@ -0,0 +1,29 @@
name: goreleaser
on:
push:
tags:
- '*'
jobs:
goreleaser:
runs-on: ubuntu-latest
steps:
-
name: Checkout
uses: actions/checkout@v2
with:
fetch-depth: 0
-
name: Set up Go
uses: actions/setup-go@v2
with:
go-version: 1.15
-
name: Run GoReleaser
uses: goreleaser/goreleaser-action@v2
with:
version: latest
args: release --rm-dist
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

3
.gitignore vendored
View File

@@ -26,4 +26,5 @@ _testmain.go
.vscode/ .vscode/
vendor vendor
.idea/ .idea/
example/* example/*
/test

66
.golangci.yml Normal file
View File

@@ -0,0 +1,66 @@
linters:
# please, do not use `enable-all`: it's deprecated and will be removed soon.
# inverted configuration with `enable-all` and `disable` is not scalable during updates of golangci-lint
disable-all: true
enable:
- bodyclose
- deadcode
- depguard
- dogsled
- dupl
- errcheck
- funlen
- goconst
# - gocritic
- gocyclo
- gofmt
- goimports
- golint
- goprintffuncname
- gosimple
- govet
- ineffassign
- interfacer
- misspell
- nolintlint
- rowserrcheck
- scopelint
- staticcheck
- structcheck
- stylecheck
- typecheck
- unconvert
- unparam
- unused
- varcheck
- whitespace
issues:
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
# https://github.com/go-critic/go-critic/issues/926
- linters:
- gocritic
text: "unnecessaryDefer:"
linters-settings:
funlen:
lines: 66
statements: 40
#issues:
# include:
# - EXC0002 # disable excluding of issues about comments from golint
# exclude-rules:
# - linters:
# - stylecheck
# text: "ST1000:"

29
.goreleaser.yml Normal file
View File

@@ -0,0 +1,29 @@
# This is an example goreleaser.yaml file with some sane defaults.
# Make sure to check the documentation at http://goreleaser.com
before:
hooks:
# You may remove this if you don't use go modules.
- go mod download
# you may remove this if you don't need go generate
- go generate ./...
builds:
- skip: true
archives:
- replacements:
darwin: Darwin
linux: Linux
windows: Windows
386: i386
amd64: x86_64
checksum:
name_template: 'checksums.txt'
snapshot:
name_template: "{{ .Tag }}-next"
changelog:
sort: asc
filters:
exclude:
- '^docs:'
- '^test:'

View File

@@ -1,20 +0,0 @@
language: go
go:
- 1.13.x
- 1.12.x
- 1.11.x
- 1.10.x
services:
- memcached
- redis-server
before_script:
- GO_FILES=$(find . -iname '*.go' -type f | grep -v /vendor/)
- go get golang.org/x/lint/golint
script:
- go test -v -race ./...
- go vet ./...
- golint -set_exit_status $(go list ./...)

View File

@@ -1,66 +1,83 @@
# WeChat SDK for Go # WeChat SDK for Go
[![Build Status](https://travis-ci.org/silenceper/wechat.svg?branch=release-2.0)](https://travis-ci.org/silenceper/wechat)
![Go](https://github.com/silenceper/wechat/workflows/Go/badge.svg?branch=release-2.0)
[![Go Report Card](https://goreportcard.com/badge/github.com/silenceper/wechat)](https://goreportcard.com/report/github.com/silenceper/wechat) [![Go Report Card](https://goreportcard.com/badge/github.com/silenceper/wechat)](https://goreportcard.com/report/github.com/silenceper/wechat)
[![GoDoc](http://godoc.org/github.com/silenceper/wechat?status.svg)](http://godoc.org/github.com/silenceper/wechat) [![pkg](https://img.shields.io/badge/dev-reference-007d9c?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/silenceper/wechat/v2?tab=doc)
![version](https://img.shields.io/badge/version-v2-green)
使用Golang开发的微信SDK简单、易用。 使用Golang开发的微信SDK简单、易用。
> 注意当前版本为v2版本v1版本已废弃
## 文档 && 例子
[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"
```
以下是一个微信公众号处理消息接收以及回复的例子: 以下是一个微信公众号处理消息接收以及回复的例子:
```go ```go
//使用memcache保存access_token也可选择redis或自定义cache // 使用memcache保存access_token也可选择redis或自定义cache
wc := wechat.NewWechat() wc := wechat.NewWechat()
memory := cache.NewMemory() memory := cache.NewMemory()
cfg := &offConfig.Config{ cfg := &offConfig.Config{
AppID: "xxx", AppID: "xxx",
AppSecret: "xxx", AppSecret: "xxx",
Token: "xxx", Token: "xxx",
//EncodingAESKey: "xxxx", // EncodingAESKey: "xxxx",
Cache: memory, Cache: memory,
} }
officialAccount := wc.GetOfficialAccount(cfg) officialAccount := wc.GetOfficialAccount(cfg)
// 传入request和responseWriter // 传入request和responseWriter
server := officialAccount.GetServer(req, rw) server := officialAccount.GetServer(req, rw)
//设置接收消息的处理方法 // 设置接收消息的处理方法
server.SetMessageHandler(func(msg message.MixMessage) *message.Reply { server.SetMessageHandler(func(msg *message.MixMessage) *message.Reply {
//回复消息:演示回复用户发送的消息 // 回复消息:演示回复用户发送的消息
text := message.NewText(msg.Content) text := message.NewText(msg.Content)
return &message.Reply{MsgType: message.MsgTypeText, MsgData: text} return &message.Reply{MsgType: message.MsgTypeText, MsgData: text}
}) })
//处理消息接收以及回复 // 处理消息接收以及回复
err := server.Serve() err := server.Serve()
if err != nil { if err != nil {
fmt.Println(err) fmt.Println(err)
return return
} }
//发送回复的消息 // 发送回复的消息
server.Send() server.Send()
``` ```
## 文档
[Wechat SDK 2.0 文档](http://silenceper.com/wechat)
## 目录说明 ## 目录说明
- officialaccount: 微信公众号API - officialaccount: 微信公众号API
- miniprogram: 小程序API - miniprogram: 小程序API
- minigame:小游戏API - minigame:小游戏API
- pay:微信支付API - pay:微信支付API
- opernplatform:开放平台API - openplatform:开放平台API
- work:企业微信 - work:企业微信
- aispeech:智能对话 - aispeech:智能对话
- doc: api文档
## 如何贡献 ## 贡献
- 在[API列表](https://github.com/silenceper/wechat/tree/v2/doc/api)中查看哪些API未实现
- 提交issue描述需要贡献的内容 - 提交issue描述需要贡献的内容
- 完成更改后提交PR - 完成更改后提交PR
## 公众号
![img](https://silenceper.oss-cn-beijing.aliyuncs.com/qrcode/search_study_program.png)
## License ## License

2
cache/cache.go vendored
View File

@@ -2,7 +2,7 @@ package cache
import "time" import "time"
//Cache interface // Cache interface
type Cache interface { type Cache interface {
Get(key string) interface{} Get(key string) interface{}
Set(key string, val interface{}, timeout time.Duration) error Set(key string, val interface{}, timeout time.Duration) error

10
cache/memcache.go vendored
View File

@@ -7,18 +7,18 @@ import (
"github.com/bradfitz/gomemcache/memcache" "github.com/bradfitz/gomemcache/memcache"
) )
//Memcache struct contains *memcache.Client // Memcache struct contains *memcache.Client
type Memcache struct { type Memcache struct {
conn *memcache.Client conn *memcache.Client
} }
//NewMemcache create new memcache // NewMemcache create new memcache
func NewMemcache(server ...string) *Memcache { func NewMemcache(server ...string) *Memcache {
mc := memcache.New(server...) mc := memcache.New(server...)
return &Memcache{mc} return &Memcache{mc}
} }
//Get return cached value // Get return cached value
func (mem *Memcache) Get(key string) interface{} { func (mem *Memcache) Get(key string) interface{} {
var err error var err error
var item *memcache.Item var item *memcache.Item
@@ -40,7 +40,7 @@ func (mem *Memcache) IsExist(key string) bool {
return true return true
} }
//Set cached value with key and expire time. // Set cached value with key and expire time.
func (mem *Memcache) Set(key string, val interface{}, timeout time.Duration) (err error) { func (mem *Memcache) Set(key string, val interface{}, timeout time.Duration) (err error) {
var data []byte var data []byte
if data, err = json.Marshal(val); err != nil { if data, err = json.Marshal(val); err != nil {
@@ -51,7 +51,7 @@ func (mem *Memcache) Set(key string, val interface{}, timeout time.Duration) (er
return mem.conn.Set(item) return mem.conn.Set(item)
} }
//Delete delete value in memcache. // Delete delete value in memcache.
func (mem *Memcache) Delete(key string) error { func (mem *Memcache) Delete(key string) error {
return mem.conn.Delete(key) return mem.conn.Delete(key)
} }

View File

@@ -3,6 +3,9 @@ package cache
import ( import (
"testing" "testing"
"time" "time"
"github.com/bradfitz/gomemcache/memcache"
"github.com/stretchr/testify/assert"
) )
func TestMemcache(t *testing.T) { func TestMemcache(t *testing.T) {
@@ -16,13 +19,22 @@ func TestMemcache(t *testing.T) {
if !mem.IsExist("username") { if !mem.IsExist("username") {
t.Error("IsExist Error") t.Error("IsExist Error")
} }
exists := mem.IsExist("unknown-key")
assert.Equal(t, false, exists)
name := mem.Get("username").(string) name := mem.Get("username").(string)
if name != "silenceper" { if name != "" {
t.Error("get Error") if name != "silenceper" {
t.Error("get Error")
}
} }
data := mem.Get("unknown-key")
assert.Nil(t, data)
if err = mem.Delete("username"); err != nil { if err = mem.Delete("username"); err != nil {
t.Errorf("delete Error , err=%v", err) t.Errorf("delete Error , err=%v", err)
} }
err = mem.Delete("unknown-key")
assert.Equal(t, memcache.ErrCacheMiss, err)
} }

16
cache/memory.go vendored
View File

@@ -5,7 +5,7 @@ import (
"time" "time"
) )
//Memory struct contains *memcache.Client // Memory struct contains *memcache.Client
type Memory struct { type Memory struct {
sync.Mutex sync.Mutex
@@ -17,14 +17,14 @@ type data struct {
Expired time.Time Expired time.Time
} }
//NewMemory create new memcache // NewMemory create new memcache
func NewMemory() *Memory { func NewMemory() *Memory {
return &Memory{ return &Memory{
data: map[string]*data{}, data: map[string]*data{},
} }
} }
//Get return cached value // Get return cached value
func (mem *Memory) Get(key string) interface{} { func (mem *Memory) Get(key string) interface{} {
if ret, ok := mem.data[key]; ok { if ret, ok := mem.data[key]; ok {
if ret.Expired.Before(time.Now()) { if ret.Expired.Before(time.Now()) {
@@ -48,7 +48,7 @@ func (mem *Memory) IsExist(key string) bool {
return false 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) { func (mem *Memory) Set(key string, val interface{}, timeout time.Duration) (err error) {
mem.Lock() mem.Lock()
defer mem.Unlock() defer mem.Unlock()
@@ -60,15 +60,15 @@ func (mem *Memory) Set(key string, val interface{}, timeout time.Duration) (err
return nil return nil
} }
//Delete delete value in memcache. // Delete delete value in memcache.
func (mem *Memory) Delete(key string) error { func (mem *Memory) Delete(key string) error {
return mem.deleteKey(key) mem.deleteKey(key)
return nil
} }
// deleteKey // deleteKey
func (mem *Memory) deleteKey(key string) error { func (mem *Memory) deleteKey(key string) {
mem.Lock() mem.Lock()
defer mem.Unlock() defer mem.Unlock()
delete(mem.data, key) delete(mem.data, key)
return nil
} }

109
cache/redis.go vendored
View File

@@ -1,109 +1,72 @@
package cache package cache
import ( import (
"encoding/json" "context"
"time" "time"
"github.com/gomodule/redigo/redis" "github.com/go-redis/redis/v8"
) )
//Redis redis cache // Redis .redis cache
type Redis struct { type Redis struct {
conn *redis.Pool ctx context.Context
conn redis.UniversalClient
} }
//RedisOpts redis 连接属性 // RedisOpts redis 连接属性
type RedisOpts struct { type RedisOpts struct {
Host string `yml:"host" json:"host"` Host string `yml:"host" json:"host"`
Password string `yml:"password" json:"password"` Password string `yml:"password" json:"password"`
Database int `yml:"database" json:"database"` Database int `yml:"database" json:"database"`
MaxIdle int `yml:"max_idle" json:"max_idle"` MaxIdle int `yml:"max_idle" json:"max_idle"`
MaxActive int `yml:"max_active" json:"max_active"` MaxActive int `yml:"max_active" json:"max_active"`
IdleTimeout int32 `yml:"idle_timeout" json:"idle_timeout"` //second IdleTimeout int `yml:"idle_timeout" json:"idle_timeout"` // second
} }
//NewRedis 实例化 // NewRedis 实例化
func NewRedis(opts *RedisOpts) *Redis { func NewRedis(ctx context.Context, opts *RedisOpts) *Redis {
pool := &redis.Pool{ conn := redis.NewUniversalClient(&redis.UniversalOptions{
MaxActive: opts.MaxActive, Addrs: []string{opts.Host},
MaxIdle: opts.MaxIdle, DB: opts.Database,
IdleTimeout: time.Second * time.Duration(opts.IdleTimeout), Password: opts.Password,
Dial: func() (redis.Conn, error) { IdleTimeout: time.Second * time.Duration(opts.IdleTimeout),
return redis.Dial("tcp", opts.Host, MinIdleConns: opts.MaxIdle,
redis.DialDatabase(opts.Database), })
redis.DialPassword(opts.Password), return &Redis{ctx: ctx, conn: conn}
)
},
TestOnBorrow: func(conn redis.Conn, t time.Time) error {
if time.Since(t) < time.Minute {
return nil
}
_, err := conn.Do("PING")
return err
},
}
return &Redis{pool}
} }
//SetConn 设置conn // SetConn 设置conn
func (r *Redis) SetConn(conn *redis.Pool) { func (r *Redis) SetConn(conn redis.UniversalClient) {
r.conn = conn 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{} { func (r *Redis) Get(key string) interface{} {
conn := r.conn.Get() result, err := r.conn.Do(r.ctx, "GET", key).Result()
defer conn.Close() if err != nil {
var data []byte
var err error
if data, err = redis.Bytes(conn.Do("GET", key)); err != nil {
return nil return nil
} }
var reply interface{} return result
if err = json.Unmarshal(data, &reply); err != nil {
return nil
}
return reply
} }
//Set 设置一个值 // Set 设置一个值
func (r *Redis) Set(key string, val interface{}, timeout time.Duration) (err error) { func (r *Redis) Set(key string, val interface{}, timeout time.Duration) error {
conn := r.conn.Get() return r.conn.SetEX(r.ctx, key, val, timeout).Err()
defer conn.Close()
var data []byte
if data, err = json.Marshal(val); err != nil {
return
}
_, err = conn.Do("SETEX", key, int64(timeout/time.Second), data)
return
} }
//IsExist 判断key是否存在 // IsExist 判断key是否存在
func (r *Redis) IsExist(key string) bool { func (r *Redis) IsExist(key string) bool {
conn := r.conn.Get() result, _ := r.conn.Exists(r.ctx, key).Result()
defer conn.Close()
a, _ := conn.Do("EXISTS", key) return result > 0
i := a.(int64)
if i > 0 {
return true
}
return false
} }
//Delete 删除 // Delete 删除
func (r *Redis) Delete(key string) error { func (r *Redis) Delete(key string) error {
conn := r.conn.Get() return r.conn.Del(r.ctx, key).Err()
defer conn.Close()
if _, err := conn.Do("DEL", key); err != nil {
return err
}
return nil
} }

30
cache/redis_test.go vendored
View File

@@ -1,32 +1,40 @@
package cache package cache
import ( import (
"context"
"testing" "testing"
"time" "time"
) )
func TestRedis(t *testing.T) { func TestRedis(t *testing.T) {
opts := &RedisOpts{ var (
Host: "127.0.0.1:6379", timeoutDuration = time.Second
} ctx = context.Background()
redis := NewRedis(opts) opts = &RedisOpts{
var err error Host: "127.0.0.1:6379",
timeoutDuration := 1 * time.Second }
redis = NewRedis(ctx, opts)
err error
val = "silenceper"
key = "username"
)
redis.SetConn(redis.conn)
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) t.Error("set Error", err)
} }
if !redis.IsExist("username") { if !redis.IsExist(key) {
t.Error("IsExist Error") t.Error("IsExist Error")
} }
name := redis.Get("username").(string) name := redis.Get(key).(string)
if name != "silenceper" { if name != val {
t.Error("get Error") 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) t.Errorf("delete Error , err=%v", err)
} }
} }

View File

@@ -0,0 +1,6 @@
package credential
// AccessTokenHandle AccessToken 接口
type AccessTokenHandle interface {
GetAccessToken() (accessToken string, err error)
}

View File

@@ -0,0 +1,157 @@
package credential
import (
"encoding/json"
"fmt"
"sync"
"time"
"github.com/silenceper/wechat/v2/cache"
"github.com/silenceper/wechat/v2/util"
)
const (
// AccessTokenURL 获取access_token的接口
accessTokenURL = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=%s&secret=%s"
// AccessTokenURL 企业微信获取access_token的接口
workAccessTokenURL = "https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=%s&corpsecret=%s"
// CacheKeyOfficialAccountPrefix 微信公众号cache key前缀
CacheKeyOfficialAccountPrefix = "gowechat_officialaccount_"
// CacheKeyMiniProgramPrefix 小程序cache key前缀
CacheKeyMiniProgramPrefix = "gowechat_miniprogram_"
// CacheKeyWorkPrefix 企业微信cache key前缀
CacheKeyWorkPrefix = "gowechat_work_"
)
// DefaultAccessToken 默认AccessToken 获取
type DefaultAccessToken struct {
appID string
appSecret string
cacheKeyPrefix string
cache cache.Cache
accessTokenLock *sync.Mutex
}
// NewDefaultAccessToken new DefaultAccessToken
func NewDefaultAccessToken(appID, appSecret, cacheKeyPrefix string, cache cache.Cache) AccessTokenHandle {
if cache == nil {
panic("cache is ineed")
}
return &DefaultAccessToken{
appID: appID,
appSecret: appSecret,
cache: cache,
cacheKeyPrefix: cacheKeyPrefix,
accessTokenLock: new(sync.Mutex),
}
}
// ResAccessToken struct
type ResAccessToken struct {
util.CommonError
AccessToken string `json:"access_token"`
ExpiresIn int64 `json:"expires_in"`
}
// GetAccessToken 获取access_token,先从cache中获取没有则从服务端获取
func (ak *DefaultAccessToken) GetAccessToken() (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
}
// 加上lock是为了防止在并发获取token时cache刚好失效导致从微信服务器上获取到不同token
ak.accessTokenLock.Lock()
defer ak.accessTokenLock.Unlock()
// 双检,防止重复从微信服务器获取
if val := ak.cache.Get(accessTokenCacheKey); val != nil {
return val.(string), nil
}
// cache失效从微信服务器获取
var resAccessToken ResAccessToken
resAccessToken, err = GetTokenFromServer(fmt.Sprintf(accessTokenURL, ak.appID, ak.appSecret))
if err != nil {
return
}
expires := resAccessToken.ExpiresIn - 1500
err = ak.cache.Set(accessTokenCacheKey, resAccessToken.AccessToken, time.Duration(expires)*time.Second)
if err != nil {
return
}
accessToken = resAccessToken.AccessToken
return
}
// WorkAccessToken 企业微信AccessToken 获取
type WorkAccessToken struct {
CorpID string
CorpSecret string
cacheKeyPrefix string
cache cache.Cache
accessTokenLock *sync.Mutex
}
// NewWorkAccessToken new WorkAccessToken
func NewWorkAccessToken(corpID, corpSecret, cacheKeyPrefix string, cache cache.Cache) AccessTokenHandle {
if cache == nil {
panic("cache the not exist")
}
return &WorkAccessToken{
CorpID: corpID,
CorpSecret: corpSecret,
cache: cache,
cacheKeyPrefix: cacheKeyPrefix,
accessTokenLock: new(sync.Mutex),
}
}
// GetAccessToken 企业微信获取access_token,先从cache中获取没有则从服务端获取
func (ak *WorkAccessToken) GetAccessToken() (accessToken string, err error) {
// 加上lock是为了防止在并发获取token时cache刚好失效导致从微信服务器上获取到不同token
ak.accessTokenLock.Lock()
defer ak.accessTokenLock.Unlock()
accessTokenCacheKey := fmt.Sprintf("%s_access_token_%s", ak.cacheKeyPrefix, ak.CorpID)
val := ak.cache.Get(accessTokenCacheKey)
if val != nil {
accessToken = val.(string)
return
}
// cache失效从微信服务器获取
var resAccessToken ResAccessToken
resAccessToken, err = GetTokenFromServer(fmt.Sprintf(workAccessTokenURL, ak.CorpID, ak.CorpSecret))
if err != nil {
return
}
expires := resAccessToken.ExpiresIn - 1500
err = ak.cache.Set(accessTokenCacheKey, resAccessToken.AccessToken, time.Duration(expires)*time.Second)
if err != nil {
return
}
accessToken = resAccessToken.AccessToken
return
}
// GetTokenFromServer 强制从微信服务器获取token
func GetTokenFromServer(url string) (resAccessToken ResAccessToken, err error) {
var body []byte
body, err = util.HTTPGet(url)
if err != nil {
return
}
err = json.Unmarshal(body, &resAccessToken)
if err != nil {
return
}
if resAccessToken.ErrCode != 0 {
err = fmt.Errorf("get access_token error : errcode=%v , errormsg=%v", resAccessToken.ErrCode, resAccessToken.ErrMsg)
return
}
return
}

View File

@@ -0,0 +1,19 @@
package credential
import (
"testing"
"github.com/stretchr/testify/assert"
"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})
ticket, err := GetTicketFromServer("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")
}

View File

@@ -0,0 +1,87 @@
package credential
import (
"encoding/json"
"fmt"
"sync"
"time"
"github.com/silenceper/wechat/v2/cache"
"github.com/silenceper/wechat/v2/util"
)
// getTicketURL 获取ticket的url
const getTicketURL = "https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=%s&type=jsapi"
// DefaultJsTicket 默认获取js ticket方法
type DefaultJsTicket struct {
appID string
cacheKeyPrefix string
cache cache.Cache
// jsAPITicket 读写锁 同一个AppID一个
jsAPITicketLock *sync.Mutex
}
// NewDefaultJsTicket new
func NewDefaultJsTicket(appID string, cacheKeyPrefix string, cache cache.Cache) JsTicketHandle {
return &DefaultJsTicket{
appID: appID,
cache: cache,
cacheKeyPrefix: cacheKeyPrefix,
jsAPITicketLock: new(sync.Mutex),
}
}
// ResTicket 请求jsapi_tikcet返回结果
type ResTicket struct {
util.CommonError
Ticket string `json:"ticket"`
ExpiresIn int64 `json:"expires_in"`
}
// GetTicket 获取jsapi_ticket
func (js *DefaultJsTicket) GetTicket(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
}
js.jsAPITicketLock.Lock()
defer js.jsAPITicketLock.Unlock()
// 双检,防止重复从微信服务器获取
if val := js.cache.Get(jsAPITicketCacheKey); val != nil {
return val.(string), nil
}
var ticket ResTicket
ticket, err = GetTicketFromServer(accessToken)
if err != nil {
return
}
expires := ticket.ExpiresIn - 1500
err = js.cache.Set(jsAPITicketCacheKey, ticket.Ticket, time.Duration(expires)*time.Second)
ticketStr = ticket.Ticket
return
}
// GetTicketFromServer 从服务器中获取ticket
func GetTicketFromServer(accessToken string) (ticket ResTicket, err error) {
var response []byte
url := fmt.Sprintf(getTicketURL, accessToken)
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
}

7
credential/js_ticket.go Normal file
View File

@@ -0,0 +1,7 @@
package credential
// JsTicketHandle js ticket获取
type JsTicketHandle interface {
// GetTicket 获取ticket
GetTicket(accessToken string) (ticket string, err error)
}

17
doc/api/README.md Normal file
View 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
View File

@@ -0,0 +1,3 @@
# 智能对话
TODO

3
doc/api/minigame.md Normal file
View File

@@ -0,0 +1,3 @@
# 小游戏
TODO

50
doc/api/miniprogram.md Normal file
View 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 |

219
doc/api/officialaccount.md Normal file
View File

@@ -0,0 +1,219 @@
# 微信公众号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 | NO | |
| 添加客服帐号 | POST | /customservice/kfaccount/add | NO | |
| 邀请绑定客服帐号 | POST | /customservice/kfaccount/inviteworker | NO | |
| 设置客服信息 | POST | /customservice/kfaccount/update | NO | |
| 上传客服头像 | POST/FORM | /customservice/kfaccount/uploadheadimg | NO | |
| 删除客服帐号 | GET | /customservice/kfaccount/del | NO | |
#### 会话控制
[官方文档](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)
说明:「发表记录」包括群发和发布。
注意:该接口,只能处理 "发布" 相关的信息,无法操作和获取 "群发" 相关内容!![官方回复](https://developers.weixin.qq.com/community/develop/doc/0002a4fb2109d8f7a91d421c556c00)
- 群发:主动推送给粉丝,历史消息可看,被搜一搜收录,可以限定部分的粉丝接收到。
- 发布:不会主动推给粉丝,历史消息列表看不到,但是是公开给所有人的文章。也不会占用群发的次数。每天可以发布多篇内容。可以用于自动回复、自定义菜单、页面模板和话题中,发布成功时会生成一个永久链接。
| 名称 | 请求方式 | 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 |
## 图文消息留言管理
## 用户管理
## 账号管理
## 数据统计
## 微信卡券
## 微信门店
## 智能接口
## 微信设备功能
## 微信“一物一码”
## 微信发票
## 微信非税缴费

1
doc/api/oplatform.md Normal file
View File

@@ -0,0 +1 @@
# 开放平台

74
doc/api/work.md Normal file
View File

@@ -0,0 +1,74 @@
# 企业微信
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)
| 名称 | 请求方式 | 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 |
## 应用管理
TODO

3
doc/api/wxpay.md Normal file
View File

@@ -0,0 +1,3 @@
# 微信支付
TODO

15
go.mod
View File

@@ -1,12 +1,15 @@
module github.com/silenceper/wechat/v2 module github.com/silenceper/wechat/v2
go 1.14 go 1.15
require ( require (
github.com/bradfitz/gomemcache v0.0.0-20190913173617-a41fca850d0b github.com/bradfitz/gomemcache v0.0.0-20220106215444-fb4bf637b56d
github.com/fatih/structs v1.1.0 github.com/fatih/structs v1.1.0
github.com/gomodule/redigo v1.8.1 github.com/go-redis/redis/v8 v8.11.5
github.com/sirupsen/logrus v1.6.0 github.com/sirupsen/logrus v1.9.0
github.com/spf13/cast v1.3.1 github.com/spf13/cast v1.4.1
golang.org/x/crypto v0.0.0-20200510223506-06a226fb4e37 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
) )

146
go.sum
View File

@@ -1,33 +1,145 @@
github.com/bradfitz/gomemcache v0.0.0-20190913173617-a41fca850d0b h1:L/QXpzIa3pOvUGt1D1lA5KjYhPBAN/3iWdP7xeFS9F0= github.com/bradfitz/gomemcache v0.0.0-20220106215444-fb4bf637b56d h1:pVrfxiGfwelyab6n21ZBkbkmbevaf+WvMIiR7sr97hw=
github.com/bradfitz/gomemcache v0.0.0-20190913173617-a41fca850d0b/go.mod h1:H0wQNHz2YrLsuXOZozoeDmnHXkNCRmMW0gwFWDfEZDA= github.com/bradfitz/gomemcache v0.0.0-20220106215444-fb4bf637b56d/go.mod h1:H0wQNHz2YrLsuXOZozoeDmnHXkNCRmMW0gwFWDfEZDA=
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8= 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.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 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= 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/fatih/structs v1.1.0/go.mod h1:9NiDSp5zOcgEDl+j00MP/WkGVPOlPRLejGD8Ga6PJ7M=
github.com/gomodule/redigo v1.8.1 h1:Abmo0bI7Xf0IhdIPc7HZQzZcShdnmxeoVuDDtIQp8N8= github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
github.com/gomodule/redigo v1.8.1/go.mod h1:P9dn9mFrCBvWhGE1wpxx6fgq7BAeLBk+UUUzlpkBYO0= github.com/fsnotify/fsnotify v1.4.9 h1:hsms1Qyu0jgnwNXIxa+/V/PDsU6CfLf6CNO8H7IWoS4=
github.com/konsorten/go-windows-terminal-sequences v1.0.3 h1:CE8S1cTafDpPvMhIxNJKvHsGVBgn1xWYf1NbHQhywc8= github.com/fsnotify/fsnotify v1.4.9/go.mod h1:znqG4EE+3YCdAaPaxE2ZRY/06pZUdp0tY4IgpuI1SZQ=
github.com/konsorten/go-windows-terminal-sequences v1.0.3/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ= 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 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw=
github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY=
github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
github.com/google/go-cmp v0.3.1/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38/go.mod h1:kpwsk12EmLew5upagYY7GY0pfYCcupk39gWOCRROcvE=
github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 h1:2VTzZjLZBgl62/EtslCrtky5vbi9dd7HrQPQIx6wqiw=
github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542/go.mod h1:Ow0tF8D4Kplbc8s8sSb3V2oUCygFHVp8gC3Dn6U4MNI=
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/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 h1:CcuG/HvWNkkaqCUpJifQY8z7qEMBJya6aLPx6ftGyjQ=
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/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/sirupsen/logrus v1.6.0 h1:UBcNElsrwanuuMsnGSlYmtmgbb23qDR5dG+6X6Oo89I= github.com/sirupsen/logrus v1.9.0 h1:trlNQbNUG3OdDrDil03MCb1H2o9nJ1x4/5LYw7byDE0=
github.com/sirupsen/logrus v1.6.0/go.mod h1:7uNnSEd1DgxDLC74fIahvMZmmYsHGZGEOFrfsX/uA88= github.com/sirupsen/logrus v1.9.0/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
github.com/spf13/cast v1.3.1/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE= 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/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.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.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA=
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/stretchr/testify v1.7.1 h1:5TQK59W5E3v0r2duFAb7P95B6hEeOyEnHRa8MjYSMTY=
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
github.com/tidwall/gjson v1.14.1 h1:iymTbGkQBhveq21bEvAQ81I0LEBork8BFe1CUZXdyuo=
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=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20200510223506-06a226fb4e37 h1:cg5LA/zNPRzIXIWSCxQW10Rvpy94aQh3LT/ShoCpkHw= golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
golang.org/x/crypto v0.0.0-20200510223506-06a226fb4e37/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3 h1:0GoQqolDA55aaLxZyTzK/Y2ePZzZTUrRacwib7cNsYQ= 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-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-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20190422165155-953cdadca894 h1:Cz4ceDQGXuKRnVBDTS23GTn/pU5OE2C0WrNTOYK1Uuc= golang.org/x/sys v0.0.0-20190904154756-749cb33beabd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20191005200804-aed5e4c7ecf9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg= 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.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 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE=
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLYBciE7Vtevhsrf46CRTquxDuWsQurQQe4oz8=
google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0=
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 h1:bxAC2xTBsZGibn2RTntX0oH50xLsqy1OxA9tTL3p/lk=
google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw= 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.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=

View File

@@ -3,6 +3,7 @@
[官方文档](https://developers.weixin.qq.com/minigame/dev/api-backend/) [官方文档](https://developers.weixin.qq.com/minigame/dev/api-backend/)
## 快速入门 ## 快速入门
```go ```go
``` ```

View File

@@ -2,11 +2,12 @@
[官方文档](https://developers.weixin.qq.com/miniprogram/dev/framework/) [官方文档](https://developers.weixin.qq.com/miniprogram/dev/framework/)
## 包说明 ## 包说明
- analysis 数据分析相关API - analysis 数据分析相关API
## 快速入门 ## 快速入门
```go ```go
wc := wechat.NewWechat() wc := wechat.NewWechat()
memory := cache.NewMemory() memory := cache.NewMemory()

View File

@@ -32,12 +32,12 @@ const (
getAnalysisVisitPageURL = "https://api.weixin.qq.com/datacube/getweanalysisappidvisitpage?access_token=%s" getAnalysisVisitPageURL = "https://api.weixin.qq.com/datacube/getweanalysisappidvisitpage?access_token=%s"
) )
//Analysis analyis 数据分析 // Analysis analyis 数据分析
type Analysis struct { type Analysis struct {
*context.Context *context.Context
} }
//NewAnalysis new // NewAnalysis new
func NewAnalysis(ctx *context.Context) *Analysis { func NewAnalysis(ctx *context.Context) *Analysis {
return &Analysis{ctx} return &Analysis{ctx}
} }
@@ -125,7 +125,7 @@ func (analysis *Analysis) GetAnalysisDailySummary(beginDate, endDate string) (re
if err != nil { if err != nil {
return return
} }
fmt.Println(string(response))
err = json.Unmarshal(response, &result) err = json.Unmarshal(response, &result)
if err != nil { if err != nil {
return return

View File

@@ -1,6 +1,7 @@
package auth package auth
import ( import (
context2 "context"
"encoding/json" "encoding/json"
"fmt" "fmt"
@@ -10,14 +11,18 @@ import (
const ( const (
code2SessionURL = "https://api.weixin.qq.com/sns/jscode2session?appid=%s&secret=%s&js_code=%s&grant_type=authorization_code" code2SessionURL = "https://api.weixin.qq.com/sns/jscode2session?appid=%s&secret=%s&js_code=%s&grant_type=authorization_code"
checkEncryptedDataURL = "https://api.weixin.qq.com/wxa/business/checkencryptedmsg?access_token=%s"
getPhoneNumber = "https://api.weixin.qq.com/wxa/business/getuserphonenumber?access_token=%s"
) )
//Auth 登录/用户信息 // Auth 登录/用户信息
type Auth struct { type Auth struct {
*context.Context *context.Context
} }
//NewAuth new auth // NewAuth new auth
func NewAuth(ctx *context.Context) *Auth { func NewAuth(ctx *context.Context) *Auth {
return &Auth{ctx} return &Auth{ctx}
} }
@@ -31,16 +36,26 @@ type ResCode2Session struct {
UnionID string `json:"unionid"` // 用户在开放平台的唯一标识符在满足UnionID下发条件的情况下会返回 UnionID string `json:"unionid"` // 用户在开放平台的唯一标识符在满足UnionID下发条件的情况下会返回
} }
//Code2Session 登录凭证校验。 // RspCheckEncryptedData .
type RspCheckEncryptedData struct {
util.CommonError
Vaild bool `json:"vaild"` // 是否是合法的数据
CreateTime uint `json:"create_time"` // 加密数据生成的时间戳
}
// Code2Session 登录凭证校验。
func (auth *Auth) Code2Session(jsCode string) (result ResCode2Session, err error) { 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 var response []byte
response, err = util.HTTPGet(urlStr) if response, err = util.HTTPGetContext(ctx, fmt.Sprintf(code2SessionURL, auth.AppID, auth.AppSecret, jsCode)); err != nil {
if err != nil {
return return
} }
err = json.Unmarshal(response, &result) if err = json.Unmarshal(response, &result); err != nil {
if err != nil {
return return
} }
if result.ErrCode != 0 { if result.ErrCode != 0 {
@@ -50,7 +65,86 @@ func (auth *Auth) Code2Session(jsCode string) (result ResCode2Session, err error
return return
} }
//GetPaidUnionID 用户支付完成后,获取该用户的 UnionId无需用户授权 // GetPaidUnionID 用户支付完成后,获取该用户的 UnionId无需用户授权
func (auth *Auth) GetPaidUnionID() { func (auth *Auth) GetPaidUnionID() {
//TODO // TODO
}
// 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.GetAccessToken(); 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.GetAccessToken(); 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
if err = util.DecodeWithError(response, &result, "phonenumber.getPhoneNumber"); err != nil {
return nil, err
}
return &result, nil
}
// GetPhoneNumber 小程序通过code获取用户手机号
func (auth *Auth) GetPhoneNumber(code string) (*GetPhoneNumberResponse, error) {
return auth.GetPhoneNumberContext(context2.Background(), code)
} }

View File

@@ -1,15 +0,0 @@
package basic
import "github.com/silenceper/wechat/v2/miniprogram/context"
//Basic struct
type Basic struct {
*context.Context
}
//NewBasic 实例
func NewBasic(context *context.Context) *Basic {
basic := new(Basic)
basic.Context = context
return basic
}

View 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}
}

View File

@@ -0,0 +1,54 @@
package business
import (
"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) {
accessToken, err := business.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(getPhoneNumberURL, accessToken)
response, err := util.PostJSON(uri, in)
if err != nil {
return
}
// 使用通用方法返回错误
var resp struct {
util.CommonError
PhoneInfo PhoneInfo `json:"phone_info"`
}
err = util.DecodeWithError(response, &resp, "business.GetPhoneNumber")
if nil != err {
return
}
info = resp.PhoneInfo
return
}

View File

@@ -1,12 +1,13 @@
// Package config 小程序config配置
package config package config
import ( import (
"github.com/silenceper/wechat/v2/cache" "github.com/silenceper/wechat/v2/cache"
) )
//Config config for 小程序 // Config .config for 小程序
type Config struct { type Config struct {
AppID string `json:"app_id"` //appid AppID string `json:"app_id"` // appid
AppSecret string `json:"app_secret"` //appsecret AppSecret string `json:"app_secret"` // appSecret
Cache cache.Cache Cache cache.Cache
} }

View File

@@ -0,0 +1,65 @@
package content
import (
"fmt"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/util"
)
const (
checkTextURL = "https://api.weixin.qq.com/wxa/msg_sec_check?access_token=%s"
checkImageURL = "https://api.weixin.qq.com/wxa/img_sec_check?access_token=%s"
)
// Content 内容安全
type Content struct {
*context.Context
}
// NewContent 内容安全接口
func NewContent(ctx *context.Context) *Content {
return &Content{ctx}
}
// CheckText 检测文字
// @text 需要检测的文字
// Deprecated
// 采用 security.MsgCheckV1 替代,返回值更加丰富
func (content *Content) CheckText(text string) error {
accessToken, err := content.GetAccessToken()
if err != nil {
return err
}
response, err := util.PostJSON(
fmt.Sprintf(checkTextURL, accessToken),
map[string]string{
"content": text,
},
)
if err != nil {
return err
}
return util.DecodeWithCommonError(response, "ContentCheckText")
}
// 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 {
return err
}
response, err := util.PostFile(
"media",
media,
fmt.Sprintf(checkImageURL, accessToken),
)
if err != nil {
return err
}
return util.DecodeWithCommonError(response, "ContentCheckImage")
}

View File

@@ -1,87 +0,0 @@
package context
import (
"encoding/json"
"fmt"
"sync"
"time"
"github.com/silenceper/wechat/v2/util"
)
const (
//AccessTokenURL 获取access_token的接口
AccessTokenURL = "https://api.weixin.qq.com/cgi-bin/token"
//CacheKeyPrefix cache前缀
CacheKeyPrefix = "gowechat_miniprogram_"
)
//ResAccessToken struct
type ResAccessToken struct {
util.CommonError
AccessToken string `json:"access_token"`
ExpiresIn int64 `json:"expires_in"`
}
//GetAccessTokenFunc 获取 access token 的函数签名
type GetAccessTokenFunc func(ctx *Context) (accessToken string, err error)
//SetAccessTokenLock 设置读写锁一个appID一个读写锁
func (ctx *Context) SetAccessTokenLock(l *sync.RWMutex) {
ctx.accessTokenLock = l
}
//SetGetAccessTokenFunc 设置自定义获取accessToken的方式, 需要自己实现缓存
func (ctx *Context) SetGetAccessTokenFunc(f GetAccessTokenFunc) {
ctx.accessTokenFunc = f
}
//GetAccessToken 获取access_token
func (ctx *Context) GetAccessToken() (accessToken string, err error) {
ctx.accessTokenLock.Lock()
defer ctx.accessTokenLock.Unlock()
if ctx.accessTokenFunc != nil {
return ctx.accessTokenFunc(ctx)
}
accessTokenCacheKey := fmt.Sprintf("%s_access_token_%s", CacheKeyPrefix, ctx.AppID)
val := ctx.Cache.Get(accessTokenCacheKey)
if val != nil {
accessToken = val.(string)
return
}
//从微信服务器获取
var resAccessToken ResAccessToken
resAccessToken, err = ctx.GetAccessTokenFromServer()
if err != nil {
return
}
accessToken = resAccessToken.AccessToken
return
}
//GetAccessTokenFromServer 强制从微信服务器获取token
func (ctx *Context) GetAccessTokenFromServer() (resAccessToken ResAccessToken, err error) {
url := fmt.Sprintf("%s?grant_type=client_credential&appid=%s&secret=%s", AccessTokenURL, ctx.AppID, ctx.AppSecret)
var body []byte
body, err = util.HTTPGet(url)
if err != nil {
return
}
err = json.Unmarshal(body, &resAccessToken)
if err != nil {
return
}
if resAccessToken.ErrMsg != "" {
err = fmt.Errorf("get access_token error : errcode=%v , errormsg=%v", resAccessToken.ErrCode, resAccessToken.ErrMsg)
return
}
accessTokenCacheKey := fmt.Sprintf("%s_access_token_%s", CacheKeyPrefix, ctx.AppID)
expires := resAccessToken.ExpiresIn - 1500
err = ctx.Cache.Set(accessTokenCacheKey, resAccessToken.AccessToken, time.Duration(expires)*time.Second)
return
}

View File

@@ -1,18 +1,12 @@
package context package context
import ( import (
"sync" "github.com/silenceper/wechat/v2/credential"
"github.com/silenceper/wechat/v2/miniprogram/config" "github.com/silenceper/wechat/v2/miniprogram/config"
) )
// Context struct // Context struct
type Context struct { type Context struct {
*config.Config *config.Config
credential.AccessTokenHandle
//accessTokenLock 读写锁 同一个AppID一个
accessTokenLock *sync.RWMutex
//accessTokenFunc 自定义获取 access token 的方法
accessTokenFunc GetAccessTokenFunc
} }

View File

@@ -1,4 +1,4 @@
package basic package encryptor
import ( import (
"crypto/aes" "crypto/aes"
@@ -6,8 +6,23 @@ import (
"encoding/base64" "encoding/base64"
"encoding/json" "encoding/json"
"errors" "errors"
"fmt"
"github.com/silenceper/wechat/v2/miniprogram/context"
) )
// Encryptor struct
type Encryptor struct {
*context.Context
}
// NewEncryptor 实例
func NewEncryptor(context *context.Context) *Encryptor {
basic := new(Encryptor)
basic.Context = context
return basic
}
var ( var (
// ErrAppIDNotMatch appid不匹配 // ErrAppIDNotMatch appid不匹配
ErrAppIDNotMatch = errors.New("app id not match") ErrAppIDNotMatch = errors.New("app id not match")
@@ -19,26 +34,20 @@ var (
ErrInvalidPKCS7Padding = errors.New("invalid padding on input") ErrInvalidPKCS7Padding = errors.New("invalid padding on input")
) )
// UserInfo 用户信息 // PlainData 用户信息/手机号信息
type UserInfo struct { type PlainData struct {
OpenID string `json:"openId"` OpenID string `json:"openId"`
UnionID string `json:"unionId"` UnionID string `json:"unionId"`
NickName string `json:"nickName"` NickName string `json:"nickName"`
Gender int `json:"gender"` Gender int `json:"gender"`
City string `json:"city"` City string `json:"city"`
Province string `json:"province"` Province string `json:"province"`
Country string `json:"country"` Country string `json:"country"`
AvatarURL string `json:"avatarUrl"` AvatarURL string `json:"avatarUrl"`
Language string `json:"language"` Language string `json:"language"`
Watermark struct {
Timestamp int64 `json:"timestamp"`
AppID string `json:"appid"`
} `json:"watermark"`
}
// PhoneInfo 用户手机号
type PhoneInfo struct {
PhoneNumber string `json:"phoneNumber"` PhoneNumber string `json:"phoneNumber"`
OpenGID string `json:"openGId"`
MsgTicket string `json:"msgTicket"`
PurePhoneNumber string `json:"purePhoneNumber"` PurePhoneNumber string `json:"purePhoneNumber"`
CountryCode string `json:"countryCode"` CountryCode string `json:"countryCode"`
Watermark struct { Watermark struct {
@@ -68,8 +77,8 @@ func pkcs7Unpad(data []byte, blockSize int) ([]byte, error) {
return data[:len(data)-n], nil return data[:len(data)-n], nil
} }
// getCipherText returns slice of the cipher text // GetCipherText returns slice of the cipher text
func getCipherText(sessionKey, encryptedData, iv string) ([]byte, error) { func GetCipherText(sessionKey, encryptedData, iv string) ([]byte, error) {
aesKey, err := base64.StdEncoding.DecodeString(sessionKey) aesKey, err := base64.StdEncoding.DecodeString(sessionKey)
if err != nil { if err != nil {
return nil, err return nil, err
@@ -82,6 +91,9 @@ func getCipherText(sessionKey, encryptedData, iv string) ([]byte, error) {
if err != nil { if err != nil {
return nil, err return nil, err
} }
if len(ivBytes) != aes.BlockSize {
return nil, fmt.Errorf("bad iv length %d", len(ivBytes))
}
block, err := aes.NewCipher(aesKey) block, err := aes.NewCipher(aesKey)
if err != nil { if err != nil {
return nil, err return nil, err
@@ -96,35 +108,18 @@ func getCipherText(sessionKey, encryptedData, iv string) ([]byte, error) {
} }
// Decrypt 解密数据 // Decrypt 解密数据
func (basic *Basic) Decrypt(sessionKey, encryptedData, iv string) (*UserInfo, error) { func (encryptor *Encryptor) Decrypt(sessionKey, encryptedData, iv string) (*PlainData, error) {
cipherText, err := getCipherText(sessionKey, encryptedData, iv) cipherText, err := GetCipherText(sessionKey, encryptedData, iv)
if err != nil { if err != nil {
return nil, err return nil, err
} }
var userInfo UserInfo var plainData PlainData
err = json.Unmarshal(cipherText, &userInfo) err = json.Unmarshal(cipherText, &plainData)
if err != nil { if err != nil {
return nil, err return nil, err
} }
if userInfo.Watermark.AppID != basic.AppID { if plainData.Watermark.AppID != encryptor.AppID {
return nil, ErrAppIDNotMatch return nil, ErrAppIDNotMatch
} }
return &userInfo, nil return &plainData, nil
}
// DecryptPhone 解密数据(手机)
func (basic *Basic) DecryptPhone(sessionKey, encryptedData, iv string) (*PhoneInfo, error) {
cipherText, err := getCipherText(sessionKey, encryptedData, iv)
if err != nil {
return nil, err
}
var phoneInfo PhoneInfo
err = json.Unmarshal(cipherText, &phoneInfo)
if err != nil {
return nil, err
}
if phoneInfo.Watermark.AppID != basic.AppID {
return nil, ErrAppIDNotMatch
}
return &phoneInfo, nil
} }

View 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)
}

View File

@@ -0,0 +1,57 @@
package message
import "encoding/xml"
// MsgType 基本消息类型
type MsgType string
// EventType 事件类型
type EventType string
// InfoType 第三方平台授权事件类型
type InfoType string
const (
// MsgTypeText 文本消息
MsgTypeText MsgType = "text"
// MsgTypeImage 图片消息
MsgTypeImage = "image"
// MsgTypeLink 图文链接
MsgTypeLink = "link"
// MsgTypeMiniProgramPage 小程序卡片
MsgTypeMiniProgramPage = "miniprogrampage"
)
// CommonToken 消息中通用的结构
type CommonToken struct {
XMLName xml.Name `xml:"xml"`
ToUserName string `xml:"ToUserName"`
FromUserName string `xml:"FromUserName"`
CreateTime int64 `xml:"CreateTime"`
MsgType MsgType `xml:"MsgType"`
}
// MiniProgramMixMessage 小程序回调的消息结构
type MiniProgramMixMessage struct {
CommonToken
MsgID int64 `xml:"MsgId"`
// 文本消息
Content string `xml:"Content"`
// 图片消息
PicURL string `xml:"PicUrl"`
MediaID string `xml:"MediaId"`
// 小程序卡片消息
Title string `xml:"Title"`
AppID string `xml:"AppId"`
PagePath string `xml:"PagePath"`
ThumbURL string `xml:"ThumbUrl"`
ThumbMediaID string `xml:"ThumbMediaId"`
// 进入会话事件
Event string `xml:"Event"`
SessionFrom string `xml:"SessionFrom"`
}

View File

@@ -0,0 +1,124 @@
package message
import (
"fmt"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/util"
)
const (
customerSendMessage = "https://api.weixin.qq.com/cgi-bin/message/custom/send"
)
// Manager 消息管理者,可以发送消息
type Manager struct {
*context.Context
}
// NewCustomerMessageManager 实例化消息管理者
func NewCustomerMessageManager(context *context.Context) *Manager {
return &Manager{
context,
}
}
// MediaText 文本消息的文字
type MediaText struct {
Content string `json:"content"`
}
// MediaResource 消息使用的临时素材id
type MediaResource struct {
MediaID string `json:"media_id"`
}
// MediaMiniprogrampage 小程序卡片
type MediaMiniprogrampage struct {
Title string `json:"title"`
Appid string `json:"appid"`
Pagepath string `json:"pagepath"`
ThumbMediaID string `json:"thumb_media_id"`
}
// MediaLink 发送图文链接
type MediaLink struct {
Title string `json:"title"`
Description string `json:"description"`
URL string `json:"url"`
ThumbURL string `json:"thumb_url"`
}
// 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"` // 可选
}
// NewCustomerTextMessage 文本消息结构体构造方法
func NewCustomerTextMessage(toUser, text string) *CustomerMessage {
return &CustomerMessage{
ToUser: toUser,
Msgtype: MsgTypeText,
Text: &MediaText{
Content: text,
},
}
}
// NewCustomerImgMessage 图片消息的构造方法
func NewCustomerImgMessage(toUser, mediaID string) *CustomerMessage {
return &CustomerMessage{
ToUser: toUser,
Msgtype: MsgTypeImage,
Image: &MediaResource{
MediaID: mediaID,
},
}
}
// NewCustomerLinkMessage 图文链接消息的构造方法
func NewCustomerLinkMessage(toUser, title, description, url, thumbURL string) *CustomerMessage {
return &CustomerMessage{
ToUser: toUser,
Msgtype: MsgTypeLink,
Link: &MediaLink{
Title: title,
Description: description,
URL: url,
ThumbURL: thumbURL,
},
}
}
// NewCustomerMiniprogrampageMessage 小程序卡片消息的构造方法
func NewCustomerMiniprogrampageMessage(toUser, title, pagepath, thumbMediaID string) *CustomerMessage {
return &CustomerMessage{
ToUser: toUser,
Msgtype: MsgTypeMiniProgramPage,
Miniprogrampage: &MediaMiniprogrampage{
Title: title,
Pagepath: pagepath,
ThumbMediaID: thumbMediaID,
},
}
}
// Send 发送客服消息
func (manager *Manager) Send(msg *CustomerMessage) error {
accessToken, err := manager.Context.GetAccessToken()
if err != nil {
return err
}
uri := fmt.Sprintf("%s?access_token=%s", customerSendMessage, accessToken)
response, err := util.PostJSON(uri, msg)
if err != nil {
return err
}
return util.DecodeWithCommonError(response, "SendCustomerMessage")
}

View File

@@ -1,60 +1,128 @@
package miniprogram package miniprogram
import ( import (
"sync" "github.com/silenceper/wechat/v2/credential"
"github.com/silenceper/wechat/v2/miniprogram/analysis" "github.com/silenceper/wechat/v2/miniprogram/analysis"
"github.com/silenceper/wechat/v2/miniprogram/auth" "github.com/silenceper/wechat/v2/miniprogram/auth"
"github.com/silenceper/wechat/v2/miniprogram/basic" "github.com/silenceper/wechat/v2/miniprogram/business"
"github.com/silenceper/wechat/v2/miniprogram/config" "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/context"
"github.com/silenceper/wechat/v2/miniprogram/encryptor"
"github.com/silenceper/wechat/v2/miniprogram/message"
"github.com/silenceper/wechat/v2/miniprogram/privacy"
"github.com/silenceper/wechat/v2/miniprogram/qrcode" "github.com/silenceper/wechat/v2/miniprogram/qrcode"
"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/tcb"
"github.com/silenceper/wechat/v2/miniprogram/urllink"
"github.com/silenceper/wechat/v2/miniprogram/urlscheme"
"github.com/silenceper/wechat/v2/miniprogram/werun"
) )
//MiniProgram 微信小程序相关API // MiniProgram 微信小程序相关API
type MiniProgram struct { type MiniProgram struct {
ctx *context.Context ctx *context.Context
} }
//NewMiniProgram 实例化小程序API // NewMiniProgram 实例化小程序API
func NewMiniProgram(cfg *config.Config) *MiniProgram { func NewMiniProgram(cfg *config.Config) *MiniProgram {
if cfg.Cache == nil { defaultAkHandle := credential.NewDefaultAccessToken(cfg.AppID, cfg.AppSecret, credential.CacheKeyMiniProgramPrefix, cfg.Cache)
panic("cache未设置")
}
ctx := &context.Context{ ctx := &context.Context{
Config: cfg, Config: cfg,
AccessTokenHandle: defaultAkHandle,
} }
ctx.SetAccessTokenLock(new(sync.RWMutex))
return &MiniProgram{ctx} return &MiniProgram{ctx}
} }
// SetAccessTokenHandle 自定义access_token获取方式
func (miniProgram *MiniProgram) SetAccessTokenHandle(accessTokenHandle credential.AccessTokenHandle) {
miniProgram.ctx.AccessTokenHandle = accessTokenHandle
}
// GetContext get Context // GetContext get Context
func (miniProgram *MiniProgram) GetContext() *context.Context { func (miniProgram *MiniProgram) GetContext() *context.Context {
return miniProgram.ctx return miniProgram.ctx
} }
// GetBasic 基础接口(小程序加解密) // GetEncryptor 小程序加解密
func (miniProgram *MiniProgram) GetBasic() *basic.Basic { func (miniProgram *MiniProgram) GetEncryptor() *encryptor.Encryptor {
return basic.NewBasic(miniProgram.ctx) return encryptor.NewEncryptor(miniProgram.ctx)
} }
//GetAuth 登录/用户信息相关接口 // GetAuth 登录/用户信息相关接口
func (miniProgram *MiniProgram) GetAuth() *auth.Auth { func (miniProgram *MiniProgram) GetAuth() *auth.Auth {
return auth.NewAuth(miniProgram.ctx) return auth.NewAuth(miniProgram.ctx)
} }
//GetAnalysis 数据分析 // GetAnalysis 数据分析
func (miniProgram *MiniProgram) GetAnalysis() *analysis.Analysis { func (miniProgram *MiniProgram) GetAnalysis() *analysis.Analysis {
return analysis.NewAnalysis(miniProgram.ctx) 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 { func (miniProgram *MiniProgram) GetQRCode() *qrcode.QRCode {
return qrcode.NewQRCode(miniProgram.ctx) return qrcode.NewQRCode(miniProgram.ctx)
} }
//GetTcb 小程序云开发API // GetTcb 小程序云开发API
func (miniProgram *MiniProgram) GetTcb() *tcb.Tcb { func (miniProgram *MiniProgram) GetTcb() *tcb.Tcb {
return tcb.NewTcb(miniProgram.ctx) return tcb.NewTcb(miniProgram.ctx)
} }
// GetSubscribe 小程序订阅消息
func (miniProgram *MiniProgram) GetSubscribe() *subscribe.Subscribe {
return subscribe.NewSubscribe(miniProgram.ctx)
}
// GetCustomerMessage 客服消息接口
func (miniProgram *MiniProgram) GetCustomerMessage() *message.Manager {
return message.NewCustomerMessageManager(miniProgram.ctx)
}
// GetWeRun 微信运动接口
func (miniProgram *MiniProgram) GetWeRun() *werun.WeRun {
return werun.NewWeRun(miniProgram.ctx)
}
// GetContentSecurity 内容安全接口
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)
}

View File

@@ -0,0 +1,167 @@
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
if err = util.DecodeWithError(response, &result, "getprivacysetting"); err != nil {
return GetPrivacySettingResponse{}, err
}
return result, nil
}
// 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
}
// 返回错误信息
if err = util.DecodeWithCommonError(response, "setprivacysetting"); err != nil {
return err
}
return err
}
// 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
if err = util.DecodeWithError(response, &result, "setprivacysetting"); err != nil {
return UploadPrivacyExtFileResponse{}, err
}
return result, err
}

View File

@@ -15,12 +15,12 @@ const (
getWXACodeUnlimitURL = "https://api.weixin.qq.com/wxa/getwxacodeunlimit?access_token=%s" getWXACodeUnlimitURL = "https://api.weixin.qq.com/wxa/getwxacodeunlimit?access_token=%s"
) )
//QRCode struct // QRCode struct
type QRCode struct { type QRCode struct {
*context.Context *context.Context
} }
//NewQRCode 实例 // NewQRCode 实例
func NewQRCode(context *context.Context) *QRCode { func NewQRCode(context *context.Context) *QRCode {
qrCode := new(QRCode) qrCode := new(QRCode)
qrCode.Context = context qrCode.Context = context
@@ -40,16 +40,20 @@ type QRCoder struct {
Page string `json:"page,omitempty"` Page string `json:"page,omitempty"`
// path 扫码进入的小程序页面路径 // path 扫码进入的小程序页面路径
Path string `json:"path,omitempty"` Path string `json:"path,omitempty"`
// checkPath 检查page 是否存在,为 true 时 page 必须是已经发布的小程序存在的页面(否则报错);为 false 时允许小程序未发布或者 page 不存在, 但page 有数量上限60000个请勿滥用默认true
CheckPath *bool `json:"check_path,omitempty"`
// width 图片宽度 // width 图片宽度
Width int `json:"width,omitempty"` Width int `json:"width,omitempty"`
// scene 最大32个可见字符只支持数字大小写英文以及部分特殊字符!#$&'()*+,/:;=?@-._~,其它字符请自行编码为合法字符(因不支持%,中文无法使用 urlencode 处理,请使用其他编码方式) // scene 最大32个可见字符只支持数字大小写英文以及部分特殊字符!#$&'()*+,/:;=?@-._~,其它字符请自行编码为合法字符(因不支持%,中文无法使用 urlencode 处理,请使用其他编码方式)
Scene string `json:"scene,omitempty"` Scene string `json:"scene,omitempty"`
// autoColor 自动配置线条颜色,如果颜色依然是黑色,则说明不建议配置主色调 // autoColor 自动配置线条颜色,如果颜色依然是黑色,则说明不建议配置主色调默认false
AutoColor bool `json:"auto_color,omitempty"` AutoColor bool `json:"auto_color,omitempty"`
// lineColor AutoColor 为 false 时生效,使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"},十进制表示 // lineColor AutoColor 为 false 时生效,使用 rgb 设置颜色 例如 {"r":"xxx","g":"xxx","b":"xxx"},十进制表示
LineColor Color `json:"line_color,omitempty"` LineColor *Color `json:"line_color,omitempty"`
// isHyaline 是否需要透明底色 // isHyaline 是否需要透明底色默认false
IsHyaline bool `json:"is_hyaline,omitempty"` IsHyaline bool `json:"is_hyaline,omitempty"`
// envVersion 要打开的小程序版本。正式版为 "release",体验版为 "trial",开发版为 "develop"
EnvVersion string `json:"env_version,omitempty"`
} }
// fetchCode 请求并返回二维码二进制数据 // fetchCode 请求并返回二维码二进制数据
@@ -74,15 +78,13 @@ func (qrCode *QRCode) fetchCode(urlStr string, body interface{}) (response []byt
err = fmt.Errorf("fetchCode error : errcode=%v , errmsg=%v", result.ErrCode, result.ErrMsg) err = fmt.Errorf("fetchCode error : errcode=%v , errmsg=%v", result.ErrCode, result.ErrMsg)
return nil, err return nil, err
} }
} else if contentType == "image/jpeg" { }
if contentType == "image/jpeg" {
// 返回文件 // 返回文件
return response, nil return response, nil
} else {
err = fmt.Errorf("fetchCode error : unknown response content type - %v", contentType)
return nil, err
} }
err = fmt.Errorf("fetchCode error : unknown response content type - %v", contentType)
return return nil, err
} }
// CreateWXAQRCode 获取小程序二维码,适用于需要的码数量较少的业务场景 // CreateWXAQRCode 获取小程序二维码,适用于需要的码数量较少的业务场景

View 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
}

View File

@@ -0,0 +1,256 @@
package security
import (
"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")
if err != nil {
return
}
traceID = res.TraceID
return
}
// 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) {
accessToken, err := security.GetAccessToken()
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.PostJSON(uri, req)
if err != nil {
return
}
// 使用通用方法返回错误
var res struct {
util.CommonError
TraceID string `json:"trace_id"`
}
err = util.DecodeWithError(response, &res, "MediaCheckAsync")
if err != nil {
return
}
traceID = res.TraceID
return
}
// 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) {
accessToken, err := security.GetAccessToken()
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.PostJSON(uri, req)
if err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &res, "security.MsgCheck")
return
}

View File

@@ -0,0 +1,86 @@
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")
if err != nil {
return "", err
}
return res.Link, nil
}
// 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,
})
}

View File

@@ -0,0 +1,195 @@
package subscribe
import (
"fmt"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/util"
)
const (
// 发送订阅消息
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.send.html
subscribeSendURL = "https://api.weixin.qq.com/cgi-bin/message/subscribe/send"
// 获取当前帐号下的个人模板列表
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.getTemplateList.html
getTemplateURL = "https://api.weixin.qq.com/wxaapi/newtmpl/gettemplate"
// 添加订阅模板
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.addTemplate.html
addTemplateURL = "https://api.weixin.qq.com/wxaapi/newtmpl/addtemplate"
// 删除私有模板
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.deleteTemplate.html
delTemplateURL = "https://api.weixin.qq.com/wxaapi/newtmpl/deltemplate"
// 统一服务消息
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/uniform-message/uniformMessage.send.html
uniformMessageSend = "https://api.weixin.qq.com/cgi-bin/message/wxopen/template/uniform_send"
)
// Subscribe 订阅消息
type Subscribe struct {
*context.Context
}
// NewSubscribe 实例化
func NewSubscribe(ctx *context.Context) *Subscribe {
return &Subscribe{Context: ctx}
}
// 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
}
// DataItem 模版内某个 .DATA 的值
type DataItem struct {
Value interface{} `json:"value"`
Color string `json:"color"`
}
// 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"`
}
// TemplateList template list
type TemplateList struct {
util.CommonError
Data []TemplateItem `json:"data"`
}
// Send 发送订阅消息
func (s *Subscribe) Send(msg *Message) (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
}
return util.DecodeWithCommonError(response, "Send")
}
// 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()
if err != nil {
return nil, err
}
uri := fmt.Sprintf("%s?access_token=%s", getTemplateURL, accessToken)
response, err := util.HTTPGet(uri)
if err != nil {
return nil, err
}
templateList := TemplateList{}
err = util.DecodeWithError(response, &templateList, "ListTemplates")
if err != nil {
return nil, err
}
return &templateList, nil
}
// UniformMessage 统一服务消息
type UniformMessage struct {
ToUser string `json:"touser"`
WeappTemplateMsg struct {
TemplateID string `json:"template_id"`
Page string `json:"page"`
FormID string `json:"form_id"`
Data map[string]*DataItem `json:"data"`
EmphasisKeyword string `json:"emphasis_keyword"`
} `json:"weapp_template_msg"`
MpTemplateMsg struct {
Appid string `json:"appid"`
TemplateID string `json:"template_id"`
URL string `json:"url"`
Miniprogram struct {
Appid string `json:"appid"`
Pagepath string `json:"page"`
} `json:"miniprogram"`
Data map[string]*DataItem `json:"data"`
} `json:"mp_template_msg"`
}
// UniformSend 发送统一服务消息
func (s *Subscribe) UniformSend(msg *UniformMessage) (err error) {
var accessToken string
accessToken, err = s.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", uniformMessageSend, accessToken)
response, err := util.PostJSON(uri, msg)
if err != nil {
return
}
return util.DecodeWithCommonError(response, "UniformSend")
}
type resSubscribeAdd struct {
util.CommonError
TemplateID string `json:"priTmplId"`
}
// Add 添加订阅消息模板
func (s *Subscribe) Add(ShortID string, kidList []int, sceneDesc string) (templateID string, err error) {
var accessToken string
accessToken, err = s.GetAccessToken()
if err != nil {
return
}
var msg = struct {
TemplateIDShort string `json:"tid"`
SceneDesc string `json:"sceneDesc"`
KidList []int `json:"kidList"`
}{TemplateIDShort: ShortID, SceneDesc: sceneDesc, KidList: kidList}
uri := fmt.Sprintf("%s?access_token=%s", addTemplateURL, accessToken)
var response []byte
response, err = util.PostJSON(uri, msg)
if err != nil {
return
}
var result resSubscribeAdd
err = util.DecodeWithError(response, &result, "AddSubscribe")
if err != nil {
return
}
templateID = result.TemplateID
return
}
// Delete 删除私有模板
func (s *Subscribe) Delete(templateID string) (err error) {
var accessToken string
accessToken, err = s.GetAccessToken()
if err != nil {
return
}
var msg = struct {
TemplateID string `json:"priTmplId"`
}{TemplateID: templateID}
uri := fmt.Sprintf("%s?access_token=%s", delTemplateURL, accessToken)
var response []byte
response, err = util.PostJSON(uri, msg)
if err != nil {
return
}
return util.DecodeWithCommonError(response, "DeleteSubscribe")
}

View File

@@ -21,7 +21,9 @@ wcTcb := wc.GetTcb()
``` ```
### 举例 ### 举例
#### 触发云函数 #### 触发云函数
```golang ```golang
res, err := wcTcb.InvokeCloudFunction("test-xxxx", "add", `{"a":1,"b":2}`) res, err := wcTcb.InvokeCloudFunction("test-xxxx", "add", `{"a":1,"b":2}`)
if err != nil { if err != nil {
@@ -29,4 +31,4 @@ if err != nil {
} }
``` ```
更多使用方法参考[GODOC](https://godoc.org/github.com/silenceper/wechat/v2/tcb) 更多使用方法参考[PKG.DEV](https://pkg.go.dev/github.com/silenceper/wechat/v2/miniprogram/tcb)

View File

@@ -7,17 +7,17 @@ import (
) )
const ( const (
//触发云函数 // 触发云函数
invokeCloudFunctionURL = "https://api.weixin.qq.com/tcb/invokecloudfunction" invokeCloudFunctionURL = "https://api.weixin.qq.com/tcb/invokecloudfunction"
) )
//InvokeCloudFunctionRes 云函数调用返回结果 // InvokeCloudFunctionRes 云函数调用返回结果
type InvokeCloudFunctionRes struct { type InvokeCloudFunctionRes struct {
util.CommonError 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 //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) { func (tcb *Tcb) InvokeCloudFunction(env, name, args string) (*InvokeCloudFunctionRes, error) {
accessToken, err := tcb.GetAccessToken() accessToken, err := tcb.GetAccessToken()

View File

@@ -7,191 +7,191 @@ import (
) )
const ( const (
//数据库导入 // 数据库导入
databaseMigrateImportURL = "https://api.weixin.qq.com/tcb/databasemigrateimport" databaseMigrateImportURL = "https://api.weixin.qq.com/tcb/databasemigrateimport"
//数据库导出 // 数据库导出
databaseMigrateExportURL = "https://api.weixin.qq.com/tcb/databasemigrateexport" databaseMigrateExportURL = "https://api.weixin.qq.com/tcb/databasemigrateexport"
//数据库迁移状态查询 // 数据库迁移状态查询
databaseMigrateQueryInfoURL = "https://api.weixin.qq.com/tcb/databasemigratequeryinfo" databaseMigrateQueryInfoURL = "https://api.weixin.qq.com/tcb/databasemigratequeryinfo"
//变更数据库索引 // 变更数据库索引
updateIndexURL = "https://api.weixin.qq.com/tcb/updateindex" updateIndexURL = "https://api.weixin.qq.com/tcb/updateindex"
//新增集合 // 新增集合
databaseCollectionAddURL = "https://api.weixin.qq.com/tcb/databasecollectionadd" databaseCollectionAddURL = "https://api.weixin.qq.com/tcb/databasecollectionadd"
//删除集合 // 删除集合
databaseCollectionDeleteURL = "https://api.weixin.qq.com/tcb/databasecollectiondelete" databaseCollectionDeleteURL = "https://api.weixin.qq.com/tcb/databasecollectiondelete"
//获取特定云环境下集合信息 // 获取特定云环境下集合信息
databaseCollectionGetURL = "https://api.weixin.qq.com/tcb/databasecollectionget" databaseCollectionGetURL = "https://api.weixin.qq.com/tcb/databasecollectionget"
//数据库插入记录 // 数据库插入记录
databaseAddURL = "https://api.weixin.qq.com/tcb/databaseadd" databaseAddURL = "https://api.weixin.qq.com/tcb/databaseadd"
//数据库删除记录 // 数据库删除记录
databaseDeleteURL = "https://api.weixin.qq.com/tcb/databasedelete" databaseDeleteURL = "https://api.weixin.qq.com/tcb/databasedelete"
//数据库更新记录 // 数据库更新记录
databaseUpdateURL = "https://api.weixin.qq.com/tcb/databaseupdate" databaseUpdateURL = "https://api.weixin.qq.com/tcb/databaseupdate"
//数据库查询记录 // 数据库查询记录
databaseQueryURL = "https://api.weixin.qq.com/tcb/databasequery" databaseQueryURL = "https://api.weixin.qq.com/tcb/databasequery"
//统计集合记录数或统计查询语句对应的结果记录数 // 统计集合记录数或统计查询语句对应的结果记录数
databaseCountURL = "https://api.weixin.qq.com/tcb/databasecount" databaseCountURL = "https://api.weixin.qq.com/tcb/databasecount"
//ConflictModeInster 冲突处理模式 插入 // ConflictModeInster 冲突处理模式 插入
ConflictModeInster ConflictMode = 1 ConflictModeInster ConflictMode = 1
//ConflictModeUpsert 冲突处理模式 更新 // ConflictModeUpsert 冲突处理模式 更新
ConflictModeUpsert ConflictMode = 2 ConflictModeUpsert ConflictMode = 2
//FileTypeJSON 的合法值 json // FileTypeJSON 的合法值 json
FileTypeJSON FileType = 1 FileTypeJSON FileType = 1
//FileTypeCsv 的合法值 csv // FileTypeCsv 的合法值 csv
FileTypeCsv FileType = 2 FileTypeCsv FileType = 2
) )
//ConflictMode 冲突处理模式 // ConflictMode 冲突处理模式
type ConflictMode int type ConflictMode int
//FileType 文件上传和导出的允许文件类型 // FileType 文件上传和导出的允许文件类型
type FileType int type FileType int
//ValidDirections 合法的direction值 // ValidDirections 合法的direction值
var ValidDirections = []string{"1", "-1", "2dsphere"} var ValidDirections = []string{"1", "-1", "2dsphere"}
//DatabaseMigrateExportReq 数据库出 请求参数 // DatabaseMigrateExportReq 数据库出 请求参数
type DatabaseMigrateExportReq struct { type DatabaseMigrateExportReq struct {
Env string `json:"env,omitempty"` //云环境ID Env string `json:"env,omitempty"` // 云环境ID
FilePath string `json:"file_path,omitempty"` //导出文件路径(导入文件需先上传到同环境的存储中,可使用开发者工具或 HTTP API的上传文件 API上传 FilePath string `json:"file_path,omitempty"` // 导出文件路径(导入文件需先上传到同环境的存储中,可使用开发者工具或 HTTP API的上传文件 API上传
FileType FileType `json:"file_type,omitempty"` //导出文件类型,文件格式参考数据库导入指引中的文件格式部分 1:json 2:csv FileType FileType `json:"file_type,omitempty"` // 导出文件类型,文件格式参考数据库导入指引中的文件格式部分 1:json 2:csv
Query string `json:"query,omitempty"` //导出条件 Query string `json:"query,omitempty"` // 导出条件
} }
//DatabaseMigrateExportRes 数据库导出 返回结果 // DatabaseMigrateExportRes 数据库导出 返回结果
type DatabaseMigrateExportRes struct { type DatabaseMigrateExportRes struct {
util.CommonError util.CommonError
JobID int64 `json:"job_id"` //导出任务ID可使用数据库迁移进度查询 API 查询导入进度及结果 JobID int64 `json:"job_id"` // 导出任务ID可使用数据库迁移进度查询 API 查询导入进度及结果
} }
//DatabaseMigrateImportReq 数据库导入 请求参数 // DatabaseMigrateImportReq 数据库导入 请求参数
type DatabaseMigrateImportReq struct { type DatabaseMigrateImportReq struct {
Env string `json:"env,omitempty"` //云环境ID Env string `json:"env,omitempty"` // 云环境ID
CollectionName string `json:"collection_name,omitempty"` //集合名称 CollectionName string `json:"collection_name,omitempty"` // 集合名称
FilePath string `json:"file_path,omitempty"` //导出文件路径(文件会导出到同环境的云存储中,可使用获取下载链接 API 获取下载链接) FilePath string `json:"file_path,omitempty"` // 导出文件路径(文件会导出到同环境的云存储中,可使用获取下载链接 API 获取下载链接)
FileType FileType `json:"file_type,omitempty"` //导入文件类型,文件格式参考数据库导入指引中的文件格式部分 1:json 2:csv FileType FileType `json:"file_type,omitempty"` // 导入文件类型,文件格式参考数据库导入指引中的文件格式部分 1:json 2:csv
StopOnError bool `json:"stop_on_error,omitempty"` //是否在遇到错误时停止导入 StopOnError bool `json:"stop_on_error,omitempty"` // 是否在遇到错误时停止导入
ConflictMode ConflictMode `json:"conflict_mode,omitempty"` //冲突处理模式 1:inster 2:UPSERT ConflictMode ConflictMode `json:"conflict_mode,omitempty"` // 冲突处理模式 1:inster 2:UPSERT
} }
//DatabaseMigrateImportRes 数据库导入 返回结果 // DatabaseMigrateImportRes 数据库导入 返回结果
type DatabaseMigrateImportRes struct { type DatabaseMigrateImportRes struct {
util.CommonError util.CommonError
JobID int64 `json:"job_id"` //导入任务ID可使用数据库迁移进度查询 API 查询导入进度及结果 JobID int64 `json:"job_id"` // 导入任务ID可使用数据库迁移进度查询 API 查询导入进度及结果
} }
//DatabaseMigrateQueryInfoRes 数据库迁移状态查询 // DatabaseMigrateQueryInfoRes 数据库迁移状态查询
type DatabaseMigrateQueryInfoRes struct { type DatabaseMigrateQueryInfoRes struct {
util.CommonError util.CommonError
Status string `json:"status"` //导出状态 Status string `json:"status"` // 导出状态
RecordSuccess int64 `json:"record_success"` //导出成功记录数 RecordSuccess int64 `json:"record_success"` // 导出成功记录数
RecordFail int64 `json:"record_fail"` //导出失败记录数 RecordFail int64 `json:"record_fail"` // 导出失败记录数
ErrMsg string `json:"err_msg"` //导出错误信息 ErrMsg string `json:"err_msg"` // 导出错误信息
FileURL string `json:"file_url"` //导出文件下载地址 FileURL string `json:"file_url"` // 导出文件下载地址
} }
//UpdateIndexReq 变更数据库索引 请求参数 // UpdateIndexReq 变更数据库索引 请求参数
type UpdateIndexReq struct { type UpdateIndexReq struct {
Env string `json:"env,omitempty"` //云环境ID Env string `json:"env,omitempty"` // 云环境ID
CollectionName string `json:"collection_name,omitempty"` //集合名称 CollectionName string `json:"collection_name,omitempty"` // 集合名称
CreateIndexes []CreateIndex `json:"create_indexes,omitempty"` //新增索引 CreateIndexes []CreateIndex `json:"create_indexes,omitempty"` // 新增索引
DropIndexes []DropIndex `json:"drop_indexes,omitempty"` //删除索引 DropIndexes []DropIndex `json:"drop_indexes,omitempty"` // 删除索引
} }
//CreateIndex 新增索引 // CreateIndex 新增索引
type CreateIndex struct { type CreateIndex struct {
Name string `json:"name,omitempty"` //索引名 Name string `json:"name,omitempty"` // 索引名
Unique bool `json:"unique,omitempty"` //是否唯一 Unique bool `json:"unique,omitempty"` // 是否唯一
Keys []CreateIndexKey `json:"keys,omitempty"` //索引字段 Keys []CreateIndexKey `json:"keys,omitempty"` // 索引字段
} }
//CreateIndexKey create index key // CreateIndexKey create index key
type CreateIndexKey struct { type CreateIndexKey struct {
Name string `json:"name,omitempty"` //字段名 Name string `json:"name,omitempty"` // 字段名
Direction string `json:"direction,omitempty"` //字段排序 Direction string `json:"direction,omitempty"` // 字段排序
} }
//DropIndex 删除索引 // DropIndex 删除索引
type DropIndex struct { type DropIndex struct {
Name string `json:"name,omitempty"` Name string `json:"name,omitempty"`
} }
//DatabaseCollectionReq 新增/删除集合请求参数 // DatabaseCollectionReq 新增/删除集合请求参数
type DatabaseCollectionReq struct { type DatabaseCollectionReq struct {
Env string `json:"env,omitempty"` //云环境ID Env string `json:"env,omitempty"` // 云环境ID
CollectionName string `json:"collection_name,omitempty"` //集合名称 CollectionName string `json:"collection_name,omitempty"` // 集合名称
} }
//DatabaseCollectionGetReq 获取特定云环境下集合信息请求 // DatabaseCollectionGetReq 获取特定云环境下集合信息请求
type DatabaseCollectionGetReq struct { type DatabaseCollectionGetReq struct {
Env string `json:"env,omitempty"` //云环境ID Env string `json:"env,omitempty"` // 云环境ID
Limit int64 `json:"limit,omitempty"` //获取数量限制 Limit int64 `json:"limit,omitempty"` // 获取数量限制
Offset int64 `json:"offset,omitempty"` //偏移量 Offset int64 `json:"offset,omitempty"` // 偏移量
} }
//DatabaseCollectionGetRes 获取特定云环境下集合信息结果 // DatabaseCollectionGetRes 获取特定云环境下集合信息结果
type DatabaseCollectionGetRes struct { type DatabaseCollectionGetRes struct {
util.CommonError util.CommonError
Pager struct { Pager struct {
Limit int64 `json:"limit"` //单次查询限制 Limit int64 `json:"limit"` // 单次查询限制
Offset int64 `json:"offset"` //偏移量 Offset int64 `json:"offset"` // 偏移量
Total int64 `json:"total"` //符合查询条件的记录总数 Total int64 `json:"total"` // 符合查询条件的记录总数
} `json:"pager"` } `json:"pager"`
Collections []struct { Collections []struct {
Name string `json:"name"` //集合名 Name string `json:"name"` // 集合名
Count int64 `json:"count"` //表中文档数量 Count int64 `json:"count"` // 表中文档数量
Size int64 `json:"size"` //表的大小(即表中文档总大小),单位:字节 Size int64 `json:"size"` // 表的大小(即表中文档总大小),单位:字节
IndexCount int64 `json:"index_count"` //索引数量 IndexCount int64 `json:"index_count"` // 索引数量
IndexSize int64 `json:"index_size"` //索引占用大小,单位:字节 IndexSize int64 `json:"index_size"` // 索引占用大小,单位:字节
} `json:"collections"` } `json:"collections"`
} }
//DatabaseReq 数据库插入/删除/更新/查询/统计记录请求参数 // DatabaseReq 数据库插入/删除/更新/查询/统计记录请求参数
type DatabaseReq struct { type DatabaseReq struct {
Env string `json:"env,omitempty"` //云环境ID Env string `json:"env,omitempty"` // 云环境ID
Query string `json:"query,omitempty"` //数据库操作语句 Query string `json:"query,omitempty"` // 数据库操作语句
} }
//DatabaseAddRes 数据库插入记录返回结果 // DatabaseAddRes 数据库插入记录返回结果
type DatabaseAddRes struct { type DatabaseAddRes struct {
util.CommonError util.CommonError
IDList []string `json:"id_list"` //插入成功的数据集合主键_id。 IDList []string `json:"id_list"` // 插入成功的数据集合主键_id。
} }
//DatabaseDeleteRes 数据库删除记录返回结果 // DatabaseDeleteRes 数据库删除记录返回结果
type DatabaseDeleteRes struct { type DatabaseDeleteRes struct {
util.CommonError util.CommonError
Deleted int64 `json:"deleted"` //删除记录数量 Deleted int64 `json:"deleted"` // 删除记录数量
} }
//DatabaseUpdateRes 数据库更新记录返回结果 // DatabaseUpdateRes 数据库更新记录返回结果
type DatabaseUpdateRes struct { type DatabaseUpdateRes struct {
util.CommonError util.CommonError
Matched int64 `json:"matched"` //更新条件匹配到的结果数 Matched int64 `json:"matched"` // 更新条件匹配到的结果数
Modified int64 `json:"modified"` //修改的记录数注意使用set操作新插入的数据不计入修改数目 Modified int64 `json:"modified"` // 修改的记录数注意使用set操作新插入的数据不计入修改数目
ID string `json:"id"` ID string `json:"id"`
} }
//DatabaseQueryRes 数据库查询记录 返回结果 // DatabaseQueryRes 数据库查询记录 返回结果
type DatabaseQueryRes struct { type DatabaseQueryRes struct {
util.CommonError util.CommonError
Pager struct { Pager struct {
Limit int64 `json:"limit"` //单次查询限制 Limit int64 `json:"limit"` // 单次查询限制
Offset int64 `json:"offset"` //偏移量 Offset int64 `json:"offset"` // 偏移量
Total int64 `json:"total"` //符合查询条件的记录总数 Total int64 `json:"total"` // 符合查询条件的记录总数
} `json:"pager"` } `json:"pager"`
Data []string `json:"data"` Data []string `json:"data"`
} }
//DatabaseCountRes 统计集合记录数或统计查询语句对应的结果记录数 返回结果 // DatabaseCountRes 统计集合记录数或统计查询语句对应的结果记录数 返回结果
type DatabaseCountRes struct { type DatabaseCountRes struct {
util.CommonError 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 //reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateImport.html
func (tcb *Tcb) DatabaseMigrateImport(req *DatabaseMigrateImportReq) (*DatabaseMigrateImportRes, error) { func (tcb *Tcb) DatabaseMigrateImport(req *DatabaseMigrateImportReq) (*DatabaseMigrateImportRes, error) {
accessToken, err := tcb.GetAccessToken() accessToken, err := tcb.GetAccessToken()
@@ -208,7 +208,7 @@ func (tcb *Tcb) DatabaseMigrateImport(req *DatabaseMigrateImportReq) (*DatabaseM
return databaseMigrateImportRes, err return databaseMigrateImportRes, err
} }
//DatabaseMigrateExport 数据库导出 // DatabaseMigrateExport 数据库导出
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateExport.html //reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateExport.html
func (tcb *Tcb) DatabaseMigrateExport(req *DatabaseMigrateExportReq) (*DatabaseMigrateExportRes, error) { func (tcb *Tcb) DatabaseMigrateExport(req *DatabaseMigrateExportReq) (*DatabaseMigrateExportRes, error) {
accessToken, err := tcb.GetAccessToken() accessToken, err := tcb.GetAccessToken()
@@ -225,7 +225,7 @@ func (tcb *Tcb) DatabaseMigrateExport(req *DatabaseMigrateExportReq) (*DatabaseM
return databaseMigrateExportRes, err return databaseMigrateExportRes, err
} }
//DatabaseMigrateQueryInfo 数据库迁移状态查询 // DatabaseMigrateQueryInfo 数据库迁移状态查询
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseMigrateQueryInfo.html //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) { func (tcb *Tcb) DatabaseMigrateQueryInfo(env string, jobID int64) (*DatabaseMigrateQueryInfoRes, error) {
accessToken, err := tcb.GetAccessToken() accessToken, err := tcb.GetAccessToken()
@@ -245,8 +245,8 @@ func (tcb *Tcb) DatabaseMigrateQueryInfo(env string, jobID int64) (*DatabaseMigr
return databaseMigrateQueryInfoRes, err return databaseMigrateQueryInfoRes, err
} }
//UpdateIndex 变更数据库索引 // UpdateIndex 变更数据库索引
//https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/updateIndex.html // https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/updateIndex.html
func (tcb *Tcb) UpdateIndex(req *UpdateIndexReq) error { func (tcb *Tcb) UpdateIndex(req *UpdateIndexReq) error {
accessToken, err := tcb.GetAccessToken() accessToken, err := tcb.GetAccessToken()
if err != nil { if err != nil {
@@ -260,7 +260,7 @@ func (tcb *Tcb) UpdateIndex(req *UpdateIndexReq) error {
return util.DecodeWithCommonError(response, "UpdateIndex") return util.DecodeWithCommonError(response, "UpdateIndex")
} }
//DatabaseCollectionAdd 新增集合 // DatabaseCollectionAdd 新增集合
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionAdd.html //reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionAdd.html
func (tcb *Tcb) DatabaseCollectionAdd(env, collectionName string) error { func (tcb *Tcb) DatabaseCollectionAdd(env, collectionName string) error {
accessToken, err := tcb.GetAccessToken() accessToken, err := tcb.GetAccessToken()
@@ -278,7 +278,7 @@ func (tcb *Tcb) DatabaseCollectionAdd(env, collectionName string) error {
return util.DecodeWithCommonError(response, "DatabaseCollectionAdd") return util.DecodeWithCommonError(response, "DatabaseCollectionAdd")
} }
//DatabaseCollectionDelete 删除集合 // DatabaseCollectionDelete 删除集合
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionDelete.html //reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionDelete.html
func (tcb *Tcb) DatabaseCollectionDelete(env, collectionName string) error { func (tcb *Tcb) DatabaseCollectionDelete(env, collectionName string) error {
accessToken, err := tcb.GetAccessToken() accessToken, err := tcb.GetAccessToken()
@@ -296,7 +296,7 @@ func (tcb *Tcb) DatabaseCollectionDelete(env, collectionName string) error {
return util.DecodeWithCommonError(response, "DatabaseCollectionDelete") return util.DecodeWithCommonError(response, "DatabaseCollectionDelete")
} }
//DatabaseCollectionGet 获取特定云环境下集合信息 // DatabaseCollectionGet 获取特定云环境下集合信息
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCollectionGet.html //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) { func (tcb *Tcb) DatabaseCollectionGet(env string, limit, offset int64) (*DatabaseCollectionGetRes, error) {
accessToken, err := tcb.GetAccessToken() accessToken, err := tcb.GetAccessToken()
@@ -317,7 +317,7 @@ func (tcb *Tcb) DatabaseCollectionGet(env string, limit, offset int64) (*Databas
return databaseCollectionGetRes, err return databaseCollectionGetRes, err
} }
//DatabaseAdd 数据库插入记录 // DatabaseAdd 数据库插入记录
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseAdd.html //reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseAdd.html
func (tcb *Tcb) DatabaseAdd(env, query string) (*DatabaseAddRes, error) { func (tcb *Tcb) DatabaseAdd(env, query string) (*DatabaseAddRes, error) {
accessToken, err := tcb.GetAccessToken() accessToken, err := tcb.GetAccessToken()
@@ -337,7 +337,7 @@ func (tcb *Tcb) DatabaseAdd(env, query string) (*DatabaseAddRes, error) {
return databaseAddRes, err return databaseAddRes, err
} }
//DatabaseDelete 数据库插入记录 // DatabaseDelete 数据库插入记录
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseDelete.html //reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseDelete.html
func (tcb *Tcb) DatabaseDelete(env, query string) (*DatabaseDeleteRes, error) { func (tcb *Tcb) DatabaseDelete(env, query string) (*DatabaseDeleteRes, error) {
accessToken, err := tcb.GetAccessToken() accessToken, err := tcb.GetAccessToken()
@@ -357,7 +357,7 @@ func (tcb *Tcb) DatabaseDelete(env, query string) (*DatabaseDeleteRes, error) {
return databaseDeleteRes, err return databaseDeleteRes, err
} }
//DatabaseUpdate 数据库插入记录 // DatabaseUpdate 数据库插入记录
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseUpdate.html //reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseUpdate.html
func (tcb *Tcb) DatabaseUpdate(env, query string) (*DatabaseUpdateRes, error) { func (tcb *Tcb) DatabaseUpdate(env, query string) (*DatabaseUpdateRes, error) {
accessToken, err := tcb.GetAccessToken() accessToken, err := tcb.GetAccessToken()
@@ -377,7 +377,7 @@ func (tcb *Tcb) DatabaseUpdate(env, query string) (*DatabaseUpdateRes, error) {
return databaseUpdateRes, err return databaseUpdateRes, err
} }
//DatabaseQuery 数据库查询记录 // DatabaseQuery 数据库查询记录
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseQuery.html //reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseQuery.html
func (tcb *Tcb) DatabaseQuery(env, query string) (*DatabaseQueryRes, error) { func (tcb *Tcb) DatabaseQuery(env, query string) (*DatabaseQueryRes, error) {
accessToken, err := tcb.GetAccessToken() accessToken, err := tcb.GetAccessToken()
@@ -397,7 +397,7 @@ func (tcb *Tcb) DatabaseQuery(env, query string) (*DatabaseQueryRes, error) {
return databaseQueryRes, err return databaseQueryRes, err
} }
//DatabaseCount 统计集合记录数或统计查询语句对应的结果记录数 // DatabaseCount 统计集合记录数或统计查询语句对应的结果记录数
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCount.html //reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/database/databaseCount.html
func (tcb *Tcb) DatabaseCount(env, query string) (*DatabaseCountRes, error) { func (tcb *Tcb) DatabaseCount(env, query string) (*DatabaseCountRes, error) {
accessToken, err := tcb.GetAccessToken() accessToken, err := tcb.GetAccessToken()

View File

@@ -7,60 +7,60 @@ import (
) )
const ( const (
//获取文件上传链接 // 获取文件上传链接
uploadFilePathURL = "https://api.weixin.qq.com/tcb/uploadfile" uploadFilePathURL = "https://api.weixin.qq.com/tcb/uploadfile"
//获取文件下载链接 // 获取文件下载链接
batchDownloadFileURL = "https://api.weixin.qq.com/tcb/batchdownloadfile" batchDownloadFileURL = "https://api.weixin.qq.com/tcb/batchdownloadfile"
//删除文件链接 // 删除文件链接
batchDeleteFileURL = "https://api.weixin.qq.com/tcb/batchdeletefile" batchDeleteFileURL = "https://api.weixin.qq.com/tcb/batchdeletefile"
) )
//UploadFileReq 上传文件请求值 // UploadFileReq 上传文件请求值
type UploadFileReq struct { type UploadFileReq struct {
Env string `json:"env,omitempty"` Env string `json:"env,omitempty"`
Path string `json:"path,omitempty"` Path string `json:"path,omitempty"`
} }
//UploadFileRes 上传文件返回结果 // UploadFileRes 上传文件返回结果
type UploadFileRes struct { type UploadFileRes struct {
util.CommonError util.CommonError
URL string `json:"url"` //上传url URL string `json:"url"` // 上传url
Token string `json:"token"` //token Token string `json:"token"` // token
Authorization string `json:"authorization"` //authorization Authorization string `json:"authorization"` // authorization
FileID string `json:"file_id"` //文件ID FileID string `json:"file_id"` // 文件ID
CosFileID string `json:"cos_file_id"` //cos文件ID CosFileID string `json:"cos_file_id"` // cos文件ID
} }
//BatchDownloadFileReq 上传文件请求值 // BatchDownloadFileReq 上传文件请求值
type BatchDownloadFileReq struct { type BatchDownloadFileReq struct {
Env string `json:"env,omitempty"` Env string `json:"env,omitempty"`
FileList []*DownloadFile `json:"file_list,omitempty"` FileList []*DownloadFile `json:"file_list,omitempty"`
} }
//DownloadFile 文件信息 // DownloadFile 文件信息
type DownloadFile struct { type DownloadFile struct {
FileID string `json:"fileid"` //文件ID FileID string `json:"fileid"` // 文件ID
MaxAge int64 `json:"max_age"` //下载链接有效期 MaxAge int64 `json:"max_age"` // 下载链接有效期
} }
//BatchDownloadFileRes 上传文件返回结果 // BatchDownloadFileRes 上传文件返回结果
type BatchDownloadFileRes struct { type BatchDownloadFileRes struct {
util.CommonError util.CommonError
FileList []struct { FileList []struct {
FileID string `json:"file_id"` //文件ID FileID string `json:"file_id"` // 文件ID
DownloadURL string `json:"download_url"` //下载链接 DownloadURL string `json:"download_url"` // 下载链接
Status int64 `json:"status"` //状态码 Status int64 `json:"status"` // 状态码
ErrMsg string `json:"errmsg"` //该文件错误信息 ErrMsg string `json:"errmsg"` // 该文件错误信息
} `json:"file_list"` } `json:"file_list"`
} }
//BatchDeleteFileReq 批量删除文件请求参数 // BatchDeleteFileReq 批量删除文件请求参数
type BatchDeleteFileReq struct { type BatchDeleteFileReq struct {
Env string `json:"env,omitempty"` Env string `json:"env,omitempty"`
FileIDList []string `json:"fileid_list,omitempty"` FileIDList []string `json:"fileid_list,omitempty"`
} }
//BatchDeleteFileRes 批量删除文件返回结果 // BatchDeleteFileRes 批量删除文件返回结果
type BatchDeleteFileRes struct { type BatchDeleteFileRes struct {
util.CommonError util.CommonError
DeleteList []struct { DeleteList []struct {
@@ -70,7 +70,7 @@ type BatchDeleteFileRes struct {
} `json:"delete_list"` } `json:"delete_list"`
} }
//UploadFile 上传文件 // UploadFile 上传文件
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/uploadFile.html //reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/uploadFile.html
func (tcb *Tcb) UploadFile(env, path string) (*UploadFileRes, error) { func (tcb *Tcb) UploadFile(env, path string) (*UploadFileRes, error) {
accessToken, err := tcb.GetAccessToken() accessToken, err := tcb.GetAccessToken()
@@ -91,7 +91,7 @@ func (tcb *Tcb) UploadFile(env, path string) (*UploadFileRes, error) {
return uploadFileRes, err return uploadFileRes, err
} }
//BatchDownloadFile 获取文件下载链接 // BatchDownloadFile 获取文件下载链接
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/batchDownloadFile.html //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) { func (tcb *Tcb) BatchDownloadFile(env string, fileList []*DownloadFile) (*BatchDownloadFileRes, error) {
accessToken, err := tcb.GetAccessToken() accessToken, err := tcb.GetAccessToken()
@@ -112,7 +112,7 @@ func (tcb *Tcb) BatchDownloadFile(env string, fileList []*DownloadFile) (*BatchD
return batchDownloadFileRes, err return batchDownloadFileRes, err
} }
//BatchDeleteFile 批量删除文件 // BatchDeleteFile 批量删除文件
//reference:https://developers.weixin.qq.com/miniprogram/dev/wxcloud/reference-http-api/storage/batchDeleteFile.html //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) { func (tcb *Tcb) BatchDeleteFile(env string, fileIDList []string) (*BatchDeleteFileRes, error) {
accessToken, err := tcb.GetAccessToken() accessToken, err := tcb.GetAccessToken()
@@ -130,5 +130,5 @@ func (tcb *Tcb) BatchDeleteFile(env string, fileIDList []string) (*BatchDeleteFi
} }
batchDeleteFileRes := &BatchDeleteFileRes{} batchDeleteFileRes := &BatchDeleteFileRes{}
err = util.DecodeWithError(response, batchDeleteFileRes, "BatchDeleteFile") err = util.DecodeWithError(response, batchDeleteFileRes, "BatchDeleteFile")
return batchDeleteFileRes, nil return batchDeleteFileRes, err
} }

View File

@@ -2,12 +2,12 @@ package tcb
import "github.com/silenceper/wechat/v2/miniprogram/context" import "github.com/silenceper/wechat/v2/miniprogram/context"
//Tcb Tencent Cloud Base // Tcb Tencent Cloud Base
type Tcb struct { type Tcb struct {
*context.Context *context.Context
} }
//NewTcb new Tencent Cloud Base // NewTcb new Tencent Cloud Base
func NewTcb(context *context.Context) *Tcb { func NewTcb(context *context.Context) *Tcb {
return &Tcb{ return &Tcb{
context, context,

View File

@@ -0,0 +1,52 @@
package urllink
import (
"fmt"
"github.com/silenceper/wechat/v2/util"
)
const queryURL = "https://api.weixin.qq.com/wxa/query_urllink"
// ULQueryResult 返回的结果
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-link/urllink.query.html 返回值
type ULQueryResult struct {
util.CommonError
URLLinkInfo struct {
Appid string `json:"appid"`
Path string `json:"path"`
Query string `json:"query"`
CreateTime int64 `json:"create_time"`
ExpireTime int64 `json:"expire_time"`
EnvVersion string `json:"env_version"`
CloudBase struct {
Env string `json:"env"`
Domain string `json:"domain"`
Path string `json:"path"`
Query string `json:"query"`
ResourceAppid string `json:"resource_appid"`
} `json:"cloud_base"`
} `json:"url_link_info"`
VisitOpenid string `json:"visit_openid"`
}
// Query 查询小程序 url_link 配置。
func (u *URLLink) Query(urlLink string) (*ULQueryResult, error) {
accessToken, err := u.GetAccessToken()
if err != nil {
return nil, err
}
uri := fmt.Sprintf("%s?access_token=%s", queryURL, accessToken)
response, err := util.PostJSON(uri, map[string]string{"url_link": urlLink})
if err != nil {
return nil, err
}
var resp ULQueryResult
err = util.DecodeWithError(response, &resp, "URLLink.Query")
if err != nil {
return nil, err
}
return &resp, nil
}

View File

@@ -0,0 +1,72 @@
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")
if err != nil {
return "", err
}
return resp.URLLink, nil
}

View File

@@ -0,0 +1,70 @@
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"`
}
// 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"`
}
// 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"`
}
// QueryScheme 查询小程序 scheme 码
func (u *URLScheme) QueryScheme(querySchemeParams QueryScheme) (schemeInfo SchemeInfo, visitOpenid string, err error) {
var accessToken string
accessToken, err = u.GetAccessToken()
if err != nil {
return
}
urlStr := fmt.Sprintf(querySchemeURL, accessToken)
var response []byte
response, err = util.PostJSON(urlStr, querySchemeParams)
if err != nil {
return
}
// 使用通用方法返回错误
var res resQueryScheme
err = util.DecodeWithError(response, &res, "QueryScheme")
if err != nil {
return
}
return res.SchemeInfo, res.VisitOpenid, nil
}

View File

@@ -0,0 +1,85 @@
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 = "https://api.weixin.qq.com/wxa/generatescheme"
// 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"`
ExpireType TExpireType `json:"expire_type"`
ExpireTime int64 `json:"expire_time"`
ExpireInterval int `json:"expire_interval"`
}
// 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")
if err != nil {
return "", err
}
return resp.OpenLink, nil
}

View File

@@ -0,0 +1,40 @@
package werun
import (
"encoding/json"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/miniprogram/encryptor"
)
// WeRun 微信运动
type WeRun struct {
*context.Context
}
// Data 微信运动数据
type Data struct {
StepInfoList []struct {
Timestamp int `json:"timestamp"`
Step int `json:"step"`
} `json:"stepInfoList"`
}
// NewWeRun 实例化
func NewWeRun(ctx *context.Context) *WeRun {
return &WeRun{Context: ctx}
}
// GetWeRunData 解密数据
func (werun *WeRun) GetWeRunData(sessionKey, encryptedData, iv string) (*Data, error) {
cipherText, err := encryptor.GetCipherText(sessionKey, encryptedData, iv)
if err != nil {
return nil, err
}
var weRunData Data
err = json.Unmarshal(cipherText, &weRunData)
if err != nil {
return nil, err
}
return &weRunData, nil
}

View File

@@ -1,15 +1,84 @@
package basic package basic
import "github.com/silenceper/wechat/v2/officialaccount/context" import (
"fmt"
//Basic struct "github.com/silenceper/wechat/v2/officialaccount/context"
"github.com/silenceper/wechat/v2/util"
)
var (
// 获取微信服务器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
type Basic struct { type Basic struct {
*context.Context *context.Context
} }
//NewBasic 实例 // NewBasic 实例
func NewBasic(context *context.Context) *Basic { func NewBasic(context *context.Context) *Basic {
basic := new(Basic) basic := new(Basic)
basic.Context = context basic.Context = context
return basic return basic
} }
// IPListRes 获取微信服务器IP地址 返回结果
type IPListRes struct {
util.CommonError
IPList []string `json:"ip_list"`
}
// GetCallbackIP 获取微信callback IP地址
func (basic *Basic) GetCallbackIP() ([]string, error) {
ak, err := basic.GetAccessToken()
if err != nil {
return nil, err
}
url := fmt.Sprintf("%s?access_token=%s", getCallbackIPURL, ak)
data, err := util.HTTPGet(url)
if err != nil {
return nil, err
}
ipListRes := &IPListRes{}
err = util.DecodeWithError(data, ipListRes, "GetCallbackIP")
return ipListRes.IPList, err
}
// GetAPIDomainIP 获取微信API接口 IP地址
func (basic *Basic) GetAPIDomainIP() ([]string, error) {
ak, err := basic.GetAccessToken()
if err != nil {
return nil, err
}
url := fmt.Sprintf("%s?access_token=%s", getAPIDomainIPURL, ak)
data, err := util.HTTPGet(url)
if err != nil {
return nil, err
}
ipListRes := &IPListRes{}
err = util.DecodeWithError(data, ipListRes, "GetAPIDomainIP")
return ipListRes.IPList, err
}
// ClearQuota 清理接口调用次数
func (basic *Basic) ClearQuota() error {
ak, err := basic.GetAccessToken()
if err != nil {
return err
}
url := fmt.Sprintf("%s?access_token=%s", clearQuotaURL, ak)
data, err := util.PostJSON(url, map[string]string{
"appid": basic.AppID,
})
if err != nil {
return err
}
return util.DecodeWithCommonError(data, "ClearQuota")
}

View File

@@ -62,6 +62,11 @@ func (basic *Basic) GetQRTicket(tq *Request) (t *Ticket, err error) {
return return
} }
if t.ErrMsg != "" {
err = fmt.Errorf("get qr_ticket error : errcode=%v , errormsg=%v", t.ErrCode, t.ErrMsg)
return
}
return return
} }

View File

@@ -0,0 +1,52 @@
package basic
import (
"fmt"
"github.com/silenceper/wechat/v2/util"
)
const (
// 将一条长链接转成短链接
// https://developers.weixin.qq.com/doc/offiaccount/Account_Management/URL_Shortener.html
long2shortURL = "https://api.weixin.qq.com/cgi-bin/shorturl?access_token=%s"
long2shortAction = "long2short"
)
type (
reqLong2ShortURL struct {
Action string `json:"action"`
LongURL string `json:"long_url"`
}
resplong2ShortURL struct {
ShortURL string `json:"short_url"`
util.CommonError
}
)
// Long2ShortURL 将一条长链接转成短链接
func (basic *Basic) Long2ShortURL(longURL string) (shortURL string, err error) {
var (
req = &reqLong2ShortURL{
Action: long2shortAction,
LongURL: longURL,
}
resp = new(resplong2ShortURL)
ac, uri string
responseBytes []byte
)
ac, err = basic.GetAccessToken()
if err != nil {
return
}
uri = fmt.Sprintf(long2shortURL, ac)
responseBytes, err = util.PostJSON(uri, req)
if err != nil {
return
}
if err = util.DecodeWithError(responseBytes, resp, long2shortAction); err != nil {
return
}
shortURL = resp.ShortURL
return
}

View File

@@ -0,0 +1,356 @@
package broadcast
import (
"fmt"
"github.com/silenceper/wechat/v2/officialaccount/context"
"github.com/silenceper/wechat/v2/util"
)
const (
sendURLByTag = "https://api.weixin.qq.com/cgi-bin/message/mass/sendall"
sendURLByOpenID = "https://api.weixin.qq.com/cgi-bin/message/mass/send"
deleteSendURL = "https://api.weixin.qq.com/cgi-bin/message/mass/delete"
previewSendURL = "https://api.weixin.qq.com/cgi-bin/message/mass/preview"
massStatusSendURL = "https://api.weixin.qq.com/cgi-bin/message/mass/get"
getSpeedSendURL = "https://api.weixin.qq.com/cgi-bin/message/mass/speed/get"
setSpeedSendURL = "https://api.weixin.qq.com/cgi-bin/message/mass/speed/set"
)
// MsgType 发送消息类型
type MsgType string
const (
// MsgTypeNews 图文消息
MsgTypeNews MsgType = "mpnews"
// MsgTypeText 文本
MsgTypeText MsgType = "text"
// MsgTypeVoice 语音/音频
MsgTypeVoice MsgType = "voice"
// MsgTypeImage 图片
MsgTypeImage MsgType = "image"
// MsgTypeVideo 视频
MsgTypeVideo MsgType = "mpvideo"
// MsgTypeWxCard 卡券
MsgTypeWxCard MsgType = "wxcard"
)
// Broadcast 群发消息
type Broadcast struct {
*context.Context
preview bool
}
// NewBroadcast new
func NewBroadcast(ctx *context.Context) *Broadcast {
return &Broadcast{ctx, false}
}
// User 发送的用户
type User struct {
TagID int64
OpenID []string
}
// Result 群发返回结果
type Result struct {
util.CommonError
MsgID int64 `json:"msg_id"`
MsgDataID int64 `json:"msg_data_id"`
MsgStatus string `json:"msg_status"`
}
// SpeedResult 群发速度返回结果
type SpeedResult struct {
util.CommonError
Speed int64 `json:"speed"`
RealSpeed int64 `json:"realspeed"`
}
// sendRequest 发送请求的数据
type sendRequest struct {
// 根据tag获全部发送
Filter map[string]interface{} `json:"filter,omitempty"`
// 根据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"`
// 发送图片
Images *Image `json:"images,omitempty"`
// 发送卡券
WxCard map[string]interface{} `json:"wxcard,omitempty"`
MsgType MsgType `json:"msgtype"`
SendIgnoreReprint int32 `json:"send_ignore_reprint,omitempty"`
}
// Image 发送图片
type Image struct {
MediaIDs []string `json:"media_ids"`
Recommend string `json:"recommend"`
NeedOpenComment int32 `json:"need_open_comment"`
OnlyFansCanComment int32 `json:"only_fans_can_comment"`
}
// 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 {
return nil, err
}
req := &sendRequest{
ToUser: nil,
MsgType: MsgTypeText,
}
req.Text = map[string]interface{}{
"content": content,
}
req, sendURL := broadcast.chooseTagOrOpenID(user, req)
url := fmt.Sprintf("%s?access_token=%s", sendURL, ak)
data, err := util.PostJSON(url, req)
if err != nil {
return nil, err
}
res := &Result{}
err = util.DecodeWithError(data, res, "SendText")
return res, err
}
// SendNews 发送图文
func (broadcast *Broadcast) SendNews(user *User, mediaID string, ignoreReprint bool) (*Result, error) {
ak, err := broadcast.GetAccessToken()
if err != nil {
return nil, err
}
req := &sendRequest{
ToUser: nil,
MsgType: MsgTypeNews,
}
if ignoreReprint {
req.SendIgnoreReprint = 1
}
req.Mpnews = map[string]interface{}{
"media_id": mediaID,
}
req, sendURL := broadcast.chooseTagOrOpenID(user, req)
url := fmt.Sprintf("%s?access_token=%s", sendURL, ak)
data, err := util.PostJSON(url, req)
if err != nil {
return nil, err
}
res := &Result{}
err = util.DecodeWithError(data, res, "SendNews")
return res, err
}
// SendVoice 发送语音
func (broadcast *Broadcast) SendVoice(user *User, mediaID string) (*Result, error) {
ak, err := broadcast.GetAccessToken()
if err != nil {
return nil, err
}
req := &sendRequest{
ToUser: nil,
MsgType: MsgTypeVoice,
}
req.Voice = map[string]interface{}{
"media_id": mediaID,
}
req, sendURL := broadcast.chooseTagOrOpenID(user, req)
url := fmt.Sprintf("%s?access_token=%s", sendURL, ak)
data, err := util.PostJSON(url, req)
if err != nil {
return nil, err
}
res := &Result{}
err = util.DecodeWithError(data, res, "SendVoice")
return res, err
}
// SendImage 发送图片
func (broadcast *Broadcast) SendImage(user *User, images *Image) (*Result, error) {
ak, err := broadcast.GetAccessToken()
if err != nil {
return nil, err
}
req := &sendRequest{
ToUser: nil,
MsgType: MsgTypeImage,
}
req.Images = images
req, sendURL := broadcast.chooseTagOrOpenID(user, req)
url := fmt.Sprintf("%s?access_token=%s", sendURL, ak)
data, err := util.PostJSON(url, req)
if err != nil {
return nil, err
}
res := &Result{}
err = util.DecodeWithError(data, res, "SendImage")
return res, err
}
// SendVideo 发送视频
func (broadcast *Broadcast) SendVideo(user *User, mediaID string, title, description string) (*Result, error) {
ak, err := broadcast.GetAccessToken()
if err != nil {
return nil, err
}
req := &sendRequest{
ToUser: nil,
MsgType: MsgTypeVideo,
}
req.Voice = map[string]interface{}{
"media_id": mediaID,
"title": title,
"description": description,
}
req, sendURL := broadcast.chooseTagOrOpenID(user, req)
url := fmt.Sprintf("%s?access_token=%s", sendURL, ak)
data, err := util.PostJSON(url, req)
if err != nil {
return nil, err
}
res := &Result{}
err = util.DecodeWithError(data, res, "SendVideo")
return res, err
}
// SendWxCard 发送卡券
func (broadcast *Broadcast) SendWxCard(user *User, cardID string) (*Result, error) {
ak, err := broadcast.GetAccessToken()
if err != nil {
return nil, err
}
req := &sendRequest{
ToUser: nil,
MsgType: MsgTypeWxCard,
}
req.WxCard = map[string]interface{}{
"card_id": cardID,
}
req, sendURL := broadcast.chooseTagOrOpenID(user, req)
url := fmt.Sprintf("%s?access_token=%s", sendURL, ak)
data, err := util.PostJSON(url, req)
if err != nil {
return nil, err
}
res := &Result{}
err = util.DecodeWithError(data, res, "SendWxCard")
return res, err
}
// Delete 删除群发消息
func (broadcast *Broadcast) Delete(msgID int64, articleIDx int64) error {
ak, err := broadcast.GetAccessToken()
if err != nil {
return err
}
req := map[string]interface{}{
"msg_id": msgID,
"article_idx": articleIDx,
}
url := fmt.Sprintf("%s?access_token=%s", deleteSendURL, ak)
data, err := util.PostJSON(url, req)
if err != nil {
return err
}
return util.DecodeWithCommonError(data, "Delete")
}
// Preview 预览
func (broadcast *Broadcast) Preview() *Broadcast {
broadcast.preview = true
return broadcast
}
// GetMassStatus 获取群发状态
func (broadcast *Broadcast) GetMassStatus(msgID string) (*Result, error) {
ak, err := broadcast.GetAccessToken()
if err != nil {
return nil, err
}
req := map[string]interface{}{
"msg_id": msgID,
}
url := fmt.Sprintf("%s?access_token=%s", massStatusSendURL, ak)
data, err := util.PostJSON(url, req)
if err != nil {
return nil, err
}
res := &Result{}
err = util.DecodeWithError(data, res, "GetMassStatus")
return res, err
}
// GetSpeed 获取群发速度
func (broadcast *Broadcast) GetSpeed() (*SpeedResult, error) {
ak, err := broadcast.GetAccessToken()
if err != nil {
return nil, err
}
req := map[string]interface{}{}
url := fmt.Sprintf("%s?access_token=%s", getSpeedSendURL, ak)
data, err := util.PostJSON(url, req)
if err != nil {
return nil, err
}
res := &SpeedResult{}
err = util.DecodeWithError(data, res, "GetSpeed")
return res, err
}
// SetSpeed 设置群发速度
func (broadcast *Broadcast) SetSpeed(speed int) (*SpeedResult, error) {
ak, err := broadcast.GetAccessToken()
if err != nil {
return nil, err
}
req := map[string]interface{}{
"speed": speed,
}
url := fmt.Sprintf("%s?access_token=%s", setSpeedSendURL, ak)
data, err := util.PostJSON(url, req)
if err != nil {
return nil, err
}
res := &SpeedResult{}
err = util.DecodeWithError(data, res, "SetSpeed")
return res, err
}
func (broadcast *Broadcast) chooseTagOrOpenID(user *User, req *sendRequest) (ret *sendRequest, url string) {
sendURL := ""
if user == nil {
req.Filter = map[string]interface{}{
"is_to_all": true,
}
sendURL = sendURLByTag
} else {
if broadcast.preview {
// 预览 默认发给第一个用户
if len(user.OpenID) != 0 {
req.ToUser = user.OpenID[0]
sendURL = previewSendURL
}
} else {
if user.TagID != 0 {
req.Filter = map[string]interface{}{
"is_to_all": false,
"tag_id": user.TagID,
}
sendURL = sendURLByTag
}
if len(user.OpenID) != 0 {
req.ToUser = user.OpenID
sendURL = sendURLByOpenID
}
}
}
return req, sendURL
}

View File

@@ -4,11 +4,11 @@ import (
"github.com/silenceper/wechat/v2/cache" "github.com/silenceper/wechat/v2/cache"
) )
//Config config for 微信公众号 // Config .config for 微信公众号
type Config struct { type Config struct {
AppID string `json:"app_id"` //appid AppID string `json:"app_id"` // appid
AppSecret string `json:"app_secret"` //appsecret AppSecret string `json:"app_secret"` // appsecret
Token string `json:"token"` //token Token string `json:"token"` // token
EncodingAESKey string `json:"encoding_aes_key"` //EncodingAESKey EncodingAESKey string `json:"encoding_aes_key"` // EncodingAESKey
Cache cache.Cache Cache cache.Cache
} }

View File

@@ -1,87 +0,0 @@
package context
import (
"encoding/json"
"fmt"
"sync"
"time"
"github.com/silenceper/wechat/v2/util"
)
const (
//AccessTokenURL 获取access_token的接口
AccessTokenURL = "https://api.weixin.qq.com/cgi-bin/token"
//CacheKeyPrefix 微信公众号cache key前缀
CacheKeyPrefix = "gowechat_officialaccount_"
)
//ResAccessToken struct
type ResAccessToken struct {
util.CommonError
AccessToken string `json:"access_token"`
ExpiresIn int64 `json:"expires_in"`
}
//GetAccessTokenFunc 获取 access token 的函数签名
type GetAccessTokenFunc func(ctx *Context) (accessToken string, err error)
//SetAccessTokenLock 设置读写锁一个appID一个读写锁
func (ctx *Context) SetAccessTokenLock(l *sync.RWMutex) {
ctx.accessTokenLock = l
}
//SetGetAccessTokenFunc 设置自定义获取accessToken的方式, 需要自己实现缓存
func (ctx *Context) SetGetAccessTokenFunc(f GetAccessTokenFunc) {
ctx.accessTokenFunc = f
}
//GetAccessToken 获取access_token
func (ctx *Context) GetAccessToken() (accessToken string, err error) {
ctx.accessTokenLock.Lock()
defer ctx.accessTokenLock.Unlock()
if ctx.accessTokenFunc != nil {
return ctx.accessTokenFunc(ctx)
}
accessTokenCacheKey := fmt.Sprintf("%s_access_token_%s", CacheKeyPrefix, ctx.AppID)
val := ctx.Cache.Get(accessTokenCacheKey)
if val != nil {
accessToken = val.(string)
return
}
//从微信服务器获取
var resAccessToken ResAccessToken
resAccessToken, err = ctx.GetAccessTokenFromServer()
if err != nil {
return
}
accessToken = resAccessToken.AccessToken
return
}
//GetAccessTokenFromServer 强制从微信服务器获取token
func (ctx *Context) GetAccessTokenFromServer() (resAccessToken ResAccessToken, err error) {
url := fmt.Sprintf("%s?grant_type=client_credential&appid=%s&secret=%s", AccessTokenURL, ctx.AppID, ctx.AppSecret)
var body []byte
body, err = util.HTTPGet(url)
if err != nil {
return
}
err = json.Unmarshal(body, &resAccessToken)
if err != nil {
return
}
if resAccessToken.ErrMsg != "" {
err = fmt.Errorf("get access_token error : errcode=%v , errormsg=%v", resAccessToken.ErrCode, resAccessToken.ErrMsg)
return
}
accessTokenCacheKey := fmt.Sprintf("%s_access_token_%s", CacheKeyPrefix, ctx.AppID)
expires := resAccessToken.ExpiresIn - 1500
err = ctx.Cache.Set(accessTokenCacheKey, resAccessToken.AccessToken, time.Duration(expires)*time.Second)
return
}

View File

@@ -1,31 +1,12 @@
package context package context
import ( import (
"sync" "github.com/silenceper/wechat/v2/credential"
"github.com/silenceper/wechat/v2/officialaccount/config" "github.com/silenceper/wechat/v2/officialaccount/config"
) )
// Context struct // Context struct
type Context struct { type Context struct {
*config.Config *config.Config
credential.AccessTokenHandle
//accessTokenLock 读写锁 同一个AppID一个
accessTokenLock *sync.RWMutex
//jsAPITicket 读写锁 同一个AppID一个
jsAPITicketLock *sync.RWMutex
//accessTokenFunc 自定义获取 access token 的方法
accessTokenFunc GetAccessTokenFunc
}
// SetJsAPITicketLock 设置jsAPITicket的lock
func (ctx *Context) SetJsAPITicketLock(lock *sync.RWMutex) {
ctx.jsAPITicketLock = lock
}
// GetJsAPITicketLock 获取jsAPITicket 的lock
func (ctx *Context) GetJsAPITicketLock() *sync.RWMutex {
return ctx.jsAPITicketLock
} }

View File

@@ -0,0 +1,271 @@
package datacube
import (
"fmt"
"github.com/silenceper/wechat/v2/util"
)
const (
getArticleSummary = "https://api.weixin.qq.com/datacube/getarticlesummary"
getArticleTotal = "https://api.weixin.qq.com/datacube/getarticletotal"
getUserRead = "https://api.weixin.qq.com/datacube/getuserread"
getUserReadHour = "https://api.weixin.qq.com/datacube/getuserreadhour"
getUserShare = "https://api.weixin.qq.com/datacube/getusershare"
getUserShareHour = "https://api.weixin.qq.com/datacube/getusersharehour"
)
// ResArticleSummary 获取图文群发每日数据响应
type ResArticleSummary struct {
util.CommonError
List []struct {
RefDate string `json:"ref_date"`
MsgID string `json:"msgid"`
Title string `json:"title"`
IntPageReadUser int `json:"int_page_read_user"`
IntPageReadCount int `json:"int_page_read_count"`
OriPageReadUser int `json:"ori_page_read_user"`
OriPageReadCount int `json:"ori_page_read_count"`
ShareUser int `json:"share_user"`
ShareCount int `json:"share_count"`
AddToFavUser int `json:"add_to_fav_user"`
AddToFavCount int `json:"add_to_fav_count"`
} `json:"list"`
}
// ResArticleTotal 获取图文群发总数据响应
type ResArticleTotal struct {
util.CommonError
List []struct {
RefDate string `json:"ref_date"`
MsgID string `json:"msgid"`
Title string `json:"title"`
Details []ArticleTotalDetails `json:"details"`
} `json:"list"`
}
// ArticleTotalDetails 获取图文群发总数据响应文字详情
type ArticleTotalDetails struct {
StatDate string `json:"stat_date"`
TargetUser int `json:"target_user"`
IntPageReadUser int `json:"int_page_read_user"`
IntPageReadCount int `json:"int_page_read_count"`
OriPageReadUser int `json:"ori_page_read_user"`
OriPageReadCount int `json:"ori_page_read_count"`
ShareUser int `json:"share_user"`
ShareCount int `json:"share_count"`
AddToFavUser int `json:"add_to_fav_user"`
AddToFavCount int `json:"add_to_fav_count"`
IntPageFromSessionReadUser int `json:"int_page_from_session_read_user"`
IntPageFromSessionReadCount int `json:"int_page_from_session_read_count"`
IntPageFromHistMsgReadUser int `json:"int_page_from_hist_msg_read_user"`
IntPageFromHistMsgReadCount int `json:"int_page_from_hist_msg_read_count"`
IntPageFromFeedReadUser int `json:"int_page_from_feed_read_user"`
IntPageFromFeedReadCount int `json:"int_page_from_feed_read_count"`
IntPageFromFriendsReadUser int `json:"int_page_from_friends_read_user"`
IntPageFromFriendsReadCount int `json:"int_page_from_friends_read_count"`
IntPageFromOtherReadUser int `json:"int_page_from_other_read_user"`
IntPageFromOtherReadCount int `json:"int_page_from_other_read_count"`
FeedShareFromSessionUser int `json:"feed_share_from_session_user"`
FeedShareFromSessionCnt int `json:"feed_share_from_session_cnt"`
FeedShareFromFeedUser int `json:"feed_share_from_feed_user"`
FeedShareFromFeedCnt int `json:"feed_share_from_feed_cnt"`
FeedShareFromOtherUser int `json:"feed_share_from_other_user"`
FeedShareFromOtherCnt int `json:"feed_share_from_other_cnt"`
}
// ResUserRead 获取图文统计数据响应
type ResUserRead struct {
util.CommonError
List []struct {
RefDate string `json:"ref_date"`
UserSource int `json:"user_source"`
IntPageReadUser int `json:"int_page_read_user"`
IntPageReadCount int `json:"int_page_read_count"`
OriPageReadUser int `json:"ori_page_read_user"`
OriPageReadCount int `json:"ori_page_read_count"`
ShareUser int `json:"share_user"`
ShareCount int `json:"share_count"`
AddToFavUser int `json:"add_to_fav_user"`
AddToFavCount int `json:"add_to_fav_count"`
} `json:"list"`
}
// ResUserReadHour 获取图文统计分时数据
type ResUserReadHour struct {
util.CommonError
List []struct {
RefDate string `json:"ref_date"`
RefHour int `json:"ref_hour"`
UserSource int `json:"user_source"`
IntPageReadUser int `json:"int_page_read_user"`
IntPageReadCount int `json:"int_page_read_count"`
OriPageReadUser int `json:"ori_page_read_user"`
OriPageReadCount int `json:"ori_page_read_count"`
ShareUser int `json:"share_user"`
ShareCount int `json:"share_count"`
AddToFavUser int `json:"add_to_fav_user"`
AddToFavCount int `json:"add_to_fav_count"`
} `json:"list"`
}
// ResUserShare 获取图文分享转发数据
type ResUserShare struct {
util.CommonError
List []struct {
RefDate string `json:"ref_date"`
ShareScene int `json:"share_scene"`
ShareCount int `json:"share_count"`
ShareUser int `json:"share_user"`
} `json:"list"`
}
// ResUserShareHour 获取图文分享转发分时数据
type ResUserShareHour struct {
util.CommonError
List []struct {
RefDate string `json:"ref_date"`
RefHour int `json:"ref_hour"`
ShareScene int `json:"share_scene"`
ShareCount int `json:"share_count"`
ShareUser int `json:"share_user"`
} `json:"list"`
}
// GetArticleSummary 获取图文群发每日数据
func (cube *DataCube) GetArticleSummary(s string, e string) (resArticleSummary ResArticleSummary, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getArticleSummary, accessToken)
reqDate := &reqDate{
BeginDate: s,
EndDate: e,
}
response, err := util.PostJSON(uri, reqDate)
if err != nil {
return
}
err = util.DecodeWithError(response, &resArticleSummary, "GetArticleSummary")
return
}
// GetArticleTotal 获取图文群发总数据
func (cube *DataCube) GetArticleTotal(s string, e string) (resArticleTotal ResArticleTotal, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getArticleTotal, accessToken)
reqDate := &reqDate{
BeginDate: s,
EndDate: e,
}
response, err := util.PostJSON(uri, reqDate)
if err != nil {
return
}
err = util.DecodeWithError(response, &resArticleTotal, "GetArticleTotal")
return
}
// GetUserRead 获取图文统计数据
func (cube *DataCube) GetUserRead(s string, e string) (resUserRead ResUserRead, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getUserRead, accessToken)
reqDate := &reqDate{
BeginDate: s,
EndDate: e,
}
response, err := util.PostJSON(uri, reqDate)
if err != nil {
return
}
err = util.DecodeWithError(response, &resUserRead, "GetUserRead")
return
}
// GetUserReadHour 获取图文统计分时数据
func (cube *DataCube) GetUserReadHour(s string, e string) (resUserReadHour ResUserReadHour, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getUserReadHour, accessToken)
reqDate := &reqDate{
BeginDate: s,
EndDate: e,
}
response, err := util.PostJSON(uri, reqDate)
if err != nil {
return
}
err = util.DecodeWithError(response, &resUserReadHour, "GetUserReadHour")
return
}
// GetUserShare 获取图文分享转发数据
func (cube *DataCube) GetUserShare(s string, e string) (resUserShare ResUserShare, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getUserShare, accessToken)
reqDate := &reqDate{
BeginDate: s,
EndDate: e,
}
response, err := util.PostJSON(uri, reqDate)
if err != nil {
return
}
err = util.DecodeWithError(response, &resUserShare, "GetUserShare")
return
}
// GetUserShareHour 获取图文分享转发分时数据
func (cube *DataCube) GetUserShareHour(s string, e string) (resUserShareHour ResUserShareHour, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getUserShareHour, accessToken)
reqDate := &reqDate{
BeginDate: s,
EndDate: e,
}
response, err := util.PostJSON(uri, reqDate)
if err != nil {
return
}
err = util.DecodeWithError(response, &resUserShareHour, "GetUserShareHour")
return
}

View File

@@ -0,0 +1,22 @@
package datacube
import (
"github.com/silenceper/wechat/v2/officialaccount/context"
)
type reqDate struct {
BeginDate string `json:"begin_date"`
EndDate string `json:"end_date"`
}
// DataCube 数据统计
type DataCube struct {
*context.Context
}
// NewCube 数据统计
func NewCube(context *context.Context) *DataCube {
dataCube := new(DataCube)
dataCube.Context = context
return dataCube
}

View File

@@ -0,0 +1,83 @@
package datacube
import (
"fmt"
"github.com/silenceper/wechat/v2/util"
)
const (
getInterfaceSummary = "https://api.weixin.qq.com/datacube/getinterfacesummary"
getInterfaceSummaryHour = "https://api.weixin.qq.com/datacube/getinterfacesummaryhour"
)
// ResInterfaceSummary 接口分析数据响应
type ResInterfaceSummary struct {
util.CommonError
List []struct {
RefDate string `json:"ref_date"`
CallbackCount int `json:"callback_count"`
FailCount int `json:"fail_count"`
TotalTimeCost int `json:"total_time_cost"`
MaxTimeCost int `json:"max_time_cost"`
} `json:"list"`
}
// ResInterfaceSummaryHour 接口分析分时数据响应
type ResInterfaceSummaryHour struct {
util.CommonError
List []struct {
RefDate string `json:"ref_date"`
RefHour int `json:"ref_hour"`
CallbackCount int `json:"callback_count"`
FailCount int `json:"fail_count"`
TotalTimeCost int `json:"total_time_cost"`
MaxTimeCost int `json:"max_time_cost"`
} `json:"list"`
}
// GetInterfaceSummary 获取接口分析数据
func (cube *DataCube) GetInterfaceSummary(s string, e string) (resInterfaceSummary ResInterfaceSummary, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getInterfaceSummary, accessToken)
reqDate := &reqDate{
BeginDate: s,
EndDate: e,
}
response, err := util.PostJSON(uri, reqDate)
if err != nil {
return
}
err = util.DecodeWithError(response, &resInterfaceSummary, "GetInterfaceSummary")
return
}
// GetInterfaceSummaryHour 获取接口分析分时数据
func (cube *DataCube) GetInterfaceSummaryHour(s string, e string) (resInterfaceSummaryHour ResInterfaceSummaryHour, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getInterfaceSummaryHour, accessToken)
reqDate := &reqDate{
BeginDate: s,
EndDate: e,
}
response, err := util.PostJSON(uri, reqDate)
if err != nil {
return
}
err = util.DecodeWithError(response, &resInterfaceSummaryHour, "GetInterfaceSummaryHour")
return
}

View File

@@ -0,0 +1,253 @@
package datacube
import (
"fmt"
"github.com/silenceper/wechat/v2/util"
)
const (
getUpstreamMsg = "https://api.weixin.qq.com/datacube/getupstreammsg"
getUpstreamMsgHour = "https://api.weixin.qq.com/datacube/getupstreammsghour"
getUpstreamMsgWeek = "https://api.weixin.qq.com/datacube/getupstreammsgweek"
getUpstreamMsgMonth = "https://api.weixin.qq.com/datacube/getupstreammsgmonth"
getUpstreamMsgDist = "https://api.weixin.qq.com/datacube/getupstreammsgdist"
getUpstreamMsgDistWeek = "https://api.weixin.qq.com/datacube/getupstreammsgdistweek"
getUpstreamMsgDistMonth = "https://api.weixin.qq.com/datacube/getupstreammsgdistmonth"
)
// ResUpstreamMsg 获取消息发送概况数据响应
type ResUpstreamMsg struct {
util.CommonError
List []struct {
RefDate string `json:"ref_date"`
MsgType int `json:"msg_type"`
MsgUser int `json:"msg_user"`
MsgCount int `json:"msg_count"`
} `json:"list"`
}
// ResUpstreamMsgHour 获取消息分送分时数据响应
type ResUpstreamMsgHour struct {
util.CommonError
List []struct {
RefDate string `json:"ref_date"`
RefHour int `json:"ref_hour"`
MsgType int `json:"msg_type"`
MsgUser int `json:"msg_user"`
MsgCount int `json:"msg_count"`
} `json:"list"`
}
// ResUpstreamMsgWeek 获取消息发送周数据响应
type ResUpstreamMsgWeek struct {
util.CommonError
List []struct {
RefDate string `json:"ref_date"`
MsgType int `json:"msg_type"`
MsgUser int `json:"msg_user"`
MsgCount int `json:"msg_count"`
} `json:"list"`
}
// ResUpstreamMsgMonth 获取消息发送月数据响应
type ResUpstreamMsgMonth struct {
util.CommonError
List []struct {
RefDate string `json:"ref_date"`
MsgType int `json:"msg_type"`
MsgUser int `json:"msg_user"`
MsgCount int `json:"msg_count"`
} `json:"list"`
}
// ResUpstreamMsgDist 获取消息发送分布数据响应
type ResUpstreamMsgDist struct {
util.CommonError
List []struct {
RefDate string `json:"ref_date"`
CountInterval int `json:"count_interval"`
MsgUser int `json:"msg_user"`
} `json:"list"`
}
// ResUpstreamMsgDistWeek 获取消息发送分布周数据响应
type ResUpstreamMsgDistWeek struct {
util.CommonError
List []struct {
RefDate string `json:"ref_date"`
CountInterval int `json:"count_interval"`
MsgUser int `json:"msg_user"`
} `json:"list"`
}
// ResUpstreamMsgDistMonth 获取消息发送分布月数据响应
type ResUpstreamMsgDistMonth struct {
util.CommonError
List []struct {
RefDate string `json:"ref_date"`
CountInterval int `json:"count_interval"`
MsgUser int `json:"msg_user"`
} `json:"list"`
}
// GetUpstreamMsg 获取消息发送概况数据
func (cube *DataCube) GetUpstreamMsg(s string, e string) (resUpstreamMsg ResUpstreamMsg, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getUpstreamMsg, accessToken)
reqDate := &reqDate{
BeginDate: s,
EndDate: e,
}
response, err := util.PostJSON(uri, reqDate)
if err != nil {
return
}
err = util.DecodeWithError(response, &resUpstreamMsg, "GetUpstreamMsg")
return
}
// GetUpstreamMsgHour 获取消息分送分时数据
func (cube *DataCube) GetUpstreamMsgHour(s string, e string) (resUpstreamMsgHour ResUpstreamMsgHour, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getUpstreamMsgHour, accessToken)
reqDate := &reqDate{
BeginDate: s,
EndDate: e,
}
response, err := util.PostJSON(uri, reqDate)
if err != nil {
return
}
err = util.DecodeWithError(response, &resUpstreamMsgHour, "GetUpstreamMsgHour")
return
}
// GetUpstreamMsgWeek 获取消息发送周数据
func (cube *DataCube) GetUpstreamMsgWeek(s string, e string) (resUpstreamMsgWeek ResUpstreamMsgWeek, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getUpstreamMsgWeek, accessToken)
reqDate := &reqDate{
BeginDate: s,
EndDate: e,
}
response, err := util.PostJSON(uri, reqDate)
if err != nil {
return
}
err = util.DecodeWithError(response, &resUpstreamMsgWeek, "GetUpstreamMsgWeek")
return
}
// GetUpstreamMsgMonth 获取消息发送月数据
func (cube *DataCube) GetUpstreamMsgMonth(s string, e string) (resUpstreamMsgMonth ResUpstreamMsgMonth, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getUpstreamMsgMonth, accessToken)
reqDate := &reqDate{
BeginDate: s,
EndDate: e,
}
response, err := util.PostJSON(uri, reqDate)
if err != nil {
return
}
err = util.DecodeWithError(response, &resUpstreamMsgMonth, "GetUpstreamMsgMonth")
return
}
// GetUpstreamMsgDist 获取消息发送分布数据
func (cube *DataCube) GetUpstreamMsgDist(s string, e string) (resUpstreamMsgDist ResUpstreamMsgDist, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getUpstreamMsgDist, accessToken)
reqDate := &reqDate{
BeginDate: s,
EndDate: e,
}
response, err := util.PostJSON(uri, reqDate)
if err != nil {
return
}
err = util.DecodeWithError(response, &resUpstreamMsgDist, "GetUpstreamMsgDist")
return
}
// GetUpstreamMsgDistWeek 获取消息发送分布周数据
func (cube *DataCube) GetUpstreamMsgDistWeek(s string, e string) (resUpstreamMsgDistWeek ResUpstreamMsgDistWeek, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getUpstreamMsgDistWeek, accessToken)
reqDate := &reqDate{
BeginDate: s,
EndDate: e,
}
response, err := util.PostJSON(uri, reqDate)
if err != nil {
return
}
err = util.DecodeWithError(response, &resUpstreamMsgDistWeek, "GetUpstreamMsgDistWeek")
return
}
// GetUpstreamMsgDistMonth 获取消息发送分布月数据
func (cube *DataCube) GetUpstreamMsgDistMonth(s string, e string) (resUpstreamMsgDistMonth ResUpstreamMsgDistMonth, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getUpstreamMsgDistMonth, accessToken)
reqDate := &reqDate{
BeginDate: s,
EndDate: e,
}
response, err := util.PostJSON(uri, reqDate)
if err != nil {
return
}
err = util.DecodeWithError(response, &resUpstreamMsgDistMonth, "GetUpstreamMsgDistMonth")
return
}

View File

@@ -0,0 +1,272 @@
package datacube
import (
"fmt"
"net/url"
"strconv"
"github.com/silenceper/wechat/v2/util"
)
// AdSlot 广告位类型
type AdSlot string
const (
// SlotIDBizBottom 公众号底部广告
SlotIDBizBottom AdSlot = "SLOT_ID_BIZ_BOTTOM"
// SlotIDBizMidContext 公众号文中广告
SlotIDBizMidContext AdSlot = "SLOT_ID_BIZ_MID_CONTEXT"
// SlotIDBizVideoEnd 公众号视频后贴
SlotIDBizVideoEnd AdSlot = "SLOT_ID_BIZ_VIDEO_END"
// SlotIDBizSponsor 公众号互选广告
SlotIDBizSponsor AdSlot = "SLOT_ID_BIZ_SPONSOR"
// SlotIDBizCps 公众号返佣商品
SlotIDBizCps AdSlot = "SLOT_ID_BIZ_CPS"
// SlotIDWeappBanner 小程序banner
SlotIDWeappBanner AdSlot = "SLOT_ID_WEAPP_BANNER"
// SlotIDWeappRewardVideo 小程序激励视频
SlotIDWeappRewardVideo AdSlot = "SLOT_ID_WEAPP_REWARD_VIDEO"
// SlotIDWeappInterstitial 小程序插屏广告
SlotIDWeappInterstitial AdSlot = "SLOT_ID_WEAPP_INTERSTITIAL"
// SlotIDWeappVideoFeeds 小程序视频广告
SlotIDWeappVideoFeeds AdSlot = "SLOT_ID_WEAPP_VIDEO_FEEDS"
// SlotIDWeappVideoBegin 小程序视频前贴
SlotIDWeappVideoBegin AdSlot = "SLOT_ID_WEAPP_VIDEO_BEGIN"
// SlotIDWeappBox 小程序格子广告
SlotIDWeappBox AdSlot = "SLOT_ID_WEAPP_BOX"
)
const (
publisherURL = "https://api.weixin.qq.com/publisher/stat"
)
const (
actionPublisherAdPosGeneral = "publisher_adpos_general"
actionPublisherCpsGeneral = "publisher_cps_general"
actionPublisherSettlement = "publisher_settlement"
)
// BaseResp 错误信息
type BaseResp struct {
ErrMsg string `json:"err_msg"`
Ret int `json:"ret"`
}
// ResPublisherAdPos 公众号分广告位数据响应
type ResPublisherAdPos struct {
util.CommonError
BaseResp BaseResp `json:"base_resp"`
List []ResAdPosList `json:"list"`
Summary ResAdPosSummary `json:"summary"`
TotalNum int `json:"total_num"`
}
// ResAdPosList 公众号分广告位列表
type ResAdPosList struct {
SlotID int64 `json:"slot_id"`
AdSlot string `json:"ad_slot"`
Date string `json:"date"`
ReqSuccCount int `json:"req_succ_count"`
ExposureCount int `json:"exposure_count"`
ExposureRate float64 `json:"exposure_rate"`
ClickCount int `json:"click_count"`
ClickRate float64 `json:"click_rate"`
Income int `json:"income"`
Ecpm float64 `json:"ecpm"`
}
// ResAdPosSummary 公众号分广告位概览
type ResAdPosSummary struct {
ReqSuccCount int `json:"req_succ_count"`
ExposureCount int `json:"exposure_count"`
ExposureRate float64 `json:"exposure_rate"`
ClickCount int `json:"click_count"`
ClickRate float64 `json:"click_rate"`
Income int `json:"income"`
Ecpm float64 `json:"ecpm"`
}
// ResPublisherCps 公众号返佣商品数据响应
type ResPublisherCps struct {
util.CommonError
BaseResp BaseResp `json:"base_resp"`
List []ResCpsList `json:"list"`
Summary ResCpsSummary `json:"summary"`
TotalNum int `json:"total_num"`
}
// ResCpsList 公众号返佣商品列表
type ResCpsList struct {
Date string `json:"date"`
ExposureCount int `json:"exposure_count"`
ClickCount int `json:"click_count"`
ClickRate float64 `json:"click_rate"`
OrderCount int `json:"order_count"`
OrderRate float64 `json:"order_rate"`
TotalFee int `json:"total_fee"`
TotalCommission int `json:"total_commission"`
}
// ResCpsSummary 公众号返佣概览
type ResCpsSummary struct {
ExposureCount int `json:"exposure_count"`
ClickCount int `json:"click_count"`
ClickRate float64 `json:"click_rate"`
OrderCount int `json:"order_count"`
OrderRate float64 `json:"order_rate"`
TotalFee int `json:"total_fee"`
TotalCommission int `json:"total_commission"`
}
// ResPublisherSettlement 公众号结算收入数据及结算主体信息响应
type ResPublisherSettlement struct {
util.CommonError
BaseResp BaseResp `json:"base_resp"`
Body string `json:"body"`
PenaltyAll int `json:"penalty_all"`
RevenueAll int64 `json:"revenue_all"`
SettledRevenueAll int64 `json:"settled_revenue_all"`
SettlementList []SettlementList `json:"settlement_list"`
TotalNum int `json:"total_num"`
}
// SettlementList 结算单列表
type SettlementList struct {
Date string `json:"date"`
Zone string `json:"zone"`
Month string `json:"month"`
Order int `json:"order"`
SettStatus int `json:"sett_status"`
SettledRevenue int `json:"settled_revenue"`
SettNo string `json:"sett_no"`
MailSendCnt string `json:"mail_send_cnt"`
SlotRevenue []SlotRevenue `json:"slot_revenue"`
}
// SlotRevenue 产生收入的广告
type SlotRevenue struct {
SlotID string `json:"slot_id"`
SlotSettledRevenue int `json:"slot_settled_revenue"`
}
// ParamsPublisher 拉取数据参数
type ParamsPublisher struct {
Action string `json:"action"`
StartDate string `json:"start_date"`
EndDate string `json:"end_date"`
Page int `json:"page"`
PageSize int `json:"page_size"`
AdSlot AdSlot `json:"ad_slot"`
}
// fetchData 拉取统计数据
func (cube *DataCube) fetchData(params ParamsPublisher) (response []byte, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
v := url.Values{}
v.Add("action", params.Action)
v.Add("access_token", accessToken)
v.Add("page", strconv.Itoa(params.Page))
v.Add("page_size", strconv.Itoa(params.PageSize))
v.Add("start_date", params.StartDate)
v.Add("end_date", params.EndDate)
if params.AdSlot != "" {
v.Add("ad_slot", string(params.AdSlot))
}
uri := fmt.Sprintf("%s?%s", publisherURL, v.Encode())
response, err = util.HTTPGet(uri)
if err != nil {
return
}
return
}
// GetPublisherAdPosGeneral 获取公众号分广告位数据
func (cube *DataCube) GetPublisherAdPosGeneral(startDate, endDate string, page, pageSize int, adSlot AdSlot) (resPublisherAdPos ResPublisherAdPos, err error) {
params := ParamsPublisher{
Action: actionPublisherAdPosGeneral,
StartDate: startDate,
EndDate: endDate,
Page: page,
PageSize: pageSize,
AdSlot: adSlot,
}
response, err := cube.fetchData(params)
if err != nil {
return
}
err = util.DecodeWithError(response, &resPublisherAdPos, "GetPublisherAdPosGeneral")
if err != nil {
return
}
if resPublisherAdPos.BaseResp.Ret != 0 {
err = fmt.Errorf("GetPublisherAdPosGeneral Error , errcode=%d , errmsg=%s", resPublisherAdPos.BaseResp.Ret, resPublisherAdPos.BaseResp.ErrMsg)
return
}
return
}
// GetPublisherCpsGeneral 获取公众号返佣商品数据
func (cube *DataCube) GetPublisherCpsGeneral(startDate, endDate string, page, pageSize int) (resPublisherCps ResPublisherCps, err error) {
params := ParamsPublisher{
Action: actionPublisherCpsGeneral,
StartDate: startDate,
EndDate: endDate,
Page: page,
PageSize: pageSize,
}
response, err := cube.fetchData(params)
if err != nil {
return
}
err = util.DecodeWithError(response, &resPublisherCps, "GetPublisherCpsGeneral")
if err != nil {
return
}
if resPublisherCps.BaseResp.Ret != 0 {
err = fmt.Errorf("GetPublisherCpsGeneral Error , errcode=%d , errmsg=%s", resPublisherCps.BaseResp.Ret, resPublisherCps.BaseResp.ErrMsg)
return
}
return
}
// GetPublisherSettlement 获取公众号结算收入数据及结算主体信息
func (cube *DataCube) GetPublisherSettlement(startDate, endDate string, page, pageSize int) (resPublisherSettlement ResPublisherSettlement, err error) {
params := ParamsPublisher{
Action: actionPublisherSettlement,
StartDate: startDate,
EndDate: endDate,
Page: page,
PageSize: pageSize,
}
response, err := cube.fetchData(params)
if err != nil {
return
}
err = util.DecodeWithError(response, &resPublisherSettlement, "GetPublisherSettlement")
if err != nil {
return
}
if resPublisherSettlement.BaseResp.Ret != 0 {
err = fmt.Errorf("GetPublisherSettlement Error , errcode=%d , errmsg=%s", resPublisherSettlement.BaseResp.Ret, resPublisherSettlement.BaseResp.ErrMsg)
return
}
return
}

View File

@@ -0,0 +1,78 @@
package datacube
import (
"fmt"
"github.com/silenceper/wechat/v2/util"
)
const (
getUserSummary = "https://api.weixin.qq.com/datacube/getusersummary"
getUserAccumulate = "https://api.weixin.qq.com/datacube/getusercumulate"
)
// ResUserSummary 获取用户增减数据响应
type ResUserSummary struct {
util.CommonError
List []struct {
RefDate string `json:"ref_date"`
UserSource int `json:"user_source"`
NewUser int `json:"new_user"`
CancelUser int `json:"cancel_user"`
} `json:"list"`
}
// ResUserAccumulate 获取累计用户数据响应
type ResUserAccumulate struct {
util.CommonError
List []struct {
RefDate string `json:"ref_date"`
CumulateUser int `json:"cumulate_user"`
} `json:"list"`
}
// GetUserSummary 获取用户增减数据
func (cube *DataCube) GetUserSummary(s string, e string) (resUserSummary ResUserSummary, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getUserSummary, accessToken)
reqDate := &reqDate{
BeginDate: s,
EndDate: e,
}
response, err := util.PostJSON(uri, reqDate)
if err != nil {
return
}
err = util.DecodeWithError(response, &resUserSummary, "GetUserSummary")
return
}
// GetUserAccumulate 获取累计用户数据
func (cube *DataCube) GetUserAccumulate(s string, e string) (resUserAccumulate ResUserAccumulate, err error) {
accessToken, err := cube.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getUserAccumulate, accessToken)
reqDate := &reqDate{
BeginDate: s,
EndDate: e,
}
response, err := util.PostJSON(uri, reqDate)
if err != nil {
return
}
err = util.DecodeWithError(response, &resUserAccumulate, "GetUserAccumulate")
return
}

View File

@@ -1,3 +1,4 @@
// Package device 设备相关接口
package device package device
import ( import (
@@ -22,13 +23,13 @@ type reqDeviceAuthorize struct {
// 请求操作的类型限定取值为0设备授权缺省值为0 1设备更新更新已授权设备的各属性值 // 请求操作的类型限定取值为0设备授权缺省值为0 1设备更新更新已授权设备的各属性值
OpType string `json:"op_type,omitempty"` OpType string `json:"op_type,omitempty"`
// 设备的产品编号(由微信硬件平台分配)。可在公众号设备功能管理页面查询。 // 设备的产品编号(由微信硬件平台分配)。可在公众号设备功能管理页面查询。
//当 op_type 为0product_id 为1不要填写 product_id 字段(会引起不必要错误); // 当 op_type 为0product_id 为1不要填写 product_id 字段(会引起不必要错误);
//当 op_typy 为0product_id 不为1必须填写 product_id 字段; // 当 op_typy 为0product_id 不为1必须填写 product_id 字段;
//当 op_type 为 1 时,不要填写 product_id 字段。 // 当 op_type 为 1 时,不要填写 product_id 字段。
ProductID string `json:"product_id,omitempty"` ProductID string `json:"product_id,omitempty"`
} }
//ReqDevice 设备授权实体 // ReqDevice 设备授权实体
type ReqDevice struct { type ReqDevice struct {
// 设备的 device id // 设备的 device id
ID string `json:"id"` ID string `json:"id"`
@@ -41,22 +42,22 @@ type ReqDevice struct {
// ble 3 // ble 3
// wifi -- 4 // wifi -- 4
// 一个设备可以支持多种连接类型,用符号"|"做分割,客户端优先选择靠前的连接方式(优先级按|关系的排序依次降低),举例: // 一个设备可以支持多种连接类型,用符号"|"做分割,客户端优先选择靠前的连接方式(优先级按|关系的排序依次降低),举例:
// 1表示设备仅支持andiod classic bluetooth 1|2表示设备支持andiod 和ios 两种classic bluetooth但是客户端优先选择andriod classic bluetooth 协议如果andriod classic bluetooth协议连接失败再选择ios classic bluetooth协议进行连接 // 1表示设备仅支持andiod classic bluetooth 1|2表示设备支持android 和ios 两种classic bluetooth但是客户端优先选择android classic bluetooth 协议如果android classic bluetooth协议连接失败再选择ios classic bluetooth协议进行连接
// 安卓平台不同时支持BLE和classic类型 // 安卓平台不同时支持BLE和classic类型
ConnectProtocol string `json:"connect_protocol"` 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"` AuthKey string `json:"auth_key"`
// 断开策略,目前支持: 1退出公众号页面时即断开连接 2退出公众号之后保持连接不断开 // 断开策略,目前支持: 1退出公众号页面时即断开连接 2退出公众号之后保持连接不断开
CloseStrategy string `json:"close_strategy"` CloseStrategy string `json:"close_strategy"`
//连接策略32位整型按bit位置位目前仅第1bit和第3bit位有效bit置0为无效1为有效第2bit已被废弃且bit位可以按或置位如1|4=5各bit置位含义说明如下 // 连接策略32位整型按bit位置位目前仅第1bit和第3bit位有效bit置0为无效1为有效第2bit已被废弃且bit位可以按或置位如1|4=5各bit置位含义说明如下
//1第1bit置位在公众号对话页面不停的尝试连接设备 // 1第1bit置位在公众号对话页面不停的尝试连接设备
//4第3bit置位处于非公众号页面如主界面等微信自动连接。当用户切换微信到前台时可能尝试去连接设备连上后一定时间会断开 // 4第3bit置位处于非公众号页面如主界面等微信自动连接。当用户切换微信到前台时可能尝试去连接设备连上后一定时间会断开
ConnStrategy string `json:"conn_strategy"` ConnStrategy string `json:"conn_strategy"`
// auth version设备和微信进行auth时会根据该版本号来确认auth buf和auth key的格式各version对应的auth buf及key的具体格式可以参看“客户端蓝牙外设协议”该字段目前支持取值 // auth version设备和微信进行auth时会根据该版本号来确认auth buf和auth key的格式各version对应的auth buf及key的具体格式可以参看“客户端蓝牙外设协议”该字段目前支持取值
// 0不加密的version // 0不加密的version
// 1version 1 // 1version 1
AuthVer string `json:"auth_ver"` AuthVer string `json:"auth_ver"`
// 表示mac地址在厂商广播manufature data里含有mac地址的偏移取值如下 // 表示mac地址在厂商广播manufacture data里含有mac地址的偏移取值如下
// -1在尾部、 // -1在尾部、
// -2表示不包含mac地址 其他:非法偏移 // -2表示不包含mac地址 其他:非法偏移
ManuMacPos string `json:"manu_mac_pos"` ManuMacPos string `json:"manu_mac_pos"`
@@ -68,7 +69,7 @@ type ReqDevice struct {
BleSimpleProtocol string `json:"ble_simple_protocol,omitempty"` BleSimpleProtocol string `json:"ble_simple_protocol,omitempty"`
} }
//ResBaseInfo 授权回调实体 // ResBaseInfo 授权回调实体
type ResBaseInfo struct { type ResBaseInfo struct {
BaseInfo struct { BaseInfo struct {
DeviceType string `json:"device_type"` DeviceType string `json:"device_type"`

View File

@@ -19,12 +19,12 @@ const (
uriState = "https://api.weixin.qq.com/device/get_stat" uriState = "https://api.weixin.qq.com/device/get_stat"
) )
//Device struct // Device struct
type Device struct { type Device struct {
*context.Context *context.Context
} }
//NewDevice 实例 // NewDevice 实例
func NewDevice(context *context.Context) *Device { func NewDevice(context *context.Context) *Device {
device := new(Device) device := new(Device)
device.Context = context device.Context = context

View File

@@ -1,6 +1,6 @@
package device package device
//MsgDevice 设备消息响应 // MsgDevice 设备消息响应
type MsgDevice struct { type MsgDevice struct {
DeviceType string DeviceType string
DeviceID string DeviceID string

View File

@@ -7,7 +7,7 @@ import (
"github.com/silenceper/wechat/v2/util" "github.com/silenceper/wechat/v2/util"
) )
//ResCreateQRCode 获取二维码的返回实体 // ResCreateQRCode 获取二维码的返回实体
type ResCreateQRCode struct { type ResCreateQRCode struct {
util.CommonError util.CommonError
DeviceNum int `json:"device_num"` DeviceNum int `json:"device_num"`
@@ -42,7 +42,7 @@ func (d *Device) CreateQRCode(devices []string) (res ResCreateQRCode, err error)
return return
} }
//ResVerifyQRCode 验证授权结果实体 // ResVerifyQRCode 验证授权结果实体
type ResVerifyQRCode struct { type ResVerifyQRCode struct {
util.CommonError util.CommonError
DeviceType string `json:"device_type"` DeviceType string `json:"device_type"`
@@ -60,7 +60,7 @@ func (d *Device) VerifyQRCode(ticket string) (res ResVerifyQRCode, err error) {
req := map[string]interface{}{ req := map[string]interface{}{
"ticket": ticket, "ticket": ticket,
} }
fmt.Println(req)
var response []byte var response []byte
if response, err = util.PostJSON(uri, req); err != nil { if response, err = util.PostJSON(uri, req); err != nil {
return return

View File

@@ -0,0 +1,228 @@
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")
if err != nil {
return
}
mediaID = res.MediaID
return
}
// 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")
if err != nil {
return
}
articles = res.NewsItem
return
}
// 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")
if nil != err {
return
}
total = res.Total
return
}
// 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
}

View File

@@ -0,0 +1,248 @@
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")
if err != nil {
return
}
publishID = res.PublishID
return
}
// 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")
if err != nil {
return
}
list = res.NewsItem
return
}
// 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
}

View File

@@ -1,19 +1,17 @@
package js package js
import ( import (
"encoding/json"
"fmt" "fmt"
"time"
"github.com/silenceper/wechat/v2/credential"
"github.com/silenceper/wechat/v2/officialaccount/context" "github.com/silenceper/wechat/v2/officialaccount/context"
"github.com/silenceper/wechat/v2/util" "github.com/silenceper/wechat/v2/util"
) )
const getTicketURL = "https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=%s&type=jsapi"
// Js struct // Js struct
type Js struct { type Js struct {
*context.Context *context.Context
credential.JsTicketHandle
} }
// Config 返回给用户jssdk配置信息 // Config 返回给用户jssdk配置信息
@@ -24,33 +22,37 @@ type Config struct {
Signature string `json:"signature"` Signature string `json:"signature"`
} }
// resTicket 请求jsapi_tikcet返回结果 // NewJs init
type resTicket struct {
util.CommonError
Ticket string `json:"ticket"`
ExpiresIn int64 `json:"expires_in"`
}
//NewJs init
func NewJs(context *context.Context) *Js { func NewJs(context *context.Context) *Js {
js := new(Js) js := new(Js)
js.Context = context js.Context = context
jsTicketHandle := credential.NewDefaultJsTicket(context.AppID, credential.CacheKeyOfficialAccountPrefix, context.Cache)
js.SetJsTicketHandle(jsTicketHandle)
return js return js
} }
//GetConfig 获取jssdk需要的配置参数 // SetJsTicketHandle 自定义js ticket取值方式
//uri 为当前网页地址 func (js *Js) SetJsTicketHandle(ticketHandle credential.JsTicketHandle) {
js.JsTicketHandle = ticketHandle
}
// GetConfig 获取jssdk需要的配置参数
// uri 为当前网页地址
func (js *Js) GetConfig(uri string) (config *Config, err error) { func (js *Js) GetConfig(uri string) (config *Config, err error) {
config = new(Config) config = new(Config)
var accessToken string
accessToken, err = js.GetAccessToken()
if err != nil {
return
}
var ticketStr string var ticketStr string
ticketStr, err = js.GetTicket() ticketStr, err = js.GetTicket(accessToken)
if err != nil { if err != nil {
return return
} }
nonceStr := util.RandomStr(16) nonceStr := util.RandomStr(16)
timestamp := util.GetCurrTs() timestamp := util.GetCurrTS()
str := fmt.Sprintf("jsapi_ticket=%s&noncestr=%s&timestamp=%d&url=%s", ticketStr, nonceStr, timestamp, uri) str := fmt.Sprintf("jsapi_ticket=%s&noncestr=%s&timestamp=%d&url=%s", ticketStr, nonceStr, timestamp, uri)
sigStr := util.Signature(str) sigStr := util.Signature(str)
@@ -60,50 +62,3 @@ func (js *Js) GetConfig(uri string) (config *Config, err error) {
config.Signature = sigStr config.Signature = sigStr
return return
} }
//GetTicket 获取jsapi_ticket
func (js *Js) GetTicket() (ticketStr string, err error) {
js.GetJsAPITicketLock().Lock()
defer js.GetJsAPITicketLock().Unlock()
//先从cache中取
jsAPITicketCacheKey := fmt.Sprintf("%s_jsapi_ticket_%s", context.CacheKeyPrefix, js.AppID)
val := js.Cache.Get(jsAPITicketCacheKey)
if val != nil {
ticketStr = val.(string)
return
}
var ticket resTicket
ticket, err = js.getTicketFromServer()
if err != nil {
return
}
ticketStr = ticket.Ticket
return
}
//getTicketFromServer 强制从服务器中获取ticket
func (js *Js) getTicketFromServer() (ticket resTicket, err error) {
var accessToken string
accessToken, err = js.GetAccessToken()
if err != nil {
return
}
var response []byte
url := fmt.Sprintf(getTicketURL, accessToken)
response, err = util.HTTPGet(url)
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
}
jsAPITicketCacheKey := fmt.Sprintf("%s_jsapi_ticket_%s", context.CacheKeyPrefix, js.AppID)
expires := ticket.ExpiresIn - 1500
err = js.Cache.Set(jsAPITicketCacheKey, ticket.Ticket, time.Duration(expires)*time.Second)
return
}

View File

@@ -10,25 +10,42 @@ import (
) )
const ( const (
addNewsURL = "https://api.weixin.qq.com/cgi-bin/material/add_news" addNewsURL = "https://api.weixin.qq.com/cgi-bin/material/add_news"
addMaterialURL = "https://api.weixin.qq.com/cgi-bin/material/add_material" updateNewsURL = "https://api.weixin.qq.com/cgi-bin/material/update_news"
delMaterialURL = "https://api.weixin.qq.com/cgi-bin/material/del_material" addMaterialURL = "https://api.weixin.qq.com/cgi-bin/material/add_material"
getMaterialURL = "https://api.weixin.qq.com/cgi-bin/material/get_material" delMaterialURL = "https://api.weixin.qq.com/cgi-bin/material/del_material"
getMaterialURL = "https://api.weixin.qq.com/cgi-bin/material/get_material"
getMaterialCountURL = "https://api.weixin.qq.com/cgi-bin/material/get_materialcount"
batchGetMaterialURL = "https://api.weixin.qq.com/cgi-bin/material/batchget_material"
) )
//Material 素材管理 // PermanentMaterialType 永久素材类型
type PermanentMaterialType string
const (
// PermanentMaterialTypeImage 永久素材图片类型image
PermanentMaterialTypeImage PermanentMaterialType = "image"
// PermanentMaterialTypeVideo 永久素材视频类型video
PermanentMaterialTypeVideo PermanentMaterialType = "video"
// PermanentMaterialTypeVoice 永久素材语音类型 voice
PermanentMaterialTypeVoice PermanentMaterialType = "voice"
// PermanentMaterialTypeNews 永久素材图文类型news
PermanentMaterialTypeNews PermanentMaterialType = "news"
)
// Material 素材管理
type Material struct { type Material struct {
*context.Context *context.Context
} }
//NewMaterial init // NewMaterial init
func NewMaterial(context *context.Context) *Material { func NewMaterial(context *context.Context) *Material {
material := new(Material) material := new(Material)
material.Context = context material.Context = context
return material return material
} }
//Article 永久图文素材 // Article 永久图文素材
type Article struct { type Article struct {
Title string `json:"title"` Title string `json:"title"`
ThumbMediaID string `json:"thumb_media_id"` ThumbMediaID string `json:"thumb_media_id"`
@@ -55,6 +72,9 @@ func (material *Material) GetNews(id string) ([]*Article, error) {
} }
req.MediaID = id req.MediaID = id
responseBytes, err := util.PostJSON(uri, req) responseBytes, err := util.PostJSON(uri, req)
if err != nil {
return nil, err
}
var res struct { var res struct {
NewsItem []*Article `json:"news_item"` NewsItem []*Article `json:"news_item"`
@@ -67,19 +87,19 @@ func (material *Material) GetNews(id string) ([]*Article, error) {
return res.NewsItem, nil return res.NewsItem, nil
} }
//reqArticles 永久性图文素材请求信息 // reqArticles 永久性图文素材请求信息
type reqArticles struct { type reqArticles struct {
Articles []*Article `json:"articles"` Articles []*Article `json:"articles"`
} }
//resArticles 永久性图文素材返回结果 // resArticles 永久性图文素材返回结果
type resArticles struct { type resArticles struct {
util.CommonError util.CommonError
MediaID string `json:"media_id"` MediaID string `json:"media_id"`
} }
//AddNews 新增永久图文素材 // AddNews 新增永久图文素材
func (material *Material) AddNews(articles []*Article) (mediaID string, err error) { func (material *Material) AddNews(articles []*Article) (mediaID string, err error) {
req := &reqArticles{articles} req := &reqArticles{articles}
@@ -91,16 +111,48 @@ func (material *Material) AddNews(articles []*Article) (mediaID string, err erro
uri := fmt.Sprintf("%s?access_token=%s", addNewsURL, accessToken) uri := fmt.Sprintf("%s?access_token=%s", addNewsURL, accessToken)
responseBytes, err := util.PostJSON(uri, req) responseBytes, err := util.PostJSON(uri, req)
if err != nil {
return
}
var res resArticles var res resArticles
err = json.Unmarshal(responseBytes, &res) err = json.Unmarshal(responseBytes, &res)
if err != nil { if err != nil {
return return
} }
if res.ErrCode != 0 {
return "", fmt.Errorf("errcode=%d,errmsg=%s", res.ErrCode, res.ErrMsg)
}
mediaID = res.MediaID mediaID = res.MediaID
return return
} }
//resAddMaterial 永久性素材上传返回的结果 // reqUpdateArticle 更新永久性图文素材请求信息
type reqUpdateArticle struct {
MediaID string `json:"media_id"`
Index int64 `json:"index"`
Articles *Article `json:"articles"`
}
// UpdateNews 更新永久图文素材
func (material *Material) UpdateNews(article *Article, mediaID string, index int64) (err error) {
req := &reqUpdateArticle{mediaID, index, article}
var accessToken string
accessToken, err = material.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", updateNewsURL, accessToken)
var response []byte
response, err = util.PostJSON(uri, req)
if err != nil {
return
}
return util.DecodeWithCommonError(response, "UpdateNews")
}
// resAddMaterial 永久性素材上传返回的结果
type resAddMaterial struct { type resAddMaterial struct {
util.CommonError util.CommonError
@@ -108,10 +160,11 @@ type resAddMaterial struct {
URL string `json:"url"` URL string `json:"url"`
} }
//AddMaterial 上传永久性素材(处理视频需要单独上传) // AddMaterial 上传永久性素材(处理视频需要单独上传)
func (material *Material) AddMaterial(mediaType MediaType, filename string) (mediaID string, url string, err error) { func (material *Material) AddMaterial(mediaType MediaType, filename string) (mediaID string, url string, err error) {
if mediaType == MediaTypeVideo { if mediaType == MediaTypeVideo {
err = errors.New("永久视频素材上传使用 AddVideo 方法") err = errors.New("永久视频素材上传使用 AddVideo 方法")
return
} }
var accessToken string var accessToken string
accessToken, err = material.GetAccessToken() accessToken, err = material.GetAccessToken()
@@ -144,7 +197,7 @@ type reqVideo struct {
Introduction string `json:"introduction"` Introduction string `json:"introduction"`
} }
//AddVideo 永久视频素材文件上传 // AddVideo 永久视频素材文件上传
func (material *Material) AddVideo(filename, title, introduction string) (mediaID string, url string, err error) { func (material *Material) AddVideo(filename, title, introduction string) (mediaID string, url string, err error) {
var accessToken string var accessToken string
accessToken, err = material.GetAccessToken() accessToken, err = material.GetAccessToken()
@@ -201,7 +254,7 @@ type reqDeleteMaterial struct {
MediaID string `json:"media_id"` MediaID string `json:"media_id"`
} }
//DeleteMaterial 删除永久素材 // DeleteMaterial 删除永久素材
func (material *Material) DeleteMaterial(mediaID string) error { func (material *Material) DeleteMaterial(mediaID string) error {
accessToken, err := material.GetAccessToken() accessToken, err := material.GetAccessToken()
if err != nil { if err != nil {
@@ -216,3 +269,86 @@ func (material *Material) DeleteMaterial(mediaID string) error {
return util.DecodeWithCommonError(response, "DeleteMaterial") return util.DecodeWithCommonError(response, "DeleteMaterial")
} }
// 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"`
Content ArticleListContent `json:"content"`
Name string `json:"name"`
URL string `json:"url"`
UpdateTime int64 `json:"update_time"`
}
// ArticleListContent 用于ArticleListItem的content节点
type ArticleListContent struct {
NewsItem []Article `json:"news_item"`
UpdateTime int64 `json:"update_time"`
CreateTime int64 `json:"create_time"`
}
// reqBatchGetMaterial BatchGetMaterial请求参数
type reqBatchGetMaterial struct {
Type PermanentMaterialType `json:"type"`
Count int64 `json:"count"`
Offset int64 `json:"offset"`
}
// 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
accessToken, err = material.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", batchGetMaterialURL, accessToken)
req := reqBatchGetMaterial{
Type: permanentMaterialType,
Offset: offset,
Count: count,
}
var response []byte
response, err = util.PostJSON(uri, req)
if err != nil {
return
}
err = util.DecodeWithError(response, &list, "BatchGetMaterial")
return
}
// ResMaterialCount 素材总数
type ResMaterialCount struct {
util.CommonError
VoiceCount int64 `json:"voice_count"` // 语音总数量
VideoCount int64 `json:"video_count"` // 视频总数量
ImageCount int64 `json:"image_count"` // 图片总数量
NewsCount int64 `json:"news_count"` // 图文总数量
}
// GetMaterialCount 获取素材总数.
func (material *Material) GetMaterialCount() (res ResMaterialCount, err error) {
var accessToken string
accessToken, err = material.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", getMaterialCountURL, accessToken)
var response []byte
response, err = util.HTTPGet(uri)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "GetMaterialCount")
return
}

View File

@@ -7,18 +7,18 @@ import (
"github.com/silenceper/wechat/v2/util" "github.com/silenceper/wechat/v2/util"
) )
//MediaType 媒体文件类型 // MediaType 媒体文件类型
type MediaType string type MediaType string
const ( const (
//MediaTypeImage 媒体文件:图片 // MediaTypeImage 媒体文件:图片
MediaTypeImage MediaType = "image" MediaTypeImage MediaType = "image"
//MediaTypeVoice 媒体文件:声音 // MediaTypeVoice 媒体文件:声音
MediaTypeVoice = "voice" MediaTypeVoice MediaType = "voice"
//MediaTypeVideo 媒体文件:视频 // MediaTypeVideo 媒体文件:视频
MediaTypeVideo = "video" MediaTypeVideo MediaType = "video"
//MediaTypeThumb 媒体文件:缩略图 // MediaTypeThumb 媒体文件:缩略图
MediaTypeThumb = "thumb" MediaTypeThumb MediaType = "thumb"
) )
const ( const (
@@ -27,7 +27,7 @@ const (
mediaGetURL = "https://api.weixin.qq.com/cgi-bin/media/get" mediaGetURL = "https://api.weixin.qq.com/cgi-bin/media/get"
) )
//Media 临时素材上传返回信息 // Media 临时素材上传返回信息
type Media struct { type Media struct {
util.CommonError util.CommonError
@@ -37,7 +37,7 @@ type Media struct {
CreatedAt int64 `json:"created_at"` CreatedAt int64 `json:"created_at"`
} }
//MediaUpload 临时素材上传 // MediaUpload 临时素材上传
func (material *Material) MediaUpload(mediaType MediaType, filename string) (media Media, err error) { func (material *Material) MediaUpload(mediaType MediaType, filename string) (media Media, err error) {
var accessToken string var accessToken string
accessToken, err = material.GetAccessToken() accessToken, err = material.GetAccessToken()
@@ -62,8 +62,8 @@ func (material *Material) MediaUpload(mediaType MediaType, filename string) (med
return return
} }
//GetMediaURL 返回临时素材的下载地址供用户自己处理 // GetMediaURL 返回临时素材的下载地址供用户自己处理
//NOTICE: URL 不可公开因为含access_token 需要立即另存文件 // NOTICE: URL 不可公开因为含access_token 需要立即另存文件
func (material *Material) GetMediaURL(mediaID string) (mediaURL string, err error) { func (material *Material) GetMediaURL(mediaID string) (mediaURL string, err error) {
var accessToken string var accessToken string
accessToken, err = material.GetAccessToken() accessToken, err = material.GetAccessToken()
@@ -74,14 +74,14 @@ func (material *Material) GetMediaURL(mediaID string) (mediaURL string, err erro
return return
} }
//resMediaImage 图片上传返回结果 // resMediaImage 图片上传返回结果
type resMediaImage struct { type resMediaImage struct {
util.CommonError util.CommonError
URL string `json:"url"` URL string `json:"url"`
} }
//ImageUpload 图片上传 // ImageUpload 图片上传
func (material *Material) ImageUpload(filename string) (url string, err error) { func (material *Material) ImageUpload(filename string) (url string, err error) {
var accessToken string var accessToken string
accessToken, err = material.GetAccessToken() accessToken, err = material.GetAccessToken()
@@ -106,5 +106,4 @@ func (material *Material) ImageUpload(filename string) (url string, err error) {
} }
url = image.URL url = image.URL
return return
} }

View File

@@ -1,6 +1,6 @@
package menu package menu
//Button 菜单按钮 // Button 菜单按钮
type Button struct { type Button struct {
Type string `json:"type,omitempty"` Type string `json:"type,omitempty"`
Name string `json:"name,omitempty"` Name string `json:"name,omitempty"`
@@ -12,48 +12,52 @@ type Button struct {
SubButtons []*Button `json:"sub_button,omitempty"` SubButtons []*Button `json:"sub_button,omitempty"`
} }
//SetSubButton 设置二级菜单 // SetSubButton 设置二级菜单
func (btn *Button) SetSubButton(name string, subButtons []*Button) { func (btn *Button) SetSubButton(name string, subButtons []*Button) *Button {
btn.Name = name btn.Name = name
btn.SubButtons = subButtons btn.SubButtons = subButtons
btn.Type = "" btn.Type = ""
btn.Key = "" btn.Key = ""
btn.URL = "" btn.URL = ""
btn.MediaID = "" btn.MediaID = ""
return btn
} }
//SetClickButton btn 为click类型 // SetClickButton btn 为click类型
func (btn *Button) SetClickButton(name, key string) { func (btn *Button) SetClickButton(name, key string) *Button {
btn.Type = "click" btn.Type = "click"
btn.Name = name btn.Name = name
btn.Key = key btn.Key = key
btn.URL = "" btn.URL = ""
btn.MediaID = "" btn.MediaID = ""
btn.SubButtons = nil btn.SubButtons = nil
return btn
} }
//SetViewButton view类型 // SetViewButton view类型
func (btn *Button) SetViewButton(name, url string) { func (btn *Button) SetViewButton(name, url string) *Button {
btn.Type = "view" btn.Type = "view"
btn.Name = name btn.Name = name
btn.URL = url btn.URL = url
btn.Key = "" btn.Key = ""
btn.MediaID = "" btn.MediaID = ""
btn.SubButtons = nil btn.SubButtons = nil
return btn
} }
// SetScanCodePushButton 扫码推事件 // SetScanCodePushButton 扫码推事件
func (btn *Button) SetScanCodePushButton(name, key string) { func (btn *Button) SetScanCodePushButton(name, key string) *Button {
btn.Type = "scancode_push" btn.Type = "scancode_push"
btn.Name = name btn.Name = name
btn.Key = key btn.Key = key
btn.URL = "" btn.URL = ""
btn.MediaID = "" btn.MediaID = ""
btn.SubButtons = nil btn.SubButtons = nil
return btn
} }
//SetScanCodeWaitMsgButton 设置 扫码推事件且弹出"消息接收中"提示框 // SetScanCodeWaitMsgButton 设置 扫码推事件且弹出"消息接收中"提示框
func (btn *Button) SetScanCodeWaitMsgButton(name, key string) { func (btn *Button) SetScanCodeWaitMsgButton(name, key string) *Button {
btn.Type = "scancode_waitmsg" btn.Type = "scancode_waitmsg"
btn.Name = name btn.Name = name
btn.Key = key btn.Key = key
@@ -61,10 +65,11 @@ func (btn *Button) SetScanCodeWaitMsgButton(name, key string) {
btn.URL = "" btn.URL = ""
btn.MediaID = "" btn.MediaID = ""
btn.SubButtons = nil btn.SubButtons = nil
return btn
} }
//SetPicSysPhotoButton 设置弹出系统拍照发图按钮 // SetPicSysPhotoButton 设置弹出系统拍照发图按钮
func (btn *Button) SetPicSysPhotoButton(name, key string) { func (btn *Button) SetPicSysPhotoButton(name, key string) *Button {
btn.Type = "pic_sysphoto" btn.Type = "pic_sysphoto"
btn.Name = name btn.Name = name
btn.Key = key btn.Key = key
@@ -72,10 +77,11 @@ func (btn *Button) SetPicSysPhotoButton(name, key string) {
btn.URL = "" btn.URL = ""
btn.MediaID = "" btn.MediaID = ""
btn.SubButtons = nil btn.SubButtons = nil
return btn
} }
//SetPicPhotoOrAlbumButton 设置弹出拍照或者相册发图类型按钮 // SetPicPhotoOrAlbumButton 设置弹出拍照或者相册发图类型按钮
func (btn *Button) SetPicPhotoOrAlbumButton(name, key string) { func (btn *Button) SetPicPhotoOrAlbumButton(name, key string) *Button {
btn.Type = "pic_photo_or_album" btn.Type = "pic_photo_or_album"
btn.Name = name btn.Name = name
btn.Key = key btn.Key = key
@@ -83,10 +89,11 @@ func (btn *Button) SetPicPhotoOrAlbumButton(name, key string) {
btn.URL = "" btn.URL = ""
btn.MediaID = "" btn.MediaID = ""
btn.SubButtons = nil btn.SubButtons = nil
return btn
} }
// SetPicWeixinButton 设置弹出微信相册发图器类型按钮 // SetPicWeixinButton 设置弹出微信相册发图器类型按钮
func (btn *Button) SetPicWeixinButton(name, key string) { func (btn *Button) SetPicWeixinButton(name, key string) *Button {
btn.Type = "pic_weixin" btn.Type = "pic_weixin"
btn.Name = name btn.Name = name
btn.Key = key btn.Key = key
@@ -94,10 +101,11 @@ func (btn *Button) SetPicWeixinButton(name, key string) {
btn.URL = "" btn.URL = ""
btn.MediaID = "" btn.MediaID = ""
btn.SubButtons = nil btn.SubButtons = nil
return btn
} }
// SetLocationSelectButton 设置 弹出地理位置选择器 类型按钮 // SetLocationSelectButton 设置 弹出地理位置选择器 类型按钮
func (btn *Button) SetLocationSelectButton(name, key string) { func (btn *Button) SetLocationSelectButton(name, key string) *Button {
btn.Type = "location_select" btn.Type = "location_select"
btn.Name = name btn.Name = name
btn.Key = key btn.Key = key
@@ -105,10 +113,11 @@ func (btn *Button) SetLocationSelectButton(name, key string) {
btn.URL = "" btn.URL = ""
btn.MediaID = "" btn.MediaID = ""
btn.SubButtons = nil btn.SubButtons = nil
return btn
} }
//SetMediaIDButton 设置 下发消息(除文本消息) 类型按钮 // SetMediaIDButton 设置 下发消息(除文本消息) 类型按钮
func (btn *Button) SetMediaIDButton(name, mediaID string) { func (btn *Button) SetMediaIDButton(name, mediaID string) *Button {
btn.Type = "media_id" btn.Type = "media_id"
btn.Name = name btn.Name = name
btn.MediaID = mediaID btn.MediaID = mediaID
@@ -116,10 +125,11 @@ func (btn *Button) SetMediaIDButton(name, mediaID string) {
btn.Key = "" btn.Key = ""
btn.URL = "" btn.URL = ""
btn.SubButtons = nil btn.SubButtons = nil
return btn
} }
//SetViewLimitedButton 设置 跳转图文消息URL 类型按钮 // SetViewLimitedButton 设置 跳转图文消息URL 类型按钮
func (btn *Button) SetViewLimitedButton(name, mediaID string) { func (btn *Button) SetViewLimitedButton(name, mediaID string) *Button {
btn.Type = "view_limited" btn.Type = "view_limited"
btn.Name = name btn.Name = name
btn.MediaID = mediaID btn.MediaID = mediaID
@@ -127,10 +137,11 @@ func (btn *Button) SetViewLimitedButton(name, mediaID string) {
btn.Key = "" btn.Key = ""
btn.URL = "" btn.URL = ""
btn.SubButtons = nil btn.SubButtons = nil
return btn
} }
//SetMiniprogramButton 设置 跳转小程序 类型按钮 (公众号后台必须已经关联小程序) // SetMiniprogramButton 设置 跳转小程序 类型按钮 (公众号后台必须已经关联小程序)
func (btn *Button) SetMiniprogramButton(name, url, appID, pagePath string) { func (btn *Button) SetMiniprogramButton(name, url, appID, pagePath string) *Button {
btn.Type = "miniprogram" btn.Type = "miniprogram"
btn.Name = name btn.Name = name
btn.URL = url btn.URL = url
@@ -140,4 +151,65 @@ func (btn *Button) SetMiniprogramButton(name, url, appID, pagePath string) {
btn.Key = "" btn.Key = ""
btn.MediaID = "" btn.MediaID = ""
btn.SubButtons = nil btn.SubButtons = nil
return btn
}
// NewSubButton 二级菜单
func NewSubButton(name string, subButtons []*Button) *Button {
return (&Button{}).SetSubButton(name, subButtons)
}
// NewClickButton btn 为click类型
func NewClickButton(name, key string) *Button {
return (&Button{}).SetClickButton(name, key)
}
// NewViewButton view类型
func NewViewButton(name, url string) *Button {
return (&Button{}).SetViewButton(name, url)
}
// NewScanCodePushButton 扫码推事件
func NewScanCodePushButton(name, key string) *Button {
return (&Button{}).SetScanCodePushButton(name, key)
}
// NewScanCodeWaitMsgButton 扫码推事件且弹出"消息接收中"提示框
func NewScanCodeWaitMsgButton(name, key string) *Button {
return (&Button{}).SetScanCodeWaitMsgButton(name, key)
}
// NewPicSysPhotoButton 弹出系统拍照发图按钮
func NewPicSysPhotoButton(name, key string) *Button {
return (&Button{}).SetPicSysPhotoButton(name, key)
}
// NewPicPhotoOrAlbumButton 弹出拍照或者相册发图类型按钮
func NewPicPhotoOrAlbumButton(name, key string) *Button {
return (&Button{}).SetPicPhotoOrAlbumButton(name, key)
}
// NewPicWeixinButton 弹出微信相册发图器类型按钮
func NewPicWeixinButton(name, key string) *Button {
return (&Button{}).SetPicWeixinButton(name, key)
}
// NewLocationSelectButton 弹出地理位置选择器 类型按钮
func NewLocationSelectButton(name, key string) *Button {
return (&Button{}).SetLocationSelectButton(name, key)
}
// NewMediaIDButton 下发消息(除文本消息) 类型按钮
func NewMediaIDButton(name, mediaID string) *Button {
return (&Button{}).SetMediaIDButton(name, mediaID)
}
// NewViewLimitedButton 跳转图文消息URL 类型按钮
func NewViewLimitedButton(name, mediaID string) *Button {
return (&Button{}).SetViewLimitedButton(name, mediaID)
}
// NewMiniprogramButton 跳转小程序 类型按钮 (公众号后台必须已经关联小程序)
func NewMiniprogramButton(name, url, appID, pagePath string) *Button {
return (&Button{}).SetMiniprogramButton(name, url, appID, pagePath)
} }

View File

@@ -0,0 +1,28 @@
package menu
import (
"encoding/json"
"testing"
"github.com/stretchr/testify/assert"
)
func TestNewButtonFun(t *testing.T) {
buttons := []*Button{
NewSubButton("1", []*Button{
NewViewButton("1.1", "https://baidu.com"),
NewViewButton("1.2", "https://baidu.com"),
NewViewButton("1.3", "https://baidu.com"),
}),
NewSubButton("2", []*Button{
NewViewButton("2.1", "https://baidu.com"),
NewViewButton("2.2", "https://baidu.com"),
NewViewButton("2.3", "https://baidu.com"),
}),
NewViewButton("3", "https://baidu.com"),
}
data, err := json.Marshal(buttons)
assert.Nil(t, err)
assert.Equal(t, `[{"name":"1","sub_button":[{"type":"view","name":"1.1","url":"https://baidu.com"},{"type":"view","name":"1.2","url":"https://baidu.com"},{"type":"view","name":"1.3","url":"https://baidu.com"}]},{"name":"2","sub_button":[{"type":"view","name":"2.1","url":"https://baidu.com"},{"type":"view","name":"2.2","url":"https://baidu.com"},{"type":"view","name":"2.3","url":"https://baidu.com"}]},{"type":"view","name":"3","url":"https://baidu.com"}]`, string(data))
}

View File

@@ -18,42 +18,42 @@ const (
menuSelfMenuInfoURL = "https://api.weixin.qq.com/cgi-bin/get_current_selfmenu_info" menuSelfMenuInfoURL = "https://api.weixin.qq.com/cgi-bin/get_current_selfmenu_info"
) )
//Menu struct // Menu struct
type Menu struct { type Menu struct {
*context.Context *context.Context
} }
//reqMenu 设置菜单请求数据 // reqMenu 设置菜单请求数据
type reqMenu struct { type reqMenu struct {
Button []*Button `json:"button,omitempty"` Button []*Button `json:"button,omitempty"`
MatchRule *MatchRule `json:"matchrule,omitempty"` MatchRule *MatchRule `json:"matchrule,omitempty"`
} }
//reqDeleteConditional 删除个性化菜单请求数据 // reqDeleteConditional 删除个性化菜单请求数据
type reqDeleteConditional struct { type reqDeleteConditional struct {
MenuID int64 `json:"menuid"` MenuID int64 `json:"menuid"`
} }
//reqMenuTryMatch 菜单匹配请求 // reqMenuTryMatch 菜单匹配请求
type reqMenuTryMatch struct { type reqMenuTryMatch struct {
UserID string `json:"user_id"` UserID string `json:"user_id"`
} }
//resConditionalMenu 个性化菜单返回结果 // resConditionalMenu 个性化菜单返回结果
type resConditionalMenu struct { type resConditionalMenu struct {
Button []Button `json:"button"` Button []Button `json:"button"`
MatchRule MatchRule `json:"matchrule"` MatchRule MatchRule `json:"matchrule"`
MenuID int64 `json:"menuid"` MenuID int64 `json:"menuid"`
} }
//resMenuTryMatch 菜单匹配请求结果 // resMenuTryMatch 菜单匹配请求结果
type resMenuTryMatch struct { type resMenuTryMatch struct {
util.CommonError util.CommonError
Button []Button `json:"button"` Button []Button `json:"button"`
} }
//ResMenu 查询菜单的返回数据 // ResMenu 查询菜单的返回数据
type ResMenu struct { type ResMenu struct {
util.CommonError util.CommonError
@@ -64,7 +64,7 @@ type ResMenu struct {
Conditionalmenu []resConditionalMenu `json:"conditionalmenu"` Conditionalmenu []resConditionalMenu `json:"conditionalmenu"`
} }
//ResSelfMenuInfo 自定义菜单配置返回结果 // ResSelfMenuInfo 自定义菜单配置返回结果
type ResSelfMenuInfo struct { type ResSelfMenuInfo struct {
util.CommonError util.CommonError
@@ -74,7 +74,7 @@ type ResSelfMenuInfo struct {
} `json:"selfmenu_info"` } `json:"selfmenu_info"`
} }
//SelfMenuButton 自定义菜单配置详情 // SelfMenuButton 自定义菜单配置详情
type SelfMenuButton struct { type SelfMenuButton struct {
Type string `json:"type"` Type string `json:"type"`
Name string `json:"name"` Name string `json:"name"`
@@ -89,7 +89,7 @@ type SelfMenuButton struct {
} `json:"news_info,omitempty"` } `json:"news_info,omitempty"`
} }
//ButtonNew 图文消息菜单 // ButtonNew 图文消息菜单
type ButtonNew struct { type ButtonNew struct {
Title string `json:"title"` Title string `json:"title"`
Author string `json:"author"` Author string `json:"author"`
@@ -100,25 +100,25 @@ type ButtonNew struct {
SourceURL string `json:"source_url"` SourceURL string `json:"source_url"`
} }
//MatchRule 个性化菜单规则 // MatchRule 个性化菜单规则
type MatchRule struct { type MatchRule struct {
GroupID int32 `json:"group_id,omitempty"` GroupID string `json:"group_id,omitempty"`
Sex int32 `json:"sex,omitempty"` Sex string `json:"sex,omitempty"`
Country string `json:"country,omitempty"` Country string `json:"country,omitempty"`
Province string `json:"province,omitempty"` Province string `json:"province,omitempty"`
City string `json:"city,omitempty"` City string `json:"city,omitempty"`
ClientPlatformType int32 `json:"client_platform_type,omitempty"` ClientPlatformType string `json:"client_platform_type,omitempty"`
Language string `json:"language,omitempty"` Language string `json:"language,omitempty"`
} }
//NewMenu 实例 // NewMenu 实例
func NewMenu(context *context.Context) *Menu { func NewMenu(context *context.Context) *Menu {
menu := new(Menu) menu := new(Menu)
menu.Context = context menu.Context = context
return menu return menu
} }
//SetMenu 设置按钮 // SetMenu 设置按钮
func (menu *Menu) SetMenu(buttons []*Button) error { func (menu *Menu) SetMenu(buttons []*Button) error {
accessToken, err := menu.GetAccessToken() accessToken, err := menu.GetAccessToken()
if err != nil { if err != nil {
@@ -138,7 +138,24 @@ func (menu *Menu) SetMenu(buttons []*Button) error {
return util.DecodeWithCommonError(response, "SetMenu") return util.DecodeWithCommonError(response, "SetMenu")
} }
//GetMenu 获取菜单配置 // SetMenuByJSON 设置按钮
func (menu *Menu) SetMenuByJSON(jsonInfo string) error {
accessToken, err := menu.GetAccessToken()
if err != nil {
return err
}
uri := fmt.Sprintf("%s?access_token=%s", menuCreateURL, accessToken)
response, err := util.HTTPPost(uri, jsonInfo)
if err != nil {
return err
}
return util.DecodeWithCommonError(response, "SetMenuByJSON")
}
// GetMenu 获取菜单配置
func (menu *Menu) GetMenu() (resMenu ResMenu, err error) { func (menu *Menu) GetMenu() (resMenu ResMenu, err error) {
var accessToken string var accessToken string
accessToken, err = menu.GetAccessToken() accessToken, err = menu.GetAccessToken()
@@ -162,7 +179,7 @@ func (menu *Menu) GetMenu() (resMenu ResMenu, err error) {
return return
} }
//DeleteMenu 删除菜单 // DeleteMenu 删除菜单
func (menu *Menu) DeleteMenu() error { func (menu *Menu) DeleteMenu() error {
accessToken, err := menu.GetAccessToken() accessToken, err := menu.GetAccessToken()
if err != nil { if err != nil {
@@ -177,7 +194,7 @@ func (menu *Menu) DeleteMenu() error {
return util.DecodeWithCommonError(response, "GetMenu") return util.DecodeWithCommonError(response, "GetMenu")
} }
//AddConditional 添加个性化菜单 // AddConditional 添加个性化菜单
func (menu *Menu) AddConditional(buttons []*Button, matchRule *MatchRule) error { func (menu *Menu) AddConditional(buttons []*Button, matchRule *MatchRule) error {
accessToken, err := menu.GetAccessToken() accessToken, err := menu.GetAccessToken()
if err != nil { if err != nil {
@@ -198,7 +215,23 @@ func (menu *Menu) AddConditional(buttons []*Button, matchRule *MatchRule) error
return util.DecodeWithCommonError(response, "AddConditional") return util.DecodeWithCommonError(response, "AddConditional")
} }
//DeleteConditional 删除个性化菜单 // AddConditionalByJSON 添加个性化菜单
func (menu *Menu) AddConditionalByJSON(jsonInfo string) error {
accessToken, err := menu.GetAccessToken()
if err != nil {
return err
}
uri := fmt.Sprintf("%s?access_token=%s", menuAddConditionalURL, accessToken)
response, err := util.HTTPPost(uri, jsonInfo)
if err != nil {
return err
}
return util.DecodeWithCommonError(response, "AddConditional")
}
// DeleteConditional 删除个性化菜单
func (menu *Menu) DeleteConditional(menuID int64) error { func (menu *Menu) DeleteConditional(menuID int64) error {
accessToken, err := menu.GetAccessToken() accessToken, err := menu.GetAccessToken()
if err != nil { if err != nil {
@@ -218,7 +251,7 @@ func (menu *Menu) DeleteConditional(menuID int64) error {
return util.DecodeWithCommonError(response, "DeleteConditional") return util.DecodeWithCommonError(response, "DeleteConditional")
} }
//MenuTryMatch 菜单匹配 // MenuTryMatch 菜单匹配
func (menu *Menu) MenuTryMatch(userID string) (buttons []Button, err error) { func (menu *Menu) MenuTryMatch(userID string) (buttons []Button, err error) {
var accessToken string var accessToken string
accessToken, err = menu.GetAccessToken() accessToken, err = menu.GetAccessToken()
@@ -245,7 +278,7 @@ func (menu *Menu) MenuTryMatch(userID string) (buttons []Button, err error) {
return return
} }
//GetCurrentSelfMenuInfo 获取自定义菜单配置接口 // GetCurrentSelfMenuInfo 获取自定义菜单配置接口
func (menu *Menu) GetCurrentSelfMenuInfo() (resSelfMenuInfo ResSelfMenuInfo, err error) { func (menu *Menu) GetCurrentSelfMenuInfo() (resSelfMenuInfo ResSelfMenuInfo, err error) {
var accessToken string var accessToken string
accessToken, err = menu.GetAccessToken() accessToken, err = menu.GetAccessToken()

View File

@@ -12,35 +12,35 @@ const (
customerSendMessage = "https://api.weixin.qq.com/cgi-bin/message/custom/send" customerSendMessage = "https://api.weixin.qq.com/cgi-bin/message/custom/send"
) )
//Manager 消息管理者,可以发送消息 // Manager 消息管理者,可以发送消息
type Manager struct { type Manager struct {
*context.Context *context.Context
} }
//NewMessageManager 实例化消息管理者 // NewMessageManager 实例化消息管理者
func NewMessageManager(context *context.Context) *Manager { func NewMessageManager(context *context.Context) *Manager {
return &Manager{ return &Manager{
context, context,
} }
} }
//CustomerMessage 客服消息 // CustomerMessage 客服消息
type CustomerMessage struct { type CustomerMessage struct {
ToUser string `json:"touser"` //接受者OpenID ToUser string `json:"touser"` // 接受者OpenID
Msgtype MsgType `json:"msgtype"` //客服消息类型 Msgtype MsgType `json:"msgtype"` // 客服消息类型
Text *MediaText `json:"text,omitempty"` //可选 Text *MediaText `json:"text,omitempty"` // 可选
Image *MediaResource `json:"image,omitempty"` //可选 Image *MediaResource `json:"image,omitempty"` // 可选
Voice *MediaResource `json:"voice,omitempty"` //可选 Voice *MediaResource `json:"voice,omitempty"` // 可选
Video *MediaVideo `json:"video,omitempty"` //可选 Video *MediaVideo `json:"video,omitempty"` // 可选
Music *MediaMusic `json:"music,omitempty"` //可选 Music *MediaMusic `json:"music,omitempty"` // 可选
News *MediaNews `json:"news,omitempty"` //可选 News *MediaNews `json:"news,omitempty"` // 可选
Mpnews *MediaResource `json:"mpnews,omitempty"` //可选 Mpnews *MediaResource `json:"mpnews,omitempty"` // 可选
Wxcard *MediaWxcard `json:"wxcard,omitempty"` //可选 Wxcard *MediaWxcard `json:"wxcard,omitempty"` // 可选
Msgmenu *MediaMsgmenu `json:"msgmenu,omitempty"` //可选 Msgmenu *MediaMsgmenu `json:"msgmenu,omitempty"` // 可选
Miniprogrampage *MediaMiniprogrampage `json:"miniprogrampage,omitempty"` //可选 Miniprogrampage *MediaMiniprogrampage `json:"miniprogrampage,omitempty"` // 可选
} }
//NewCustomerTextMessage 文本消息结构体构造方法 // NewCustomerTextMessage 文本消息结构体构造方法
func NewCustomerTextMessage(toUser, text string) *CustomerMessage { func NewCustomerTextMessage(toUser, text string) *CustomerMessage {
return &CustomerMessage{ return &CustomerMessage{
ToUser: toUser, ToUser: toUser,
@@ -51,7 +51,7 @@ func NewCustomerTextMessage(toUser, text string) *CustomerMessage {
} }
} }
//NewCustomerImgMessage 图片消息的构造方法 // NewCustomerImgMessage 图片消息的构造方法
func NewCustomerImgMessage(toUser, mediaID string) *CustomerMessage { func NewCustomerImgMessage(toUser, mediaID string) *CustomerMessage {
return &CustomerMessage{ return &CustomerMessage{
ToUser: toUser, ToUser: toUser,
@@ -62,7 +62,7 @@ func NewCustomerImgMessage(toUser, mediaID string) *CustomerMessage {
} }
} }
//NewCustomerVoiceMessage 语音消息的构造方法 // NewCustomerVoiceMessage 语音消息的构造方法
func NewCustomerVoiceMessage(toUser, mediaID string) *CustomerMessage { func NewCustomerVoiceMessage(toUser, mediaID string) *CustomerMessage {
return &CustomerMessage{ return &CustomerMessage{
ToUser: toUser, ToUser: toUser,
@@ -73,17 +73,31 @@ func NewCustomerVoiceMessage(toUser, mediaID string) *CustomerMessage {
} }
} }
//MediaText 文本消息的文字 // NewCustomerMiniprogrampageMessage 小程序卡片消息的构造方法
func NewCustomerMiniprogrampageMessage(toUser, title, appID, pagePath, thumbMediaID string) *CustomerMessage {
return &CustomerMessage{
ToUser: toUser,
Msgtype: MsgTypeMiniprogrampage,
Miniprogrampage: &MediaMiniprogrampage{
Title: title,
AppID: appID,
Pagepath: pagePath,
ThumbMediaID: thumbMediaID,
},
}
}
// MediaText 文本消息的文字
type MediaText struct { type MediaText struct {
Content string `json:"content"` Content string `json:"content"`
} }
//MediaResource 消息使用的永久素材id // MediaResource 消息使用的永久素材id
type MediaResource struct { type MediaResource struct {
MediaID string `json:"media_id"` MediaID string `json:"media_id"`
} }
//MediaVideo 视频消息包含的内容 // MediaVideo 视频消息包含的内容
type MediaVideo struct { type MediaVideo struct {
MediaID string `json:"media_id"` MediaID string `json:"media_id"`
ThumbMediaID string `json:"thumb_media_id"` ThumbMediaID string `json:"thumb_media_id"`
@@ -91,7 +105,7 @@ type MediaVideo struct {
Description string `json:"description"` Description string `json:"description"`
} }
//MediaMusic 音乐消息包括的内容 // MediaMusic 音乐消息包括的内容
type MediaMusic struct { type MediaMusic struct {
Title string `json:"title"` Title string `json:"title"`
Description string `json:"description"` Description string `json:"description"`
@@ -100,12 +114,12 @@ type MediaMusic struct {
ThumbMediaID string `json:"thumb_media_id"` ThumbMediaID string `json:"thumb_media_id"`
} }
//MediaNews 图文消息的内容 // MediaNews 图文消息的内容
type MediaNews struct { type MediaNews struct {
Articles []MediaArticles `json:"articles"` Articles []MediaArticles `json:"articles"`
} }
//MediaArticles 图文消息的内容的文章列表中的单独一条 // MediaArticles 图文消息的内容的文章列表中的单独一条
type MediaArticles struct { type MediaArticles struct {
Title string `json:"title"` Title string `json:"title"`
Description string `json:"description"` Description string `json:"description"`
@@ -113,33 +127,33 @@ type MediaArticles struct {
Picurl string `json:"picurl"` Picurl string `json:"picurl"`
} }
//MediaMsgmenu 菜单消息的内容 // MediaMsgmenu 菜单消息的内容
type MediaMsgmenu struct { type MediaMsgmenu struct {
HeadContent string `json:"head_content"` HeadContent string `json:"head_content"`
List []MsgmenuItem `json:"list"` List []MsgmenuItem `json:"list"`
TailContent string `json:"tail_content"` TailContent string `json:"tail_content"`
} }
//MsgmenuItem 菜单消息的菜单按钮 // MsgmenuItem 菜单消息的菜单按钮
type MsgmenuItem struct { type MsgmenuItem struct {
ID string `json:"id"` ID string `json:"id"`
Content string `json:"content"` Content string `json:"content"`
} }
//MediaWxcard 卡券的id // MediaWxcard 卡券的id
type MediaWxcard struct { type MediaWxcard struct {
CardID string `json:"card_id"` CardID string `json:"card_id"`
} }
//MediaMiniprogrampage 小程序消息 // MediaMiniprogrampage 小程序消息
type MediaMiniprogrampage struct { type MediaMiniprogrampage struct {
Title string `json:"title"` Title string `json:"title"`
Appid string `json:"appid"` AppID string `json:"appid"`
Pagepath string `json:"pagepath"` Pagepath string `json:"pagepath"`
ThumbMediaID string `json:"thumb_media_id"` ThumbMediaID string `json:"thumb_media_id"`
} }
//Send 发送客服消息 // Send 发送客服消息
func (manager *Manager) Send(msg *CustomerMessage) error { func (manager *Manager) Send(msg *CustomerMessage) error {
accessToken, err := manager.Context.GetAccessToken() accessToken, err := manager.Context.GetAccessToken()
if err != nil { if err != nil {
@@ -147,6 +161,9 @@ func (manager *Manager) Send(msg *CustomerMessage) error {
} }
uri := fmt.Sprintf("%s?access_token=%s", customerSendMessage, accessToken) uri := fmt.Sprintf("%s?access_token=%s", customerSendMessage, accessToken)
response, err := util.PostJSON(uri, msg) response, err := util.PostJSON(uri, msg)
if err != nil {
return err
}
var result util.CommonError var result util.CommonError
err = json.Unmarshal(response, &result) err = json.Unmarshal(response, &result)
if err != nil { if err != nil {

View File

@@ -1,6 +1,6 @@
package message package message
//Image 图片消息 // Image 图片消息
type Image struct { type Image struct {
CommonToken CommonToken
@@ -9,7 +9,7 @@ type Image struct {
} `xml:"Image"` } `xml:"Image"`
} }
//NewImage 回复图片消息 // NewImage 回复图片消息
func NewImage(mediaID string) *Image { func NewImage(mediaID string) *Image {
image := new(Image) image := new(Image)
image.Image.MediaID = mediaID image.Image.MediaID = mediaID

View File

@@ -4,6 +4,7 @@ import (
"encoding/xml" "encoding/xml"
"github.com/silenceper/wechat/v2/officialaccount/device" "github.com/silenceper/wechat/v2/officialaccount/device"
"github.com/silenceper/wechat/v2/officialaccount/freepublish"
) )
// MsgType 基本消息类型 // MsgType 基本消息类型
@@ -16,96 +17,109 @@ type EventType string
type InfoType string type InfoType string
const ( const (
//MsgTypeText 表示文本消息 // MsgTypeText 表示文本消息
MsgTypeText MsgType = "text" MsgTypeText MsgType = "text"
//MsgTypeImage 表示图片消息 // MsgTypeImage 表示图片消息
MsgTypeImage = "image" MsgTypeImage MsgType = "image"
//MsgTypeVoice 表示语音消息 // MsgTypeVoice 表示语音消息
MsgTypeVoice = "voice" MsgTypeVoice MsgType = "voice"
//MsgTypeVideo 表示视频消息 // MsgTypeVideo 表示视频消息
MsgTypeVideo = "video" MsgTypeVideo MsgType = "video"
//MsgTypeShortVideo 表示短视频消息[限接收] // MsgTypeMiniprogrampage 表示小程序卡片消息
MsgTypeShortVideo = "shortvideo" MsgTypeMiniprogrampage MsgType = "miniprogrampage"
//MsgTypeLocation 表示坐标消息[限接收] // MsgTypeShortVideo 表示短视频消息[限接收]
MsgTypeLocation = "location" MsgTypeShortVideo MsgType = "shortvideo"
//MsgTypeLink 表示链接消息[限接收] // MsgTypeLocation 表示坐标消息[限接收]
MsgTypeLink = "link" MsgTypeLocation MsgType = "location"
//MsgTypeMusic 表示音乐消息[限回复] // MsgTypeLink 表示链接消息[限接收]
MsgTypeMusic = "music" MsgTypeLink MsgType = "link"
//MsgTypeNews 表示图文消息[限回复] // MsgTypeMusic 表示音乐消息[限回复]
MsgTypeNews = "news" MsgTypeMusic MsgType = "music"
//MsgTypeTransfer 表示消息消息转发到客服 // MsgTypeNews 表示图文消息[限回复]
MsgTypeTransfer = "transfer_customer_service" MsgTypeNews MsgType = "news"
//MsgTypeEvent 表示事件推送消息 // MsgTypeTransfer 表示消息消息转发到客服
MsgTypeEvent = "event" MsgTypeTransfer MsgType = "transfer_customer_service"
// MsgTypeEvent 表示事件推送消息
MsgTypeEvent MsgType = "event"
) )
const ( const (
//EventSubscribe 订阅 // EventSubscribe 订阅
EventSubscribe EventType = "subscribe" EventSubscribe EventType = "subscribe"
//EventUnsubscribe 取消订阅 // EventUnsubscribe 取消订阅
EventUnsubscribe = "unsubscribe" EventUnsubscribe EventType = "unsubscribe"
//EventScan 用户已经关注公众号,则微信会将带场景值扫描事件推送给开发者 // EventScan 用户已经关注公众号,则微信会将带场景值扫描事件推送给开发者
EventScan = "SCAN" EventScan EventType = "SCAN"
//EventLocation 上报地理位置事件 // EventLocation 上报地理位置事件
EventLocation = "LOCATION" EventLocation EventType = "LOCATION"
//EventClick 点击菜单拉取消息时的事件推送 // EventClick 点击菜单拉取消息时的事件推送
EventClick = "CLICK" EventClick EventType = "CLICK"
//EventView 点击菜单跳转链接时的事件推送 // EventView 点击菜单跳转链接时的事件推送
EventView = "VIEW" EventView EventType = "VIEW"
//EventScancodePush 扫码推事件的事件推送 // EventScancodePush 扫码推事件的事件推送
EventScancodePush = "scancode_push" EventScancodePush EventType = "scancode_push"
//EventScancodeWaitmsg 扫码推事件且弹出“消息接收中”提示框的事件推送 // EventScancodeWaitmsg 扫码推事件且弹出“消息接收中”提示框的事件推送
EventScancodeWaitmsg = "scancode_waitmsg" EventScancodeWaitmsg EventType = "scancode_waitmsg"
//EventPicSysphoto 弹出系统拍照发图的事件推送 // EventPicSysphoto 弹出系统拍照发图的事件推送
EventPicSysphoto = "pic_sysphoto" EventPicSysphoto EventType = "pic_sysphoto"
//EventPicPhotoOrAlbum 弹出拍照或者相册发图的事件推送 // EventPicPhotoOrAlbum 弹出拍照或者相册发图的事件推送
EventPicPhotoOrAlbum = "pic_photo_or_album" EventPicPhotoOrAlbum EventType = "pic_photo_or_album"
//EventPicWeixin 弹出微信相册发图器的事件推送 // EventPicWeixin 弹出微信相册发图器的事件推送
EventPicWeixin = "pic_weixin" EventPicWeixin EventType = "pic_weixin"
//EventLocationSelect 弹出地理位置选择器的事件推送 // EventLocationSelect 弹出地理位置选择器的事件推送
EventLocationSelect = "location_select" EventLocationSelect EventType = "location_select"
//EventTemplateSendJobFinish 发送模板消息推送通知 // EventViewMiniprogram 点击菜单跳转小程序的事件推送
EventTemplateSendJobFinish = "TEMPLATESENDJOBFINISH" EventViewMiniprogram EventType = "view_miniprogram"
//EventWxaMediaCheck 异步校验图片/音频是否含有违法违规内容推送事件 // EventTemplateSendJobFinish 发送模板消息推送通知
EventWxaMediaCheck = "wxa_media_check" EventTemplateSendJobFinish EventType = "TEMPLATESENDJOBFINISH"
// EventMassSendJobFinish 群发消息推送通知
EventMassSendJobFinish EventType = "MASSSENDJOBFINISH"
// EventWxaMediaCheck 异步校验图片/音频是否含有违法违规内容推送事件
EventWxaMediaCheck EventType = "wxa_media_check"
// EventSubscribeMsgPopupEvent 订阅通知事件推送
EventSubscribeMsgPopupEvent EventType = "subscribe_msg_popup_event"
// EventPublishJobFinish 发布任务完成
EventPublishJobFinish EventType = "PUBLISHJOBFINISH"
) )
const ( const (
//微信开放平台需要用到 // 微信开放平台需要用到
// InfoTypeVerifyTicket 返回ticket // InfoTypeVerifyTicket 返回ticket
InfoTypeVerifyTicket InfoType = "component_verify_ticket" InfoTypeVerifyTicket InfoType = "component_verify_ticket"
// InfoTypeAuthorized 授权 // InfoTypeAuthorized 授权
InfoTypeAuthorized = "authorized" InfoTypeAuthorized InfoType = "authorized"
// InfoTypeUnauthorized 取消授权 // InfoTypeUnauthorized 取消授权
InfoTypeUnauthorized = "unauthorized" InfoTypeUnauthorized InfoType = "unauthorized"
// InfoTypeUpdateAuthorized 更新授权 // InfoTypeUpdateAuthorized 更新授权
InfoTypeUpdateAuthorized = "updateauthorized" InfoTypeUpdateAuthorized InfoType = "updateauthorized"
// InfoTypeNotifyThirdFasterRegister 注册审核事件推送
InfoTypeNotifyThirdFasterRegister InfoType = "notify_third_fasteregister"
) )
//MixMessage 存放所有微信发送过来的消息和事件 // MixMessage 存放所有微信发送过来的消息和事件
type MixMessage struct { type MixMessage struct {
CommonToken CommonToken
//基本消息 // 基本消息
MsgID int64 `xml:"MsgId"` MsgID int64 `xml:"MsgId"` // 其他消息推送过来是MsgId
Content string `xml:"Content"` TemplateMsgID int64 `xml:"MsgID"` // 模板消息推送成功的消息是MsgID
Recognition string `xml:"Recognition"` Content string `xml:"Content"`
PicURL string `xml:"PicUrl"` Recognition string `xml:"Recognition"`
MediaID string `xml:"MediaId"` PicURL string `xml:"PicUrl"`
Format string `xml:"Format"` MediaID string `xml:"MediaId"`
ThumbMediaID string `xml:"ThumbMediaId"` Format string `xml:"Format"`
LocationX float64 `xml:"Location_X"` ThumbMediaID string `xml:"ThumbMediaId"`
LocationY float64 `xml:"Location_Y"` LocationX float64 `xml:"Location_X"`
Scale float64 `xml:"Scale"` LocationY float64 `xml:"Location_Y"`
Label string `xml:"Label"` Scale float64 `xml:"Scale"`
Title string `xml:"Title"` Label string `xml:"Label"`
Description string `xml:"Description"` Title string `xml:"Title"`
URL string `xml:"Url"` Description string `xml:"Description"`
URL string `xml:"Url"`
//事件相关 // 事件相关
Event EventType `xml:"Event"` Event EventType `xml:"Event" json:"Event"`
EventKey string `xml:"EventKey"` EventKey string `xml:"EventKey"`
Ticket string `xml:"Ticket"` Ticket string `xml:"Ticket"`
Latitude string `xml:"Latitude"` Latitude string `xml:"Latitude"`
@@ -114,6 +128,10 @@ type MixMessage struct {
MenuID string `xml:"MenuId"` MenuID string `xml:"MenuId"`
Status string `xml:"Status"` Status string `xml:"Status"`
SessionFrom string `xml:"SessionFrom"` SessionFrom string `xml:"SessionFrom"`
TotalCount int64 `xml:"TotalCount"`
FilterCount int64 `xml:"FilterCount"`
SentCount int64 `xml:"SentCount"`
ErrorCount int64 `xml:"ErrorCount"`
ScanCodeInfo struct { ScanCodeInfo struct {
ScanType string `xml:"ScanType"` ScanType string `xml:"ScanType"`
@@ -133,6 +151,27 @@ type MixMessage struct {
Poiname string `xml:"Poiname"` Poiname string `xml:"Poiname"`
} }
subscribeMsgPopupEventList []SubscribeMsgPopupEvent `json:"-"`
SubscribeMsgPopupEvent []struct {
List SubscribeMsgPopupEvent `xml:"List"`
} `xml:"SubscribeMsgPopupEvent"`
// 事件相关:发布能力
PublishEventInfo struct {
PublishID int64 `xml:"publish_id"` // 发布任务id
PublishStatus freepublish.PublishStatus `xml:"publish_status"` // 发布状态
ArticleID string `xml:"article_id"` // 当发布状态为0时即成功返回图文的 article_id可用于“客服消息”场景
ArticleDetail struct {
Count uint `xml:"count"` // 文章数量
Item []struct {
Index uint `xml:"idx"` // 文章对应的编号
ArticleURL string `xml:"article_url"` // 图文的永久链接
} `xml:"item"`
} `xml:"article_detail"` // 当发布状态为0时即成功返回内容
FailIndex []uint `xml:"fail_idx"` // 当发布状态为2或4时返回不通过的文章编号第一篇为 1其他发布状态则为空
} `xml:"PublishEventInfo"`
// 第三方平台相关 // 第三方平台相关
InfoType InfoType `xml:"InfoType"` InfoType InfoType `xml:"InfoType"`
AppID string `xml:"AppId"` AppID string `xml:"AppId"`
@@ -141,6 +180,15 @@ type MixMessage struct {
AuthorizationCode string `xml:"AuthorizationCode"` AuthorizationCode string `xml:"AuthorizationCode"`
AuthorizationCodeExpiredTime int64 `xml:"AuthorizationCodeExpiredTime"` AuthorizationCodeExpiredTime int64 `xml:"AuthorizationCodeExpiredTime"`
PreAuthCode string `xml:"PreAuthCode"` PreAuthCode string `xml:"PreAuthCode"`
AuthCode string `xml:"auth_code"`
Info struct {
Name string `xml:"name"`
Code string `xml:"code"`
CodeType int `xml:"code_type"`
LegalPersonaWechat string `xml:"legal_persona_wechat"`
LegalPersonaName string `xml:"legal_persona_name"`
ComponentPhone string `xml:"component_phone"`
} `xml:"info"`
// 卡券相关 // 卡券相关
CardID string `xml:"CardId"` CardID string `xml:"CardId"`
@@ -159,23 +207,47 @@ type MixMessage struct {
TraceID string `xml:"trace_id"` TraceID string `xml:"trace_id"`
StatusCode int `xml:"status_code"` StatusCode int `xml:"status_code"`
//设备相关 // 设备相关
device.MsgDevice device.MsgDevice
} }
//EventPic 发图事件推送 // SubscribeMsgPopupEvent 订阅通知事件推送的消息体
type SubscribeMsgPopupEvent struct {
TemplateID string `xml:"TemplateId" json:"TemplateId"`
SubscribeStatusString string `xml:"SubscribeStatusString" json:"SubscribeStatusString"`
PopupScene int `xml:"PopupScene" json:"PopupScene,string"`
}
// SetSubscribeMsgPopupEvents 设置订阅消息事件
func (s *MixMessage) SetSubscribeMsgPopupEvents(list []SubscribeMsgPopupEvent) {
s.subscribeMsgPopupEventList = list
}
// GetSubscribeMsgPopupEvents 获取订阅消息事件数据
func (s *MixMessage) GetSubscribeMsgPopupEvents() []SubscribeMsgPopupEvent {
if s.subscribeMsgPopupEventList != nil {
return s.subscribeMsgPopupEventList
}
list := make([]SubscribeMsgPopupEvent, len(s.SubscribeMsgPopupEvent))
for i, item := range s.SubscribeMsgPopupEvent {
list[i] = item.List
}
return list
}
// EventPic 发图事件推送
type EventPic struct { type EventPic struct {
PicMd5Sum string `xml:"PicMd5Sum"` PicMd5Sum string `xml:"PicMd5Sum"`
} }
//EncryptedXMLMsg 安全模式下的消息体 // EncryptedXMLMsg 安全模式下的消息体
type EncryptedXMLMsg struct { type EncryptedXMLMsg struct {
XMLName struct{} `xml:"xml" json:"-"` XMLName struct{} `xml:"xml" json:"-"`
ToUserName string `xml:"ToUserName" json:"ToUserName"` ToUserName string `xml:"ToUserName" json:"ToUserName"`
EncryptedMsg string `xml:"Encrypt" json:"Encrypt"` EncryptedMsg string `xml:"Encrypt" json:"Encrypt"`
} }
//ResponseEncryptedXMLMsg 需要返回的消息体 // ResponseEncryptedXMLMsg 需要返回的消息体
type ResponseEncryptedXMLMsg struct { type ResponseEncryptedXMLMsg struct {
XMLName struct{} `xml:"xml" json:"-"` XMLName struct{} `xml:"xml" json:"-"`
EncryptedMsg string `xml:"Encrypt" json:"Encrypt"` EncryptedMsg string `xml:"Encrypt" json:"Encrypt"`
@@ -197,28 +269,33 @@ func (c CDATA) MarshalXML(e *xml.Encoder, start xml.StartElement) error {
// CommonToken 消息中通用的结构 // CommonToken 消息中通用的结构
type CommonToken struct { type CommonToken struct {
XMLName xml.Name `xml:"xml"` XMLName xml.Name `xml:"xml"`
ToUserName CDATA `xml:"ToUserName"` ToUserName CDATA `xml:"ToUserName" json:"ToUserName"`
FromUserName CDATA `xml:"FromUserName"` FromUserName CDATA `xml:"FromUserName" json:"FromUserName"`
CreateTime int64 `xml:"CreateTime"` CreateTime int64 `xml:"CreateTime" json:"CreateTime"`
MsgType MsgType `xml:"MsgType"` MsgType MsgType `xml:"MsgType" json:"MsgType"`
} }
//SetToUserName set ToUserName // SetToUserName set ToUserName
func (msg *CommonToken) SetToUserName(toUserName CDATA) { func (msg *CommonToken) SetToUserName(toUserName CDATA) {
msg.ToUserName = toUserName msg.ToUserName = toUserName
} }
//SetFromUserName set FromUserName // SetFromUserName set FromUserName
func (msg *CommonToken) SetFromUserName(fromUserName CDATA) { func (msg *CommonToken) SetFromUserName(fromUserName CDATA) {
msg.FromUserName = fromUserName msg.FromUserName = fromUserName
} }
//SetCreateTime set createTime // SetCreateTime set createTime
func (msg *CommonToken) SetCreateTime(createTime int64) { func (msg *CommonToken) SetCreateTime(createTime int64) {
msg.CreateTime = createTime msg.CreateTime = createTime
} }
//SetMsgType set MsgType // SetMsgType set MsgType
func (msg *CommonToken) SetMsgType(msgType MsgType) { func (msg *CommonToken) SetMsgType(msgType MsgType) {
msg.MsgType = msgType msg.MsgType = msgType
} }
// GetOpenID get the FromUserName value
func (msg *CommonToken) GetOpenID() string {
return string(msg.FromUserName)
}

View File

@@ -1,6 +1,6 @@
package message package message
//Music 音乐消息 // Music 音乐消息
type Music struct { type Music struct {
CommonToken CommonToken
@@ -13,7 +13,7 @@ type Music struct {
} `xml:"Music"` } `xml:"Music"`
} }
//NewMusic 回复音乐消息 // NewMusic 回复音乐消息
func NewMusic(title, description, musicURL, hQMusicURL, thumbMediaID string) *Music { func NewMusic(title, description, musicURL, hQMusicURL, thumbMediaID string) *Music {
music := new(Music) music := new(Music)
music.Music.Title = title music.Music.Title = title

View File

@@ -1,6 +1,6 @@
package message package message
//News 图文消息 // News 图文消息
type News struct { type News struct {
CommonToken CommonToken
@@ -8,7 +8,7 @@ type News struct {
Articles []*Article `xml:"Articles>item,omitempty"` Articles []*Article `xml:"Articles>item,omitempty"`
} }
//NewNews 初始化图文消息 // NewNews 初始化图文消息
func NewNews(articles []*Article) *News { func NewNews(articles []*Article) *News {
news := new(News) news := new(News)
news.ArticleCount = len(articles) news.ArticleCount = len(articles)
@@ -16,7 +16,7 @@ func NewNews(articles []*Article) *News {
return news return news
} }
//Article 单篇文章 // Article 单篇文章
type Article struct { type Article struct {
Title string `xml:"Title,omitempty"` Title string `xml:"Title,omitempty"`
Description string `xml:"Description,omitempty"` Description string `xml:"Description,omitempty"`
@@ -24,7 +24,7 @@ type Article struct {
URL string `xml:"Url,omitempty"` URL string `xml:"Url,omitempty"`
} }
//NewArticle 初始化文章 // NewArticle 初始化文章
func NewArticle(title, description, picURL, url string) *Article { func NewArticle(title, description, picURL, url string) *Article {
article := new(Article) article := new(Article)
article.Title = title article.Title = title

View File

@@ -2,13 +2,13 @@ package message
import "errors" import "errors"
//ErrInvalidReply 无效的回复 // ErrInvalidReply 无效的回复
var ErrInvalidReply = errors.New("无效的回复消息") var ErrInvalidReply = errors.New("无效的回复消息")
//ErrUnsupportReply 不支持的回复类型 // ErrUnsupportReply 不支持的回复类型
var ErrUnsupportReply = errors.New("不支持的回复消息") var ErrUnsupportReply = errors.New("不支持的回复消息")
//Reply 消息回复 // Reply 消息回复
type Reply struct { type Reply struct {
MsgType MsgType MsgType MsgType
MsgData interface{} MsgData interface{}

View File

@@ -0,0 +1,255 @@
package message
import (
"fmt"
"github.com/silenceper/wechat/v2/officialaccount/context"
"github.com/silenceper/wechat/v2/util"
)
const (
subscribeSendURL = "https://api.weixin.qq.com/cgi-bin/message/subscribe/bizsend"
subscribeTemplateListURL = "https://api.weixin.qq.com/wxaapi/newtmpl/gettemplate"
subscribeTemplateAddURL = "https://api.weixin.qq.com/wxaapi/newtmpl/addtemplate"
subscribeTemplateDelURL = "https://api.weixin.qq.com/wxaapi/newtmpl/deltemplate"
subscribeTemplateGetCategoryURL = "https://api.weixin.qq.com/wxaapi/newtmpl/getcategory"
subscribeTemplateGetPubTplKeyWorksURL = "https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatekeywords"
subscribeTemplateGetPubTplTitles = "https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatetitles"
)
// Subscribe 订阅消息
type Subscribe struct {
*context.Context
}
// NewSubscribe 实例化
func NewSubscribe(context *context.Context) *Subscribe {
tpl := new(Subscribe)
tpl.Context = context
return tpl
}
// SubscribeMessage 发送的订阅消息内容
type SubscribeMessage struct {
ToUser string `json:"touser"` // 必须, 接受者OpenID
TemplateID string `json:"template_id"` // 必须, 模版ID
Page string `json:"page,omitempty"` // 可选, 跳转网页时填写
Data map[string]*SubscribeDataItem `json:"data"` // 必须, 模板数据
MiniProgram struct {
AppID string `json:"appid"` // 所需跳转到的小程序appid该小程序appid必须与发模板消息的公众号是绑定关联关系
PagePath string `json:"pagepath"` // 所需跳转到小程序的具体页面路径,支持带参数,示例index?foo=bar
} `json:"miniprogram"` // 可选,跳转至小程序地址
}
// SubscribeDataItem 模版内某个 .DATA 的值
type SubscribeDataItem struct {
Value string `json:"value"`
}
// Send 发送订阅消息
func (tpl *Subscribe) Send(msg *SubscribeMessage) (err error) {
var accessToken string
accessToken, err = tpl.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", subscribeSendURL, accessToken)
response, err := util.PostJSON(uri, msg)
if err != nil {
return
}
return util.DecodeWithCommonError(response, "SendSubscribeMessage")
}
// PrivateSubscribeItem 私有订阅消息模板
type PrivateSubscribeItem struct {
PriTmplID string `json:"priTmplId"` // 添加至帐号下的模板 id发送订阅通知时所需
Title string `json:"title"` // 模版标题
Content string `json:"content"` // 模版内容
Example string `json:"example"` // 模板内容示例
SubType int `json:"type"` // 模版类型2 为一次性订阅3 为长期订阅
}
type resPrivateSubscribeList struct {
util.CommonError
SubscriptionList []*PrivateSubscribeItem `json:"data"`
}
// List 获取私有订阅消息模板列表
func (tpl *Subscribe) List() (templateList []*PrivateSubscribeItem, err error) {
var accessToken string
accessToken, err = tpl.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", subscribeTemplateListURL, accessToken)
var response []byte
response, err = util.HTTPGet(uri)
if err != nil {
return
}
var res resPrivateSubscribeList
err = util.DecodeWithError(response, &res, "ListSubscribe")
if err != nil {
return
}
templateList = res.SubscriptionList
return
}
type resSubscribeAdd struct {
util.CommonError
TemplateID string `json:"priTmplId"`
}
// Add 添加订阅消息模板
func (tpl *Subscribe) Add(ShortID string, kidList []int, sceneDesc string) (templateID string, err error) {
var accessToken string
accessToken, err = tpl.GetAccessToken()
if err != nil {
return
}
var msg = struct {
TemplateIDShort string `json:"tid"`
SceneDesc string `json:"sceneDesc"`
KidList []int `json:"kidList"`
}{TemplateIDShort: ShortID, SceneDesc: sceneDesc, KidList: kidList}
uri := fmt.Sprintf("%s?access_token=%s", subscribeTemplateAddURL, accessToken)
var response []byte
response, err = util.PostJSON(uri, msg)
if err != nil {
return
}
var result resSubscribeAdd
err = util.DecodeWithError(response, &result, "AddSubscribe")
if err != nil {
return
}
templateID = result.TemplateID
return
}
// Delete 删除私有模板
func (tpl *Subscribe) Delete(templateID string) (err error) {
var accessToken string
accessToken, err = tpl.GetAccessToken()
if err != nil {
return
}
var msg = struct {
TemplateID string `json:"priTmplId"`
}{TemplateID: templateID}
uri := fmt.Sprintf("%s?access_token=%s", subscribeTemplateDelURL, accessToken)
var response []byte
response, err = util.PostJSON(uri, msg)
if err != nil {
return
}
return util.DecodeWithCommonError(response, "DeleteSubscribe")
}
// PublicTemplateCategory 公众号类目
type PublicTemplateCategory struct {
ID int `json:"id"` //类目ID
Name string `json:"name"` //类目的中文名
}
type resSubscribeCategoryList struct {
util.CommonError
CategoryList []*PublicTemplateCategory `json:"data"`
}
// GetCategory 获取公众号类目
func (tpl *Subscribe) GetCategory() (categoryList []*PublicTemplateCategory, err error) {
var accessToken string
accessToken, err = tpl.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", subscribeTemplateGetCategoryURL, accessToken)
var response []byte
response, err = util.HTTPGet(uri)
if err != nil {
return
}
var result resSubscribeCategoryList
err = util.DecodeWithError(response, &result, "GetCategory")
if err != nil {
return
}
categoryList = result.CategoryList
return
}
// PublicTemplateKeyWords 模板中的关键词
type PublicTemplateKeyWords struct {
KeyWordsID int `json:"kid"` // 关键词 id
Name string `json:"name"` // 关键词内容
Example string `json:"example"` //关键词内容对应的示例
Rule string `json:"rule"` // 参数类型
}
type resPublicTemplateKeyWordsList struct {
util.CommonError
KeyWordsList []*PublicTemplateKeyWords `json:"data"` //关键词列表
}
// GetPubTplKeyWordsByID 获取模板中的关键词
func (tpl *Subscribe) GetPubTplKeyWordsByID(titleID string) (keyWordsList []*PublicTemplateKeyWords, err error) {
var accessToken string
accessToken, err = tpl.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s&tid=%s", subscribeTemplateGetPubTplKeyWorksURL, accessToken, titleID)
var response []byte
response, err = util.HTTPGet(uri)
if err != nil {
return
}
var result resPublicTemplateKeyWordsList
err = util.DecodeWithError(response, &result, "GetPublicTemplateKeyWords")
if err != nil {
return
}
keyWordsList = result.KeyWordsList
return
}
// PublicTemplateTitle 类目下的公共模板
type PublicTemplateTitle struct {
TitleID int `json:"tid"` // 模版标题 id
Title string `json:"title"` // 模版标题
Type int `json:"type"` // 模版类型2 为一次性订阅3 为长期订阅
CategoryID string `json:"categoryId"` // 模版所属类目 id
}
type resPublicTemplateTitleList struct {
util.CommonError
Count int `json:"count"` //公共模板列表总数
TemplateTitleList []*PublicTemplateTitle `json:"data"` //模板标题列表
}
// GetPublicTemplateTitleList 获取类目下的公共模板
func (tpl *Subscribe) GetPublicTemplateTitleList(ids string, start int, limit int) (count int, templateTitleList []*PublicTemplateTitle, err error) {
var accessToken string
accessToken, err = tpl.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s&ids=%s&start=%d&limit=%d", subscribeTemplateGetPubTplTitles, accessToken, ids, start, limit)
var response []byte
response, err = util.HTTPGet(uri)
if err != nil {
return
}
var result resPublicTemplateTitleList
err = util.DecodeWithError(response, &result, "GetPublicTemplateTitle")
if err != nil {
return
}
count = result.Count
templateTitleList = result.TemplateTitleList
return
}

View File

@@ -10,36 +10,39 @@ import (
const ( const (
templateSendURL = "https://api.weixin.qq.com/cgi-bin/message/template/send" templateSendURL = "https://api.weixin.qq.com/cgi-bin/message/template/send"
templateListURL = "https://api.weixin.qq.com/cgi-bin/template/get_all_private_template"
templateAddURL = "https://api.weixin.qq.com/cgi-bin/template/api_add_template"
templateDelURL = "https://api.weixin.qq.com/cgi-bin/template/del_private_template"
) )
//Template 模板消息 // Template 模板消息
type Template struct { type Template struct {
*context.Context *context.Context
} }
//NewTemplate 实例化 // NewTemplate 实例化
func NewTemplate(context *context.Context) *Template { func NewTemplate(context *context.Context) *Template {
tpl := new(Template) tpl := new(Template)
tpl.Context = context tpl.Context = context
return tpl return tpl
} }
//Message 发送的模板消息内容 // TemplateMessage 发送的模板消息内容
type Message struct { type TemplateMessage struct {
ToUser string `json:"touser"` // 必须, 接受者OpenID ToUser string `json:"touser"` // 必须, 接受者OpenID
TemplateID string `json:"template_id"` // 必须, 模版ID TemplateID string `json:"template_id"` // 必须, 模版ID
URL string `json:"url,omitempty"` // 可选, 用户点击后跳转的URL, 该URL必须处于开发者在公众平台网站中设置的域中 URL string `json:"url,omitempty"` // 可选, 用户点击后跳转的URL, 该URL必须处于开发者在公众平台网站中设置的域中
Color string `json:"color,omitempty"` // 可选, 整个消息的颜色, 可以不设置 Color string `json:"color,omitempty"` // 可选, 整个消息的颜色, 可以不设置
Data map[string]*DataItem `json:"data"` // 必须, 模板数据 Data map[string]*TemplateDataItem `json:"data"` // 必须, 模板数据
MiniProgram struct { MiniProgram struct {
AppID string `json:"appid"` //所需跳转到的小程序appid该小程序appid必须与发模板消息的公众号是绑定关联关系 AppID string `json:"appid"` // 所需跳转到的小程序appid该小程序appid必须与发模板消息的公众号是绑定关联关系
PagePath string `json:"pagepath"` //所需跳转到小程序的具体页面路径,支持带参数,示例index?foo=bar PagePath string `json:"pagepath"` // 所需跳转到小程序的具体页面路径,支持带参数,示例index?foo=bar
} `json:"miniprogram"` //可选,跳转至小程序地址 } `json:"miniprogram"` // 可选,跳转至小程序地址
} }
//DataItem 模版内某个 .DATA 的值 // TemplateDataItem 模版内某个 .DATA 的值
type DataItem struct { type TemplateDataItem struct {
Value string `json:"value"` Value string `json:"value"`
Color string `json:"color,omitempty"` Color string `json:"color,omitempty"`
} }
@@ -50,16 +53,19 @@ type resTemplateSend struct {
MsgID int64 `json:"msgid"` MsgID int64 `json:"msgid"`
} }
//Send 发送模板消息 // Send 发送模板消息
func (tpl *Template) Send(msg *Message) (msgID int64, err error) { func (tpl *Template) Send(msg *TemplateMessage) (msgID int64, err error) {
var accessToken string var accessToken string
accessToken, err = tpl.GetAccessToken() accessToken, err = tpl.GetAccessToken()
if err != nil { if err != nil {
return return
} }
uri := fmt.Sprintf("%s?access_token=%s", templateSendURL, accessToken) uri := fmt.Sprintf("%s?access_token=%s", templateSendURL, accessToken)
response, err := util.PostJSON(uri, msg) var response []byte
response, err = util.PostJSON(uri, msg)
if err != nil {
return
}
var result resTemplateSend var result resTemplateSend
err = json.Unmarshal(response, &result) err = json.Unmarshal(response, &result)
if err != nil { if err != nil {
@@ -72,3 +78,93 @@ func (tpl *Template) Send(msg *Message) (msgID int64, err error) {
msgID = result.MsgID msgID = result.MsgID
return return
} }
// TemplateItem 模板消息.
type TemplateItem struct {
TemplateID string `json:"template_id"`
Title string `json:"title"`
PrimaryIndustry string `json:"primary_industry"`
DeputyIndustry string `json:"deputy_industry"`
Content string `json:"content"`
Example string `json:"example"`
}
type resTemplateList struct {
util.CommonError
TemplateList []*TemplateItem `json:"template_list"`
}
// List 获取模板列表
func (tpl *Template) List() (templateList []*TemplateItem, err error) {
var accessToken string
accessToken, err = tpl.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", templateListURL, accessToken)
var response []byte
response, err = util.HTTPGet(uri)
if err != nil {
return
}
var res resTemplateList
err = util.DecodeWithError(response, &res, "ListTemplate")
if err != nil {
return
}
templateList = res.TemplateList
return
}
type resTemplateAdd struct {
util.CommonError
TemplateID string `json:"template_id"`
}
// Add 添加模板.
func (tpl *Template) Add(shortID string) (templateID string, err error) {
var accessToken string
accessToken, err = tpl.GetAccessToken()
if err != nil {
return
}
var msg = struct {
ShortID string `json:"template_id_short"`
}{ShortID: shortID}
uri := fmt.Sprintf("%s?access_token=%s", templateAddURL, accessToken)
var response []byte
response, err = util.PostJSON(uri, msg)
if err != nil {
return
}
var result resTemplateAdd
err = util.DecodeWithError(response, &result, "AddTemplate")
if err != nil {
return
}
templateID = result.TemplateID
return
}
// Delete 删除私有模板.
func (tpl *Template) Delete(templateID string) (err error) {
var accessToken string
accessToken, err = tpl.GetAccessToken()
if err != nil {
return
}
var msg = struct {
TemplateID string `json:"template_id"`
}{TemplateID: templateID}
uri := fmt.Sprintf("%s?access_token=%s", templateDelURL, accessToken)
var response []byte
response, err = util.PostJSON(uri, msg)
if err != nil {
return
}
return util.DecodeWithCommonError(response, "DeleteTemplate")
}

View File

@@ -1,12 +1,12 @@
package message package message
//Text 文本消息 // Text 文本消息
type Text struct { type Text struct {
CommonToken CommonToken
Content CDATA `xml:"Content"` Content CDATA `xml:"Content"`
} }
//NewText 初始化文本消息 // NewText 初始化文本消息
func NewText(content string) *Text { func NewText(content string) *Text {
text := new(Text) text := new(Text)
text.Content = CDATA(content) text.Content = CDATA(content)

View File

@@ -1,23 +1,23 @@
package message package message
//TransferCustomer 转发客服消息 // TransferCustomer 转发客服消息
type TransferCustomer struct { type TransferCustomer struct {
CommonToken CommonToken
TransInfo *TransInfo `xml:"TransInfo,omitempty"` TransInfo *TransInfo `xml:"TransInfo,omitempty"`
} }
//TransInfo 转发到指定客服 // TransInfo 转发到指定客服
type TransInfo struct { type TransInfo struct {
KfAccount string `xml:"KfAccount"` KfAccount string `xml:"KfAccount"`
} }
//NewTransferCustomer 实例化 // NewTransferCustomer 实例化
func NewTransferCustomer(KfAccount string) *TransferCustomer { func NewTransferCustomer(kfAccount string) *TransferCustomer {
tc := new(TransferCustomer) tc := new(TransferCustomer)
if KfAccount != "" { if kfAccount != "" {
transInfo := new(TransInfo) transInfo := new(TransInfo)
transInfo.KfAccount = KfAccount transInfo.KfAccount = kfAccount
tc.TransInfo = transInfo tc.TransInfo = transInfo
} }
return tc return tc

View File

@@ -1,6 +1,6 @@
package message package message
//Video 视频消息 // Video 视频消息
type Video struct { type Video struct {
CommonToken CommonToken
@@ -11,7 +11,7 @@ type Video struct {
} `xml:"Video"` } `xml:"Video"`
} }
//NewVideo 回复图片消息 // NewVideo 回复图片消息
func NewVideo(mediaID, title, description string) *Video { func NewVideo(mediaID, title, description string) *Video {
video := new(Video) video := new(Video)
video.Video.MediaID = mediaID video.Video.MediaID = mediaID

Some files were not shown because too many files have changed in this diff Show More