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

Compare commits

..

93 Commits

Author SHA1 Message Date
曹晶
f0f35e2f77 feat(miniprogram): add intracity delivery service APIs (#875)
* feat(media): add getTempFile api

add getTempFile api

* feat(miniprogram): add intracity delivery service APIs

Add WeChat intracity (same-city) delivery service APIs including:
- Store management: Apply, Create, Query, Update store
- Payment: StoreCharge, StoreRefund, QueryFlow, BalanceQuery
- Order management: PreAddOrder, AddOrder, QueryOrder, CancelOrder

Ref: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/intracity_service.html

---------

Co-authored-by: lumiaqian <cjj1@truesightai.com>
2026-01-22 19:18:52 +08:00
markwang
eebfb93386 feat: 企业微信-获取成员UserID (#876) 2026-01-22 19:18:35 +08:00
markwang
9b028e5368 feat: 企业微信-通讯录管理-成员管理新增接口 (#874)
* feat: 企业微信-通讯录管理-成员管理新增接口

* feat: 企业微信-通讯录管理-成员管理新增接口
2026-01-20 16:15:09 +08:00
markwang
2bfc250f21 feat: 企业微信-通讯录管理-成员管理新增接口 (#873) 2026-01-16 23:31:39 +08:00
markwang
f0866babb5 feat: 企业微信-打卡规则支持配置大小周规则 (#872) 2026-01-14 12:54:39 +08:00
Gophlet
7d93d1b9c8 feat(redis): 优化配置语义并增强超时与连接池能力,同时保持向后兼容 (#869)
* fix: correct non-standard 'yml' tag to 'yaml' in RedisOpts

* fix: apply MaxActive config to Redis PoolSize

* fix: clarify config semantics, enhance timeout & pool options, and maintain backward compatibility

* test: update unit test for redis

* refactor: apply suggestions from code review

* test: add comprehensive coverage for redis

* refactor: resolve funlen linter errors in redis unit tests

* refactor: remove empty else-if branch in NewRedis function
2026-01-08 09:49:41 +08:00
markwang
78c00a9124 fix: 企业微信-营销获客更新 (#871) 2025-12-30 18:00:01 +08:00
yin jiashuai
54f08cbd73 update:小程序ocr识别 refs#864 (#865)
* update:小程序ocr识别

* fix:删除ResPlateNumber

---------

Co-authored-by: 阴佳帅 <14988374+yin-jiashuai@user.noreply.gitee.com>
2025-11-16 21:46:49 +08:00
markwang
c34ff2031b fix: 企业微信-通讯录管理-更新成员企业邮箱别名参数类型修正 (#863) 2025-11-13 14:13:14 +08:00
is-Xiaoen
30c8e77246 fix: improve type safety in httpWithTLS for custom RoundTripper (#861)
* fix: improve type safety in httpWithTLS for custom RoundTripper

Add type assertion check to handle cases where DefaultHTTPClient.Transport
is a custom http.RoundTripper implementation (not *http.Transport).

This improves upon the fix in PR #844 which only handled nil Transport.
The previous code would still panic if users set a custom RoundTripper:

  trans := baseTransport.(*http.Transport).Clone()  // panic if not *http.Transport

Now safely handles three scenarios:
1. Transport is nil -> use http.DefaultTransport
2. Transport is *http.Transport -> clone it
3. Transport is custom RoundTripper -> use http.DefaultTransport

Added comprehensive test cases:
- TestHttpWithTLS_NilTransport
- TestHttpWithTLS_CustomTransport
- TestHttpWithTLS_CustomRoundTripper

Related to #803

* refactor: reduce code duplication and complexity in httpWithTLS

- Eliminate duplicate http.DefaultTransport.Clone() calls
- Reduce cyclomatic complexity by simplifying conditional logic
- Use nil check pattern instead of nested else branches
- Maintain same functionality with cleaner code structure

This addresses golangci-lint warnings for dupl and gocyclo.

* fix: add newline at end of http_test.go

Fix gofmt -s compliance issue:
- File must end with newline character
- Addresses golangci-lint gofmt error on line 81

This fixes CI check failure.
2025-10-27 14:24:24 +08:00
mahongran
6f6e95cfdb SubscribeMsgSentList结构中的ErrorCode类型从int更新为string (#859) 2025-10-24 20:49:24 +08:00
silenceper
c806a0c172 Add star badge to README 2025-10-24 17:37:01 +08:00
zhangjiani
c136b878ce 调整企微回调URL参数tag,兼容kratos框架 (#855)
* fix: handle JSON parse error when API returns binary file instead of error JSON

* fix: add JSON tags to SignatureOptions struct fields for proper serialization

* fix: mod module

* fix: rollback

---------

Co-authored-by: tax <jia_deng@intsig.net>
2025-09-19 11:16:52 +08:00
zhangjiani
d4a81916d5 fix: handle JSON parse error when API returns binary file instead of error JSON (#852)
Co-authored-by: tax <jia_deng@intsig.net>
2025-09-14 19:47:00 +08:00
Outyua
ef1372b98a fix BatchGetExternalUserDetails to return NextCursor in response (#849) 2025-08-18 15:51:30 +08:00
silenceper
0d666b60ba update readme (#848)
* update readme

* update readme

* update readme
2025-07-29 23:31:01 +08:00
silenceper
e1122d42b0 Update FUNDING.yml 2025-07-29 23:13:42 +08:00
silenceper
be3f0d8bd5 Update FUNDING.yml 2025-07-29 22:52:50 +08:00
silenceper
66f9794d2f Update FUNDING.yml (#847) 2025-07-29 22:41:02 +08:00
silenceper
ee5f045b89 fix panic (#844) 2025-07-24 09:59:13 +08:00
silenceper
d35f0f0865 Ai dev (#846)
* add Claude Code workflow

* add Claude Code model
2025-07-23 23:43:46 +08:00
silenceper
bbad169706 add Claude Code workflow (#845) 2025-07-23 22:56:33 +08:00
ccfish
5927c26152 追加接口【微信物流服务 /微信物流服务(商家查看) /查询组件】 (#843)
* feat: 添加 微信物流服务 /微信物流服务(商家查看) /消息组件

* fix lint issues

* fix: 查询运单详情信息返回结果结构

* 追加官方文档地址

* feat: 追加接口【微信物流服务 /微信物流服务(商家查看) /查询组件】

* fix: comments

* fix: indents
2025-07-21 10:13:47 +08:00
markwang
8ebff5c29c feat: 微信小程序-运维中心 (#838)
* feat: 微信小程序-运维中心

* feat: 微信小程序-运维中心

* feat: 微信小程序-运维中心

* feat: 微信小程序-运维中心
2025-07-14 16:16:44 +08:00
ccfish
86ef690ecd feat: 添加 微信物流服务 /微信物流服务(商家查看) /消息组件 (#842) 2025-07-05 09:01:15 +08:00
markwang
ee85790123 微信小程序-数据分析-获取小程序性能数据 (#837)
* feat: 微信小程序-数据分析-性能数据

* feat: 微信小程序-数据分析-性能数据

* feat: 微信小程序-数据分析-性能数据
2025-07-01 19:14:44 +08:00
markwang
8a810837a4 feat: 微信小程序-动态消息及订阅消息 (#835)
* feat: 微信小程序-动态消息及订阅消息

* feat: 微信小程序-动态消息及订阅消息

* feat: 微信小程序-动态消息及订阅消息
2025-06-18 16:16:43 +08:00
yahuian
c51d41ee8a security 模块增加 context 调用函数 (#836) 2025-06-18 16:14:10 +08:00
Lien Li
24f812d187 feat: 支持Redis作为Cache的时候使用TLS (#834)
* feat: 支持Redis作为Cache的时候使用TLS

* feat: fix lint

* fix lint

* Update redis.go
2025-05-03 23:43:15 +08:00
markwang
dd43b7baa3 feat: 微信小程序-小程序链接 (#833)
* feat: 微信小程序-小程序链接

* feat: 微信小程序-小程序链接
2025-05-01 10:19:19 +08:00
markwang
2dfd2ff608 feat: 微信小程序-登录及用户信息 (#830)
* feat: 微信小程序-登录及用户信息

* feat: 微信小程序-登录及用户信息
2025-04-27 10:09:31 +08:00
litterGuy
23bb10b0c9 fix: ImageUpload 接口报错 'media data missing hint:' (#832) 2025-04-27 10:08:51 +08:00
lizhuang
b639d2235d Add JSSDK context method functionality (#828)
* Add JSSDK context method functionality

* 善JSSDK上下文方法,并添加测试文件

* feat: 完善JSSDK上下文方法,保证协程安全,并添加测试文件

* 修改 import 包分组处理

* feat: 修改测试文件中 fmt.Print -> t.Log

* 删除空行
2025-04-23 14:14:16 +08:00
wwek
26d2093bd7 fix typo (#831) 2025-04-22 19:40:57 +08:00
曹晶
cf42cd8d54 feat: 添加获取成员多次收消息详情API (#824)
* feat(media): add getTempFile api

add getTempFile api

* feat: 添加获取成员多次收消息详情API

- 添加customerAcquisitionGetChatInfoURL常量
- 实现GetChatInfo方法及相关请求/响应结构体
- 支持企业微信获客助手多次收消息功能

---------

Co-authored-by: caojing <jingjing.cao@trustbe.cn>
2025-04-21 10:44:12 +08:00
markwang
85ee45580b feat: 企业微信-打卡-添加打卡记录 (#829) 2025-04-21 10:42:47 +08:00
markwang
208d5c528a feat: 企业微信-打卡-新增返回字段 (#827) 2025-04-18 20:08:21 +08:00
markwang
b5f9a8933e 企业微信-通讯录管理-更新成员接口,支持更新企业邮箱别名 (#826)
* feat: 企业微信-通讯录管理,新增更新成员、更新部门、删除部门方法

* feat: 企业微信-通讯录管理-更新成员接口,支持更新企业邮箱别名
2025-04-18 14:13:26 +08:00
LarryLiu
52fb5596d3 修改最新版本的授权地址 (#823)
* Update accessToken.go

add openplatform refresh_token

* Update accessToken.go

openplatform add refresh_token expire set 10 year

* Update openplatform/context/accessToken.go

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update accessToken.go

修改最新的授权H5链接地址

* Update accessToken.go

增加新版本授权链接

* Update accessToken.go

增加新版本授权链接

---------

Co-authored-by: houseme <housemecn@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-03-31 10:51:46 +08:00
LarryLiu
44150c557e 微信开放平台增加refreshtoken缓存 (#822)
* Update accessToken.go

add openplatform refresh_token

* Update accessToken.go

openplatform add refresh_token expire set 10 year

* Update openplatform/context/accessToken.go

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: houseme <housemecn@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-03-28 11:38:57 +08:00
fearlessfei
635a0c640d feat(auth): getAccessToken with context (#820) 2025-03-25 14:20:12 +08:00
mahongran
010e49c35c fix: work js-api signature (#818)
* feat: enhance WorkAccessToken to include AgentID for improved token management

- Added AgentID field to WorkAccessToken struct.
- Updated NewWorkAccessToken function to accept AgentID as a parameter.
- Modified access token cache key to incorporate AgentID, ensuring unique cache entries per agent.

This change improves the handling of access tokens in a multi-agent environment.

* refactor: enhance WorkAccessToken to improve cache key handling

- Updated the AgentID field in WorkAccessToken struct to clarify its optional nature for distinguishing applications.
- Modified the access token cache key construction to support both new and legacy formats based on the presence of AgentID.
- Added comments for better understanding of the cache key logic and its compatibility with historical versions.

This change improves the flexibility and clarity of access token management in multi-agent scenarios.

* feat(work): add JsSdk method for JavaScript SDK integration

- Introduced a new JsSdk method in the Work struct to facilitate the creation of a Js instance.
- This addition enhances the functionality of the Work module by enabling JavaScript SDK support.

This change improves the integration capabilities for developers working with the WeChat Work API.

* fix gofmt

* refactor(jsapi): simplify signature generation in GetConfig and GetAgentConfig methods

- Replaced the use of strconv to format the signature string with fmt.Sprintf for improved readability.
- Updated the signature generation logic in both GetConfig and GetAgentConfig methods to use a single formatted string.

This change enhances code clarity and maintains functionality in the signature generation process.

* fix gofmt

* fix gofmt

* fix gofmt

* fix gofmt

* refactor(js): correct initialization of Config in GetConfig method

- Removed redundant initialization of the Config variable and ensured it is instantiated correctly before use.
- This change improves code clarity and maintains the intended functionality of the GetConfig method.
2025-01-14 17:24:42 +08:00
mahongran
9c87d1cb34 feat:企业微信客户端API JS-SDK wx.config 和 wx.agentConfig 方法权限签名 (#817)
* feat: enhance WorkAccessToken to include AgentID for improved token management

- Added AgentID field to WorkAccessToken struct.
- Updated NewWorkAccessToken function to accept AgentID as a parameter.
- Modified access token cache key to incorporate AgentID, ensuring unique cache entries per agent.

This change improves the handling of access tokens in a multi-agent environment.

* refactor: enhance WorkAccessToken to improve cache key handling

- Updated the AgentID field in WorkAccessToken struct to clarify its optional nature for distinguishing applications.
- Modified the access token cache key construction to support both new and legacy formats based on the presence of AgentID.
- Added comments for better understanding of the cache key logic and its compatibility with historical versions.

This change improves the flexibility and clarity of access token management in multi-agent scenarios.

* feat(work): add JsSdk method for JavaScript SDK integration

- Introduced a new JsSdk method in the Work struct to facilitate the creation of a Js instance.
- This addition enhances the functionality of the Work module by enabling JavaScript SDK support.

This change improves the integration capabilities for developers working with the WeChat Work API.

* fix gofmt
2025-01-14 10:52:24 +08:00
mahongran
71c8ab58fb F ix work access token (#810)
* feat: enhance WorkAccessToken to include AgentID for improved token management

- Added AgentID field to WorkAccessToken struct.
- Updated NewWorkAccessToken function to accept AgentID as a parameter.
- Modified access token cache key to incorporate AgentID, ensuring unique cache entries per agent.

This change improves the handling of access tokens in a multi-agent environment.

* refactor: enhance WorkAccessToken to improve cache key handling

- Updated the AgentID field in WorkAccessToken struct to clarify its optional nature for distinguishing applications.
- Modified the access token cache key construction to support both new and legacy formats based on the presence of AgentID.
- Added comments for better understanding of the cache key logic and its compatibility with historical versions.

This change improves the flexibility and clarity of access token management in multi-agent scenarios.

* feat: enhance WorkAccessToken with new constructor for AgentID support

- Introduced NewWorkAccessTokenWithAgentID function to maintain backward compatibility while allowing for AgentID usage.
- Updated NewWorkAccessToken to call the new constructor, ensuring seamless integration.
- Improved error handling in GetAccessTokenContext by checking for cache availability and handling potential errors during cache operations.

This change enhances the flexibility of access token management, particularly in multi-agent scenarios, while ensuring compatibility with existing implementations.
2025-01-07 22:19:21 +08:00
mqf20
92bf6c7699 use context when getting access token (#815)
* use context

Signed-off-by: mqf20 <mingqingfoo@gmail.com>

* added docs

Signed-off-by: mqf20 <mingqingfoo@gmail.com>

* improved docs

Signed-off-by: mqf20 <mingqingfoo@gmail.com>

* added SetAccessTokenContextHandle

Signed-off-by: mqf20 <mingqingfoo@gmail.com>

---------

Signed-off-by: mqf20 <mingqingfoo@gmail.com>
2025-01-07 22:13:03 +08:00
mqf20
6b9d4f82da added GetPhoneNumberWithContext (#812)
Signed-off-by: mqf20 <mingqingfoo@gmail.com>
2025-01-07 13:31:43 +08:00
markwang
17521d047e feat: 企业微信-微信客服,客服账号列表接口支持分页拉取,接待人员增加部门ID (#798)
Co-authored-by: houseme <qzg40737@163.com>
2025-01-06 14:52:42 +08:00
Lien Li
d38e750876 add is_expire field for generateScheme (#808) 2025-01-03 10:32:30 +08:00
markwang
3bd886d7f2 feat: 企业微信-通讯录管理,新增更新成员、更新部门、删除部门方法 (#799) 2024-12-20 14:34:48 +08:00
曹晶
35af33f0bc feat(media): add UploadImgFromReader api (#802)
* feat(media): add getTempFile api

add getTempFile api

* feat(media): handle error in GetTempFile

handle error in GetTempFile

* feat(media): add UploadImgFromReader api

add UploadImgFromReader api

* fix(media): fixed not return common error

fixed not return common error
2024-12-20 14:34:27 +08:00
yangyl12345
4a8371e178 Feature/mini program template (#806)
* feat: 小程序发送订阅消息支持返回 msgid

* 小程序发送订阅消息支持返回 msgid

---------

Co-authored-by: w_yangyili <w_yangyili@xiwang.com>
2024-11-27 11:56:14 +08:00
yangyl12345
a571bf3546 Update default_access_token.go (#805)
* Update default_access_token.go

微信获取稳定版token,只有不等于空字符串的情况下才会返回access_token信息,未空的情况,继续调去微信服务

* 微信稳定性获取 access_token 接口,添加防止并发性获取 access_token 和多次微信服务获取代码

---------

Co-authored-by: w_yangyili <w_yangyili@xiwang.com>
2024-11-26 12:13:49 +08:00
CyJaySong
3fbe8634d9 officeaccount 和 miniprogram 添加UseStableAK 配置项 (#788) 2024-11-23 18:25:24 +08:00
markwang
990ba6ede9 feat: 企业微信-接待人员管理增加部门ID及停止接待子类型 (#800) 2024-10-16 16:11:20 +08:00
曹晶
44b09c7c3b feat(media): add getTempFile api (#801)
add getTempFile api
2024-10-16 16:11:03 +08:00
Lien Li
2e0708845b add-show_splash_ad-for-qrcodeparam (#794) 2024-08-26 10:20:39 +08:00
oah8
c1770130a0 add stream_upload_source (#786)
Co-authored-by: _oah <57302072@qq.com>
2024-08-22 14:21:58 +08:00
一叶知秋
c22a036b7f fix: 增加一个用户信息接口 (#793) 2024-08-22 12:08:44 +08:00
Ji Luo Yang
05ac7148d4 feat: 公众号新增模板接口,支持模板参数传递 (#783)
* feat: 公众号新增模板接口,支持模板参数传递

* fix: 公众号新增模板接口,合并定义参数

* fix: 公众号新增模板接口,统一代码风格

---------

Co-authored-by: yangj23 <yangj23@mingyuanyun.com>
2024-07-16 21:02:59 +08:00
sam
6b3532cc2d feat: Material 增加 AddMaterialFromReader 与 AddVideoFromReader 方法 (#780)
* feat: Material 增加 AddMaterialFromReader 与 AddVideoFromReader 方法

* update: 调整 PostFileFromReader 参数。
2024-07-16 15:43:18 +08:00
ccfish
1138a7db0e feat:追加动态消息接口 (#775)
* 小程序发货信息管理

* fix golang lint

* fix miss

* fix lint

* fix lint

* fix lint

* 修复查询参数last_index=“”时异常

* 小程序消息推送

* fix lint errors

* fix lint

* fix lint

* fix lint,

* 简化写法

* fix 简化写法

* fix name in comments

* Update miniprogram.go

* add events

* change GoodsInfo type

* change statements to 50

* 追加xml支持

* fix cl lint

* 追加动态消息

* 删除多余空格

* 修复命名

* 修复createActivityId返回值类型
2024-04-23 10:03:08 +08:00
houseme
1842f08f4c fix:modify mediaID type (#771)
* fix:modify mediaID type

* upgrade action version

* upgrade

* upgrade
2024-04-16 10:52:47 +08:00
markwang
d28ca4f334 feat: optimized-error-handling&remove unused constant (#772)
* feat: optimized-error-handling&remove unused constant

* feat: optimized-error-handling

---------

Co-authored-by: markwang <www.wang61@qq.com>
2024-04-16 10:51:51 +08:00
Leo
74795e86ee fix:群发视频消息及预览图片消息错误修复 (#774)
* fix:群发图片预览消息无效

* fix:群发视频消息参数名称错误

---------

Co-authored-by: wuweichao <wuweichao@dobest.com>
2024-03-28 16:28:03 +08:00
sotoupx
179704187b fix query url scheme error bug (#766)
Co-authored-by: sotoup <sotoup@gmail.com>
2024-02-19 10:05:03 +08:00
braumye
ceb006bf58 开放平台修改小程序基础信息 (#642)
* 开放平台修改小程序基础信息

* 统一错误处理
2024-01-29 14:36:32 +08:00
markwang
9f14122a87 feat:企业微信-打卡-打卡配置及规则管理 (#755)
Co-authored-by: markwang <www.wang61@qq.com>
2024-01-12 19:24:54 +08:00
ren-jimmy
7fcd7a34dd 添加小程序获取红包封面接口 (#760)
* ADD 获取红包封面

* Update redpacketcover.go

* MOD 修改为统一错误方法

* Update go.yml
2024-01-12 19:24:08 +08:00
Jiaxi_Wu
5b29289dbb fix: 修复缓存失效时,可能会重复获取accessToken的问题 (#762)
* fix: 修复缓存失效时,可能会重复获取accessToken的问题

* feat: 添加获取AK失败时的错误信息返回

---------

Co-authored-by: wujiaxi <wujiaxi@expandera.cn>
2024-01-12 19:23:09 +08:00
曹晶
74e3e9c04e feat(work): add member_version field in GroupChatListResponse (#757)
add member_version field in GroupChatListResponse
2024-01-02 17:24:17 +08:00
曹晶
97c9f7d908 fix(work): fix 752 (#753)
fix cannot unmarshal object into Go struct field ExternalUser.external_contact.external_profile of
type string
2024-01-02 17:23:22 +08:00
oscar
97e1af5904 支持设置全局HTTPClient (#761)
* [新增]支持设置httpClient

* 增加说明

* 增加说明

* 格式化imports

* [fix]1.21.5 和golangci 有兼容性问题

* [fix]优化imports
2024-01-02 17:19:59 +08:00
zxfishhack
a5e674bf10 支持在请求前修改各api的地址 (#736)
* 增加URI修改接口,以支持正向代理

* Update http.go

* Update http.go
2023-11-02 09:44:08 +08:00
leonard627
0ffe34187a fix:compatibility cache expiration returns empty string issue (#742) 2023-11-02 09:42:17 +08:00
曹晶
04b62f6c3c fix(work): fixed AddGroupWelcomeTemplate Error (#745)
* fix(work): fixed  AddGroupWelcomeTemplate Error

fixed  AddGroupWelcomeTemplate Error , errcode=40063 , errmsg=some parameters are empty

* fix(work): fixed  AddGroupWelcomeTemplate Error

fixed  AddGroupWelcomeTemplate Error , errcode=40063 , errmsg=some parameters are empty
2023-11-02 09:40:36 +08:00
markwang
4adc59b1b0 feat:企业微信-打卡-新增相关查询接口 (#746)
Co-authored-by: markwang <www.wang61@qq.com>
2023-11-02 09:40:01 +08:00
ourines
dad7932574 feat(work): add department by id (#741)
* feat(work): add department by id

Refactor the DepartmentList function and add the DepartmentListByID function.

* fix: api name

* fix: formatURL name

* chore: format
2023-11-02 09:39:42 +08:00
houseme
56a3734546 Feature: improve code message subscribe (#739)
* fix

* feat(miniapp): 小程序订阅消息 (#429)

1. 用户订阅消息服务端回调处理
2. 用户订阅消息订阅通知事件推送

Co-authored-by: houseme <qzg40737@163.com>

* feat: improve subscribe msg

* feat: add v1.21 and feature branch

* feat: improve code for subscribe

* test

* test

* fix

* fix

* improve comment

* improve code for message

* improve code for unmarshal message

* improve code for message

---------

Co-authored-by: Ralph Maas <stuchilde@outlook.com>
2023-11-02 09:39:10 +08:00
施国鹏
d4fd145bb5 add: oauth 添加 ctx, 且增加 GetUserInfoByCodeCtx 方法快速获取用户信息 (#747)
* add: oauth 添加 ctx, 且增加 GetUserInfoByCodeCtx 方法快速获取用户信息

* fix: code style

* fix: white space

---------

Co-authored-by: seth-shi <shiguopeng@mampod.com>
2023-11-02 09:38:42 +08:00
Thinker
038037b89d feat: 企业微信-打卡-日报与月报数据 (#733)
* feat: 企业微信-打卡-日报数据

* feat: 企业微信-打卡-月报数据

* refactor:重命名checkin为record(该文件内所有方法均为获取记录)

* refactor:修改字段名称以符合golint标准

* fix: ineffectual assignment to err
2023-10-10 22:10:10 -05:00
曹晶
479ff1f242 feat(work): AddMsgTemplate api add params allow_select chat_id_list tag_filter (#730)
* feat(work): add params allow_select chat_id_list tag_filter

add params allow_select chat_id_list tag_filter

* feat(work): add params allow_select chat_id_list tag_filter

add params allow_select chat_id_list tag_filter
2023-10-10 19:32:22 +08:00
markwang
3f1c5e7637 企业微信-移除可省略的错误判断 (#734)
Co-authored-by: markwang <www.wang61@qq.com>
2023-10-10 19:31:23 +08:00
曹晶
da5067bcb2 fix(work): fix json Unmarshal Error in GetExternalUserDetail api (#732)
fix json Unmarshal Error, err=json: cannot unmarshal number into Go struct field
WechatChannel.follow_user.wechat_channels.source of type string
2023-10-09 02:02:37 -05:00
houseme
8f10936479 fix: util.DecodeWithError result (#729) 2023-10-07 12:55:11 +08:00
曹晶
9bfebc8a27 fix(work): fix DepartmentGet with commonError is invalid or not struct (#728)
fix DepartmentGet with commonError is invalid or not struct
2023-09-25 14:15:33 +08:00
silenceper
4f6cbc3d59 remove goreleaser (#727) 2023-09-24 20:24:15 +08:00
markwang
49c4cfaf54 fix:GetAccessTokenContext从cache中获取字符窜为空时,从微信服务器获取 (#721)
Co-authored-by: markwang <www.wang61@qq.com>
2023-09-24 10:47:43 +08:00
曹晶
ead8a6fadb fix(work): fix UserGet api error userid not found (#723)
fix UserGet api error userid not found
2023-09-24 10:46:38 +08:00
曹晶
ae40639b56 feat(work): add DepartmentGet api (#718)
get single department detail
2023-09-24 10:46:18 +08:00
曹晶
8bb145155e fix(work): fix GroupChatMember struct without State (#717)
fix GroupChatMember struct without State in joinway config
2023-09-24 10:45:43 +08:00
febelery
85bf989242 feat: 添加发放红包接口 (#726)
* feat: 添加发放红包接口

* feat: 添加发放红包接口

* chore: golang ci lint

---------

Co-authored-by: ross <ross@ross.ross>
2023-09-24 10:44:18 +08:00
Feng
b4f2d1793c feat: Add Checkin (#719)
* feat: Add Checkin

- Implement 'getcheckindata' API

* refactor: Change variable names

* refactor: Change struct name
2023-09-24 10:43:41 +08:00
曹晶
4a2c44c7c8 Feature/upload attachment (#720)
* feat(work): add UploadAttachment API

add UploadAttachment API

* feat(work): add UploadAttachment API

add UploadAttachment API

* feat(work): add UploadAttachment API

add UploadAttachment API
2023-09-24 10:43:11 +08:00
113 changed files with 6574 additions and 1056 deletions

4
.github/FUNDING.yml vendored
View File

@@ -1,8 +1,8 @@
# These are supported funding model platforms
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
github: # silenceper
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
open_collective: gowechat
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry

View File

@@ -1,6 +1,6 @@
---
name: 报告Bug
about: 反馈BUG信息
name: 报告 Bug
about: 反馈 BUG 信息
title: "[BUG]"
labels: bug
assignees: ''
@@ -18,4 +18,4 @@ assignees: ''
**使用的版本**
- SDK版本: [比如 v0.0.0]
- SDK 版本[比如 v0.0.0]

View File

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

View File

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

38
.github/workflows/ai-dev.yaml vendored Normal file
View File

@@ -0,0 +1,38 @@
name: Claude Code
on:
issue_comment:
types: [created]
pull_request_review_comment:
types: [created]
issues:
types: [opened, assigned]
pull_request_review:
types: [submitted]
jobs:
claude:
if: |
(github.event_name == 'issue_comment' && contains(github.event.comment.body, '@claude')) ||
(github.event_name == 'pull_request_review_comment' && contains(github.event.comment.body, '@claude')) ||
(github.event_name == 'pull_request_review' && contains(github.event.review.body, '@claude')) ||
(github.event_name == 'issues' && (contains(github.event.issue.body, '@claude') || contains(github.event.issue.title, '@claude')))
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: read
issues: read
id-token: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 1
- name: Run Claude Code
id: claude
uses: anthropics/claude-code-action@beta
env:
ANTHROPIC_BASE_URL: "${{ secrets.ANTHROPIC_BASE_URL }}"
with:
model: "${{ secrets.ANTHROPIC_MODEL }}"
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}

View File

@@ -2,26 +2,26 @@ name: Go
on:
push:
branches: [ master,release-*,v2 ]
branches: [ master,release-*,v2,feature/**,fix/** ]
pull_request:
branches: [ master,release-*,v2 ]
branches: [ master,release-*,v2,feature/**,fix/** ]
jobs:
golangci:
strategy:
matrix:
go-version: [ '1.16','1.17','1.18','1.19','1.20' ]
go-version: [ '1.16','1.17','1.18','1.19','1.20','1.21.4' ]
name: golangci-lint
runs-on: ubuntu-latest
steps:
- name: Setup Golang ${{ matrix.go-version }}
uses: actions/setup-go@v4
uses: actions/setup-go@v5
with:
go-version: ${{ matrix.go-version }}
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: golangci-lint
uses: golangci/golangci-lint-action@v3
uses: golangci/golangci-lint-action@v4
with:
# Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
version: v1.52.2
@@ -42,12 +42,12 @@ jobs:
# strategy set
strategy:
matrix:
go: [ '1.16','1.17','1.18','1.19','1.20' ]
go: [ '1.16','1.17','1.18','1.19','1.20','1.21','1.22' ]
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Set up Go 1.x
uses: actions/setup-go@v4
uses: actions/setup-go@v5
with:
go-version: ${{ matrix.go }}
id: go

View File

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

View File

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

View File

@@ -1,12 +1,13 @@
# WeChat SDK for Go
![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](https://github.com/silenceper/wechat/actions/workflows/go.yml/badge.svg?branch=v2)
[![Go Report Card](https://goreportcard.com/badge/github.com/silenceper/wechat/v2)](https://goreportcard.com/report/github.com/silenceper/wechat/v2)
[![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)
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/silenceper/wechat?sort=semver)
![star](https://gitcode.com/silenceper/wechat/star/badge.svg)
使用Golang开发的微信SDK简单、易用。
> 注意当前版本为v2版本v1版本已废弃
## 文档 && 例子
@@ -75,7 +76,13 @@ server.Send()
- 提交issue描述需要贡献的内容
- 完成更改后提交PR
## 公众号
## 感谢以下贡献者
<a href="https://opencollective.com/gowechat"><img src="https://opencollective.com/gowechat/contributors.svg?width=890" /></a>
## 作者公众号
![img](https://silenceper.oss-cn-beijing.aliyuncs.com/qrcode/search_study_program.png)

75
cache/redis.go vendored
View File

@@ -2,6 +2,8 @@ package cache
import (
"context"
"crypto/tls"
"net"
"time"
"github.com/go-redis/redis/v8"
@@ -15,23 +17,76 @@ type Redis struct {
// RedisOpts redis 连接属性
type RedisOpts struct {
Host string `yml:"host" json:"host"`
Password string `yml:"password" json:"password"`
Database int `yml:"database" json:"database"`
MaxIdle int `yml:"max_idle" json:"max_idle"`
MaxActive int `yml:"max_active" json:"max_active"`
IdleTimeout int `yml:"idle_timeout" json:"idle_timeout"` // second
Host string `json:"host" yaml:"host"`
Username string `json:"username" yaml:"username"`
Password string `json:"password" yaml:"password"`
Database int `json:"database" yaml:"database"`
MinIdleConns int `json:"min_idle_conns" yaml:"min_idle_conns"` // 最小空闲连接数
PoolSize int `json:"pool_size" yaml:"pool_size"` // 连接池大小0 表示使用默认值(即 CPU 核心数 * 10
MaxRetries int `json:"max_retries" yaml:"max_retries"` // 最大重试次数,-1 表示不重试0 表示使用默认值(即 3 次)
DialTimeout int `json:"dial_timeout" yaml:"dial_timeout"` // 连接超时时间0 表示使用默认值(即 5 秒)
ReadTimeout int `json:"read_timeout" yaml:"read_timeout"` // 读取超时时间(秒),-1 表示不超时0 表示使用默认值(即 3 秒)
WriteTimeout int `json:"write_timeout" yaml:"write_timeout"` // 写入超时时间(秒),-1 表示不超时0 表示使用默认值(即 ReadTimeout
PoolTimeout int `json:"pool_timeout" yaml:"pool_timeout"` // 连接池获取连接超时时间0 表示使用默认值(即 ReadTimeout + 1 秒)
IdleTimeout int `json:"idle_timeout" yaml:"idle_timeout"` // 空闲连接超时时间(秒),-1 表示禁用空闲连接超时检查0 表示使用默认值(即 5 分钟)
UseTLS bool `json:"use_tls" yaml:"use_tls"` // 是否使用 TLS
// Deprecated: 应使用 MinIdleConns 代替
MaxIdle int `json:"max_idle" yaml:"max_idle"`
// Deprecated: 应使用 PoolSize 代替
MaxActive int `json:"max_active" yaml:"max_active"`
}
// NewRedis 实例化
func NewRedis(ctx context.Context, opts *RedisOpts) *Redis {
conn := redis.NewUniversalClient(&redis.UniversalOptions{
uniOpt := &redis.UniversalOptions{
Addrs: []string{opts.Host},
DB: opts.Database,
Username: opts.Username,
Password: opts.Password,
IdleTimeout: time.Second * time.Duration(opts.IdleTimeout),
MinIdleConns: opts.MaxIdle,
})
MinIdleConns: opts.MinIdleConns,
PoolSize: opts.PoolSize,
MaxRetries: opts.MaxRetries,
}
// 兼容旧的 MaxIdle 参数,仅在未显式设置 MinIdleConns 时生效
if opts.MaxIdle > 0 && opts.MinIdleConns == 0 {
uniOpt.MinIdleConns = opts.MaxIdle
}
// 兼容旧的 MaxActive 参数,仅在未显式设置 PoolSize 时生效
if opts.MaxActive > 0 && opts.PoolSize == 0 {
uniOpt.PoolSize = opts.MaxActive
}
applyTimeout := func(seconds int, target *time.Duration) {
if seconds > 0 {
*target = time.Duration(seconds) * time.Second
} else if seconds == -1 {
// 当 seconds 为 -1 时,表示禁用超时:按 go-redis 约定,将超时时间设置为负值(如 -1ns代表「无超时」
*target = -1
}
// 当 seconds 为 0 时,使用 go-redis 的默认超时配置:
// 不修改 target保持其零值0由 go-redis 解释为“使用默认值”
}
applyTimeout(opts.DialTimeout, &uniOpt.DialTimeout)
applyTimeout(opts.ReadTimeout, &uniOpt.ReadTimeout)
applyTimeout(opts.WriteTimeout, &uniOpt.WriteTimeout)
applyTimeout(opts.PoolTimeout, &uniOpt.PoolTimeout)
applyTimeout(opts.IdleTimeout, &uniOpt.IdleTimeout)
if opts.UseTLS {
h, _, err := net.SplitHostPort(opts.Host)
if err != nil {
h = opts.Host
}
uniOpt.TLSConfig = &tls.Config{
ServerName: h,
}
}
conn := redis.NewUniversalClient(uniOpt)
return &Redis{ctx: ctx, conn: conn}
}

268
cache/redis_test.go vendored
View File

@@ -6,6 +6,7 @@ import (
"time"
"github.com/alicebob/miniredis/v2"
"github.com/go-redis/redis/v8"
)
func TestRedis(t *testing.T) {
@@ -18,7 +19,16 @@ func TestRedis(t *testing.T) {
timeoutDuration = time.Second
ctx = context.Background()
opts = &RedisOpts{
Host: server.Addr(),
Host: server.Addr(),
Password: "",
Database: 0,
PoolSize: 10,
MinIdleConns: 5,
DialTimeout: 5,
ReadTimeout: 5,
WriteTimeout: 5,
PoolTimeout: 5,
IdleTimeout: 300,
}
redis = NewRedis(ctx, opts)
val = "silenceper"
@@ -44,3 +54,259 @@ func TestRedis(t *testing.T) {
t.Errorf("delete Error , err=%v", err)
}
}
// setupRedisServer 创建并返回一个 miniredis 服务器实例
func setupRedisServer(t *testing.T) *miniredis.Miniredis {
server, err := miniredis.Run()
if err != nil {
t.Fatal("miniredis.Run Error", err)
}
t.Cleanup(server.Close)
return server
}
// TestRedisMaxIdleMapping 测试只设置MaxIdle应该映射到MinIdleConns
func TestRedisMaxIdleMapping(t *testing.T) {
server := setupRedisServer(t)
ctx := context.Background()
opts := &RedisOpts{
Host: server.Addr(),
Database: 0,
MaxIdle: 10,
}
r := NewRedis(ctx, opts)
// 获取底层的 UniversalClient 并断言为 *redis.Client
client, ok := r.conn.(*redis.Client)
if !ok {
t.Fatal("无法转换为 *redis.Client")
}
// 注意MinIdleConns 表示期望的最小空闲连接数,但实际空闲连接数可能不同
// 我们需要通过 Options() 来验证配置是否正确应用
clientOpts := client.Options()
if clientOpts.MinIdleConns != 10 {
t.Errorf("期望 MinIdleConns = 10, 实际 = %d", clientOpts.MinIdleConns)
}
}
// TestRedisMaxActiveMapping 测试只设置MaxActive应该映射到PoolSize
func TestRedisMaxActiveMapping(t *testing.T) {
server := setupRedisServer(t)
ctx := context.Background()
opts := &RedisOpts{
Host: server.Addr(),
Database: 0,
MaxActive: 20,
}
r := NewRedis(ctx, opts)
client, ok := r.conn.(*redis.Client)
if !ok {
t.Fatal("无法转换为 *redis.Client")
}
clientOpts := client.Options()
if clientOpts.PoolSize != 20 {
t.Errorf("期望 PoolSize = 20, 实际 = %d", clientOpts.PoolSize)
}
}
// TestRedisNewFieldsPriority 测试新字段应该优先于旧字段
func TestRedisNewFieldsPriority(t *testing.T) {
server := setupRedisServer(t)
ctx := context.Background()
opts := &RedisOpts{
Host: server.Addr(),
Database: 0,
MaxIdle: 5,
MinIdleConns: 15,
MaxActive: 10,
PoolSize: 30,
}
r := NewRedis(ctx, opts)
client, ok := r.conn.(*redis.Client)
if !ok {
t.Fatal("无法转换为 *redis.Client")
}
clientOpts := client.Options()
if clientOpts.MinIdleConns != 15 {
t.Errorf("期望 MinIdleConns = 15 (新字段优先), 实际 = %d", clientOpts.MinIdleConns)
}
if clientOpts.PoolSize != 30 {
t.Errorf("期望 PoolSize = 30 (新字段优先), 实际 = %d", clientOpts.PoolSize)
}
}
// TestRedisPositiveTimeouts 测试正值超时应该正确应用
func TestRedisPositiveTimeouts(t *testing.T) {
server := setupRedisServer(t)
ctx := context.Background()
opts := &RedisOpts{
Host: server.Addr(),
Database: 0,
DialTimeout: 10,
ReadTimeout: 20,
WriteTimeout: 30,
PoolTimeout: 40,
IdleTimeout: 50,
}
r := NewRedis(ctx, opts)
client, ok := r.conn.(*redis.Client)
if !ok {
t.Fatal("无法转换为 *redis.Client")
}
clientOpts := client.Options()
if clientOpts.DialTimeout != 10*time.Second {
t.Errorf("期望 DialTimeout = 10s, 实际 = %v", clientOpts.DialTimeout)
}
if clientOpts.ReadTimeout != 20*time.Second {
t.Errorf("期望 ReadTimeout = 20s, 实际 = %v", clientOpts.ReadTimeout)
}
if clientOpts.WriteTimeout != 30*time.Second {
t.Errorf("期望 WriteTimeout = 30s, 实际 = %v", clientOpts.WriteTimeout)
}
if clientOpts.PoolTimeout != 40*time.Second {
t.Errorf("期望 PoolTimeout = 40s, 实际 = %v", clientOpts.PoolTimeout)
}
if clientOpts.IdleTimeout != 50*time.Second {
t.Errorf("期望 IdleTimeout = 50s, 实际 = %v", clientOpts.IdleTimeout)
}
}
// TestRedisNegativeTimeouts 测试-1值应该禁用超时
func TestRedisNegativeTimeouts(t *testing.T) {
server := setupRedisServer(t)
ctx := context.Background()
opts := &RedisOpts{
Host: server.Addr(),
Database: 0,
DialTimeout: -1,
ReadTimeout: -1,
WriteTimeout: -1,
PoolTimeout: -1,
IdleTimeout: -1,
}
r := NewRedis(ctx, opts)
client, ok := r.conn.(*redis.Client)
if !ok {
t.Fatal("无法转换为 *redis.Client")
}
clientOpts := client.Options()
// -1 应该被设置为负值表示禁用超时
// DialTimeout, PoolTimeout, IdleTimeout 会被设置为 -1ns
if clientOpts.DialTimeout != -1 {
t.Errorf("期望 DialTimeout = -1ns (禁用), 实际 = %v", clientOpts.DialTimeout)
}
// ReadTimeout 和 WriteTimeout 在 go-redis 中有特殊处理
// 当设置为负值时,会被规范化为 0这也表示无超时
t.Logf("ReadTimeout = %v (设置为-1后的值)", clientOpts.ReadTimeout)
t.Logf("WriteTimeout = %v (设置为-1后的值)", clientOpts.WriteTimeout)
if clientOpts.PoolTimeout != -1 {
t.Errorf("期望 PoolTimeout = -1ns (禁用), 实际 = %v", clientOpts.PoolTimeout)
}
if clientOpts.IdleTimeout != -1 {
t.Errorf("期望 IdleTimeout = -1ns (禁用), 实际 = %v", clientOpts.IdleTimeout)
}
}
// TestRedisZeroTimeouts 测试0值应该使用go-redis默认值
func TestRedisZeroTimeouts(t *testing.T) {
server := setupRedisServer(t)
ctx := context.Background()
opts := &RedisOpts{
Host: server.Addr(),
Database: 0,
DialTimeout: 0,
ReadTimeout: 0,
WriteTimeout: 0,
PoolTimeout: 0,
IdleTimeout: 0,
}
r := NewRedis(ctx, opts)
client, ok := r.conn.(*redis.Client)
if !ok {
t.Fatal("无法转换为 *redis.Client")
}
clientOpts := client.Options()
// 0值应该保持为0由 go-redis 使用默认值
// go-redis 的默认值:
// DialTimeout: 5s
// ReadTimeout: 3s
// WriteTimeout: ReadTimeout
// PoolTimeout: ReadTimeout + 1s
// IdleTimeout: 5min
if clientOpts.DialTimeout == 0 {
t.Error("期望 DialTimeout 使用 go-redis 默认值 (5s), 实际为 0")
}
if clientOpts.ReadTimeout == 0 {
t.Error("期望 ReadTimeout 使用 go-redis 默认值 (3s), 实际为 0")
}
if clientOpts.WriteTimeout == 0 {
t.Error("期望 WriteTimeout 使用 go-redis 默认值 (ReadTimeout), 实际为 0")
}
if clientOpts.PoolTimeout == 0 {
t.Error("期望 PoolTimeout 使用 go-redis 默认值 (ReadTimeout + 1s), 实际为 0")
}
if clientOpts.IdleTimeout == 0 {
t.Error("期望 IdleTimeout 使用 go-redis 默认值 (5min), 实际为 0")
}
}
// TestRedisMixedTimeouts 测试混合超时配置
func TestRedisMixedTimeouts(t *testing.T) {
server := setupRedisServer(t)
ctx := context.Background()
opts := &RedisOpts{
Host: server.Addr(),
Database: 0,
DialTimeout: 5, // 正值
ReadTimeout: -1, // 禁用
WriteTimeout: 0, // 使用默认值
PoolTimeout: 10, // 正值
IdleTimeout: -1, // 禁用
}
r := NewRedis(ctx, opts)
client, ok := r.conn.(*redis.Client)
if !ok {
t.Fatal("无法转换为 *redis.Client")
}
clientOpts := client.Options()
if clientOpts.DialTimeout != 5*time.Second {
t.Errorf("期望 DialTimeout = 5s, 实际 = %v", clientOpts.DialTimeout)
}
// ReadTimeout 设置为 -1会被 go-redis 处理为 0无超时
t.Logf("ReadTimeout = %v (设置为-1后的值)", clientOpts.ReadTimeout)
// WriteTimeout 设置为 0应该使用 go-redis 的默认值
// 默认值通常是 ReadTimeout 的值
t.Logf("WriteTimeout = %v (设置为0后使用的默认值)", clientOpts.WriteTimeout)
if clientOpts.PoolTimeout != 10*time.Second {
t.Errorf("期望 PoolTimeout = 10s, 实际 = %v", clientOpts.PoolTimeout)
}
// IdleTimeout 设置为 -1应该被设置为 -1ns禁用空闲超时
if clientOpts.IdleTimeout != -1 {
t.Errorf("期望 IdleTimeout = -1ns (禁用), 实际 = %v", clientOpts.IdleTimeout)
}
}

View File

@@ -7,6 +7,16 @@ type AccessTokenHandle interface {
GetAccessToken() (accessToken string, err error)
}
// AccessTokenCompatibleHandle 同时实现 AccessTokenHandle 和 AccessTokenContextHandle
type AccessTokenCompatibleHandle struct {
AccessTokenHandle
}
// GetAccessTokenContext 获取access_token,先从cache中获取没有则从服务端获取
func (c AccessTokenCompatibleHandle) GetAccessTokenContext(_ context.Context) (accessToken string, err error) {
return c.GetAccessToken()
}
// AccessTokenContextHandle AccessToken 接口
type AccessTokenContextHandle interface {
AccessTokenHandle

View File

@@ -66,8 +66,11 @@ func (ak *DefaultAccessToken) GetAccessToken() (accessToken string, err error) {
func (ak *DefaultAccessToken) GetAccessTokenContext(ctx context.Context) (accessToken string, err error) {
// 先从cache中取
accessTokenCacheKey := fmt.Sprintf("%s_access_token_%s", ak.cacheKeyPrefix, ak.appID)
if val := ak.cache.Get(accessTokenCacheKey); val != nil {
return val.(string), nil
if accessToken = val.(string); accessToken != "" {
return
}
}
// 加上lock是为了防止在并发获取token时cache刚好失效导致从微信服务器上获取到不同token
@@ -76,7 +79,9 @@ func (ak *DefaultAccessToken) GetAccessTokenContext(ctx context.Context) (access
// 双检,防止重复从微信服务器获取
if val := ak.cache.Get(accessTokenCacheKey); val != nil {
return val.(string), nil
if accessToken = val.(string); accessToken != "" {
return
}
}
// cache失效从微信服务器获取
@@ -85,9 +90,9 @@ func (ak *DefaultAccessToken) GetAccessTokenContext(ctx context.Context) (access
return
}
if err = ak.cache.Set(accessTokenCacheKey, resAccessToken.AccessToken, time.Duration(resAccessToken.ExpiresIn-1500)*time.Second); err != nil {
return
}
expires := resAccessToken.ExpiresIn - 1500
err = ak.cache.Set(accessTokenCacheKey, resAccessToken.AccessToken, time.Duration(expires)*time.Second)
accessToken = resAccessToken.AccessToken
return
}
@@ -96,10 +101,11 @@ func (ak *DefaultAccessToken) GetAccessTokenContext(ctx context.Context) (access
// 不强制更新access_token,可用于不同环境不同服务而不需要分布式锁以及公用缓存避免access_token争抢
// https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-access-token/getStableAccessToken.html
type StableAccessToken struct {
appID string
appSecret string
cacheKeyPrefix string
cache cache.Cache
appID string
appSecret string
cacheKeyPrefix string
cache cache.Cache
accessTokenLock *sync.Mutex
}
// NewStableAccessToken new StableAccessToken
@@ -108,10 +114,11 @@ func NewStableAccessToken(appID, appSecret, cacheKeyPrefix string, cache cache.C
panic("cache is need")
}
return &StableAccessToken{
appID: appID,
appSecret: appSecret,
cache: cache,
cacheKeyPrefix: cacheKeyPrefix,
appID: appID,
appSecret: appSecret,
cache: cache,
cacheKeyPrefix: cacheKeyPrefix,
accessTokenLock: new(sync.Mutex),
}
}
@@ -125,7 +132,20 @@ func (ak *StableAccessToken) GetAccessTokenContext(ctx context.Context) (accessT
// 先从cache中取
accessTokenCacheKey := fmt.Sprintf("%s_stable_access_token_%s", ak.cacheKeyPrefix, ak.appID)
if val := ak.cache.Get(accessTokenCacheKey); val != nil {
return val.(string), nil
if accessToken = val.(string); accessToken != "" {
return
}
}
// 加上lock是为了防止在并发获取token时cache刚好失效导致从微信服务器上获取到不同token
ak.accessTokenLock.Lock()
defer ak.accessTokenLock.Unlock()
// 双检,防止重复从微信服务器获取
if val := ak.cache.Get(accessTokenCacheKey); val != nil {
if accessToken = val.(string); accessToken != "" {
return
}
}
// cache失效从微信服务器获取
@@ -136,7 +156,7 @@ func (ak *StableAccessToken) GetAccessTokenContext(ctx context.Context) (accessT
}
expires := resAccessToken.ExpiresIn - 300
_ = ak.cache.Set(accessTokenCacheKey, resAccessToken.AccessToken, time.Duration(expires)*time.Second)
err = ak.cache.Set(accessTokenCacheKey, resAccessToken.AccessToken, time.Duration(expires)*time.Second)
accessToken = resAccessToken.AccessToken
return
@@ -169,19 +189,27 @@ func (ak *StableAccessToken) GetAccessTokenDirectly(ctx context.Context, forceRe
type WorkAccessToken struct {
CorpID string
CorpSecret string
AgentID string // 可选,用于区分不同应用
cacheKeyPrefix string
cache cache.Cache
accessTokenLock *sync.Mutex
}
// NewWorkAccessToken new WorkAccessToken
func NewWorkAccessToken(corpID, corpSecret, cacheKeyPrefix string, cache cache.Cache) AccessTokenContextHandle {
// NewWorkAccessToken new WorkAccessToken (保持向后兼容)
func NewWorkAccessToken(corpID, corpSecret, agentID, cacheKeyPrefix string, cache cache.Cache) AccessTokenContextHandle {
// 调用新方法,保持兼容性
return NewWorkAccessTokenWithAgentID(corpID, corpSecret, agentID, cacheKeyPrefix, cache)
}
// NewWorkAccessTokenWithAgentID new WorkAccessToken with agentID
func NewWorkAccessTokenWithAgentID(corpID, corpSecret, agentID, cacheKeyPrefix string, cache cache.Cache) AccessTokenContextHandle {
if cache == nil {
panic("cache the not exist")
panic("cache is needed")
}
return &WorkAccessToken{
CorpID: corpID,
CorpSecret: corpSecret,
AgentID: agentID,
cache: cache,
cacheKeyPrefix: cacheKeyPrefix,
accessTokenLock: new(sync.Mutex),
@@ -198,7 +226,18 @@ func (ak *WorkAccessToken) GetAccessTokenContext(ctx context.Context) (accessTok
// 加上lock是为了防止在并发获取token时cache刚好失效导致从微信服务器上获取到不同token
ak.accessTokenLock.Lock()
defer ak.accessTokenLock.Unlock()
accessTokenCacheKey := fmt.Sprintf("%s_access_token_%s", ak.cacheKeyPrefix, ak.CorpID)
// 构建缓存key
var accessTokenCacheKey string
if ak.AgentID != "" {
// 如果设置了AgentID使用新的key格式
accessTokenCacheKey = fmt.Sprintf("%s_access_token_%s_%s", ak.cacheKeyPrefix, ak.CorpID, ak.AgentID)
} else {
// 兼容历史版本的key格式
accessTokenCacheKey = fmt.Sprintf("%s_access_token_%s", ak.cacheKeyPrefix, ak.CorpID)
}
val := ak.cache.Get(accessTokenCacheKey)
if val != nil {
accessToken = val.(string)
@@ -217,6 +256,7 @@ func (ak *WorkAccessToken) GetAccessTokenContext(ctx context.Context) (accessTok
if err != nil {
return
}
accessToken = resAccessToken.AccessToken
return
}

View File

@@ -1,6 +1,7 @@
package credential
import (
context2 "context"
"encoding/json"
"fmt"
"sync"
@@ -42,6 +43,16 @@ type ResTicket struct {
// GetTicket 获取jsapi_ticket
func (js *DefaultJsTicket) GetTicket(accessToken string) (ticketStr string, err error) {
return js.GetTicketContext(context2.Background(), accessToken)
}
// GetTicketFromServer 从服务器中获取ticket
func GetTicketFromServer(accessToken string) (ticket ResTicket, err error) {
return GetTicketFromServerContext(context2.Background(), accessToken)
}
// GetTicketContext 获取jsapi_ticket
func (js *DefaultJsTicket) GetTicketContext(ctx context2.Context, accessToken string) (ticketStr string, err error) {
// 先从cache中取
jsAPITicketCacheKey := fmt.Sprintf("%s_jsapi_ticket_%s", js.cacheKeyPrefix, js.appID)
if val := js.cache.Get(jsAPITicketCacheKey); val != nil {
@@ -57,7 +68,7 @@ func (js *DefaultJsTicket) GetTicket(accessToken string) (ticketStr string, err
}
var ticket ResTicket
ticket, err = GetTicketFromServer(accessToken)
ticket, err = GetTicketFromServerContext(ctx, accessToken)
if err != nil {
return
}
@@ -67,11 +78,11 @@ func (js *DefaultJsTicket) GetTicket(accessToken string) (ticketStr string, err
return
}
// GetTicketFromServer 从服务器中获取ticket
func GetTicketFromServer(accessToken string) (ticket ResTicket, err error) {
// GetTicketFromServerContext 从服务器中获取ticket
func GetTicketFromServerContext(ctx context2.Context, accessToken string) (ticket ResTicket, err error) {
var response []byte
url := fmt.Sprintf(getTicketURL, accessToken)
response, err = util.HTTPGet(url)
response, err = util.HTTPGetContext(ctx, url)
if err != nil {
return
}

View File

@@ -0,0 +1,22 @@
package credential
import (
"context"
"fmt"
"testing"
"github.com/stretchr/testify/assert"
"gopkg.in/h2non/gock.v1"
)
// TestGetTicketFromServerContext 测试 GetTicketFromServerContext 函数
func TestGetTicketFromServerContext(t *testing.T) {
defer gock.Off()
gock.New(fmt.Sprintf(getTicketURL, "arg-ak")).Reply(200).JSON(&ResTicket{Ticket: "mock-ticket", ExpiresIn: 10})
ticket, err := GetTicketFromServerContext(context.Background(), "arg-ak")
assert.Nil(t, err)
assert.Equal(t, int64(0), ticket.ErrCode)
assert.Equal(t, "mock-ticket", ticket.Ticket, "they should be equal")
assert.Equal(t, int64(10), ticket.ExpiresIn, "they should be equal")
}

View File

@@ -1,7 +1,15 @@
package credential
import context2 "context"
// JsTicketHandle js ticket获取
type JsTicketHandle interface {
// GetTicket 获取ticket
GetTicket(accessToken string) (ticket string, err error)
}
// JsTicketContextHandle js ticket获取
type JsTicketContextHandle interface {
JsTicketHandle
GetTicketContext(ctx context2.Context, accessToken string) (ticket string, err error)
}

View File

@@ -0,0 +1,118 @@
package credential
import (
"encoding/json"
"fmt"
"sync"
"time"
"github.com/silenceper/wechat/v2/cache"
"github.com/silenceper/wechat/v2/util"
)
// TicketType ticket类型
type TicketType int
const (
// TicketTypeCorpJs 企业jsapi ticket
TicketTypeCorpJs TicketType = iota
// TicketTypeAgentJs 应用jsapi ticket
TicketTypeAgentJs
)
// 企业微信相关的 ticket URL
const (
// 企业微信 jsapi ticket
getWorkJsTicketURL = "https://qyapi.weixin.qq.com/cgi-bin/get_jsapi_ticket?access_token=%s"
// 企业微信应用 jsapi ticket
getWorkAgentJsTicketURL = "https://qyapi.weixin.qq.com/cgi-bin/ticket/get?access_token=%s&type=agent_config"
)
// WorkJsTicket 企业微信js ticket获取
type WorkJsTicket struct {
corpID string
agentID string
cacheKeyPrefix string
cache cache.Cache
jsAPITicketLock *sync.Mutex
}
// NewWorkJsTicket new WorkJsTicket
func NewWorkJsTicket(corpID, agentID, cacheKeyPrefix string, cache cache.Cache) *WorkJsTicket {
return &WorkJsTicket{
corpID: corpID,
agentID: agentID,
cache: cache,
cacheKeyPrefix: cacheKeyPrefix,
jsAPITicketLock: new(sync.Mutex),
}
}
// GetTicket 根据类型获取相应的jsapi_ticket
func (js *WorkJsTicket) GetTicket(accessToken string, ticketType TicketType) (ticketStr string, err error) {
var cacheKey string
switch ticketType {
case TicketTypeCorpJs:
cacheKey = fmt.Sprintf("%s_corp_jsapi_ticket_%s", js.cacheKeyPrefix, js.corpID)
case TicketTypeAgentJs:
if js.agentID == "" {
err = fmt.Errorf("agentID is empty")
return
}
cacheKey = fmt.Sprintf("%s_agent_jsapi_ticket_%s_%s", js.cacheKeyPrefix, js.corpID, js.agentID)
default:
err = fmt.Errorf("unsupported ticket type: %v", ticketType)
return
}
if val := js.cache.Get(cacheKey); val != nil {
return val.(string), nil
}
js.jsAPITicketLock.Lock()
defer js.jsAPITicketLock.Unlock()
// 双检,防止重复从微信服务器获取
if val := js.cache.Get(cacheKey); val != nil {
return val.(string), nil
}
var ticket ResTicket
ticket, err = js.getTicketFromServer(accessToken, ticketType)
if err != nil {
return
}
expires := ticket.ExpiresIn - 1500
err = js.cache.Set(cacheKey, ticket.Ticket, time.Duration(expires)*time.Second)
ticketStr = ticket.Ticket
return
}
// getTicketFromServer 从服务器中获取ticket
func (js *WorkJsTicket) getTicketFromServer(accessToken string, ticketType TicketType) (ticket ResTicket, err error) {
var url string
switch ticketType {
case TicketTypeCorpJs:
url = fmt.Sprintf(getWorkJsTicketURL, accessToken)
case TicketTypeAgentJs:
url = fmt.Sprintf(getWorkAgentJsTicketURL, accessToken)
default:
err = fmt.Errorf("unsupported ticket type: %v", ticketType)
return
}
var response []byte
response, err = util.HTTPGet(url)
if err != nil {
return
}
err = json.Unmarshal(response, &ticket)
if err != nil {
return
}
if ticket.ErrCode != 0 {
err = fmt.Errorf("getTicket Error : errcode=%d , errmsg=%s", ticket.ErrCode, ticket.ErrMsg)
return
}
return
}

View File

@@ -90,10 +90,12 @@ host: https://qyapi.weixin.qq.com/
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 |
|:---------:|------|:----------------------------------------| ---------- | ------------------------------- |----------|
| 获取子部门ID列表 | GET | /cgi-bin/department/simplelist | YES | (r *Client) DepartmentSimpleList| MARKWANG |
| 获取部门列表 | GET | /cgi-bin/department/list | YES | (r *Client) DepartmentList| just5325, ourines |
| 获取部门成员 | GET | /cgi-bin/user/simplelist | YES | (r *Client) UserSimpleList | MARKWANG |
| 获取成员ID列表 | Post | /cgi-bin/user/list_id | YES | (r *Client) UserListId | MARKWANG |
## 素材管理
[官方文档](https://developer.work.weixin.qq.com/document/path/91054)
@@ -116,5 +118,14 @@ host: https://qyapi.weixin.qq.com/
| ---------------- | -------- | --------------------- | ---------- | -------------------------- | -------- |
| 群机器人发送消息 | POST | /cgi-bin/webhook/send | YES | (r *Client) RobotBroadcast | chcthink |
## 打卡
[官方文档](https://developer.work.weixin.qq.com/document/path/96497)
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 |
|----------| -------- | --------------------- | ---------- | -------------------------- |---------|
| 获取打卡日报数据 | POST | /cgi-bin/checkin/getcheckin_daydata | YES | (r *Client) GetDayData | Thinker |
| 获取打卡月报数据 | POST | /cgi-bin/checkin/getcheckin_monthdata | YES | (r *Client) GetMonthData | Thinker |
## 应用管理
TODO

View File

@@ -2,12 +2,12 @@ package openapi
import "github.com/silenceper/wechat/v2/util"
// GetAPIQuotaParams 查询API调用额度参数
// GetAPIQuotaParams 查询 API 调用额度参数
type GetAPIQuotaParams struct {
CgiPath string `json:"cgi_path"` // api的请求地址例如"/cgi-bin/message/custom/send";不要前缀“https://api.weixin.qq.com” ,也不要漏了"/",否则都会76003的报错
CgiPath string `json:"cgi_path"` // api 的请求地址,例如"/cgi-bin/message/custom/send";不要前缀“https://api.weixin.qq.com” ,也不要漏了"/",否则都会 76003 的报错
}
// APIQuota API调用额度
// APIQuota API 调用额度
type APIQuota struct {
util.CommonError
Quota struct {
@@ -17,20 +17,20 @@ type APIQuota struct {
} `json:"quota"` // 详情
}
// GetRidInfoParams 查询rid信息参数
// GetRidInfoParams 查询 rid 信息参数
type GetRidInfoParams struct {
Rid string `json:"rid"` // 调用接口报错返回的rid
Rid string `json:"rid"` // 调用接口报错返回的 rid
}
// RidInfo rid信息
// RidInfo rid 信息
type RidInfo struct {
util.CommonError
Request struct {
InvokeTime int64 `json:"invoke_time"` // 发起请求的时间戳
CostInMs int64 `json:"cost_in_ms"` // 请求毫秒级耗时
RequestURL string `json:"request_url"` // 请求的URL参数
RequestBody string `json:"request_body"` // post请求的请求参数
RequestURL string `json:"request_url"` // 请求的 URL 参数
RequestBody string `json:"request_body"` // post 请求的请求参数
ResponseBody string `json:"response_body"` // 接口请求返回参数
ClientIP string `json:"client_ip"` // 接口请求的客户端ip
} `json:"request"` // 该rid对应的请求详情
ClientIP string `json:"client_ip"` // 接口请求的客户端 ip
} `json:"request"` // 该 rid 对应的请求详情
}

View File

@@ -30,6 +30,8 @@ const (
getAnalysisVisitDistributionURL = "https://api.weixin.qq.com/datacube/getweanalysisappidvisitdistribution?access_token=%s"
// 访问页面
getAnalysisVisitPageURL = "https://api.weixin.qq.com/datacube/getweanalysisappidvisitpage?access_token=%s"
// 获取小程序性能数据
getPerformanceDataURL = "https://api.weixin.qq.com/wxa/business/performance/boot?access_token=%s"
)
// Analysis analyis 数据分析
@@ -315,3 +317,67 @@ func (analysis *Analysis) GetAnalysisVisitPage(beginDate, endDate string) (resul
}
return
}
// GetPerformanceDataRequest 获取小程序性能数据请求
type GetPerformanceDataRequest struct {
Module string `json:"module"`
Time PerformanceDataTime `json:"time"`
Params []PerformanceDataParams `json:"params"`
}
// PerformanceDataTime 获取小程序性能数据开始和结束日期
type PerformanceDataTime struct {
BeginTimestamp int64 `json:"begin_timestamp"`
EndTimestamp int64 `json:"end_timestamp"`
}
// PerformanceDataParams 获取小程序性能数据查询条件
type PerformanceDataParams struct {
Field string `json:"field"`
Value string `json:"value"`
}
// GetPerformanceDataResponse 获取小程序性能数据响应
type GetPerformanceDataResponse struct {
util.CommonError
Body PerformanceDataBody `json:"body"`
}
// PerformanceDataBody 性能数据
type PerformanceDataBody struct {
Tables []PerformanceDataTable `json:"tables"`
Count int64 `json:"count"`
}
// PerformanceDataTable 数据数组
type PerformanceDataTable struct {
ID string `json:"id"`
Lines []PerformanceDataTableLine `json:"lines"`
Zh string `json:"zh"`
}
// PerformanceDataTableLine 按时间排列的性能数据
type PerformanceDataTableLine struct {
Fields []PerformanceDataTableLineField `json:"fields"`
}
// PerformanceDataTableLineField 单天的性能数据
type PerformanceDataTableLineField struct {
RefDate string `json:"refdate"`
Value string `json:"value"`
}
// GetPerformanceData 获取小程序性能数据
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/data-analysis/others/getPerformanceData.html
func (analysis *Analysis) GetPerformanceData(req *GetPerformanceDataRequest) (res GetPerformanceDataResponse, err error) {
var accessToken string
if accessToken, err = analysis.GetAccessToken(); err != nil {
return
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(getPerformanceDataURL, accessToken), req); err != nil {
return
}
err = util.DecodeWithError(response, &res, "GetPerformanceData")
return
}

View File

@@ -10,13 +10,22 @@ import (
)
const (
// code2SessionURL 小程序登录
code2SessionURL = "https://api.weixin.qq.com/sns/jscode2session?appid=%s&secret=%s&js_code=%s&grant_type=authorization_code"
// checkEncryptedDataURL 检查加密信息
checkEncryptedDataURL = "https://api.weixin.qq.com/wxa/business/checkencryptedmsg?access_token=%s"
// getPhoneNumber 获取手机号
getPhoneNumber = "https://api.weixin.qq.com/wxa/business/getuserphonenumber?access_token=%s"
checkSessionURL = "https://api.weixin.qq.com/wxa/checksession?access_token=%s&openid=%s&signature=%s&sig_method=hmac_sha256"
// checkSessionURL 检验登录态
checkSessionURL = "https://api.weixin.qq.com/wxa/checksession?access_token=%s&signature=%s&openid=%s&sig_method=hmac_sha256"
// resetUserSessionKeyURL 重置登录态
resetUserSessionKeyURL = "https://api.weixin.qq.com/wxa/resetusersessionkey?access_token=%s&signature=%s&openid=%s&sig_method=hmac_sha256"
// getPluginOpenPIDURL 获取插件用户openPID
getPluginOpenPIDURL = "https://api.weixin.qq.com/wxa/getpluginopenpid?access_token=%s"
// getPaidUnionIDURL 支付后获取 UnionID
getPaidUnionIDURL = "https://api.weixin.qq.com/wxa/getpaidunionid"
// getUserEncryptKeyURL 获取用户encryptKey
getUserEncryptKeyURL = "https://api.weixin.qq.com/wxa/business/getuserencryptkey?access_token=%s&signature=%s&openid=%s&sig_method=hmac_sha256"
)
// Auth 登录/用户信息
@@ -35,7 +44,7 @@ type ResCode2Session struct {
OpenID string `json:"openid"` // 用户唯一标识
SessionKey string `json:"session_key"` // 会话密钥
UnionID string `json:"unionid"` // 用户在开放平台的唯一标识符,在满足 UnionID 下发条件的情况下会返回
UnionID string `json:"unionid"` // 用户在开放平台的唯一标识符在满足UnionID下发条件的情况下会返回
}
// RspCheckEncryptedData .
@@ -67,27 +76,63 @@ func (auth *Auth) Code2SessionContext(ctx context2.Context, jsCode string) (resu
return
}
type (
// GetPaidUnionIDRequest 支付后获取UnionID请求
GetPaidUnionIDRequest struct {
OpenID string `json:"openid"`
TransactionID string `json:"transaction_id,omitempty"`
MchID string `json:"mch_id,omitempty"`
OutTradeNo string `json:"out_trade_no,omitempty"`
}
// GetPaidUnionIDResponse 支付后获取UnionID响应
GetPaidUnionIDResponse struct {
util.CommonError
UnionID string `json:"unionid"`
}
)
// GetPaidUnionID 用户支付完成后,获取该用户的 UnionId无需用户授权
func (auth *Auth) GetPaidUnionID() {
// TODO
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-info/basic-info/getPaidUnionid.html
func (auth *Auth) GetPaidUnionID(req *GetPaidUnionIDRequest) (string, error) {
var (
accessToken string
err error
)
if accessToken, err = auth.GetAccessToken(); err != nil {
return "", err
}
var url string
if req.TransactionID != "" {
url = fmt.Sprintf("%s?access_token=%s&openid=%s&transaction_id=%s", getPaidUnionIDURL, accessToken, req.OpenID, req.TransactionID)
} else {
url = fmt.Sprintf("%s?access_token=%s&openid=%s&mch_id=%s&out_trade_no=%s", getPaidUnionIDURL, accessToken, req.OpenID, req.MchID, req.OutTradeNo)
}
var response []byte
if response, err = util.HTTPGet(url); err != nil {
return "", err
}
result := &GetPaidUnionIDResponse{}
err = util.DecodeWithError(response, result, "GetPaidUnionID")
return result.UnionID, err
}
// CheckEncryptedData .检查加密信息是否由微信生成(当前只支持手机号加密数据),只能检测最近 3 天生成的加密数据
// CheckEncryptedData .检查加密信息是否由微信生成(当前只支持手机号加密数据),只能检测最近3天生成的加密数据
func (auth *Auth) CheckEncryptedData(encryptedMsgHash string) (result RspCheckEncryptedData, err error) {
return auth.CheckEncryptedDataContext(context2.Background(), encryptedMsgHash)
}
// CheckEncryptedDataContext .检查加密信息是否由微信生成(当前只支持手机号加密数据),只能检测最近 3 天生成的加密数据
// 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 {
if at, err = auth.GetAccessTokenContext(ctx); err != nil {
return
}
// 由于 GetPhoneNumberContext 需要传入 JSON所以 HTTPPostContext 入参改为 []byte
// 由于GetPhoneNumberContext需要传入JSON所以HTTPPostContext入参改为[]byte
if response, err = util.HTTPPostContext(ctx, fmt.Sprintf(checkEncryptedDataURL, at), []byte("encrypted_msg_hash="+encryptedMsgHash), nil); err != nil {
return
}
@@ -115,62 +160,148 @@ type PhoneInfo struct {
} `json:"watermark"` // 数据水印
}
// GetPhoneNumberContext 小程序通过 code 获取用户手机号
func (auth *Auth) GetPhoneNumberContext(ctx context2.Context, code string) (result *GetPhoneNumberResponse, err error) {
var accessToken string
if accessToken, err = auth.GetAccessToken(); err != nil {
// GetPhoneNumberContext 小程序通过code获取用户手机号
func (auth *Auth) GetPhoneNumberContext(ctx context2.Context, code string) (*GetPhoneNumberResponse, error) {
var response []byte
var (
at string
err error
)
if at, err = auth.GetAccessTokenContext(ctx); err != nil {
return nil, err
}
bodyBytes, err := json.Marshal(map[string]interface{}{
body := map[string]interface{}{
"code": code,
})
}
bodyBytes, err := json.Marshal(body)
if err != nil {
return nil, err
}
var (
header = map[string]string{"Content-Type": "application/json;charset=utf-8"}
response []byte
)
if response, err = util.HTTPPostContext(ctx, fmt.Sprintf(getPhoneNumber, accessToken), bodyBytes, header); err != nil {
header := map[string]string{"Content-Type": "application/json;charset=utf-8"}
if response, err = util.HTTPPostContext(ctx, fmt.Sprintf(getPhoneNumber, at), bodyBytes, header); err != nil {
return nil, err
}
var result GetPhoneNumberResponse
err = util.DecodeWithError(response, &result, "phonenumber.getPhoneNumber")
return
return &result, err
}
// GetPhoneNumber 小程序通过 code 获取用户手机号
// GetPhoneNumber 小程序通过code获取用户手机号
func (auth *Auth) GetPhoneNumber(code string) (*GetPhoneNumberResponse, error) {
return auth.GetPhoneNumberContext(context2.Background(), code)
}
// // CheckSession 检验登录态是否过期。
// func (auth *Auth) CheckSession(sessionKey, openID string) (result *CheckSessionResponse, err error) {
// return auth.CheckSessionContext(context2.Background(), sessionKey, openID)
// }
//
// // CheckSessionContext 检验登录态是否过期。
// func (auth *Auth) CheckSessionContext(ctx context2.Context, sessionKey, openID string) (result *CheckSessionResponse, err error) {
// var accessToken string
// if accessToken, err = auth.GetAccessToken(); err != nil {
// return nil, err
// }
// var (
// response []byte
// signature string = sessionKey
// )
// if response, err = util.HTTPGetContext(ctx, fmt.Sprintf(checkSessionURL, accessToken, openID, signature)); err != nil {
// return nil, err
// }
//
// err = util.DecodeWithError(response, &result, "CheckSessionContext")
// return
// }
//
// // CheckSessionResponse 检验登录态是否过期。
// type CheckSessionResponse struct {
// util.CommonError
// }
// CheckSession 检验登录态
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-login/checkSessionKey.html
func (auth *Auth) CheckSession(signature, openID string) error {
var (
accessToken string
err error
)
if accessToken, err = auth.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(checkSessionURL, accessToken, signature, openID)); err != nil {
return err
}
return util.DecodeWithCommonError(response, "CheckSession")
}
// ResetUserSessionKeyResponse 重置登录态响应
type ResetUserSessionKeyResponse struct {
util.CommonError
OpenID string `json:"openid"`
SessionKey string `json:"session_key"`
}
// ResetUserSessionKey 重置登录态
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-login/ResetUserSessionKey.html
func (auth *Auth) ResetUserSessionKey(signature, openID string) (*ResetUserSessionKeyResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = auth.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(resetUserSessionKeyURL, accessToken, signature, openID)); err != nil {
return nil, err
}
result := &ResetUserSessionKeyResponse{}
err = util.DecodeWithError(response, result, "ResetUserSessionKey")
return result, err
}
type (
// GetPluginOpenPIDRequest 获取插件用户openPID请求
GetPluginOpenPIDRequest struct {
Code string `json:"code"`
}
// GetPluginOpenPIDResponse 获取插件用户openPID响应
GetPluginOpenPIDResponse struct {
util.CommonError
OpenPID string `json:"openpid"`
}
)
// GetPluginOpenPID 获取插件用户openPID
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-info/basic-info/getPluginOpenPId.html
func (auth *Auth) GetPluginOpenPID(code string) (string, error) {
var (
accessToken string
err error
)
if accessToken, err = auth.GetAccessToken(); err != nil {
return "", err
}
req := &GetPluginOpenPIDRequest{
Code: code,
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(getPluginOpenPIDURL, accessToken), req); err != nil {
return "", err
}
result := &GetPluginOpenPIDResponse{}
err = util.DecodeWithError(response, result, "GetPluginOpenPID")
return result.OpenPID, err
}
// GetUserEncryptKeyResponse 获取用户encryptKey响应
type GetUserEncryptKeyResponse struct {
util.CommonError
KeyInfoList []KeyInfo `json:"key_info_list"`
}
// KeyInfo 用户最近三次的加密key
type KeyInfo struct {
EncryptKey string `json:"encrypt_key"`
Version int64 `json:"version"`
ExpireIn int64 `json:"expire_in"`
Iv string `json:"iv"`
CreateTime int64 `json:"create_time"`
}
// GetUserEncryptKey 获取用户encryptKey
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-info/internet/getUserEncryptKey.html
func (auth *Auth) GetUserEncryptKey(signature, openID string) (*GetUserEncryptKeyResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = auth.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(getUserEncryptKeyURL, accessToken, signature, openID)); err != nil {
return nil, err
}
result := &GetUserEncryptKeyResponse{}
err = util.DecodeWithError(response, result, "GetUserEncryptKey")
return result, err
}

View File

@@ -1,6 +1,7 @@
package business
import (
"context"
"fmt"
"github.com/silenceper/wechat/v2/util"
@@ -28,13 +29,18 @@ type PhoneInfo struct {
// GetPhoneNumber code换取用户手机号。 每个code只能使用一次code的有效期为5min
func (business *Business) GetPhoneNumber(in *GetPhoneNumberRequest) (info PhoneInfo, err error) {
accessToken, err := business.GetAccessToken()
return business.GetPhoneNumberWithContext(context.Background(), in)
}
// GetPhoneNumberWithContext 利用context将code换取用户手机号。 每个code只能使用一次code的有效期为5min
func (business *Business) GetPhoneNumberWithContext(ctx context.Context, in *GetPhoneNumberRequest) (info PhoneInfo, err error) {
accessToken, err := business.GetAccessTokenContext(ctx)
if err != nil {
return
}
uri := fmt.Sprintf(getPhoneNumberURL, accessToken)
response, err := util.PostJSON(uri, in)
response, err := util.PostJSONContext(ctx, uri, in)
if err != nil {
return
}
@@ -45,10 +51,5 @@ func (business *Business) GetPhoneNumber(in *GetPhoneNumberRequest) (info PhoneI
PhoneInfo PhoneInfo `json:"phone_info"`
}
err = util.DecodeWithError(response, &resp, "business.GetPhoneNumber")
if nil != err {
return
}
info = resp.PhoneInfo
return
return resp.PhoneInfo, err
}

View File

@@ -14,4 +14,5 @@ type Config struct {
Token string `json:"token"` // token
EncodingAESKey string `json:"encoding_aes_key"` // EncodingAESKey
Cache cache.Cache
UseStableAK bool // use the stable access_token
}

View File

@@ -8,5 +8,5 @@ import (
// Context struct
type Context struct {
*config.Config
credential.AccessTokenHandle
credential.AccessTokenContextHandle
}

View File

@@ -0,0 +1,295 @@
package express
import (
"context"
"fmt"
"github.com/silenceper/wechat/v2/util"
)
const (
// 传运单接口,商户使用此接口向微信提供某交易单号对应的运单号。微信后台会跟踪运单的状态变化
openMsgTraceWaybillURL = "https://api.weixin.qq.com/cgi-bin/express/delivery/open_msg/trace_waybill?access_token=%s"
// 查询运单接口商户在调用完trace_waybill接口后可以使用本接口查询到对应运单的详情信息
openMsgQueryTraceURL = "https://api.weixin.qq.com/cgi-bin/express/delivery/open_msg/query_trace?access_token=%s"
// 更新物流信息,更新物品信息
openMsgUpdateWaybillGoodsURL = "https://api.weixin.qq.com/cgi-bin/express/delivery/open_msg/update_waybill_goods?access_token=%s"
// 传运单接口,商户使用此接口向微信提供某交易单号对应的运单号。微信后台会跟踪运单的状态变化,在关键物流节点给下单用户推送消息通知
openMsgFollowWaybillURL = "https://api.weixin.qq.com/cgi-bin/express/delivery/open_msg/follow_waybill?access_token=%s"
// 查运单接口商户在调用完follow_waybill接口后可以使用本接口查询到对应运单的详情信息
openMsgQueryFollowTraceURL = "https://api.weixin.qq.com/cgi-bin/express/delivery/open_msg/query_follow_trace?access_token=%s"
// 更新物品信息接口
openMsgUpdateFollowWaybillGoodsURL = "https://api.weixin.qq.com/cgi-bin/express/delivery/open_msg/update_follow_waybill_goods?access_token=%s"
// 获取运力id列表
openMsgGetDeliveryListURL = "https://api.weixin.qq.com/cgi-bin/express/delivery/open_msg/get_delivery_list?access_token=%s"
)
// TraceWaybill 传运单
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/express_search.html#_2-%E6%8E%A5%E5%8F%A3%E5%88%97%E8%A1%A8
func (express *Express) TraceWaybill(ctx context.Context, in *TraceWaybillRequest) (res TraceWaybillResponse, err error) {
accessToken, err := express.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(openMsgTraceWaybillURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, in)
if err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &res, "TraceWaybill")
return
}
// QueryTrace 查询运单详情信息
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/express_search.html#_2-%E6%8E%A5%E5%8F%A3%E5%88%97%E8%A1%A8
func (express *Express) QueryTrace(ctx context.Context, in *QueryTraceRequest) (res QueryTraceResponse, err error) {
accessToken, err := express.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(openMsgQueryTraceURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, in)
if err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &res, "QueryTrace")
return
}
// UpdateWaybillGoods 更新物品信息
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/express_search.html#_2-%E6%8E%A5%E5%8F%A3%E5%88%97%E8%A1%A8
func (express *Express) UpdateWaybillGoods(ctx context.Context, in *UpdateWaybillGoodsRequest) (err error) {
accessToken, err := express.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(openMsgUpdateWaybillGoodsURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, in)
if err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithCommonError(response, "UpdateWaybillGoods")
return
}
// FollowWaybill 传运单
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/express_open_msg.html#_4-1%E3%80%81%E4%BC%A0%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3-follow-waybill
func (express *Express) FollowWaybill(ctx context.Context, in *FollowWaybillRequest) (res FollowWaybillResponse, err error) {
accessToken, err := express.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(openMsgFollowWaybillURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, in)
if err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &res, "FollowWaybill")
return
}
// QueryFollowTrace 查询运单详情信息
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/express_open_msg.html#_4-2%E3%80%81%E6%9F%A5%E8%BF%90%E5%8D%95%E6%8E%A5%E5%8F%A3-query-follow-trace
func (express *Express) QueryFollowTrace(ctx context.Context, in *QueryFollowTraceRequest) (res QueryFollowTraceResponse, err error) {
accessToken, err := express.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(openMsgQueryFollowTraceURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, in)
if err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &res, "QueryFollowTrace")
return
}
// UpdateFollowWaybillGoods 更新物品信息
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/express_open_msg.html#_4-3%E3%80%81%E6%9B%B4%E6%96%B0%E7%89%A9%E5%93%81%E4%BF%A1%E6%81%AF%E6%8E%A5%E5%8F%A3-update-follow-waybill-goods
func (express *Express) UpdateFollowWaybillGoods(ctx context.Context, in *UpdateFollowWaybillGoodsRequest) (err error) {
accessToken, err := express.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(openMsgUpdateFollowWaybillGoodsURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, in)
if err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithCommonError(response, "UpdateFollowWaybillGoods")
return
}
// GetDeliveryList 获取运力id列表
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/express_open_msg.html#_4-4%E8%8E%B7%E5%8F%96%E8%BF%90%E5%8A%9Bid%E5%88%97%E8%A1%A8get-delivery-list
func (express *Express) GetDeliveryList(ctx context.Context) (res GetDeliveryListResponse, err error) {
accessToken, err := express.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(openMsgGetDeliveryListURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, map[string]interface{}{})
if err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &res, "GetDeliveryList")
return
}
// TraceWaybillRequest 传运单接口请求参数
type TraceWaybillRequest struct {
GoodsInfo FollowWaybillGoodsInfo `json:"goods_info"` // 必选,商品信息
Openid string `json:"openid"` // 必选用户openid
SenderPhone string `json:"sender_phone"` // 寄件人手机号
ReceiverPhone string `json:"receiver_phone"` // 必选,收件人手机号,部分运力需要用户手机号作为查单依据
DeliveryID string `json:"delivery_id"` // 运力id运单号所属运力公司id
WaybillID string `json:"waybill_id"` // 必选,运单号
TransID string `json:"trans_id"` // 必选交易单号微信支付生成的交易单号一般以420开头
OrderDetailPath string `json:"order_detail_path"` // 订单详情页地址
}
// TraceWaybillResponse 传运单接口返回参数
type TraceWaybillResponse struct {
util.CommonError
WaybillToken string `json:"waybill_token"` // 查询id
}
// QueryTraceRequest 查询运单详情接口请求参数
type QueryTraceRequest struct {
WaybillToken string `json:"waybill_token"` // 必选查询id
}
// QueryTraceResponse 查询运单详情接口返回参数
type QueryTraceResponse struct {
util.CommonError
WaybillInfo FlowWaybillInfo `json:"waybill_info"` // 运单信息
ShopInfo FollowWaybillShopInfo `json:"shop_info"` // 商品信息
DeliveryInfo FlowWaybillDeliveryInfo `json:"delivery_info"` // 运力信息
}
// UpdateWaybillGoodsRequest 更新物品信息接口请求参数
type UpdateWaybillGoodsRequest struct {
WaybillToken string `json:"waybill_token"` // 必选查询id
GoodsInfo FollowWaybillGoodsInfo `json:"goods_info"` // 必选,商品信息
}
// FollowWaybillRequest 传运单接口请求参数
type FollowWaybillRequest struct {
GoodsInfo FollowWaybillGoodsInfo `json:"goods_info"` // 必选,商品信息
Openid string `json:"openid"` // 必选用户openid
SenderPhone string `json:"sender_phone"` // 寄件人手机号
ReceiverPhone string `json:"receiver_phone"` // 必选,收件人手机号,部分运力需要用户手机号作为查单依据
DeliveryID string `json:"delivery_id"` // 运力id运单号所属运力公司id
WaybillID string `json:"waybill_id"` // 必选,运单号
TransID string `json:"trans_id"` // 必选交易单号微信支付生成的交易单号一般以420开头
OrderDetailPath string `json:"order_detail_path"` // 订单详情页地址
}
// FollowWaybillGoodsInfo 商品信息
type FollowWaybillGoodsInfo struct {
DetailList []FollowWaybillGoodsInfoItem `json:"detail_list"`
}
// FollowWaybillShopInfo 商品信息
type FollowWaybillShopInfo struct {
GoodsInfo FollowWaybillGoodsInfo `json:"goods_info"` // 商品信息
}
// FollowWaybillGoodsInfoItem 商品信息详情
type FollowWaybillGoodsInfoItem struct {
GoodsName string `json:"goods_name"` // 必选,商品名称(最大长度为utf-8编码下的60个字符
GoodsImgURL string `json:"goods_img_url"` // 必选商品图片url
GoodsDesc string `json:"goods_desc,omitempty"` // 商品详情描述不传默认取“商品名称”值最多40汉字
}
// FollowWaybillResponse 传运单接口返回参数
type FollowWaybillResponse struct {
util.CommonError
WaybillToken string `json:"waybill_token"` // 查询id
}
// QueryFollowTraceRequest 查询运单详情信息请求参数
type QueryFollowTraceRequest struct {
WaybillToken string `json:"waybill_token"` // 必选查询id
}
// QueryFollowTraceResponse 查询运单详情信息返回参数
type QueryFollowTraceResponse struct {
util.CommonError
WaybillInfo FlowWaybillInfo `json:"waybill_info"` // 运单信息
ShopInfo FollowWaybillShopInfo `json:"shop_info"` // 商品信息
DeliveryInfo FlowWaybillDeliveryInfo `json:"delivery_info"` // 运力信息
}
// FlowWaybillInfo 运单信息
type FlowWaybillInfo struct {
WaybillID string `json:"waybill_id"` // 运单号
Status WaybillStatus `json:"status"` // 运单状态
}
// UpdateFollowWaybillGoodsRequest 修改运单商品信息请求参数
type UpdateFollowWaybillGoodsRequest struct {
WaybillToken string `json:"waybill_token"` // 必选查询id
GoodsInfo FollowWaybillGoodsInfo `json:"goods_info"` // 必选,商品信息
}
// GetDeliveryListResponse 获取运力id列表返回参数
type GetDeliveryListResponse struct {
util.CommonError
DeliveryList []FlowWaybillDeliveryInfo `json:"delivery_list"` // 运力公司列表
Count int `json:"count"` // 运力公司个数
}
// FlowWaybillDeliveryInfo 运力公司信息
type FlowWaybillDeliveryInfo struct {
DeliveryID string `json:"delivery_id"` // 运力公司id
DeliveryName string `json:"delivery_name"` // 运力公司名称
}
// WaybillStatus 运单状态
type WaybillStatus int
const (
// WaybillStatusNotExist 运单不存在或者未揽收
WaybillStatusNotExist WaybillStatus = iota
// WaybillStatusPicked 已揽件
WaybillStatusPicked
// WaybillStatusTransporting 运输中
WaybillStatusTransporting
// WaybillStatusDispatching 派件中
WaybillStatusDispatching
// WaybillStatusSigned 已签收
WaybillStatusSigned
// WaybillStatusException 异常
WaybillStatusException
// WaybillStatusSignedByOthers 代签收
WaybillStatusSignedByOthers
)

View File

@@ -0,0 +1,16 @@
package express
import (
"github.com/silenceper/wechat/v2/miniprogram/context"
)
// Express 微信物流服务
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/introduction.html
type Express struct {
*context.Context
}
// NewExpress init
func NewExpress(ctx *context.Context) *Express {
return &Express{ctx}
}

View File

@@ -0,0 +1,618 @@
package express
import (
"context"
"fmt"
"github.com/silenceper/wechat/v2/util"
)
// 同城配送 API URL
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/intracity_service.html
const (
// 开通门店权限
intracityApplyURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/apply?access_token=%s"
// 创建门店
intracityCreateStoreURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/createstore?access_token=%s"
// 查询门店
intracityQueryStoreURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/querystore?access_token=%s"
// 更新门店
intracityUpdateStoreURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/updatestore?access_token=%s"
// 门店运费充值
intracityStoreChargeURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/storecharge?access_token=%s"
// 门店运费退款
intracityStoreRefundURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/storerefund?access_token=%s"
// 门店运费流水查询
intracityQueryFlowURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/queryflow?access_token=%s"
// 门店余额查询
intracityBalanceQueryURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/balancequery?access_token=%s"
// 预下配送单(查询运费)
intracityPreAddOrderURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/preaddorder?access_token=%s"
// 创建配送单
intracityAddOrderURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/addorder?access_token=%s"
// 查询配送单
intracityQueryOrderURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/queryorder?access_token=%s"
// 取消配送单
intracityCancelOrderURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/cancelorder?access_token=%s"
// 模拟配送回调(仅用于测试)
intracityMockNotifyURL = "https://api.weixin.qq.com/cgi-bin/express/intracity/mocknotify?access_token=%s"
)
// PayMode 充值/扣费主体
type PayMode string
const (
// PayModeStore 门店
PayModeStore PayMode = "PAY_MODE_STORE"
// PayModeApp 小程序
PayModeApp PayMode = "PAY_MODE_APP"
// PayModeComponent 服务商
PayModeComponent PayMode = "PAY_MODE_COMPONENT"
)
// OrderPattern 运力偏好
type OrderPattern uint32
const (
// OrderPatternPriceFirst 价格优先
OrderPatternPriceFirst OrderPattern = 1
// OrderPatternTransFirst 运力优先
OrderPatternTransFirst OrderPattern = 2
)
// FlowType 流水类型
type FlowType uint32
const (
// FlowTypeCharge 充值流水
FlowTypeCharge FlowType = 1
// FlowTypeConsume 消费流水
FlowTypeConsume FlowType = 2
// FlowTypeRefund 退款流水
FlowTypeRefund FlowType = 3
)
// IntracityDeliveryStatus 配送单状态
type IntracityDeliveryStatus int32
const (
// IntracityDeliveryStatusReady 配送单待接单
IntracityDeliveryStatusReady IntracityDeliveryStatus = 100
// IntracityDeliveryStatusPickedUp 配送单待取货
IntracityDeliveryStatusPickedUp IntracityDeliveryStatus = 101
// IntracityDeliveryStatusOngoing 配送单配送中
IntracityDeliveryStatusOngoing IntracityDeliveryStatus = 102
// IntracityDeliveryStatusFinished 配送单已送达
IntracityDeliveryStatusFinished IntracityDeliveryStatus = 200
// IntracityDeliveryStatusCancelled 配送单已取消
IntracityDeliveryStatusCancelled IntracityDeliveryStatus = 300
// IntracityDeliveryStatusAbnormal 配送单异常
IntracityDeliveryStatusAbnormal IntracityDeliveryStatus = 400
)
// IntracityAddressInfo 门店地址信息
type IntracityAddressInfo struct {
Province string `json:"province"` // 省/自治区/直辖市
City string `json:"city"` // 地级市
Area string `json:"area"` // 县/县级市/区
Street string `json:"street"` // 街道
House string `json:"house"` // 具体门牌号或详细地址
Lat float64 `json:"lat"` // 门店所在地纬度
Lng float64 `json:"lng"` // 门店所在地经度
Phone string `json:"phone"` // 门店联系电话
Name string `json:"name,omitempty"` // 联系人姓名(收货地址时使用)
}
// IntracityStoreInfo 门店信息
type IntracityStoreInfo struct {
WxStoreID string `json:"wx_store_id"` // 微信门店编号
OutStoreID string `json:"out_store_id"` // 自定义门店编号
CityID string `json:"city_id"` // 门店所在城市ID
StoreName string `json:"store_name"` // 门店名称
OrderPattern OrderPattern `json:"order_pattern"` // 运力偏好
ServiceTransPrefer string `json:"service_trans_prefer"` // 优先使用的运力ID
AddressInfo IntracityAddressInfo `json:"address_info"` // 门店地址信息
}
// ============ 门店管理接口 ============
// IntracityApply 开通门店权限
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/express/business/intracity_service.html
func (express *Express) IntracityApply(ctx context.Context) error {
accessToken, err := express.GetAccessToken()
if err != nil {
return err
}
uri := fmt.Sprintf(intracityApplyURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, map[string]interface{}{})
if err != nil {
return err
}
return util.DecodeWithCommonError(response, "IntracityApply")
}
// CreateStoreRequest 创建门店请求参数
type CreateStoreRequest struct {
OutStoreID string `json:"out_store_id"` // 自定义门店编号
StoreName string `json:"store_name"` // 门店名称
OrderPattern OrderPattern `json:"order_pattern,omitempty"` // 运力偏好1-价格优先2-运力优先
ServiceTransPrefer string `json:"service_trans_prefer,omitempty"` // 优先使用的运力IDorder_pattern=2时必填
AddressInfo IntracityAddressInfo `json:"address_info"` // 门店地址信息
}
// CreateStoreResponse 创建门店返回参数
type CreateStoreResponse struct {
util.CommonError
WxStoreID string `json:"wx_store_id"` // 微信门店编号
AppID string `json:"appid"` // 小程序appid
OutStoreID string `json:"out_store_id"` // 自定义门店ID
}
// IntracityCreateStore 创建门店
func (express *Express) IntracityCreateStore(ctx context.Context, req *CreateStoreRequest) (res CreateStoreResponse, err error) {
accessToken, err := express.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(intracityCreateStoreURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, req)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "IntracityCreateStore")
return
}
// QueryStoreRequest 查询门店请求参数
type QueryStoreRequest struct {
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号
OutStoreID string `json:"out_store_id,omitempty"` // 自定义门店编号
}
// QueryStoreResponse 查询门店返回参数
type QueryStoreResponse struct {
util.CommonError
Total uint32 `json:"total"` // 符合条件的门店总数
AppID string `json:"appid"` // 小程序appid
StoreList []IntracityStoreInfo `json:"store_list"` // 门店信息列表
}
// IntracityQueryStore 查询门店
func (express *Express) IntracityQueryStore(ctx context.Context, req *QueryStoreRequest) (res QueryStoreResponse, err error) {
accessToken, err := express.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(intracityQueryStoreURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, req)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "IntracityQueryStore")
return
}
// UpdateStoreKeyInfo 更新门店的key信息
type UpdateStoreKeyInfo struct {
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号
OutStoreID string `json:"out_store_id,omitempty"` // 自定义门店编号,二选一
}
// UpdateStoreContent 更新门店的内容
type UpdateStoreContent struct {
StoreName string `json:"store_name,omitempty"` // 门店名称
OrderPattern OrderPattern `json:"order_pattern,omitempty"` // 运力偏好
ServiceTransPrefer string `json:"service_trans_prefer,omitempty"` // 优先使用的运力ID
AddressInfo *IntracityAddressInfo `json:"address_info,omitempty"` // 门店地址信息
}
// UpdateStoreRequest 更新门店请求参数
type UpdateStoreRequest struct {
Keys UpdateStoreKeyInfo `json:"keys"` // 门店编号
Content UpdateStoreContent `json:"content"` // 更新内容
}
// IntracityUpdateStore 更新门店
func (express *Express) IntracityUpdateStore(ctx context.Context, req *UpdateStoreRequest) error {
accessToken, err := express.GetAccessToken()
if err != nil {
return err
}
uri := fmt.Sprintf(intracityUpdateStoreURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, req)
if err != nil {
return err
}
return util.DecodeWithCommonError(response, "IntracityUpdateStore")
}
// ============ 充值退款接口 ============
// StoreChargeRequest 门店运费充值请求参数
type StoreChargeRequest struct {
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号pay_mode=PAY_MODE_STORE时必传
ServiceTransID string `json:"service_trans_id"` // 运力ID
Amount uint32 `json:"amount"` // 充值金额单位50元起充
PayMode PayMode `json:"pay_mode,omitempty"` // 充值主体
}
// StoreChargeResponse 门店运费充值返回参数
type StoreChargeResponse struct {
util.CommonError
PayURL string `json:"payurl"` // 充值页面地址
AppID string `json:"appid"` // 小程序appid
WxStoreID string `json:"wx_store_id"` // 微信门店编号
}
// IntracityStoreCharge 门店运费充值
func (express *Express) IntracityStoreCharge(ctx context.Context, req *StoreChargeRequest) (res StoreChargeResponse, err error) {
accessToken, err := express.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(intracityStoreChargeURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, req)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "IntracityStoreCharge")
return
}
// StoreRefundRequest 门店运费退款请求参数
type StoreRefundRequest struct {
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号
PayMode PayMode `json:"pay_mode,omitempty"` // 充值/扣费主体
ServiceTransID string `json:"service_trans_id"` // 运力ID
}
// StoreRefundResponse 门店运费退款返回参数
type StoreRefundResponse struct {
util.CommonError
AppID string `json:"appid"` // 小程序appid
WxStoreID string `json:"wx_store_id"` // 微信门店编号
RefundAmount uint32 `json:"refund_amount"` // 退款金额,单位:分
}
// IntracityStoreRefund 门店运费退款
func (express *Express) IntracityStoreRefund(ctx context.Context, req *StoreRefundRequest) (res StoreRefundResponse, err error) {
accessToken, err := express.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(intracityStoreRefundURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, req)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "IntracityStoreRefund")
return
}
// QueryFlowRequest 门店运费流水查询请求参数
type QueryFlowRequest struct {
WxStoreID string `json:"wx_store_id"` // 微信门店编号
FlowType FlowType `json:"flow_type"` // 流水类型1-充值2-消费3-退款
ServiceTransID string `json:"service_trans_id,omitempty"` // 运力ID
BeginTime uint32 `json:"begin_time,omitempty"` // 开始时间戳
EndTime uint32 `json:"end_time,omitempty"` // 结束时间戳
PayMode PayMode `json:"pay_mode"` // 扣费主体
}
// FlowRecordInfo 流水记录信息
type FlowRecordInfo struct {
FlowType FlowType `json:"flow_type"` // 流水类型
AppID string `json:"appid"` // appid
WxStoreID string `json:"wx_store_id"` // 微信门店ID
PayOrderID uint64 `json:"pay_order_id,omitempty"` // 充值订单号
WxOrderID string `json:"wx_order_id,omitempty"` // 订单ID消费流水
ServiceTransID string `json:"service_trans_id"` // 运力ID
OpenID string `json:"openid,omitempty"` // 用户openid消费流水
DeliveryStatus int32 `json:"delivery_status,omitempty"` // 运单状态(消费流水)
PayAmount int32 `json:"pay_amount"` // 支付金额,单位:分
PayTime uint32 `json:"pay_time,omitempty"` // 支付时间
PayStatus string `json:"pay_status,omitempty"` // 支付状态
RefundStatus string `json:"refund_status,omitempty"` // 退款状态
RefundAmount int32 `json:"refund_amount,omitempty"` // 退款金额
RefundTime uint32 `json:"refund_time,omitempty"` // 退款时间
DeductAmount int32 `json:"deduct_amount,omitempty"` // 扣除违约金
CreateTime uint32 `json:"create_time"` // 创建时间
ConsumeDeadline uint32 `json:"consume_deadline,omitempty"` // 有效截止日期
BillID string `json:"bill_id,omitempty"` // 运单ID
DeliveryFinishedTime uint32 `json:"delivery_finished_time,omitempty"` // 运单完成配送的时间
}
// QueryFlowResponse 门店运费流水查询返回参数
type QueryFlowResponse struct {
util.CommonError
Total uint32 `json:"total"` // 总数
FlowList []FlowRecordInfo `json:"flow_list"` // 流水数组
TotalPayAmt int `json:"total_pay_amt"` // 总支付金额
TotalRefundAmt int `json:"total_refund_amt"` // 总退款金额
TotalDeductAmt int `json:"total_deduct_amt"` // 总违约金(消费流水返回)
}
// IntracityQueryFlow 门店运费流水查询
func (express *Express) IntracityQueryFlow(ctx context.Context, req *QueryFlowRequest) (res QueryFlowResponse, err error) {
accessToken, err := express.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(intracityQueryFlowURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, req)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "IntracityQueryFlow")
return
}
// BalanceQueryRequest 门店余额查询请求参数
type BalanceQueryRequest struct {
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号
ServiceTransID string `json:"service_trans_id,omitempty"` // 运力ID
PayMode PayMode `json:"pay_mode,omitempty"` // 充值/扣费主体
}
// BalanceInfo 余额信息
type BalanceInfo struct {
ServiceTransID string `json:"service_trans_id"` // 运力ID
Balance int32 `json:"balance"` // 余额,单位:分
}
// BalanceQueryResponse 门店余额查询返回参数
type BalanceQueryResponse struct {
util.CommonError
AppID string `json:"appid"` // 小程序appid
WxStoreID string `json:"wx_store_id"` // 微信门店编号
BalanceList []BalanceInfo `json:"balance_list"` // 余额列表
}
// IntracityBalanceQuery 门店余额查询
func (express *Express) IntracityBalanceQuery(ctx context.Context, req *BalanceQueryRequest) (res BalanceQueryResponse, err error) {
accessToken, err := express.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(intracityBalanceQueryURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, req)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "IntracityBalanceQuery")
return
}
// ============ 配送订单接口 ============
// CargoInfo 货物信息
type CargoInfo struct {
Name string `json:"name"` // 货物名称
Num uint32 `json:"num,omitempty"` // 货物数量
Price uint32 `json:"price,omitempty"` // 货物价格,单位:分
Weight uint32 `json:"weight,omitempty"` // 货物重量,单位:克
}
// PreAddOrderRequest 预下配送单请求参数
type PreAddOrderRequest struct {
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号,二选一
OutStoreID string `json:"out_store_id,omitempty"` // 自定义门店编号,二选一
UserOpenID string `json:"user_openid"` // 用户openid
UserPhone string `json:"user_phone,omitempty"` // 用户联系电话
UserName string `json:"user_name,omitempty"` // 用户姓名
UserLat float64 `json:"user_lat"` // 用户地址纬度
UserLng float64 `json:"user_lng"` // 用户地址经度
UserAddress string `json:"user_address"` // 用户详细地址
ServiceTransID string `json:"service_trans_id,omitempty"` // 运力ID不传则查询所有运力
PayMode PayMode `json:"pay_mode,omitempty"` // 充值/扣费主体
CargoInfo *CargoInfo `json:"cargo_info,omitempty"` // 货物信息
}
// TransInfo 运力信息
type TransInfo struct {
ServiceTransID string `json:"service_trans_id"` // 运力ID
ServiceName string `json:"service_name"` // 运力名称
Price uint32 `json:"price"` // 配送费用,单位:分
Distance uint32 `json:"distance"` // 配送距离,单位:米
Errcode int `json:"errcode"` // 错误码0表示成功
Errmsg string `json:"errmsg"` // 错误信息
}
// PreAddOrderResponse 预下配送单返回参数
type PreAddOrderResponse struct {
util.CommonError
WxStoreID string `json:"wx_store_id"` // 微信门店编号
AppID string `json:"appid"` // 小程序appid
TransList []TransInfo `json:"trans_list"` // 运力列表
}
// IntracityPreAddOrder 预下配送单(查询运费)
func (express *Express) IntracityPreAddOrder(ctx context.Context, req *PreAddOrderRequest) (res PreAddOrderResponse, err error) {
accessToken, err := express.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(intracityPreAddOrderURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, req)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "IntracityPreAddOrder")
return
}
// AddOrderRequest 创建配送单请求参数
type AddOrderRequest struct {
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号,二选一
OutStoreID string `json:"out_store_id,omitempty"` // 自定义门店编号,二选一
OutOrderID string `json:"out_order_id"` // 自定义订单号,需唯一
ServiceTransID string `json:"service_trans_id,omitempty"` // 运力ID
UserOpenID string `json:"user_openid"` // 用户openid
UserPhone string `json:"user_phone"` // 用户联系电话
UserName string `json:"user_name"` // 用户姓名
UserLat float64 `json:"user_lat"` // 用户地址纬度
UserLng float64 `json:"user_lng"` // 用户地址经度
UserAddress string `json:"user_address"` // 用户详细地址
PayMode PayMode `json:"pay_mode,omitempty"` // 充值/扣费主体
CargoInfo *CargoInfo `json:"cargo_info,omitempty"` // 货物信息
OrderDetailPath string `json:"order_detail_path,omitempty"` // 订单详情页路径
CallbackURL string `json:"callback_url,omitempty"` // 配送状态回调URL
UseInsurance uint32 `json:"use_insurance,omitempty"` // 是否使用保价0-不使用1-使用
InsuranceValue uint32 `json:"insurance_value,omitempty"` // 保价金额,单位:分
ExpectTime uint32 `json:"expect_time,omitempty"` // 期望送达时间戳
Remark string `json:"remark,omitempty"` // 备注
}
// AddOrderResponse 创建配送单返回参数
type AddOrderResponse struct {
util.CommonError
WxOrderID string `json:"wx_order_id"` // 微信订单号
AppID string `json:"appid"` // 小程序appid
WxStoreID string `json:"wx_store_id"` // 微信门店编号
OutOrderID string `json:"out_order_id"` // 自定义订单号
ServiceTransID string `json:"service_trans_id"` // 运力ID
BillID string `json:"bill_id"` // 运力订单号
Price uint32 `json:"price"` // 配送费用,单位:分
Distance uint32 `json:"distance"` // 配送距离,单位:米
}
// IntracityAddOrder 创建配送单
func (express *Express) IntracityAddOrder(ctx context.Context, req *AddOrderRequest) (res AddOrderResponse, err error) {
accessToken, err := express.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(intracityAddOrderURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, req)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "IntracityAddOrder")
return
}
// QueryOrderRequest 查询配送单请求参数
type QueryOrderRequest struct {
WxOrderID string `json:"wx_order_id,omitempty"` // 微信订单号,二选一
OutOrderID string `json:"out_order_id,omitempty"` // 自定义订单号,二选一
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号
OutStoreID string `json:"out_store_id,omitempty"` // 自定义门店编号
}
// RiderInfo 骑手信息
type RiderInfo struct {
Name string `json:"name"` // 骑手姓名
Phone string `json:"phone"` // 骑手电话
RiderCode string `json:"rider_code"` // 骑手编号
RiderImgURL string `json:"rider_img_url"` // 骑手头像URL
}
// QueryOrderResponse 查询配送单返回参数
type QueryOrderResponse struct {
util.CommonError
WxOrderID string `json:"wx_order_id"` // 微信订单号
AppID string `json:"appid"` // 小程序appid
WxStoreID string `json:"wx_store_id"` // 微信门店编号
OutOrderID string `json:"out_order_id"` // 自定义订单号
ServiceTransID string `json:"service_trans_id"` // 运力ID
BillID string `json:"bill_id"` // 运力订单号
DeliveryStatus IntracityDeliveryStatus `json:"delivery_status"` // 配送状态
Price uint32 `json:"price"` // 配送费用,单位:分
Distance uint32 `json:"distance"` // 配送距离,单位:米
CreateTime uint32 `json:"create_time"` // 订单创建时间
RiderInfo *RiderInfo `json:"rider_info"` // 骑手信息
FinishTime uint32 `json:"finish_time"` // 订单完成时间
}
// IntracityQueryOrder 查询配送单
func (express *Express) IntracityQueryOrder(ctx context.Context, req *QueryOrderRequest) (res QueryOrderResponse, err error) {
accessToken, err := express.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(intracityQueryOrderURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, req)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "IntracityQueryOrder")
return
}
// CancelOrderRequest 取消配送单请求参数
type CancelOrderRequest struct {
WxOrderID string `json:"wx_order_id,omitempty"` // 微信订单号,二选一
OutOrderID string `json:"out_order_id,omitempty"` // 自定义订单号,二选一
WxStoreID string `json:"wx_store_id,omitempty"` // 微信门店编号
OutStoreID string `json:"out_store_id,omitempty"` // 自定义门店编号
CancelReason string `json:"cancel_reason,omitempty"` // 取消原因
}
// CancelOrderResponse 取消配送单返回参数
type CancelOrderResponse struct {
util.CommonError
WxOrderID string `json:"wx_order_id"` // 微信订单号
RefundAmount int32 `json:"refund_amount"` // 退款金额,单位:分
DeductAmount int32 `json:"deduct_amount"` // 扣除违约金,单位:分
}
// IntracityCancelOrder 取消配送单
func (express *Express) IntracityCancelOrder(ctx context.Context, req *CancelOrderRequest) (res CancelOrderResponse, err error) {
accessToken, err := express.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(intracityCancelOrderURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, req)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "IntracityCancelOrder")
return
}
// MockNotifyRequest 模拟配送回调请求参数(仅用于测试)
type MockNotifyRequest struct {
WxOrderID string `json:"wx_order_id"` // 微信订单号
DeliveryStatus IntracityDeliveryStatus `json:"delivery_status"` // 配送状态
}
// IntracityMockNotify 模拟配送回调(仅用于测试)
func (express *Express) IntracityMockNotify(ctx context.Context, req *MockNotifyRequest) error {
accessToken, err := express.GetAccessToken()
if err != nil {
return err
}
uri := fmt.Sprintf(intracityMockNotifyURL, accessToken)
response, err := util.PostJSONContext(ctx, uri, req)
if err != nil {
return err
}
return util.DecodeWithCommonError(response, "IntracityMockNotify")
}

View File

@@ -22,9 +22,9 @@ const (
MsgTypeMiniProgramPage = "miniprogrampage"
// MsgTypeEvent 事件
MsgTypeEvent MsgType = "event"
// DataTypeXML XML格式数据
// DataTypeXML XML 格式数据
DataTypeXML = "xml"
// DataTypeJSON JSON格式数据
// DataTypeJSON JSON 格式数据
DataTypeJSON = "json"
)

View File

@@ -28,7 +28,7 @@ type MediaText struct {
Content string `json:"content"`
}
// MediaResource 消息使用的临时素材id
// MediaResource 消息使用的临时素材 id
type MediaResource struct {
MediaID string `json:"media_id"`
}
@@ -51,7 +51,7 @@ type MediaLink struct {
// CustomerMessage 客服消息
type CustomerMessage struct {
ToUser string `json:"touser"` // 接受者OpenID
ToUser string `json:"touser"` // 接受者 OpenID
Msgtype MsgType `json:"msgtype"` // 客服消息类型
Text *MediaText `json:"text,omitempty"` // 可选
Image *MediaResource `json:"image,omitempty"` // 可选

View File

@@ -9,6 +9,8 @@ import (
"sort"
"strings"
"github.com/tidwall/gjson"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/miniprogram/security"
"github.com/silenceper/wechat/v2/util"
@@ -18,11 +20,11 @@ import (
type ConfirmReceiveMethod int8
const (
// EventTypeTradeManageRemindAccessAPI 提醒接入发货信息管理服务API
// EventTypeTradeManageRemindAccessAPI 提醒接入发货信息管理服务 API
// 小程序完成账期授权时/小程序产生第一笔交易时/已产生交易但从未发货的小程序,每天一次
EventTypeTradeManageRemindAccessAPI EventType = "trade_manage_remind_access_api"
// EventTypeTradeManageRemindShipping 提醒需要上传发货信息
// 曾经发过货的小程序订单超过48小时未发货时
// 曾经发过货的小程序,订单超过 48 小时未发货时
EventTypeTradeManageRemindShipping EventType = "trade_manage_remind_shipping"
// EventTypeTradeManageOrderSettlement 订单将要结算或已经结算
// 订单完成发货时/订单结算时
@@ -39,14 +41,27 @@ const (
EventTypeXpayGoodsDeliverNotify EventType = "xpay_goods_deliver_notify"
// EventTypeXpayCoinPayNotify 代币支付推送事件
EventTypeXpayCoinPayNotify EventType = "xpay_coin_pay_notify"
// EventSubscribePopup 用户操作订阅通知弹窗事件推送,用户在图文等场景内订阅通知的操作
EventSubscribePopup EventType = "subscribe_msg_popup_event"
// EventSubscribeMsgChange 用户管理订阅通知,用户在服务通知管理页面做通知管理时的操作
EventSubscribeMsgChange EventType = "subscribe_msg_change_event"
// EventSubscribeMsgSent 发送订阅通知,调用 bizsend 接口发送通知
EventSubscribeMsgSent EventType = "subscribe_msg_sent_event"
// ConfirmReceiveMethodAuto 自动确认收货
ConfirmReceiveMethodAuto ConfirmReceiveMethod = 1
// ConfirmReceiveMethodManual 手动确认收货
ConfirmReceiveMethodManual ConfirmReceiveMethod = 2
)
const (
// InfoTypeAcceptSubscribeMessage 接受订阅通知
InfoTypeAcceptSubscribeMessage InfoType = "accept"
// InfoTypeRejectSubscribeMessage 拒绝订阅通知
InfoTypeRejectSubscribeMessage InfoType = "reject"
)
// PushReceiver 接收消息推送
// 暂仅支付Aes加密方式
// 暂仅支付 Aes 加密方式
type PushReceiver struct {
*context.Context
}
@@ -58,16 +73,16 @@ func NewPushReceiver(ctx *context.Context) *PushReceiver {
}
}
// GetMsg 获取接收到的消息(如果是加密的返回解密数据)
// GetMsg 获取接收到的消息 (如果是加密的返回解密数据)
func (receiver *PushReceiver) GetMsg(r *http.Request) (string, []byte, error) {
// 判断请求格式
var dataType string
contentType := r.Header.Get("Content-Type")
if strings.HasPrefix(contentType, "text/xml") {
// xml格式
// xml 格式
dataType = DataTypeXML
} else {
// json格式
// json 格式
dataType = DataTypeJSON
}
@@ -108,7 +123,7 @@ func (receiver *PushReceiver) GetMsg(r *http.Request) (string, []byte, error) {
return dataType, byteData, err
}
// GetMsgData 获取接收到的消息(解密数据)
// GetMsgData 获取接收到的消息 (解密数据)
func (receiver *PushReceiver) GetMsgData(r *http.Request) (MsgType, EventType, PushData, error) {
dataType, decryptMsg, err := receiver.GetMsg(r)
if err != nil {
@@ -144,7 +159,7 @@ func (receiver *PushReceiver) GetMsgData(r *http.Request) (MsgType, EventType, P
func (receiver *PushReceiver) getEvent(dataType string, eventType EventType, decryptMsg []byte) (PushData, error) {
switch eventType {
case EventTypeTradeManageRemindAccessAPI:
// 提醒接入发货信息管理服务API
// 提醒接入发货信息管理服务 API
var pushData PushDataRemindAccessAPI
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
@@ -188,25 +203,104 @@ func (receiver *PushReceiver) getEvent(dataType string, eventType EventType, dec
var pushData PushDataXpayCoinPayNotify
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventSubscribePopup:
// 用户操作订阅通知弹窗事件推送
return receiver.unmarshalSubscribePopup(dataType, decryptMsg)
case EventSubscribeMsgChange:
// 用户管理订阅通知事件推送
return receiver.unmarshalSubscribeMsgChange(dataType, decryptMsg)
case EventSubscribeMsgSent:
// 用户发送订阅通知事件推送
return receiver.unmarshalSubscribeMsgSent(dataType, decryptMsg)
}
// 暂不支持其他事件类型,直接返回解密后的数据,由调用方处理
return decryptMsg, nil
}
// unmarshal 解析推送的数据
func (receiver *PushReceiver) unmarshal(dateType string, decryptMsg []byte, pushData interface{}) error {
if dateType == DataTypeXML {
func (receiver *PushReceiver) unmarshal(dataType string, decryptMsg []byte, pushData interface{}) error {
if dataType == DataTypeXML {
return xml.Unmarshal(decryptMsg, pushData)
}
return json.Unmarshal(decryptMsg, pushData)
}
// unmarshalSubscribePopup
func (receiver *PushReceiver) unmarshalSubscribePopup(dataType string, decryptMsg []byte) (PushData, error) {
var pushData PushDataSubscribePopup
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
if err == nil {
listData := gjson.Get(string(decryptMsg), "List")
if listData.IsObject() {
listItem := SubscribeMsgPopupEventList{}
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItem); parseErr != nil {
return &pushData, parseErr
}
pushData.SetSubscribeMsgPopupEvents([]SubscribeMsgPopupEventList{listItem})
} else if listData.IsArray() {
listItems := make([]SubscribeMsgPopupEventList, 0)
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItems); parseErr != nil {
return &pushData, parseErr
}
pushData.SetSubscribeMsgPopupEvents(listItems)
}
}
return &pushData, err
}
// unmarshalSubscribeMsgChange 解析用户管理订阅通知事件推送
func (receiver *PushReceiver) unmarshalSubscribeMsgChange(dataType string, decryptMsg []byte) (PushData, error) {
var pushData PushDataSubscribeMsgChange
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
if err == nil {
listData := gjson.Get(string(decryptMsg), "List")
if listData.IsObject() {
listItem := SubscribeMsgChangeList{}
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItem); parseErr != nil {
return &pushData, parseErr
}
pushData.SetSubscribeMsgChangeEvents([]SubscribeMsgChangeList{listItem})
} else if listData.IsArray() {
listItems := make([]SubscribeMsgChangeList, 0)
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItems); parseErr != nil {
return &pushData, parseErr
}
pushData.SetSubscribeMsgChangeEvents(listItems)
}
}
return &pushData, err
}
// unmarshalSubscribeMsgSent 解析用户发送订阅通知事件推送
func (receiver *PushReceiver) unmarshalSubscribeMsgSent(dataType string, decryptMsg []byte) (PushData, error) {
var pushData PushDataSubscribeMsgSent
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
if err == nil {
listData := gjson.Get(string(decryptMsg), "List")
if listData.IsObject() {
listItem := SubscribeMsgSentList{}
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItem); parseErr != nil {
return &pushData, parseErr
}
pushData.SetSubscribeMsgSentEvents([]SubscribeMsgSentList{listItem})
} else if listData.IsArray() {
listItems := make([]SubscribeMsgSentList, 0)
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItems); parseErr != nil {
return &pushData, parseErr
}
pushData.SetSubscribeMsgSentEvents(listItems)
}
}
return &pushData, err
}
// DataReceived 接收到的数据
type DataReceived struct {
Encrypt string `json:"Encrypt" xml:"Encrypt"` // 加密的消息体
}
// PushData 推送的数据(已转对应的结构体)
// PushData 推送的数据 (已转对应的结构体)
type PushData interface{}
// CommonPushData 推送数据通用部分
@@ -216,7 +310,7 @@ type CommonPushData struct {
Event EventType `json:"Event" xml:"Event"` // 事件类型
ToUserName string `json:"ToUserName" xml:"ToUserName"` // 小程序的原始 ID
FromUserName string `json:"FromUserName" xml:"FromUserName"` // 发送方账号(一个 OpenID此时发送方是系统账号
CreateTime int64 `json:"CreateTime" xml:"CreateTime"` // 消息创建时间 (整型),时间戳
CreateTime int64 `json:"CreateTime" xml:"CreateTime"` // 消息创建时间(整型),时间戳
}
// MediaCheckAsyncData 媒体内容安全异步审查结果通知
@@ -272,7 +366,7 @@ type PushDataRemindShipping struct {
Msg string `json:"msg" xml:"msg"` // 消息文本内容
}
// PushDataRemindAccessAPI 提醒接入发货信息管理服务API信息
// PushDataRemindAccessAPI 提醒接入发货信息管理服务 API 信息
type PushDataRemindAccessAPI struct {
CommonPushData
Msg string `json:"msg" xml:"msg"` // 消息文本内容
@@ -281,9 +375,9 @@ type PushDataRemindAccessAPI struct {
// PushDataAddExpressPath 运单轨迹更新信息
type PushDataAddExpressPath struct {
CommonPushData
DeliveryID string `json:"DeliveryID" xml:"DeliveryID"` // 快递公司ID
WayBillID string `json:"WaybillId" xml:"WaybillId"` // 运单ID
OrderID string `json:"OrderId" xml:"OrderId"` // 订单ID
DeliveryID string `json:"DeliveryID" xml:"DeliveryID"` // 快递公司 ID
WayBillID string `json:"WaybillId" xml:"WaybillId"` // 运单 ID
OrderID string `json:"OrderId" xml:"OrderId"` // 订单 ID
Version int `json:"Version" xml:"Version"` // 轨迹版本号(整型)
Count int `json:"Count" xml:"Count"` // 轨迹节点数(整型)
Actions []*PushDataAddExpressPathAction `json:"Actions" xml:"Actions"` // 轨迹节点列表
@@ -304,10 +398,10 @@ type PushDataSecVodUpload struct {
// SecVodUploadEvent 短剧媒资上传完成事件
type SecVodUploadEvent struct {
MediaID string `json:"media_id" xml:"media_id"` // 媒资id
MediaID int64 `json:"media_id" xml:"media_id"` // 媒资 id
SourceContext string `json:"source_context" xml:"source_context"` // 透传上传接口中开发者设置的值。
Errcode int `json:"errcode" xml:"errcode"` // 错误码,上传失败时该值非
Errmsg string `json:"errmsg" xml:"errmsg"` // 错误提示
ErrCode int `json:"errcode" xml:"errcode"` // 错误码,上传失败时该值非
ErrMsg string `json:"errmsg" xml:"errmsg"` // 错误提示
}
// PushDataSecVodAudit 短剧媒资审核状态
@@ -318,14 +412,14 @@ type PushDataSecVodAudit struct {
// SecVodAuditEvent 短剧媒资审核状态事件
type SecVodAuditEvent struct {
DramaID string `json:"drama_id" xml:"drama_id"` // 剧目id
DramaID int64 `json:"drama_id" xml:"drama_id"` // 剧目 id
SourceContext string `json:"source_context" xml:"source_context"` // 透传上传接口中开发者设置的值
AuditDetail DramaAuditDetail `json:"audit_detail" xml:"audit_detail"` // 剧目审核结果单独每一集的审核结果可以根据drama_id查询剧集详情得到
AuditDetail DramaAuditDetail `json:"audit_detail" xml:"audit_detail"` // 剧目审核结果,单独每一集的审核结果可以根据 drama_id 查询剧集详情得到
}
// DramaAuditDetail 剧目审核结果
type DramaAuditDetail struct {
Status int `json:"status" xml:"status"` // 审核状态0为无效值1为审核中2为最终失败3为审核通过4为驳回重填
Status int `json:"status" xml:"status"` // 审核状态0 为无效值1 为审核中2 为最终失败3 为审核通过4 为驳回重填
CreateTime int64 `json:"create_time" xml:"create_time"` // 提审时间戳
AuditTime int64 `json:"audit_time" xml:"audit_time"` // 审核时间戳
}
@@ -333,9 +427,9 @@ type DramaAuditDetail struct {
// PushDataXpayGoodsDeliverNotify 道具发货推送
type PushDataXpayGoodsDeliverNotify struct {
CommonPushData
OpenID string `json:"OpenId" xml:"OpenId"` // 用户openid
OpenID string `json:"OpenId" xml:"OpenId"` // 用户 openid
OutTradeNo string `json:"OutTradeNo" xml:"OutTradeNo"` // 业务订单号
Env int `json:"Env" xml:"Env"` //,环境配置 0现网环境也叫正式环境1沙箱环境
Env int `json:"Env" xml:"Env"` // ,环境配置 0现网环境也叫正式环境1沙箱环境
WeChatPayInfo WeChatPayInfo `json:"WeChatPayInfo" xml:"WeChatPayInfo"` // 微信支付信息 非微信支付渠道可能没有
GoodsInfo GoodsInfo `json:"GoodsInfo" xml:"GoodsInfo"` // 道具参数信息
}
@@ -344,14 +438,14 @@ type PushDataXpayGoodsDeliverNotify struct {
type WeChatPayInfo struct {
MchOrderNo string `json:"MchOrderNo" xml:"MchOrderNo"` // 微信支付商户单号
TransactionID string `json:"TransactionId" xml:"TransactionId"` // 交易单号(微信支付订单号)
PaidTime int64 `json:"PaidTime" xml:"PaidTime"` // 用户支付时间Linux秒级时间戳
PaidTime int64 `json:"PaidTime" xml:"PaidTime"` // 用户支付时间Linux 秒级时间戳
}
// GoodsInfo 道具参数信息
type GoodsInfo struct {
ProductID string `json:"ProductId" xml:"ProductId"` // 道具ID
ProductID string `json:"ProductId" xml:"ProductId"` // 道具 ID
Quantity int `json:"Quantity" xml:"Quantity"` // 数量
OrigPrice int64 `json:"OrigPrice" xml:"OrigPrice"` // 物品原始价格 (单位:分)
OrigPrice int64 `json:"OrigPrice" xml:"OrigPrice"` // 物品原始价格(单位:分)
ActualPrice int64 `json:"ActualPrice" xml:"ActualPrice"` // 物品实际支付价格(单位:分)
Attach string `json:"Attach" xml:"Attach"` // 透传信息
}
@@ -359,9 +453,9 @@ type GoodsInfo struct {
// PushDataXpayCoinPayNotify 代币支付推送
type PushDataXpayCoinPayNotify struct {
CommonPushData
OpenID string `json:"OpenId" xml:"OpenId"` // 用户openid
OpenID string `json:"OpenId" xml:"OpenId"` // 用户 openid
OutTradeNo string `json:"OutTradeNo" xml:"OutTradeNo"` // 业务订单号
Env int `json:"Env" xml:"Env"` //,环境配置 0现网环境也叫正式环境1沙箱环境
Env int `json:"Env" xml:"Env"` // ,环境配置 0现网环境也叫正式环境1沙箱环境
WeChatPayInfo WeChatPayInfo `json:"WeChatPayInfo" xml:"WeChatPayInfo"` // 微信支付信息 非微信支付渠道可能没有
CoinInfo CoinInfo `json:"CoinInfo" xml:"CoinInfo"` // 代币参数信息
}
@@ -369,7 +463,117 @@ type PushDataXpayCoinPayNotify struct {
// CoinInfo 代币参数信息
type CoinInfo struct {
Quantity int `json:"Quantity" xml:"Quantity"` // 数量
OrigPrice int64 `json:"OrigPrice" xml:"OrigPrice"` // 物品原始价格 (单位:分)
OrigPrice int64 `json:"OrigPrice" xml:"OrigPrice"` // 物品原始价格(单位:分)
ActualPrice int64 `json:"ActualPrice" xml:"ActualPrice"` // 物品实际支付价格(单位:分)
Attach string `json:"Attach" xml:"Attach"` // 透传信息
}
// PushDataSubscribePopup 用户操作订阅通知弹窗事件推送
type PushDataSubscribePopup struct {
CommonPushData
subscribeMsgPopupEventList []SubscribeMsgPopupEventList `json:"-"`
SubscribeMsgPopupEvent SubscribeMsgPopupEvent `xml:"SubscribeMsgPopupEvent"`
}
// SubscribeMsgPopupEvent 用户操作订阅通知弹窗消息回调
type SubscribeMsgPopupEvent struct {
List []SubscribeMsgPopupEventList `xml:"List"`
}
// SubscribeMsgPopupEventList 订阅消息事件列表
type SubscribeMsgPopupEventList struct {
TemplateID string `xml:"TemplateId" json:"TemplateId"`
SubscribeStatusString string `xml:"SubscribeStatusString" json:"SubscribeStatusString"`
PopupScene string `xml:"PopupScene" json:"PopupScene"`
}
// SetSubscribeMsgPopupEvents 设置订阅消息事件
func (s *PushDataSubscribePopup) SetSubscribeMsgPopupEvents(list []SubscribeMsgPopupEventList) {
s.subscribeMsgPopupEventList = list
}
// GetSubscribeMsgPopupEvents 获取订阅消息事件数据
func (s *PushDataSubscribePopup) GetSubscribeMsgPopupEvents() []SubscribeMsgPopupEventList {
if s.subscribeMsgPopupEventList != nil {
return s.subscribeMsgPopupEventList
}
if s.SubscribeMsgPopupEvent.List == nil || len(s.SubscribeMsgPopupEvent.List) < 1 {
return nil
}
return s.SubscribeMsgPopupEvent.List
}
// PushDataSubscribeMsgChange 用户管理订阅通知事件推送
type PushDataSubscribeMsgChange struct {
CommonPushData
SubscribeMsgChangeEvent SubscribeMsgChangeEvent `xml:"SubscribeMsgChangeEvent"`
subscribeMsgChangeList []SubscribeMsgChangeList `json:"-"`
}
// SubscribeMsgChangeEvent 用户管理订阅通知回调
type SubscribeMsgChangeEvent struct {
List []SubscribeMsgChangeList `xml:"List" json:"List"`
}
// SubscribeMsgChangeList 订阅消息事件列表
type SubscribeMsgChangeList struct {
TemplateID string `xml:"TemplateId" json:"TemplateId"`
SubscribeStatusString string `xml:"SubscribeStatusString" json:"SubscribeStatusString"`
}
// SetSubscribeMsgChangeEvents 设置订阅消息事件
func (s *PushDataSubscribeMsgChange) SetSubscribeMsgChangeEvents(list []SubscribeMsgChangeList) {
s.subscribeMsgChangeList = list
}
// GetSubscribeMsgChangeEvents 获取订阅消息事件数据
func (s *PushDataSubscribeMsgChange) GetSubscribeMsgChangeEvents() []SubscribeMsgChangeList {
if s.subscribeMsgChangeList != nil {
return s.subscribeMsgChangeList
}
if s.SubscribeMsgChangeEvent.List == nil || len(s.SubscribeMsgChangeEvent.List) < 1 {
return nil
}
return s.SubscribeMsgChangeEvent.List
}
// PushDataSubscribeMsgSent 用户发送订阅通知事件推送
type PushDataSubscribeMsgSent struct {
CommonPushData
SubscribeMsgSentEvent SubscribeMsgSentEvent `xml:"SubscribeMsgSentEvent"`
subscribeMsgSentEventList []SubscribeMsgSentList `json:"-"`
}
// SubscribeMsgSentEvent 用户发送订阅通知回调
type SubscribeMsgSentEvent struct {
List []SubscribeMsgSentList `xml:"List" json:"List"`
}
// SubscribeMsgSentList 订阅消息事件列表
type SubscribeMsgSentList struct {
TemplateID string `xml:"TemplateId" json:"TemplateId"`
MsgID string `xml:"MsgID" json:"MsgID"`
ErrorCode string `xml:"ErrorCode" json:"ErrorCode"`
ErrorStatus string `xml:"ErrorStatus" json:"ErrorStatus"`
}
// SetSubscribeMsgSentEvents 设置订阅消息事件
func (s *PushDataSubscribeMsgSent) SetSubscribeMsgSentEvents(list []SubscribeMsgSentList) {
s.subscribeMsgSentEventList = list
}
// GetSubscribeMsgSentEvents 获取订阅消息事件数据
func (s *PushDataSubscribeMsgSent) GetSubscribeMsgSentEvents() []SubscribeMsgSentList {
if s.subscribeMsgSentEventList != nil {
return s.subscribeMsgSentEventList
}
if s.SubscribeMsgSentEvent.List == nil || len(s.SubscribeMsgSentEvent.List) < 1 {
return nil
}
return s.SubscribeMsgSentEvent.List
}

View File

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

View File

@@ -0,0 +1,147 @@
package message
import (
"fmt"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/util"
)
const (
// createActivityIDURL 创建activity_id
createActivityIDURL = "https://api.weixin.qq.com/cgi-bin/message/wxopen/activityid/create?access_token=%s&unionid=%s&openid=%s"
// SendUpdatableMsgURL 修改动态消息
setUpdatableMsgURL = "https://api.weixin.qq.com/cgi-bin/message/wxopen/updatablemsg/send?access_token=%s"
// setChatToolMsgURL 修改小程序聊天工具的动态卡片消息
setChatToolMsgURL = "https://api.weixin.qq.com/cgi-bin/message/wxopen/chattoolmsg/send?access_token=%s"
)
// UpdatableTargetState 动态消息状态
type UpdatableTargetState int
const (
// TargetStateNotStarted 未开始
TargetStateNotStarted UpdatableTargetState = 0
// TargetStateStarted 已开始
TargetStateStarted UpdatableTargetState = 1
// TargetStateFinished 已结束
TargetStateFinished UpdatableTargetState = 2
)
// UpdatableMessage 动态消息
type UpdatableMessage struct {
*context.Context
}
// NewUpdatableMessage 实例化
func NewUpdatableMessage(ctx *context.Context) *UpdatableMessage {
return &UpdatableMessage{
Context: ctx,
}
}
// CreateActivityIDRequest 创建activity_id请求
type CreateActivityIDRequest struct {
UnionID string
OpenID string
}
// CreateActivityID 创建activity_id
func (updatableMessage *UpdatableMessage) CreateActivityID() (CreateActivityIDResponse, error) {
return updatableMessage.CreateActivityIDWithReq(&CreateActivityIDRequest{})
}
// CreateActivityIDWithReq 创建activity_id
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/updatable-message/createActivityId.html
func (updatableMessage *UpdatableMessage) CreateActivityIDWithReq(req *CreateActivityIDRequest) (res CreateActivityIDResponse, err error) {
accessToken, err := updatableMessage.GetAccessToken()
if err != nil {
return
}
url := fmt.Sprintf(createActivityIDURL, accessToken, req.UnionID, req.OpenID)
response, err := util.HTTPGet(url)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "CreateActivityID")
return
}
// SetUpdatableMsg 修改动态消息
func (updatableMessage *UpdatableMessage) SetUpdatableMsg(activityID string, targetState UpdatableTargetState, template UpdatableMsgTemplate) (err error) {
accessToken, err := updatableMessage.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(setUpdatableMsgURL, accessToken)
data := SendUpdatableMsgReq{
ActivityID: activityID,
TargetState: targetState,
TemplateInfo: template,
}
response, err := util.PostJSON(uri, data)
if err != nil {
return
}
return util.DecodeWithCommonError(response, "SendUpdatableMsg")
}
// CreateActivityIDResponse 创建activity_id 返回
type CreateActivityIDResponse struct {
util.CommonError
ActivityID string `json:"activity_id"`
ExpirationTime int64 `json:"expiration_time"`
}
// UpdatableMsgTemplate 动态消息模板
type UpdatableMsgTemplate struct {
ParameterList []UpdatableMsgParameter `json:"parameter_list"`
}
// UpdatableMsgParameter 动态消息参数
type UpdatableMsgParameter struct {
Name string `json:"name"`
Value string `json:"value"`
}
// SendUpdatableMsgReq 修改动态消息参数
type SendUpdatableMsgReq struct {
ActivityID string `json:"activity_id"`
TemplateInfo UpdatableMsgTemplate `json:"template_info"`
TargetState UpdatableTargetState `json:"target_state"`
}
// SetChatToolMsgRequest 修改小程序聊天工具的动态卡片消息请求
type SetChatToolMsgRequest struct {
VersionType int64 `json:"version_type"`
TargetState UpdatableTargetState `json:"target_state"`
ActivityID string `json:"activity_id"`
TemplateID string `json:"template_id"`
ParticipatorInfoList []ParticipatorInfo `json:"participator_info_list,omitempty"`
}
// ParticipatorInfo 更新后的聊天室成员状态
type ParticipatorInfo struct {
State int `json:"state"`
GroupOpenID string `json:"group_openid"`
}
// SetChatToolMsg 修改小程序聊天工具的动态卡片消息
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/updatable-message/setChatToolMsg.html
func (updatableMessage *UpdatableMessage) SetChatToolMsg(req *SetChatToolMsgRequest) error {
var (
accessToken string
err error
)
if accessToken, err = updatableMessage.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(setChatToolMsgURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "SetChatToolMsg")
}

View File

@@ -180,7 +180,7 @@ type MediaInfo struct {
CreateTime int64 `json:"create_time"` // 上传时间,时间戳。
ExpireTime int64 `json:"expire_time"` // 过期时间,时间戳。
DramaID int64 `json:"drama_id"` // 所属剧目 id。
FileSize string `json:"file_size"` // 媒资文件大小,单位:字节。
FileSize int64 `json:"file_size"` // 媒资文件大小,单位:字节。
Duration int64 `json:"duration"` // 播放时长,单位:秒。
Name string `json:"name"` // 媒资文件名。
Description string `json:"description"` // 描述。

View File

@@ -27,7 +27,7 @@ import (
)
// SingleFileUpload 单文件上传
func (s *MiniDrama) SingleFileUpload(ctx context.Context, in *SingleFileUploadRequest) (out *SingleFileUploadResponse, err error) {
func (s *MiniDrama) SingleFileUpload(ctx context.Context, in *SingleFileUploadRequest) (out SingleFileUploadResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, singleFileUpload); err != nil {
return
@@ -76,12 +76,12 @@ func (s *MiniDrama) SingleFileUpload(ctx context.Context, in *SingleFileUploadRe
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "SingleFileUpload")
err = util.DecodeWithError(response, &out, "SingleFileUpload")
return
}
// PullUpload 拉取上传
func (s *MiniDrama) PullUpload(ctx context.Context, in *PullUploadRequest) (out *PullUploadResponse, err error) {
func (s *MiniDrama) PullUpload(ctx context.Context, in *PullUploadRequest) (out PullUploadResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, pullUpload); err != nil {
return
@@ -92,12 +92,12 @@ func (s *MiniDrama) PullUpload(ctx context.Context, in *PullUploadRequest) (out
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "PullUpload")
err = util.DecodeWithError(response, &out, "PullUpload")
return
}
// GetTask 查询任务状态
func (s *MiniDrama) GetTask(ctx context.Context, in *GetTaskRequest) (out *GetTaskResponse, err error) {
func (s *MiniDrama) GetTask(ctx context.Context, in *GetTaskRequest) (out GetTaskResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getTask); err != nil {
return
@@ -109,12 +109,12 @@ func (s *MiniDrama) GetTask(ctx context.Context, in *GetTaskRequest) (out *GetTa
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "GetTask")
err = util.DecodeWithError(response, &out, "GetTask")
return
}
// ApplyUpload 申请分片上传
func (s *MiniDrama) ApplyUpload(ctx context.Context, in *ApplyUploadRequest) (out *ApplyUploadResponse, err error) {
func (s *MiniDrama) ApplyUpload(ctx context.Context, in *ApplyUploadRequest) (out ApplyUploadResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, applyUpload); err != nil {
return
@@ -126,13 +126,13 @@ func (s *MiniDrama) ApplyUpload(ctx context.Context, in *ApplyUploadRequest) (ou
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "ApplyUpload")
err = util.DecodeWithError(response, &out, "ApplyUpload")
return
}
// UploadPart 上传分片
// Content-Type 需要指定为 multipart/form-data; boundary=<delimiter><箭头括号>表示必须替换为有效值的变量。
func (s *MiniDrama) UploadPart(ctx context.Context, in *UploadPartRequest) (out *UploadPartResponse, err error) {
func (s *MiniDrama) UploadPart(ctx context.Context, in *UploadPartRequest) (out UploadPartResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, uploadPart); err != nil {
return
@@ -165,12 +165,12 @@ func (s *MiniDrama) UploadPart(ctx context.Context, in *UploadPartRequest) (out
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "UploadPart")
err = util.DecodeWithError(response, &out, "UploadPart")
return
}
// CommitUpload 确认上传
func (s *MiniDrama) CommitUpload(ctx context.Context, in *CommitUploadRequest) (out *CommitUploadResponse, err error) {
func (s *MiniDrama) CommitUpload(ctx context.Context, in *CommitUploadRequest) (out CommitUploadResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, commitUpload); err != nil {
return
@@ -182,12 +182,12 @@ func (s *MiniDrama) CommitUpload(ctx context.Context, in *CommitUploadRequest) (
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "CommitUpload")
err = util.DecodeWithError(response, &out, "CommitUpload")
return
}
// ListMedia 获取媒体列表
func (s *MiniDrama) ListMedia(ctx context.Context, in *ListMediaRequest) (out *ListMediaResponse, err error) {
func (s *MiniDrama) ListMedia(ctx context.Context, in *ListMediaRequest) (out ListMediaResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, listMedia); err != nil {
return
@@ -199,12 +199,12 @@ func (s *MiniDrama) ListMedia(ctx context.Context, in *ListMediaRequest) (out *L
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "ListMedia")
err = util.DecodeWithError(response, &out, "ListMedia")
return
}
// GetMedia 获取媒资详细信息
func (s *MiniDrama) GetMedia(ctx context.Context, in *GetMediaRequest) (out *GetMediaResponse, err error) {
func (s *MiniDrama) GetMedia(ctx context.Context, in *GetMediaRequest) (out GetMediaResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getMedia); err != nil {
return
@@ -216,12 +216,12 @@ func (s *MiniDrama) GetMedia(ctx context.Context, in *GetMediaRequest) (out *Get
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "GetMedia")
err = util.DecodeWithError(response, &out, "GetMedia")
return
}
// GetMediaLink 获取媒资播放链接
func (s *MiniDrama) GetMediaLink(ctx context.Context, in *GetMediaLinkRequest) (out *GetMediaLinkResponse, err error) {
func (s *MiniDrama) GetMediaLink(ctx context.Context, in *GetMediaLinkRequest) (out GetMediaLinkResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getMediaLink); err != nil {
return
@@ -233,12 +233,12 @@ func (s *MiniDrama) GetMediaLink(ctx context.Context, in *GetMediaLinkRequest) (
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "GetMediaLink")
err = util.DecodeWithError(response, &out, "GetMediaLink")
return
}
// DeleteMedia 删除媒体
func (s *MiniDrama) DeleteMedia(ctx context.Context, in *DeleteMediaRequest) (out *DeleteMediaResponse, err error) {
func (s *MiniDrama) DeleteMedia(ctx context.Context, in *DeleteMediaRequest) (out DeleteMediaResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, deleteMedia); err != nil {
return
@@ -250,12 +250,12 @@ func (s *MiniDrama) DeleteMedia(ctx context.Context, in *DeleteMediaRequest) (ou
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "DeleteMedia")
err = util.DecodeWithError(response, &out, "DeleteMedia")
return
}
// AuditDrama 审核剧本
func (s *MiniDrama) AuditDrama(ctx context.Context, in *AuditDramaRequest) (out *AuditDramaResponse, err error) {
func (s *MiniDrama) AuditDrama(ctx context.Context, in *AuditDramaRequest) (out AuditDramaResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, auditDrama); err != nil {
return
@@ -267,12 +267,12 @@ func (s *MiniDrama) AuditDrama(ctx context.Context, in *AuditDramaRequest) (out
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "AuditDrama")
err = util.DecodeWithError(response, &out, "AuditDrama")
return
}
// ListDramas 获取剧目列表
func (s *MiniDrama) ListDramas(ctx context.Context, in *ListDramasRequest) (out *ListDramasResponse, err error) {
func (s *MiniDrama) ListDramas(ctx context.Context, in *ListDramasRequest) (out ListDramasResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, listDramas); err != nil {
return
@@ -284,12 +284,12 @@ func (s *MiniDrama) ListDramas(ctx context.Context, in *ListDramasRequest) (out
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "ListDramas")
err = util.DecodeWithError(response, &out, "ListDramas")
return
}
// GetDrama 获取剧目信息
func (s *MiniDrama) GetDrama(ctx context.Context, in *GetDramaRequest) (out *GetDramaResponse, err error) {
func (s *MiniDrama) GetDrama(ctx context.Context, in *GetDramaRequest) (out GetDramaResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getDrama); err != nil {
return
@@ -300,12 +300,12 @@ func (s *MiniDrama) GetDrama(ctx context.Context, in *GetDramaRequest) (out *Get
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "GetDrama")
err = util.DecodeWithError(response, &out, "GetDrama")
return
}
// GetCdnUsageData 查询 CDN 用量数据
func (s *MiniDrama) GetCdnUsageData(ctx context.Context, in *GetCdnUsageDataRequest) (out *GetCdnUsageDataResponse, err error) {
func (s *MiniDrama) GetCdnUsageData(ctx context.Context, in *GetCdnUsageDataRequest) (out GetCdnUsageDataResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getCdnUsageData); err != nil {
return
@@ -316,12 +316,12 @@ func (s *MiniDrama) GetCdnUsageData(ctx context.Context, in *GetCdnUsageDataRequ
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "GetCdnUsageData")
err = util.DecodeWithError(response, &out, "GetCdnUsageData")
return
}
// GetCdnLogs 查询 CDN 日志
func (s *MiniDrama) GetCdnLogs(ctx context.Context, in *GetCdnLogsRequest) (out *GetCdnLogsResponse, err error) {
func (s *MiniDrama) GetCdnLogs(ctx context.Context, in *GetCdnLogsRequest) (out GetCdnLogsResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getCdnLogs); err != nil {
return
@@ -332,7 +332,7 @@ func (s *MiniDrama) GetCdnLogs(ctx context.Context, in *GetCdnLogsRequest) (out
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "GetCdnLogs")
err = util.DecodeWithError(response, &out, "GetCdnLogs")
return
}

View File

@@ -10,11 +10,15 @@ import (
"github.com/silenceper/wechat/v2/miniprogram/content"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/miniprogram/encryptor"
"github.com/silenceper/wechat/v2/miniprogram/express"
"github.com/silenceper/wechat/v2/miniprogram/message"
"github.com/silenceper/wechat/v2/miniprogram/minidrama"
"github.com/silenceper/wechat/v2/miniprogram/ocr"
"github.com/silenceper/wechat/v2/miniprogram/operation"
"github.com/silenceper/wechat/v2/miniprogram/order"
"github.com/silenceper/wechat/v2/miniprogram/privacy"
"github.com/silenceper/wechat/v2/miniprogram/qrcode"
"github.com/silenceper/wechat/v2/miniprogram/redpacketcover"
"github.com/silenceper/wechat/v2/miniprogram/riskcontrol"
"github.com/silenceper/wechat/v2/miniprogram/security"
"github.com/silenceper/wechat/v2/miniprogram/shortlink"
@@ -33,17 +37,30 @@ type MiniProgram struct {
// NewMiniProgram 实例化小程序 API
func NewMiniProgram(cfg *config.Config) *MiniProgram {
defaultAkHandle := credential.NewDefaultAccessToken(cfg.AppID, cfg.AppSecret, credential.CacheKeyMiniProgramPrefix, cfg.Cache)
var defaultAkHandle credential.AccessTokenContextHandle
const cacheKeyPrefix = credential.CacheKeyMiniProgramPrefix
if cfg.UseStableAK {
defaultAkHandle = credential.NewStableAccessToken(cfg.AppID, cfg.AppSecret, cacheKeyPrefix, cfg.Cache)
} else {
defaultAkHandle = credential.NewDefaultAccessToken(cfg.AppID, cfg.AppSecret, cacheKeyPrefix, cfg.Cache)
}
ctx := &context.Context{
Config: cfg,
AccessTokenHandle: defaultAkHandle,
Config: cfg,
AccessTokenContextHandle: defaultAkHandle,
}
return &MiniProgram{ctx}
}
// SetAccessTokenHandle 自定义 access_token 获取方式
func (miniProgram *MiniProgram) SetAccessTokenHandle(accessTokenHandle credential.AccessTokenHandle) {
miniProgram.ctx.AccessTokenHandle = accessTokenHandle
miniProgram.ctx.AccessTokenContextHandle = credential.AccessTokenCompatibleHandle{
AccessTokenHandle: accessTokenHandle,
}
}
// SetAccessTokenContextHandle 自定义 access_token 获取方式
func (miniProgram *MiniProgram) SetAccessTokenContextHandle(accessTokenContextHandle credential.AccessTokenContextHandle) {
miniProgram.ctx.AccessTokenContextHandle = accessTokenContextHandle
}
// GetContext get Context
@@ -155,3 +172,33 @@ func (miniProgram *MiniProgram) GetShipping() *order.Shipping {
func (miniProgram *MiniProgram) GetMiniDrama() *minidrama.MiniDrama {
return minidrama.NewMiniDrama(miniProgram.ctx)
}
// GetRedPacketCover 小程序微信红包封面 API
func (miniProgram *MiniProgram) GetRedPacketCover() *redpacketcover.RedPacketCover {
return redpacketcover.NewRedPacketCover(miniProgram.ctx)
}
// GetUpdatableMessage 小程序动态消息
func (miniProgram *MiniProgram) GetUpdatableMessage() *message.UpdatableMessage {
return message.NewUpdatableMessage(miniProgram.ctx)
}
// GetOperation 小程序运维中心
func (miniProgram *MiniProgram) GetOperation() *operation.Operation {
return operation.NewOperation(miniProgram.ctx)
}
// GetExpress 微信物流服务
func (miniProgram *MiniProgram) GetExpress() *express.Express {
return express.NewExpress(miniProgram.ctx)
}
// GetOCR OCR接口
func (miniProgram *MiniProgram) GetOCR() *ocr.OCR {
return ocr.NewOCR(miniProgram.ctx)
}
// GetIntracity 同城配送接口
func (miniProgram *MiniProgram) GetIntracity() *express.Express {
return express.NewExpress(miniProgram.ctx)
}

248
miniprogram/ocr/ocr.go Normal file
View File

@@ -0,0 +1,248 @@
package ocr
import (
"fmt"
"net/url"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/util"
)
const (
ocrIDCardURL = "https://api.weixin.qq.com/cv/ocr/idcard"
ocrBankCardURL = "https://api.weixin.qq.com/cv/ocr/bankcard"
ocrDrivingURL = "https://api.weixin.qq.com/cv/ocr/driving"
ocrDrivingLicenseURL = "https://api.weixin.qq.com/cv/ocr/drivinglicense"
ocrBizLicenseURL = "https://api.weixin.qq.com/cv/ocr/bizlicense"
ocrCommonURL = "https://api.weixin.qq.com/cv/ocr/comm"
)
// OCR struct
type OCR struct {
*context.Context
}
// coordinate 坐标
type coordinate struct {
X int64 `json:"x,omitempty"`
Y int64 `json:"y,omitempty"`
}
// position 位置
type position struct {
LeftTop coordinate `json:"left_top"`
RightTop coordinate `json:"right_top"`
RightBottom coordinate `json:"right_bottom"`
LeftBottom coordinate `json:"left_bottom"`
}
// imageSize 图片尺寸
type imageSize struct {
Width int64 `json:"w,omitempty"`
Height int64 `json:"h,omitempty"`
}
// ResDriving 行驶证返回结果
type ResDriving struct {
util.CommonError
PlateNumber string `json:"plate_num,omitempty"`
VehicleType string `json:"vehicle_type,omitempty"`
Owner string `json:"owner,omitempty"`
Address string `json:"addr,omitempty"`
UseCharacter string `json:"use_character,omitempty"`
Model string `json:"model,omitempty"`
Vin string `json:"vin,omitempty"`
EngineNumber string `json:"engine_num,omitempty"`
RegisterDate string `json:"register_date,omitempty"`
IssueDate string `json:"issue_date,omitempty"`
PlateNumberB string `json:"plate_num_b,omitempty"`
Record string `json:"record,omitempty"`
PassengersNumber string `json:"passengers_num,omitempty"`
TotalQuality string `json:"total_quality,omitempty"`
PrepareQuality string `json:"prepare_quality,omitempty"`
OverallSize string `json:"overall_size,omitempty"`
CardPositionFront map[string]position `json:"card_position_front,omitempty"`
CardPositionBack map[string]position `json:"card_position_back,omitempty"`
ImageSize imageSize `json:"img_size,omitempty"`
}
// ResIDCard 身份证返回结果
type ResIDCard struct {
util.CommonError
Type string `json:"type,omitempty"`
Name string `json:"name,omitempty"`
ID string `json:"id,omitempty"`
Address string `json:"addr,omitempty"`
Gender string `json:"gender,omitempty"`
Nationality string `json:"nationality,omitempty"`
ValidDate string `json:"valid_date,omitempty"`
}
// ResBankCard 银行卡返回结果
type ResBankCard struct {
util.CommonError
Number string `json:"number,omitempty"`
}
// ResDrivingLicense 驾驶证返回结果
type ResDrivingLicense struct {
util.CommonError
IDNumber string `json:"id_num,omitempty"`
Name string `json:"name,omitempty"`
Sex string `json:"sex,omitempty"`
Nationality string `json:"nationality,omitempty"`
Address string `json:"address,omitempty"`
Birthday string `json:"birth_date,omitempty"`
IssueDate string `json:"issue_date,omitempty"`
CarClass string `json:"car_class,omitempty"`
ValidFrom string `json:"valid_from,omitempty"`
ValidTo string `json:"valid_to,omitempty"`
OfficialSeal string `json:"official_seal,omitempty"`
}
// ResBizLicense 营业执照返回结果
type ResBizLicense struct {
util.CommonError
RegisterNumber string `json:"reg_num,omitempty"`
Serial string `json:"serial,omitempty"`
LegalRepresentative string `json:"legal_representative,omitempty"`
EnterpriseName string `json:"enterprise_name,omitempty"`
TypeOfOrganization string `json:"type_of_organization,omitempty"`
Address string `json:"address,omitempty"`
TypeOfEnterprise string `json:"type_of_enterprise,omitempty"`
BusinessScope string `json:"business_scope,omitempty"`
RegisteredCapital string `json:"registered_capital,omitempty"`
PaidInCapital string `json:"paid_in_capital,omitempty"`
ValidPeriod string `json:"valid_period,omitempty"`
RegisterDate string `json:"registered_date,omitempty"`
CertPosition map[string]position `json:"cert_position,omitempty"`
ImageSize imageSize `json:"img_size,omitempty"`
}
// ResCommon 公共印刷品返回结果
type ResCommon struct {
util.CommonError
Items []commonItem `json:"items,omitempty"`
ImageSize imageSize `json:"img_size,omitempty"`
}
// commonItem 公共元素
type commonItem struct {
Position position `json:"pos"`
Text string `json:"text"`
}
// NewOCR 实例
func NewOCR(c *context.Context) *OCR {
ocr := new(OCR)
ocr.Context = c
return ocr
}
// IDCard 身份证OCR识别接口
func (ocr *OCR) IDCard(path string) (resIDCard ResIDCard, err error) {
accessToken, err := ocr.GetAccessToken()
if err != nil {
return
}
response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrIDCardURL, url.QueryEscape(path), accessToken), "")
if err != nil {
return
}
err = util.DecodeWithError(response, &resIDCard, "OCRIDCard")
return
}
// BankCard 银行卡OCR识别接口
func (ocr *OCR) BankCard(path string) (resBankCard ResBankCard, err error) {
accessToken, err := ocr.GetAccessToken()
if err != nil {
return
}
response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrBankCardURL, url.QueryEscape(path), accessToken), "")
if err != nil {
return
}
err = util.DecodeWithError(response, &resBankCard, "OCRBankCard")
return
}
// Driving 行驶证OCR识别接口
func (ocr *OCR) Driving(path string) (resDriving ResDriving, err error) {
accessToken, err := ocr.GetAccessToken()
if err != nil {
return
}
response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrDrivingURL, url.QueryEscape(path), accessToken), "")
if err != nil {
return
}
err = util.DecodeWithError(response, &resDriving, "OCRDriving")
return
}
// DrivingLicense 驾驶证OCR识别接口
func (ocr *OCR) DrivingLicense(path string) (resDrivingLicense ResDrivingLicense, err error) {
accessToken, err := ocr.GetAccessToken()
if err != nil {
return
}
response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrDrivingLicenseURL, url.QueryEscape(path), accessToken), "")
if err != nil {
return
}
err = util.DecodeWithError(response, &resDrivingLicense, "OCRDrivingLicense")
return
}
// BizLicense 营业执照OCR识别接口
func (ocr *OCR) BizLicense(path string) (resBizLicense ResBizLicense, err error) {
accessToken, err := ocr.GetAccessToken()
if err != nil {
return
}
response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrBizLicenseURL, url.QueryEscape(path), accessToken), "")
if err != nil {
return
}
err = util.DecodeWithError(response, &resBizLicense, "OCRBizLicense")
return
}
// Common 通用印刷体OCR识别接口
func (ocr *OCR) Common(path string) (resCommon ResCommon, err error) {
accessToken, err := ocr.GetAccessToken()
if err != nil {
return
}
response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrCommonURL, url.QueryEscape(path), accessToken), "")
if err != nil {
return
}
err = util.DecodeWithError(response, &resCommon, "OCRCommon")
return
}

View File

@@ -0,0 +1,456 @@
package operation
import (
"fmt"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/util"
)
const (
// getDomainInfoURL 查询域名配置
getDomainInfoURL = "https://api.weixin.qq.com/wxa/getwxadevinfo?access_token=%s"
// getPerformanceURL 获取性能数据
getPerformanceURL = "https://api.weixin.qq.com/wxaapi/log/get_performance?access_token=%s"
// getSceneListURL 获取访问来源
getSceneListURL = "https://api.weixin.qq.com/wxaapi/log/get_scene?access_token=%s"
// getVersionListURL 获取客户端版本
getVersionListURL = "https://api.weixin.qq.com/wxaapi/log/get_client_version?access_token=%s"
// realTimeLogSearchURL 查询实时日志
realTimeLogSearchURL = "https://api.weixin.qq.com/wxaapi/userlog/userlog_search?%s"
// getFeedbackListURL 获取用户反馈列表
getFeedbackListURL = "https://api.weixin.qq.com/wxaapi/feedback/list?%s"
// getJsErrDetailURL 查询js错误详情
getJsErrDetailURL = "https://api.weixin.qq.com/wxaapi/log/jserr_detail?access_token=%s"
// getJsErrListURL 查询错误列表
getJsErrListURL = "https://api.weixin.qq.com/wxaapi/log/jserr_list?access_token=%s"
// getGrayReleasePlanURL 获取分阶段发布详情
getGrayReleasePlanURL = "https://api.weixin.qq.com/wxa/getgrayreleaseplan?access_token=%s"
)
// Operation 运维中心
type Operation struct {
*context.Context
}
// NewOperation 实例化
func NewOperation(ctx *context.Context) *Operation {
return &Operation{ctx}
}
// GetDomainInfoRequest 查询域名配置请求
type GetDomainInfoRequest struct {
Action string `json:"action"`
}
// GetDomainInfoResponse 查询域名配置响应
type GetDomainInfoResponse struct {
util.CommonError
RequestDomain []string `json:"requestdomain"`
WsRequestDomain []string `json:"wsrequestdomain"`
UploadDomain []string `json:"uploaddomain"`
DownloadDomain []string `json:"downloaddomain"`
UDPDomain []string `json:"udpdomain"`
BizDomain []string `json:"bizdomain"`
}
// GetDomainInfo 查询域名配置
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/getDomainInfo.html
func (o *Operation) GetDomainInfo(req *GetDomainInfoRequest) (res GetDomainInfoResponse, err error) {
var accessToken string
if accessToken, err = o.GetAccessToken(); err != nil {
return
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(getDomainInfoURL, accessToken), req); err != nil {
return
}
err = util.DecodeWithError(response, &res, "GetDomainInfo")
return
}
// GetPerformanceRequest 获取性能数据请求
type GetPerformanceRequest struct {
CostTimeType int64 `json:"cost_time_type"`
DefaultStartTime int64 `json:"default_start_time"`
DefaultEndTime int64 `json:"default_end_time"`
Device string `json:"device"`
IsDownloadCode string `json:"is_download_code"`
Scene string `json:"scene"`
NetworkType string `json:"networktype"`
}
// GetPerformanceResponse 获取性能数据响应
type GetPerformanceResponse struct {
util.CommonError
DefaultTimeData string `json:"default_time_data"`
CompareTimeData string `json:"compare_time_data"`
}
// PerformanceDefaultTimeData 查询数据
type PerformanceDefaultTimeData struct {
List []DefaultTimeDataItem `json:"list"`
}
// DefaultTimeDataItem 查询数据
type DefaultTimeDataItem struct {
RefData string `json:"ref_data"`
CostTimeType int64 `json:"cost_time_type"`
CostTime int64 `json:"cost_time"`
}
// GetPerformance 获取性能数据
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/getPerformance.html
func (o *Operation) GetPerformance(req *GetPerformanceRequest) (res GetPerformanceResponse, err error) {
var accessToken string
if accessToken, err = o.GetAccessToken(); err != nil {
return
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(getPerformanceURL, accessToken), req); err != nil {
return
}
err = util.DecodeWithError(response, &res, "GetPerformance")
return
}
// GetSceneListResponse 获取访问来源响应
type GetSceneListResponse struct {
util.CommonError
Scene []Scene `json:"scene"`
}
// Scene 访问来源
type Scene struct {
Name string `json:"name"`
Value string `json:"value"`
}
// GetSceneList 获取访问来源
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/getSceneList.html
func (o *Operation) GetSceneList() (res GetSceneListResponse, err error) {
var accessToken string
if accessToken, err = o.GetAccessToken(); err != nil {
return
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(getSceneListURL, accessToken)); err != nil {
return
}
err = util.DecodeWithError(response, &res, "GetSceneList")
return
}
// GetVersionListResponse 获取客户端版本响应
type GetVersionListResponse struct {
util.CommonError
CvList []ClientVersion `json:"cvlist"`
}
// ClientVersion 客户端版本
type ClientVersion struct {
Type int64 `json:"type"`
ClientVersionList []string `json:"client_version_list"`
}
// GetVersionList 获取客户端版本
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/getVersionList.html
func (o *Operation) GetVersionList() (res GetVersionListResponse, err error) {
var accessToken string
if accessToken, err = o.GetAccessToken(); err != nil {
return
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(getVersionListURL, accessToken)); err != nil {
return
}
err = util.DecodeWithError(response, &res, "GetVersionList")
return
}
// RealTimeLogSearchRequest 查询实时日志请求
type RealTimeLogSearchRequest struct {
Date string
BeginTime int64
EndTime int64
Start int64
Limit int64
Level int64
TraceID string
URL string
ID string
FilterMsg string
}
// RealTimeLogSearchResponse 查询实时日志响应
type RealTimeLogSearchResponse struct {
util.CommonError
Data RealTimeLogSearchData `json:"data"`
}
// RealTimeLogSearchData 日志数据和日志条数总量
type RealTimeLogSearchData struct {
List []RealTimeLogSearchDataList `json:"list"`
Total int64 `json:"total"`
}
// RealTimeLogSearchDataList 日志数据列表
type RealTimeLogSearchDataList struct {
Level int64 `json:"level"`
LibraryVersion string `json:"libraryVersion"`
ClientVersion string `json:"clientVersion"`
ID string `json:"id"`
Timestamp int64 `json:"timestamp"`
Platform int64 `json:"platform"`
URL string `json:"url"`
TraceID string `json:"traceid"`
FilterMsg string `json:"filterMsg"`
Msg []RealTimeLogSearchDataListMsg `json:"msg"`
}
// RealTimeLogSearchDataListMsg 日志内容数组
type RealTimeLogSearchDataListMsg struct {
Time int64 `json:"time"`
Level int64 `json:"level"`
Msg []string `json:"msg"`
}
// RealTimeLogSearch 查询实时日志
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/realtimelogSearch.html
func (o *Operation) RealTimeLogSearch(req *RealTimeLogSearchRequest) (res RealTimeLogSearchResponse, err error) {
var accessToken string
if accessToken, err = o.GetAccessToken(); err != nil {
return
}
params := map[string]interface{}{
"access_token": accessToken,
"date": req.Date,
"begintime": req.BeginTime,
"endtime": req.EndTime,
}
if req.Start > 0 {
params["start"] = req.Start
}
if req.Limit > 0 {
params["limit"] = req.Limit
}
if req.TraceID != "" {
params["traceId"] = req.TraceID
}
if req.URL != "" {
params["url"] = req.URL
}
if req.ID != "" {
params["id"] = req.ID
}
if req.FilterMsg != "" {
params["filterMsg"] = req.FilterMsg
}
if req.Level > 0 {
params["level"] = req.Level
}
query := util.Query(params)
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(realTimeLogSearchURL, query)); err != nil {
return
}
err = util.DecodeWithError(response, &res, "RealTimeLogSearch")
return
}
// GetFeedbackListRequest 获取用户反馈列表请求
type GetFeedbackListRequest struct {
Page int64
Num int64
Type int64
}
// GetFeedbackListResponse 获取用户反馈列表响应
type GetFeedbackListResponse struct {
util.CommonError
TotalNum int64 `json:"total_num"`
List []Feedback `json:"list"`
}
// Feedback 反馈列表
type Feedback struct {
RecordID int64 `json:"record_id"`
CreateTime int64 `json:"create_time"`
Content string `json:"content"`
Phone string `json:"phone"`
OpenID string `json:"openid"`
Nickname string `json:"nickname"`
HeadURL string `json:"head_url"`
Type int64 `json:"type"`
MediaIDS []string `json:"mediaIds"`
SystemInfo string `json:"systemInfo"`
}
// GetFeedbackList 获取用户反馈列表
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/getFeedback.html
func (o *Operation) GetFeedbackList(req *GetFeedbackListRequest) (res GetFeedbackListResponse, err error) {
var accessToken string
if accessToken, err = o.GetAccessToken(); err != nil {
return
}
params := map[string]interface{}{
"access_token": accessToken,
"page": req.Page,
"num": req.Num,
}
if req.Type > 0 {
params["type"] = req.Type
}
query := util.Query(params)
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(getFeedbackListURL, query)); err != nil {
return
}
err = util.DecodeWithError(response, &res, "GetFeedbackList")
return
}
// GetJsErrDetailRequest 查询js错误详情请求
type GetJsErrDetailRequest struct {
StartTime string `json:"startTime"`
EndTime string `json:"endTime"`
ErrorMsgMd5 string `json:"errorMsgMd5"`
ErrorStackMd5 string `json:"errorStackMd5"`
AppVersion string `json:"appVersion"`
SdkVersion string `json:"sdkVersion"`
OsName string `json:"osName"`
ClientVersion string `json:"clientVersion"`
OpenID string `json:"openid"`
Offset int64 `json:"offset"`
Limit int64 `json:"limit"`
Desc string `json:"desc"`
}
// GetJsErrDetailResponse 查询js错误详情响应
type GetJsErrDetailResponse struct {
util.CommonError
TotalCount int64 `json:"totalCount"`
OpenID string `json:"openid"`
Data []JsErrDetailData `json:"data"`
}
// JsErrDetailData 错误列表
type JsErrDetailData struct {
Count string `json:"Count"`
SdkVersion string `json:"sdkVersion"`
ClientVersion string `json:"ClientVersion"`
ErrorStackMd5 string `json:"errorStackMd5"`
TimeStamp string `json:"TimeStamp"`
AppVersion string `json:"appVersion"`
ErrorMsgMd5 string `json:"errorMsgMd5"`
ErrorMsg string `json:"errorMsg"`
ErrorStack string `json:"errorStack"`
Ds string `json:"Ds"`
OsName string `json:"OsName"`
OpenID string `json:"openId"`
PluginVersion string `json:"pluginversion"`
AppID string `json:"appId"`
DeviceModel string `json:"DeviceModel"`
Source string `json:"source"`
Route string `json:"route"`
Uin string `json:"Uin"`
Nickname string `json:"nickname"`
}
// GetJsErrDetail 查询js错误详情
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/getJsErrDetail.html
func (o *Operation) GetJsErrDetail(req *GetJsErrDetailRequest) (res GetJsErrDetailResponse, err error) {
var accessToken string
if accessToken, err = o.GetAccessToken(); err != nil {
return
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(getJsErrDetailURL, accessToken), req); err != nil {
return
}
err = util.DecodeWithError(response, &res, "GetJsErrDetail")
return
}
// GetJsErrListRequest 查询错误列表请求
type GetJsErrListRequest struct {
AppVersion string `json:"appVersion"`
ErrType string `json:"errType"`
StartTime string `json:"startTime"`
EndTime string `json:"endTime"`
Keyword string `json:"keyword"`
OpenID string `json:"openid"`
OrderBy string `json:"orderby"`
Desc string `json:"desc"`
Offset int64 `json:"offset"`
Limit int64 `json:"limit"`
}
// GetJsErrListResponse 查询错误列表响应
type GetJsErrListResponse struct {
util.CommonError
TotalCount int64 `json:"totalCount"`
OpenID string `json:"openid"`
Data []JsErrListData `json:"data"`
}
// JsErrListData 错误列表
type JsErrListData struct {
ErrorMsgMd5 string `json:"errorMsgMd5"`
ErrorMsg string `json:"errorMsg"`
Uv int64 `json:"uv"`
Pv int64 `json:"pv"`
ErrorStackMd5 string `json:"errorStackMd5"`
ErrorStack string `json:"errorStack"`
PvPercent string `json:"pvPercent"`
UvPercent string `json:"uvPercent"`
}
// GetJsErrList 查询错误列表
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/getJsErrList.html
func (o *Operation) GetJsErrList(req *GetJsErrListRequest) (res GetJsErrListResponse, err error) {
var accessToken string
if accessToken, err = o.GetAccessToken(); err != nil {
return
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(getJsErrListURL, accessToken), req); err != nil {
return
}
err = util.DecodeWithError(response, &res, "GetJsErrList")
return
}
// GetGrayReleasePlanResponse 获取分阶段发布详情响应
type GetGrayReleasePlanResponse struct {
util.CommonError
GrayReleasePlan GrayReleasePlanDetail `json:"gray_release_plan"`
}
// GrayReleasePlanDetail 分阶段发布计划详情
type GrayReleasePlanDetail struct {
Status int64 `json:"status"`
CreateTimestamp int64 `json:"create_timestamp"`
GrayPercentage int64 `json:"gray_percentage"`
SupportExperiencerFirst bool `json:"support_experiencer_first"`
SupportDebugerFirst bool `json:"support_debuger_first"`
}
// GetGrayReleasePlan 获取分阶段发布详情
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/operation/getGrayReleasePlan.html
func (o *Operation) GetGrayReleasePlan() (res GetGrayReleasePlanResponse, err error) {
var accessToken string
if accessToken, err = o.GetAccessToken(); err != nil {
return
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(getGrayReleasePlanURL, accessToken)); err != nil {
return
}
err = util.DecodeWithError(response, &res, "GetGrayReleasePlan")
return
}

View File

@@ -103,11 +103,8 @@ func (s *Privacy) GetPrivacySetting(privacyVer int) (GetPrivacySettingResponse,
}
// 返回错误信息
var result GetPrivacySettingResponse
if err = util.DecodeWithError(response, &result, "getprivacysetting"); err != nil {
return GetPrivacySettingResponse{}, err
}
return result, nil
err = util.DecodeWithError(response, &result, "getprivacysetting")
return result, err
}
// SetPrivacySetting 更新小程序权限配置
@@ -130,11 +127,7 @@ func (s *Privacy) SetPrivacySetting(privacyVer int, ownerSetting OwnerSetting, s
}
// 返回错误信息
if err = util.DecodeWithCommonError(response, "setprivacysetting"); err != nil {
return err
}
return err
return util.DecodeWithCommonError(response, "setprivacysetting")
}
// UploadPrivacyExtFileResponse 上传权限定义模板响应参数
@@ -159,9 +152,6 @@ func (s *Privacy) UploadPrivacyExtFile(fileData []byte) (UploadPrivacyExtFileRes
// 返回错误信息
var result UploadPrivacyExtFileResponse
if err = util.DecodeWithError(response, &result, "setprivacysetting"); err != nil {
return UploadPrivacyExtFileResponse{}, err
}
err = util.DecodeWithError(response, &result, "setprivacysetting")
return result, err
}

View File

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

View File

@@ -0,0 +1,59 @@
package redpacketcover
import (
"fmt"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/util"
)
const (
getRedPacketCoverURL = "https://api.weixin.qq.com/redpacketcover/wxapp/cover_url/get_by_token?access_token=%s"
)
// RedPacketCover struct
type RedPacketCover struct {
*context.Context
}
// NewRedPacketCover 实例
func NewRedPacketCover(context *context.Context) *RedPacketCover {
redPacketCover := new(RedPacketCover)
redPacketCover.Context = context
return redPacketCover
}
// GetRedPacketCoverRequest 获取微信红包封面参数
type GetRedPacketCoverRequest struct {
// openid 可领取用户的openid
OpenID string `json:"openid"`
// ctoken 在红包封面平台获取发放ctoken需要指定可以发放的appid
CToken string `json:"ctoken"`
}
// GetRedPacketCoverResp 获取微信红包封面
type GetRedPacketCoverResp struct {
util.CommonError
Data struct {
URL string `json:"url"`
} `json:"data"` // 唯一请求标识
}
// GetRedPacketCoverURL 获得指定用户可以领取的红包封面链接。获取参数ctoken参考微信红包封面开放平台
// 文档地址: https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/red-packet-cover/getRedPacketCoverUrl.html
func (cover *RedPacketCover) GetRedPacketCoverURL(coderParams GetRedPacketCoverRequest) (res GetRedPacketCoverResp, err error) {
accessToken, err := cover.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(getRedPacketCoverURL, accessToken)
response, err := util.PostJSON(uri, coderParams)
if err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &res, "GetRedPacketCoverURL")
return
}

View File

@@ -1,6 +1,7 @@
package security
import (
context2 "context"
"fmt"
"strconv"
@@ -51,12 +52,7 @@ func (security *Security) MediaCheckAsyncV1(in *MediaCheckAsyncV1Request) (trace
TraceID string `json:"trace_id"`
}
err = util.DecodeWithError(response, &res, "MediaCheckAsyncV1")
if err != nil {
return
}
traceID = res.TraceID
return
return res.TraceID, err
}
// MediaCheckAsyncRequest 图片/音频异步校验请求参数
@@ -69,7 +65,12 @@ type MediaCheckAsyncRequest struct {
// MediaCheckAsync 异步校验图片/音频是否含有违法违规内容
func (security *Security) MediaCheckAsync(in *MediaCheckAsyncRequest) (traceID string, err error) {
accessToken, err := security.GetAccessToken()
return security.MediaCheckAsyncContext(context2.Background(), in)
}
// MediaCheckAsyncContext 异步校验图片/音频是否含有违法违规内容
func (security *Security) MediaCheckAsyncContext(ctx context2.Context, in *MediaCheckAsyncRequest) (traceID string, err error) {
accessToken, err := security.GetAccessTokenContext(ctx)
if err != nil {
return
}
@@ -82,7 +83,7 @@ func (security *Security) MediaCheckAsync(in *MediaCheckAsyncRequest) (traceID s
req.Version = 2
uri := fmt.Sprintf(mediaCheckAsyncURL, accessToken)
response, err := util.PostJSON(uri, req)
response, err := util.PostJSONContext(ctx, uri, req)
if err != nil {
return
}
@@ -93,12 +94,7 @@ func (security *Security) MediaCheckAsync(in *MediaCheckAsyncRequest) (traceID s
TraceID string `json:"trace_id"`
}
err = util.DecodeWithError(response, &res, "MediaCheckAsync")
if err != nil {
return
}
traceID = res.TraceID
return
return res.TraceID, err
}
// ImageCheckV1 校验一张图片是否含有违法违规内容(同步)
@@ -232,7 +228,12 @@ func (security *Security) MsgCheckV1(content string) (res MsgCheckResponse, err
// MsgCheck 检查一段文本是否含有违法违规内容
func (security *Security) MsgCheck(in *MsgCheckRequest) (res MsgCheckResponse, err error) {
accessToken, err := security.GetAccessToken()
return security.MsgCheckContext(context2.Background(), in)
}
// MsgCheckContext 检查一段文本是否含有违法违规内容
func (security *Security) MsgCheckContext(ctx context2.Context, in *MsgCheckRequest) (res MsgCheckResponse, err error) {
accessToken, err := security.GetAccessTokenContext(ctx)
if err != nil {
return
}
@@ -245,7 +246,7 @@ func (security *Security) MsgCheck(in *MsgCheckRequest) (res MsgCheckResponse, e
req.Version = 2
uri := fmt.Sprintf(msgCheckURL, accessToken)
response, err := util.PostJSON(uri, req)
response, err := util.PostJSONContext(ctx, uri, req)
if err != nil {
return
}

View File

@@ -60,11 +60,7 @@ func (shortLink *ShortLink) generate(shortLinkParams ShortLinker) (string, error
// 使用通用方法返回错误
var res resShortLinker
err = util.DecodeWithError(response, &res, "GenerateShortLink")
if err != nil {
return "", err
}
return res.Link, nil
return res.Link, err
}
// GenerateShortLinkPermanent 生成永久 shortLink

View File

@@ -1,6 +1,7 @@
package subscribe
import (
"encoding/json"
"fmt"
"github.com/silenceper/wechat/v2/miniprogram/context"
@@ -11,22 +12,30 @@ const (
// 发送订阅消息
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.send.html
subscribeSendURL = "https://api.weixin.qq.com/cgi-bin/message/subscribe/send"
// 获取当前帐号下的个人模板列表
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.getTemplateList.html
getTemplateURL = "https://api.weixin.qq.com/wxaapi/newtmpl/gettemplate"
// 添加订阅模板
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.addTemplate.html
addTemplateURL = "https://api.weixin.qq.com/wxaapi/newtmpl/addtemplate"
// 删除私有模板
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.deleteTemplate.html
delTemplateURL = "https://api.weixin.qq.com/wxaapi/newtmpl/deltemplate"
// 统一服务消息
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/uniform-message/uniformMessage.send.html
uniformMessageSend = "https://api.weixin.qq.com/cgi-bin/message/wxopen/template/uniform_send"
// getCategoryURL 获取类目
getCategoryURL = "https://api.weixin.qq.com/wxaapi/newtmpl/getcategory?access_token=%s"
// getPubTemplateKeyWordsByIDURL 获取关键词列表
getPubTemplateKeyWordsByIDURL = "https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatekeywords?access_token=%s&tid=%s"
// getPubTemplateTitleListURL 获取所属类目下的公共模板
getPubTemplateTitleListURL = "https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatetitles?access_token=%s&ids=%s&start=%d&limit=%d"
// setUserNotifyURL 激活与更新服务卡片
setUserNotifyURL = "https://api.weixin.qq.com/wxa/set_user_notify?access_token=%s"
// setUserNotifyExtURL 更新服务卡片扩展信息
setUserNotifyExtURL = "https://api.weixin.qq.com/wxa/set_user_notifyext?access_token=%s"
// getUserNotifyURL 查询服务卡片状态
getUserNotifyURL = "https://api.weixin.qq.com/wxa/get_user_notify?access_token=%s"
)
// Subscribe 订阅消息
@@ -57,11 +66,18 @@ type DataItem struct {
// TemplateItem template item
type TemplateItem struct {
PriTmplID string `json:"priTmplId"`
Title string `json:"title"`
Content string `json:"content"`
Example string `json:"example"`
Type int64 `json:"type"`
PriTmplID string `json:"priTmplId"`
Title string `json:"title"`
Content string `json:"content"`
Example string `json:"example"`
Type int64 `json:"type"`
KeywordEnumValueList []KeywordEnumValue `json:"keywordEnumValueList"`
}
// KeywordEnumValue 枚举参数值范围
type KeywordEnumValue struct {
EnumValueList []string `json:"enumValueList"`
KeywordCode string `json:"keywordCode"`
}
// TemplateList template list
@@ -70,6 +86,13 @@ type TemplateList struct {
Data []TemplateItem `json:"data"`
}
// resTemplateSend 发送获取 msg id
type resTemplateSend struct {
util.CommonError
MsgID int64 `json:"msgid"`
}
// Send 发送订阅消息
func (s *Subscribe) Send(msg *Message) (err error) {
var accessToken string
@@ -85,6 +108,33 @@ func (s *Subscribe) Send(msg *Message) (err error) {
return util.DecodeWithCommonError(response, "Send")
}
// SendGetMsgID 发送订阅消息返回 msgid
func (s *Subscribe) SendGetMsgID(msg *Message) (msgID int64, err error) {
var accessToken string
accessToken, err = s.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", subscribeSendURL, accessToken)
response, err := util.PostJSON(uri, msg)
if err != nil {
return
}
var result resTemplateSend
if err = json.Unmarshal(response, &result); err != nil {
return
}
if result.ErrCode != 0 {
err = fmt.Errorf("template msg send error : errcode=%v , errmsg=%v", result.ErrCode, result.ErrMsg)
return
}
msgID = result.MsgID
return
}
// ListTemplates 获取当前帐号下的个人模板列表
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.getTemplateList.html
func (s *Subscribe) ListTemplates() (*TemplateList, error) {
@@ -168,11 +218,7 @@ func (s *Subscribe) Add(ShortID string, kidList []int, sceneDesc string) (templa
}
var result resSubscribeAdd
err = util.DecodeWithError(response, &result, "AddSubscribe")
if err != nil {
return
}
templateID = result.TemplateID
return
return result.TemplateID, err
}
// Delete 删除私有模板
@@ -193,3 +239,200 @@ func (s *Subscribe) Delete(templateID string) (err error) {
}
return util.DecodeWithCommonError(response, "DeleteSubscribe")
}
// GetCategoryResponse 获取类目响应
type GetCategoryResponse struct {
util.CommonError
Data []Category `json:"data"`
}
// Category 类目
type Category struct {
ID int64 `json:"id"`
Name string `json:"name"`
}
// GetCategory 获取类目
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/subscribe-message/getCategory.html
func (s *Subscribe) GetCategory() ([]Category, error) {
var (
accessToken string
err error
)
if accessToken, err = s.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(getCategoryURL, accessToken)); err != nil {
return nil, err
}
result := &GetCategoryResponse{}
err = util.DecodeWithError(response, result, "GetCategory")
return result.Data, err
}
// GetPubTemplateKeywordsByIDResponse 获取关键词列表响应
type GetPubTemplateKeywordsByIDResponse struct {
util.CommonError
Count int64 `json:"count"`
Data []PubTemplateKeywords `json:"data"`
}
// PubTemplateKeywords 关键词
type PubTemplateKeywords struct {
KID int64 `json:"kid"`
Name string `json:"name"`
Example string `json:"example"`
Rule string `json:"rule"`
}
// GetPubTemplateKeywordsByID 获取关键词列表
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/subscribe-message/getPubTemplateKeyWordsById.html
func (s *Subscribe) GetPubTemplateKeywordsByID(tid string) (*GetPubTemplateKeywordsByIDResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = s.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(getPubTemplateKeyWordsByIDURL, accessToken, tid)); err != nil {
return nil, err
}
result := &GetPubTemplateKeywordsByIDResponse{}
err = util.DecodeWithError(response, result, "GetPubTemplateKeywordsByID")
return result, err
}
// GetPubTemplateTitleListRequest 获取所属类目下的公共模板请求
type GetPubTemplateTitleListRequest struct {
Start int64
Limit int64
IDs string
}
// GetPubTemplateTitleListResponse 获取所属类目下的公共模板响应
type GetPubTemplateTitleListResponse struct {
util.CommonError
Count int64 `json:"count"`
Data []PubTemplateTitle `json:"data"`
}
// PubTemplateTitle 模板标题
type PubTemplateTitle struct {
Type int64 `json:"type"`
TID string `json:"tid"`
Title string `json:"title"`
CategoryID string `json:"categoryId"`
}
// GetPubTemplateTitleList 获取所属类目下的公共模板
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/subscribe-message/getPubTemplateTitleList.html
func (s *Subscribe) GetPubTemplateTitleList(req *GetPubTemplateTitleListRequest) (*GetPubTemplateTitleListResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = s.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(getPubTemplateTitleListURL, accessToken, req.IDs, req.Start, req.Limit)); err != nil {
return nil, err
}
result := &GetPubTemplateTitleListResponse{}
err = util.DecodeWithError(response, result, "GetPubTemplateTitleList")
return result, err
}
// SetUserNotifyRequest 激活与更新服务卡片请求
type SetUserNotifyRequest struct {
OpenID string `json:"openid"`
NotifyType int64 `json:"notify_type"`
NotifyCode string `json:"notify_code"`
ContentJSON string `json:"content_json"`
CheckJSON string `json:"check_json,omitempty"`
}
// SetUserNotify 激活与更新服务卡片
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/subscribe-message/setUserNotify.html
func (s *Subscribe) SetUserNotify(req *SetUserNotifyRequest) error {
var (
accessToken string
err error
)
if accessToken, err = s.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(setUserNotifyURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "SetUserNotify")
}
// SetUserNotifyExtRequest 更新服务卡片扩展信息请求
type SetUserNotifyExtRequest struct {
OpenID string `json:"openid"`
NotifyType int64 `json:"notify_type"`
NotifyCode string `json:"notify_code"`
ExtJSON string `json:"ext_json"`
}
// SetUserNotifyExt 更新服务卡片扩展信息
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/subscribe-message/setUserNotifyExt.html
func (s *Subscribe) SetUserNotifyExt(req *SetUserNotifyExtRequest) error {
var (
accessToken string
err error
)
if accessToken, err = s.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(setUserNotifyExtURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "SetUserNotifyExt")
}
// GetUserNotifyRequest 查询服务卡片状态请求
type GetUserNotifyRequest struct {
OpenID string `json:"openid"`
NotifyType int64 `json:"notify_type"`
NotifyCode string `json:"notify_code"`
}
// GetUserNotifyResponse 查询服务卡片状态响应
type GetUserNotifyResponse struct {
util.CommonError
NotifyInfo NotifyInfo `json:"notify_info"`
}
// NotifyInfo 卡片状态
type NotifyInfo struct {
NotifyType int64 `json:"notify_type"`
ContentJSON string `json:"content_json"`
CodeState int64 `json:"code_state"`
CodeExpireTime int64 `json:"code_expire_time"`
}
// GetUserNotify 查询服务卡片状态
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-message-management/subscribe-message/getUserNotify.html
func (s *Subscribe) GetUserNotify(req *GetUserNotifyRequest) (*GetUserNotifyResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = s.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(getUserNotifyURL, accessToken), req); err != nil {
return nil, err
}
result := &GetUserNotifyResponse{}
err = util.DecodeWithError(response, result, "GetUserNotify")
return result, err
}

View File

@@ -6,7 +6,13 @@ import (
"github.com/silenceper/wechat/v2/util"
)
const queryURL = "https://api.weixin.qq.com/wxa/query_urllink"
const queryURL = "https://api.weixin.qq.com/wxa/query_urllink?access_token=%s"
// ULQueryRequest 查询加密URLLink请求
type ULQueryRequest struct {
URLLink string `json:"url_link"`
QueryType int `json:"query_type"`
}
// ULQueryResult 返回的结果
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-link/urllink.query.html 返回值
@@ -28,25 +34,35 @@ type ULQueryResult struct {
ResourceAppid string `json:"resource_appid"`
} `json:"cloud_base"`
} `json:"url_link_info"`
VisitOpenid string `json:"visit_openid"`
VisitOpenid string `json:"visit_openid"`
QuotaInfo QuotaInfo `json:"quota_info"`
}
// QuotaInfo quota 配置
type QuotaInfo struct {
RemainVisitQuota int64 `json:"remain_visit_quota"`
}
// Query 查询小程序 url_link 配置。
func (u *URLLink) Query(urlLink string) (*ULQueryResult, error) {
accessToken, err := u.GetAccessToken()
if err != nil {
return nil, err
}
uri := fmt.Sprintf("%s?access_token=%s", queryURL, accessToken)
response, err := util.PostJSON(uri, map[string]string{"url_link": urlLink})
if err != nil {
return nil, err
}
var resp ULQueryResult
err = util.DecodeWithError(response, &resp, "URLLink.Query")
if err != nil {
return nil, err
}
return &resp, nil
return u.QueryWithType(&ULQueryRequest{URLLink: urlLink})
}
// QueryWithType 查询加密URLLink
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/qrcode-link/url-link/queryUrlLink.html
func (u *URLLink) QueryWithType(req *ULQueryRequest) (*ULQueryResult, error) {
var (
accessToken string
err error
)
if accessToken, err = u.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(queryURL, accessToken), req); err != nil {
return nil, err
}
result := &ULQueryResult{}
err = util.DecodeWithError(response, result, "URLLink.Query")
return result, err
}

View File

@@ -65,8 +65,5 @@ func (u *URLLink) Generate(params *ULParams) (string, error) {
}
var resp ULResult
err = util.DecodeWithError(response, &resp, "URLLink.Generate")
if err != nil {
return "", err
}
return resp.URLLink, nil
return resp.URLLink, err
}

View File

@@ -14,7 +14,8 @@ const (
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-scheme/urlscheme.query.html#参数
type QueryScheme struct {
// 小程序 scheme 码
Scheme string `json:"scheme"`
Scheme string `json:"scheme"`
QueryType int `json:"query_type"`
}
// SchemeInfo scheme 配置
@@ -33,38 +34,47 @@ type SchemeInfo struct {
EnvVersion EnvVersion `json:"env_version"`
}
// resQueryScheme 返回结构体
// QuotaInfo quota 配置
type QuotaInfo struct {
RemainVisitQuota int64 `json:"remain_visit_quota"`
}
// ResQueryScheme 返回结构体
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-scheme/urlscheme.query.html#参数
type resQueryScheme struct {
type ResQueryScheme struct {
// 通用错误
*util.CommonError
util.CommonError
// scheme 配置
SchemeInfo SchemeInfo `json:"scheme_info"`
// 访问该链接的openid没有用户访问过则为空字符串
VisitOpenid string `json:"visit_openid"`
VisitOpenid string `json:"visit_openid"`
QuotaInfo QuotaInfo `json:"quota_info"`
}
// QueryScheme 查询小程序 scheme 码
func (u *URLScheme) QueryScheme(querySchemeParams QueryScheme) (schemeInfo SchemeInfo, visitOpenid string, err error) {
var accessToken string
accessToken, err = u.GetAccessToken()
res, err := u.QuerySchemeWithRes(querySchemeParams)
if err != nil {
return
}
urlStr := fmt.Sprintf(querySchemeURL, accessToken)
var response []byte
response, err = util.PostJSON(urlStr, querySchemeParams)
if err != nil {
return
}
// 使用通用方法返回错误
var res resQueryScheme
err = util.DecodeWithError(response, &res, "QueryScheme")
if err != nil {
return
}
return res.SchemeInfo, res.VisitOpenid, nil
return res.SchemeInfo, res.VisitOpenid, err
}
// QuerySchemeWithRes 查询scheme码
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/qrcode-link/url-scheme/queryScheme.html
func (u *URLScheme) QuerySchemeWithRes(req QueryScheme) (*ResQueryScheme, error) {
var (
accessToken string
err error
)
if accessToken, err = u.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(querySchemeURL, accessToken), req); err != nil {
return nil, err
}
result := &ResQueryScheme{}
err = util.DecodeWithError(response, result, "QueryScheme")
return result, err
}

View File

@@ -17,7 +17,12 @@ func NewURLScheme(ctx *context.Context) *URLScheme {
return &URLScheme{Context: ctx}
}
const generateURL = "https://api.weixin.qq.com/wxa/generatescheme"
const (
// generateURL 获取加密scheme码
generateURL = "https://api.weixin.qq.com/wxa/generatescheme"
// generateNFCURL 获取 NFC 的小程序 scheme
generateNFCURL = "https://api.weixin.qq.com/wxa/generatenfcscheme?access_token=%s"
)
// TExpireType 失效类型 (指定时间戳/指定间隔)
type TExpireType int
@@ -50,10 +55,13 @@ type JumpWxa struct {
// USParams 请求参数
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-scheme/urlscheme.generate.html#请求参数
type USParams struct {
JumpWxa *JumpWxa `json:"jump_wxa"`
ExpireType TExpireType `json:"expire_type"`
ExpireTime int64 `json:"expire_time"`
ExpireInterval int `json:"expire_interval"`
JumpWxa *JumpWxa `json:"jump_wxa,omitempty"`
ExpireType TExpireType `json:"expire_type,omitempty"`
ExpireTime int64 `json:"expire_time,omitempty"`
ExpireInterval int `json:"expire_interval,omitempty"`
IsExpire bool `json:"is_expire,omitempty"`
ModelID string `json:"model_id,omitempty"`
Sn string `json:"sn,omitempty"`
}
// USResult 返回的结果
@@ -78,8 +86,24 @@ func (u *URLScheme) Generate(params *USParams) (string, error) {
}
var resp USResult
err = util.DecodeWithError(response, &resp, "URLScheme.Generate")
if err != nil {
return resp.OpenLink, err
}
// GenerateNFC 获取 NFC 的小程序 scheme
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/qrcode-link/url-scheme/generateNFCScheme.html
func (u *URLScheme) GenerateNFC(params *USParams) (string, error) {
var (
accessToken string
err error
)
if accessToken, err = u.GetAccessToken(); err != nil {
return "", err
}
return resp.OpenLink, nil
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(generateNFCURL, accessToken), params); err != nil {
return "", err
}
result := &USResult{}
err = util.DecodeWithError(response, result, "URLScheme.GenerateNFC")
return result.OpenLink, err
}

View File

@@ -117,24 +117,6 @@ const (
// queryPublishGoods 查询批量发布道具任务状态
queryPublishGoods = "/xpay/query_publish_goods"
// queryBizBalance 查询商家账户里的可提现余额
queryBizBalance = "/xpay/query_biz_balance"
// queryTransferAccount 查询广告金充值账户
queryTransferAccount = "/xpay/query_transfer_account"
// queryAdverFunds 查询广告金发放记录
queryAdverFunds = "/xpay/query_adver_funds"
// createFundsBill 充值广告金
createFundsBill = "/xpay/create_funds_bill"
// bindTransferAccount 绑定广告金充值账户
bindTransferAccount = "/xpay/bind_transfer_accout"
// defaultUnifiedOrderURL default unified order url
defaultUnifiedOrderURL = "requestVirtualPayment"
)
const (

View File

@@ -145,8 +145,6 @@ type OrderItem struct {
WxOrderID string `json:"wx_order_id"` // 微信内部单号
ChannelOrderID string `json:"channel_order_id"` // 渠道订单号,为用户微信支付详情页面上的商户单号
WxPayOrderID string `json:"wxpay_order_id"` // 微信支付交易单号,为用户微信支付详情页面上的交易单号
SettTime int64 `json:"sett_time"` // 结算时间unix 秒级时间戳,结算时间的秒级时间戳,大于 0 表示结算成功
SettState uint `json:"sett_state"` // 结算状态 0-未开始结算 1-结算中 2-结算成功
}
// QueryOrderResponse 查询创建的订单(现金单,非代币单)响应参数

View File

@@ -37,7 +37,7 @@ func (s *VirtualPayment) SetSessionKey(sessionKey string) {
}
// QueryUserBalance 查询虚拟支付余额
func (s *VirtualPayment) QueryUserBalance(ctx context.Context, in *QueryUserBalanceRequest) (out *QueryUserBalanceResponse, err error) {
func (s *VirtualPayment) QueryUserBalance(ctx context.Context, in *QueryUserBalanceRequest) (out QueryUserBalanceResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
@@ -60,12 +60,12 @@ func (s *VirtualPayment) QueryUserBalance(ctx context.Context, in *QueryUserBala
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "QueryUserBalance")
err = util.DecodeWithError(response, &out, "QueryUserBalance")
return
}
// CurrencyPay currency pay 扣减代币(一般用于代币支付)
func (s *VirtualPayment) CurrencyPay(ctx context.Context, in *CurrencyPayRequest) (out *CurrencyPayResponse, err error) {
func (s *VirtualPayment) CurrencyPay(ctx context.Context, in *CurrencyPayRequest) (out CurrencyPayResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
@@ -88,12 +88,12 @@ func (s *VirtualPayment) CurrencyPay(ctx context.Context, in *CurrencyPayRequest
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "CurrencyPay")
err = util.DecodeWithError(response, &out, "CurrencyPay")
return
}
// QueryOrder 查询创建的订单(现金单,非代币单)
func (s *VirtualPayment) QueryOrder(ctx context.Context, in *QueryOrderRequest) (out *QueryOrderResponse, err error) {
func (s *VirtualPayment) QueryOrder(ctx context.Context, in *QueryOrderRequest) (out QueryOrderResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
@@ -116,12 +116,12 @@ func (s *VirtualPayment) QueryOrder(ctx context.Context, in *QueryOrderRequest)
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "QueryOrder")
err = util.DecodeWithError(response, &out, "QueryOrder")
return
}
// CancelCurrencyPay 取消订单 代币支付退款 (currency_pay 接口的逆操作)
func (s *VirtualPayment) CancelCurrencyPay(ctx context.Context, in *CancelCurrencyPayRequest) (out *CancelCurrencyPayResponse, err error) {
func (s *VirtualPayment) CancelCurrencyPay(ctx context.Context, in *CancelCurrencyPayRequest) (out CancelCurrencyPayResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
@@ -144,13 +144,13 @@ func (s *VirtualPayment) CancelCurrencyPay(ctx context.Context, in *CancelCurren
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "CancelCurrencyPay")
err = util.DecodeWithError(response, &out, "CancelCurrencyPay")
return
}
// NotifyProvideGoods 通知发货
// 通知已经发货完成(只能通知现金单),正常通过 xpay_goods_deliver_notify 消息推送返回成功就不需要调用这个 api 接口。这个接口用于异常情况推送不成功时手动将单改成已发货状态
func (s *VirtualPayment) NotifyProvideGoods(ctx context.Context, in *NotifyProvideGoodsRequest) (out *NotifyProvideGoodsResponse, err error) {
func (s *VirtualPayment) NotifyProvideGoods(ctx context.Context, in *NotifyProvideGoodsRequest) (out NotifyProvideGoodsResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
@@ -174,12 +174,12 @@ func (s *VirtualPayment) NotifyProvideGoods(ctx context.Context, in *NotifyProvi
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "NotifyProvideGoods")
err = util.DecodeWithError(response, &out, "NotifyProvideGoods")
return
}
// PresentCurrency 代币赠送接口,由于目前不支付按单号查赠送单的功能,所以当需要赠送的时候可以一直重试到返回 0 或者返回 268490004重复操作为止
func (s *VirtualPayment) PresentCurrency(ctx context.Context, in *PresentCurrencyRequest) (out *PresentCurrencyResponse, err error) {
func (s *VirtualPayment) PresentCurrency(ctx context.Context, in *PresentCurrencyRequest) (out PresentCurrencyResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
@@ -203,12 +203,12 @@ func (s *VirtualPayment) PresentCurrency(ctx context.Context, in *PresentCurrenc
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "PresentCurrency")
err = util.DecodeWithError(response, &out, "PresentCurrency")
return
}
// DownloadBill 下载订单交易账单
func (s *VirtualPayment) DownloadBill(ctx context.Context, in *DownloadBillRequest) (out *DownloadBillResponse, err error) {
func (s *VirtualPayment) DownloadBill(ctx context.Context, in *DownloadBillRequest) (out DownloadBillResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
@@ -232,12 +232,12 @@ func (s *VirtualPayment) DownloadBill(ctx context.Context, in *DownloadBillReque
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "DownloadBill")
err = util.DecodeWithError(response, &out, "DownloadBill")
return
}
// RefundOrder 退款 对使用 jsapi 接口下的单进行退款
func (s *VirtualPayment) RefundOrder(ctx context.Context, in *RefundOrderRequest) (out *RefundOrderResponse, err error) {
func (s *VirtualPayment) RefundOrder(ctx context.Context, in *RefundOrderRequest) (out RefundOrderResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
@@ -261,12 +261,12 @@ func (s *VirtualPayment) RefundOrder(ctx context.Context, in *RefundOrderRequest
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "RefundOrder")
err = util.DecodeWithError(response, &out, "RefundOrder")
return
}
// CreateWithdrawOrder 创建提现单
func (s *VirtualPayment) CreateWithdrawOrder(ctx context.Context, in *CreateWithdrawOrderRequest) (out *CreateWithdrawOrderResponse, err error) {
func (s *VirtualPayment) CreateWithdrawOrder(ctx context.Context, in *CreateWithdrawOrderRequest) (out CreateWithdrawOrderResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
@@ -290,12 +290,12 @@ func (s *VirtualPayment) CreateWithdrawOrder(ctx context.Context, in *CreateWith
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "CreateWithdrawOrder")
err = util.DecodeWithError(response, &out, "CreateWithdrawOrder")
return
}
// QueryWithdrawOrder 查询提现单
func (s *VirtualPayment) QueryWithdrawOrder(ctx context.Context, in *QueryWithdrawOrderRequest) (out *QueryWithdrawOrderResponse, err error) {
func (s *VirtualPayment) QueryWithdrawOrder(ctx context.Context, in *QueryWithdrawOrderRequest) (out QueryWithdrawOrderResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
@@ -319,12 +319,12 @@ func (s *VirtualPayment) QueryWithdrawOrder(ctx context.Context, in *QueryWithdr
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "QueryWithdrawOrder")
err = util.DecodeWithError(response, &out, "QueryWithdrawOrder")
return
}
// StartUploadGoods 开始上传商品
func (s *VirtualPayment) StartUploadGoods(ctx context.Context, in *StartUploadGoodsRequest) (out *StartUploadGoodsResponse, err error) {
func (s *VirtualPayment) StartUploadGoods(ctx context.Context, in *StartUploadGoodsRequest) (out StartUploadGoodsResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
@@ -348,12 +348,12 @@ func (s *VirtualPayment) StartUploadGoods(ctx context.Context, in *StartUploadGo
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "StartUploadGoods")
err = util.DecodeWithError(response, &out, "StartUploadGoods")
return
}
// QueryUploadGoods 查询上传商品
func (s *VirtualPayment) QueryUploadGoods(ctx context.Context, in *QueryUploadGoodsRequest) (out *QueryUploadGoodsResponse, err error) {
func (s *VirtualPayment) QueryUploadGoods(ctx context.Context, in *QueryUploadGoodsRequest) (out QueryUploadGoodsResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
@@ -377,12 +377,12 @@ func (s *VirtualPayment) QueryUploadGoods(ctx context.Context, in *QueryUploadGo
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "QueryUploadGoods")
err = util.DecodeWithError(response, &out, "QueryUploadGoods")
return
}
// StartPublishGoods 开始发布商品
func (s *VirtualPayment) StartPublishGoods(ctx context.Context, in *StartPublishGoodsRequest) (out *StartPublishGoodsResponse, err error) {
func (s *VirtualPayment) StartPublishGoods(ctx context.Context, in *StartPublishGoodsRequest) (out StartPublishGoodsResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
@@ -406,12 +406,12 @@ func (s *VirtualPayment) StartPublishGoods(ctx context.Context, in *StartPublish
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "StartPublishGoods")
err = util.DecodeWithError(response, &out, "StartPublishGoods")
return
}
// QueryPublishGoods 查询发布商品
func (s *VirtualPayment) QueryPublishGoods(ctx context.Context, in *QueryPublishGoodsRequest) (out *QueryPublishGoodsResponse, err error) {
func (s *VirtualPayment) QueryPublishGoods(ctx context.Context, in *QueryPublishGoodsRequest) (out QueryPublishGoodsResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
@@ -435,7 +435,7 @@ func (s *VirtualPayment) QueryPublishGoods(ctx context.Context, in *QueryPublish
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, out, "QueryPublishGoods")
err = util.DecodeWithError(response, &out, "QueryPublishGoods")
return
}
@@ -479,7 +479,6 @@ func (s *VirtualPayment) requestAddress(params URLParams) (url string, err error
case queryUserBalance:
case currencyPay:
case cancelCurrencyPay:
case defaultUnifiedOrderURL:
if params.PaySign, params.Signature, err = s.PaySignature(params.Path, params.Content); err != nil {
return
}

View File

@@ -44,9 +44,6 @@ func (basic *Basic) Long2ShortURL(longURL string) (shortURL string, err error) {
if err != nil {
return
}
if err = util.DecodeWithError(responseBytes, resp, long2shortAction); err != nil {
return
}
shortURL = resp.ShortURL
return
err = util.DecodeWithError(responseBytes, resp, long2shortAction)
return resp.ShortURL, err
}

View File

@@ -79,6 +79,10 @@ type sendRequest struct {
Mpnews map[string]interface{} `json:"mpnews,omitempty"`
// 发送语音
Voice map[string]interface{} `json:"voice,omitempty"`
// 发送视频
Mpvideo map[string]interface{} `json:"mpvideo,omitempty"`
// 发送图片-预览使用
Image map[string]interface{} `json:"image,omitempty"`
// 发送图片
Images *Image `json:"images,omitempty"`
// 发送卡券
@@ -183,7 +187,13 @@ func (broadcast *Broadcast) SendImage(user *User, images *Image) (*Result, error
ToUser: nil,
MsgType: MsgTypeImage,
}
req.Images = images
if broadcast.preview {
req.Image = map[string]interface{}{
"media_id": images.MediaIDs[0],
}
} else {
req.Images = images
}
req, sendURL := broadcast.chooseTagOrOpenID(user, req)
url := fmt.Sprintf("%s?access_token=%s", sendURL, ak)
data, err := util.PostJSON(url, req)
@@ -205,7 +215,7 @@ func (broadcast *Broadcast) SendVideo(user *User, mediaID string, title, descrip
ToUser: nil,
MsgType: MsgTypeVideo,
}
req.Voice = map[string]interface{}{
req.Mpvideo = map[string]interface{}{
"media_id": mediaID,
"title": title,
"description": description,

View File

@@ -11,4 +11,5 @@ type Config struct {
Token string `json:"token"` // token
EncodingAESKey string `json:"encoding_aes_key"` // EncodingAESKey
Cache cache.Cache
UseStableAK bool // use the stable access_token
}

View File

@@ -72,11 +72,7 @@ func (csm *Manager) List() (customerServiceList []*KeFuInfo, err error) {
}
var res resKeFuList
err = util.DecodeWithError(response, &res, "ListCustomerService")
if err != nil {
return
}
customerServiceList = res.KfList
return
return res.KfList, err
}
// KeFuOnlineInfo 客服在线信息
@@ -107,11 +103,7 @@ func (csm *Manager) OnlineList() (customerServiceOnlineList []*KeFuOnlineInfo, e
}
var res resKeFuOnlineList
err = util.DecodeWithError(response, &res, "ListOnlineCustomerService")
if err != nil {
return
}
customerServiceOnlineList = res.KfOnlineList
return
return res.KfOnlineList, err
}
// Add 添加客服账号

View File

@@ -183,9 +183,6 @@ func (cube *DataCube) fetchData(params ParamsPublisher) (response []byte, err er
uri := fmt.Sprintf("%s?%s", publisherURL, v.Encode())
response, err = util.HTTPGet(uri)
if err != nil {
return
}
return
}

View File

@@ -64,11 +64,7 @@ func (draft *Draft) AddDraft(articles []*Article) (mediaID string, err error) {
MediaID string `json:"media_id"`
}
err = util.DecodeWithError(response, &res, "AddDraft")
if err != nil {
return
}
mediaID = res.MediaID
return
return res.MediaID, err
}
// GetDraft 获取草稿
@@ -94,12 +90,7 @@ func (draft *Draft) GetDraft(mediaID string) (articles []*Article, err error) {
NewsItem []*Article `json:"news_item"`
}
err = util.DecodeWithError(response, &res, "GetDraft")
if err != nil {
return
}
articles = res.NewsItem
return
return res.NewsItem, err
}
// DeleteDraft 删除草稿
@@ -172,12 +163,7 @@ func (draft *Draft) CountDraft() (total uint, err error) {
Total uint `json:"total_count"`
}
err = util.DecodeWithError(response, &res, "CountDraft")
if nil != err {
return
}
total = res.Total
return
return res.Total, err
}
// ArticleList 草稿列表

View File

@@ -73,12 +73,7 @@ func (freePublish *FreePublish) Publish(mediaID string) (publishID int64, err er
PublishID int64 `json:"publish_id"`
}
err = util.DecodeWithError(response, &res, "SubmitFreePublish")
if err != nil {
return
}
publishID = res.PublishID
return
return res.PublishID, err
}
// PublishStatusList 发布任务状态列表
@@ -191,12 +186,7 @@ func (freePublish *FreePublish) First(articleID string) (list []Article, err err
NewsItem []Article `json:"news_item"`
}
err = util.DecodeWithError(response, &res, "FirstFreePublish")
if err != nil {
return
}
list = res.NewsItem
return
return res.NewsItem, err
}
// ArticleList 发布列表

View File

@@ -1,6 +1,7 @@
package js
import (
context2 "context"
"fmt"
"github.com/silenceper/wechat/v2/credential"
@@ -39,14 +40,31 @@ func (js *Js) SetJsTicketHandle(ticketHandle credential.JsTicketHandle) {
// GetConfig 获取jssdk需要的配置参数
// uri 为当前网页地址
func (js *Js) GetConfig(uri string) (config *Config, err error) {
config = new(Config)
return js.GetConfigContext(context2.Background(), uri)
}
// GetConfigContext 新方法,允许传入上下文,避免协程泄漏
func (js *Js) GetConfigContext(ctx context2.Context, uri string) (config *Config, err error) {
var accessToken string
accessToken, err = js.GetAccessToken()
// 类型断言,如果断言成功,调用安全的 GetAccessTokenContext 方法
if ctxHandle, ok := js.Context.AccessTokenHandle.(credential.AccessTokenContextHandle); ok {
accessToken, err = ctxHandle.GetAccessTokenContext(ctx)
} else {
// 如果没有实现 AccessTokenContextHandle 接口,调用旧的 GetAccessToken 方法
accessToken, err = js.Context.GetAccessToken()
}
if err != nil {
return
}
var ticketStr string
ticketStr, err = js.GetTicket(accessToken)
// 类型断言 jsTicket
if ticketCtxHandle, ok := js.JsTicketHandle.(credential.JsTicketContextHandle); ok {
ticketStr, err = ticketCtxHandle.GetTicketContext(ctx, accessToken)
} else {
// 如果没有实现 JsTicketContextHandle 接口,调用旧的 GetTicket 方法
ticketStr, err = js.GetTicket(accessToken)
}
if err != nil {
return
}
@@ -56,6 +74,7 @@ func (js *Js) GetConfig(uri string) (config *Config, err error) {
str := fmt.Sprintf("jsapi_ticket=%s&noncestr=%s&timestamp=%d&url=%s", ticketStr, nonceStr, timestamp, uri)
sigStr := util.Signature(str)
config = new(Config)
config.AppID = js.AppID
config.NonceStr = nonceStr
config.Timestamp = timestamp

View File

@@ -4,6 +4,9 @@ import (
"encoding/json"
"errors"
"fmt"
"io"
"os"
"path"
"github.com/silenceper/wechat/v2/officialaccount/context"
"github.com/silenceper/wechat/v2/util"
@@ -160,8 +163,8 @@ type resAddMaterial struct {
URL string `json:"url"`
}
// AddMaterial 上传永久性素材(处理视频需要单独上传)
func (material *Material) AddMaterial(mediaType MediaType, filename string) (mediaID string, url string, err error) {
// AddMaterialFromReader 上传永久性素材(处理视频需要单独上传),从 io.Reader 中读取
func (material *Material) AddMaterialFromReader(mediaType MediaType, filePath string, reader io.Reader) (mediaID string, url string, err error) {
if mediaType == MediaTypeVideo {
err = errors.New("永久视频素材上传使用 AddVideo 方法")
return
@@ -173,8 +176,10 @@ func (material *Material) AddMaterial(mediaType MediaType, filename string) (med
}
uri := fmt.Sprintf("%s?access_token=%s&type=%s", addMaterialURL, accessToken, mediaType)
// 获取文件名
filename := path.Base(filePath)
var response []byte
response, err = util.PostFile("media", filename, uri)
response, err = util.PostFileFromReader("media", filePath, filename, uri, reader)
if err != nil {
return
}
@@ -192,13 +197,24 @@ func (material *Material) AddMaterial(mediaType MediaType, filename string) (med
return
}
// AddMaterial 上传永久性素材(处理视频需要单独上传)
func (material *Material) AddMaterial(mediaType MediaType, filename string) (mediaID string, url string, err error) {
f, err := os.Open(filename)
if err != nil {
return
}
defer func() { _ = f.Close() }()
return material.AddMaterialFromReader(mediaType, filename, f)
}
type reqVideo struct {
Title string `json:"title"`
Introduction string `json:"introduction"`
}
// AddVideo 永久视频素材文件上传
func (material *Material) AddVideo(filename, title, introduction string) (mediaID string, url string, err error) {
// AddVideoFromReader 永久视频素材文件上传,从 io.Reader 中读取
func (material *Material) AddVideoFromReader(filePath, title, introduction string, reader io.Reader) (mediaID string, url string, err error) {
var accessToken string
accessToken, err = material.GetAccessToken()
if err != nil {
@@ -216,16 +232,19 @@ func (material *Material) AddVideo(filename, title, introduction string) (mediaI
if err != nil {
return
}
fileName := path.Base(filePath)
fields := []util.MultipartFormField{
{
IsFile: true,
Fieldname: "media",
Filename: filename,
IsFile: true,
Fieldname: "media",
FilePath: filePath,
Filename: fileName,
FileReader: reader,
},
{
IsFile: false,
Fieldname: "description",
Filename: fileName,
Value: fieldValue,
},
}
@@ -250,6 +269,17 @@ func (material *Material) AddVideo(filename, title, introduction string) (mediaI
return
}
// AddVideo 永久视频素材文件上传
func (material *Material) AddVideo(directory, title, introduction string) (mediaID string, url string, err error) {
f, err := os.Open(directory)
if err != nil {
return "", "", err
}
defer func() { _ = f.Close() }()
return material.AddVideoFromReader(directory, title, introduction, f)
}
type reqDeleteMaterial struct {
MediaID string `json:"media_id"`
}

View File

@@ -3,6 +3,7 @@ package material
import (
"encoding/json"
"fmt"
"io"
"github.com/silenceper/wechat/v2/util"
)
@@ -62,6 +63,38 @@ func (material *Material) MediaUpload(mediaType MediaType, filename string) (med
return
}
// MediaUploadFromReader 临时素材上传
func (material *Material) MediaUploadFromReader(mediaType MediaType, filename string, reader io.Reader) (media Media, err error) {
var accessToken string
accessToken, err = material.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s&type=%s", mediaUploadURL, accessToken, mediaType)
var byteData []byte
byteData, err = io.ReadAll(reader)
if err != nil {
return
}
var response []byte
response, err = util.PostFileByStream("media", filename, uri, byteData)
if err != nil {
return
}
err = json.Unmarshal(response, &media)
if err != nil {
return
}
if media.ErrCode != 0 {
err = fmt.Errorf("MediaUpload error : errcode=%v , errmsg=%v", media.ErrCode, media.ErrMsg)
return
}
return
}
// GetMediaURL 返回临时素材的下载地址供用户自己处理
// NOTICE: URL 不可公开因为含access_token 需要立即另存文件
func (material *Material) GetMediaURL(mediaID string) (mediaURL string, err error) {

View File

@@ -27,15 +27,15 @@ const (
MsgTypeVideo MsgType = "video"
// MsgTypeMiniprogrampage 表示小程序卡片消息
MsgTypeMiniprogrampage MsgType = "miniprogrampage"
// MsgTypeShortVideo 表示短视频消息[限接收]
// MsgTypeShortVideo 表示短视频消息 [限接收]
MsgTypeShortVideo MsgType = "shortvideo"
// MsgTypeLocation 表示坐标消息[限接收]
// MsgTypeLocation 表示坐标消息 [限接收]
MsgTypeLocation MsgType = "location"
// MsgTypeLink 表示链接消息[限接收]
// MsgTypeLink 表示链接消息 [限接收]
MsgTypeLink MsgType = "link"
// MsgTypeMusic 表示音乐消息[限回复]
// MsgTypeMusic 表示音乐消息 [限回复]
MsgTypeMusic MsgType = "music"
// MsgTypeNews 表示图文消息[限回复]
// MsgTypeNews 表示图文消息 [限回复]
MsgTypeNews MsgType = "news"
// MsgTypeTransfer 表示消息消息转发到客服
MsgTypeTransfer MsgType = "transfer_customer_service"
@@ -91,7 +91,7 @@ const (
const (
// 微信开放平台需要用到
// InfoTypeVerifyTicket 返回ticket
// InfoTypeVerifyTicket 返回 ticket
InfoTypeVerifyTicket InfoType = "component_verify_ticket"
// InfoTypeAuthorized 授权
InfoTypeAuthorized InfoType = "authorized"
@@ -108,8 +108,8 @@ type MixMessage struct {
CommonToken
// 基本消息
MsgID int64 `xml:"MsgId"` // 其他消息推送过来是MsgId
TemplateMsgID int64 `xml:"MsgID"` // 模板消息推送成功的消息是MsgID
MsgID int64 `xml:"MsgId"` // 其他消息推送过来是 MsgId
TemplateMsgID int64 `xml:"MsgID"` // 模板消息推送成功的消息是 MsgID
Content string `xml:"Content"`
Recognition string `xml:"Recognition"`
PicURL string `xml:"PicUrl"`
@@ -166,17 +166,17 @@ type MixMessage struct {
// 事件相关:发布能力
PublishEventInfo struct {
PublishID int64 `xml:"publish_id"` // 发布任务id
PublishID int64 `xml:"publish_id"` // 发布任务 id
PublishStatus freepublish.PublishStatus `xml:"publish_status"` // 发布状态
ArticleID string `xml:"article_id"` // 当发布状态为0时(即成功)时,返回图文的 article_id可用于“客服消息”场景
ArticleID string `xml:"article_id"` // 当发布状态为 0 时(即成功)时,返回图文的 article_id可用于“客服消息”场景
ArticleDetail struct {
Count uint `xml:"count"` // 文章数量
Item []struct {
Index uint `xml:"idx"` // 文章对应的编号
ArticleURL string `xml:"article_url"` // 图文的永久链接
} `xml:"item"`
} `xml:"article_detail"` // 当发布状态为0时(即成功)时,返回内容
FailIndex []uint `xml:"fail_idx"` // 当发布状态为2或4时,返回不通过的文章编号,第一篇为 1其他发布状态则为空
} `xml:"article_detail"` // 当发布状态为 0 时(即成功)时,返回内容
FailIndex []uint `xml:"fail_idx"` // 当发布状态为 2 或 4 时,返回不通过的文章编号,第一篇为 1其他发布状态则为空
} `xml:"PublishEventInfo"`
// 第三方平台相关
@@ -222,19 +222,19 @@ type MixMessage struct {
TraceID string `xml:"trace_id"`
StatusCode int `xml:"status_code"`
//小程序名称审核结果事件推送
Ret int32 `xml:"ret"` //审核结果 2失败3成功
NickName string `xml:"nickname"` //小程序昵称
// 小程序名称审核结果事件推送
Ret int32 `xml:"ret"` // 审核结果 2失败3成功
NickName string `xml:"nickname"` // 小程序昵称
// 设备相关
device.MsgDevice
//小程序审核通知
SuccTime int `xml:"SuccTime"` //审核成功时的时间戳
FailTime int `xml:"FailTime"` //审核不通过的时间戳
DelayTime int `xml:"DelayTime"` //审核延后时的时间戳
Reason string `xml:"Reason"` //审核不通过的原因
ScreenShot string `xml:"ScreenShot"` //审核不通过的截图示例。用 | 分隔的 media_id 的列表,可通过获取永久素材接口拉取截图内容
// 小程序审核通知
SuccTime int `xml:"SuccTime"` // 审核成功时的时间戳
FailTime int `xml:"FailTime"` // 审核不通过的时间戳
DelayTime int `xml:"DelayTime"` // 审核延后时的时间戳
Reason string `xml:"Reason"` // 审核不通过的原因
ScreenShot string `xml:"ScreenShot"` // 审核不通过的截图示例。用 | 分隔的 media_id 的列表,可通过获取永久素材接口拉取截图内容
}
// SubscribeMsgPopupEvent 订阅通知事件推送的消息体
@@ -282,7 +282,7 @@ type ResponseEncryptedXMLMsg struct {
Nonce string `xml:"Nonce" json:"Nonce"`
}
// CDATA 使用该类型,在序列化为 xml 文本时文本会被解析器忽略
// CDATA 使用该类型在序列化为 xml 文本时文本会被解析器忽略
type CDATA string
// MarshalXML 实现自己的序列化方法

View File

@@ -90,11 +90,7 @@ func (tpl *Subscribe) List() (templateList []*PrivateSubscribeItem, err error) {
}
var res resPrivateSubscribeList
err = util.DecodeWithError(response, &res, "ListSubscribe")
if err != nil {
return
}
templateList = res.SubscriptionList
return
return res.SubscriptionList, err
}
type resSubscribeAdd struct {
@@ -123,11 +119,7 @@ func (tpl *Subscribe) Add(ShortID string, kidList []int, sceneDesc string) (temp
}
var result resSubscribeAdd
err = util.DecodeWithError(response, &result, "AddSubscribe")
if err != nil {
return
}
templateID = result.TemplateID
return
return result.TemplateID, err
}
// Delete 删除私有模板
@@ -175,11 +167,7 @@ func (tpl *Subscribe) GetCategory() (categoryList []*PublicTemplateCategory, err
}
var result resSubscribeCategoryList
err = util.DecodeWithError(response, &result, "GetCategory")
if err != nil {
return
}
categoryList = result.CategoryList
return
return result.CategoryList, err
}
// PublicTemplateKeyWords 模板中的关键词
@@ -210,11 +198,7 @@ func (tpl *Subscribe) GetPubTplKeyWordsByID(titleID string) (keyWordsList []*Pub
}
var result resPublicTemplateKeyWordsList
err = util.DecodeWithError(response, &result, "GetPublicTemplateKeyWords")
if err != nil {
return
}
keyWordsList = result.KeyWordsList
return
return result.KeyWordsList, err
}
// PublicTemplateTitle 类目下的公共模板
@@ -246,10 +230,5 @@ func (tpl *Subscribe) GetPublicTemplateTitleList(ids string, start int, limit in
}
var result resPublicTemplateTitleList
err = util.DecodeWithError(response, &result, "GetPublicTemplateTitle")
if err != nil {
return
}
count = result.Count
templateTitleList = result.TemplateTitleList
return
return result.Count, result.TemplateTitleList, err
}

View File

@@ -61,15 +61,15 @@ func (tpl *Template) Send(msg *TemplateMessage) (msgID int64, err error) {
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", templateSendURL, accessToken)
var response []byte
response, err = util.PostJSON(uri, msg)
if err != nil {
var (
uri = fmt.Sprintf("%s?access_token=%s", templateSendURL, accessToken)
response []byte
)
if response, err = util.PostJSON(uri, msg); err != nil {
return
}
var result resTemplateSend
err = json.Unmarshal(response, &result)
if err != nil {
if err = json.Unmarshal(response, &result); err != nil {
return
}
if result.ErrCode != 0 {
@@ -103,19 +103,16 @@ func (tpl *Template) List() (templateList []*TemplateItem, err error) {
if err != nil {
return
}
uri := fmt.Sprintf("%s?access_token=%s", templateListURL, accessToken)
var response []byte
response, err = util.HTTPGet(uri)
if err != nil {
var (
uri = fmt.Sprintf("%s?access_token=%s", templateListURL, accessToken)
response []byte
)
if response, err = util.HTTPGet(uri); err != nil {
return
}
var res resTemplateList
err = util.DecodeWithError(response, &res, "ListTemplate")
if err != nil {
return
}
templateList = res.TemplateList
return
return res.TemplateList, err
}
type resTemplateAdd struct {
@@ -125,29 +122,26 @@ type resTemplateAdd struct {
}
// Add 添加模板.
func (tpl *Template) Add(shortID string) (templateID string, err error) {
func (tpl *Template) Add(shortID string, keyNameList []string) (templateID string, err error) {
var accessToken string
accessToken, err = tpl.GetAccessToken()
if err != nil {
return
}
var msg = struct {
ShortID string `json:"template_id_short"`
}{ShortID: shortID}
uri := fmt.Sprintf("%s?access_token=%s", templateAddURL, accessToken)
var response []byte
response, err = util.PostJSON(uri, msg)
if err != nil {
var (
msg = struct {
ShortID string `json:"template_id_short"`
KeyNameList []string `json:"keyword_name_list"`
}{ShortID: shortID, KeyNameList: keyNameList}
uri = fmt.Sprintf("%s?access_token=%s", templateAddURL, accessToken)
response []byte
)
if response, err = util.PostJSON(uri, msg); err != nil {
return
}
var result resTemplateAdd
err = util.DecodeWithError(response, &result, "AddTemplate")
if err != nil {
return
}
templateID = result.TemplateID
return
return result.TemplateID, err
}
// Delete 删除私有模板.
@@ -157,14 +151,14 @@ func (tpl *Template) Delete(templateID string) (err error) {
if err != nil {
return
}
var msg = struct {
TemplateID string `json:"template_id"`
}{TemplateID: templateID}
uri := fmt.Sprintf("%s?access_token=%s", templateDelURL, accessToken)
var response []byte
response, err = util.PostJSON(uri, msg)
if err != nil {
var (
msg = struct {
TemplateID string `json:"template_id"`
}{TemplateID: templateID}
uri = fmt.Sprintf("%s?access_token=%s", templateDelURL, accessToken)
response []byte
)
if response, err = util.PostJSON(uri, msg); err != nil {
return
}
return util.DecodeWithCommonError(response, "DeleteTemplate")

View File

@@ -1,6 +1,7 @@
package oauth
import (
ctx2 "context"
"encoding/json"
"fmt"
"net/http"
@@ -73,11 +74,28 @@ type ResAccessToken struct {
UnionID string `json:"unionid"`
}
// GetUserInfoByCodeContext 通过网页授权的code 换取用户的信息
func (oauth *Oauth) GetUserInfoByCodeContext(ctx ctx2.Context, code string) (result UserInfo, err error) {
var (
token ResAccessToken
)
if token, err = oauth.GetUserAccessTokenContext(ctx, code); err != nil {
return
}
return oauth.GetUserInfoContext(ctx, token.AccessToken, token.OpenID, "")
}
// GetUserAccessToken 通过网页授权的code 换取access_token(区别于context中的access_token)
func (oauth *Oauth) GetUserAccessToken(code string) (result ResAccessToken, err error) {
return oauth.GetUserAccessTokenContext(ctx2.Background(), code)
}
// GetUserAccessTokenContext 通过网页授权的code 换取access_token(区别于context中的access_token) with context
func (oauth *Oauth) GetUserAccessTokenContext(ctx ctx2.Context, code string) (result ResAccessToken, err error) {
urlStr := fmt.Sprintf(accessTokenURL, oauth.AppID, oauth.AppSecret, code)
var response []byte
response, err = util.HTTPGet(urlStr)
response, err = util.HTTPGetContext(ctx, urlStr)
if err != nil {
return
}
@@ -94,9 +112,14 @@ func (oauth *Oauth) GetUserAccessToken(code string) (result ResAccessToken, err
// RefreshAccessToken 刷新access_token
func (oauth *Oauth) RefreshAccessToken(refreshToken string) (result ResAccessToken, err error) {
return oauth.RefreshAccessTokenContext(ctx2.Background(), refreshToken)
}
// RefreshAccessTokenContext 刷新access_token with context
func (oauth *Oauth) RefreshAccessTokenContext(ctx ctx2.Context, refreshToken string) (result ResAccessToken, err error) {
urlStr := fmt.Sprintf(refreshAccessTokenURL, oauth.AppID, refreshToken)
var response []byte
response, err = util.HTTPGet(urlStr)
response, err = util.HTTPGetContext(ctx, urlStr)
if err != nil {
return
}
@@ -113,9 +136,14 @@ func (oauth *Oauth) RefreshAccessToken(refreshToken string) (result ResAccessTok
// CheckAccessToken 检验access_token是否有效
func (oauth *Oauth) CheckAccessToken(accessToken, openID string) (b bool, err error) {
return oauth.CheckAccessTokenContext(ctx2.Background(), accessToken, openID)
}
// CheckAccessTokenContext 检验access_token是否有效 with context
func (oauth *Oauth) CheckAccessTokenContext(ctx ctx2.Context, accessToken, openID string) (b bool, err error) {
urlStr := fmt.Sprintf(checkAccessTokenURL, accessToken, openID)
var response []byte
response, err = util.HTTPGet(urlStr)
response, err = util.HTTPGetContext(ctx, urlStr)
if err != nil {
return
}
@@ -149,12 +177,17 @@ type UserInfo struct {
// GetUserInfo 如果scope为 snsapi_userinfo 则可以通过此方法获取到用户基本信息
func (oauth *Oauth) GetUserInfo(accessToken, openID, lang string) (result UserInfo, err error) {
return oauth.GetUserInfoContext(ctx2.Background(), accessToken, openID, lang)
}
// GetUserInfoContext 如果scope为 snsapi_userinfo 则可以通过此方法获取到用户基本信息 with context
func (oauth *Oauth) GetUserInfoContext(ctx ctx2.Context, accessToken, openID, lang string) (result UserInfo, err error) {
if lang == "" {
lang = "zh_CN"
}
urlStr := fmt.Sprintf(userInfoURL, accessToken, openID, lang)
var response []byte
response, err = util.HTTPGet(urlStr)
response, err = util.HTTPGetContext(ctx, urlStr)
if err != nil {
return
}

View File

@@ -49,7 +49,13 @@ type OfficialAccount struct {
// NewOfficialAccount 实例化公众号API
func NewOfficialAccount(cfg *config.Config) *OfficialAccount {
defaultAkHandle := credential.NewDefaultAccessToken(cfg.AppID, cfg.AppSecret, credential.CacheKeyOfficialAccountPrefix, cfg.Cache)
var defaultAkHandle credential.AccessTokenContextHandle
const cacheKeyPrefix = credential.CacheKeyOfficialAccountPrefix
if cfg.UseStableAK {
defaultAkHandle = credential.NewStableAccessToken(cfg.AppID, cfg.AppSecret, cacheKeyPrefix, cfg.Cache)
} else {
defaultAkHandle = credential.NewDefaultAccessToken(cfg.AppID, cfg.AppSecret, cacheKeyPrefix, cfg.Cache)
}
ctx := &context.Context{
Config: cfg,
AccessTokenHandle: defaultAkHandle,

View File

@@ -73,7 +73,7 @@ func (srv *Server) Serve() error {
if err != nil {
return err
}
// 非安全模式下请求处理方法返回为nil则直接回复success给微信服务器
// 非安全模式下,请求处理方法返回为 nil 则直接回复 success 给微信服务器
if response == nil && !srv.isSafeMode {
srv.String("success")
return nil
@@ -198,7 +198,7 @@ func (srv *Server) parseRequestMessage(rawXMLMsgBytes []byte) (msg *message.MixM
if err != nil {
return
}
// nonstandard json, 目前小程序订阅消息返回数据格式不标准订阅消息模板单个List返回是对象多个List返回是数组。
// nonstandard json, 目前小程序订阅消息返回数据格式不标准,订阅消息模板单个 List 返回是对象,多个 List 返回是数组。
if msg.MsgType == message.MsgTypeEvent {
listData := gjson.Get(string(rawXMLMsgBytes), "List")
if listData.IsObject() {
@@ -284,7 +284,7 @@ func (srv *Server) Send() (err error) {
if err != nil {
return
}
// TODO 如果获取不到timestamp nonce 则自己生成
// TODO 如果获取不到 timestamp nonce 则自己生成
timestamp := srv.timestamp
timestampStr := strconv.FormatInt(timestamp, 10)
msgSignature := util.Signature(srv.Token, timestampStr, srv.nonce, string(encryptedMsg))

View File

@@ -62,10 +62,6 @@ func (user *User) ListChangeOpenIDs(fromAppID string, openIDs ...string) (list *
}
err = util.DecodeWithError(resp, list, "ListChangeOpenIDs")
if err != nil {
return
}
return
}

View File

@@ -126,10 +126,7 @@ func (user *User) GetTag() (tags []*TagInfo, err error) {
Tags []*TagInfo `json:"tags"`
}
err = json.Unmarshal(response, &result)
if err != nil {
return
}
return result.Tags, nil
return result.Tags, err
}
// OpenIDListByTag 获取标签下粉丝列表
@@ -154,9 +151,6 @@ func (user *User) OpenIDListByTag(tagID int32, nextOpenID ...string) (userList *
}
userList = new(TagOpenIDList)
err = json.Unmarshal(response, &userList)
if err != nil {
return
}
return
}

View File

@@ -2,7 +2,7 @@ package account
import "github.com/silenceper/wechat/v2/openplatform/context"
// Account 开放平台张哈管理
// Account 开放平台帐号管理
// TODO 实现方法
type Account struct {
*context.Context

View File

@@ -20,6 +20,7 @@ const (
getComponentInfoURL = "https://api.weixin.qq.com/cgi-bin/component/api_get_authorizer_info?component_access_token=%s"
componentLoginURL = "https://mp.weixin.qq.com/cgi-bin/componentloginpage?component_appid=%s&pre_auth_code=%s&redirect_uri=%s&auth_type=%d&biz_appid=%s"
bindComponentURL = "https://mp.weixin.qq.com/safe/bindcomponent?action=bindcomponent&auth_type=%d&no_scan=1&component_appid=%s&pre_auth_code=%s&redirect_uri=%s&biz_appid=%s#wechat_redirect"
bindComponentURLV2 = "https://open.weixin.qq.com/wxaopen/safe/bindcomponent?action=bindcomponent&auth_type=%d&no_scan=1&component_appid=%s&pre_auth_code=%s&redirect_uri=%s&biz_appid=%s#wechat_redirect"
// TODO 获取授权方选项信息
// getComponentConfigURL = "https://api.weixin.qq.com/cgi-bin/component/api_get_authorizer_option?component_access_token=%s"
// TODO 获取已授权的账号信息
@@ -100,11 +101,8 @@ func (ctx *Context) GetPreCodeContext(stdCtx context.Context) (string, error) {
var ret struct {
PreCode string `json:"pre_auth_code"`
}
if err := json.Unmarshal(body, &ret); err != nil {
return "", err
}
return ret.PreCode, nil
err = json.Unmarshal(body, &ret)
return ret.PreCode, err
}
// GetPreCode 获取预授权码
@@ -140,6 +138,20 @@ func (ctx *Context) GetBindComponentURL(redirectURI string, authType int, bizApp
return ctx.GetBindComponentURLContext(context.Background(), redirectURI, authType, bizAppID)
}
// GetBindComponentURLV2Context 获取新版本第三方公众号授权链接(链接跳转,适用移动端)
func (ctx *Context) GetBindComponentURLV2Context(stdCtx context.Context, redirectURI string, authType int, bizAppID string) (string, error) {
code, err := ctx.GetPreCodeContext(stdCtx)
if err != nil {
return "", err
}
return fmt.Sprintf(bindComponentURLV2, authType, ctx.AppID, code, url.QueryEscape(redirectURI), bizAppID), nil
}
// GetBindComponentURLV2 获取新版本第三方公众号授权链接(链接跳转,适用移动端)
func (ctx *Context) GetBindComponentURLV2(redirectURI string, authType int, bizAppID string) (string, error) {
return ctx.GetBindComponentURLContext(context.Background(), redirectURI, authType, bizAppID)
}
// ID 微信返回接口中各种类型字段
type ID struct {
ID int `json:"id"`
@@ -228,6 +240,10 @@ func (ctx *Context) RefreshAuthrTokenContext(stdCtx context.Context, appid, refr
if err := cache.SetContext(stdCtx, ctx.Cache, authrTokenKey, ret.AccessToken, time.Second*time.Duration(ret.ExpiresIn-30)); err != nil {
return nil, err
}
refreshTokenKey := "authorizer_refresh_token_" + appid
if err := cache.SetContext(stdCtx, ctx.Cache, refreshTokenKey, ret.RefreshToken, 10*365*24*60*60*time.Second); err != nil {
return nil, err
}
return ret, nil
}
@@ -241,8 +257,18 @@ func (ctx *Context) GetAuthrAccessTokenContext(stdCtx context.Context, appid str
authrTokenKey := "authorizer_access_token_" + appid
val := cache.GetContext(stdCtx, ctx.Cache, authrTokenKey)
if val == nil {
return "", fmt.Errorf("cannot get authorizer %s access token", appid)
refreshTokenKey := "authorizer_refresh_token_" + appid
val := cache.GetContext(stdCtx, ctx.Cache, refreshTokenKey)
if val == nil {
return "", fmt.Errorf("cannot get authorizer %s refresh token", appid)
}
token, err := ctx.RefreshAuthrTokenContext(stdCtx, appid, val.(string))
if err != nil {
return "", err
}
return token.AccessToken, nil
}
return val.(string), nil
}

View File

@@ -9,6 +9,12 @@ import (
const (
getAccountBasicInfoURL = "https://api.weixin.qq.com/cgi-bin/account/getaccountbasicinfo"
checkNickNameURL = "https://api.weixin.qq.com/cgi-bin/wxverify/checkwxverifynickname"
setNickNameURL = "https://api.weixin.qq.com/wxa/setnickname"
setSignatureURL = "https://api.weixin.qq.com/cgi-bin/account/modifysignature"
setHeadImageURL = "https://api.weixin.qq.com/cgi-bin/account/modifyheadimage"
getSearchStatusURL = "https://api.weixin.qq.com/wxa/getwxasearchstatus"
setSearchStatusURL = "https://api.weixin.qq.com/wxa/changewxasearchstatus"
)
// Basic 基础信息设置
@@ -51,3 +57,181 @@ func (basic *Basic) GetAccountBasicInfo() (*AccountBasicInfo, error) {
// TODO
// func (encryptor *Basic) modifyDomain() {
// }
// CheckNickNameResp 小程序名称检测结果
type CheckNickNameResp struct {
util.CommonError
HitCondition bool `json:"hit_condition"` // 是否命中关键字策略。若命中,可以选填关键字材料
Wording string `json:"wording"` // 命中关键字的说明描述
}
// CheckNickName 检测微信认证的名称是否符合规则
// ref: https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/basic-info-management/checkNickName.html
func (basic *Basic) CheckNickName(nickname string) (*CheckNickNameResp, error) {
ak, err := basic.GetAuthrAccessToken(basic.AppID)
if err != nil {
return nil, err
}
url := fmt.Sprintf("%s?access_token=%s", checkNickNameURL, ak)
data, err := util.PostJSON(url, map[string]string{
"nick_name": nickname,
})
if err != nil {
return nil, err
}
res := &CheckNickNameResp{}
err = util.DecodeWithError(data, res, "CheckNickName")
return res, err
}
// SetNickNameResp 设置小程序名称结果
type SetNickNameResp struct {
util.CommonError
AuditID int64 `json:"audit_id"` // 审核单Id通过用于查询改名审核状态
Wording string `json:"wording"` // 材料说明
}
// SetNickNameParam 设置小程序名称参数
type SetNickNameParam struct {
NickName string `json:"nick_name"` // 昵称,不支持包含“小程序”关键字的昵称
IDCard string `json:"id_card,omitempty"` // 身份证照片 mediaid个人号必填
License string `json:"license,omitempty"` // 组织机构代码证或营业执照 mediaid组织号必填
NameingOtherStuff1 string `json:"naming_other_stuff_1,omitempty"` // 其他证明材料 mediaid选填
NameingOtherStuff2 string `json:"naming_other_stuff_2,omitempty"` // 其他证明材料 mediaid选填
NameingOtherStuff3 string `json:"naming_other_stuff_3,omitempty"` // 其他证明材料 mediaid选填
NameingOtherStuff4 string `json:"naming_other_stuff_4,omitempty"` // 其他证明材料 mediaid选填
NameingOtherStuff5 string `json:"naming_other_stuff_5,omitempty"` // 其他证明材料 mediaid选填
}
// SetNickName 设置小程序名称
func (basic *Basic) SetNickName(nickname string) (*SetNickNameResp, error) {
return basic.SetNickNameFull(&SetNickNameParam{
NickName: nickname,
})
}
// SetNickNameFull 设置小程序名称
// ref: https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/basic-info-management/setNickName.html
func (basic *Basic) SetNickNameFull(param *SetNickNameParam) (*SetNickNameResp, error) {
ak, err := basic.GetAuthrAccessToken(basic.AppID)
if err != nil {
return nil, err
}
url := fmt.Sprintf("%s?access_token=%s", setNickNameURL, ak)
data, err := util.PostJSON(url, param)
if err != nil {
return nil, err
}
res := &SetNickNameResp{}
err = util.DecodeWithError(data, res, "SetNickName")
return res, err
}
// SetSignatureResp 小程序功能介绍修改结果
type SetSignatureResp struct {
util.CommonError
}
// SetSignature 小程序修改功能介绍
// ref: https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/basic-info-management/setSignature.html
func (basic *Basic) SetSignature(signature string) error {
ak, err := basic.GetAuthrAccessToken(basic.AppID)
if err != nil {
return err
}
url := fmt.Sprintf("%s?access_token=%s", setSignatureURL, ak)
data, err := util.PostJSON(url, map[string]string{
"signature": signature,
})
if err != nil {
return err
}
return util.DecodeWithError(data, &SetSignatureResp{}, "SetSignature")
}
// GetSearchStatusResp 查询小程序当前是否可被搜索
type GetSearchStatusResp struct {
util.CommonError
Status int `json:"status"` // 1 表示不可搜索0 表示可搜索
}
// GetSearchStatus 查询小程序当前是否可被搜索
// ref: https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/basic-info-management/getSearchStatus.html
func (basic *Basic) GetSearchStatus(signature string) (*GetSearchStatusResp, error) {
ak, err := basic.GetAuthrAccessToken(basic.AppID)
if err != nil {
return nil, err
}
url := fmt.Sprintf("%s?access_token=%s", getSearchStatusURL, ak)
data, err := util.HTTPGet(url)
if err != nil {
return nil, err
}
res := &GetSearchStatusResp{}
err = util.DecodeWithError(data, res, "GetSearchStatus")
return res, err
}
// SetSearchStatusResp 小程序是否可被搜索修改结果
type SetSearchStatusResp struct {
util.CommonError
}
// SetSearchStatus 修改小程序是否可被搜索
// status: 1 表示不可搜索0 表示可搜索
// ref: https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/basic-info-management/setSearchStatus.html
func (basic *Basic) SetSearchStatus(status int) error {
ak, err := basic.GetAuthrAccessToken(basic.AppID)
if err != nil {
return err
}
url := fmt.Sprintf("%s?access_token=%s", setSearchStatusURL, ak)
data, err := util.PostJSON(url, map[string]int{
"status": status,
})
if err != nil {
return err
}
return util.DecodeWithError(data, &SetSearchStatusResp{}, "SetSearchStatus")
}
// SetHeadImageResp 小程序头像修改结果
type SetHeadImageResp struct {
util.CommonError
}
// SetHeadImageParam 小程序头像修改参数
type SetHeadImageParam struct {
HeadImageMediaID string `json:"head_img_media_id"` // 头像素材 media_id
X1 string `json:"x1"` // 裁剪框左上角 x 坐标(取值范围:[0, 1]
Y1 string `json:"y1"` // 裁剪框左上角 y 坐标(取值范围:[0, 1]
X2 string `json:"x2"` // 裁剪框右下角 x 坐标(取值范围:[0, 1]
Y2 string `json:"y2"` // 裁剪框右下角 y 坐标(取值范围:[0, 1]
}
// SetHeadImage 修改小程序头像
func (basic *Basic) SetHeadImage(imgMediaID string) error {
return basic.SetHeadImageFull(&SetHeadImageParam{
HeadImageMediaID: imgMediaID,
X1: "0",
Y1: "0",
X2: "1",
Y2: "1",
})
}
// SetHeadImageFull 修改小程序头像
// 新增临时素材: https://developers.weixin.qq.com/doc/offiaccount/Asset_Management/New_temporary_materials.html
// ref: https://developers.weixin.qq.com/doc/oplatform/openApi/OpenApiDoc/miniprogram-management/basic-info-management/setHeadImage.html
func (basic *Basic) SetHeadImageFull(param *SetHeadImageParam) error {
ak, err := basic.GetAuthrAccessToken(basic.AppID)
if err != nil {
return err
}
url := fmt.Sprintf("%s?access_token=%s", setHeadImageURL, ak)
data, err := util.PostJSON(url, param)
if err != nil {
return err
}
return util.DecodeWithError(data, &SetHeadImageResp{}, "account/setheadimage")
}

View File

@@ -1,6 +1,7 @@
package miniprogram
import (
originalContext "context"
"fmt"
"github.com/silenceper/wechat/v2/credential"
@@ -37,6 +38,22 @@ func (miniProgram *MiniProgram) GetAccessToken() (string, error) {
return akRes.AccessToken, nil
}
// GetAccessTokenContext 利用ctx获取ak
func (miniProgram *MiniProgram) GetAccessTokenContext(ctx originalContext.Context) (string, error) {
ak, akErr := miniProgram.openContext.GetAuthrAccessTokenContext(ctx, miniProgram.AppID)
if akErr == nil {
return ak, nil
}
if miniProgram.authorizerRefreshToken == "" {
return "", fmt.Errorf("please set the authorizer_refresh_token first")
}
akRes, akResErr := miniProgram.GetComponent().RefreshAuthrTokenContext(ctx, miniProgram.AppID, miniProgram.authorizerRefreshToken)
if akResErr != nil {
return "", akResErr
}
return akRes.AccessToken, nil
}
// SetAuthorizerRefreshToken 设置代执操作业务授权账号authorizer_refresh_token
func (miniProgram *MiniProgram) SetAuthorizerRefreshToken(authorizerRefreshToken string) *MiniProgram {
miniProgram.authorizerRefreshToken = authorizerRefreshToken
@@ -68,7 +85,7 @@ func (miniProgram *MiniProgram) GetBasic() *basic.Basic {
// GetURLLink 小程序URL Link接口 调用前需确认已调用 SetAuthorizerRefreshToken 避免由于缓存中 authorizer_access_token 过期执行中断
func (miniProgram *MiniProgram) GetURLLink() *urllink.URLLink {
return urllink.NewURLLink(&miniContext.Context{
AccessTokenHandle: miniProgram,
AccessTokenContextHandle: miniProgram,
})
}

View File

@@ -1,6 +1,7 @@
package js
import (
context2 "context"
"fmt"
"github.com/silenceper/wechat/v2/credential"
@@ -32,14 +33,31 @@ func (js *Js) SetJsTicketHandle(ticketHandle credential.JsTicketHandle) {
// GetConfig 第三方平台 - 获取jssdk需要的配置参数
// uri 为当前网页地址
func (js *Js) GetConfig(uri, appid string) (config *officialJs.Config, err error) {
config = new(officialJs.Config)
return js.GetConfigContext(context2.Background(), uri, appid)
}
// GetConfigContext 新方法,允许传入上下文,避免协程泄漏
func (js *Js) GetConfigContext(ctx context2.Context, uri, appid string) (config *officialJs.Config, err error) {
var accessToken string
accessToken, err = js.GetAccessToken()
// 类型断言,如果断言成功,调用安全的 GetAccessTokenContext 方法
if ctxHandle, ok := js.Context.AccessTokenHandle.(credential.AccessTokenContextHandle); ok {
accessToken, err = ctxHandle.GetAccessTokenContext(ctx)
} else {
// 如果没有实现 AccessTokenContextHandle 接口,调用旧的 GetAccessToken 方法
accessToken, err = js.Context.GetAccessToken()
}
if err != nil {
return
}
var ticketStr string
ticketStr, err = js.GetTicket(accessToken)
// 类型断言 jsTicket
if ticketCtxHandle, ok := js.JsTicketHandle.(credential.JsTicketContextHandle); ok {
ticketStr, err = ticketCtxHandle.GetTicketContext(ctx, accessToken)
} else {
// 如果没有实现 JsTicketContextHandle 接口,调用旧的 GetTicket 方法
ticketStr, err = js.GetTicket(accessToken)
}
if err != nil {
return
}
@@ -49,6 +67,7 @@ func (js *Js) GetConfig(uri, appid string) (config *officialJs.Config, err error
str := fmt.Sprintf("jsapi_ticket=%s&noncestr=%s&timestamp=%d&url=%s", ticketStr, nonceStr, timestamp, uri)
sigStr := util.Signature(str)
config = new(officialJs.Config)
config.AppID = appid
config.NonceStr = nonceStr
config.Timestamp = timestamp

View File

@@ -0,0 +1,147 @@
// 验证 js.GetConfigContext 是否能正确传递上下文到 HTTP 请求,确保上下文正确传播,防止在获取 JSSDK 配置时发生协程泄露。
package js
import (
"bytes"
context2 "context"
"errors"
"fmt"
"io"
"net/http"
"testing"
"github.com/silenceper/wechat/v2/cache"
"github.com/silenceper/wechat/v2/credential"
"github.com/silenceper/wechat/v2/officialaccount/config"
"github.com/silenceper/wechat/v2/officialaccount/context"
"github.com/silenceper/wechat/v2/util"
)
// mockAccessTokenHandle 模拟 AccessTokenHandle
type mockAccessTokenHandle struct{}
func (m *mockAccessTokenHandle) GetAccessToken() (string, error) {
return "mock-access-token", nil
}
func (m *mockAccessTokenHandle) GetAccessTokenContext(_ context2.Context) (string, error) {
return "mock-access-token", nil
}
// contextCheckingRoundTripper 自定义 RoundTripper 用于检查 context
type contextCheckingRoundTripper struct {
originalCtx context2.Context
t *testing.T
key interface{}
expectedVal interface{}
}
func (rt *contextCheckingRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
// 获取请求中的 context
reqCtx := req.Context()
// 打印 context 比较结果
rt.t.Logf("比较上下文的内存地址:\n")
if reqCtx == rt.originalCtx {
rt.t.Logf("上下文具有相同的内存地址。原始上下文: %p, 请求上下文: %p\n", rt.originalCtx, reqCtx)
} else {
rt.t.Logf("上下文具有不同的内存地址。原始上下文: %p, 请求上下文: %p\n", rt.originalCtx, reqCtx)
}
// 检查 context 中的键值对
if rt.key != nil {
value := reqCtx.Value(rt.key)
rt.t.Logf("检查请求上下文中的键 %v:\n", rt.key)
if value != rt.expectedVal {
rt.t.Errorf("上下文键 %v 的值不匹配: 预期 %v, 实际 %v\n", rt.key, rt.expectedVal, value)
} else {
rt.t.Logf("上下文键 %v 的值匹配: 预期 %v, 实际 %v\n", rt.key, rt.expectedVal, value)
}
}
// 检查上下文是否已取消
select {
case <-reqCtx.Done():
return nil, reqCtx.Err() // 返回上下文取消错误
default:
// 返回模拟的 HTTP 响应,包含有效的 JSON
responseBody := `{"ticket":"mock-ticket","expires_in":7200}`
response := &http.Response{
Status: "200 OK",
StatusCode: http.StatusOK,
Proto: "HTTP/1.1",
ProtoMajor: 1,
ProtoMinor: 1,
Body: io.NopCloser(bytes.NewReader([]byte(responseBody))),
ContentLength: int64(len(responseBody)),
Header: make(http.Header),
}
response.Header.Set("Content-Type", "application/json")
return response, nil
}
}
// contextKey 定义自定义上下文键类型,避免使用内置 string 类型
type contextKey string
// setupJsInstance 初始化 Js 实例和 HTTP 客户端
func setupJsInstance(t *testing.T, ctx context2.Context, key, val interface{}) (*Js, func()) {
cfg := &config.Config{
AppID: "test-app-id",
AppSecret: "test-app-secret",
Cache: cache.NewMemory(),
}
cacheKey := fmt.Sprintf("%s_jsapi_ticket_%s", credential.CacheKeyOfficialAccountPrefix, cfg.AppID)
if err := cfg.Cache.Delete(cacheKey); err != nil {
t.Fatalf("清除缓存失败: %v", err)
}
t.Log("清除 jsapi_ticket 的缓存:", cacheKey)
ctxHandle := &context.Context{Config: cfg, AccessTokenHandle: &mockAccessTokenHandle{}}
jsInstance := NewJs(ctxHandle, cfg.AppID)
jsInstance.SetJsTicketHandle(credential.NewDefaultJsTicket(cfg.AppID, credential.CacheKeyOfficialAccountPrefix, cfg.Cache))
originalClient := util.DefaultHTTPClient
util.DefaultHTTPClient = &http.Client{
Transport: &contextCheckingRoundTripper{originalCtx: ctx, t: t, key: key, expectedVal: val},
}
return jsInstance, func() { util.DefaultHTTPClient = originalClient }
}
// TestGetConfigContext 测试GetConfigContext的上下文传递和取消行为。
func TestGetConfigContext(t *testing.T) {
t.Run("ContextPassing", func(t *testing.T) {
ctxKey := contextKey("testKey111") // 使用自定义类型 contextKey
ctxValue := "testValue222"
ctx := context2.WithValue(context2.Background(), ctxKey, ctxValue)
t.Logf("创建的测试上下文: %p, 添加的键值对: %v=%v\n", ctx, ctxKey, ctxValue)
jsInstance, cleanup := setupJsInstance(t, ctx, ctxKey, ctxValue)
defer cleanup()
t.Log("调用 GetConfigContext")
config2, err := jsInstance.GetConfigContext(ctx, "https://www.baidu.com", "test-app-id")
if err != nil {
t.Fatalf("GetConfigContext 失败: %v", err)
}
if config2.AppID != "test-app-id" {
t.Errorf("预期 AppID 为 %s实际为 %s", "test-app-id", config2.AppID)
}
})
t.Run("ContextCancellation", func(t *testing.T) {
ctx, cancel := context2.WithCancel(context2.Background())
defer cancel()
jsInstance, cleanup := setupJsInstance(t, ctx, nil, nil)
defer cleanup()
cancel()
t.Log("调用 GetConfigContext已取消上下文")
_, err := jsInstance.GetConfigContext(ctx, "https://www.baidu.com", "test-app-id")
if err == nil {
t.Error("预期上下文取消错误,但 GetConfigContext 未返回错误")
} else if !errors.Is(err, context2.Canceled) {
t.Errorf("预期错误为 context.Canceled实际为: %v", err)
}
})
}

View File

@@ -4,6 +4,7 @@ import (
"github.com/silenceper/wechat/v2/pay/config"
"github.com/silenceper/wechat/v2/pay/notify"
"github.com/silenceper/wechat/v2/pay/order"
"github.com/silenceper/wechat/v2/pay/redpacket"
"github.com/silenceper/wechat/v2/pay/refund"
"github.com/silenceper/wechat/v2/pay/transfer"
)
@@ -37,3 +38,8 @@ func (pay *Pay) GetRefund() *refund.Refund {
func (pay *Pay) GetTransfer() *transfer.Transfer {
return transfer.NewTransfer(pay.cfg)
}
// GetRedpacket 红包
func (pay *Pay) GetRedpacket() *redpacket.Redpacket {
return redpacket.NewRedpacket(pay.cfg)
}

131
pay/redpacket/redpacket.go Normal file
View File

@@ -0,0 +1,131 @@
package redpacket
import (
"encoding/xml"
"fmt"
"strconv"
"github.com/silenceper/wechat/v2/pay/config"
"github.com/silenceper/wechat/v2/util"
)
// redpacketGateway 发放红包接口
// https://pay.weixin.qq.com/wiki/doc/api/tools/cash_coupon.php?chapter=13_4&index=3
var redpacketGateway = "https://api.mch.weixin.qq.com/mmpaymkttransfers/sendredpack"
// Redpacket struct extends context
type Redpacket struct {
*config.Config
}
// NewRedpacket return an instance of Redpacket package
func NewRedpacket(cfg *config.Config) *Redpacket {
return &Redpacket{cfg}
}
// Params 调用参数
type Params struct {
MchBillno string // 商户订单号
SendName string // 商户名称
ReOpenID string
TotalAmount int
TotalNum int
Wishing string
ClientIP string
ActName string
Remark string
RootCa string // ca证书
}
// request 接口请求参数
type request struct {
NonceStr string `xml:"nonce_str"`
Sign string `xml:"sign"`
MchID string `xml:"mch_id"`
MchBillno string `xml:"mch_billno"`
Wxappid string `xml:"wxappid"`
SendName string `xml:"send_name"`
ReOpenID string `xml:"re_openid"`
TotalAmount int `xml:"total_amount"`
TotalNum int `xml:"total_num"`
Wishing string `xml:"wishing"`
ClientIP string `xml:"client_ip"`
ActName string `xml:"act_name"`
Remark string `xml:"remark"`
}
// Response 接口返回
type Response struct {
ReturnCode string `xml:"return_code"`
ReturnMsg string `xml:"return_msg"`
ResultCode string `xml:"result_code,omitempty"`
ErrCode string `xml:"err_code,omitempty"`
ErrCodeDes string `xml:"err_code_des,omitempty"`
MchBillno string `xml:"mch_billno,omitempty"`
MchID string `xml:"mch_id,omitempty"`
Wxappid string `xml:"wxappid"`
ReOpenID string `xml:"re_openid"`
TotalAmount int `xml:"total_amount"`
SendListid string `xml:"send_listid"`
}
// SendRedpacket 发放红包
func (redpacket *Redpacket) SendRedpacket(p *Params) (rsp *Response, err error) {
nonceStr := util.RandomStr(32)
param := make(map[string]string)
param["nonce_str"] = nonceStr
param["mch_id"] = redpacket.MchID
param["wxappid"] = redpacket.AppID
param["mch_billno"] = p.MchBillno
param["send_name"] = p.SendName
param["re_openid"] = p.ReOpenID
param["total_amount"] = strconv.Itoa(p.TotalAmount)
param["total_num"] = strconv.Itoa(p.TotalNum)
param["wishing"] = p.Wishing
param["client_ip"] = p.ClientIP
param["act_name"] = p.ActName
param["remark"] = p.Remark
//param["scene_id"] = "PRODUCT_2"
sign, err := util.ParamSign(param, redpacket.Key)
if err != nil {
return
}
req := request{
NonceStr: nonceStr,
Sign: sign,
MchID: redpacket.MchID,
Wxappid: redpacket.AppID,
MchBillno: p.MchBillno,
SendName: p.SendName,
ReOpenID: p.ReOpenID,
TotalAmount: p.TotalAmount,
TotalNum: p.TotalNum,
Wishing: p.Wishing,
ClientIP: p.ClientIP,
ActName: p.ActName,
Remark: p.Remark,
}
rawRet, err := util.PostXMLWithTLS(redpacketGateway, req, p.RootCa, redpacket.MchID)
if err != nil {
return
}
err = xml.Unmarshal(rawRet, &rsp)
if err != nil {
return
}
if rsp.ReturnCode == "SUCCESS" {
if rsp.ResultCode == "SUCCESS" {
err = nil
return
}
err = fmt.Errorf("send redpacket error, errcode=%s,errmsg=%s", rsp.ErrCode, rsp.ErrCodeDes)
return
}
err = fmt.Errorf("[msg : xmlUnmarshalError] [rawReturn : %s] [sign : %s]", string(rawRet), sign)
return
}

View File

@@ -68,3 +68,18 @@ func DecodeWithError(response []byte, obj interface{}, apiName string) error {
}
return nil
}
// HandleFileResponse 通用处理微信等接口返回:有时 JSON 错误,有时文件内容
func HandleFileResponse(response []byte, apiName string) ([]byte, error) {
var commErr CommonError
if err := json.Unmarshal(response, &commErr); err == nil {
// 能解析成 JSON判断是否为错误
if commErr.ErrCode != 0 {
commErr.apiName = apiName
return nil, &commErr
}
// 能解析成 JSON 且没错误码,极少情况(比如微信返回的业务数据是 JSON 但无 errcode 字段),可根据需要调整
}
// 不能解析成 JSON或没错误码直接返回原始内容
return response, nil
}

View File

@@ -17,6 +17,19 @@ import (
"golang.org/x/crypto/pkcs12"
)
// URIModifier URI修改器
type URIModifier func(uri string) string
var uriModifier URIModifier
// DefaultHTTPClient 默认httpClient
var DefaultHTTPClient = http.DefaultClient
// SetURIModifier 设置URI修改器
func SetURIModifier(fn URIModifier) {
uriModifier = fn
}
// HTTPGet get 请求
func HTTPGet(uri string) ([]byte, error) {
return HTTPGetContext(context.Background(), uri)
@@ -24,11 +37,14 @@ func HTTPGet(uri string) ([]byte, error) {
// HTTPGetContext get 请求
func HTTPGetContext(ctx context.Context, uri string) ([]byte, error) {
if uriModifier != nil {
uri = uriModifier(uri)
}
request, err := http.NewRequestWithContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, err
}
response, err := http.DefaultClient.Do(request)
response, err := DefaultHTTPClient.Do(request)
if err != nil {
return nil, err
}
@@ -47,6 +63,9 @@ func HTTPPost(uri string, data string) ([]byte, error) {
// HTTPPostContext post 请求
func HTTPPostContext(ctx context.Context, uri string, data []byte, header map[string]string) ([]byte, error) {
if uriModifier != nil {
uri = uriModifier(uri)
}
body := bytes.NewBuffer(data)
request, err := http.NewRequestWithContext(ctx, http.MethodPost, uri, body)
if err != nil {
@@ -57,7 +76,7 @@ func HTTPPostContext(ctx context.Context, uri string, data []byte, header map[st
request.Header.Set(key, value)
}
response, err := http.DefaultClient.Do(request)
response, err := DefaultHTTPClient.Do(request)
if err != nil {
return nil, err
}
@@ -71,6 +90,9 @@ func HTTPPostContext(ctx context.Context, uri string, data []byte, header map[st
// PostJSONContext post json 数据请求
func PostJSONContext(ctx context.Context, uri string, obj interface{}) ([]byte, error) {
if uriModifier != nil {
uri = uriModifier(uri)
}
jsonBuf := new(bytes.Buffer)
enc := json.NewEncoder(jsonBuf)
enc.SetEscapeHTML(false)
@@ -83,7 +105,7 @@ func PostJSONContext(ctx context.Context, uri string, obj interface{}) ([]byte,
return nil, err
}
req.Header.Set("Content-Type", "application/json;charset=utf-8")
response, err := http.DefaultClient.Do(req)
response, err := DefaultHTTPClient.Do(req)
if err != nil {
return nil, err
}
@@ -110,7 +132,7 @@ func PostJSONWithRespContentType(uri string, obj interface{}) ([]byte, string, e
return nil, "", err
}
response, err := http.Post(uri, "application/json;charset=utf-8", jsonBuf)
response, err := DefaultHTTPClient.Post(uri, "application/json;charset=utf-8", jsonBuf)
if err != nil {
return nil, "", err
}
@@ -124,13 +146,41 @@ func PostJSONWithRespContentType(uri string, obj interface{}) ([]byte, string, e
return responseData, contentType, err
}
// PostFileByStream 上传文件
func PostFileByStream(fieldName, fileName, uri string, byteData []byte) ([]byte, error) {
fields := []MultipartFormField{
{
IsFile: false,
Fieldname: fieldName,
Filename: fileName,
Value: byteData,
},
}
return PostMultipartForm(fields, uri)
}
// PostFile 上传文件
func PostFile(fieldName, filename, uri string) ([]byte, error) {
func PostFile(fieldName, filePath, uri string) ([]byte, error) {
fields := []MultipartFormField{
{
IsFile: true,
Fieldname: fieldName,
Filename: filename,
FilePath: filePath,
Filename: filePath,
},
}
return PostMultipartForm(fields, uri)
}
// PostFileFromReader 上传文件,从 io.Reader 中读取
func PostFileFromReader(filedName, filePath, fileName, uri string, reader io.Reader) ([]byte, error) {
fields := []MultipartFormField{
{
IsFile: true,
Fieldname: filedName,
FilePath: filePath,
Filename: fileName,
FileReader: reader,
},
}
return PostMultipartForm(fields, uri)
@@ -138,14 +188,19 @@ func PostFile(fieldName, filename, uri string) ([]byte, error) {
// MultipartFormField 保存文件或其他字段信息
type MultipartFormField struct {
IsFile bool
Fieldname string
Value []byte
Filename string
IsFile bool
Fieldname string
Value []byte
FilePath string
Filename string
FileReader io.Reader
}
// PostMultipartForm 上传文件或其他多个字段
func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte, err error) {
if uriModifier != nil {
uri = uriModifier(uri)
}
bodyBuf := &bytes.Buffer{}
bodyWriter := multipart.NewWriter(bodyBuf)
@@ -157,18 +212,24 @@ func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte
return
}
fh, e := os.Open(field.Filename)
if e != nil {
err = fmt.Errorf("error opening file , err=%v", e)
return
}
defer fh.Close()
if _, err = io.Copy(fileWriter, fh); err != nil {
return
if field.FileReader == nil {
fh, e := os.Open(field.FilePath)
if e != nil {
err = fmt.Errorf("error opening file , err=%v", e)
return
}
_, err = io.Copy(fileWriter, fh)
_ = fh.Close()
if err != nil {
return
}
} else {
if _, err = io.Copy(fileWriter, field.FileReader); err != nil {
return
}
}
} else {
partWriter, e := bodyWriter.CreateFormField(field.Fieldname)
partWriter, e := bodyWriter.CreateFormFile(field.Fieldname, field.Filename)
if e != nil {
err = e
return
@@ -183,14 +244,14 @@ func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte
contentType := bodyWriter.FormDataContentType()
bodyWriter.Close()
resp, e := http.Post(uri, contentType, bodyBuf)
resp, e := DefaultHTTPClient.Post(uri, contentType, bodyBuf)
if e != nil {
err = e
return
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return nil, err
return nil, fmt.Errorf("http code error : uri=%v , statusCode=%v", uri, resp.StatusCode)
}
respBody, err = io.ReadAll(resp.Body)
return
@@ -198,13 +259,16 @@ func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte
// PostXML perform a HTTP/POST request with XML body
func PostXML(uri string, obj interface{}) ([]byte, error) {
if uriModifier != nil {
uri = uriModifier(uri)
}
xmlData, err := xml.Marshal(obj)
if err != nil {
return nil, err
}
body := bytes.NewBuffer(xmlData)
response, err := http.Post(uri, "application/xml;charset=utf-8", body)
response, err := DefaultHTTPClient.Post(uri, "application/xml;charset=utf-8", body)
if err != nil {
return nil, err
}
@@ -227,11 +291,23 @@ func httpWithTLS(rootCa, key string) (*http.Client, error) {
config := &tls.Config{
Certificates: []tls.Certificate{cert},
}
tr := &http.Transport{
TLSClientConfig: config,
DisableCompression: true,
// 安全地获取 *http.Transport
var trans *http.Transport
// 尝试从 DefaultHTTPClient 获取 Transport如果失败则使用默认值
if DefaultHTTPClient.Transport != nil {
if t, ok := DefaultHTTPClient.Transport.(*http.Transport); ok {
trans = t.Clone()
}
}
client = &http.Client{Transport: tr}
// 如果无法获取有效的 Transport使用默认值
if trans == nil {
trans = http.DefaultTransport.(*http.Transport).Clone()
}
trans.TLSClientConfig = config
trans.DisableCompression = true
client = &http.Client{Transport: trans}
return client, nil
}
@@ -259,6 +335,9 @@ func pkcs12ToPem(p12 []byte, password string) tls.Certificate {
// PostXMLWithTLS perform a HTTP/POST request with XML body and TLS
func PostXMLWithTLS(uri string, obj interface{}, ca, key string) ([]byte, error) {
if uriModifier != nil {
uri = uriModifier(uri)
}
xmlData, err := xml.Marshal(obj)
if err != nil {
return nil, err

81
util/http_test.go Normal file
View File

@@ -0,0 +1,81 @@
package util
import (
"net/http"
"testing"
)
// TestHttpWithTLS_NilTransport tests the scenario where DefaultHTTPClient.Transport is nil
func TestHttpWithTLS_NilTransport(t *testing.T) {
// Save original transport
originalTransport := DefaultHTTPClient.Transport
defer func() {
DefaultHTTPClient.Transport = originalTransport
}()
// Set Transport to nil to simulate the bug scenario
DefaultHTTPClient.Transport = nil
// This should not panic after the fix
// Note: This will fail due to invalid cert path, but shouldn't panic on type assertion
_, err := httpWithTLS("./testdata/invalid_cert.p12", "password")
// We expect an error (cert file not found), but NOT a panic
if err == nil {
t.Error("Expected error due to invalid cert path, but got nil")
}
}
// TestHttpWithTLS_CustomTransport tests the scenario where DefaultHTTPClient has a custom Transport
func TestHttpWithTLS_CustomTransport(t *testing.T) {
// Save original transport
originalTransport := DefaultHTTPClient.Transport
defer func() {
DefaultHTTPClient.Transport = originalTransport
}()
// Set a custom http.Transport
customTransport := &http.Transport{
MaxIdleConns: 100,
}
DefaultHTTPClient.Transport = customTransport
// This should not panic
_, err := httpWithTLS("./testdata/invalid_cert.p12", "password")
// We expect an error (cert file not found), but NOT a panic
if err == nil {
t.Error("Expected error due to invalid cert path, but got nil")
}
}
// CustomRoundTripper is a custom implementation of http.RoundTripper
type CustomRoundTripper struct{}
func (c *CustomRoundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
return http.DefaultTransport.RoundTrip(req)
}
// TestHttpWithTLS_CustomRoundTripper tests the edge case where DefaultHTTPClient has a custom RoundTripper
// that is NOT *http.Transport
func TestHttpWithTLS_CustomRoundTripper(t *testing.T) {
// Save original transport
originalTransport := DefaultHTTPClient.Transport
defer func() {
DefaultHTTPClient.Transport = originalTransport
}()
// Set a custom RoundTripper that is NOT *http.Transport
customRoundTripper := &CustomRoundTripper{}
DefaultHTTPClient.Transport = customRoundTripper
// Create a recovery handler to catch potential panic
defer func() {
if r := recover(); r != nil {
t.Errorf("httpWithTLS panicked with custom RoundTripper: %v", r)
}
}()
// This might panic if the code doesn't handle non-*http.Transport RoundTripper properly
_, _ = httpWithTLS("./testdata/invalid_cert.p12", "password")
}

View File

@@ -1,6 +1,7 @@
package wechat
import (
"net/http"
"os"
log "github.com/sirupsen/logrus"
@@ -14,6 +15,7 @@ import (
openConfig "github.com/silenceper/wechat/v2/openplatform/config"
"github.com/silenceper/wechat/v2/pay"
payConfig "github.com/silenceper/wechat/v2/pay/config"
"github.com/silenceper/wechat/v2/util"
"github.com/silenceper/wechat/v2/work"
workConfig "github.com/silenceper/wechat/v2/work/config"
)
@@ -81,3 +83,8 @@ func (wc *Wechat) GetWork(cfg *workConfig.Config) *work.Work {
}
return work.NewWork(cfg)
}
// SetHTTPClient 设置HTTPClient
func (wc *Wechat) SetHTTPClient(client *http.Client) {
util.DefaultHTTPClient = client
}

View File

@@ -9,10 +9,17 @@ import (
const (
// departmentCreateURL 创建部门
departmentCreateURL = "https://qyapi.weixin.qq.com/cgi-bin/department/create?access_token=%s"
// departmentUpdateURL 更新部门
departmentUpdateURL = "https://qyapi.weixin.qq.com/cgi-bin/department/update?access_token=%s"
// departmentDeleteURL 删除部门
departmentDeleteURL = "https://qyapi.weixin.qq.com/cgi-bin/department/delete?access_token=%s&id=%d"
// departmentSimpleListURL 获取子部门ID列表
departmentSimpleListURL = "https://qyapi.weixin.qq.com/cgi-bin/department/simplelist?access_token=%s&id=%d"
// departmentListURL 获取部门列表
departmentListURL = "https://qyapi.weixin.qq.com/cgi-bin/department/list?access_token=%s"
departmentListURL = "https://qyapi.weixin.qq.com/cgi-bin/department/list?access_token=%s"
departmentListByIDURL = "https://qyapi.weixin.qq.com/cgi-bin/department/list?access_token=%s&id=%d"
// departmentGetURL 获取单个部门详情
departmentGetURL = "https://qyapi.weixin.qq.com/cgi-bin/department/get?access_token=%s&id=%d"
)
type (
@@ -56,6 +63,11 @@ type (
ParentID int `json:"parentid"` // 父部门id。根部门为1
Order int `json:"order"` // 在父部门中的次序值。order值大的排序靠前
}
// DepartmentGetResponse 获取单个部门详情
DepartmentGetResponse struct {
util.CommonError
Department Department `json:"department"`
}
)
// DepartmentCreate 创建部门
@@ -73,10 +85,51 @@ func (r *Client) DepartmentCreate(req *DepartmentCreateRequest) (*DepartmentCrea
return nil, err
}
result := &DepartmentCreateResponse{}
if err = util.DecodeWithError(response, result, "DepartmentCreate"); err != nil {
return nil, err
err = util.DecodeWithError(response, result, "DepartmentCreate")
return result, err
}
// DepartmentUpdateRequest 更新部门请求
type DepartmentUpdateRequest struct {
ID int `json:"id"`
Name string `json:"name,omitempty"`
NameEn string `json:"name_en,omitempty"`
ParentID int `json:"parentid,omitempty"`
Order int `json:"order,omitempty"`
}
// DepartmentUpdate 更新部门
// see https://developer.work.weixin.qq.com/document/path/90206
func (r *Client) DepartmentUpdate(req *DepartmentUpdateRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
return result, nil
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(departmentUpdateURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "DepartmentUpdate")
}
// DepartmentDelete 删除部门
// @see https://developer.work.weixin.qq.com/document/path/90207
func (r *Client) DepartmentDelete(departmentID int) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(departmentDeleteURL, accessToken, departmentID)); err != nil {
return err
}
return util.DecodeWithCommonError(response, "DepartmentDelete")
}
// DepartmentSimpleList 获取子部门ID列表
@@ -94,30 +147,63 @@ func (r *Client) DepartmentSimpleList(departmentID int) ([]*DepartmentID, error)
return nil, err
}
result := &DepartmentSimpleListResponse{}
if err = util.DecodeWithError(response, result, "DepartmentSimpleList"); err != nil {
return nil, err
}
return result.DepartmentID, nil
err = util.DecodeWithError(response, result, "DepartmentSimpleList")
return result.DepartmentID, err
}
// DepartmentList 获取部门列表
// @desc https://developer.work.weixin.qq.com/document/path/90208
func (r *Client) DepartmentList() ([]*Department, error) {
return r.DepartmentListByID(0)
}
// DepartmentListByID 获取部门列表
//
// departmentID 部门id。获取指定部门及其下的子部门以及子部门的子部门等等递归
//
// @desc https://developer.work.weixin.qq.com/document/path/90208
func (r *Client) DepartmentListByID(departmentID int) ([]*Department, error) {
var formatURL string
// 获取accessToken
accessToken, err := r.GetAccessToken()
if err != nil {
return nil, err
}
if departmentID > 0 {
formatURL = fmt.Sprintf(departmentListByIDURL, accessToken, departmentID)
} else {
formatURL = fmt.Sprintf(departmentListURL, accessToken)
}
// 发起http请求
response, err := util.HTTPGet(fmt.Sprintf(departmentListURL, accessToken))
response, err := util.HTTPGet(formatURL)
if err != nil {
return nil, err
}
// 按照结构体解析返回值
result := &DepartmentListResponse{}
if err = util.DecodeWithError(response, result, "DepartmentList"); err != nil {
return nil, err
}
err = util.DecodeWithError(response, result, "DepartmentList")
// 返回数据
return result.Department, err
}
// DepartmentGet 获取单个部门详情
// see https://developer.work.weixin.qq.com/document/path/95351
func (r *Client) DepartmentGet(departmentID int) (*Department, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(departmentGetURL, accessToken, departmentID)); err != nil {
return nil, err
}
result := &DepartmentGetResponse{}
err = util.DecodeWithError(response, result, "DepartmentGet")
return &result.Department, err
}

View File

@@ -41,10 +41,8 @@ func (r *Client) GetPermList() (*GetPermListResponse, error) {
return nil, err
}
result := &GetPermListResponse{}
if err = util.DecodeWithError(response, result, "GetPermList"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetPermList")
return result, err
}
// GetLinkedCorpUserRequest 获取互联企业成员详细信息请求
@@ -111,10 +109,8 @@ func (r *Client) GetLinkedCorpUser(req *GetLinkedCorpUserRequest) (*GetLinkedCor
return nil, err
}
result := &GetLinkedCorpUserResponse{}
if err = util.DecodeWithError(response, result, "GetLinkedCorpUser"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetLinkedCorpUser")
return result, err
}
// LinkedCorpSimpleListRequest 获取互联企业部门成员请求
@@ -151,10 +147,8 @@ func (r *Client) LinkedCorpSimpleList(req *LinkedCorpSimpleListRequest) (*Linked
return nil, err
}
result := &LinkedCorpSimpleListResponse{}
if err = util.DecodeWithError(response, result, "LinkedCorpSimpleList"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "LinkedCorpSimpleList")
return result, err
}
// LinkedCorpUserListRequest 获取互联企业部门成员详情请求
@@ -183,10 +177,8 @@ func (r *Client) LinkedCorpUserList(req *LinkedCorpUserListRequest) (*LinkedCorp
return nil, err
}
result := &LinkedCorpUserListResponse{}
if err = util.DecodeWithError(response, result, "LinkedCorpUserList"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "LinkedCorpUserList")
return result, err
}
// LinkedCorpDepartmentListRequest 获取互联企业部门列表请求
@@ -223,8 +215,6 @@ func (r *Client) LinkedCorpDepartmentList(req *LinkedCorpDepartmentListRequest)
return nil, err
}
result := &LinkedCorpDepartmentListResponse{}
if err = util.DecodeWithError(response, result, "LinkedCorpDepartmentList"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "LinkedCorpDepartmentList")
return result, err
}

View File

@@ -51,10 +51,8 @@ func (r *Client) CreateTag(req *CreateTagRequest) (*CreateTagResponse, error) {
return nil, err
}
result := &CreateTagResponse{}
if err = util.DecodeWithError(response, result, "CreateTag"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "CreateTag")
return result, err
}
type (
@@ -129,10 +127,8 @@ func (r *Client) GetTag(tagID int) (*GetTagResponse, error) {
return nil, err
}
result := &GetTagResponse{}
if err = util.DecodeWithError(response, result, "GetTag"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetTag")
return result, err
}
type (
@@ -165,10 +161,8 @@ func (r *Client) AddTagUsers(req *AddTagUsersRequest) (*AddTagUsersResponse, err
return nil, err
}
result := &AddTagUsersResponse{}
if err = util.DecodeWithError(response, result, "AddTagUsers"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "AddTagUsers")
return result, err
}
type (
@@ -201,10 +195,8 @@ func (r *Client) DelTagUsers(req *DelTagUsersRequest) (*DelTagUsersResponse, err
return nil, err
}
result := &DelTagUsersResponse{}
if err = util.DecodeWithError(response, result, "DelTagUsers"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "DelTagUsers")
return result, err
}
type (
@@ -235,8 +227,6 @@ func (r *Client) ListTag() (*ListTagResponse, error) {
return nil, err
}
result := &ListTagResponse{}
if err = util.DecodeWithError(response, result, "ListTag"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "ListTag")
return result, err
}

View File

@@ -12,6 +12,8 @@ const (
userSimpleListURL = "https://qyapi.weixin.qq.com/cgi-bin/user/simplelist"
// userCreateURL 创建成员
userCreateURL = "https://qyapi.weixin.qq.com/cgi-bin/user/create?access_token=%s"
// userUpdateURL 更新成员
userUpdateURL = "https://qyapi.weixin.qq.com/cgi-bin/user/update?access_token=%s"
// userGetURL 读取成员
userGetURL = "https://qyapi.weixin.qq.com/cgi-bin/user/get"
// userDeleteURL 删除成员
@@ -22,6 +24,18 @@ const (
convertToOpenIDURL = "https://qyapi.weixin.qq.com/cgi-bin/user/convert_to_openid"
// convertToUserIDURL openID转userID
convertToUserIDURL = "https://qyapi.weixin.qq.com/cgi-bin/user/convert_to_userid"
// userBatchDeleteURL 批量删除成员
userBatchDeleteURL = "https://qyapi.weixin.qq.com/cgi-bin/user/batchdelete?access_token=%s"
// userAuthSuccURL 登录二次验证
userAuthSuccURL = "https://qyapi.weixin.qq.com/cgi-bin/user/authsucc?access_token=%s&userid=%s"
// batchInviteURL 邀请成员
batchInviteURL = "https://qyapi.weixin.qq.com/cgi-bin/batch/invite?access_token=%s"
// getJoinQrcodeURL 获取加入企业二维码
getJoinQrcodeURL = "https://qyapi.weixin.qq.com/cgi-bin/corp/get_join_qrcode"
// getUseridURL 手机号获取userid
getUseridURL = "https://qyapi.weixin.qq.com/cgi-bin/user/getuserid?access_token=%s"
// getUseridByEmailURL 邮箱获取userid
getUseridByEmailURL = "https://qyapi.weixin.qq.com/cgi-bin/user/get_userid_by_email?access_token=%s"
)
type (
@@ -61,10 +75,7 @@ func (r *Client) UserSimpleList(departmentID int) ([]*UserList, error) {
}
result := &UserSimpleListResponse{}
err = util.DecodeWithError(response, result, "UserSimpleList")
if err != nil {
return nil, err
}
return result.UserList, nil
return result.UserList, err
}
type (
@@ -153,10 +164,56 @@ func (r *Client) UserCreate(req *UserCreateRequest) (*UserCreateResponse, error)
return nil, err
}
result := &UserCreateResponse{}
if err = util.DecodeWithError(response, result, "UserCreate"); err != nil {
return nil, err
err = util.DecodeWithError(response, result, "UserCreate")
return result, err
}
// UserUpdateRequest 更新成员请求
type UserUpdateRequest struct {
UserID string `json:"userid"`
NewUserID string `json:"new_userid"`
Name string `json:"name"`
Alias string `json:"alias"`
Mobile string `json:"mobile"`
Department []int `json:"department"`
Order []int `json:"order"`
Position string `json:"position"`
Gender int `json:"gender"`
Email string `json:"email"`
BizMail string `json:"biz_mail"`
BizMailAlias struct {
Item []string `json:"item"`
} `json:"biz_mail_alias"`
IsLeaderInDept []int `json:"is_leader_in_dept"`
DirectLeader []string `json:"direct_leader"`
Enable int `json:"enable"`
AvatarMediaid string `json:"avatar_mediaid"`
Telephone string `json:"telephone"`
Address string `json:"address"`
MainDepartment int `json:"main_department"`
Extattr struct {
Attrs []ExtraAttr `json:"attrs"`
} `json:"extattr"`
ToInvite bool `json:"to_invite"`
ExternalPosition string `json:"external_position"`
ExternalProfile ExternalProfile `json:"external_profile"`
}
// UserUpdate 更新成员
// see https://developer.work.weixin.qq.com/document/path/90197
func (r *Client) UserUpdate(req *UserUpdateRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
return result, nil
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(userUpdateURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "UserUpdate")
}
// UserGetResponse 获取部门成员响应
@@ -221,7 +278,7 @@ type UserGetResponse struct {
} `json:"external_profile"` // 成员对外属性,字段详情见对外属性;代开发自建应用需要管理员授权才返回;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段
}
// UserGet 获取部门成员
// UserGet 读取成员
// @see https://developer.work.weixin.qq.com/document/path/90196
func (r *Client) UserGet(UserID string) (*UserGetResponse, error) {
var (
@@ -237,18 +294,15 @@ func (r *Client) UserGet(UserID string) (*UserGetResponse, error) {
strings.Join([]string{
userGetURL,
util.Query(map[string]interface{}{
"access_token": accessToken,
"department_id": UserID,
"access_token": accessToken,
"userid": UserID,
}),
}, "?")); err != nil {
return nil, err
}
result := &UserGetResponse{}
err = util.DecodeWithError(response, result, "UserGet")
if err != nil {
return nil, err
}
return result, nil
return result, err
}
type (
@@ -279,10 +333,8 @@ func (r *Client) UserDelete(userID string) (*UserDeleteResponse, error) {
return nil, err
}
result := &UserDeleteResponse{}
if err = util.DecodeWithError(response, result, "UserDelete"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "UserDelete")
return result, err
}
// UserListIDRequest 获取成员ID列表请求
@@ -324,10 +376,8 @@ func (r *Client) UserListID(req *UserListIDRequest) (*UserListIDResponse, error)
return nil, err
}
result := &UserListIDResponse{}
if err = util.DecodeWithError(response, result, "UserListID"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "UserListID")
return result, err
}
type (
@@ -366,10 +416,8 @@ func (r *Client) ConvertToOpenID(userID string) (string, error) {
return "", err
}
result := &convertToOpenIDResponse{}
if err = util.DecodeWithError(response, result, "ConvertToOpenID"); err != nil {
return "", err
}
return result.OpenID, nil
err = util.DecodeWithError(response, result, "ConvertToOpenID")
return result.OpenID, err
}
type (
@@ -408,8 +456,170 @@ func (r *Client) ConvertToUserID(openID string) (string, error) {
return "", err
}
result := &convertToUserIDResponse{}
if err = util.DecodeWithError(response, result, "ConvertToUserID"); err != nil {
return "", err
}
return result.UserID, nil
err = util.DecodeWithError(response, result, "ConvertToUserID")
return result.UserID, err
}
// UserBatchDeleteRequest 批量删除成员请求
type UserBatchDeleteRequest struct {
UseridList []string `json:"useridlist"`
}
// UserBatchDelete 批量删除成员
// see https://developer.work.weixin.qq.com/document/path/90199
func (r *Client) UserBatchDelete(req *UserBatchDeleteRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(userBatchDeleteURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "UserBatchDelete")
}
// UserAuthSucc 登录二次验证
// @see https://developer.work.weixin.qq.com/document/path/90203
func (r *Client) UserAuthSucc(userID string) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(userAuthSuccURL, accessToken, userID)); err != nil {
return err
}
return util.DecodeWithCommonError(response, "UserAuthSucc")
}
// BatchInviteRequest 邀请成员请求
type BatchInviteRequest struct {
User []string `json:"user"`
Party []int `json:"party"`
Tag []int `json:"tag"`
}
// BatchInviteResponse 邀请成员响应
type BatchInviteResponse struct {
util.CommonError
InvalidUser []string `json:"invaliduser"`
InvalidParty []int `json:"invalidparty"`
InvalidTag []int `json:"invalidtag"`
}
// BatchInvite 邀请成员
// see https://developer.work.weixin.qq.com/document/path/90975
func (r *Client) BatchInvite(req *BatchInviteRequest) (*BatchInviteResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(batchInviteURL, accessToken), req); err != nil {
return nil, err
}
result := &BatchInviteResponse{}
err = util.DecodeWithError(response, result, "BatchInvite")
return result, err
}
// GetJoinQrcodeRequest 获取加入企业二维码请求
type GetJoinQrcodeRequest struct {
SizeType int `json:"size_type"`
}
// GetJoinQrcodeResponse 获取加入企业二维码响应
type GetJoinQrcodeResponse struct {
util.CommonError
JoinQrcode string `json:"join_qrcode"`
}
// GetJoinQrcode 获取加入企业二维码
// see https://developer.work.weixin.qq.com/document/path/91714
func (r *Client) GetJoinQrcode(req *GetJoinQrcodeRequest) (*GetJoinQrcodeResponse, error) {
var (
accessToken string
err error
apiURL string
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
if req.SizeType > 0 {
apiURL = fmt.Sprintf("%s?access_token=%s&size_type=%d", getJoinQrcodeURL, accessToken, req.SizeType)
} else {
apiURL = fmt.Sprintf("%s?access_token=%s", getJoinQrcodeURL, accessToken)
}
var response []byte
if response, err = util.HTTPGet(apiURL); err != nil {
return nil, err
}
result := &GetJoinQrcodeResponse{}
err = util.DecodeWithError(response, result, "GetJoinQrcode")
return result, err
}
// GetUseridRequest 手机号获取userid请求
type GetUseridRequest struct {
Mobile string `json:"mobile"`
}
// GetUseridResponse 获取userid响应
type GetUseridResponse struct {
util.CommonError
Userid string `json:"userid"`
}
// GetUserid 手机号获取userid
// see https://developer.work.weixin.qq.com/document/path/95402
func (r *Client) GetUserid(req *GetUseridRequest) (*GetUseridResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(getUseridURL, accessToken), req); err != nil {
return nil, err
}
result := &GetUseridResponse{}
err = util.DecodeWithError(response, result, "GetUserid")
return result, err
}
// GetUseridByEmailRequest 邮箱获取userid请求
type GetUseridByEmailRequest struct {
Email string `json:"email"`
EmailType int `json:"email_type,omitempty"`
}
// GetUseridByEmail 邮箱获取userid
// see https://developer.work.weixin.qq.com/document/path/95895
func (r *Client) GetUseridByEmail(req *GetUseridByEmailRequest) (*GetUseridResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(getUseridByEmailURL, accessToken), req); err != nil {
return nil, err
}
result := &GetUseridResponse{}
err = util.DecodeWithError(response, result, "GetUseridByEmail")
return result, err
}

View File

@@ -82,11 +82,9 @@ func (r *Client) Send(apiName string, request interface{}) (*SendResponse, error
}
// 按照结构体解析返回值
result := &SendResponse{}
if err = util.DecodeWithError(response, result, apiName); err != nil {
return nil, err
}
err = util.DecodeWithError(response, result, apiName)
// 返回数据
return result, nil
return result, err
}
// SendText 发送文本消息

443
work/checkin/checkin.go Normal file
View File

@@ -0,0 +1,443 @@
package checkin
import (
"fmt"
"github.com/silenceper/wechat/v2/util"
)
const (
// setScheduleListURL 为打卡人员排班
setScheduleListURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/setcheckinschedulist?access_token=%s"
// punchCorrectionURL 为打卡人员补卡
punchCorrectionURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/punch_correction?access_token=%s"
// addUserFaceURL 录入打卡人员人脸信息
addUserFaceURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/addcheckinuserface?access_token=%s"
// addOptionURL 创建打卡规则
addOptionURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/add_checkin_option?access_token=%s"
// updateOptionURL 修改打卡规则
updateOptionURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/update_checkin_option?access_token=%s"
// clearOptionURL 清空打卡规则数组元素
clearOptionURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/clear_checkin_option_array_field?access_token=%s"
// delOptionURL 删除打卡规则
delOptionURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/del_checkin_option?access_token=%s"
// addRecordURL 添加打卡记录
addRecordURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/add_checkin_record?access_token=%s"
)
// SetScheduleListRequest 为打卡人员排班请求
type SetScheduleListRequest struct {
GroupID int64 `json:"groupid"`
Items []SetScheduleListItem `json:"items"`
YearMonth int64 `json:"yearmonth"`
}
// SetScheduleListItem 排班表信息
type SetScheduleListItem struct {
UserID string `json:"userid"`
Day int64 `json:"day"`
ScheduleID int64 `json:"schedule_id"`
}
// SetScheduleList 为打卡人员排班
// see https://developer.work.weixin.qq.com/document/path/93385
func (r *Client) SetScheduleList(req *SetScheduleListRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(setScheduleListURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "SetScheduleList")
}
// PunchCorrectionRequest 为打卡人员补卡请求
type PunchCorrectionRequest struct {
UserID string `json:"userid"`
ScheduleDateTime int64 `json:"schedule_date_time"`
ScheduleCheckinTime int64 `json:"schedule_checkin_time"`
CheckinTime int64 `json:"checkin_time"`
Remark string `json:"remark"`
}
// PunchCorrection 为打卡人员补卡
// see https://developer.work.weixin.qq.com/document/path/95803
func (r *Client) PunchCorrection(req *PunchCorrectionRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(punchCorrectionURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "PunchCorrection")
}
// AddUserFaceRequest 录入打卡人员人脸信息请求
type AddUserFaceRequest struct {
UserID string `json:"userid"`
UserFace string `json:"userface"`
}
// AddUserFace 录入打卡人员人脸信息
// see https://developer.work.weixin.qq.com/document/path/93378
func (r *Client) AddUserFace(req *AddUserFaceRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(addUserFaceURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "AddUserFace")
}
// AddOptionRequest 创建打卡规则请求
type AddOptionRequest struct {
EffectiveNow bool `json:"effective_now,omitempty"`
Group OptionGroupRule `json:"group,omitempty"`
}
// OptionGroupRule 打卡规则字段
type OptionGroupRule struct {
GroupID int64 `json:"groupid,omitempty"`
GroupType int64 `json:"grouptype"`
GroupName string `json:"groupname"`
CheckinDate []OptionGroupRuleCheckinDate `json:"checkindate,omitempty"`
SpeWorkdays []OptionGroupSpeWorkdays `json:"spe_workdays,omitempty"`
SpeOffDays []OptionGroupSpeOffDays `json:"spe_offdays,omitempty"`
SyncHolidays bool `json:"sync_holidays,omitempty"`
NeedPhoto bool `json:"need_photo,omitempty"`
NoteCanUseLocalPic bool `json:"note_can_use_local_pic,omitempty"`
WifiMacInfos []OptionGroupWifiMacInfos `json:"wifimac_infos,omitempty"`
LocInfos []OptionGroupLocInfos `json:"loc_infos,omitempty"`
AllowCheckinOffWorkday bool `json:"allow_checkin_offworkday,omitempty"`
AllowApplyOffWorkday bool `json:"allow_apply_offworkday,omitempty"`
Range []OptionGroupRange `json:"range"`
WhiteUsers []string `json:"white_users,omitempty"`
Type int64 `json:"type,omitempty"`
ReporterInfo OptionGroupReporterInfo `json:"reporterinfo,omitempty"`
AllowApplyBkCnt int64 `json:"allow_apply_bk_cnt,omitempty"`
AllowApplyBkDayLimit int64 `json:"allow_apply_bk_day_limit,omitempty"`
BukaLimitNextMonth int64 `json:"buka_limit_next_month,omitempty"`
OptionOutRange int64 `json:"option_out_range,omitempty"`
ScheduleList []OptionGroupScheduleList `json:"schedulelist,omitempty"`
OffWorkIntervalTime int64 `json:"offwork_interval_time,omitempty"`
UseFaceDetect bool `json:"use_face_detect,omitempty"`
OpenFaceLiveDetect bool `json:"open_face_live_detect,omitempty"`
OtInfoV2 OptionGroupOtInfoV2 `json:"ot_info_v2,omitempty"`
SyncOutCheckin bool `json:"sync_out_checkin,omitempty"`
BukaRemind OptionGroupBukaRemind `json:"buka_remind,omitempty"`
BukaRestriction int64 `json:"buka_restriction,omitempty"`
CheckinMethodType int64 `json:"checkin_method_type,omitempty"`
SpanDayTime int64 `json:"span_day_time,omitempty"`
StandardWorkDuration int64 `json:"standard_work_duration,omitempty"`
}
// OptionGroupRuleCheckinDate 固定时间上下班打卡时间
type OptionGroupRuleCheckinDate struct {
Workdays []int64 `json:"workdays"`
CheckinTime []OptionGroupRuleCheckinTime `json:"checkintime"`
FlexTime int64 `json:"flex_time"`
AllowFlex bool `json:"allow_flex"`
FlexOnDutyTime int64 `json:"flex_on_duty_time"`
FlexOffDutyTime int64 `json:"flex_off_duty_time"`
MaxAllowArriveEarly int64 `json:"max_allow_arrive_early"`
MaxAllowArriveLate int64 `json:"max_allow_arrive_late"`
LateRule OptionGroupLateRule `json:"late_rule"`
Biweekly OptionGroupBiweekly `json:"biweekly,omitempty"`
}
// OptionGroupRuleCheckinTime 工作日上下班打卡时间信息
type OptionGroupRuleCheckinTime struct {
TimeID int64 `json:"time_id"`
WorkSec int64 `json:"work_sec"`
OffWorkSec int64 `json:"off_work_sec"`
RemindWorkSec int64 `json:"remind_work_sec"`
RemindOffWorkSec int64 `json:"remind_off_work_sec"`
AllowRest bool `json:"allow_rest"`
RestBeginTime int64 `json:"rest_begin_time"`
RestEndTime int64 `json:"rest_end_time"`
EarliestWorkSec int64 `json:"earliest_work_sec"`
LatestWorkSec int64 `json:"latest_work_sec"`
EarliestOffWorkSec int64 `json:"earliest_off_work_sec"`
LatestOffWorkSec int64 `json:"latest_off_work_sec"`
NoNeedCheckOn bool `json:"no_need_checkon"`
NoNeedCheckOff bool `json:"no_need_checkoff"`
RestTimes []OptionGroupRuleRestTimes `json:"rest_times,omitempty"`
}
// OptionGroupRuleRestTimes 多组休息时间
type OptionGroupRuleRestTimes struct {
RestBeginTime int64 `json:"rest_begin_time,omitempty"`
RestEndTime int64 `json:"rest_end_time,omitempty"`
}
// OptionGroupLateRule 晚走晚到时间规则信息
type OptionGroupLateRule struct {
OffWorkAfterTime int64 `json:"offwork_after_time"`
OnWorkFlexTime int64 `json:"onwork_flex_time"`
AllowOffWorkAfterTime int64 `json:"allow_offwork_after_time"`
TimeRules []OptionGroupTimeRule `json:"timerules"`
}
// OptionGroupTimeRule 晚走晚到时间规则
type OptionGroupTimeRule struct {
OffWorkAfterTime int64 `json:"offwork_after_time"`
OnWorkFlexTime int64 `json:"onwork_flex_time"`
}
// OptionGroupBiweekly 大小周规则
type OptionGroupBiweekly struct {
EnableWeekdayRecurrence bool `json:"enable_weekday_recurrence"`
OddWorkdays []int64 `json:"odd_workdays"`
EvenWorkdays []int64 `json:"even_workdays"`
}
// OptionGroupSpeWorkdays 特殊工作日
type OptionGroupSpeWorkdays struct {
Timestamp int64 `json:"timestamp"`
Notes string `json:"notes"`
CheckinTime []OptionGroupCheckinTime `json:"checkintime"`
Type int64 `json:"type"`
BegTime int64 `json:"begtime"`
EndTime int64 `json:"endtime"`
}
// OptionGroupCheckinTime 特殊工作日的上下班打卡时间配置
type OptionGroupCheckinTime struct {
TimeID int64 `json:"time_id"`
WorkSec int64 `json:"work_sec"`
OffWorkSec int64 `json:"off_work_sec"`
RemindWorkSec int64 `json:"remind_work_sec"`
RemindOffWorkSec int64 `json:"remind_off_work_sec"`
}
// OptionGroupSpeOffDays 特殊非工作日
type OptionGroupSpeOffDays struct {
Timestamp int64 `json:"timestamp"`
Notes string `json:"notes"`
Type int64 `json:"type"`
BegTime int64 `json:"begtime"`
EndTime int64 `json:"endtime"`
}
// OptionGroupWifiMacInfos WIFI信息
type OptionGroupWifiMacInfos struct {
WifiName string `json:"wifiname"`
WifiMac string `json:"wifimac"`
}
// OptionGroupLocInfos 地点信息
type OptionGroupLocInfos struct {
Lat int64 `json:"lat"`
Lng int64 `json:"lng"`
LocTitle string `json:"loc_title"`
LocDetail string `json:"loc_detail"`
Distance int64 `json:"distance"`
}
// OptionGroupRange 人员信息
type OptionGroupRange struct {
PartyID []string `json:"party_id"`
UserID []string `json:"userid"`
TagID []int64 `json:"tagid"`
}
// OptionGroupReporterInfo 汇报人
type OptionGroupReporterInfo struct {
Reporters []OptionGroupReporters `json:"reporters"`
}
// OptionGroupReporters 汇报对象
type OptionGroupReporters struct {
UserID string `json:"userid"`
TagID int64 `json:"tagid"`
}
// OptionGroupScheduleList 自定义排班规则所有排班
type OptionGroupScheduleList struct {
ScheduleID int64 `json:"schedule_id"`
ScheduleName string `json:"schedule_name"`
TimeSection []OptionGroupTimeSection `json:"time_section"`
AllowFlex bool `json:"allow_flex"`
FlexOnDutyTime int64 `json:"flex_on_duty_time"`
FlexOffDutyTime int64 `json:"flex_off_duty_time"`
LateRule OptionGroupLateRule `json:"late_rule"`
MaxAllowArriveEarly int64 `json:"max_allow_arrive_early"`
MaxAllowArriveLate int64 `json:"max_allow_arrive_late"`
}
// OptionGroupTimeSection 班次上下班时段信息
type OptionGroupTimeSection struct {
TimeID int64 `json:"time_id"`
WorkSec int64 `json:"work_sec"`
OffWorkSec int64 `json:"off_work_sec"`
RemindWorkSec int64 `json:"remind_work_sec"`
RemindOffWorkSec int64 `json:"remind_off_work_sec"`
RestBeginTime int64 `json:"rest_begin_time"`
RestEndTime int64 `json:"rest_end_time"`
AllowRest bool `json:"allow_rest"`
EarliestWorkSec int64 `json:"earliest_work_sec"`
LatestWorkSec int64 `json:"latest_work_sec"`
EarliestOffWorkSec int64 `json:"earliest_off_work_sec"`
LatestOffWorkSec int64 `json:"latest_off_work_sec"`
NoNeedCheckOn bool `json:"no_need_checkon"`
NoNeedCheckOff bool `json:"no_need_checkoff"`
}
// OptionGroupOtInfoV2 加班配置
type OptionGroupOtInfoV2 struct {
WorkdayConf OptionGroupWorkdayConf `json:"workdayconf"`
}
// OptionGroupWorkdayConf 工作日加班配置
type OptionGroupWorkdayConf struct {
AllowOt bool `json:"allow_ot"`
Type int64 `json:"type"`
}
// OptionGroupBukaRemind 补卡提醒
type OptionGroupBukaRemind struct {
OpenRemind bool `json:"open_remind"`
BukaRemindDay int64 `json:"buka_remind_day"`
BukaRemindMonth int64 `json:"buka_remind_month"`
}
// AddOption 创建打卡规则
// see https://developer.work.weixin.qq.com/document/path/98041#%E5%88%9B%E5%BB%BA%E6%89%93%E5%8D%A1%E8%A7%84%E5%88%99
func (r *Client) AddOption(req *AddOptionRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(addOptionURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "AddOption")
}
// UpdateOptionRequest 修改打卡规则请求
type UpdateOptionRequest struct {
EffectiveNow bool `json:"effective_now,omitempty"`
Group OptionGroupRule `json:"group,omitempty"`
}
// UpdateOption 修改打卡规则
// see https://developer.work.weixin.qq.com/document/path/98041#%E4%BF%AE%E6%94%B9%E6%89%93%E5%8D%A1%E8%A7%84%E5%88%99
func (r *Client) UpdateOption(req *UpdateOptionRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(updateOptionURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "UpdateOption")
}
// ClearOptionRequest 清空打卡规则数组元素请求
type ClearOptionRequest struct {
GroupID int64 `json:"groupid"`
ClearField []int64 `json:"clear_field"`
EffectiveNow bool `json:"effective_now"`
}
// ClearOption 清空打卡规则数组元素
// see https://developer.work.weixin.qq.com/document/path/98041#%E6%B8%85%E7%A9%BA%E6%89%93%E5%8D%A1%E8%A7%84%E5%88%99%E6%95%B0%E7%BB%84%E5%85%83%E7%B4%A0
func (r *Client) ClearOption(req *ClearOptionRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(clearOptionURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "ClearOption")
}
// DelOptionRequest 删除打卡规则请求
type DelOptionRequest struct {
GroupID int64 `json:"groupid"`
EffectiveNow bool `json:"effective_now"`
}
// DelOption 删除打卡规则
// see https://developer.work.weixin.qq.com/document/path/98041#%E5%88%A0%E9%99%A4%E6%89%93%E5%8D%A1%E8%A7%84%E5%88%99
func (r *Client) DelOption(req *DelOptionRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(delOptionURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "DelOption")
}
// AddRecordRequest 添加打卡记录请求
type AddRecordRequest struct {
Records []Record `json:"records"`
}
// Record 打卡记录
type Record struct {
UserID string `json:"userid"`
CheckinTime int64 `json:"checkin_time"`
LocationTitle string `json:"location_title"`
LocationDetail string `json:"location_detail"`
MediaIDS []string `json:"mediaids"`
Notes string `json:"notes"`
DeviceType int `json:"device_type"`
Lat int64 `json:"lat"`
Lng int64 `json:"lng"`
DeviceDetail string `json:"device_detail"`
WifiName string `json:"wifiname"`
WifiMac string `json:"wifimac"`
}
// AddRecord 添加打卡记录
// see https://developer.work.weixin.qq.com/document/path/99647
func (r *Client) AddRecord(req *AddRecordRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(addRecordURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "AddRecord")
}

17
work/checkin/client.go Normal file
View File

@@ -0,0 +1,17 @@
package checkin
import (
"github.com/silenceper/wechat/v2/work/context"
)
// Client 打卡接口实例
type Client struct {
*context.Context
}
// NewClient 初始化实例
func NewClient(ctx *context.Context) *Client {
return &Client{
ctx,
}
}

682
work/checkin/record.go Normal file
View File

@@ -0,0 +1,682 @@
package checkin
import (
"fmt"
"github.com/silenceper/wechat/v2/util"
)
const (
// getCheckinDataURL 获取打卡记录数据
getCheckinDataURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/getcheckindata?access_token=%s"
// getDayDataURL 获取打卡日报数据
getDayDataURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/getcheckin_daydata?access_token=%s"
// getMonthDataURL 获取打卡月报数据
getMonthDataURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/getcheckin_monthdata?access_token=%s"
// getCorpOptionURL 获取企业所有打卡规则
getCorpOptionURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/getcorpcheckinoption?access_token=%s"
// getOptionURL 获取员工打卡规则
getOptionURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/getcheckinoption?access_token=%s"
// getScheduleListURL 获取打卡人员排班信息
getScheduleListURL = "https://qyapi.weixin.qq.com/cgi-bin/checkin/getcheckinschedulist?access_token=%s"
// getHardwareDataURL获取设备打卡数据
getHardwareDataURL = "https://qyapi.weixin.qq.com/cgi-bin/hardware/get_hardware_checkin_data?access_token=%s"
)
type (
// GetCheckinDataRequest 获取打卡记录数据请求
GetCheckinDataRequest struct {
OpenCheckinDataType int64 `json:"opencheckindatatype"`
StartTime int64 `json:"starttime"`
EndTime int64 `json:"endtime"`
UserIDList []string `json:"useridlist"`
}
// GetCheckinDataResponse 获取打卡记录数据响应
GetCheckinDataResponse struct {
util.CommonError
CheckinData []*GetCheckinDataItem `json:"checkindata"`
}
// GetCheckinDataItem 打卡记录数据
GetCheckinDataItem struct {
UserID string `json:"userid"`
GroupName string `json:"groupname"`
CheckinType string `json:"checkin_type"`
ExceptionType string `json:"exception_type"`
CheckinTime int64 `json:"checkin_time"`
LocationTitle string `json:"location_title"`
LocationDetail string `json:"location_detail"`
WifiName string `json:"wifiname"`
Notes string `json:"notes"`
WifiMac string `json:"wifimac"`
MediaIDs []string `json:"mediaids"`
SchCheckinTime int64 `json:"sch_checkin_time"`
GroupID int64 `json:"groupid"`
ScheduleID int64 `json:"schedule_id"`
TimelineID int64 `json:"timeline_id"`
Lat int64 `json:"lat,omitempty"`
Lng int64 `json:"lng,omitempty"`
DeviceID string `json:"deviceid,omitempty"`
}
)
// GetCheckinData 获取打卡记录数据
// @see https://developer.work.weixin.qq.com/document/path/90262
func (r *Client) GetCheckinData(req *GetCheckinDataRequest) (*GetCheckinDataResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(getCheckinDataURL, accessToken), req); err != nil {
return nil, err
}
result := &GetCheckinDataResponse{}
err = util.DecodeWithError(response, result, "GetCheckinData")
return result, err
}
type (
// GetDayDataResponse 获取打卡日报数据
GetDayDataResponse struct {
util.CommonError
Datas []DayDataItem `json:"datas"`
}
// DayDataItem 日报
DayDataItem struct {
BaseInfo DayBaseInfo `json:"base_info"`
SummaryInfo DaySummaryInfo `json:"summary_info"`
HolidayInfos []HolidayInfo `json:"holiday_infos"`
ExceptionInfos []ExceptionInfo `json:"exception_infos"`
OtInfo OtInfo `json:"ot_info"`
SpItems []SpItem `json:"sp_items"`
}
// DayBaseInfo 基础信息
DayBaseInfo struct {
Date int64 `json:"date"`
RecordType int64 `json:"record_type"`
Name string `json:"name"`
NameEx string `json:"name_ex"`
DepartsName string `json:"departs_name"`
AcctID string `json:"acctid"`
DayType int64 `json:"day_type"`
RuleInfo DayRuleInfo `json:"rule_info"`
}
// DayCheckInTime 当日打卡时间
DayCheckInTime struct {
WorkSec int64 `json:"work_sec"`
OffWorkSec int64 `json:"off_work_sec"`
}
// DayRuleInfo 打卡人员所属规则信息
DayRuleInfo struct {
GroupID int64 `json:"groupid"`
GroupName string `json:"groupname"`
ScheduleID int64 `json:"scheduleid"`
ScheduleName string `json:"schedulename"`
CheckInTimes []DayCheckInTime `json:"checkintime"`
}
// DaySummaryInfo 汇总信息
DaySummaryInfo struct {
CheckinCount int64 `json:"checkin_count"`
RegularWorkSec int64 `json:"regular_work_sec"`
StandardWorkSec int64 `json:"standard_work_sec"`
EarliestTime int64 `json:"earliest_time"`
LastestTime int64 `json:"lastest_time"`
}
// HolidayInfo 假勤相关信息
HolidayInfo struct {
SpNumber string `json:"sp_number"`
SpTitle SpTitle `json:"sp_title"`
SpDescription SpDescription `json:"sp_description"`
}
// SpTitle 假勤信息摘要-标题信息
SpTitle struct {
Data []SpData `json:"data"`
}
// SpDescription 假勤信息摘要-描述信息
SpDescription struct {
Data []SpData `json:"data"`
}
// SpData 假勤信息(多种语言描述,目前只有中文一种)
SpData struct {
Lang string `json:"lang"`
Text string `json:"text"`
}
// SpItem 假勤统计信息
SpItem struct {
Count int64 `json:"count"`
Duration int64 `json:"duration"`
TimeType int64 `json:"time_type"`
Type int64 `json:"type"`
VacationID int64 `json:"vacation_id"`
Name string `json:"name"`
}
// ExceptionInfo 校准状态信息
ExceptionInfo struct {
Count int64 `json:"count"`
Duration int64 `json:"duration"`
Exception int64 `json:"exception"`
}
// OtInfo 加班信息
OtInfo struct {
OtStatus int64 `json:"ot_status"`
OtDuration int64 `json:"ot_duration"`
ExceptionDuration []uint64 `json:"exception_duration"`
WorkdayOverAsVacation int64 `json:"workday_over_as_vacation"`
WorkdayOverAsMoney int64 `json:"workday_over_as_money"`
RestdayOverAsVacation int64 `json:"restday_over_as_vacation"`
RestdayOverAsMoney int64 `json:"restday_over_as_money"`
HolidayOverAsVacation int64 `json:"holiday_over_as_vacation"`
HolidayOverAsMoney int64 `json:"holiday_over_as_money"`
}
)
// GetDayData 获取打卡日报数据
// @see https://developer.work.weixin.qq.com/document/path/96498
func (r *Client) GetDayData(req *GetCheckinDataRequest) (result *GetDayDataResponse, err error) {
var (
response []byte
accessToken string
)
if accessToken, err = r.GetAccessToken(); err != nil {
return
}
if response, err = util.PostJSON(fmt.Sprintf(getDayDataURL, accessToken), req); err != nil {
return
}
result = new(GetDayDataResponse)
err = util.DecodeWithError(response, result, "GetDayData")
return
}
type (
// GetMonthDataResponse 获取打卡月报数据
GetMonthDataResponse struct {
util.CommonError
Datas []MonthDataItem `json:"datas"`
}
// MonthDataItem 月报数据
MonthDataItem struct {
BaseInfo MonthBaseInfo `json:"base_info"`
SummaryInfo MonthSummaryInfo `json:"summary_info"`
ExceptionInfos []ExceptionInfo `json:"exception_infos"`
SpItems []SpItem `json:"sp_items"`
OverWorkInfo OverWorkInfo `json:"overwork_info"`
}
// MonthBaseInfo 基础信息
MonthBaseInfo struct {
RecordType int64 `json:"record_type"`
Name string `json:"name"`
NameEx string `json:"name_ex"`
DepartsName string `json:"departs_name"`
AcctID string `json:"acctid"`
RuleInfo MonthRuleInfo `json:"rule_info"`
}
// MonthRuleInfo 打卡人员所属规则信息
MonthRuleInfo struct {
GroupID int64 `json:"groupid"`
GroupName string `json:"groupname"`
}
// MonthSummaryInfo 汇总信息
MonthSummaryInfo struct {
WorkDays int64 `json:"work_days"`
ExceptDays int64 `json:"except_days"`
RegularDays int64 `json:"regular_days"`
RegularWorkSec int64 `json:"regular_work_sec"`
StandardWorkSec int64 `json:"standard_work_sec"`
RestDays int64 `json:"rest_days"`
}
// OverWorkInfo 加班情况
OverWorkInfo struct {
WorkdayOverSec int64 `json:"workday_over_sec"`
HolidayOverSec int64 `json:"holidays_over_sec"`
RestDayOverSec int64 `json:"restdays_over_sec"`
WorkdaysOverAsVacation int64 `json:"workdays_over_as_vacation"`
WorkdaysOverAsMoney int64 `json:"workdays_over_as_money"`
RestdaysOverAsVacation int64 `json:"restdays_over_as_vacation"`
RestdaysOverAsMoney int64 `json:"restdays_over_as_money"`
HolidaysOverAsVacation int64 `json:"holidays_over_as_vacation"`
HolidaysOverAsMoney int64 `json:"holidays_over_as_money"`
}
)
// GetMonthData 获取打卡月报数据
// @see https://developer.work.weixin.qq.com/document/path/96499
func (r *Client) GetMonthData(req *GetCheckinDataRequest) (result *GetMonthDataResponse, err error) {
var (
response []byte
accessToken string
)
if accessToken, err = r.GetAccessToken(); err != nil {
return
}
if response, err = util.PostJSON(fmt.Sprintf(getMonthDataURL, accessToken), req); err != nil {
return
}
result = new(GetMonthDataResponse)
err = util.DecodeWithError(response, result, "GetMonthData")
return
}
// GetCorpOptionResponse 获取企业所有打卡规则响应
type GetCorpOptionResponse struct {
util.CommonError
Group []CorpOptionGroup `json:"group"`
}
// CorpOptionGroup 企业规则信息列表
type CorpOptionGroup struct {
GroupType int64 `json:"grouptype"`
GroupID int64 `json:"groupid"`
GroupName string `json:"groupname"`
CheckinDate []GroupCheckinDate `json:"checkindate"`
SpeWorkdays []SpeWorkdays `json:"spe_workdays"`
SpeOffDays []SpeOffDays `json:"spe_offdays"`
SyncHolidays bool `json:"sync_holidays"`
NeedPhoto bool `json:"need_photo"`
NoteCanUseLocalPic bool `json:"note_can_use_local_pic"`
AllowCheckinOffWorkday bool `json:"allow_checkin_offworkday"`
AllowApplyOffWorkday bool `json:"allow_apply_offworkday"`
WifiMacInfos []WifiMacInfos `json:"wifimac_infos"`
LocInfos []LocInfos `json:"loc_infos"`
Range []Range `json:"range"`
CreateTime int64 `json:"create_time"`
WhiteUsers []string `json:"white_users"`
Type int64 `json:"type"`
ReporterInfo ReporterInfo `json:"reporterinfo"`
OtInfo GroupOtInfo `json:"ot_info"`
OtApplyInfo OtApplyInfo `json:"otapplyinfo"`
Uptime int64 `json:"uptime"`
AllowApplyBkCnt int64 `json:"allow_apply_bk_cnt"`
OptionOutRange int64 `json:"option_out_range"`
CreateUserID string `json:"create_userid"`
UseFaceDetect bool `json:"use_face_detect"`
AllowApplyBkDayLimit int64 `json:"allow_apply_bk_day_limit"`
UpdateUserID string `json:"update_userid"`
BukaRestriction int64 `json:"buka_restriction"`
ScheduleList []ScheduleList `json:"schedulelist"`
OffWorkIntervalTime int64 `json:"offwork_interval_time"`
SpanDayTime int64 `json:"span_day_time"`
StandardWorkDuration int64 `json:"standard_work_duration"`
OpenSpCheckin bool `json:"open_sp_checkin"`
CheckinMethodType int64 `json:"checkin_method_type"`
}
// GroupCheckinDate 打卡时间,当规则类型为排班时没有意义
type GroupCheckinDate struct {
Workdays []int64 `json:"workdays"`
CheckinTime []GroupCheckinTime `json:"checkintime"`
NoNeedOffWork bool `json:"noneed_offwork"`
LimitAheadTime int64 `json:"limit_aheadtime"`
FlexOnDutyTime int64 `json:"flex_on_duty_time"`
FlexOffDutyTime int64 `json:"flex_off_duty_time"`
}
// GroupCheckinTime 工作日上下班打卡时间信息
type GroupCheckinTime struct {
WorkSec int64 `json:"work_sec"`
OffWorkSec int64 `json:"off_work_sec"`
RemindWorkSec int64 `json:"remind_work_sec"`
RemindOffWorkSec int64 `json:"remind_off_work_sec"`
}
// SpeWorkdays 特殊日期-必须打卡日期信息
type SpeWorkdays struct {
Timestamp int64 `json:"timestamp"`
Notes string `json:"notes"`
CheckinTime []GroupCheckinTime `json:"checkintime"`
}
// SpeOffDays 特殊日期-不用打卡日期信息
type SpeOffDays struct {
Timestamp int64 `json:"timestamp"`
Notes string `json:"notes"`
}
// WifiMacInfos 打卡地点-WiFi打卡信息
type WifiMacInfos struct {
WifiName string `json:"wifiname"`
WifiMac string `json:"wifimac"`
}
// LocInfos 打卡地点-位置打卡信息
type LocInfos struct {
Lat int64 `json:"lat"`
Lng int64 `json:"lng"`
LocTitle string `json:"loc_title"`
LocDetail string `json:"loc_detail"`
Distance int64 `json:"distance"`
}
// Range 打卡人员信息
type Range struct {
PartyID []string `json:"partyid"`
UserID []string `json:"userid"`
TagID []int64 `json:"tagid"`
}
// ReporterInfo 汇报对象信息
type ReporterInfo struct {
Reporters []Reporters `json:"reporters"`
UpdateTime int64 `json:"updatetime"`
}
// Reporters 汇报对象每个汇报人用userid表示
type Reporters struct {
UserID string `json:"userid"`
}
// GroupOtInfo 加班信息
type GroupOtInfo struct {
Type int64 `json:"type"`
AllowOtWorkingDay bool `json:"allow_ot_workingday"`
AllowOtNonWorkingDay bool `json:"allow_ot_nonworkingday"`
OtCheckInfo OtCheckInfo `json:"otcheckinfo"`
}
// OtCheckInfo 以打卡时间为准-加班时长计算规则信息
type OtCheckInfo struct {
OtWorkingDayTimeStart int64 `json:"ot_workingday_time_start"`
OtWorkingDayTimeMin int64 `json:"ot_workingday_time_min"`
OtWorkingDayTimeMax int64 `json:"ot_workingday_time_max"`
OtNonworkingDayTimeMin int64 `json:"ot_nonworkingday_time_min"`
OtNonworkingDayTimeMax int64 `json:"ot_nonworkingday_time_max"`
OtNonworkingDaySpanDayTime int64 `json:"ot_nonworkingday_spanday_time"`
OtWorkingDayRestInfo OtRestInfo `json:"ot_workingday_restinfo"`
OtNonWorkingDayRestInfo OtRestInfo `json:"ot_nonworkingday_restinfo"`
}
// OtRestInfo 加班-休息扣除配置信息
type OtRestInfo struct {
Type int64 `json:"type"`
FixTimeRule FixTimeRule `json:"fix_time_rule"`
CalOtTimeRule CalOtTimeRule `json:"cal_ottime_rule"`
}
// FixTimeRule 工作日加班-指定休息时间配置信息
type FixTimeRule struct {
FixTimeBeginSec int64 `json:"fix_time_begin_sec"`
FixTimeEndSec int64 `json:"fix_time_end_sec"`
}
// CalOtTimeRule 工作日加班-按加班时长扣除配置信息
type CalOtTimeRule struct {
Items []CalOtTimeRuleItem `json:"items"`
}
// CalOtTimeRuleItem 工作日加班-按加班时长扣除条件信息
type CalOtTimeRuleItem struct {
OtTime int64 `json:"ot_time"`
RestTime int64 `json:"rest_time"`
}
// OtApplyInfo 以加班申请核算打卡记录相关信息
type OtApplyInfo struct {
AllowOtWorkingDay bool `json:"allow_ot_workingday"`
AllowOtNonWorkingDay bool `json:"allow_ot_nonworkingday"`
Uiptime int64 `json:"uptime"`
OtNonworkingDaySpanDayTime int64 `json:"ot_nonworkingday_spanday_time"`
OtWorkingDayRestInfo OtRestInfo `json:"ot_workingday_restinfo"`
OtNonWorkingDayRestInfo OtRestInfo `json:"ot_nonworkingday_restinfo"`
}
// ScheduleList 排班信息列表
type ScheduleList struct {
ScheduleID int64 `json:"schedule_id"`
ScheduleName string `json:"schedule_name"`
TimeSection []TimeSection `json:"time_section"`
LimitAheadTime int64 `json:"limit_aheadtime"`
NoNeedOffWork bool `json:"noneed_offwork"`
LimitOffTime int64 `json:"limit_offtime"`
FlexOnDutyTime int64 `json:"flex_on_duty_time"`
FlexOffDutyTime int64 `json:"flex_off_duty_time"`
AllowFlex bool `json:"allow_flex"`
LateRule LateRule `json:"late_rule"`
MaxAllowArriveEarly int64 `json:"max_allow_arrive_early"`
MaxAllowArriveLate int64 `json:"max_allow_arrive_late"`
}
// TimeSection 班次上下班时段信息
type TimeSection struct {
TimeID int64 `json:"time_id"`
WorkSec int64 `json:"work_sec"`
OffWorkSec int64 `json:"off_work_sec"`
RemindWorkSec int64 `json:"remind_work_sec"`
RemindOffWorkSec int64 `json:"remind_off_work_sec"`
RestBeginTime int64 `json:"rest_begin_time"`
RestEndTime int64 `json:"rest_end_time"`
AllowRest bool `json:"allow_rest"`
}
// LateRule 晚走晚到时间规则信息
type LateRule struct {
AllowOffWorkAfterTime bool `json:"allow_offwork_after_time"`
TimeRules []TimeRule `json:"timerules"`
}
// TimeRule 迟到规则时间
type TimeRule struct {
OffWorkAfterTime int64 `json:"offwork_after_time"`
OnWorkFlexTime int64 `json:"onwork_flex_time"`
}
// GetCorpOption 获取企业所有打卡规则
// @see https://developer.work.weixin.qq.com/document/path/93384
func (r *Client) GetCorpOption() (*GetCorpOptionResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.HTTPPost(fmt.Sprintf(getCorpOptionURL, accessToken), ""); err != nil {
return nil, err
}
result := &GetCorpOptionResponse{}
err = util.DecodeWithError(response, result, "GetCorpOption")
return result, err
}
// GetOptionRequest 获取员工打卡规则请求
type GetOptionRequest struct {
Datetime int64 `json:"datetime"`
UserIDList []string `json:"useridlist"`
}
// GetOptionResponse 获取员工打卡规则响应
type GetOptionResponse struct {
util.CommonError
Info []OptionInfo `json:"info"`
}
// OptionInfo 打卡规则列表
type OptionInfo struct {
UserID string `json:"userid"`
Group OptionGroup `json:"group"`
}
// OptionGroup 打卡规则相关信息
type OptionGroup struct {
GroupType int64 `json:"grouptype"`
GroupID int64 `json:"groupid"`
OpenSpCheckin bool `json:"open_sp_checkin"`
GroupName string `json:"groupname"`
CheckinDate []OptionCheckinDate `json:"checkindate"`
SpeWorkdays []SpeWorkdays `json:"spe_workdays"`
SpeOffDays []SpeOffDays `json:"spe_offdays"`
SyncHolidays bool `json:"sync_holidays"`
NeedPhoto bool `json:"need_photo"`
WifiMacInfos []WifiMacInfos `json:"wifimac_infos"`
NoteCanUseLocalPic bool `json:"note_can_use_local_pic"`
AllowCheckinOffWorkday bool `json:"allow_checkin_offworkday"`
AllowApplyOffWorkday bool `json:"allow_apply_offworkday"`
LocInfos []LocInfos `json:"loc_infos"`
ScheduleList []ScheduleList `json:"schedulelist"`
BukaRestriction int64 `json:"buka_restriction"`
SpanDayTime int64 `json:"span_day_time"`
StandardWorkDuration int64 `json:"standard_work_duration"`
OffWorkIntervalTime int64 `json:"offwork_interval_time"`
CheckinMethodType int64 `json:"checkin_method_type"`
}
// OptionCheckinDate 打卡时间配置
type OptionCheckinDate struct {
Workdays []int64 `json:"workdays"`
CheckinTime []GroupCheckinTime `json:"checkintime"`
FlexTime int64 `json:"flex_time"`
NoNeedOffWork bool `json:"noneed_offwork"`
LimitAheadTime int64 `json:"limit_aheadtime"`
FlexOnDutyTime int64 `json:"flex_on_duty_time"`
FlexOffDutyTime int64 `json:"flex_off_duty_time"`
}
// GetOption 获取员工打卡规则
// see https://developer.work.weixin.qq.com/document/path/90263
func (r *Client) GetOption(req *GetOptionRequest) (*GetOptionResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(getOptionURL, accessToken), req); err != nil {
return nil, err
}
result := &GetOptionResponse{}
err = util.DecodeWithError(response, result, "GetOption")
return result, err
}
// GetScheduleListRequest 获取打卡人员排班信息请求
type GetScheduleListRequest struct {
StartTime int64 `json:"starttime"`
EndTime int64 `json:"endtime"`
UserIDList []string `json:"useridlist"`
}
// GetScheduleListResponse 获取打卡人员排班信息响应
type GetScheduleListResponse struct {
util.CommonError
ScheduleList []ScheduleItem `json:"schedule_list"`
}
// ScheduleItem 排班表信息
type ScheduleItem struct {
UserID string `json:"userid"`
YearMonth int64 `json:"yearmonth"`
GroupID int64 `json:"groupid"`
GroupName string `json:"groupname"`
Schedule Schedule `json:"schedule"`
}
// Schedule 个人排班信息
type Schedule struct {
ScheduleList []ScheduleListItem `json:"scheduleList"`
}
// ScheduleListItem 个人排班表信息
type ScheduleListItem struct {
Day int64 `json:"day"`
ScheduleInfo ScheduleInfo `json:"schedule_info"`
}
// ScheduleInfo 个人当日排班信息
type ScheduleInfo struct {
ScheduleID int64 `json:"schedule_id"`
ScheduleName string `json:"schedule_name"`
TimeSection []ScheduleTimeSection `json:"time_section"`
}
// ScheduleTimeSection 班次上下班时段信息
type ScheduleTimeSection struct {
ID int64 `json:"id"`
WorkSec int64 `json:"work_sec"`
OffWorkSec int64 `json:"off_work_sec"`
RemindWorkSec int64 `json:"remind_work_sec"`
RemindOffWorkSec int64 `json:"remind_off_work_sec"`
}
// GetScheduleList 获取打卡人员排班信息
// see https://developer.work.weixin.qq.com/document/path/93380
func (r *Client) GetScheduleList(req *GetScheduleListRequest) (*GetScheduleListResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(getScheduleListURL, accessToken), req); err != nil {
return nil, err
}
result := &GetScheduleListResponse{}
err = util.DecodeWithError(response, result, "GetScheduleList")
return result, err
}
// GetHardwareDataRequest 获取设备打卡数据请求
type GetHardwareDataRequest struct {
FilterType int64 `json:"filter_type"`
StartTime int64 `json:"starttime"`
EndTime int64 `json:"endtime"`
UserIDList []string `json:"useridlist"`
}
// GetHardwareDataResponse 获取设备打卡数据响应
type GetHardwareDataResponse struct {
util.CommonError
CheckinData []HardwareCheckinData `json:"checkindata"`
}
// HardwareCheckinData 设备打卡数据
type HardwareCheckinData struct {
UserID string `json:"userid"`
CheckinTime int64 `json:"checkin_time"`
DeviceSn string `json:"device_sn"`
DeviceName string `json:"device_name"`
}
// GetHardwareData 获取设备打卡数据
// see https://developer.work.weixin.qq.com/document/path/94126
func (r *Client) GetHardwareData(req *GetHardwareDataRequest) (*GetHardwareDataResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(getHardwareDataURL, accessToken), req); err != nil {
return nil, err
}
result := &GetHardwareDataResponse{}
err = util.DecodeWithError(response, result, "GetHardwareData")
return result, err
}

View File

@@ -7,12 +7,11 @@ import (
// Config for 企业微信
type Config struct {
CorpID string `json:"corp_id"` // corp_id
CorpSecret string `json:"corp_secret"` // corp_secret,如果需要获取会话存档实例当前参数请填写聊天内容存档的Secret可以在企业微信管理端--管理工具--聊天内容存档查看
AgentID string `json:"agent_id"` // agent_id
Cache cache.Cache
RasPrivateKey string // 消息加密私钥,可以在企业微信管理端--管理工具--消息加密公钥查看对用公钥,私钥一般由自己保存
CorpID string `json:"corp_id"` // corp_id
CorpSecret string `json:"corp_secret"` // corp_secret,如果需要获取会话存档实例当前参数请填写聊天内容存档的Secret可以在企业微信管理端--管理工具--聊天内容存档查看
AgentID string `json:"agent_id"` // agent_id
Cache cache.Cache
RasPrivateKey string // 消息加密私钥,可以在企业微信管理端--管理工具--消息加密公钥查看对用公钥,私钥一般由自己保存
Token string `json:"token"` // 微信客服回调配置,用于生成签名校验回调请求的合法性
EncodingAESKey string `json:"encoding_aes_key"` // 微信客服回调p配置用于解密回调消息内容对应的密文
}

View File

@@ -38,8 +38,6 @@ func (r *Client) GetCallbackMessage(encryptedMsg []byte) (msg EventCallbackMessa
if err != nil {
return
}
if err = xml.Unmarshal(bData, &msg); err != nil {
return
}
err = xml.Unmarshal(bData, &msg)
return
}

View File

@@ -77,6 +77,8 @@ type (
ExpiresIn int `json:"expires_in"`
ChatExpiresIn int `json:"chat_expires_in"`
UnionID string `json:"unionid"`
IsExclusive bool `json:"is_exclusive"`
MarkSource bool `json:"mark_source"`
Conclusions ConclusionsRequest `json:"conclusions"`
}
// AddContactWayResponse 配置客户联系「联系我」方式响应
@@ -102,10 +104,8 @@ func (r *Client) AddContactWay(req *AddContactWayRequest) (*AddContactWayRespons
return nil, err
}
result := &AddContactWayResponse{}
if err = util.DecodeWithError(response, result, "AddContactWay"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "AddContactWay")
return result, err
}
type (
@@ -134,6 +134,7 @@ type (
ExpiresIn int `json:"expires_in"`
ChatExpiresIn int `json:"chat_expires_in"`
UnionID string `json:"unionid"`
MarkSource bool `json:"mark_source"`
Conclusions ConclusionsResponse `json:"conclusions"`
}
)
@@ -153,10 +154,8 @@ func (r *Client) GetContactWay(req *GetContactWayRequest) (*GetContactWayRespons
return nil, err
}
result := &GetContactWayResponse{}
if err = util.DecodeWithError(response, result, "GetContactWay"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetContactWay")
return result, err
}
type (
@@ -172,6 +171,7 @@ type (
ExpiresIn int `json:"expires_in"`
ChatExpiresIn int `json:"chat_expires_in"`
UnionID string `json:"unionid"`
MarkSource bool `json:"mark_source"`
Conclusions ConclusionsRequest `json:"conclusions"`
}
// UpdateContactWayResponse 更新企业已配置的「联系我」方式响应
@@ -195,10 +195,8 @@ func (r *Client) UpdateContactWay(req *UpdateContactWayRequest) (*UpdateContactW
return nil, err
}
result := &UpdateContactWayResponse{}
if err = util.DecodeWithError(response, result, "UpdateContactWay"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "UpdateContactWay")
return result, err
}
type (
@@ -236,10 +234,8 @@ func (r *Client) ListContactWay(req *ListContactWayRequest) (*ListContactWayResp
return nil, err
}
result := &ListContactWayResponse{}
if err = util.DecodeWithError(response, result, "ListContactWay"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "ListContactWay")
return result, err
}
type (
@@ -268,8 +264,6 @@ func (r *Client) DelContactWay(req *DelContactWayRequest) (*DelContactWayRespons
return nil, err
}
result := &DelContactWayResponse{}
if err = util.DecodeWithError(response, result, "DelContactWay"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "DelContactWay")
return result, err
}

View File

@@ -23,6 +23,10 @@ const (
customerAcquisitionQuotaURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition_quota?access_token=%s"
// customerAcquisitionStatistic 查询链接使用详情
customerAcquisitionStatisticURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition/statistic?access_token=%s"
// customerAcquisitionGetChatInfo 获取成员多次收消息详情
customerAcquisitionGetChatInfoURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition/get_chat_info?access_token=%s"
// customerAcquisitionGetPermitURL 获取客户可建联成员
customerAcquisitionGetPermitURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/customer_acquisition_app/get_permit?access_token=%s"
)
type (
@@ -54,10 +58,8 @@ func (r *Client) ListLink(req *ListLinkRequest) (*ListLinkResponse, error) {
return nil, err
}
result := &ListLinkResponse{}
if err = util.DecodeWithError(response, result, "ListLink"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "ListLink")
return result, err
}
type (
@@ -68,9 +70,10 @@ type (
// GetCustomerAcquisitionResponse 获取获客链接详情响应
GetCustomerAcquisitionResponse struct {
util.CommonError
Link Link `json:"link"`
Range CustomerAcquisitionRange `json:"range"`
SkipVerify bool `json:"skip_verify"`
Link Link `json:"link"`
Range CustomerAcquisitionRange `json:"range"`
PriorityOption CustomerPriorityOption `json:"priority_option"`
SkipVerify bool `json:"skip_verify"`
}
// Link 获客链接
Link struct {
@@ -78,6 +81,8 @@ type (
LinkName string `json:"link_name"`
URL string `json:"url"`
CreateTime int64 `json:"create_time"`
SkipVerify bool `json:"skip_verify"`
MarkSource bool `json:"mark_source"`
}
// CustomerAcquisitionRange 该获客链接使用范围
@@ -85,6 +90,12 @@ type (
UserList []string `json:"user_list"`
DepartmentList []int64 `json:"department_list"`
}
// CustomerPriorityOption 该获客链接的优先选项
CustomerPriorityOption struct {
PriorityType int `json:"priority_type"`
PriorityUseridList []string `json:"priority_userid_list"`
}
)
// GetCustomerAcquisition 获客助手--获取获客链接详情
@@ -102,18 +113,18 @@ func (r *Client) GetCustomerAcquisition(req *GetCustomerAcquisitionRequest) (*Ge
return nil, err
}
result := &GetCustomerAcquisitionResponse{}
if err = util.DecodeWithError(response, result, "GetCustomerAcquisition"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetCustomerAcquisition")
return result, err
}
type (
// CreateCustomerAcquisitionLinkRequest 创建获客链接请求
CreateCustomerAcquisitionLinkRequest struct {
LinkName string `json:"link_name"`
Range CustomerAcquisitionRange `json:"range"`
SkipVerify bool `json:"skip_verify"`
LinkName string `json:"link_name"`
Range CustomerAcquisitionRange `json:"range"`
SkipVerify bool `json:"skip_verify"`
PriorityOption CustomerPriorityOption `json:"priority_option"`
MarkSource bool `json:"mark_source"`
}
// CreateCustomerAcquisitionLinkResponse 创建获客链接响应
CreateCustomerAcquisitionLinkResponse struct {
@@ -137,19 +148,19 @@ func (r *Client) CreateCustomerAcquisitionLink(req *CreateCustomerAcquisitionLin
return nil, err
}
result := &CreateCustomerAcquisitionLinkResponse{}
if err = util.DecodeWithError(response, result, "CreateCustomerAcquisitionLink"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "CreateCustomerAcquisitionLink")
return result, err
}
type (
// UpdateCustomerAcquisitionLinkRequest 编辑获客链接请求
UpdateCustomerAcquisitionLinkRequest struct {
LinkID string `json:"link_id"`
LinkName string `json:"link_name"`
Range CustomerAcquisitionRange `json:"range"`
SkipVerify bool `json:"skip_verify"`
LinkID string `json:"link_id"`
LinkName string `json:"link_name"`
Range CustomerAcquisitionRange `json:"range"`
SkipVerify bool `json:"skip_verify"`
PriorityOption CustomerPriorityOption `json:"priority_option"`
MarkSource bool `json:"mark_source"`
}
// UpdateCustomerAcquisitionLinkResponse 编辑获客链接响应
UpdateCustomerAcquisitionLinkResponse struct {
@@ -172,10 +183,8 @@ func (r *Client) UpdateCustomerAcquisitionLink(req *UpdateCustomerAcquisitionLin
return nil, err
}
result := &UpdateCustomerAcquisitionLinkResponse{}
if err = util.DecodeWithError(response, result, "UpdateCustomerAcquisitionLink"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "UpdateCustomerAcquisitionLink")
return result, err
}
type (
@@ -204,10 +213,8 @@ func (r *Client) DeleteCustomerAcquisitionLink(req *DeleteCustomerAcquisitionLin
return nil, err
}
result := &DeleteCustomerAcquisitionLinkResponse{}
if err = util.DecodeWithError(response, result, "DeleteCustomerAcquisitionLink"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "DeleteCustomerAcquisitionLink")
return result, err
}
type (
@@ -247,10 +254,8 @@ func (r *Client) GetCustomerInfoWithCustomerAcquisitionLink(req *GetCustomerInfo
return nil, err
}
result := &GetCustomerInfoWithCustomerAcquisitionLinkResponse{}
if err = util.DecodeWithError(response, result, "GetCustomerInfoWithCustomerAcquisitionLink"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetCustomerInfoWithCustomerAcquisitionLink")
return result, err
}
type (
@@ -279,14 +284,12 @@ func (r *Client) CustomerAcquisitionQuota() (*CustomerAcquisitionQuotaResponse,
return nil, err
}
var response []byte
if response, err = util.HTTPGet((fmt.Sprintf(customerAcquisitionQuotaURL, accessToken))); err != nil {
if response, err = util.HTTPGet(fmt.Sprintf(customerAcquisitionQuotaURL, accessToken)); err != nil {
return nil, err
}
result := &CustomerAcquisitionQuotaResponse{}
if err = util.DecodeWithError(response, result, "CustomerAcquisitionQuota"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "CustomerAcquisitionQuota")
return result, err
}
type (
@@ -319,8 +322,72 @@ func (r *Client) CustomerAcquisitionStatistic(req *CustomerAcquisitionStatisticR
return nil, err
}
result := &CustomerAcquisitionStatisticResponse{}
if err = util.DecodeWithError(response, result, "CustomerAcquisitionStatistic"); err != nil {
err = util.DecodeWithError(response, result, "CustomerAcquisitionStatistic")
return result, err
}
type (
// GetChatInfoRequest 获取成员多次收消息详情请求
GetChatInfoRequest struct {
ChatKey string `json:"chat_key"`
}
// GetChatInfoResponse 获取成员多次收消息详情响应
GetChatInfoResponse struct {
util.CommonError
UserID string `json:"userid"`
ExternalUserID string `json:"external_userid"`
ChatInfo ChatInfo `json:"chat_info"`
}
// ChatInfo 聊天信息
ChatInfo struct {
RecvMsgCnt int64 `json:"recv_msg_cnt"` // 成员收到的此客户的消息次数
LinkID string `json:"link_id"` // 成员添加客户的获客链接id
State string `json:"state"` // 成员添加客户的state
}
)
// GetChatInfo 获取成员多次收消息详情
// see https://developer.work.weixin.qq.com/document/path/100130
func (r *Client) GetChatInfo(req *GetChatInfoRequest) (*GetChatInfoResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
return result, nil
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(customerAcquisitionGetChatInfoURL, accessToken), req); err != nil {
return nil, err
}
result := &GetChatInfoResponse{}
err = util.DecodeWithError(response, result, "GetChatInfo")
return result, err
}
// GetPermitResponse 获取客户可建联成员响应
type GetPermitResponse struct {
util.CommonError
UserList []string `json:"user_list"`
DepartmentList []int `json:"department_list"`
TagList []int `json:"tag_list"`
}
// GetPermit 获取客户可建联成员
// see https://developer.work.weixin.qq.com/document/path/101146
func (r *Client) GetPermit() (*GetPermitResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(customerAcquisitionGetPermitURL, accessToken)); err != nil {
return nil, err
}
result := &GetPermitResponse{}
err = util.DecodeWithError(response, result, "CustomerAcquisitionGetPermit")
return result, err
}

View File

@@ -50,10 +50,7 @@ func (r *Client) GetExternalUserList(userID string) ([]string, error) {
}
var result ExternalUserListResponse
err = util.DecodeWithError(response, &result, "GetExternalUserList")
if err != nil {
return nil, err
}
return result.ExternalUserID, nil
return result.ExternalUserID, err
}
// ExternalUserDetailResponse 外部联系人详情响应
@@ -66,16 +63,16 @@ type ExternalUserDetailResponse struct {
// ExternalUser 外部联系人
type ExternalUser struct {
ExternalUserID string `json:"external_userid"`
Name string `json:"name"`
Avatar string `json:"avatar"`
Type int64 `json:"type"`
Gender int64 `json:"gender"`
UnionID string `json:"unionid"`
Position string `json:"position"`
CorpName string `json:"corp_name"`
CorpFullName string `json:"corp_full_name"`
ExternalProfile string `json:"external_profile"`
ExternalUserID string `json:"external_userid"`
Name string `json:"name"`
Avatar string `json:"avatar"`
Type int64 `json:"type"`
Gender int64 `json:"gender"`
UnionID string `json:"unionid"`
Position string `json:"position"`
CorpName string `json:"corp_name"`
CorpFullName string `json:"corp_full_name"`
ExternalProfile *ExternalProfile `json:"external_profile,omitempty"`
}
// FollowUser 跟进用户(指企业内部用户)
@@ -104,7 +101,47 @@ type Tag struct {
// WechatChannel 视频号添加的场景
type WechatChannel struct {
NickName string `json:"nickname"`
Source string `json:"source"`
Source int `json:"source"`
}
// ExternalProfile 外部联系人的自定义展示信息,可以有多个字段和多种类型,包括文本,网页和小程序
type ExternalProfile struct {
ExternalCorpName string `json:"external_corp_name"`
WechatChannels WechatChannels `json:"wechat_channels"`
ExternalAttr []ExternalAttr `json:"external_attr"`
}
// WechatChannels 视频号属性。须从企业绑定到企业微信的视频号中选择,可在“我的企业”页中查看绑定的视频号
type WechatChannels struct {
Nickname string `json:"nickname"`
Status int `json:"status"`
}
// ExternalAttr 属性列表,目前支持文本、网页、小程序三种类型
type ExternalAttr struct {
Type int `json:"type"`
Name string `json:"name"`
Text *Text `json:"text,omitempty"`
Web *Web `json:"web,omitempty"`
MiniProgram *MiniProgram `json:"miniprogram,omitempty"`
}
// Text 文本
type Text struct {
Value string `json:"value"`
}
// Web 网页
type Web struct {
URL string `json:"url"`
Title string `json:"title"`
}
// MiniProgram 小程序
type MiniProgram struct {
AppID string `json:"appid"`
Pagepath string `json:"pagepath"`
Title string `json:"title"`
}
// GetExternalUserDetail 获取外部联系人详情
@@ -125,10 +162,7 @@ func (r *Client) GetExternalUserDetail(externalUserID string, nextCursor ...stri
}
result := &ExternalUserDetailResponse{}
err = util.DecodeWithError(response, result, "get_external_user_detail")
if err != nil {
return nil, err
}
return result, nil
return result, err
}
// BatchGetExternalUserDetailsRequest 批量获取外部联系人详情请求
@@ -142,6 +176,7 @@ type BatchGetExternalUserDetailsRequest struct {
type ExternalUserDetailListResponse struct {
util.CommonError
ExternalContactList []ExternalUserForBatch `json:"external_contact_list"`
NextCursor string `json:"next_cursor"`
}
// ExternalUserForBatch 批量获取外部联系人客户列表
@@ -180,26 +215,23 @@ type FollowInfo struct {
// BatchGetExternalUserDetails 批量获取外部联系人详情
// @see https://developer.work.weixin.qq.com/document/path/92994
func (r *Client) BatchGetExternalUserDetails(request BatchGetExternalUserDetailsRequest) ([]ExternalUserForBatch, error) {
func (r *Client) BatchGetExternalUserDetails(request BatchGetExternalUserDetailsRequest) ([]ExternalUserForBatch, string, error) {
accessToken, err := r.GetAccessToken()
if err != nil {
return nil, err
return nil, "", err
}
var response []byte
jsonData, err := json.Marshal(request)
if err != nil {
return nil, err
return nil, "", err
}
response, err = util.HTTPPost(fmt.Sprintf("%s?access_token=%v", fetchBatchExternalContactUserDetailURL, accessToken), string(jsonData))
if err != nil {
return nil, err
return nil, "", err
}
var result ExternalUserDetailListResponse
err = util.DecodeWithError(response, &result, "BatchGetExternalUserDetails")
if err != nil {
return nil, err
}
return result.ExternalContactList, nil
return result.ExternalContactList, result.NextCursor, err
}
// UpdateUserRemarkRequest 修改客户备注信息请求体
@@ -265,10 +297,8 @@ func (r *Client) ListCustomerStrategy(req *ListCustomerStrategyRequest) (*ListCu
return nil, err
}
result := &ListCustomerStrategyResponse{}
if err = util.DecodeWithError(response, result, "ListCustomerStrategy"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "ListCustomerStrategy")
return result, err
}
// GetCustomerStrategyRequest 获取规则组详情请求
@@ -332,10 +362,8 @@ func (r *Client) GetCustomerStrategy(req *GetCustomerStrategyRequest) (*GetCusto
return nil, err
}
result := &GetCustomerStrategyResponse{}
if err = util.DecodeWithError(response, result, "GetCustomerStrategy"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetCustomerStrategy")
return result, err
}
// GetRangeCustomerStrategyRequest 获取规则组管理范围请求
@@ -374,10 +402,8 @@ func (r *Client) GetRangeCustomerStrategy(req *GetRangeCustomerStrategyRequest)
return nil, err
}
result := &GetRangeCustomerStrategyResponse{}
if err = util.DecodeWithError(response, result, "GetRangeCustomerStrategy"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetRangeCustomerStrategy")
return result, err
}
// CreateCustomerStrategyRequest 创建新的规则组请求
@@ -410,10 +436,8 @@ func (r *Client) CreateCustomerStrategy(req *CreateCustomerStrategyRequest) (*Cr
return nil, err
}
result := &CreateCustomerStrategyResponse{}
if err = util.DecodeWithError(response, result, "CreateCustomerStrategy"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "CreateCustomerStrategy")
return result, err
}
// EditCustomerStrategyRequest 编辑规则组及其管理范围请求

View File

@@ -31,8 +31,5 @@ func (r *Client) GetFollowUserList() ([]string, error) {
}
var result followerUserResponse
err = util.DecodeWithError(response, &result, "GetFollowUserList")
if err != nil {
return nil, err
}
return result.FollowUser, nil
return result.FollowUser, err
}

View File

@@ -44,10 +44,8 @@ func (r *Client) GetGroupChatList(req *GroupChatListRequest) (*GroupChatListResp
return nil, err
}
result := &GroupChatListResponse{}
if err = util.DecodeWithError(response, result, "GetGroupChatList"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetGroupChatList")
return result, err
}
type (
@@ -70,6 +68,7 @@ type (
GroupNickname string `json:"group_nickname"` //在群里的昵称
Name string `json:"name"` //名字。仅当 need_name = 1 时返回 如果是微信用户,则返回其在微信中设置的名字 如果是企业微信联系人,则返回其设置对外展示的别名或实名
UnionID string `json:"unionid,omitempty"` //外部联系人在微信开放平台的唯一身份标识微信unionid通过此字段企业可将外部联系人与公众号/小程序用户关联起来。仅当群成员类型是微信用户包括企业成员未添加好友且企业绑定了微信开发者ID有此字段查看绑定方法。第三方不可获取上游企业不可获取下游企业客户的unionid字段
State string `json:"state,omitempty"` //如果在配置入群方式时配置了state参数那么在获取客户群详情时通过该方式入群的成员会额外获取到相应的state参数
}
//GroupChatAdmin 群管理员
GroupChatAdmin struct {
@@ -77,13 +76,14 @@ type (
}
//GroupChat 客户群详情
GroupChat struct {
ChatID string `json:"chat_id"` //客户群ID
Name string `json:"name"` //群名
Owner string `json:"owner"` //群主ID
CreateTime int64 `json:"create_time"` //群的创建时间
Notice string `json:"notice"` //群公告
MemberList []GroupChatMember `json:"member_list"` //群成员列表
AdminList []GroupChatAdmin `json:"admin_list"` //群管理员列表
ChatID string `json:"chat_id"` //客户群ID
Name string `json:"name"` //群名
Owner string `json:"owner"` //群主ID
CreateTime int64 `json:"create_time"` //群的创建时间
Notice string `json:"notice"` //群公告
MemberList []GroupChatMember `json:"member_list"` //群成员列表
AdminList []GroupChatAdmin `json:"admin_list"` //群管理员列表
MemberVersion string `json:"member_version"` //当前群成员版本号。可以配合客户群变更事件减少主动调用本接口的次数
}
//GroupChatDetailResponse 客户群详情 返回值
GroupChatDetailResponse struct {
@@ -105,10 +105,8 @@ func (r *Client) GetGroupChatDetail(req *GroupChatDetailRequest) (*GroupChatDeta
return nil, err
}
result := &GroupChatDetailResponse{}
if err = util.DecodeWithError(response, result, "GetGroupChatDetail"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetGroupChatDetail")
return result, err
}
type (
@@ -136,8 +134,6 @@ func (r *Client) OpengIDToChatID(req *OpengIDToChatIDRequest) (*OpengIDToChatIDR
return nil, err
}
result := &OpengIDToChatIDResponse{}
if err = util.DecodeWithError(response, result, "GetGroupChatDetail"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetGroupChatDetail")
return result, err
}

View File

@@ -19,6 +19,7 @@ type (
RoomBaseID int `json:"room_base_id"` //非必填 自动建群的群起始序号当auto_create_room为1时有效
ChatIDList []string `json:"chat_id_list"` //必填 使用该配置的客户群ID列表支持5个。见客户群ID获取方法
State string `json:"state"` //非必填 企业自定义的state参数用于区分不同的入群渠道。不超过30个UTF-8字符
MarkSource bool `json:"mark_source"`
}
// AddJoinWayResponse 添加群配置返回值
@@ -44,10 +45,8 @@ func (r *Client) AddJoinWay(req *AddJoinWayRequest) (*AddJoinWayResponse, error)
return nil, err
}
result := &AddJoinWayResponse{}
if err = util.DecodeWithError(response, result, "AddJoinWay"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "AddJoinWay")
return result, err
}
type (
@@ -67,6 +66,7 @@ type (
ChatIDList []string `json:"chat_id_list"`
QrCode string `json:"qr_code"`
State string `json:"state"`
MarkSource bool `json:"mark_source"`
}
//GetJoinWayResponse 获取群配置的返回值
GetJoinWayResponse struct {
@@ -91,10 +91,8 @@ func (r *Client) GetJoinWay(req *JoinWayConfigRequest) (*GetJoinWayResponse, err
return nil, err
}
result := &GetJoinWayResponse{}
if err = util.DecodeWithError(response, result, "GetJoinWay"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetJoinWay")
return result, err
}
// UpdateJoinWayRequest 更新群配置的请求参数
@@ -107,6 +105,7 @@ type UpdateJoinWayRequest struct {
RoomBaseID int `json:"room_base_id"` //非必填 自动建群的群起始序号当auto_create_room为1时有效
ChatIDList []string `json:"chat_id_list"` //必填 使用该配置的客户群ID列表支持5个。见客户群ID获取方法
State string `json:"state"` //非必填 企业自定义的state参数用于区分不同的入群渠道。不超过30个UTF-8字符
MarkSource bool `json:"mark_source"`
}
// UpdateJoinWay 更新客户群进群方式配置

View File

@@ -112,10 +112,8 @@ func (r *Client) AddMomentTask(req *AddMomentTaskRequest) (*AddMomentTaskRespons
return nil, err
}
result := &AddMomentTaskResponse{}
if err = util.DecodeWithError(response, result, "AddMomentTask"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "AddMomentTask")
return result, err
}
// GetMomentTaskResultResponse 获取任务创建结果响应
@@ -161,10 +159,8 @@ func (r *Client) GetMomentTaskResult(jobID string) (*GetMomentTaskResultResponse
return nil, err
}
result := &GetMomentTaskResultResponse{}
if err = util.DecodeWithError(response, result, "GetMomentTaskResult"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetMomentTaskResult")
return result, err
}
// CancelMomentTaskRequest 停止发表企业朋友圈请求
@@ -264,10 +260,8 @@ func (r *Client) GetMomentList(req *GetMomentListRequest) (*GetMomentListRespons
return nil, err
}
result := &GetMomentListResponse{}
if err = util.DecodeWithError(response, result, "GetMomentList"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetMomentList")
return result, err
}
// GetMomentTaskRequest 获取客户朋友圈企业发表的列表请求
@@ -305,10 +299,8 @@ func (r *Client) GetMomentTask(req *GetMomentTaskRequest) (*GetMomentTaskRespons
return nil, err
}
result := &GetMomentTaskResponse{}
if err = util.DecodeWithError(response, result, "GetMomentTask"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetMomentTask")
return result, err
}
// GetMomentCustomerListRequest 获取客户朋友圈发表时选择的可见范围请求
@@ -347,10 +339,8 @@ func (r *Client) GetMomentCustomerList(req *GetMomentCustomerListRequest) (*GetM
return nil, err
}
result := &GetMomentCustomerListResponse{}
if err = util.DecodeWithError(response, result, "GetMomentCustomerList"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetMomentCustomerList")
return result, err
}
// GetMomentSendResultRequest 获取客户朋友圈发表后的可见客户列表请求
@@ -388,10 +378,8 @@ func (r *Client) GetMomentSendResult(req *GetMomentSendResultRequest) (*GetMomen
return nil, err
}
result := &GetMomentSendResultResponse{}
if err = util.DecodeWithError(response, result, "GetMomentSendResult"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetMomentSendResult")
return result, err
}
// GetMomentCommentsRequest 获取客户朋友圈的互动数据请求
@@ -436,10 +424,8 @@ func (r *Client) GetMomentComments(req *GetMomentCommentsRequest) (*GetMomentCom
return nil, err
}
result := &GetMomentCommentsResponse{}
if err = util.DecodeWithError(response, result, "GetMomentComments"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetMomentComments")
return result, err
}
// ListMomentStrategyRequest 获取规则组列表请求
@@ -475,10 +461,8 @@ func (r *Client) ListMomentStrategy(req *ListMomentStrategyRequest) (*ListMoment
return nil, err
}
result := &ListMomentStrategyResponse{}
if err = util.DecodeWithError(response, result, "ListMomentStrategy"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "ListMomentStrategy")
return result, err
}
// GetMomentStrategyRequest 获取规则组详情请求
@@ -524,10 +508,8 @@ func (r *Client) GetMomentStrategy(req *GetMomentStrategyRequest) (*GetMomentStr
return nil, err
}
result := &GetMomentStrategyResponse{}
if err = util.DecodeWithError(response, result, "GetMomentStrategy"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetMomentStrategy")
return result, err
}
// GetRangeMomentStrategyRequest 获取规则组管理范围请求
@@ -566,10 +548,8 @@ func (r *Client) GetRangeMomentStrategy(req *GetRangeMomentStrategyRequest) (*Ge
return nil, err
}
result := &GetRangeMomentStrategyResponse{}
if err = util.DecodeWithError(response, result, "GetRangeMomentStrategy"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetRangeMomentStrategy")
return result, err
}
// CreateMomentStrategyRequest 创建新的规则组请求
@@ -602,10 +582,8 @@ func (r *Client) CreateMomentStrategy(req *CreateMomentStrategyRequest) (*Create
return nil, err
}
result := &CreateMomentStrategyResponse{}
if err = util.DecodeWithError(response, result, "CreateMomentStrategy"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "CreateMomentStrategy")
return result, err
}
// EditMomentStrategyRequest 编辑规则组及其管理范围请求

View File

@@ -38,8 +38,23 @@ type AddMsgTemplateRequest struct {
Sender string `json:"sender,omitempty"`
Text MsgText `json:"text"`
Attachments []*Attachment `json:"attachments"`
AllowSelect bool `json:"allow_select,omitempty"`
ChatIDList []string `json:"chat_id_list,omitempty"`
TagFilter TagFilter `json:"tag_filter,omitempty"`
}
type (
// TagFilter 标签过滤
TagFilter struct {
GroupList []TagGroupList `json:"group_list"`
}
// TagGroupList 标签组
TagGroupList struct {
TagList []string `json:"tag_list"`
}
)
// MsgText 文本消息
type MsgText struct {
Content string `json:"content"`
@@ -106,10 +121,8 @@ func (r *Client) AddMsgTemplate(req *AddMsgTemplateRequest) (*AddMsgTemplateResp
return nil, err
}
result := &AddMsgTemplateResponse{}
if err = util.DecodeWithError(response, result, "AddMsgTemplate"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "AddMsgTemplate")
return result, err
}
// GetGroupMsgListV2Request 获取群发记录列表请求
@@ -155,10 +168,8 @@ func (r *Client) GetGroupMsgListV2(req *GetGroupMsgListV2Request) (*GetGroupMsgL
return nil, err
}
result := &GetGroupMsgListV2Response{}
if err = util.DecodeWithError(response, result, "GetGroupMsgListV2"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetGroupMsgListV2")
return result, err
}
// GetGroupMsgTaskRequest 获取群发成员发送任务列表请求
@@ -197,10 +208,8 @@ func (r *Client) GetGroupMsgTask(req *GetGroupMsgTaskRequest) (*GetGroupMsgTaskR
return nil, err
}
result := &GetGroupMsgTaskResponse{}
if err = util.DecodeWithError(response, result, "GetGroupMsgTask"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetGroupMsgTask")
return result, err
}
// GetGroupMsgSendResultRequest 获取企业群发成员执行结果请求
@@ -242,10 +251,8 @@ func (r *Client) GetGroupMsgSendResult(req *GetGroupMsgSendResultRequest) (*GetG
return nil, err
}
result := &GetGroupMsgSendResultResponse{}
if err = util.DecodeWithError(response, result, "GetGroupMsgSendResult"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetGroupMsgSendResult")
return result, err
}
// SendWelcomeMsgRequest 发送新客户欢迎语请求
@@ -275,22 +282,19 @@ func (r *Client) SendWelcomeMsg(req *SendWelcomeMsgRequest) error {
return err
}
result := &SendWelcomeMsgResponse{}
if err = util.DecodeWithError(response, result, "SendWelcomeMsg"); err != nil {
return err
}
return nil
return util.DecodeWithError(response, result, "SendWelcomeMsg")
}
// AddGroupWelcomeTemplateRequest 添加入群欢迎语素材请求
type AddGroupWelcomeTemplateRequest struct {
Text MsgText `json:"text"`
Image AttachmentImg `json:"image"`
Link AttachmentLink `json:"link"`
MiniProgram AttachmentMiniProgram `json:"miniprogram"`
File AttachmentFile `json:"file"`
Video AttachmentVideo `json:"video"`
AgentID int `json:"agentid"`
Notify int `json:"notify"`
Text MsgText `json:"text"`
Image *AttachmentImg `json:"image,omitempty"`
Link *AttachmentLink `json:"link,omitempty"`
MiniProgram *AttachmentMiniProgram `json:"miniprogram,omitempty"`
File *AttachmentFile `json:"file,omitempty"`
Video *AttachmentVideo `json:"video,omitempty"`
AgentID int `json:"agentid,omitempty"`
Notify int `json:"notify,omitempty"`
}
// AddGroupWelcomeTemplateResponse 添加入群欢迎语素材响应
@@ -314,22 +318,20 @@ func (r *Client) AddGroupWelcomeTemplate(req *AddGroupWelcomeTemplateRequest) (*
return nil, err
}
result := &AddGroupWelcomeTemplateResponse{}
if err = util.DecodeWithError(response, result, "AddGroupWelcomeTemplate"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "AddGroupWelcomeTemplate")
return result, err
}
// EditGroupWelcomeTemplateRequest 编辑入群欢迎语素材请求
type EditGroupWelcomeTemplateRequest struct {
TemplateID string `json:"template_id"`
Text MsgText `json:"text"`
Image AttachmentImg `json:"image"`
Link AttachmentLink `json:"link"`
MiniProgram AttachmentMiniProgram `json:"miniprogram"`
File AttachmentFile `json:"file"`
Video AttachmentVideo `json:"video"`
AgentID int `json:"agentid"`
TemplateID string `json:"template_id"`
Text MsgText `json:"text"`
Image *AttachmentImg `json:"image"`
Link *AttachmentLink `json:"link"`
MiniProgram *AttachmentMiniProgram `json:"miniprogram"`
File *AttachmentFile `json:"file"`
Video *AttachmentVideo `json:"video"`
AgentID int `json:"agentid"`
}
// EditGroupWelcomeTemplateResponse 编辑入群欢迎语素材响应
@@ -352,10 +354,7 @@ func (r *Client) EditGroupWelcomeTemplate(req *EditGroupWelcomeTemplateRequest)
return err
}
result := &EditGroupWelcomeTemplateResponse{}
if err = util.DecodeWithError(response, result, "EditGroupWelcomeTemplate"); err != nil {
return err
}
return nil
return util.DecodeWithError(response, result, "EditGroupWelcomeTemplate")
}
// GetGroupWelcomeTemplateRequest 获取入群欢迎语素材请求
@@ -367,11 +366,11 @@ type GetGroupWelcomeTemplateRequest struct {
type GetGroupWelcomeTemplateResponse struct {
util.CommonError
Text MsgText `json:"text"`
Image AttachmentImg `json:"image"`
Link AttachmentLink `json:"link"`
MiniProgram AttachmentMiniProgram `json:"miniprogram"`
File AttachmentFile `json:"file"`
Video AttachmentVideo `json:"video"`
Image AttachmentImg `json:"image,omitempty"`
Link AttachmentLink `json:"link,omitempty"`
MiniProgram AttachmentMiniProgram `json:"miniprogram,omitempty"`
File AttachmentFile `json:"file,omitempty"`
Video AttachmentVideo `json:"video,omitempty"`
}
// GetGroupWelcomeTemplate 获取入群欢迎语素材
@@ -389,10 +388,8 @@ func (r *Client) GetGroupWelcomeTemplate(req *GetGroupWelcomeTemplateRequest) (*
return nil, err
}
result := &GetGroupWelcomeTemplateResponse{}
if err = util.DecodeWithError(response, result, "GetGroupWelcomeTemplate"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetGroupWelcomeTemplate")
return result, err
}
// DelGroupWelcomeTemplateRequest 删除入群欢迎语素材请求
@@ -421,10 +418,7 @@ func (r *Client) DelGroupWelcomeTemplate(req *DelGroupWelcomeTemplateRequest) er
return err
}
result := &DelGroupWelcomeTemplateResponse{}
if err = util.DecodeWithError(response, result, "DelGroupWelcomeTemplate"); err != nil {
return err
}
return nil
return util.DecodeWithError(response, result, "DelGroupWelcomeTemplate")
}
// RemindGroupMsgSendRequest 提醒成员群发请求

View File

@@ -60,10 +60,7 @@ func (r *Client) GetUserBehaviorData(req *GetUserBehaviorRequest) ([]BehaviorDat
}
var result GetUserBehaviorResponse
err = util.DecodeWithError(response, &result, "GetUserBehaviorData")
if err != nil {
return nil, err
}
return result.BehaviorData, nil
return result.BehaviorData, err
}
type (
@@ -126,10 +123,7 @@ func (r *Client) GetGroupChatStat(req *GetGroupChatStatRequest) (*GetGroupChatSt
}
result := &GetGroupChatStatResponse{}
err = util.DecodeWithError(response, result, "GetGroupChatStat")
if err != nil {
return nil, err
}
return result, nil
return result, err
}
type (
@@ -169,8 +163,5 @@ func (r *Client) GetGroupChatStatByDay(req *GetGroupChatStatByDayRequest) ([]Get
}
var result GetGroupChatStatByDayResponse
err = util.DecodeWithError(response, &result, "GetGroupChatStatByDay")
if err != nil {
return nil, err
}
return result.Items, nil
return result.Items, err
}

View File

@@ -77,10 +77,7 @@ func (r *Client) GetCropTagList(req GetCropTagRequest) ([]TagGroup, error) {
}
var result GetCropTagListResponse
err = util.DecodeWithError(response, &result, "GetCropTagList")
if err != nil {
return nil, err
}
return result.TagGroup, nil
return result.TagGroup, err
}
// AddCropTagRequest 添加企业标签请求
@@ -123,10 +120,7 @@ func (r *Client) AddCropTag(req AddCropTagRequest) (*TagGroup, error) {
}
var result AddCropTagResponse
err = util.DecodeWithError(response, &result, "AddCropTag")
if err != nil {
return nil, err
}
return &result.TagGroup, nil
return &result.TagGroup, err
}
// EditCropTagRequest 编辑客户企业标签请求
@@ -256,10 +250,8 @@ func (r *Client) GetStrategyTagList(req *GetStrategyTagListRequest) (*GetStrateg
return nil, err
}
result := &GetStrategyTagListResponse{}
if err = util.DecodeWithError(response, result, "GetStrategyTagList"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "GetStrategyTagList")
return result, err
}
// AddStrategyTagRequest 为指定规则组创建企业客户标签请求
@@ -315,10 +307,8 @@ func (r *Client) AddStrategyTag(req *AddStrategyTagRequest) (*AddStrategyTagResp
return nil, err
}
result := &AddStrategyTagResponse{}
if err = util.DecodeWithError(response, result, "AddStrategyTag"); err != nil {
return nil, err
}
return result, nil
err = util.DecodeWithError(response, result, "AddStrategyTag")
return result, err
}
// EditStrategyTagRequest 编辑指定规则组下的企业客户标签请求

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