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

Compare commits

...

115 Commits

Author SHA1 Message Date
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
markwang
9e810be88a feat:企业微信-微信客服-知识库 (#715)
* feat:企业微信-微信客服=知识库

* fix:golangci-lint

* fix:移除非必要的err判断

---------

Co-authored-by: markwang <www.wang61@qq.com>
2023-09-04 20:15:13 +08:00
markwang
06719f77b7 feat:企业微信-微信客服-统计管理 (#707)
Co-authored-by: markwang <www.wang61@qq.com>
2023-08-31 14:36:22 +08:00
markwang
b70ecd93a7 feat:企业微信-消息推送新增接口 (#705)
Co-authored-by: markwang <www.wang61@qq.com>
2023-08-31 14:34:13 +08:00
ccfish
dea33e0e48 小程序消息推送 (#713)
* 小程序消息推送

* fix lint errors

* fix lint

* fix lint

* fix lint,

* 简化写法

* fix 简化写法

* fix name in comments

* add events

* change GoodsInfo type

* change statements to 50

* 追加xml支持

* fix cl lint
2023-08-27 19:13:00 +08:00
ccfish
e02af1dc0f 小程序发货信息管理 (#710)
* 小程序发货信息管理

* fix golang lint

* fix miss

* fix lint

* fix lint

* fix lint

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

* Update miniprogram.go
2023-08-27 11:25:05 +08:00
曹晶
c81d0b1215 feat: 企业微信-客户联系-获客助手 (#704) 2023-08-25 18:28:21 +08:00
Feng
da80430065 feat: Add APIs for User and Department (#712) 2023-08-25 18:27:30 +08:00
houseme
cc201fcece feat: create Mini Program entertainment mini-drama related interface (#711) 2023-08-25 18:02:46 +08:00
houseme
26b0aacb4c feat: create mini program virtual payment (#709) 2023-08-21 22:09:30 +08:00
markwang
7df3fe1a09 feat:企业微信-客户联系-客户朋友圈 (#702)
* feat:企业微信-客户联系-客户朋友圈

* fix:golangci-lint

---------

Co-authored-by: markwang <www.wang61@qq.com>
2023-07-31 19:32:34 +08:00
markwang
5a23c5c780 feat:企业微信-客户联系-在职继承/离职继承 (#699)
Co-authored-by: markwang <www.wang61@qq.com>
2023-07-15 23:58:24 +08:00
黄翠刚
c84eb7b550 新增获取部门列表接口:https://qyapi.weixin.qq.com/cgi-bin/department/list (#698) 2023-07-15 23:56:53 +08:00
ourines
45ad2ab8ca 调整结构体中CreateTime (#691)
* fix: 修改FollowInfo结构体中的tag标签为createtime

* fix: 统一CreateTime为int64

* chore: format

* chore: format
2023-06-30 09:54:12 +08:00
txws
5d0e32e2ea 微信开放平台 消息与事件url 添加result_info (#696)
* add result_info

* edit result_info

* edit-01 result_info

* 开放平台message添加小程序名称审核字段
2023-06-30 09:53:01 +08:00
markwang
822cfaa6c8 feat:企业微信-身份验证-获取用户身份及敏感信息 (#692)
Co-authored-by: markwang <www.wang61@qq.com>
2023-06-30 09:52:44 +08:00
markwang
acaab64fe7 feat:企业微信-客户联系-规则组/规则组标签 (#697)
Co-authored-by: markwang <www.wang61@qq.com>
2023-06-30 09:51:36 +08:00
markwang
b12825f83b feat:企业微信-电子发票 (#695)
Co-authored-by: markwang <www.wang61@qq.com>
2023-06-21 17:31:08 +08:00
okhowang
86cbd8c0b2 feat: 微信回调消息增加菜单ID字段 (#694)
close #693
2023-06-16 18:07:15 +08:00
markwang
46c3722308 feat:企业微信-通讯录管理-互联企业 (#688) 2023-06-12 13:34:56 +08:00
houseme
7d11af713b feat: improve workflows config and upgrade action version (#690) 2023-06-11 12:08:38 +08:00
silenceper
fafb1784da Update go.yml: 指定golangci-lint 版本为v1.52.2 (#689) 2023-06-09 20:35:49 +08:00
sam
31f8e24994 feat: 小程序/公众号增加 openApi 管理。 (#685)
* feat: 小程序/公众号增加 openApi 管理。

* update: 修改字段名大小写。

* update: 修改字段名大小写。

* style: import 换行。

* update: openApi 管理放到内部包中。
2023-06-04 21:57:15 +08:00
sam
ae1b056515 feat: 公众号: 批量获取用户信息。 (#686)
* feat: 公众号: 批量获取用户信息。

* update: 公众号: 调整批量获取用户方法的输入参数。

* update: 公众号: 调整批量获取用户方法的输入参数。
2023-05-31 21:55:21 +08:00
jingyuexing
8bae546b77 Improve developer experience (#681)
* feat: 添加query 以及query单元测试
feat: 添加模板字符串解析以及模板字符串单元测试

* improve: 序列化请求参数,使得参数更易读

* delete: delete useless module

* format: format code

* docs: add function comment

* docs: comment method

* fix: fixed type convert error

* feat: support any type

* feat: support other type

* format: format code

* test: check logger

* format: format code

* test: udpate testing case

* del: remove useless code

* del: remove useless module

* test: update testing case

*  feat: support for unsigned integers

*  feat: template string support any type
2023-05-31 17:26:43 +08:00
markwang
9df943df69 企业微信userid与openid互换 (#676)
* 企业微信-客户联系-统计管理

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

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

* debug

* rollback

* debug

* debug

* 获取用户信息

* token

* json.Marshal错误输出

* debug

* bugfix

* 企业微信-通讯录管理相关接口

* 企业微信-通讯录管理

* 企业微信-通讯录管理

* 企业微信-通讯录管理

* 企业微信-[联系我]方式新增和查询

* 企业微信-[联系我]方式新增和获取

* 企业微信-[联系我]方式更新

* 企业微信-[联系我]方式列表、删除

* json.Marshal错误输出

* 已实现接口bug修改

* 历史接口bugfix

* 历史接口bugfix

* comment

* 企业微信:客户联系-消息推送;素材管理-上传图片

* fix

* 企业微信-获取群发记录列表

* 历史接口bugfix

* 1.企业微信-客户联系-消息推送-入群欢迎语素材管理
2.企业微信-通讯录管理-成员管理-获取成员ID列表

* golangci-lint

* gofmt

* 方法访问命名

* 企业微信-批量获取客户详情入参优化

* 企业微信-通讯录管理-标签管理-创建/更新/删除标签

* 请求地址常量无需导出

* 企业微信保持代码风格统一,接口URL不导出

* 企业微信-通讯录管理-标签管理-获取/增加/删除标签成员、获取标签列表

* feat:企业微信userid与openid互换

---------

Co-authored-by: wang.yu <wangyu@uniondrug.com>
Co-authored-by: markwang <www.wang61@qq.com>
2023-05-16 19:22:56 +08:00
just5325
0a37184c2f 新增应用推送消息模块,实现部分常用消息推送:SendText 发送文本消息、SendImage 发送图片消息、SendVoice 发送语音消息 企业微信应用推送消息接口:https://qyapi.weixin.qq.com/cgi-bin/appchat/send (#678)
* 修正work.GetMessage()方法的注释信息

(cherry picked from commit 3dfaf9222910ae4ad977e2852908692d04118abc)

* 新增应用推送消息模块,实现部分常用消息推送:SendText 发送文本消息、SendImage 发送图片消息、SendVoice 发送语音消息
企业微信应用推送消息接口:https://qyapi.weixin.qq.com/cgi-bin/appchat/send

(cherry picked from commit 654ea158d6590a006a8c78ac3c38eafe361fe303)
2023-05-16 19:22:18 +08:00
Sunny
b4f243ab13 Fix:err != nil return nil (#680) 2023-05-16 19:20:40 +08:00
markwang
d92cd35533 企业微信-通讯录管理-标签管理-获取/增加/删除标签成员、获取标签列表 (#674)
* 企业微信-客户联系-统计管理

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

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

* debug

* rollback

* debug

* debug

* 获取用户信息

* token

* json.Marshal错误输出

* debug

* bugfix

* 企业微信-通讯录管理相关接口

* 企业微信-通讯录管理

* 企业微信-通讯录管理

* 企业微信-通讯录管理

* 企业微信-[联系我]方式新增和查询

* 企业微信-[联系我]方式新增和获取

* 企业微信-[联系我]方式更新

* 企业微信-[联系我]方式列表、删除

* json.Marshal错误输出

* 已实现接口bug修改

* 历史接口bugfix

* 历史接口bugfix

* comment

* 企业微信:客户联系-消息推送;素材管理-上传图片

* fix

* 企业微信-获取群发记录列表

* 历史接口bugfix

* 1.企业微信-客户联系-消息推送-入群欢迎语素材管理
2.企业微信-通讯录管理-成员管理-获取成员ID列表

* golangci-lint

* gofmt

* 方法访问命名

* 企业微信-批量获取客户详情入参优化

* 企业微信-通讯录管理-标签管理-创建/更新/删除标签

* 请求地址常量无需导出

* 企业微信保持代码风格统一,接口URL不导出

* 企业微信-通讯录管理-标签管理-获取/增加/删除标签成员、获取标签列表

---------

Co-authored-by: wang.yu <wangyu@uniondrug.com>
Co-authored-by: markwang <www.wang61@qq.com>
2023-05-08 11:56:48 +08:00
Mark
58621cd79d fix CallbackMessage open_kfid and SyncMsg error (#672)
* 企业微信微信客服字段同步

* fix ci lint

* fix open_kfid xml Unmarshal error and  'syncMsg: field `open_kfid` unexpected empty string. invalid Request Parameter'

* add struct CallbackMessage xml tag

---------

Co-authored-by: liuyuezhong <liuyuezhong@inke.cn>
2023-04-19 16:21:04 +08:00
welllog
8821a3856d feat: 获取稳定版接口调用凭据 (#669)
* feat: 获取稳定版接口调用凭据

* Update default_access_token.go

* fix: format code

---------

Co-authored-by: ctr <orinfy@foxmail.com>
Co-authored-by: houseme <housemecn@gmail.com>
2023-04-18 11:54:34 +08:00
Mark
4094adc5b4 企业微信微信客服字段同步 (#670)
* 企业微信微信客服字段同步

* fix ci lint

---------

Co-authored-by: liuyuezhong <liuyuezhong@inke.cn>
2023-04-18 11:07:06 +08:00
misu
cb0928a03c 获取企业微信实例,设置全局Cache (#671)
Co-authored-by: masong <misu99@github.com>
2023-04-18 11:06:39 +08:00
牛强
d6371c7289 chore: 移除 panic,转移 cache 初始化到 Wechat 结构体方法下;在使用时可以只设置一次 cache 同时避免 panic 出现 (#668) 2023-04-13 14:23:46 +08:00
okhowang
07b7dc40fc cache增加带Context版本,开放平台相关接口支持Context版本 (#653) 2023-04-03 20:32:44 +08:00
Ace
01784c2a4a fix:修复互通红包和视频号消息部分字段错误的数据类型声明 (#663)
* fix:修复消息存档内红包祝福语和视频号部分字段数据类型声明错误的问题

* docs:更新注释说明

* fix:校正互通红包内的数据结构声明类型
2023-04-03 20:31:58 +08:00
Guo yongrong
8bc1474777 增加发送图文消息(点击跳转到图文消息页面)使用通过 “发布” 系列接口得到的 article_id (#664)
Co-authored-by: handson@intonead.com <gyr@3332502!>
2023-04-03 18:13:25 +08:00
markwang
ca0b74e082 企业微信保持代码风格统一,接口URL不导出 (#660)
* 企业微信-客户联系-统计管理

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

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

* debug

* rollback

* debug

* debug

* 获取用户信息

* token

* json.Marshal错误输出

* debug

* bugfix

* 企业微信-通讯录管理相关接口

* 企业微信-通讯录管理

* 企业微信-通讯录管理

* 企业微信-通讯录管理

* 企业微信-[联系我]方式新增和查询

* 企业微信-[联系我]方式新增和获取

* 企业微信-[联系我]方式更新

* 企业微信-[联系我]方式列表、删除

* json.Marshal错误输出

* 已实现接口bug修改

* 历史接口bugfix

* 历史接口bugfix

* comment

* 企业微信:客户联系-消息推送;素材管理-上传图片

* fix

* 企业微信-获取群发记录列表

* 历史接口bugfix

* 1.企业微信-客户联系-消息推送-入群欢迎语素材管理
2.企业微信-通讯录管理-成员管理-获取成员ID列表

* golangci-lint

* gofmt

* 方法访问命名

* 企业微信-批量获取客户详情入参优化

* 企业微信-通讯录管理-标签管理-创建/更新/删除标签

* 请求地址常量无需导出

* 企业微信保持代码风格统一,接口URL不导出

---------

Co-authored-by: wang.yu <wangyu@uniondrug.com>
Co-authored-by: markwang <www.wang61@qq.com>
2023-04-03 17:06:07 +08:00
markwang
fbda048f62 企业微信-通讯录管理-标签管理-创建/更新/删除标签 (#659) 2023-03-21 23:58:37 +08:00
markwang
494082ff4f 企业微信-批量获取客户详情入参优化 (#657)
* 企业微信-批量获取客户详情入参优化

---------

Co-authored-by: wang.yu <wangyu@uniondrug.com>
Co-authored-by: markwang <www.wang61@qq.com>
2023-03-14 19:18:20 +08:00
johnpoint
9c0189340b pref: 变量命名 & url (#650) 2023-02-14 12:04:44 +08:00
realpg
d39615f2fa 补全模板消息API中遗漏的 ‘防重入ID’ 参数 (#651)
client_msg_id:
防重入id。
对于同一个openid + client_msg_id, 只发送一条消息,10分钟有效,超过10分钟不保证效果。若无防重入需求,可不填
2023-02-11 23:50:33 +08:00
just5325
429219b53f 新增消息推送模块,实现部分常用消息推送:SendText 发送文本消息、SendImage 发送图片消息、SendVoice 发送语音消息 (#649)
企业微信消息推送接口:https://qyapi.weixin.qq.com/cgi-bin/message/send
2023-02-10 17:11:02 +08:00
johnpoint
6e80b71cb2 避免无效的access_token留在cache (#645) 2023-02-08 21:19:37 +08:00
Lien Li
ab354c4d03 feat: 支持企业微信上传临时素材 (#644) 2023-02-06 08:43:41 +08:00
daguang
d1d034eb95 oauth add snapshot user mark field (#643) 2023-01-29 11:58:00 +08:00
Lien Li
1a9dbc493b feat:支持客户联系的服务端事件 (#639)
https://developer.work.weixin.qq.com/document/path/92130
2023-01-04 10:26:16 +08:00
Lien Li
04559ed4bb fix:避免游标拼接异常导致取不到数据 (#638) 2023-01-03 10:07:45 +08:00
silenceper
abd583df01 fix #636 生成短链方法报commonError is invalid or not struct (#637) 2023-01-01 23:54:58 +08:00
xuannanxan
3cb741ae1a 企业微信客户群进群方式配置(#631) (#632) 2022-11-17 09:28:42 +08:00
markwang
da3859261b 企业微信-欢迎语素材管理,企业微信-获取成员ID列表 (#629)
* 企业微信-客户联系-统计管理

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

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

* debug

* rollback

* debug

* debug

* 获取用户信息

* token

* json.Marshal错误输出

* debug

* bugfix

* 企业微信-通讯录管理相关接口

* 企业微信-通讯录管理

* 企业微信-通讯录管理

* 企业微信-通讯录管理

* 企业微信-[联系我]方式新增和查询

* 企业微信-[联系我]方式新增和获取

* 企业微信-[联系我]方式更新

* 企业微信-[联系我]方式列表、删除

* json.Marshal错误输出

* 已实现接口bug修改

* 历史接口bugfix

* 历史接口bugfix

* comment

* 企业微信:客户联系-消息推送;素材管理-上传图片

* fix

* 企业微信-获取群发记录列表

* 历史接口bugfix

* 1.企业微信-客户联系-消息推送-入群欢迎语素材管理
2.企业微信-通讯录管理-成员管理-获取成员ID列表

* golangci-lint

* gofmt

* 方法访问命名

Co-authored-by: wang.yu <wangyu@uniondrug.com>
2022-10-20 14:34:51 +08:00
Mr. Yang
86ceb6af2f 增加小程序审核结果回调通知 (#630)
Co-authored-by: yanglaosan <yang88can@163.com>
2022-10-17 16:52:19 +08:00
markwang
243f8198ae 企业微信-客户联系-获取群发记录列表 (#627)
* 企业微信-客户联系-统计管理

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

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

* debug

* rollback

* debug

* debug

* 获取用户信息

* token

* json.Marshal错误输出

* debug

* bugfix

* 企业微信-通讯录管理相关接口

* 企业微信-通讯录管理

* 企业微信-通讯录管理

* 企业微信-通讯录管理

* 企业微信-[联系我]方式新增和查询

* 企业微信-[联系我]方式新增和获取

* 企业微信-[联系我]方式更新

* 企业微信-[联系我]方式列表、删除

* json.Marshal错误输出

* 已实现接口bug修改

* 历史接口bugfix

* 历史接口bugfix

* comment

* 企业微信:客户联系-消息推送;素材管理-上传图片

* fix

* 企业微信-获取群发记录列表

* 历史接口bugfix

Co-authored-by: wang.yu <wangyu@uniondrug.com>
2022-10-12 10:03:08 +08:00
128 changed files with 10994 additions and 739 deletions

View File

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

View File

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

View File

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

View File

@@ -2,25 +2,29 @@ name: Go
on: on:
push: push:
branches: [ master,release-*,v2 ] branches: [ master,release-*,v2,feature/**,fix/** ]
pull_request: pull_request:
branches: [ master,release-*,v2 ] branches: [ master,release-*,v2,feature/**,fix/** ]
jobs: jobs:
golangci: golangci:
strategy: strategy:
matrix: matrix:
go-version: [1.16.x,1.17.x,1.18.x] go-version: [ '1.16','1.17','1.18','1.19','1.20','1.21.4' ]
name: golangci-lint name: golangci-lint
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/setup-go@v3 - name: Setup Golang ${{ matrix.go-version }}
- uses: actions/checkout@v3 uses: actions/setup-go@v5
with:
go-version: ${{ matrix.go-version }}
- name: Checkout
uses: actions/checkout@v4
- name: golangci-lint - name: golangci-lint
uses: golangci/golangci-lint-action@v3.2.0 uses: golangci/golangci-lint-action@v4
with: with:
# Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version. # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
version: latest version: v1.52.2
build: build:
name: Test name: Test
runs-on: ubuntu-latest runs-on: ubuntu-latest
@@ -28,7 +32,7 @@ jobs:
redis: redis:
image: redis image: redis
ports: ports:
- 6379:6379 - 6379:6379
options: --entrypoint redis-server options: --entrypoint redis-server
memcached: memcached:
image: memcached image: memcached
@@ -38,14 +42,14 @@ jobs:
# strategy set # strategy set
strategy: strategy:
matrix: matrix:
go: ["1.16", "1.17", "1.18"] go: [ '1.16','1.17','1.18','1.19','1.20','1.21','1.22' ]
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v4
- name: Set up Go 1.x - name: Set up Go 1.x
uses: actions/setup-go@v2 uses: actions/setup-go@v5
with: with:
go-version: ${{ matrix.go }} go-version: ${{ matrix.go }}
id: go id: go
- name: Test - name: Test
run: go test -v -race ./... run: go test -v -race ./...

View File

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

View File

@@ -55,7 +55,7 @@ issues:
linters-settings: linters-settings:
funlen: funlen:
lines: 66 lines: 66
statements: 40 statements: 50
#issues: #issues:
# include: # include:

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:'

46
cache/cache.go vendored
View File

@@ -1,6 +1,9 @@
package cache package cache
import "time" import (
"context"
"time"
)
// Cache interface // Cache interface
type Cache interface { type Cache interface {
@@ -9,3 +12,44 @@ type Cache interface {
IsExist(key string) bool IsExist(key string) bool
Delete(key string) error Delete(key string) error
} }
// ContextCache interface
type ContextCache interface {
Cache
GetContext(ctx context.Context, key string) interface{}
SetContext(ctx context.Context, key string, val interface{}, timeout time.Duration) error
IsExistContext(ctx context.Context, key string) bool
DeleteContext(ctx context.Context, key string) error
}
// GetContext get value from cache
func GetContext(ctx context.Context, cache Cache, key string) interface{} {
if cache, ok := cache.(ContextCache); ok {
return cache.GetContext(ctx, key)
}
return cache.Get(key)
}
// SetContext set value to cache
func SetContext(ctx context.Context, cache Cache, key string, val interface{}, timeout time.Duration) error {
if cache, ok := cache.(ContextCache); ok {
return cache.SetContext(ctx, key, val, timeout)
}
return cache.Set(key, val, timeout)
}
// IsExistContext check value exists in cache.
func IsExistContext(ctx context.Context, cache Cache, key string) bool {
if cache, ok := cache.(ContextCache); ok {
return cache.IsExistContext(ctx, key)
}
return cache.IsExist(key)
}
// DeleteContext delete value in cache.
func DeleteContext(ctx context.Context, cache Cache, key string) error {
if cache, ok := cache.(ContextCache); ok {
return cache.DeleteContext(ctx, key)
}
return cache.Delete(key)
}

30
cache/redis.go vendored
View File

@@ -16,6 +16,7 @@ type Redis struct {
// RedisOpts redis 连接属性 // RedisOpts redis 连接属性
type RedisOpts struct { type RedisOpts struct {
Host string `yml:"host" json:"host"` Host string `yml:"host" json:"host"`
Username string `yaml:"username" json:"username"`
Password string `yml:"password" json:"password"` Password string `yml:"password" json:"password"`
Database int `yml:"database" json:"database"` Database int `yml:"database" json:"database"`
MaxIdle int `yml:"max_idle" json:"max_idle"` MaxIdle int `yml:"max_idle" json:"max_idle"`
@@ -28,6 +29,7 @@ func NewRedis(ctx context.Context, opts *RedisOpts) *Redis {
conn := redis.NewUniversalClient(&redis.UniversalOptions{ conn := redis.NewUniversalClient(&redis.UniversalOptions{
Addrs: []string{opts.Host}, Addrs: []string{opts.Host},
DB: opts.Database, DB: opts.Database,
Username: opts.Username,
Password: opts.Password, Password: opts.Password,
IdleTimeout: time.Second * time.Duration(opts.IdleTimeout), IdleTimeout: time.Second * time.Duration(opts.IdleTimeout),
MinIdleConns: opts.MaxIdle, MinIdleConns: opts.MaxIdle,
@@ -47,7 +49,12 @@ func (r *Redis) SetRedisCtx(ctx context.Context) {
// Get 获取一个值 // Get 获取一个值
func (r *Redis) Get(key string) interface{} { func (r *Redis) Get(key string) interface{} {
result, err := r.conn.Do(r.ctx, "GET", key).Result() return r.GetContext(r.ctx, key)
}
// GetContext 获取一个值
func (r *Redis) GetContext(ctx context.Context, key string) interface{} {
result, err := r.conn.Do(ctx, "GET", key).Result()
if err != nil { if err != nil {
return nil return nil
} }
@@ -56,17 +63,32 @@ func (r *Redis) Get(key string) interface{} {
// Set 设置一个值 // Set 设置一个值
func (r *Redis) Set(key string, val interface{}, timeout time.Duration) error { func (r *Redis) Set(key string, val interface{}, timeout time.Duration) error {
return r.conn.SetEX(r.ctx, key, val, timeout).Err() return r.SetContext(r.ctx, key, val, timeout)
}
// SetContext 设置一个值
func (r *Redis) SetContext(ctx context.Context, key string, val interface{}, timeout time.Duration) error {
return r.conn.SetEX(ctx, key, val, timeout).Err()
} }
// IsExist 判断key是否存在 // IsExist 判断key是否存在
func (r *Redis) IsExist(key string) bool { func (r *Redis) IsExist(key string) bool {
result, _ := r.conn.Exists(r.ctx, key).Result() return r.IsExistContext(r.ctx, key)
}
// IsExistContext 判断key是否存在
func (r *Redis) IsExistContext(ctx context.Context, key string) bool {
result, _ := r.conn.Exists(ctx, key).Result()
return result > 0 return result > 0
} }
// Delete 删除 // Delete 删除
func (r *Redis) Delete(key string) error { func (r *Redis) Delete(key string) error {
return r.conn.Del(r.ctx, key).Err() return r.DeleteContext(r.ctx, key)
}
// DeleteContext 删除
func (r *Redis) DeleteContext(ctx context.Context, key string) error {
return r.conn.Del(ctx, key).Err()
} }

10
cache/redis_test.go vendored
View File

@@ -4,17 +4,23 @@ import (
"context" "context"
"testing" "testing"
"time" "time"
"github.com/alicebob/miniredis/v2"
) )
func TestRedis(t *testing.T) { func TestRedis(t *testing.T) {
server, err := miniredis.Run()
if err != nil {
t.Error("miniredis.Run Error", err)
}
t.Cleanup(server.Close)
var ( var (
timeoutDuration = time.Second timeoutDuration = time.Second
ctx = context.Background() ctx = context.Background()
opts = &RedisOpts{ opts = &RedisOpts{
Host: "127.0.0.1:6379", Host: server.Addr(),
} }
redis = NewRedis(ctx, opts) redis = NewRedis(ctx, opts)
err error
val = "silenceper" val = "silenceper"
key = "username" key = "username"
) )

View File

@@ -7,6 +7,16 @@ type AccessTokenHandle interface {
GetAccessToken() (accessToken string, err error) 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 接口 // AccessTokenContextHandle AccessToken 接口
type AccessTokenContextHandle interface { type AccessTokenContextHandle interface {
AccessTokenHandle AccessTokenHandle

View File

@@ -12,9 +12,11 @@ import (
) )
const ( const (
// AccessTokenURL 获取access_token的接口 // accessTokenURL 获取access_token的接口
accessTokenURL = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=%s&secret=%s" accessTokenURL = "https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=%s&secret=%s"
// AccessTokenURL 企业微信获取access_token的接口 // stableAccessTokenURL 获取稳定版access_token的接口
stableAccessTokenURL = "https://api.weixin.qq.com/cgi-bin/stable_token"
// workAccessTokenURL 企业微信获取access_token的接口
workAccessTokenURL = "https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=%s&corpsecret=%s" workAccessTokenURL = "https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=%s&corpsecret=%s"
// CacheKeyOfficialAccountPrefix 微信公众号cache key前缀 // CacheKeyOfficialAccountPrefix 微信公众号cache key前缀
CacheKeyOfficialAccountPrefix = "gowechat_officialaccount_" CacheKeyOfficialAccountPrefix = "gowechat_officialaccount_"
@@ -64,8 +66,11 @@ func (ak *DefaultAccessToken) GetAccessToken() (accessToken string, err error) {
func (ak *DefaultAccessToken) GetAccessTokenContext(ctx context.Context) (accessToken string, err error) { func (ak *DefaultAccessToken) GetAccessTokenContext(ctx context.Context) (accessToken string, err error) {
// 先从cache中取 // 先从cache中取
accessTokenCacheKey := fmt.Sprintf("%s_access_token_%s", ak.cacheKeyPrefix, ak.appID) accessTokenCacheKey := fmt.Sprintf("%s_access_token_%s", ak.cacheKeyPrefix, ak.appID)
if val := ak.cache.Get(accessTokenCacheKey); val != nil { if val := ak.cache.Get(accessTokenCacheKey); val != nil {
return val.(string), nil if accessToken = val.(string); accessToken != "" {
return
}
} }
// 加上lock是为了防止在并发获取token时cache刚好失效导致从微信服务器上获取到不同token // 加上lock是为了防止在并发获取token时cache刚好失效导致从微信服务器上获取到不同token
@@ -74,42 +79,137 @@ func (ak *DefaultAccessToken) GetAccessTokenContext(ctx context.Context) (access
// 双检,防止重复从微信服务器获取 // 双检,防止重复从微信服务器获取
if val := ak.cache.Get(accessTokenCacheKey); val != nil { if val := ak.cache.Get(accessTokenCacheKey); val != nil {
return val.(string), nil if accessToken = val.(string); accessToken != "" {
return
}
} }
// cache失效从微信服务器获取 // cache失效从微信服务器获取
var resAccessToken ResAccessToken var resAccessToken ResAccessToken
resAccessToken, err = GetTokenFromServerContext(ctx, fmt.Sprintf(accessTokenURL, ak.appID, ak.appSecret)) if resAccessToken, err = GetTokenFromServerContext(ctx, fmt.Sprintf(accessTokenURL, ak.appID, ak.appSecret)); err != nil {
if err != nil {
return return
} }
expires := resAccessToken.ExpiresIn - 1500 expires := resAccessToken.ExpiresIn - 1500
err = 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
}
// StableAccessToken 获取稳定版接口调用凭据(与getAccessToken获取的调用凭证完全隔离互不影响)
// 不强制更新access_token,可用于不同环境不同服务而不需要分布式锁以及公用缓存避免access_token争抢
// https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-access-token/getStableAccessToken.html
type StableAccessToken struct {
appID string
appSecret string
cacheKeyPrefix string
cache cache.Cache
accessTokenLock *sync.Mutex
}
// NewStableAccessToken new StableAccessToken
func NewStableAccessToken(appID, appSecret, cacheKeyPrefix string, cache cache.Cache) AccessTokenContextHandle {
if cache == nil {
panic("cache is need")
}
return &StableAccessToken{
appID: appID,
appSecret: appSecret,
cache: cache,
cacheKeyPrefix: cacheKeyPrefix,
accessTokenLock: new(sync.Mutex),
}
}
// GetAccessToken 获取access_token,先从cache中获取没有则从服务端获取
func (ak *StableAccessToken) GetAccessToken() (accessToken string, err error) {
return ak.GetAccessTokenContext(context.Background())
}
// GetAccessTokenContext 获取access_token,先从cache中获取没有则从服务端获取
func (ak *StableAccessToken) GetAccessTokenContext(ctx context.Context) (accessToken string, err error) {
// 先从cache中取
accessTokenCacheKey := fmt.Sprintf("%s_stable_access_token_%s", ak.cacheKeyPrefix, ak.appID)
if val := ak.cache.Get(accessTokenCacheKey); val != nil {
if accessToken = val.(string); accessToken != "" {
return
}
}
// 加上lock是为了防止在并发获取token时cache刚好失效导致从微信服务器上获取到不同token
ak.accessTokenLock.Lock()
defer ak.accessTokenLock.Unlock()
// 双检,防止重复从微信服务器获取
if val := ak.cache.Get(accessTokenCacheKey); val != nil {
if accessToken = val.(string); accessToken != "" {
return
}
}
// cache失效从微信服务器获取
var resAccessToken ResAccessToken
resAccessToken, err = ak.GetAccessTokenDirectly(ctx, false)
if err != nil { if err != nil {
return return
} }
expires := resAccessToken.ExpiresIn - 300
err = ak.cache.Set(accessTokenCacheKey, resAccessToken.AccessToken, time.Duration(expires)*time.Second)
accessToken = resAccessToken.AccessToken accessToken = resAccessToken.AccessToken
return return
} }
// GetAccessTokenDirectly 从微信获取access_token
func (ak *StableAccessToken) GetAccessTokenDirectly(ctx context.Context, forceRefresh bool) (resAccessToken ResAccessToken, err error) {
b, err := util.PostJSONContext(ctx, stableAccessTokenURL, map[string]interface{}{
"grant_type": "client_credential",
"appid": ak.appID,
"secret": ak.appSecret,
"force_refresh": forceRefresh,
})
if err != nil {
return
}
if err = json.Unmarshal(b, &resAccessToken); err != nil {
return
}
if resAccessToken.ErrCode != 0 {
err = fmt.Errorf("get stable access_token error : errcode=%v , errormsg=%v", resAccessToken.ErrCode, resAccessToken.ErrMsg)
return
}
return
}
// WorkAccessToken 企业微信AccessToken 获取 // WorkAccessToken 企业微信AccessToken 获取
type WorkAccessToken struct { type WorkAccessToken struct {
CorpID string CorpID string
CorpSecret string CorpSecret string
AgentID string // 可选,用于区分不同应用
cacheKeyPrefix string cacheKeyPrefix string
cache cache.Cache cache cache.Cache
accessTokenLock *sync.Mutex accessTokenLock *sync.Mutex
} }
// NewWorkAccessToken new WorkAccessToken // NewWorkAccessToken new WorkAccessToken (保持向后兼容)
func NewWorkAccessToken(corpID, corpSecret, cacheKeyPrefix string, cache cache.Cache) AccessTokenContextHandle { 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 { if cache == nil {
panic("cache the not exist") panic("cache is needed")
} }
return &WorkAccessToken{ return &WorkAccessToken{
CorpID: corpID, CorpID: corpID,
CorpSecret: corpSecret, CorpSecret: corpSecret,
AgentID: agentID,
cache: cache, cache: cache,
cacheKeyPrefix: cacheKeyPrefix, cacheKeyPrefix: cacheKeyPrefix,
accessTokenLock: new(sync.Mutex), accessTokenLock: new(sync.Mutex),
@@ -126,7 +226,18 @@ func (ak *WorkAccessToken) GetAccessTokenContext(ctx context.Context) (accessTok
// 加上lock是为了防止在并发获取token时cache刚好失效导致从微信服务器上获取到不同token // 加上lock是为了防止在并发获取token时cache刚好失效导致从微信服务器上获取到不同token
ak.accessTokenLock.Lock() ak.accessTokenLock.Lock()
defer ak.accessTokenLock.Unlock() 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) val := ak.cache.Get(accessTokenCacheKey)
if val != nil { if val != nil {
accessToken = val.(string) accessToken = val.(string)
@@ -145,6 +256,7 @@ func (ak *WorkAccessToken) GetAccessTokenContext(ctx context.Context) (accessTok
if err != nil { if err != nil {
return return
} }
accessToken = resAccessToken.AccessToken accessToken = resAccessToken.AccessToken
return return
} }

View File

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

@@ -62,21 +62,25 @@ host: https://qyapi.weixin.qq.com/
### 客户联系 ### 客户联系
[官方文档](https://developer.work.weixin.qq.com/document/path/92132/92133/92228) [官方文档](https://developer.work.weixin.qq.com/document/path/92132/92133/92228)
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 | | 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 |
|:------------------------:| -------- | :---------------------------------------| ---------- | ------------------------------- |----------| |:------------------------:| -------- |:-------------------------------------------------------------| ---------- | ------------------------------- |----------|
| 获取「联系客户统计」数据 | POST | /cgi-bin/externalcontact/get_user_behavior_data | YES | (r *Client) GetUserBehaviorData | MARKWANG | | 获取「联系客户统计」数据 | POST | /cgi-bin/externalcontact/get_user_behavior_data | YES | (r *Client) GetUserBehaviorData | MARKWANG |
| 获取「群聊数据统计」数据 (按群主聚合的方式) | POST | /cgi-bin/externalcontact/groupchat/statistic | YES | (r *Client) GetGroupChatStat | MARKWANG | | 获取「群聊数据统计」数据 (按群主聚合的方式) | POST | /cgi-bin/externalcontact/groupchat/statistic | YES | (r *Client) GetGroupChatStat | MARKWANG |
| 获取「群聊数据统计」数据 (按自然日聚合的方式) | POST | /cgi-bin/externalcontact/groupchat/statistic_group_by_day | YES | (r *Client) GetGroupChatStatByDay | MARKWANG | | 获取「群聊数据统计」数据 (按自然日聚合的方式) | POST | /cgi-bin/externalcontact/groupchat/statistic_group_by_day | YES | (r *Client) GetGroupChatStatByDay | MARKWANG |
| 配置客户联系「联系我」方式 | POST | /cgi-bin/externalcontact/add_contact_way | YES | (r *Client) AddContactWay | MARKWANG | | 配置客户联系「联系我」方式 | POST | /cgi-bin/externalcontact/add_contact_way | YES | (r *Client) AddContactWay | MARKWANG |
| 获取企业已配置的「联系我」方式 | POST | /cgi-bin/externalcontact/get_contact_way | YES | (r *Client) GetContactWay | MARKWANG | | 获取企业已配置的「联系我」方式 | POST | /cgi-bin/externalcontact/get_contact_way | YES | (r *Client) GetContactWay | MARKWANG |
| 更新企业已配置的「联系我」方式 | POST | /cgi-bin/externalcontact/update_contact_way | YES | (r *Client) UpdateContactWay | MARKWANG | | 更新企业已配置的「联系我」方式 | POST | /cgi-bin/externalcontact/update_contact_way | YES | (r *Client) UpdateContactWay | MARKWANG |
| 获取企业已配置的「联系我」列表 | POST | /cgi-bin/externalcontact/list_contact_way | YES | (r *Client) ListContactWay | MARKWANG | | 获取企业已配置的「联系我」列表 | POST | /cgi-bin/externalcontact/list_contact_way | YES | (r *Client) ListContactWay | MARKWANG |
| 删除企业已配置的「联系我」方式 | POST | /cgi-bin/externalcontact/del_contact_way | YES | (r *Client) DelContactWay | MARKWANG | | 删除企业已配置的「联系我」方式 | POST | /cgi-bin/externalcontact/del_contact_way | YES | (r *Client) DelContactWay | MARKWANG |
| 创建企业群发 | POST | /cgi-bin/externalcontact/add_msg_template | YES | (r *Client) AddMsgTemplate | MARKWANG | | 创建企业群发 | POST | /cgi-bin/externalcontact/add_msg_template | YES | (r *Client) AddMsgTemplate | MARKWANG |
| 获取群发记录列表 | POST | /cgi-bin/externalcontact/get_groupmsg_list_v2 | YES | (r *Client) GetGroupMsgListV2 | MARKWANG | | 获取群发记录列表 | POST | /cgi-bin/externalcontact/get_groupmsg_list_v2 | YES | (r *Client) GetGroupMsgListV2 | MARKWANG |
| 获取群发成员发送任务列表 | POST | /cgi-bin/externalcontact/get_groupmsg_task | YES | (r *Client) GetGroupMsgTask | MARKWANG | | 获取群发成员发送任务列表 | POST | /cgi-bin/externalcontact/get_groupmsg_task | YES | (r *Client) GetGroupMsgTask | MARKWANG |
| 获取企业群发成员执行结果 | POST | /cgi-bin/externalcontact/get_groupmsg_send_result | YES | (r *Client) GetGroupMsgSendResult | MARKWANG | | 获取企业群发成员执行结果 | POST | /cgi-bin/externalcontact/get_groupmsg_send_result | YES | (r *Client) GetGroupMsgSendResult | MARKWANG |
| 发送新客户欢迎语 | POST | /cgi-bin/externalcontact/send_welcome_msg | YES | (r *Client) SendWelcomeMsg | MARKWANG | | 发送新客户欢迎语 | POST | /cgi-bin/externalcontact/send_welcome_msg | YES | (r *Client) SendWelcomeMsg | MARKWANG |
| 添加入群欢迎语素材 | POST | /cgi-bin/externalcontact/group_welcome_template/add | YES | (r *Client) AddGroupWelcomeTemplate | MARKWANG |
| 编辑入群欢迎语素材 | POST | /cgi-bin/externalcontact/group_welcome_template/edit | YES | (r *Client) EditGroupWelcomeTemplate | MARKWANG |
| 获取入群欢迎语素材 | POST | /cgi-bin/externalcontact/group_welcome_template/get | YES | (r *Client) GetGroupWelcomeTemplate | MARKWANG |
| 删除入群欢迎语素材 | POST | /cgi-bin/externalcontact/group_welcome_template/del | YES | (r *Client) DelGroupWelcomeTemplate | MARKWANG |
## 通讯录管理 ## 通讯录管理
[官方文档](https://developer.work.weixin.qq.com/document/path/90193) [官方文档](https://developer.work.weixin.qq.com/document/path/90193)
@@ -86,7 +90,10 @@ host: https://qyapi.weixin.qq.com/
| 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 | | 名称 | 请求方式 | URL | 是否已实现 | 使用方法 | 贡献者 |
|:---------:|------|:----------------------------------------| ---------- | ------------------------------- |----------| |:---------:|------|:----------------------------------------| ---------- | ------------------------------- |----------|
| 获取子部门ID列表 | GET | /cgi-bin/department/simplelist | YES | (r *Client) DepartmentSimpleList| MARKWANG | | 获取子部门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 | | 获取部门成员 | GET | /cgi-bin/user/simplelist | YES | (r *Client) UserSimpleList | MARKWANG |
| 获取成员ID列表 | Post | /cgi-bin/user/list_id | YES | (r *Client) UserListId | MARKWANG |
## 素材管理 ## 素材管理
@@ -111,5 +118,14 @@ host: https://qyapi.weixin.qq.com/
| ---------------- | -------- | --------------------- | ---------- | -------------------------- | -------- | | ---------------- | -------- | --------------------- | ---------- | -------------------------- | -------- |
| 群机器人发送消息 | POST | /cgi-bin/webhook/send | YES | (r *Client) RobotBroadcast | chcthink | | 群机器人发送消息 | 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 TODO

36
domain/openapi/mgnt.go Normal file
View File

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

1
go.mod
View File

@@ -3,6 +3,7 @@ module github.com/silenceper/wechat/v2
go 1.16 go 1.16
require ( require (
github.com/alicebob/miniredis/v2 v2.30.0
github.com/bradfitz/gomemcache v0.0.0-20220106215444-fb4bf637b56d github.com/bradfitz/gomemcache v0.0.0-20220106215444-fb4bf637b56d
github.com/fatih/structs v1.1.0 github.com/fatih/structs v1.1.0
github.com/go-redis/redis/v8 v8.11.5 github.com/go-redis/redis/v8 v8.11.5

7
go.sum
View File

@@ -1,3 +1,7 @@
github.com/alicebob/gopher-json v0.0.0-20200520072559-a9ecdc9d1d3a h1:HbKu58rmZpUGpz5+4FfNmIU+FmZg2P3Xaj2v2bfNWmk=
github.com/alicebob/gopher-json v0.0.0-20200520072559-a9ecdc9d1d3a/go.mod h1:SGnFV6hVsYE877CKEZ6tDNTjaSXYUk6QqoIK6PrAtcc=
github.com/alicebob/miniredis/v2 v2.30.0 h1:uA3uhDbCxfO9+DI/DuGeAMr9qI+noVWwGPNTFuKID5M=
github.com/alicebob/miniredis/v2 v2.30.0/go.mod h1:84TWKZlxYkfgMucPBf5SOQBYJceZeQRFIaQgNMiCX6Q=
github.com/bradfitz/gomemcache v0.0.0-20220106215444-fb4bf637b56d h1:pVrfxiGfwelyab6n21ZBkbkmbevaf+WvMIiR7sr97hw= github.com/bradfitz/gomemcache v0.0.0-20220106215444-fb4bf637b56d h1:pVrfxiGfwelyab6n21ZBkbkmbevaf+WvMIiR7sr97hw=
github.com/bradfitz/gomemcache v0.0.0-20220106215444-fb4bf637b56d/go.mod h1:H0wQNHz2YrLsuXOZozoeDmnHXkNCRmMW0gwFWDfEZDA= github.com/bradfitz/gomemcache v0.0.0-20220106215444-fb4bf637b56d/go.mod h1:H0wQNHz2YrLsuXOZozoeDmnHXkNCRmMW0gwFWDfEZDA=
github.com/cespare/xxhash/v2 v2.1.2 h1:YRXhKfTDauu4ajMg1TPgFO5jnlC2HCbmLXMcTG5cbYE= github.com/cespare/xxhash/v2 v2.1.2 h1:YRXhKfTDauu4ajMg1TPgFO5jnlC2HCbmLXMcTG5cbYE=
@@ -71,6 +75,8 @@ github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JT
github.com/tidwall/pretty v1.2.0 h1:RWIZEg2iJ8/g6fDDYzMpobmaoGh5OLl4AXtGUGPcqCs= github.com/tidwall/pretty v1.2.0 h1:RWIZEg2iJ8/g6fDDYzMpobmaoGh5OLl4AXtGUGPcqCs=
github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU= github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
github.com/yuin/gopher-lua v0.0.0-20220504180219-658193537a64 h1:5mLPGnFdSsevFRFc9q3yYbBkB6tsm4aCwwQV/j1JQAQ=
github.com/yuin/gopher-lua v0.0.0-20220504180219-658193537a64/go.mod h1:GBR0iDaNXjAgGg9zfCvksxSRnQx76gclCIb7kdAd1Pw=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
@@ -89,6 +95,7 @@ golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJ
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20180909124046-d0be0721c37e/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190204203706-41f3e6584952/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20190904154756-749cb33beabd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190904154756-749cb33beabd/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=

127
internal/openapi/mgnt.go Normal file
View File

@@ -0,0 +1,127 @@
package openapi
import (
"errors"
"fmt"
"github.com/silenceper/wechat/v2/domain/openapi"
mpContext "github.com/silenceper/wechat/v2/miniprogram/context"
ocContext "github.com/silenceper/wechat/v2/officialaccount/context"
"github.com/silenceper/wechat/v2/util"
)
const (
clearQuotaURL = "https://api.weixin.qq.com/cgi-bin/clear_quota" // 重置API调用次数
getAPIQuotaURL = "https://api.weixin.qq.com/cgi-bin/openapi/quota/get" // 查询API调用额度
getRidInfoURL = "https://api.weixin.qq.com/cgi-bin/openapi/rid/get" // 查询rid信息
clearQuotaByAppSecretURL = "https://api.weixin.qq.com/cgi-bin/clear_quota/v2" // 使用AppSecret重置 API 调用次数
)
// OpenAPI openApi管理
type OpenAPI struct {
ctx interface{}
}
// NewOpenAPI 实例化
func NewOpenAPI(ctx interface{}) *OpenAPI {
return &OpenAPI{ctx: ctx}
}
// ClearQuota 重置API调用次数
// https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/clearQuota.html
func (o *OpenAPI) ClearQuota() error {
appID, _, err := o.getAppIDAndSecret()
if err != nil {
return err
}
var payload = struct {
AppID string `json:"appid"`
}{
AppID: appID,
}
res, err := o.doPostRequest(clearQuotaURL, payload)
if err != nil {
return err
}
return util.DecodeWithCommonError(res, "ClearQuota")
}
// GetAPIQuota 查询API调用额度
// https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/getApiQuota.html
func (o *OpenAPI) GetAPIQuota(params openapi.GetAPIQuotaParams) (quota openapi.APIQuota, err error) {
res, err := o.doPostRequest(getAPIQuotaURL, params)
if err != nil {
return
}
err = util.DecodeWithError(res, &quota, "GetAPIQuota")
return
}
// GetRidInfo 查询rid信息
// https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/getRidInfo.html
func (o *OpenAPI) GetRidInfo(params openapi.GetRidInfoParams) (r openapi.RidInfo, err error) {
res, err := o.doPostRequest(getRidInfoURL, params)
if err != nil {
return
}
err = util.DecodeWithError(res, &r, "GetRidInfo")
return
}
// ClearQuotaByAppSecret 使用AppSecret重置 API 调用次数
// https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/openApi-mgnt/clearQuotaByAppSecret.html
func (o *OpenAPI) ClearQuotaByAppSecret() error {
id, secret, err := o.getAppIDAndSecret()
if err != nil {
return err
}
uri := fmt.Sprintf("%s?appid=%s&appsecret=%s", clearQuotaByAppSecretURL, id, secret)
res, err := util.HTTPPost(uri, "")
if err != nil {
return err
}
return util.DecodeWithCommonError(res, "ClearQuotaByAppSecret")
}
// 获取 AppID 和 AppSecret
func (o *OpenAPI) getAppIDAndSecret() (string, string, error) {
switch o.ctx.(type) {
case *mpContext.Context:
c := o.ctx.(*mpContext.Context)
return c.AppID, c.AppSecret, nil
case *ocContext.Context:
c := o.ctx.(*ocContext.Context)
return c.AppID, c.AppSecret, nil
default:
return "", "", errors.New("invalid context type")
}
}
// 获取 AccessToken
func (o *OpenAPI) getAccessToken() (string, error) {
switch o.ctx.(type) {
case *mpContext.Context:
return o.ctx.(*mpContext.Context).GetAccessToken()
case *ocContext.Context:
return o.ctx.(*ocContext.Context).GetAccessToken()
default:
return "", errors.New("invalid context type")
}
}
// 创建 POST 请求
func (o *OpenAPI) doPostRequest(uri string, payload interface{}) ([]byte, error) {
ak, err := o.getAccessToken()
if err != nil {
return nil, err
}
uri = fmt.Sprintf("%s?access_token=%s", uri, ak)
return util.PostJSON(uri, payload)
}

View File

@@ -4,7 +4,7 @@
## 包说明 ## 包说明
- analysis 数据分析相关API - analysis 数据分析相关 API
## 快速入门 ## 快速入门
@@ -18,4 +18,36 @@ cfg := &miniConfig.Config{
} }
miniprogram := wc.GetMiniProgram(cfg) miniprogram := wc.GetMiniProgram(cfg)
miniprogram.GetAnalysis().GetAnalysisDailyRetain() miniprogram.GetAnalysis().GetAnalysisDailyRetain()
```
### 小程序虚拟支付
#### `注意:需要传入 Appkey、OfferID 的值`
相关文档:[小程序虚拟支付](https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/virtual-payment.html)
```go
wc := wechat.NewWechat()
miniprogram := wc.GetMiniProgram(&miniConfig.Config{
AppID: "xxx",
AppSecret: "xxx",
AppKey: "xxx",
OfferID: "xxx",
Cache: cache.NewRedis(&redis.Options{
Addr: "",
}),
})
virtualPayment := miniprogram.GetVirtualPayment()
virtualPayment.SetSessionKey("xxx")
// 查询用户余额
var (
res *virtualPayment.QueryUserBalanceResponse
err error
)
if res, err = virtualPayment.QueryUserBalance(context.TODO(), &virtualPayment.QueryUserBalanceRequest{
OpenID: "xxx",
Env: virtualPayment.EnvProduction,
UserIP: "xxx",
}); err != nil {
panic(err)
}
``` ```

View File

@@ -10,11 +10,22 @@ import (
) )
const ( const (
// code2SessionURL 小程序登录
code2SessionURL = "https://api.weixin.qq.com/sns/jscode2session?appid=%s&secret=%s&js_code=%s&grant_type=authorization_code" code2SessionURL = "https://api.weixin.qq.com/sns/jscode2session?appid=%s&secret=%s&js_code=%s&grant_type=authorization_code"
// checkEncryptedDataURL 检查加密信息
checkEncryptedDataURL = "https://api.weixin.qq.com/wxa/business/checkencryptedmsg?access_token=%s" 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" getPhoneNumber = "https://api.weixin.qq.com/wxa/business/getuserphonenumber?access_token=%s"
// checkSessionURL 检验登录态
checkSessionURL = "https://api.weixin.qq.com/wxa/checksession?access_token=%s&signature=%s&openid=%s&sig_method=hmac_sha256"
// resetUserSessionKeyURL 重置登录态
resetUserSessionKeyURL = "https://api.weixin.qq.com/wxa/resetusersessionkey?access_token=%s&signature=%s&openid=%s&sig_method=hmac_sha256"
// getPluginOpenPIDURL 获取插件用户openPID
getPluginOpenPIDURL = "https://api.weixin.qq.com/wxa/getpluginopenpid?access_token=%s"
// getPaidUnionIDURL 支付后获取 UnionID
getPaidUnionIDURL = "https://api.weixin.qq.com/wxa/getpaidunionid"
// getUserEncryptKeyURL 获取用户encryptKey
getUserEncryptKeyURL = "https://api.weixin.qq.com/wxa/business/getuserencryptkey?access_token=%s&signature=%s&openid=%s&sig_method=hmac_sha256"
) )
// Auth 登录/用户信息 // Auth 登录/用户信息
@@ -40,8 +51,8 @@ type ResCode2Session struct {
type RspCheckEncryptedData struct { type RspCheckEncryptedData struct {
util.CommonError util.CommonError
Vaild bool `json:"vaild"` // 是否是合法的数据 Vaild bool `json:"vaild"` // 是否是合法的数据
CreateTime uint `json:"create_time"` // 加密数据生成的时间戳 CreateTime uint64 `json:"create_time"` // 加密数据生成的时间戳
} }
// Code2Session 登录凭证校验。 // Code2Session 登录凭证校验。
@@ -65,9 +76,45 @@ func (auth *Auth) Code2SessionContext(ctx context2.Context, jsCode string) (resu
return 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无需用户授权 // GetPaidUnionID 用户支付完成后,获取该用户的 UnionId无需用户授权
func (auth *Auth) GetPaidUnionID() { // see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-info/basic-info/getPaidUnionid.html
// TODO 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天生成的加密数据
@@ -81,7 +128,7 @@ func (auth *Auth) CheckEncryptedDataContext(ctx context2.Context, encryptedMsgHa
var ( var (
at string at string
) )
if at, err = auth.GetAccessToken(); err != nil { if at, err = auth.GetAccessTokenContext(ctx); err != nil {
return return
} }
@@ -120,7 +167,7 @@ func (auth *Auth) GetPhoneNumberContext(ctx context2.Context, code string) (*Get
at string at string
err error err error
) )
if at, err = auth.GetAccessToken(); err != nil { if at, err = auth.GetAccessTokenContext(ctx); err != nil {
return nil, err return nil, err
} }
body := map[string]interface{}{ body := map[string]interface{}{
@@ -138,13 +185,123 @@ func (auth *Auth) GetPhoneNumberContext(ctx context2.Context, code string) (*Get
} }
var result GetPhoneNumberResponse var result GetPhoneNumberResponse
if err = util.DecodeWithError(response, &result, "phonenumber.getPhoneNumber"); err != nil { err = util.DecodeWithError(response, &result, "phonenumber.getPhoneNumber")
return nil, err return &result, err
}
return &result, nil
} }
// GetPhoneNumber 小程序通过code获取用户手机号 // GetPhoneNumber 小程序通过code获取用户手机号
func (auth *Auth) GetPhoneNumber(code string) (*GetPhoneNumberResponse, error) { func (auth *Auth) GetPhoneNumber(code string) (*GetPhoneNumberResponse, error) {
return auth.GetPhoneNumberContext(context2.Background(), code) return auth.GetPhoneNumberContext(context2.Background(), code)
} }
// CheckSession 检验登录态
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-login/checkSessionKey.html
func (auth *Auth) CheckSession(signature, openID string) error {
var (
accessToken string
err error
)
if accessToken, err = auth.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(checkSessionURL, accessToken, signature, openID)); err != nil {
return err
}
return util.DecodeWithCommonError(response, "CheckSession")
}
// ResetUserSessionKeyResponse 重置登录态响应
type ResetUserSessionKeyResponse struct {
util.CommonError
OpenID string `json:"openid"`
SessionKey string `json:"session_key"`
}
// ResetUserSessionKey 重置登录态
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-login/ResetUserSessionKey.html
func (auth *Auth) ResetUserSessionKey(signature, openID string) (*ResetUserSessionKeyResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = auth.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(resetUserSessionKeyURL, accessToken, signature, openID)); err != nil {
return nil, err
}
result := &ResetUserSessionKeyResponse{}
err = util.DecodeWithError(response, result, "ResetUserSessionKey")
return result, err
}
type (
// GetPluginOpenPIDRequest 获取插件用户openPID请求
GetPluginOpenPIDRequest struct {
Code string `json:"code"`
}
// GetPluginOpenPIDResponse 获取插件用户openPID响应
GetPluginOpenPIDResponse struct {
util.CommonError
OpenPID string `json:"openpid"`
}
)
// GetPluginOpenPID 获取插件用户openPID
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-info/basic-info/getPluginOpenPId.html
func (auth *Auth) GetPluginOpenPID(code string) (string, error) {
var (
accessToken string
err error
)
if accessToken, err = auth.GetAccessToken(); err != nil {
return "", err
}
req := &GetPluginOpenPIDRequest{
Code: code,
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(getPluginOpenPIDURL, accessToken), req); err != nil {
return "", err
}
result := &GetPluginOpenPIDResponse{}
err = util.DecodeWithError(response, result, "GetPluginOpenPID")
return result.OpenPID, err
}
// GetUserEncryptKeyResponse 获取用户encryptKey响应
type GetUserEncryptKeyResponse struct {
util.CommonError
KeyInfoList []KeyInfo `json:"key_info_list"`
}
// KeyInfo 用户最近三次的加密key
type KeyInfo struct {
EncryptKey string `json:"encrypt_key"`
Version int64 `json:"version"`
ExpireIn int64 `json:"expire_in"`
Iv string `json:"iv"`
CreateTime int64 `json:"create_time"`
}
// GetUserEncryptKey 获取用户encryptKey
// see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-info/internet/getUserEncryptKey.html
func (auth *Auth) GetUserEncryptKey(signature, openID string) (*GetUserEncryptKeyResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = auth.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(getUserEncryptKeyURL, accessToken, signature, openID)); err != nil {
return nil, err
}
result := &GetUserEncryptKeyResponse{}
err = util.DecodeWithError(response, result, "GetUserEncryptKey")
return result, err
}

View File

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

View File

@@ -1,4 +1,4 @@
// Package config 小程序config配置 // Package config 小程序 config 配置
package config package config
import ( import (
@@ -7,7 +7,12 @@ import (
// Config .config for 小程序 // Config .config for 小程序
type Config struct { type Config struct {
AppID string `json:"app_id"` // appid AppID string `json:"app_id"` // appid
AppSecret string `json:"app_secret"` // appSecret AppSecret string `json:"app_secret"` // appSecret
Cache cache.Cache AppKey string `json:"app_key"` // appKey
OfferID string `json:"offer_id"` // offerId
Token string `json:"token"` // token
EncodingAESKey string `json:"encoding_aes_key"` // EncodingAESKey
Cache cache.Cache
UseStableAK bool // use the stable access_token
} }

View File

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

View File

@@ -20,6 +20,12 @@ const (
MsgTypeLink = "link" MsgTypeLink = "link"
// MsgTypeMiniProgramPage 小程序卡片 // MsgTypeMiniProgramPage 小程序卡片
MsgTypeMiniProgramPage = "miniprogrampage" MsgTypeMiniProgramPage = "miniprogrampage"
// MsgTypeEvent 事件
MsgTypeEvent MsgType = "event"
// DataTypeXML XML 格式数据
DataTypeXML = "xml"
// DataTypeJSON JSON 格式数据
DataTypeJSON = "json"
) )
// CommonToken 消息中通用的结构 // CommonToken 消息中通用的结构

View File

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

View File

@@ -0,0 +1,579 @@
package message
import (
"encoding/json"
"encoding/xml"
"errors"
"io"
"net/http"
"sort"
"strings"
"github.com/tidwall/gjson"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/miniprogram/security"
"github.com/silenceper/wechat/v2/util"
)
// ConfirmReceiveMethod 确认收货方式
type ConfirmReceiveMethod int8
const (
// EventTypeTradeManageRemindAccessAPI 提醒接入发货信息管理服务 API
// 小程序完成账期授权时/小程序产生第一笔交易时/已产生交易但从未发货的小程序,每天一次
EventTypeTradeManageRemindAccessAPI EventType = "trade_manage_remind_access_api"
// EventTypeTradeManageRemindShipping 提醒需要上传发货信息
// 曾经发过货的小程序,订单超过 48 小时未发货时
EventTypeTradeManageRemindShipping EventType = "trade_manage_remind_shipping"
// EventTypeTradeManageOrderSettlement 订单将要结算或已经结算
// 订单完成发货时/订单结算时
EventTypeTradeManageOrderSettlement EventType = "trade_manage_order_settlement"
// EventTypeAddExpressPath 运单轨迹更新事件
EventTypeAddExpressPath EventType = "add_express_path"
// EventTypeSecvodUpload 短剧媒资上传完成事件
EventTypeSecvodUpload EventType = "secvod_upload_event"
// EventTypeSecvodAudit 短剧媒资审核状态事件
EventTypeSecvodAudit EventType = "secvod_audit_event"
// EventTypeWxaMediaCheck 媒体内容安全异步审查结果通知
EventTypeWxaMediaCheck EventType = "wxa_media_check"
// EventTypeXpayGoodsDeliverNotify 道具发货推送事件
EventTypeXpayGoodsDeliverNotify EventType = "xpay_goods_deliver_notify"
// EventTypeXpayCoinPayNotify 代币支付推送事件
EventTypeXpayCoinPayNotify EventType = "xpay_coin_pay_notify"
// EventSubscribePopup 用户操作订阅通知弹窗事件推送,用户在图文等场景内订阅通知的操作
EventSubscribePopup EventType = "subscribe_msg_popup_event"
// EventSubscribeMsgChange 用户管理订阅通知,用户在服务通知管理页面做通知管理时的操作
EventSubscribeMsgChange EventType = "subscribe_msg_change_event"
// EventSubscribeMsgSent 发送订阅通知,调用 bizsend 接口发送通知
EventSubscribeMsgSent EventType = "subscribe_msg_sent_event"
// ConfirmReceiveMethodAuto 自动确认收货
ConfirmReceiveMethodAuto ConfirmReceiveMethod = 1
// ConfirmReceiveMethodManual 手动确认收货
ConfirmReceiveMethodManual ConfirmReceiveMethod = 2
)
const (
// InfoTypeAcceptSubscribeMessage 接受订阅通知
InfoTypeAcceptSubscribeMessage InfoType = "accept"
// InfoTypeRejectSubscribeMessage 拒绝订阅通知
InfoTypeRejectSubscribeMessage InfoType = "reject"
)
// PushReceiver 接收消息推送
// 暂仅支付 Aes 加密方式
type PushReceiver struct {
*context.Context
}
// NewPushReceiver 实例化
func NewPushReceiver(ctx *context.Context) *PushReceiver {
return &PushReceiver{
Context: ctx,
}
}
// GetMsg 获取接收到的消息 (如果是加密的返回解密数据)
func (receiver *PushReceiver) GetMsg(r *http.Request) (string, []byte, error) {
// 判断请求格式
var dataType string
contentType := r.Header.Get("Content-Type")
if strings.HasPrefix(contentType, "text/xml") {
// xml 格式
dataType = DataTypeXML
} else {
// json 格式
dataType = DataTypeJSON
}
// 读取参数,验证签名
signature := r.FormValue("signature")
timestamp := r.FormValue("timestamp")
nonce := r.FormValue("nonce")
encryptType := r.FormValue("encrypt_type")
// 验证签名
tmpArr := []string{
receiver.Token,
timestamp,
nonce,
}
sort.Strings(tmpArr)
tmpSignature := util.Signature(tmpArr...)
if tmpSignature != signature {
return dataType, nil, errors.New("signature error")
}
if encryptType == "aes" {
// 解密
var reqData DataReceived
if dataType == DataTypeXML {
if err := xml.NewDecoder(r.Body).Decode(&reqData); err != nil {
return dataType, nil, err
}
} else {
if err := json.NewDecoder(r.Body).Decode(&reqData); err != nil {
return dataType, nil, err
}
}
_, rawMsgBytes, err := util.DecryptMsg(receiver.AppID, reqData.Encrypt, receiver.EncodingAESKey)
return dataType, rawMsgBytes, err
}
// 不加密
byteData, err := io.ReadAll(r.Body)
return dataType, byteData, err
}
// GetMsgData 获取接收到的消息 (解密数据)
func (receiver *PushReceiver) GetMsgData(r *http.Request) (MsgType, EventType, PushData, error) {
dataType, decryptMsg, err := receiver.GetMsg(r)
if err != nil {
return "", "", nil, err
}
var (
msgType MsgType
eventType EventType
)
if dataType == DataTypeXML {
var commonToken CommonPushData
if err := xml.Unmarshal(decryptMsg, &commonToken); err != nil {
return "", "", nil, err
}
msgType, eventType = commonToken.MsgType, commonToken.Event
} else {
var commonToken CommonPushData
if err := json.Unmarshal(decryptMsg, &commonToken); err != nil {
return "", "", nil, err
}
msgType, eventType = commonToken.MsgType, commonToken.Event
}
if msgType == MsgTypeEvent {
pushData, err := receiver.getEvent(dataType, eventType, decryptMsg)
// 暂不支持其他事件类型
return msgType, eventType, pushData, err
}
// 暂不支持其他消息类型
return msgType, eventType, decryptMsg, nil
}
// getEvent 获取事件推送的数据
func (receiver *PushReceiver) getEvent(dataType string, eventType EventType, decryptMsg []byte) (PushData, error) {
switch eventType {
case EventTypeTradeManageRemindAccessAPI:
// 提醒接入发货信息管理服务 API
var pushData PushDataRemindAccessAPI
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventTypeTradeManageRemindShipping:
// 提醒需要上传发货信息
var pushData PushDataRemindShipping
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventTypeTradeManageOrderSettlement:
// 订单将要结算或已经结算
var pushData PushDataOrderSettlement
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventTypeWxaMediaCheck:
// 媒体内容安全异步审查结果通知
var pushData MediaCheckAsyncData
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventTypeAddExpressPath:
// 运单轨迹更新
var pushData PushDataAddExpressPath
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventTypeSecvodUpload:
// 短剧媒资上传完成
var pushData PushDataSecVodUpload
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventTypeSecvodAudit:
// 短剧媒资审核状态
var pushData PushDataSecVodAudit
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventTypeXpayGoodsDeliverNotify:
// 道具发货推送事件
var pushData PushDataXpayGoodsDeliverNotify
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventTypeXpayCoinPayNotify:
// 代币支付推送事件
var pushData PushDataXpayCoinPayNotify
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
return &pushData, err
case EventSubscribePopup:
// 用户操作订阅通知弹窗事件推送
return receiver.unmarshalSubscribePopup(dataType, decryptMsg)
case EventSubscribeMsgChange:
// 用户管理订阅通知事件推送
return receiver.unmarshalSubscribeMsgChange(dataType, decryptMsg)
case EventSubscribeMsgSent:
// 用户发送订阅通知事件推送
return receiver.unmarshalSubscribeMsgSent(dataType, decryptMsg)
}
// 暂不支持其他事件类型,直接返回解密后的数据,由调用方处理
return decryptMsg, nil
}
// unmarshal 解析推送的数据
func (receiver *PushReceiver) unmarshal(dataType string, decryptMsg []byte, pushData interface{}) error {
if dataType == DataTypeXML {
return xml.Unmarshal(decryptMsg, pushData)
}
return json.Unmarshal(decryptMsg, pushData)
}
// unmarshalSubscribePopup
func (receiver *PushReceiver) unmarshalSubscribePopup(dataType string, decryptMsg []byte) (PushData, error) {
var pushData PushDataSubscribePopup
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
if err == nil {
listData := gjson.Get(string(decryptMsg), "List")
if listData.IsObject() {
listItem := SubscribeMsgPopupEventList{}
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItem); parseErr != nil {
return &pushData, parseErr
}
pushData.SetSubscribeMsgPopupEvents([]SubscribeMsgPopupEventList{listItem})
} else if listData.IsArray() {
listItems := make([]SubscribeMsgPopupEventList, 0)
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItems); parseErr != nil {
return &pushData, parseErr
}
pushData.SetSubscribeMsgPopupEvents(listItems)
}
}
return &pushData, err
}
// unmarshalSubscribeMsgChange 解析用户管理订阅通知事件推送
func (receiver *PushReceiver) unmarshalSubscribeMsgChange(dataType string, decryptMsg []byte) (PushData, error) {
var pushData PushDataSubscribeMsgChange
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
if err == nil {
listData := gjson.Get(string(decryptMsg), "List")
if listData.IsObject() {
listItem := SubscribeMsgChangeList{}
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItem); parseErr != nil {
return &pushData, parseErr
}
pushData.SetSubscribeMsgChangeEvents([]SubscribeMsgChangeList{listItem})
} else if listData.IsArray() {
listItems := make([]SubscribeMsgChangeList, 0)
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItems); parseErr != nil {
return &pushData, parseErr
}
pushData.SetSubscribeMsgChangeEvents(listItems)
}
}
return &pushData, err
}
// unmarshalSubscribeMsgSent 解析用户发送订阅通知事件推送
func (receiver *PushReceiver) unmarshalSubscribeMsgSent(dataType string, decryptMsg []byte) (PushData, error) {
var pushData PushDataSubscribeMsgSent
err := receiver.unmarshal(dataType, decryptMsg, &pushData)
if err == nil {
listData := gjson.Get(string(decryptMsg), "List")
if listData.IsObject() {
listItem := SubscribeMsgSentList{}
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItem); parseErr != nil {
return &pushData, parseErr
}
pushData.SetSubscribeMsgSentEvents([]SubscribeMsgSentList{listItem})
} else if listData.IsArray() {
listItems := make([]SubscribeMsgSentList, 0)
if parseErr := json.Unmarshal([]byte(listData.Raw), &listItems); parseErr != nil {
return &pushData, parseErr
}
pushData.SetSubscribeMsgSentEvents(listItems)
}
}
return &pushData, err
}
// DataReceived 接收到的数据
type DataReceived struct {
Encrypt string `json:"Encrypt" xml:"Encrypt"` // 加密的消息体
}
// PushData 推送的数据 (已转对应的结构体)
type PushData interface{}
// CommonPushData 推送数据通用部分
type CommonPushData struct {
XMLName xml.Name `json:"-" xml:"xml"`
MsgType MsgType `json:"MsgType" xml:"MsgType"` // 消息类型,为固定值 "event"
Event EventType `json:"Event" xml:"Event"` // 事件类型
ToUserName string `json:"ToUserName" xml:"ToUserName"` // 小程序的原始 ID
FromUserName string `json:"FromUserName" xml:"FromUserName"` // 发送方账号(一个 OpenID此时发送方是系统账号
CreateTime int64 `json:"CreateTime" xml:"CreateTime"` // 消息创建时间(整型),时间戳
}
// MediaCheckAsyncData 媒体内容安全异步审查结果通知
type MediaCheckAsyncData struct {
CommonPushData
Appid string `json:"appid" xml:"appid"`
TraceID string `json:"trace_id" xml:"trace_id"`
Version int `json:"version" xml:"version"`
Detail []*MediaCheckDetail `json:"detail" xml:"detail"`
Errcode int `json:"errcode" xml:"errcode"`
Errmsg string `json:"errmsg" xml:"errmsg"`
Result MediaCheckAsyncResult `json:"result" xml:"result"`
}
// MediaCheckDetail 检测结果详情
type MediaCheckDetail struct {
Strategy string `json:"strategy" xml:"strategy"`
Errcode int `json:"errcode" xml:"errcode"`
Suggest security.CheckSuggest `json:"suggest" xml:"suggest"`
Label int `json:"label" xml:"label"`
Prob int `json:"prob" xml:"prob"`
}
// MediaCheckAsyncResult 检测结果
type MediaCheckAsyncResult struct {
Suggest security.CheckSuggest `json:"suggest" xml:"suggest"`
Label security.CheckLabel `json:"label" xml:"label"`
}
// PushDataOrderSettlement 订单将要结算或已经结算通知
type PushDataOrderSettlement struct {
CommonPushData
TransactionID string `json:"transaction_id" xml:"transaction_id"` // 支付订单号
MerchantID string `json:"merchant_id" xml:"merchant_id"` // 商户号
SubMerchantID string `json:"sub_merchant_id" xml:"sub_merchant_id"` // 子商户号
MerchantTradeNo string `json:"merchant_trade_no" xml:"merchant_trade_no"` // 商户订单号
PayTime int64 `json:"pay_time" xml:"pay_time"` // 支付成功时间,秒级时间戳
ShippedTime int64 `json:"shipped_time" xml:"shipped_time"` // 发货时间,秒级时间戳
EstimatedSettlementTime int64 `json:"estimated_settlement_time" xml:"estimated_settlement_time"` // 预计结算时间,秒级时间戳。发货时推送才有该字段
ConfirmReceiveMethod ConfirmReceiveMethod `json:"confirm_receive_method" xml:"confirm_receive_method"` // 确认收货方式1. 自动确认收货2. 手动确认收货。结算时推送才有该字段
ConfirmReceiveTime int64 `json:"confirm_receive_time" xml:"confirm_receive_time"` // 确认收货时间,秒级时间戳。结算时推送才有该字段
SettlementTime int64 `json:"settlement_time" xml:"settlement_time"` // 订单结算时间,秒级时间戳。结算时推送才有该字段
}
// PushDataRemindShipping 提醒需要上传发货信息
type PushDataRemindShipping struct {
CommonPushData
TransactionID string `json:"transaction_id" xml:"transaction_id"` // 微信支付订单号
MerchantID string `json:"merchant_id" xml:"merchant_id"` // 商户号
SubMerchantID string `json:"sub_merchant_id" xml:"sub_merchant_id"` // 子商户号
MerchantTradeNo string `json:"merchant_trade_no" xml:"merchant_trade_no"` // 商户订单号
PayTime int64 `json:"pay_time" xml:"pay_time"` // 支付成功时间,秒级时间戳
Msg string `json:"msg" xml:"msg"` // 消息文本内容
}
// PushDataRemindAccessAPI 提醒接入发货信息管理服务 API 信息
type PushDataRemindAccessAPI struct {
CommonPushData
Msg string `json:"msg" xml:"msg"` // 消息文本内容
}
// PushDataAddExpressPath 运单轨迹更新信息
type PushDataAddExpressPath struct {
CommonPushData
DeliveryID string `json:"DeliveryID" xml:"DeliveryID"` // 快递公司 ID
WayBillID string `json:"WaybillId" xml:"WaybillId"` // 运单 ID
OrderID string `json:"OrderId" xml:"OrderId"` // 订单 ID
Version int `json:"Version" xml:"Version"` // 轨迹版本号(整型)
Count int `json:"Count" xml:"Count"` // 轨迹节点数(整型)
Actions []*PushDataAddExpressPathAction `json:"Actions" xml:"Actions"` // 轨迹节点列表
}
// PushDataAddExpressPathAction 轨迹节点
type PushDataAddExpressPathAction struct {
ActionTime int64 `json:"ActionTime" xml:"ActionTime"` // 轨迹节点 Unix 时间戳
ActionType int `json:"ActionType" xml:"ActionType"` // 轨迹节点类型
ActionMsg string `json:"ActionMsg" xml:"ActionMsg"` // 轨迹节点详情
}
// PushDataSecVodUpload 短剧媒资上传完成
type PushDataSecVodUpload struct {
CommonPushData
UploadEvent SecVodUploadEvent `json:"upload_event" xml:"upload_event"` // 上传完成事件
}
// SecVodUploadEvent 短剧媒资上传完成事件
type SecVodUploadEvent struct {
MediaID int64 `json:"media_id" xml:"media_id"` // 媒资 id
SourceContext string `json:"source_context" xml:"source_context"` // 透传上传接口中开发者设置的值。
ErrCode int `json:"errcode" xml:"errcode"` // 错误码,上传失败时该值非
ErrMsg string `json:"errmsg" xml:"errmsg"` // 错误提示
}
// PushDataSecVodAudit 短剧媒资审核状态
type PushDataSecVodAudit struct {
CommonPushData
AuditEvent SecVodAuditEvent `json:"audit_event" xml:"audit_event"` // 审核状态事件
}
// SecVodAuditEvent 短剧媒资审核状态事件
type SecVodAuditEvent struct {
DramaID int64 `json:"drama_id" xml:"drama_id"` // 剧目 id
SourceContext string `json:"source_context" xml:"source_context"` // 透传上传接口中开发者设置的值
AuditDetail DramaAuditDetail `json:"audit_detail" xml:"audit_detail"` // 剧目审核结果,单独每一集的审核结果可以根据 drama_id 查询剧集详情得到
}
// DramaAuditDetail 剧目审核结果
type DramaAuditDetail struct {
Status int `json:"status" xml:"status"` // 审核状态0 为无效值1 为审核中2 为最终失败3 为审核通过4 为驳回重填
CreateTime int64 `json:"create_time" xml:"create_time"` // 提审时间戳
AuditTime int64 `json:"audit_time" xml:"audit_time"` // 审核时间戳
}
// PushDataXpayGoodsDeliverNotify 道具发货推送
type PushDataXpayGoodsDeliverNotify struct {
CommonPushData
OpenID string `json:"OpenId" xml:"OpenId"` // 用户 openid
OutTradeNo string `json:"OutTradeNo" xml:"OutTradeNo"` // 业务订单号
Env int `json:"Env" xml:"Env"` // ,环境配置 0现网环境也叫正式环境1沙箱环境
WeChatPayInfo WeChatPayInfo `json:"WeChatPayInfo" xml:"WeChatPayInfo"` // 微信支付信息 非微信支付渠道可能没有
GoodsInfo GoodsInfo `json:"GoodsInfo" xml:"GoodsInfo"` // 道具参数信息
}
// WeChatPayInfo 微信支付信息
type WeChatPayInfo struct {
MchOrderNo string `json:"MchOrderNo" xml:"MchOrderNo"` // 微信支付商户单号
TransactionID string `json:"TransactionId" xml:"TransactionId"` // 交易单号(微信支付订单号)
PaidTime int64 `json:"PaidTime" xml:"PaidTime"` // 用户支付时间Linux 秒级时间戳
}
// GoodsInfo 道具参数信息
type GoodsInfo struct {
ProductID string `json:"ProductId" xml:"ProductId"` // 道具 ID
Quantity int `json:"Quantity" xml:"Quantity"` // 数量
OrigPrice int64 `json:"OrigPrice" xml:"OrigPrice"` // 物品原始价格(单位:分)
ActualPrice int64 `json:"ActualPrice" xml:"ActualPrice"` // 物品实际支付价格(单位:分)
Attach string `json:"Attach" xml:"Attach"` // 透传信息
}
// PushDataXpayCoinPayNotify 代币支付推送
type PushDataXpayCoinPayNotify struct {
CommonPushData
OpenID string `json:"OpenId" xml:"OpenId"` // 用户 openid
OutTradeNo string `json:"OutTradeNo" xml:"OutTradeNo"` // 业务订单号
Env int `json:"Env" xml:"Env"` // ,环境配置 0现网环境也叫正式环境1沙箱环境
WeChatPayInfo WeChatPayInfo `json:"WeChatPayInfo" xml:"WeChatPayInfo"` // 微信支付信息 非微信支付渠道可能没有
CoinInfo CoinInfo `json:"CoinInfo" xml:"CoinInfo"` // 代币参数信息
}
// CoinInfo 代币参数信息
type CoinInfo struct {
Quantity int `json:"Quantity" xml:"Quantity"` // 数量
OrigPrice int64 `json:"OrigPrice" xml:"OrigPrice"` // 物品原始价格(单位:分)
ActualPrice int64 `json:"ActualPrice" xml:"ActualPrice"` // 物品实际支付价格(单位:分)
Attach string `json:"Attach" xml:"Attach"` // 透传信息
}
// PushDataSubscribePopup 用户操作订阅通知弹窗事件推送
type PushDataSubscribePopup struct {
CommonPushData
subscribeMsgPopupEventList []SubscribeMsgPopupEventList `json:"-"`
SubscribeMsgPopupEvent SubscribeMsgPopupEvent `xml:"SubscribeMsgPopupEvent"`
}
// SubscribeMsgPopupEvent 用户操作订阅通知弹窗消息回调
type SubscribeMsgPopupEvent struct {
List []SubscribeMsgPopupEventList `xml:"List"`
}
// SubscribeMsgPopupEventList 订阅消息事件列表
type SubscribeMsgPopupEventList struct {
TemplateID string `xml:"TemplateId" json:"TemplateId"`
SubscribeStatusString string `xml:"SubscribeStatusString" json:"SubscribeStatusString"`
PopupScene string `xml:"PopupScene" json:"PopupScene"`
}
// SetSubscribeMsgPopupEvents 设置订阅消息事件
func (s *PushDataSubscribePopup) SetSubscribeMsgPopupEvents(list []SubscribeMsgPopupEventList) {
s.subscribeMsgPopupEventList = list
}
// GetSubscribeMsgPopupEvents 获取订阅消息事件数据
func (s *PushDataSubscribePopup) GetSubscribeMsgPopupEvents() []SubscribeMsgPopupEventList {
if s.subscribeMsgPopupEventList != nil {
return s.subscribeMsgPopupEventList
}
if s.SubscribeMsgPopupEvent.List == nil || len(s.SubscribeMsgPopupEvent.List) < 1 {
return nil
}
return s.SubscribeMsgPopupEvent.List
}
// PushDataSubscribeMsgChange 用户管理订阅通知事件推送
type PushDataSubscribeMsgChange struct {
CommonPushData
SubscribeMsgChangeEvent SubscribeMsgChangeEvent `xml:"SubscribeMsgChangeEvent"`
subscribeMsgChangeList []SubscribeMsgChangeList `json:"-"`
}
// SubscribeMsgChangeEvent 用户管理订阅通知回调
type SubscribeMsgChangeEvent struct {
List []SubscribeMsgChangeList `xml:"List" json:"List"`
}
// SubscribeMsgChangeList 订阅消息事件列表
type SubscribeMsgChangeList struct {
TemplateID string `xml:"TemplateId" json:"TemplateId"`
SubscribeStatusString string `xml:"SubscribeStatusString" json:"SubscribeStatusString"`
}
// SetSubscribeMsgChangeEvents 设置订阅消息事件
func (s *PushDataSubscribeMsgChange) SetSubscribeMsgChangeEvents(list []SubscribeMsgChangeList) {
s.subscribeMsgChangeList = list
}
// GetSubscribeMsgChangeEvents 获取订阅消息事件数据
func (s *PushDataSubscribeMsgChange) GetSubscribeMsgChangeEvents() []SubscribeMsgChangeList {
if s.subscribeMsgChangeList != nil {
return s.subscribeMsgChangeList
}
if s.SubscribeMsgChangeEvent.List == nil || len(s.SubscribeMsgChangeEvent.List) < 1 {
return nil
}
return s.SubscribeMsgChangeEvent.List
}
// PushDataSubscribeMsgSent 用户发送订阅通知事件推送
type PushDataSubscribeMsgSent struct {
CommonPushData
SubscribeMsgSentEvent SubscribeMsgSentEvent `xml:"SubscribeMsgSentEvent"`
subscribeMsgSentEventList []SubscribeMsgSentList `json:"-"`
}
// SubscribeMsgSentEvent 用户发送订阅通知回调
type SubscribeMsgSentEvent struct {
List []SubscribeMsgSentList `xml:"List" json:"List"`
}
// SubscribeMsgSentList 订阅消息事件列表
type SubscribeMsgSentList struct {
TemplateID string `xml:"TemplateId" json:"TemplateId"`
MsgID string `xml:"MsgID" json:"MsgID"`
ErrorCode int `xml:"ErrorCode" json:"ErrorCode"`
ErrorStatus string `xml:"ErrorStatus" json:"ErrorStatus"`
}
// SetSubscribeMsgSentEvents 设置订阅消息事件
func (s *PushDataSubscribeMsgSent) SetSubscribeMsgSentEvents(list []SubscribeMsgSentList) {
s.subscribeMsgSentEventList = list
}
// GetSubscribeMsgSentEvents 获取订阅消息事件数据
func (s *PushDataSubscribeMsgSent) GetSubscribeMsgSentEvents() []SubscribeMsgSentList {
if s.subscribeMsgSentEventList != nil {
return s.subscribeMsgSentEventList
}
if s.SubscribeMsgSentEvent.List == nil || len(s.SubscribeMsgSentEvent.List) < 1 {
return nil
}
return s.SubscribeMsgSentEvent.List
}

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,102 @@
package message
import (
"fmt"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/util"
)
const (
// createActivityURL 创建activity_id
createActivityURL = "https://api.weixin.qq.com/cgi-bin/message/wxopen/activityid/create?access_token=%s"
// SendUpdatableMsgURL 修改动态消息
setUpdatableMsgURL = "https://api.weixin.qq.com/cgi-bin/message/wxopen/updatablemsg/send?access_token=%s"
)
// UpdatableTargetState 动态消息状态
type UpdatableTargetState int
const (
// TargetStateNotStarted 未开始
TargetStateNotStarted UpdatableTargetState = 0
// TargetStateStarted 已开始
TargetStateStarted UpdatableTargetState = 1
// TargetStateFinished 已结束
TargetStateFinished UpdatableTargetState = 2
)
// UpdatableMessage 动态消息
type UpdatableMessage struct {
*context.Context
}
// NewUpdatableMessage 实例化
func NewUpdatableMessage(ctx *context.Context) *UpdatableMessage {
return &UpdatableMessage{
Context: ctx,
}
}
// CreateActivityID 创建activity_id
func (updatableMessage *UpdatableMessage) CreateActivityID() (res CreateActivityIDResponse, err error) {
accessToken, err := updatableMessage.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(createActivityURL, accessToken)
response, err := util.HTTPGet(uri)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "CreateActivityID")
return
}
// SetUpdatableMsg 修改动态消息
func (updatableMessage *UpdatableMessage) SetUpdatableMsg(activityID string, targetState UpdatableTargetState, template UpdatableMsgTemplate) (err error) {
accessToken, err := updatableMessage.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(setUpdatableMsgURL, accessToken)
data := SendUpdatableMsgReq{
ActivityID: activityID,
TargetState: targetState,
TemplateInfo: template,
}
response, err := util.PostJSON(uri, data)
if err != nil {
return
}
return util.DecodeWithCommonError(response, "SendUpdatableMsg")
}
// CreateActivityIDResponse 创建activity_id 返回
type CreateActivityIDResponse struct {
util.CommonError
ActivityID string `json:"activity_id"`
ExpirationTime int64 `json:"expiration_time"`
}
// UpdatableMsgTemplate 动态消息模板
type UpdatableMsgTemplate struct {
ParameterList []UpdatableMsgParameter `json:"parameter_list"`
}
// UpdatableMsgParameter 动态消息参数
type UpdatableMsgParameter struct {
Name string `json:"name"`
Value string `json:"value"`
}
// SendUpdatableMsgReq 修改动态消息参数
type SendUpdatableMsgReq struct {
ActivityID string `json:"activity_id"`
TemplateInfo UpdatableMsgTemplate `json:"template_info"`
TargetState UpdatableTargetState `json:"target_state"`
}

View File

@@ -0,0 +1,100 @@
/*
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* You can obtain one at https://github.com/silenceper/wechat.
*
*/
package minidrama
const (
// Success 错误码 0、成功
Success ErrCode = 0
// SystemError 错误码 -1、系统错误
SystemError ErrCode = -1
// InitError 错误码 -2 初始化未完成,请稍后再试
InitError ErrCode = -2
// FormatError 错误码 47001 输入格式错误
FormatError ErrCode = 47001
// ParamError 错误码 47003 参数不符合要求
ParamError ErrCode = 47003
// PostError 错误码 44002 POST 内容为空
PostError ErrCode = 44002
// MethodError 错误码 43002 HTTP 请求必须使用 POST 方法
MethodError ErrCode = 43002
// VideoTypeError 错误码 10090001 视频类型不支持
VideoTypeError ErrCode = 10090001
// ImageTypeError 错误码 10090002 图片类型不支持
ImageTypeError ErrCode = 10090002
// ImageURLError 错误码 10090003 图片 URL 无效
ImageURLError ErrCode = 10090003
// ResourceType 错误码 10090005 resource_type 无效
ResourceType ErrCode = 10090005
// OperationError 错误码 10093011 操作失败
OperationError ErrCode = 10093011
// ParamError2 错误码 10093014 参数错误(包括参数格式、类型等错误)
ParamError2 ErrCode = 10093014
// OperationFrequentError 错误码 10093023 操作过于频繁
OperationFrequentError ErrCode = 10093023
// ResourceNotExistError 错误码 10093030 资源不存在
ResourceNotExistError ErrCode = 10093030
)
const (
// singleFileUpload 单个文件上传,上传媒体(和封面)文件,上传小文件(小于 10MB时使用。上传大文件请使用分片上传接口。
singleFileUpload = "https://api.weixin.qq.com/wxa/sec/vod/singlefileupload?access_token="
// pullUpload 拉取上传,该接口用于将一个网络上的视频拉取上传到平台。
pullUpload = "https://api.weixin.qq.com/wxa/sec/vod/pullupload?access_token="
// getTask 查询任务,该接口用于查询拉取上传的任务状态。
getTask = "https://api.weixin.qq.com/wxa/sec/vod/gettask?access_token="
// applyUpload 申请分片上传
applyUpload = "https://api.weixin.qq.com/wxa/sec/vod/applyupload?access_token="
// uploadPart 上传分片
uploadPart = "https://api.weixin.qq.com/wxa/sec/vod/uploadpart?access_token="
// commitUpload 确认上传,该接口用于完成整个分片上传流程,合并所有文件分片,确认媒体文件(和封面图片文件)上传到平台的结果,返回文件的 ID。请求中需要给出每一个分片的 part_number 和 etag用来校验分片的准确性。
commitUpload = "https://api.weixin.qq.com/wxa/sec/vod/commitupload?access_token="
// listMedia 获取媒体列表
listMedia = "https://api.weixin.qq.com/wxa/sec/vod/listmedia?access_token="
// getMedia 获取媒资详细信息,该接口用于获取已上传到平台的指定媒资信息,用于开发者后台管理使用。用于给用户客户端播放的链接应该使用 getmedialink 接口获取。
getMedia = "https://api.weixin.qq.com/wxa/sec/vod/getmedia?access_token="
// getMediaLink 获取媒资播放链接,该接口用于获取视频临时播放链接,用于给用户的播放使用。只有审核通过的视频才能通过该接口获取播放链接。
getMediaLink = "https://api.weixin.qq.com/wxa/sec/vod/getmedialink?access_token="
// deleteMedia 删除媒体,该接口用于删除指定媒资。
deleteMedia = "https://api.weixin.qq.com/wxa/sec/vod/deletemedia?access_token="
// auditDrama 审核剧本
auditDrama = "https://api.weixin.qq.com/wxa/sec/vod/auditdrama?access_token="
// listDramas 获取剧目列表
listDramas = "https://api.weixin.qq.com/wxa/sec/vod/listdramas?access_token="
// getDrama 获取剧目信息,该接口用于查询已提交的剧目。
getDrama = "https://api.weixin.qq.com/wxa/sec/vod/getdrama?access_token="
// getCdnUsageData 查询 CDN 用量数据,该接口用于查询点播 CDN 的流量数据。
getCdnUsageData = "https://api.weixin.qq.com/wxa/sec/vod/getcdnusagedata?access_token="
// getCdnLogs 查询 CDN 日志,该接口用于查询点播 CDN 的日志。
getCdnLogs = "https://api.weixin.qq.com/wxa/sec/vod/getcdnlogs?access_token="
)

View File

@@ -0,0 +1,32 @@
/*
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* You can obtain one at https://github.com/silenceper/wechat.
*
*/
// Package minidrama Mini Program entertainment mini-drama related interface
package minidrama
import (
"github.com/silenceper/wechat/v2/miniprogram/context"
)
// NewMiniDrama 实例化小程序娱乐直播 API
func NewMiniDrama(ctx *context.Context) *MiniDrama {
return &MiniDrama{
ctx: ctx,
}
}

View File

@@ -0,0 +1,440 @@
/*
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* You can obtain one at https://github.com/silenceper/wechat.
*
*/
package minidrama
import (
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/util"
)
// MiniDrama mini program entertainment live broadcast related
type MiniDrama struct {
ctx *context.Context
}
// ErrCode error code
type ErrCode int
// SingleFileUploadRequest 单文件上传请求
// Content-Type 需要指定为 multipart/form-data; boundary=<delimiter>
// <箭头括号> 表示必须替换为有效值的变量。
// 不填写 cover_typecover_data 字段时默认截取视频首帧作为视频封面。
type SingleFileUploadRequest struct {
MediaName string `json:"media_name"` // 媒体文件名称 文件名,需按照“剧目名 - 对应剧集数”格式命名文件,示例值:"我的演艺 - 第 1 集"。
MediaType string `json:"media_type"` // 媒体文件类型 视频格式支持MP4TSMOVMXFMPGFLVWMVAVIM4VF4VMPEG3GPASFMKV示例值"MP4"。
MediaData []byte `json:"media_data"` // 媒体文件数据 视频文件内容,二进制。
CoverType string `json:"cover_type,omitempty"` // 视频封面图片格式支持JPG、JPEG、PNG、BMP、TIFF、AI、CDR、EPS、TIF示例值"JPG"。
CoverData []byte `json:"cover_data,omitempty"` // 视频封面图片内容,二进制。
SourceContext string `json:"source_context,omitempty"` // 来源上下文,会在上传完成事件中透传给开发者。
}
// SingleFileUploadResponse 单文件上传响应
type SingleFileUploadResponse struct {
util.CommonError
MediaID int64 `json:"media_id"` // 媒体文件唯一标识,用于发布视频。
}
// PullUploadRequest 拉取上传请求
// 不填写 cover_url 字段时默认截取视频首帧作为封面。
// Content-Type 需要指定为 application/json
// 该接口为异步接口,上传完成会推送上传完成事件到开发者服务器,开发者也可以调用"查询任务"接口来轮询上传结果。
type PullUploadRequest struct {
MediaName string `json:"media_name"` // 媒体文件名称 文件名,需按照“剧目名 - 对应剧集数”格式命名文件,示例值:"我的演艺 - 第 1 集"。
MediaURL string `json:"media_url"` // 视频 URL示例值"https://developers.weixin.qq.com/test.mp4"。
CoverURL string `json:"cover_url,omitempty"` // 视频封面 URL示例值"https://developers.weixin.qq.com/test.jpg"。
SourceContext string `json:"source_context,omitempty"` // 来源上下文,会在上传完成事件中透传给开发者。
}
// PullUploadResponse 拉取上传响应
type PullUploadResponse struct {
util.CommonError
TaskID int64 `json:"task_id"` // 任务 ID用于查询拉取上传任务的结果。
}
// GetTaskRequest 查询任务请求
// 该接口用于查询拉取上传的任务状态。
// Content-Type 需要指定为 application/json。
type GetTaskRequest struct {
TaskID int64 `json:"task_id"` // 任务 ID用于查询拉取上传任务的结果。
}
// GetTaskResponse 查询任务响应
type GetTaskResponse struct {
util.CommonError
TaskInfo TaskInfo `json:"task_info"` // 任务信息。
}
// TaskInfo 任务信息
type TaskInfo struct {
ID int64 `json:"id"` // 任务 ID。
TaskType int `json:"task_type"` // 任务类型1拉取上传任务。
Status int `json:"status"` // 任务状态枚举值1. 等待中2. 正在处理3. 已完成4. 失败。
ErrCode int `json:"errcode"` // 任务错误码0 表示成功,其它表示失败。
ErrMsg string `json:"errmsg"` // 任务错误原因。
CreateTime int64 `json:"create_time"` // 任务创建时间,时间戳,单位:秒。
FinishTime int64 `json:"finish_time"` // 任务完成时间,时间戳,单位:秒。
MediaID int64 `json:"media_id"` // 媒体文件唯一标识,用于发布视频。
}
// ApplyUploadRequest 申请上传请求
// 上传大文件时需使用分片上传方式,分为 3 个步骤:
//
// 申请分片上传,确定文件名、格式类型,返回 upload_id唯一标识本次分片上传。
// 上传分片,多次调用上传文件分片,需要携带 part_number 和 upload_id其中 part_number 为分片的编号,支持乱序上传。当传入 part_number 和 upload_id 都相同的时候,后发起上传请求的分片将覆盖之前的分片。
// 确认分片上传,当上传完所有分片后,需要完成整个文件的合并。请求体中需要给出每一个分片的 part_number 和 etag用来校验分片的准确性最后返回文件的 media_id。
// 如果填写了 cover_type表明本次分片上传除上传媒体文件外还需要上传封面图片不填写 cover_type 则默认截取视频首帧作为封面。
// Content-Type 需要指定为 application/json。
type ApplyUploadRequest struct {
MediaName string `json:"media_name"` // 媒体文件名称 文件名,需按照“剧目名 - 对应剧集数”格式命名文件,示例值:"我的演艺 - 第 1 集"。
MediaType string `json:"media_type"` // 媒体文件类型 视频格式支持MP4TSMOVMXFMPGFLVWMVAVIM4VF4VMPEG3GPASFMKV示例值"MP4"。
CoverType string `json:"cover_type,omitempty"` // 视频封面图片格式支持JPG、JPEG、PNG、BMP、TIFF、AI、CDR、EPS、TIF示例值"JPG"。
SourceContext string `json:"source_context,omitempty"` // 来源上下文,会在上传完成事件中透传给开发者。
}
// ApplyUploadResponse 申请上传响应
type ApplyUploadResponse struct {
util.CommonError
UploadID string `json:"upload_id"` // 本次分片上传的唯一标识。
}
// UploadPartRequest 上传分片请求
// 将文件的其中一个分片上传到平台,最多支持 100 个分片,每个分片大小为 5MB最后一个分片可以小于 5MB。该接口适用于视频和封面图片。视频最大支持 500MB封面图片最大支持 10MB。
// 调用该接口之前必须先调用申请分片上传接口。
// 在申请分片上传时,如果不填写 cover_type则默认截取视频首帧作为封面。
// Content-Type 需要指定为 multipart/form-data; boundary=<delimiter><箭头括号>表示必须替换为有效值的变量。
// part_number 从 1 开始。如除了上传视频外还需要上传封面图片,则封面图片的 part_number 需重新从 1 开始编号。
type UploadPartRequest struct {
UploadID string `json:"upload_id"` // 一次分片上传的唯一标识,由申请分片上传接口返回。
PartNumber int `json:"part_number"` // 本次上传的分片的编号,范围在 1 - 100。
ResourceType int `json:"resource_type"` // 指定该分片属于视频还是封面图片的枚举值1. 视频2. 封面图片。
Data []byte `json:"data"` // 分片内容,二进制。
}
// UploadPartResponse 上传分片响应
type UploadPartResponse struct {
util.CommonError
ETag string `json:"etag"` // 上传分片成功后返回的分片标识,用于后续确认分片上传接口。
}
// CommitUploadRequest 确认分片上传请求
// 该接口用于完成整个分片上传流程,合并所有文件分片,确认媒体文件(和封面图片文件)上传到平台的结果,返回文件的 ID。请求中需要给出每一个分片的 part_number 和 etag用来校验分片的准确性。
// 注意事项
// Content-Type 需要指定为 application/json。
// 调用该接口之前必须先调用申请分片上传接口以及上传分片接口。
// 如本次分片上传除上传媒体文件外还需要上传封面图片,则请求中还需提供 cover_part_infos 字段以用于合并封面图片文件分片。
// 请求中 media_part_infos 和 cover_part_infos 字段必须按 part_number 从小到大排序part_number 必须从 1 开始,连续且不重复。
type CommitUploadRequest struct {
UploadID string `json:"upload_id"`
MediaPartInfos []*PartInfo `json:"media_part_infos"`
CoverPartInfos []*PartInfo `json:"cover_part_infos,omitempty"`
}
// PartInfo 分片信息
type PartInfo struct {
PartNumber int `json:"part_number"` // 分片编号。
Etag string `json:"etag"` // 使用上传分片接口上传成功后返回的 etag 的值
}
// CommitUploadResponse 确认分片上传响应
type CommitUploadResponse struct {
util.CommonError
MediaID int64 `json:"media_id"` // 媒体文件唯一标识,用于发布视频。
}
// ListMediaRequest 查询媒体列表请求
// 该接口用于查询已经上传到平台的媒体文件列表。
// 注意事项
// Content-Type 需要指定为 application/json。
// 本接口返回的视频或图片链接均为临时链接,不应将其保存下来。
// media_name 参数支持模糊匹配,当需要模糊匹配时可以在前面或后面加上 %,否则为精确匹配。例如 "test%" 可以匹配到 "test123", "testxxx", "test"。
// 调用方式
type ListMediaRequest struct {
DramaID int64 `json:"drama_id,omitempty"` // 剧目 ID可通过查询剧目列表接口获取。
MediaName string `json:"media_name,omitempty"` // 媒体文件名称,可通过查询媒体列表接口获取,模糊匹配。
StartTime int64 `json:"start_time,omitempty"` // 媒资上传时间>=start_timeUnix 时间戳,单位:秒。
EndTime int64 `json:"end_time,omitempty"` // 媒资上传时间<end_timeUnix 时间戳,单位:秒。
Limit int `json:"limit,omitempty"` // 分页拉取的最大返回结果数。默认值100最大值100。
Offset int `json:"offset,omitempty"` // 分页拉取的起始偏移量。默认值0。
}
// MediaInfo 媒体信息
type MediaInfo struct {
MediaID int64 `json:"media_id"` // 媒资文件 id。
CreateTime int64 `json:"create_time"` // 上传时间,时间戳。
ExpireTime int64 `json:"expire_time"` // 过期时间,时间戳。
DramaID int64 `json:"drama_id"` // 所属剧目 id。
FileSize int64 `json:"file_size"` // 媒资文件大小,单位:字节。
Duration int64 `json:"duration"` // 播放时长,单位:秒。
Name string `json:"name"` // 媒资文件名。
Description string `json:"description"` // 描述。
CoverURL string `json:"cover_url"` // 封面图临时链接。
OriginalURL string `json:"original_url"` // 原始视频临时链接。
Mp4URL string `json:"mp4_url"` // mp4 格式临时链接。
HlsURL string `json:"hls_url"` // hls 格式临时链接。
AuditDetail *MediaAuditDetail `json:"audit_detail"` // 审核信息。
}
// MediaAuditDetail 媒体审核详情
type MediaAuditDetail struct {
Status int `json:"status"` // 审核状态 0 为无效值1 为审核中2 为审核驳回3 为审核通过4 为驳回重填。需要注意可能存在单个剧集的状态为审核通过,但是剧目整体是未通过的情况,而能不能获取播放链接取决于剧目的审核状态。
CreateTime int `json:"create_time"` // 提审时间戳。
AuditTime int `json:"audit_time"` // 审核时间戳。
Reason string `json:"reason"` // 审核备注。该值可能为空。
EvidenceMaterialIDList []string `json:"evidence_material_id_list"` // 审核证据截图 id 列表,截图 id 可以用作 get_material 接口的参数来获得截图内容。
}
// ListMediaResponse 查询媒体列表响应
type ListMediaResponse struct {
util.CommonError
MediaInfoList []*MediaInfo `json:"media_info_list"` // 媒体信息列表。
}
// GetMediaRequest 获取媒体请求
// 该接口用于获取已上传到平台的指定媒资信息,用于开发者后台管理使用。用于给用户客户端播放的链接应该使用 getmedialink 接口获取。
// Content-Type 需要指定为 application/json。
// 本接口返回的视频或图片链接均为临时链接,不应将其保存下来。
type GetMediaRequest struct {
MediaID int64 `json:"media_id"` // 媒资文件 id。
}
// GetMediaResponse 获取媒体响应
type GetMediaResponse struct {
util.CommonError
MediaInfo MediaInfo `json:"media_info"` // 媒体信息。
}
// GetMediaLinkRequest 获取媒体链接请求
// 该接口用于获取视频临时播放链接,用于给用户的播放使用。只有审核通过的视频才能通过该接口获取播放链接。
// 注意事项
// Content-Type 需要指定为 application/json。
// 本接口返回的视频或图片链接均为临时链接,不应将其保存下来。
// 能不能获取播放链接取决于剧目审核状态,可能存在单个剧集的状态为审核通过,但是剧目整体是未通过的情况,这种情况也没法获取播放链接。
// 开发者如需区分不同渠道的播放流量或次数,可以在 us 参数中传入渠道标识,这样得到的播放链接中 us 参数的前半部分就包含有渠道标识。开发者把这个带有渠道标识的链接分发给对应的渠道播放,就能统计到不同渠道播放情况。统计的数据来源为 CDN 日志(从 getcdnlogs 接口得到CDN 日志中“文件路径”列中的参数也带有该标识,再结合日志中“字节数”列的流量数值,估算每个渠道所消耗的流量。另需注意日志统计的流量和扣费流量的差异,详情参考 getcdnlogs 接口中的注意事项。
type GetMediaLinkRequest struct {
MediaID int64 `json:"media_id"` // 媒资文件 id。
T int64 `json:"t"` // 播放地址的过期时间戳。有效的时间最长不能超过 2 小时后。
US string `json:"us,omitempty"` // 链接标识。平台默认会生成一个仅包含小写字母和数字的字符串用于增强链接的唯一性 (如 us=647488c4792c15185b8fd2a6)。如开发者需要增加自己的标识,比如区分播放的渠道,可使用该参数,该参数最终的值是"开发者标识 - 平台标识"(如开发者传入 abcd则最终的临时链接中 us=abcd-647488c4792c15185b8fd2a6
Expr int `json:"expr,omitempty"` // 试看时长,单位:秒,最大值不能超过视频长度
RLimit int `json:"rlimit,omitempty"` // 最多允许多少个不同 IP 的终端播放,以十进制表示,最大值为 9不填表示不做限制。当限制 URL 只能被 1 个人播放时,建议 rlimit 不要严格限制成 1例如可设置为 3因为移动端断网后重连 IP 可能改变。
WHref string `json:"whref,omitempty"` // 允许访问的域名列表,支持 1 条 - 10 条用半角逗号分隔。域名前不要带协议名http://和 https://),域名为前缀匹配(如填写 abc.com则 abc.com/123 和 abc.com.cn 也会匹配),且支持通配符(如 *.abc.com
BkRef string `json:"bkref,omitempty"` // 禁止访问的域名列表,支持 1 条 - 10 条用半角逗号分隔。域名前不要带协议名http://和 https://),域名为前缀匹配(如填写 abc.com则 abc.com/123 和 abc.com.cn 也会匹配),且支持通配符(如 *.abc.com
}
// GetMediaLinkResponse 获取媒体链接响应
type GetMediaLinkResponse struct {
util.CommonError
MediaInfo MediaPlaybackInfo `json:"media_info"` // 媒体播放信息。
}
// MediaPlaybackInfo 媒体播放信息
type MediaPlaybackInfo struct {
MediaID int64 `json:"media_id"` // 媒资文件 id。
Duration int64 `json:"duration"` // 播放时长,单位:秒。
Name string `json:"name"` // 媒资文件名。
Description string `json:"description"` // 描述。
CoverURL string `json:"cover_url"` // 封面图临时链接。
Mp4URL string `json:"mp4_url"` // mp4 格式临时链接。
HlsURL string `json:"hls_url"` // hls 格式临时链接。
}
// DeleteMediaRequest 删除媒体请求
// 该接口用于删除已上传到平台的指定媒资文件,用于开发者后台管理使用。
// Content-Type 需要指定为 application/json。
type DeleteMediaRequest struct {
MediaID int64 `json:"media_id"` // 媒资文件 id。
}
// DeleteMediaResponse 删除媒体响应
type DeleteMediaResponse struct {
util.CommonError
}
// AuditDramaRequest 审核剧目请求
// 该接口用于审核剧目,审核通过后,剧目下所有剧集都会被审核通过。
// 注意事项
// Content-Type 需要指定为 application/json。
// 剧目信息与审核材料在首次提审时为必填,重新提审时根据是否需要修改选填,
// 本接口中使用的临时图片 material_id 可通过新增临时素材接口上传得到,对应临时素材接口中的 media_id本文档中为避免与剧集的 media_id 混淆,称其为 material_id。
// 新增临时素材接口可以被小程序调用,调用的小程序账号和剧目提审的小程序账号必须是同一个,否则提交审核时会无法识别素材 id。
type AuditDramaRequest struct {
DramaID int64 `json:"drama_id,omitempty"` // 剧目 ID可通过查询剧目列表接口获取。首次提审不需要填该参数重新提审时必填
Name string `json:"name,omitempty"` // 剧名,首次提审时必填,重新提审时根据是否需要修改选填。
MediaCount int `json:"media_count,omitempty"` // 剧集数目。首次提审时必填,重新提审时可不填,如要填写也要和第一次提审时一样。
MediaIDList []int64 `json:"media_id_list,omitempty"` // 剧集媒资 media_id 列表。首次提审时必填,而且元素个数必须与 media_count 一致。重新提审时为可选,如果剧集有内容有变化,可以通过新的列表替换未通过的剧集(推荐使用 replace_media_list 进行替换,避免顺序和原列表不一致)。
Producer string `json:"producer,omitempty"` // 制作方。首次提审时必填,重新提审时根据是否需要修改选填。
Description string `json:"description,omitempty"` // 剧描述。首次提审时必填,重新提审时根据是否需要修改选填。
CoverMaterialID string `json:"cover_material_id,omitempty"` // 封面图片临时 media_id。首次提审时必填重新提审时根据是否需要修改选填。
RegistrationNumber string `json:"registration_number,omitempty"` // 剧目备案号。首次提审时剧目备案号与网络剧片发行许可证编号二选一。重新提审时根据是否需要修改选填
AuthorizedMaterialID string `json:"authorized_material_id,omitempty"` // 剧目播放授权材料 material_id。如果小程序主体名称和制作方完全一致则不需要填否则必填
PublishLicense string `json:"publish_license,omitempty"` // 网络剧片发行许可证编号。首次提审时剧目备案号与网络剧片发行许可证编号二选一。重新提审时根据是否需要修改选填
PublishLicenseMaterialID string `json:"publish_license_material_id,omitempty"` // 网络剧片发行许可证图片,首次提审时如果网络剧片发行许可证编号非空,则该改字段也非空。重新提审时根据是否变化选填
Expedited int `json:"expedited,omitempty"` // 是否加急审核,填 1 表示审核加急0 或不填为不加急。每天有 5 次加急机会。该字段在首次提审时才有效,重新提审时会沿用首次提审时的属性,重新提审不会扣次数。最终是否为加急单,可以根据 DramaInfo.expedited 属性判断
ReplaceMediaList []*ReplaceInfo `json:"replace_media_list,omitempty"` // 重新提审时,如果剧目内容有变化,可以通过该字段替换未通过的剧集。用于重新提审时替换审核不通过的剧集。
}
// ReplaceInfo 替换信息
type ReplaceInfo struct {
Old int64 `json:"old"` // 旧的 media_id
New int64 `json:"new"` // 新的 media_id
}
// AuditDramaResponse 审核剧目响应
type AuditDramaResponse struct {
util.CommonError
DramaID int64 `json:"drama_id"` // 剧目 ID。
}
// ListDramasRequest 查询剧目列表请求
// 该接口用于获取已提交的剧目列表。
// 注意事项
// Content-Type 需要指定为 application/json。
// 本接口返回的图片链接均为临时链接,不应将其保存下来。
// 如果剧目审核结果为失败或驳回,则具体每一集的具体驳回理由及证据截图可通过“获取媒资列表”或者“获取媒资详细信息”接口来获取。
type ListDramasRequest struct {
Limit int `json:"limit,omitempty"` // 分页拉取的最大返回结果数。默认值100最大值100。
Offset int `json:"offset,omitempty"` // 分页拉取的起始偏移量。默认值0。
}
// DramaInfo 剧目信息
type DramaInfo struct {
DramaID int64 `json:"drama_id"` // 剧目 id。
CreateTime int64 `json:"create_time"` // 创建时间,时间戳。
Name string `json:"name"` // 剧名。
Playwright string `json:"playwright"` // 编剧。
Producer string `json:"producer"` // 制作方。
ProductionLicense string `json:"production_license"` // 广播电视节目制作经营许可证。
CoverURL string `json:"cover_url"` // 封面图临时链接,根据提审时提交的 cover_material_id 转存得到。
MediaCount int `json:"media_count"` // 剧集数目。
Description string `json:"description"` // 剧描述。
MediaList []*DramaMediaInfo `json:"media_list"` // 剧集信息列表。
AuditDetail *DramaAuditDetail `json:"audit_detail"` // 审核状态。
Expedited int `json:"expedited"` // 是否加急审核1 表示审核加急0 或空为非加急审核。
}
// DramaMediaInfo 剧目媒体信息
type DramaMediaInfo struct {
MediaID int64 `json:"media_id"`
}
// DramaAuditDetail 剧目审核详情
type DramaAuditDetail struct {
Status int `json:"status"` // 审核状态 0 为无效值1 为审核中2 为审核驳回3 为审核通过4 为驳回重填。
CreateTime int64 `json:"create_time"` // 提审时间戳。
AuditTime int64 `json:"audit_time"` // 审核时间戳。
}
// ListDramasResponse 查询剧目列表响应
type ListDramasResponse struct {
util.CommonError
DramaInfoList []*DramaInfo `json:"drama_info_list"` // 剧目信息列表。
}
// GetDramaRequest 获取剧目请求
// 该接口用于查询已提交的剧目。
// 注意事项
// Content-Type 需要指定为 application/json。
// 本接口返回的图片链接均为临时链接,不应将其保存下来。
// 如果剧目审核结果为失败或驳回,则具体每一集的具体驳回理由及证据截图可通过“获取媒资列表”或者“获取媒资详细信息”接口来获取。
type GetDramaRequest struct {
DramaID int64 `json:"drama_id"` // 剧目 id。
}
// GetDramaResponse 获取剧目响应
type GetDramaResponse struct {
util.CommonError
DramaInfo *DramaInfo `json:"drama_info"` // 剧目信息。
}
// GetCdnUsageDataRequest 获取 CDN 用量数据请求
// 该接口用于查询点播 CDN 的流量数据。
// 注意事项
// 可以查询最近 365 天内的 CDN 用量数据。
// 查询时间跨度不超过 90 天。
// 可以指定用量数据的时间粒度,支持 5 分钟、1 小时、1 天的时间粒度。
// 流量为查询时间粒度内的总流量。
type GetCdnUsageDataRequest struct {
StartTime int64 `json:"start_time"` // 查询起始时间Unix 时间戳,单位:秒。
EndTime int64 `json:"end_time"` // 查询结束时间Unix 时间戳,单位:秒。
DataInterval int `json:"data_interval"` // 用量数据的时间粒度单位分钟取值有5:5 分钟粒度,返回指定查询时间内 5 分钟粒度的明细数据。60小时粒度返回指定查询时间内 1 小时粒度的数据。1440天粒度返回指定查询时间内 1 天粒度的数据。默认值为 1440返回天粒度的数据。
}
// DataItem 数据项
type DataItem struct {
Time int64 `json:"time"` // 时间戳,单位:秒。
Value int64 `json:"value"` // 用量数值。
}
// GetCdnUsageDataResponse 获取 CDN 用量数据响应
type GetCdnUsageDataResponse struct {
util.CommonError
DataInterval int `json:"data_interval"`
ItemList []*DataItem `json:"item_list"`
}
// GetCdnLogsRequest 获取 CDN 日志下载链接请求
// 该接口用于获取点播 CDN 日志下载链接。
// 注意事项
// 可以查询最近 30 天内的 CDN 日志下载链接。
// 默认情况下 CDN 每小时生成一个日志文件,如果某一个小时没有 CDN 访问,不会生成日志文件。
// CDN 日志下载链接的有效期为 24 小时。
// 日志字段依次为:请求时间、客户端 IP、访问域名、文件路径、字节数、省级编码、运营商编码、HTTP 状态码、referer、Request-Time、UA、range、HTTP Method、协议标识、缓存 HIT / MISS日志数据打包存在延迟正常情况下 3 小时后数据包趋于完整日志中的字节数为应用层数据大小,未考虑网络协议包头、加速重传等开销,因此与计费数据存在一定差异。
// CDN 日志中记录的下行字节数统计而来的流量数据,是应用层数据。在实际网络传输中,产生的网络流量要比纯应用层流量多 5%-15%,比如 TCP/IP 协议的包头消耗、网络丢包重传等,这些无法被应用层统计到。在业内标准中,计费用流量一般在应用层流量的基础上加上上述开销,媒资管理服务中计费的加速流量约为日志计算加速流量的 110%。
// 省份映射
// 22北京86内蒙古146山西1069河北1177天津119宁夏152陕西1208甘肃1467青海1468新疆145黑龙江1445吉林1464辽宁2福建120江苏121安徽122山东1050上海1442浙江182河南1135湖北1465江西1466湖南118贵州153云南1051重庆1068四川1155西藏4广东173广西1441海南0其他1港澳台-1海外。
// 运营商映射
// 2中国电信26中国联通38教育网43长城宽带1046中国移动3947中国铁通-1海外运营商0其他运营商。
type GetCdnLogsRequest struct {
StartTime int64 `json:"start_time"` // 查询起始时间Unix 时间戳,单位:秒。
EndTime int64 `json:"end_time"` // 查询结束时间Unix 时间戳,单位:秒。
Limit int `json:"limit,omitempty"` // 分页拉取的最大返回结果数。默认值100最大值100。
Offset int `json:"offset,omitempty"` // 分页拉取的起始偏移量。默认值0。
}
// CdnLogInfo CDN 日志信息
type CdnLogInfo struct {
Date int64 `json:"date"` // 日志日期,格式为 YYYYMMDD。
Name string `json:"name"` // 日志文件名
URL string `json:"url"` // 日志下载链接24 小时内下载有效。
StartTime int64 `json:"start_time"` // 查询起始时间Unix 时间戳,单位:秒。
EndTime int64 `json:"end_time"` // 查询结束时间Unix 时间戳,单位:秒。
}
// GetCdnLogsResponse 获取 CDN 日志下载链接响应
type GetCdnLogsResponse struct {
util.CommonError
TotalCount int `json:"total_count"` // 日志总条数。
DomesticCdnLogs []*CdnLogInfo `json:"domestic_cdn_logs"` // 日志信息列表,国内 CDN 节点的日志下载列表。
}
// AsyncMediaUploadEvent 异步媒体上传事件
// see: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/mini-drama/mini_drama.html#_5-1-%E5%AA%92%E8%B5%84%E4%B8%8A%E4%BC%A0%E5%AE%8C%E6%88%90%E4%BA%8B%E4%BB%B6
type AsyncMediaUploadEvent struct {
util.CommonError
MediaID int64 `json:"media_id"` // 媒资文件 id。
SourceContext string `json:"source_context"` // 来源上下文,开发者可自定义该字段内容。
}
// AsyncMediaAuditEvent 异步媒体审核事件
// see: https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/mini-drama/mini_drama.html#_5-2-%E5%AE%A1%E6%A0%B8%E7%8A%B6%E6%80%81%E4%BA%8B%E4%BB%B6
type AsyncMediaAuditEvent struct {
DramaID int64 `json:"drama_id"` // 剧目 id。
SourceContext string `json:"source_context"` // 来源上下文,开发者可自定义该字段内容。
AuditDetail *DramaAuditDetail `json:"audit_detail"` // 审核状态。
}

View File

@@ -0,0 +1,346 @@
/*
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* You can obtain one at https://github.com/silenceper/wechat.
*
*/
package minidrama
import (
"context"
"strconv"
"github.com/silenceper/wechat/v2/util"
)
// SingleFileUpload 单文件上传
func (s *MiniDrama) SingleFileUpload(ctx context.Context, in *SingleFileUploadRequest) (out SingleFileUploadResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, singleFileUpload); err != nil {
return
}
var (
fields = []util.MultipartFormField{
{
IsFile: true,
Fieldname: "media_data",
Filename: string(in.MediaData),
}, {
IsFile: false,
Fieldname: "media_name",
Value: []byte(in.MediaName),
}, {
IsFile: false,
Fieldname: "media_type",
Value: []byte(in.MediaType),
},
}
response []byte
)
if in.CoverType != "" && in.CoverData != nil {
fields = append(fields, util.MultipartFormField{
IsFile: false,
Fieldname: "cover_type",
Value: []byte(in.CoverType),
})
fields = append(fields, util.MultipartFormField{
IsFile: true,
Fieldname: "cover_data",
Filename: string(in.CoverData),
})
}
if in.SourceContext != "" {
fields = append(fields, util.MultipartFormField{
IsFile: false,
Fieldname: "source_context",
Value: []byte(in.SourceContext),
})
}
if response, err = util.PostMultipartForm(fields, address); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "SingleFileUpload")
return
}
// PullUpload 拉取上传
func (s *MiniDrama) PullUpload(ctx context.Context, in *PullUploadRequest) (out PullUploadResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, pullUpload); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "PullUpload")
return
}
// GetTask 查询任务状态
func (s *MiniDrama) GetTask(ctx context.Context, in *GetTaskRequest) (out GetTaskResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getTask); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "GetTask")
return
}
// ApplyUpload 申请分片上传
func (s *MiniDrama) ApplyUpload(ctx context.Context, in *ApplyUploadRequest) (out ApplyUploadResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, applyUpload); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "ApplyUpload")
return
}
// UploadPart 上传分片
// Content-Type 需要指定为 multipart/form-data; boundary=<delimiter><箭头括号>表示必须替换为有效值的变量。
func (s *MiniDrama) UploadPart(ctx context.Context, in *UploadPartRequest) (out UploadPartResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, uploadPart); err != nil {
return
}
var (
fields = []util.MultipartFormField{
{
IsFile: true,
Fieldname: "data",
Filename: string(in.Data),
}, {
IsFile: false,
Fieldname: "upload_id",
Value: []byte(in.UploadID),
}, {
IsFile: false,
Fieldname: "part_number",
Value: []byte(strconv.Itoa(in.PartNumber)),
}, {
IsFile: false,
Fieldname: "resource_type",
Value: []byte(strconv.Itoa(in.PartNumber)),
},
}
response []byte
)
if response, err = util.PostMultipartForm(fields, address); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "UploadPart")
return
}
// CommitUpload 确认上传
func (s *MiniDrama) CommitUpload(ctx context.Context, in *CommitUploadRequest) (out CommitUploadResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, commitUpload); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "CommitUpload")
return
}
// ListMedia 获取媒体列表
func (s *MiniDrama) ListMedia(ctx context.Context, in *ListMediaRequest) (out ListMediaResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, listMedia); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "ListMedia")
return
}
// GetMedia 获取媒资详细信息
func (s *MiniDrama) GetMedia(ctx context.Context, in *GetMediaRequest) (out GetMediaResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getMedia); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "GetMedia")
return
}
// GetMediaLink 获取媒资播放链接
func (s *MiniDrama) GetMediaLink(ctx context.Context, in *GetMediaLinkRequest) (out GetMediaLinkResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getMediaLink); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "GetMediaLink")
return
}
// DeleteMedia 删除媒体
func (s *MiniDrama) DeleteMedia(ctx context.Context, in *DeleteMediaRequest) (out DeleteMediaResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, deleteMedia); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "DeleteMedia")
return
}
// AuditDrama 审核剧本
func (s *MiniDrama) AuditDrama(ctx context.Context, in *AuditDramaRequest) (out AuditDramaResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, auditDrama); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "AuditDrama")
return
}
// ListDramas 获取剧目列表
func (s *MiniDrama) ListDramas(ctx context.Context, in *ListDramasRequest) (out ListDramasResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, listDramas); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "ListDramas")
return
}
// GetDrama 获取剧目信息
func (s *MiniDrama) GetDrama(ctx context.Context, in *GetDramaRequest) (out GetDramaResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getDrama); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "GetDrama")
return
}
// GetCdnUsageData 查询 CDN 用量数据
func (s *MiniDrama) GetCdnUsageData(ctx context.Context, in *GetCdnUsageDataRequest) (out GetCdnUsageDataResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getCdnUsageData); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "GetCdnUsageData")
return
}
// GetCdnLogs 查询 CDN 日志
func (s *MiniDrama) GetCdnLogs(ctx context.Context, in *GetCdnLogsRequest) (out GetCdnLogsResponse, err error) {
var address string
if address, err = s.requestAddress(ctx, getCdnLogs); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "GetCdnLogs")
return
}
// requestAddress 请求地址
func (s *MiniDrama) requestAddress(_ context.Context, url string) (string, error) {
accessToken, err := s.ctx.GetAccessToken()
if err != nil {
return "", err
}
return url + accessToken, nil
}

View File

@@ -2,6 +2,7 @@ package miniprogram
import ( import (
"github.com/silenceper/wechat/v2/credential" "github.com/silenceper/wechat/v2/credential"
"github.com/silenceper/wechat/v2/internal/openapi"
"github.com/silenceper/wechat/v2/miniprogram/analysis" "github.com/silenceper/wechat/v2/miniprogram/analysis"
"github.com/silenceper/wechat/v2/miniprogram/auth" "github.com/silenceper/wechat/v2/miniprogram/auth"
"github.com/silenceper/wechat/v2/miniprogram/business" "github.com/silenceper/wechat/v2/miniprogram/business"
@@ -10,8 +11,11 @@ import (
"github.com/silenceper/wechat/v2/miniprogram/context" "github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/miniprogram/encryptor" "github.com/silenceper/wechat/v2/miniprogram/encryptor"
"github.com/silenceper/wechat/v2/miniprogram/message" "github.com/silenceper/wechat/v2/miniprogram/message"
"github.com/silenceper/wechat/v2/miniprogram/minidrama"
"github.com/silenceper/wechat/v2/miniprogram/order"
"github.com/silenceper/wechat/v2/miniprogram/privacy" "github.com/silenceper/wechat/v2/miniprogram/privacy"
"github.com/silenceper/wechat/v2/miniprogram/qrcode" "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/riskcontrol"
"github.com/silenceper/wechat/v2/miniprogram/security" "github.com/silenceper/wechat/v2/miniprogram/security"
"github.com/silenceper/wechat/v2/miniprogram/shortlink" "github.com/silenceper/wechat/v2/miniprogram/shortlink"
@@ -19,27 +23,41 @@ import (
"github.com/silenceper/wechat/v2/miniprogram/tcb" "github.com/silenceper/wechat/v2/miniprogram/tcb"
"github.com/silenceper/wechat/v2/miniprogram/urllink" "github.com/silenceper/wechat/v2/miniprogram/urllink"
"github.com/silenceper/wechat/v2/miniprogram/urlscheme" "github.com/silenceper/wechat/v2/miniprogram/urlscheme"
"github.com/silenceper/wechat/v2/miniprogram/virtualpayment"
"github.com/silenceper/wechat/v2/miniprogram/werun" "github.com/silenceper/wechat/v2/miniprogram/werun"
) )
// MiniProgram 微信小程序相关API // MiniProgram 微信小程序相关 API
type MiniProgram struct { type MiniProgram struct {
ctx *context.Context ctx *context.Context
} }
// NewMiniProgram 实例化小程序API // NewMiniProgram 实例化小程序 API
func NewMiniProgram(cfg *config.Config) *MiniProgram { func NewMiniProgram(cfg *config.Config) *MiniProgram {
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{ ctx := &context.Context{
Config: cfg, Config: cfg,
AccessTokenHandle: defaultAkHandle, AccessTokenContextHandle: defaultAkHandle,
} }
return &MiniProgram{ctx} return &MiniProgram{ctx}
} }
// SetAccessTokenHandle 自定义access_token获取方式 // SetAccessTokenHandle 自定义 access_token 获取方式
func (miniProgram *MiniProgram) SetAccessTokenHandle(accessTokenHandle credential.AccessTokenHandle) { 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 // GetContext get Context
@@ -67,17 +85,17 @@ func (miniProgram *MiniProgram) GetBusiness() *business.Business {
return business.NewBusiness(miniProgram.ctx) return business.NewBusiness(miniProgram.ctx)
} }
// GetPrivacy 小程序隐私协议相关API // GetPrivacy 小程序隐私协议相关 API
func (miniProgram *MiniProgram) GetPrivacy() *privacy.Privacy { func (miniProgram *MiniProgram) GetPrivacy() *privacy.Privacy {
return privacy.NewPrivacy(miniProgram.ctx) return privacy.NewPrivacy(miniProgram.ctx)
} }
// GetQRCode 小程序码相关API // GetQRCode 小程序码相关 API
func (miniProgram *MiniProgram) GetQRCode() *qrcode.QRCode { func (miniProgram *MiniProgram) GetQRCode() *qrcode.QRCode {
return qrcode.NewQRCode(miniProgram.ctx) return qrcode.NewQRCode(miniProgram.ctx)
} }
// GetTcb 小程序云开发API // GetTcb 小程序云开发 API
func (miniProgram *MiniProgram) GetTcb() *tcb.Tcb { func (miniProgram *MiniProgram) GetTcb() *tcb.Tcb {
return tcb.NewTcb(miniProgram.ctx) return tcb.NewTcb(miniProgram.ctx)
} }
@@ -102,7 +120,7 @@ func (miniProgram *MiniProgram) GetContentSecurity() *content.Content {
return content.NewContent(miniProgram.ctx) return content.NewContent(miniProgram.ctx)
} }
// GetURLLink 小程序URL Link接口 // GetURLLink 小程序 URL Link 接口
func (miniProgram *MiniProgram) GetURLLink() *urllink.URLLink { func (miniProgram *MiniProgram) GetURLLink() *urllink.URLLink {
return urllink.NewURLLink(miniProgram.ctx) return urllink.NewURLLink(miniProgram.ctx)
} }
@@ -122,7 +140,42 @@ func (miniProgram *MiniProgram) GetShortLink() *shortlink.ShortLink {
return shortlink.NewShortLink(miniProgram.ctx) return shortlink.NewShortLink(miniProgram.ctx)
} }
// GetSURLScheme 小程序URL Scheme接口 // GetSURLScheme 小程序 URL Scheme 接口
func (miniProgram *MiniProgram) GetSURLScheme() *urlscheme.URLScheme { func (miniProgram *MiniProgram) GetSURLScheme() *urlscheme.URLScheme {
return urlscheme.NewURLScheme(miniProgram.ctx) return urlscheme.NewURLScheme(miniProgram.ctx)
} }
// GetOpenAPI openApi 管理接口
func (miniProgram *MiniProgram) GetOpenAPI() *openapi.OpenAPI {
return openapi.NewOpenAPI(miniProgram.ctx)
}
// GetVirtualPayment 小程序虚拟支付
func (miniProgram *MiniProgram) GetVirtualPayment() *virtualpayment.VirtualPayment {
return virtualpayment.NewVirtualPayment(miniProgram.ctx)
}
// GetMessageReceiver 获取消息推送接收器
func (miniProgram *MiniProgram) GetMessageReceiver() *message.PushReceiver {
return message.NewPushReceiver(miniProgram.ctx)
}
// GetShipping 小程序发货信息管理服务
func (miniProgram *MiniProgram) GetShipping() *order.Shipping {
return order.NewShipping(miniProgram.ctx)
}
// GetMiniDrama 小程序娱乐微短剧
func (miniProgram *MiniProgram) GetMiniDrama() *minidrama.MiniDrama {
return minidrama.NewMiniDrama(miniProgram.ctx)
}
// GetRedPacketCover 小程序微信红包封面 API
func (miniProgram *MiniProgram) GetRedPacketCover() *redpacketcover.RedPacketCover {
return redpacketcover.NewRedPacketCover(miniProgram.ctx)
}
// GetUpdatableMessage 小程序动态消息
func (miniProgram *MiniProgram) GetUpdatableMessage() *message.UpdatableMessage {
return message.NewUpdatableMessage(miniProgram.ctx)
}

View File

@@ -0,0 +1,269 @@
package order
import (
"fmt"
"time"
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/util"
)
const (
// 发货信息录入
uploadShippingInfoURL = "https://api.weixin.qq.com/wxa/sec/order/upload_shipping_info?access_token=%s"
// 查询订单发货状态
getShippingOrderURL = "https://api.weixin.qq.com/wxa/sec/order/get_order?access_token=%s"
// 查询订单列表
getShippingOrderListURL = "https://api.weixin.qq.com/wxa/sec/order/get_order_list?access_token=%s"
// 确认收货提醒接口
notifyConfirmReceiveURL = "https://api.weixin.qq.com/wxa/sec/order/notify_confirm_receive?access_token=%s"
)
// Shipping 发货信息管理
type Shipping struct {
*context.Context
}
// NewShipping init
func NewShipping(ctx *context.Context) *Shipping {
return &Shipping{ctx}
}
// UploadShippingInfo 发货信息录入
// see https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/business-capabilities/order-shipping/order-shipping.html
func (shipping *Shipping) UploadShippingInfo(in *UploadShippingInfoRequest) (err error) {
accessToken, err := shipping.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(uploadShippingInfoURL, accessToken)
response, err := util.PostJSON(uri, in)
if err != nil {
return
}
// 使用通用方法返回错误
return util.DecodeWithCommonError(response, "UploadShippingInfo")
}
// GetShippingOrder 查询订单发货状态
func (shipping *Shipping) GetShippingOrder(in *GetShippingOrderRequest) (res ShippingOrderResponse, err error) {
accessToken, err := shipping.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(getShippingOrderURL, accessToken)
response, err := util.PostJSON(uri, in)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "GetShippingOrder")
return
}
// GetShippingOrderList 查询订单列表
func (shipping *Shipping) GetShippingOrderList(in *GetShippingOrderListRequest) (res GetShippingOrderListResponse, err error) {
accessToken, err := shipping.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(getShippingOrderListURL, accessToken)
response, err := util.PostJSON(uri, in)
if err != nil {
return
}
err = util.DecodeWithError(response, &res, "GetShippingOrderList")
return
}
// NotifyConfirmReceive 确认收货提醒接口
func (shipping *Shipping) NotifyConfirmReceive(in *NotifyConfirmReceiveRequest) (err error) {
accessToken, err := shipping.GetAccessToken()
if err != nil {
return
}
uri := fmt.Sprintf(notifyConfirmReceiveURL, accessToken)
response, err := util.PostJSON(uri, in)
if err != nil {
return
}
// 使用通用方法返回错误
return util.DecodeWithCommonError(response, "NotifyConfirmReceive")
}
// UploadShippingInfoRequest 发货信息录入请求参数
type UploadShippingInfoRequest struct {
OrderKey *ShippingOrderKey `json:"order_key"` // 订单,需要上传物流信息的订单
LogisticsType LogisticsType `json:"logistics_type"` // 物流模式
DeliveryMode DeliveryMode `json:"delivery_mode"` // 发货模式
IsAllDelivered bool `json:"is_all_delivered"` // 分拆发货模式时必填,用于标识分拆发货模式下是否已全部发货完成
ShippingList []*ShippingInfo `json:"shipping_list"` // 物流信息列表,发货物流单列表,支持统一发货(单个物流单)和分拆发货(多个物流单)两种模式
UploadTime *time.Time `json:"upload_time"` // 上传时间,用于标识请求的先后顺序
Payer *ShippingPayer `json:"payer"` // 支付人信息
}
// ShippingOrderKey 订单
type ShippingOrderKey struct {
OrderNumberType NumberType `json:"order_number_type"` // 订单单号类型用于确认需要上传详情的订单。枚举值1使用下单商户号和商户侧单号枚举值2使用微信支付单号。
TransactionID string `json:"transaction_id"` // 原支付交易对应的微信订单号
Mchid string `json:"mchid"` // 支付下单商户的商户号,由微信支付生成并下发
OutTradeNo string `json:"out_trade_no"` // 商户系统内部订单号,只能是数字、大小写字母`_-*`且在同一个商户号下唯一
}
// ShippingPayer 支付者信息
type ShippingPayer struct {
Openid string `json:"openid"` // 用户标识用户在小程序appid下的唯一标识
}
// ShippingInfo 物流信息
type ShippingInfo struct {
TrackingNo string `json:"tracking_no"` // 物流单号,物流快递发货时必填
ExpressCompany string `json:"express_company"` // 物流公司编码快递公司ID物流快递发货时必填参见「查询物流公司编码列表」
ItemDesc string `json:"item_desc"` // 商品信息,例如:微信红包抱枕*1个限120个字以内
Contact ShippingContact `json:"contact"` // 联系方式,当发货的物流公司为顺丰时,联系方式为必填,收件人或寄件人联系方式二选一
}
// ShippingContact 联系方式
type ShippingContact struct {
ConsignorContact string `json:"consignor_contact"` // 寄件人联系方式寄件人联系方式采用掩码传输最后4位数字不能打掩码
ReceiverContact string `json:"receiver_contact"` // 收件人联系方式收件人联系方式采用掩码传输最后4位数字不能打掩码
}
// DeliveryMode 发货模式
type DeliveryMode uint8
const (
// DeliveryModeUnifiedDelivery 统一发货
DeliveryModeUnifiedDelivery DeliveryMode = 1
// DeliveryModeSplitDelivery 分拆发货
DeliveryModeSplitDelivery DeliveryMode = 2
)
// LogisticsType 物流模式
type LogisticsType uint8
const (
// LogisticsTypeExpress 实体物流配送采用快递公司进行实体物流配送形式
LogisticsTypeExpress LogisticsType = 1
// LogisticsTypeSameCity 同城配送
LogisticsTypeSameCity LogisticsType = 2
// LogisticsTypeVirtual 虚拟商品,虚拟商品,例如话费充值,点卡等,无实体配送形式
LogisticsTypeVirtual LogisticsType = 3
// LogisticsTypeSelfPickup 用户自提
LogisticsTypeSelfPickup LogisticsType = 4
)
// NumberType 订单单号类型
type NumberType uint8
const (
// NumberTypeOutTradeNo 使用下单商户号和商户侧单号
NumberTypeOutTradeNo NumberType = 1
// NumberTypeTransactionID 使用微信支付单号
NumberTypeTransactionID NumberType = 2
)
// GetShippingOrderRequest 查询订单发货状态参数
type GetShippingOrderRequest struct {
TransactionID string `json:"transaction_id"` // 原支付交易对应的微信订单号
MerchantID string `json:"merchant_id"` // 支付下单商户的商户号,由微信支付生成并下发
SubMerchantID string `json:"sub_merchant_id"` //二级商户号
MerchantTradeNo string `json:"merchant_trade_no"` //商户系统内部订单号,只能是数字、大小写字母`_-*`且在同一个商户号下唯一。
}
// ShippingItem 物流信息
type ShippingItem struct {
TrackingNo string `json:"tracking_no"` // 物流单号,示例值: "323244567777
ExpressCompany string `json:"express_company"` // 物流公司编码快递公司ID物流快递发货时必填参见「查询物流公司编码列表」
UploadTime int64 `json:"upload_time"` // 上传物流信息时间,时间戳形式
}
// ShippingDetail 发货信息
type ShippingDetail struct {
DeliveryMode DeliveryMode `json:"delivery_mode"` // 发货模式
LogisticsType LogisticsType `json:"logistics_type"` // 物流模式
FinishShipping bool `json:"finish_shipping"` // 是否已全部发货
FinishShippingCount int `json:"finish_shipping_count"` // 已完成全部发货的次数
GoodsDesc string `json:"goods_desc"` // 在小程序后台发货信息录入页录入的商品描述
ShippingList []*ShippingItem `json:"shipping_list"` // 物流信息列表
}
// ShippingOrder 订单发货状态
type ShippingOrder struct {
TransactionID string `json:"transaction_id"` // 原支付交易对应的微信订单号
MerchantTradeNo string `json:"merchant_trade_no"` // 商户系统内部订单号,只能是数字、大小写字母`_-*`且在同一个商户号下唯一
MerchantID string `json:"merchant_id"` // 支付下单商户的商户号,由微信支付生成并下发
SubMerchantID string `json:"sub_merchant_id"` // 二级商户号
Description string `json:"description"` // 以分号连接的该支付单的所有商品描述当超过120字时自动截断并以 “...” 结尾
PaidAmount int64 `json:"paid_amount"` // 支付单实际支付金额,整型,单位:分钱
Openid string `json:"openid"` // 支付者openid
TradeCreateTime int64 `json:"trade_create_time"` // 交易创建时间,时间戳形式
PayTime int64 `json:"pay_time"` // 支付时间,时间戳形式
InComplaint bool `json:"in_complaint"` // 是否处在交易纠纷中
OrderState State `json:"order_state"` // 订单状态枚举:(1) 待发货;(2) 已发货;(3) 确认收货;(4) 交易完成;(5) 已退款
Shipping *ShippingDetail `json:"shipping"` // 订单发货信息
}
// ShippingOrderResponse 查询订单发货状态返回参数
type ShippingOrderResponse struct {
util.CommonError
Order ShippingOrder `json:"order"` // 订单发货信息
}
// State 订单状态
type State uint8
const (
// StateWaitShipment 待发货
StateWaitShipment State = 1
// StateShipped 已发货
StateShipped State = 2
// StateConfirm 确认收货
StateConfirm State = 3
// StateComplete 交易完成
StateComplete State = 4
// StateRefund 已退款
StateRefund State = 5
)
// GetShippingOrderListRequest 查询订单列表请求参数
type GetShippingOrderListRequest struct {
PayTimeRange *TimeRange `json:"pay_time_range"` // 支付时间范围
OrderState State `json:"order_state,omitempty"` // 订单状态
Openid string `json:"openid,omitempty"` // 支付者openid
LastIndex string `json:"last_index,omitempty"` // 翻页时使用,获取第一页时不用传入,如果查询结果中 has_more 字段为 true则传入该次查询结果中返回的 last_index 字段可获取下一页
PageSize int64 `json:"page_size"` // 每页数量最多50条
}
// TimeRange 时间范围
type TimeRange struct {
BeginTime int64 `json:"begin_time,omitempty"` // 查询开始时间,时间戳形式
EndTime int64 `json:"end_time,omitempty"` // 查询结束时间,时间戳形式
}
// GetShippingOrderListResponse 查询订单列表返回参数
type GetShippingOrderListResponse struct {
util.CommonError
OrderList []*ShippingOrder `json:"order_list"`
LastIndex string `json:"last_index"`
HasMore bool `json:"has_more"`
}
// NotifyConfirmReceiveRequest 确认收货提醒接口请求参数
type NotifyConfirmReceiveRequest struct {
TransactionID string `json:"transaction_id"` // 原支付交易对应的微信订单号
MerchantID string `json:"merchant_id"` // 支付下单商户的商户号,由微信支付生成并下发
SubMerchantID string `json:"sub_merchant_id"` // 二级商户号
MerchantTradeNo string `json:"merchant_trade_no"` // 商户系统内部订单号,只能是数字、大小写字母`_-*`且在同一个商户号下唯一
ReceivedTime int64 `json:"received_time"` // 收货时间,时间戳形式
}

View File

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

View File

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

@@ -51,12 +51,7 @@ func (security *Security) MediaCheckAsyncV1(in *MediaCheckAsyncV1Request) (trace
TraceID string `json:"trace_id"` TraceID string `json:"trace_id"`
} }
err = util.DecodeWithError(response, &res, "MediaCheckAsyncV1") err = util.DecodeWithError(response, &res, "MediaCheckAsyncV1")
if err != nil { return res.TraceID, err
return
}
traceID = res.TraceID
return
} }
// MediaCheckAsyncRequest 图片/音频异步校验请求参数 // MediaCheckAsyncRequest 图片/音频异步校验请求参数
@@ -93,12 +88,7 @@ func (security *Security) MediaCheckAsync(in *MediaCheckAsyncRequest) (traceID s
TraceID string `json:"trace_id"` TraceID string `json:"trace_id"`
} }
err = util.DecodeWithError(response, &res, "MediaCheckAsync") err = util.DecodeWithError(response, &res, "MediaCheckAsync")
if err != nil { return res.TraceID, err
return
}
traceID = res.TraceID
return
} }
// ImageCheckV1 校验一张图片是否含有违法违规内容(同步) // ImageCheckV1 校验一张图片是否含有违法违规内容(同步)

View File

@@ -24,10 +24,10 @@ func NewShortLink(ctx *context.Context) *ShortLink {
// ShortLinker 请求结构体 // ShortLinker 请求结构体
type ShortLinker struct { type ShortLinker struct {
// pageUrl 通过 Short Link 进入的小程序页面路径,必须是已经发布的小程序存在的页面,可携带 query最大1024个字符 // pageUrl 通过 Short Link 进入的小程序页面路径,必须是已经发布的小程序存在的页面,可携带 query最大 1024 个字符
PageURL string `json:"page_url"` PageURL string `json:"page_url"`
// pageTitle 页面标题不能包含违法信息超过20字符会用... 截断代替 // pageTitle 页面标题,不能包含违法信息,超过 20 字符会用... 截断代替
PageTitle string `json:"page_title"` PageTitle string `json:"page_title"`
// isPermanent 生成的 Short Link 类型短期有效false永久有效true // isPermanent 生成的 Short Link 类型短期有效false永久有效true
@@ -37,7 +37,7 @@ type ShortLinker struct {
// resShortLinker 返回结构体 // resShortLinker 返回结构体
type resShortLinker struct { type resShortLinker struct {
// 通用错误 // 通用错误
*util.CommonError util.CommonError
// 返回的 shortLink // 返回的 shortLink
Link string `json:"link"` Link string `json:"link"`
@@ -60,14 +60,10 @@ func (shortLink *ShortLink) generate(shortLinkParams ShortLinker) (string, error
// 使用通用方法返回错误 // 使用通用方法返回错误
var res resShortLinker var res resShortLinker
err = util.DecodeWithError(response, &res, "GenerateShortLink") err = util.DecodeWithError(response, &res, "GenerateShortLink")
if err != nil { return res.Link, err
return "", err
}
return res.Link, nil
} }
// GenerateShortLinkPermanent 生成永久shortLink // GenerateShortLinkPermanent 生成永久 shortLink
func (shortLink *ShortLink) GenerateShortLinkPermanent(PageURL, pageTitle string) (string, error) { func (shortLink *ShortLink) GenerateShortLinkPermanent(PageURL, pageTitle string) (string, error) {
return shortLink.generate(ShortLinker{ return shortLink.generate(ShortLinker{
PageURL: PageURL, PageURL: PageURL,
@@ -76,7 +72,7 @@ func (shortLink *ShortLink) GenerateShortLinkPermanent(PageURL, pageTitle string
}) })
} }
// GenerateShortLinkTemp 生成临时shortLink // GenerateShortLinkTemp 生成临时 shortLink
func (shortLink *ShortLink) GenerateShortLinkTemp(PageURL, pageTitle string) (string, error) { func (shortLink *ShortLink) GenerateShortLinkTemp(PageURL, pageTitle string) (string, error) {
return shortLink.generate(ShortLinker{ return shortLink.generate(ShortLinker{
PageURL: PageURL, PageURL: PageURL,

View File

@@ -1,6 +1,7 @@
package subscribe package subscribe
import ( import (
"encoding/json"
"fmt" "fmt"
"github.com/silenceper/wechat/v2/miniprogram/context" "github.com/silenceper/wechat/v2/miniprogram/context"
@@ -70,6 +71,13 @@ type TemplateList struct {
Data []TemplateItem `json:"data"` Data []TemplateItem `json:"data"`
} }
// resTemplateSend 发送获取 msg id
type resTemplateSend struct {
util.CommonError
MsgID int64 `json:"msgid"`
}
// Send 发送订阅消息 // Send 发送订阅消息
func (s *Subscribe) Send(msg *Message) (err error) { func (s *Subscribe) Send(msg *Message) (err error) {
var accessToken string var accessToken string
@@ -85,6 +93,33 @@ func (s *Subscribe) Send(msg *Message) (err error) {
return util.DecodeWithCommonError(response, "Send") 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 获取当前帐号下的个人模板列表 // ListTemplates 获取当前帐号下的个人模板列表
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.getTemplateList.html // https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.getTemplateList.html
func (s *Subscribe) ListTemplates() (*TemplateList, error) { func (s *Subscribe) ListTemplates() (*TemplateList, error) {
@@ -168,11 +203,7 @@ func (s *Subscribe) Add(ShortID string, kidList []int, sceneDesc string) (templa
} }
var result resSubscribeAdd var result resSubscribeAdd
err = util.DecodeWithError(response, &result, "AddSubscribe") err = util.DecodeWithError(response, &result, "AddSubscribe")
if err != nil { return result.TemplateID, err
return
}
templateID = result.TemplateID
return
} }
// Delete 删除私有模板 // Delete 删除私有模板

View File

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

View File

@@ -37,7 +37,7 @@ type SchemeInfo struct {
// https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/url-scheme/urlscheme.query.html#参数 // 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 配置 // scheme 配置
SchemeInfo SchemeInfo `json:"scheme_info"` SchemeInfo SchemeInfo `json:"scheme_info"`
// 访问该链接的openid没有用户访问过则为空字符串 // 访问该链接的openid没有用户访问过则为空字符串
@@ -62,9 +62,5 @@ func (u *URLScheme) QueryScheme(querySchemeParams QueryScheme) (schemeInfo Schem
// 使用通用方法返回错误 // 使用通用方法返回错误
var res resQueryScheme var res resQueryScheme
err = util.DecodeWithError(response, &res, "QueryScheme") err = util.DecodeWithError(response, &res, "QueryScheme")
if err != nil { return res.SchemeInfo, res.VisitOpenid, err
return
}
return res.SchemeInfo, res.VisitOpenid, nil
} }

View File

@@ -54,6 +54,7 @@ type USParams struct {
ExpireType TExpireType `json:"expire_type"` ExpireType TExpireType `json:"expire_type"`
ExpireTime int64 `json:"expire_time"` ExpireTime int64 `json:"expire_time"`
ExpireInterval int `json:"expire_interval"` ExpireInterval int `json:"expire_interval"`
IsExpire bool `json:"is_expire,omitempty"`
} }
// USResult 返回的结果 // USResult 返回的结果
@@ -78,8 +79,5 @@ func (u *URLScheme) Generate(params *USParams) (string, error) {
} }
var resp USResult var resp USResult
err = util.DecodeWithError(response, &resp, "URLScheme.Generate") err = util.DecodeWithError(response, &resp, "URLScheme.Generate")
if err != nil { return resp.OpenLink, err
return "", err
}
return resp.OpenLink, nil
} }

View File

@@ -0,0 +1,134 @@
/*
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* You can obtain one at https://github.com/silenceper/wechat.
*
*/
package virtualpayment
const (
// EnvProduction 环境 0-正式环境 1-沙箱环境
EnvProduction Env = 0
// EnvSandbox 环境 0-正式环境 1-沙箱环境
EnvSandbox Env = 1
)
const (
// Success 错误码 0、成功
Success ErrCode = 0
// SystemError 错误码 -1、系统错误
SystemError ErrCode = -1
// OpenIDError 错误码 268490001、openid 错误
OpenIDError ErrCode = 268490001
// RequestParamError 错误码 268490002、请求参数字段错误具体看 errmsg
RequestParamError ErrCode = 268490002
// SignError 错误码 268490003、签名错误
SignError ErrCode = 268490003
// RepeatOperationError 错误码 268490004、重复操作赠送和代币支付相关接口会返回表示之前的操作已经成功
RepeatOperationError ErrCode = 268490004
// OrderRefundedError 错误码 268490005、订单已经通过 cancel_currency_pay 接口退款,不支持再退款
OrderRefundedError ErrCode = 268490005
// InsufficientBalanceError 错误码 268490006、代币的退款/支付操作金额不足
InsufficientBalanceError ErrCode = 268490006
// SensitiveContentError 错误码 268490007、图片或文字存在敏感内容禁止使用
SensitiveContentError ErrCode = 268490007
// TokenNotPublishedError 错误码 268490008、代币未发布不允许进行代币操作
TokenNotPublishedError ErrCode = 268490008
// SessionKeyExpiredError 错误码 268490009、用户 session_key 不存在或已过期,请重新登录
SessionKeyExpiredError ErrCode = 268490009
// BillGeneratingError 错误码 268490011、账单数据生成中请稍后调用本接口获取
BillGeneratingError ErrCode = 268490011
)
const (
// OrderStatusInit 订单状态 当前状态 0-订单初始化(未创建成功,不可用于支付)
OrderStatusInit OrderStatus = 0
// OrderStatusCreated 订单状态 当前状态 1-订单创建成功
OrderStatusCreated OrderStatus = 1
// OrderStatusPaid 订单状态 当前状态 2-订单已经支付,待发货
OrderStatusPaid OrderStatus = 2
// OrderStatusDelivering 订单状态 当前状态 3-订单发货中
OrderStatusDelivering OrderStatus = 3
// OrderStatusDelivered 订单状态 当前状态 4-订单已发货
OrderStatusDelivered OrderStatus = 4
// OrderStatusRefunded 订单状态 当前状态 5-订单已经退款
OrderStatusRefunded OrderStatus = 5
// OrderStatusClosed 订单状态 当前状态 6-订单已经关闭(不可再使用)
OrderStatusClosed OrderStatus = 6
// OrderStatusRefundFailed 订单状态 当前状态 7-订单退款失败
OrderStatusRefundFailed OrderStatus = 7
)
const (
// baseSite 基础网址
baseSite = "https://api.weixin.qq.com"
// queryUserBalance 查询虚拟支付余额
queryUserBalance = "/xpay/query_user_balance"
// currencyPay 扣减代币(一般用于代币支付)
currencyPay = "/xpay/currency_pay"
// queryOrder 查询创建的订单(现金单,非代币单)
queryOrder = "/xpay/query_order"
// cancelCurrencyPay 代币支付退款 (currency_pay 接口的逆操作)
cancelCurrencyPay = "/xpay/cancel_currency_pay"
// notifyProvideGoods 通知已经发货完成(只能通知现金单),正常通过 xpay_goods_deliver_notify 消息推送返回成功就不需要调用这个 api 接口。这个接口用于异常情况推送不成功时手动将单改成已发货状态
notifyProvideGoods = "/xpay/notify_provide_goods"
// presentCurrency 代币赠送接口,由于目前不支付按单号查赠送单的功能,所以当需要赠送的时候可以一直重试到返回 0 或者返回 268490004重复操作为止
presentCurrency = "/xpay/present_currency"
// downloadBill 下载账单
downloadBill = "/xpay/download_bill"
// refundOrder 退款 对使用 jsapi 接口下的单进行退款
refundOrder = "/xpay/refund_order"
// createWithdrawOrder 创建提现单
createWithdrawOrder = "/xpay/create_withdraw_order"
// queryWithdrawOrder 查询提现单
queryWithdrawOrder = "/xpay/query_withdraw_order"
// startUploadGoods 启动批量上传道具任务
startUploadGoods = "/xpay/start_upload_goods"
// queryUploadGoods 查询批量上传道具任务状态
queryUploadGoods = "/xpay/query_upload_goods"
// startPublishGoods 启动批量发布道具任务
startPublishGoods = "/xpay/start_publish_goods"
// queryPublishGoods 查询批量发布道具任务状态
queryPublishGoods = "/xpay/query_publish_goods"
)
const (
// signature user mode signature
signature = "signature"
// paySignature payment signature
paySignature = "pay_sig"
// accessToken access_token authorization tokens
accessToken = "access_token"
// EmptyString empty string
EmptyString = ""
)

View File

@@ -0,0 +1,32 @@
/*
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* You can obtain one at https://github.com/silenceper/wechat.
*
*/
// Package virtualpayment mini program virtual payment
package virtualpayment
import (
"github.com/silenceper/wechat/v2/miniprogram/context"
)
// NewVirtualPayment 实例化小程序虚拟支付 API
func NewVirtualPayment(ctx *context.Context) *VirtualPayment {
return &VirtualPayment{
ctx: ctx,
}
}

View File

@@ -0,0 +1,427 @@
/*
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* You can obtain one at https://github.com/silenceper/wechat.
*
*/
package virtualpayment
import (
"github.com/silenceper/wechat/v2/miniprogram/context"
"github.com/silenceper/wechat/v2/util"
)
// VirtualPayment mini program virtual payment
// https://developers.weixin.qq.com/miniprogram/dev/platform-capabilities/industry/virtual-payment.html#_2-3-%E6%9C%8D%E5%8A%A1%E5%99%A8API
type VirtualPayment struct {
ctx *context.Context
sessionKey string
}
// Env Environment 0 - Production environment 1 - Sandbox environment
type Env int
// ErrCode error code
type ErrCode int
// OrderStatus 订单状态
type OrderStatus int
// CommonRequest common request parameters
type CommonRequest struct {
OpenID string `json:"openid"` // The user's openID
Env Env `json:"env"` // Environment 0 - Production environment 1 - Sandbox environment
}
// PaymentRequest payment request parameters
type PaymentRequest struct {
SignData string `json:"sign_data"` // 具体支付参数见 signData, 该参数需以 string 形式传递,例如 signData: '{"offerId":"123","buyQuantity":1,"env":0,"currencyType":"CNY","platform":"android","productId":"testproductId","goodsPrice":10,"outTradeNo":"xxxxxx","attach":"testdata"}'
Mode string `json:"mode"` // 支付模式枚举值short_series_goods: 道具直购short_series_coin: 代币充值
PaySig string `json:"pay_sig"` // 支付签名,具体生成方式见下方说明
Signature string `json:"signature"` // 用户态签名,具体生成方式见下方说明
}
// SignData 签名数据
type SignData struct {
OfferID string `json:"offerId"` // 在米大师侧申请的应用 id, mp-支付基础配置中的 offerid
BuyQuantity int `json:"buyQuantity"` // 购买数量
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
CurrencyType string `json:"currencyType"` // 币种 默认值CNY 人民币
Platform string `json:"platform,omitempty"` // 申请接入时的平台platform 与应用 id 有关 默认值android 安卓平台
ProductID string `json:"productId,omitempty"` // 道具 ID, **该字段仅 mode=short_series_goods 时可用**
GoodsPrice int `json:"goodsPrice"` // 道具单价 (分), **该字段仅 mode=short_series_goods 时可用**, 用来校验价格与后台道具价格是否一致,避免用户在业务商城页看到的价格与实际价格不一致导致投诉
OutTradeNo string `json:"outTradeNo"` // 业务订单号,每个订单号只能使用一次,重复使用会失败 (极端情况不保证唯一,不建议业务强依赖唯一性). 要求 8-32 个字符内,只能是数字、大小写字母、符号 _-|*@组成,不能以下划线 (_) 开头
Attach string `json:"attach"` // 透传数据,发货通知时会透传给开发者
}
// QueryUserBalanceRequest 查询用户代币余额,请求参数
// 1. 需要用户态签名与支付签名
// POST请求参数为 json 字符串Content-Type 为 application/json
type QueryUserBalanceRequest struct {
CommonRequest
UserIP string `json:"user_ip"` // 用户 ip例如:1.1.1.1
}
// QueryUserBalanceResponse 查询虚拟支付余额 响应参数
type QueryUserBalanceResponse struct {
util.CommonError
Balance int `json:"balance"` // 代币总余额,包括有价和赠送部分
PresentBalance int `json:"present_balance"` // 赠送账户的代币余额
SumSave int `json:"sum_save"` // 累计有价货币充值数量
SumPresent int `json:"sum_present"` // 累计赠送无价货币数量
SumBalance int `json:"sum_balance"` // 历史总增加的代币金额
SumCost int `json:"sum_cost"` // 历史总消耗代币金额
FirstSaveFlag int `json:"first_save_flag"` // 是否满足首充活动标记。0:不满足。1:满足
}
// CurrencyPayRequest 扣减代币(一般用于代币支付)
// 1. 需要用户态签名与支付签名
// POST请求参数为 json 字符串Content-Type 为 application/json
type CurrencyPayRequest struct {
CommonRequest
UserIP string `json:"user_ip"` // 用户 ip例如1.1.1.1
Amount int `json:"amount"` // 支付的代币数量
OrderID string `json:"order_id"` // 商户订单号,需要保证唯一性
PayItem string `json:"payitem"` // 物品信息。记录到账户流水中。如:[{"productid":"物品 id", "unit_price": 单价,"quantity": 数量}]
Remark string `json:"remark"` // 备注信息。需要在账单中展示
DeviceType string `json:"device_type"` // 平台类型 1-安卓 2-苹果
}
// PayItem 物品信息
type PayItem struct {
ProductID string `json:"productid"` // 物品 id
UnitPrice int `json:"unit_price"` // 单价
Quantity int `json:"quantity"` // 数量
}
// CurrencyPayResponse 扣减代币(一般用于代币支付)响应参数
type CurrencyPayResponse struct {
util.CommonError
OrderID string `json:"order_id"` // 商户订单号
Balance int `json:"balance"` // 总余额,包括有价和赠送部分
UsedPresentAmount int `json:"used_present_amount"` // 使用赠送部分的代币数量
}
// QueryOrderRequest 查询创建的订单(现金单,非代币单),请求参数
// 1. 使用支付签名
// POST请求参数为 json 字符串Content-Type 为 application/json
type QueryOrderRequest struct {
CommonRequest
OrderID string `json:"order_id,omitempty"` // 商户订单号 创建的订单号
WxOrderID string `json:"wx_order_id,omitempty"` // 微信内部单号 (与 order_id 二选一)
}
// OrderItem 订单信息
type OrderItem struct {
OrderID string `json:"order_id"` // 商户订单号
CreateTime int64 `json:"create_time"` // 订单创建时间
UpdateTime int64 `json:"update_time"` // 订单更新时间
Status OrderStatus `json:"status"` // 订单状态 当前状态 0-订单初始化未创建成功不可用于支付1-订单创建成功 2-订单已经支付,待发货 3-订单发货中 4-订单已发货 5-订单已经退款 6-订单已经关闭不可再使用7-订单退款失败
BizType int `json:"biz_type"` // 业务类型 0-短剧
OrderFee int `json:"order_fee"` // 订单金额,单位:分
CouponFee int `json:"coupon_fee"` // 优惠金额,单位:分
PaidFee int `json:"paid_fee"` // 用户支付金额,单位:分
OrderType int `json:"order_type"` // 订单类型 0-支付单 1-退款单
RefundFee int `json:"refund_fee"` // 当类型为退款单时表示退款金额,单位分
PaidTime int64 `json:"paid_time"` // 支付/退款时间unix秒级时间戳
ProvideTime int64 `json:"provide_time"` // 发货时间unix 秒级时间戳
BizMeta string `json:"biz_meta"` // 业务自定义数据 订单创建时传的信息
EnvType int `json:"env_type"` // 环境类型 1-现网 2-沙箱
Token string `json:"token"` // 下单时米大师返回的 token
LeftFee int `json:"left_fee"` // 支付单类型时表示此单经过退款还剩余的金额,单位:分
WxOrderID string `json:"wx_order_id"` // 微信内部单号
ChannelOrderID string `json:"channel_order_id"` // 渠道订单号,为用户微信支付详情页面上的商户单号
WxPayOrderID string `json:"wxpay_order_id"` // 微信支付交易单号,为用户微信支付详情页面上的交易单号
}
// QueryOrderResponse 查询创建的订单(现金单,非代币单)响应参数
type QueryOrderResponse struct {
util.CommonError
Order *OrderItem `json:"order"` // 订单信息
}
// CancelCurrencyPayRequest 取消订单(现金单,非代币单),请求参数
// 1. 使用支付签名
// POST请求参数为 json 字符串Content-Type 为 application/json
type CancelCurrencyPayRequest struct {
CommonRequest
UserIP string `json:"user_ip"` // 用户 ip例如1.1.1.1
PayOrderID string `json:"pay_order_id"` // 支付单号 代币支付 (调用 currency_pay 接口时) 时传的 order_id
OrderID string `json:"order_id"` // 本次退款单的单号
Amount int `json:"amount"` // 退款金额
DeviceType int `json:"device_type"` // 平台类型 1-安卓 2-苹果
}
// CancelCurrencyPayResponse 取消订单(现金单,非代币单)响应参数
type CancelCurrencyPayResponse struct {
util.CommonError
OrderID string `json:"order_id"` // 退款订单号
}
// NotifyProvideGoodsRequest 通知发货,请求参数
// 通知已经发货完成(只能通知现金单),正常通过 xpay_goods_deliver_notify 消息推送返回成功就不需要调用这个 api 接口。这个接口用于异常情况推送不成功时手动将单改成已发货状态
// 1. 使用支付签名
// POST请求参数为 json 字符串Content-Type 为 application/json
type NotifyProvideGoodsRequest struct {
OrderID string `json:"order_id,omitempty"` // 商户订单号 下单时传的单号
WxOrderID string `json:"wx_order_id,omitempty"` // 微信内部单号 (与 order_id 二选一)
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
}
// NotifyProvideGoodsResponse 通知发货响应参数
type NotifyProvideGoodsResponse struct {
util.CommonError
}
// PresentCurrencyRequest 赠送代币,请求参数
// 代币赠送接口,由于目前不支付按单号查赠送单的功能,所以当需要赠送的时候可以一直重试到返回 0 或者返回 268490004重复操作为止
// 1. 需要用户态签名与支付签名
// POST请求参数为 json 字符串Content-Type 为 application/json
type PresentCurrencyRequest struct {
CommonRequest
OrderID string `json:"order_id"` // 赠送单号,商户订单号,需要保证唯一性
Amount int `json:"amount"` // 赠送的代币数量
DeviceType string `json:"device_type"` // 平台类型 1-安卓 2-苹果
}
// PresentCurrencyResponse 赠送代币响应参数
type PresentCurrencyResponse struct {
util.CommonError
Balance int `json:"balance"` // 赠送后用户的代币余额
OrderID string `json:"order_id"` // 赠送单号
PresentBalance int `json:"present_balance"` // 用户收到的总赠送金额
}
// DownloadBillRequest 下载账单,请求参数
// 用于下载小程序账单,第一次调用触发生成下载 url可以间隔轮训来获取最终生成的下载 url。账单中金额相关字段是以分为单位。
// 1. 使用支付签名
// POST请求参数为 json 字符串Content-Type 为 application/json
type DownloadBillRequest struct {
BeginDs string `json:"begin_ds"` // 账单开始日期,格式为 yyyymmdd 起始时间(如 20230801
EndDs string `json:"end_ds"` // 账单结束日期,格式为 yyyymmdd 结束时间(如 20230801
}
// DownloadBillResponse 下载账单响应参数
type DownloadBillResponse struct {
util.CommonError
URL string `json:"url"` // 账单下载地址
}
// RefundOrderRequest 退款,请求参数
// 对使用 jsapi 接口下的单进行退款
// 1. 使用支付签名
// POST请求参数为 json 字符串Content-Type 为 application/json
type RefundOrderRequest struct {
CommonRequest
OrderID string `json:"order_id"` // 商户订单号,需要保证唯一性
WxOrderID string `json:"wx_order_id"` // 微信内部单号 (与 order_id 二选一)
RefundOrderID string `json:"refund_order_id"` // 退款单号,本次退款时需要传的单号,长度为 [8,32],字符只允许使用字母、数字、'_'、'-'
LeftFee int `json:"left_fee"` // 退款金额,单位:分 当前单剩余可退金额,单位分,可以通过调用 query_order 接口查到
RefundFee int `json:"refund_fee"` // 退款金额,单位:分 需要 (0,left_fee] 之间
BizMeta string `json:"biz_meta"` // 商家自定义数据,传入后可在 query_order 接口查询时原样返回,长度需要 [0,1024]
RefundReason string `json:"refund_reason"` // 退款原因,当前仅支持以下值 0-暂无描述 1-产品问题,影响使用或效果不佳 2-售后问题,无法满足需求 3-意愿问题,用户主动退款 4-价格问题 5:其他原因
ReqFrom string `json:"req_from"` // 退款来源,当前仅支持以下值 1-人工客服退款,即用户电话给客服,由客服发起退款流程 2-用户自己发起退款流程 3-其它
}
// RefundOrderResponse 退款响应参数
type RefundOrderResponse struct {
util.CommonError
RefundOrderID string `json:"refund_order_id"` // 退款单号
RefundWxOrderID string `json:"refund_wx_order_id"` // 退款单的微信侧单号
PayOrderID string `json:"pay_order_id"` // 该退款单对应的支付单单号
PayWxOrderID string `json:"pay_wx_order_id"` // 该退款单对应的支付单微信侧单号
}
// CreateWithdrawOrderRequest 创建提现单,请求参数
// 1. 使用支付签名
// POST请求参数为 json 字符串Content-Type 为 application/json
type CreateWithdrawOrderRequest struct {
WithdrawNO string `json:"withdraw_no"` // 提现单单号,长度为 [8,32],字符只允许使用字母、数字、'_'、'-'
WithdrawAmount string `json:"withdraw_amount"` // 提现的金额,单位元,例如提现 1 分钱请使用 0.01
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
}
// CreateWithdrawOrderResponse 创建提现单响应参数
type CreateWithdrawOrderResponse struct {
util.CommonError
WithdrawNO string `json:"withdraw_no"` // 提现单单号
WxWithdrawNO string `json:"wx_withdraw_no"` // 提现单的微信侧单号
}
// QueryWithdrawOrderRequest 查询提现单,请求参数
// 1. 使用支付签名
// POST请求参数为 json 字符串Content-Type 为 application/json
type QueryWithdrawOrderRequest struct {
WithdrawNO string `json:"withdraw_no"` // 提现单单号,长度为 [8,32],字符只允许使用字母、数字、'_'、'-' (与 wx_withdraw_no 二选一)
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
}
// QueryWithdrawOrderResponse 查询提现单响应参数
type QueryWithdrawOrderResponse struct {
util.CommonError
WithdrawNO string `json:"withdraw_no"` // 提现单单号
Status int `json:"status"` // 提现单的微信侧单号 1-创建成功,提现中 2-提现成功 3-提现失败
WithdrawAmount string `json:"withdraw_amount"` // 提现的金额,单位元,例如提现 1 分钱请使用 0.01
WxWithdrawNo string `json:"wx_withdraw_no"` // 提现单的微信侧单号
WithdrawSuccessTimestamp int64 `json:"withdraw_success_timestamp"` // 提现单成功的秒级时间戳unix 秒级时间戳
CreateTime string `json:"create_time"` // 提现单创建时间
FailReason string `json:"failReason"` // 提现失败的原因
}
// StartUploadGoodsRequest 启动批量上传道具任务,请求参数
// 1. 使用支付签名
// POST请求参数为 json 字符串Content-Type 为 application/json
type StartUploadGoodsRequest struct {
UploadItem []*UploadItem `json:"upload_item"` // 道具信息
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
}
// UploadItem 道具信息
type UploadItem struct {
ID string `json:"id"` // 道具 id长度 (0,64],字符只允许使用字母、数字、'_'、'-'
Name string `json:"name"` // 道具名称,长度 (0,1024]
Price int `json:"price"` // 道具单价,单位分,需要大于 0
Remark string `json:"remark"` // 道具备注,长度 (0,1024]
ItemURL string `json:"item_url"` // 道具图片的 url 地址,当前仅支持 jpg,png 等格式
UploadStatus int `json:"upload_status,omitempty"` // 上传状态 0-上传中 1-id 已经存在 2-上传成功 3-上传失败
ErrMsg string `json:"errmsg,omitempty"` // 上传失败的原因
}
// StartUploadGoodsResponse 启动批量上传道具任务响应参数
type StartUploadGoodsResponse struct {
util.CommonError
}
// QueryUploadGoodsRequest 查询批量上传道具任务,请求参数
// 1. 使用支付签名
// POST请求参数为 json 字符串Content-Type 为 application/json
type QueryUploadGoodsRequest struct {
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
}
// QueryUploadGoodsResponse 查询批量上传道具任务响应参数
type QueryUploadGoodsResponse struct {
util.CommonError
UploadItem []*UploadItem `json:"upload_item"` // 道具信息列表
Status int `json:"status"` // 任务状态 0-无任务在运行 1-任务运行中 2-上传失败或部分失败上传任务已经完成3-上传成功
}
// StartPublishGoodsRequest 启动批量发布道具任务,请求参数
// 1. 使用支付签名
// POST请求参数为 json 字符串Content-Type 为 application/json
type StartPublishGoodsRequest struct {
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
PublishItem []*PublishItem `json:"publish_item"` // 道具信息 发布的商品列表
}
// PublishItem 道具信息
type PublishItem struct {
ID string `json:"id"` // 道具 id添加到开发环境时传的道具 id长度 (0,64],字符只允许使用字母、数字、'_'、'-'
PublishStatus int `json:"publish_status,omitempty"` // 发布状态 0-上传中 1-id 已经存在 2-发布成功 3-发布失败
ErrMsg string `json:"errmsg,omitempty"` // 发布失败的原因
}
// StartPublishGoodsResponse 启动批量发布道具任务响应参数
type StartPublishGoodsResponse struct {
util.CommonError
}
// QueryPublishGoodsRequest 查询批量发布道具任务,请求参数
// 1. 使用支付签名
// POST请求参数为 json 字符串Content-Type 为 application/json
type QueryPublishGoodsRequest struct {
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
}
// QueryPublishGoodsResponse 查询批量发布道具任务响应参数
type QueryPublishGoodsResponse struct {
util.CommonError
PublishItem []*PublishItem `json:"publish_item"` // 道具信息列表
Status int `json:"status"` // 任务状态 0-无任务在运行 1-任务运行中 2-上传失败或部分失败上传任务已经完成3-上传成功
}
// AsyncXPayGoodsDeliverNotifyRequest 异步通知发货,请求参数
// 1. 使用支付签名
// POST请求参数为 json 字符串Content-Type 为 application/json
type AsyncXPayGoodsDeliverNotifyRequest struct {
ToUserName string `json:"ToUserName"` // 小程序的原始 ID
FromUserName string `json:"FromUserName"` // 发送方帐号(一个 OpenID该事件消息的 openid道具发货场景固定为微信官方的 openid
CreateTime int `json:"CreateTime"` // 消息发送时间(整型)
MsgType string `json:"MsgType"` // 消息类型此时固定为event
Event string `json:"Event"` // 事件类型此时固定为xpay_goods_deliver_notify
Openid string `json:"openid"` // 用户 openid
OutTradeNo string `json:"OutTradeNo"` // 业务订单号
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
WechatPayInfo *WeChatPayInfo `json:"WechatPayInfo"` // 微信支付订单信息
GoodsInfo *GoodsInfo `json:"GoodsInfo"` // 道具信息
}
// WeChatPayInfo 微信支付信息 非微信支付渠道可能没有
type WeChatPayInfo struct {
MchOrderNo string `json:"MchOrderNo"` // 商户订单号
TransactionID string `json:"TransactionId"` // 微信支付订单号
}
// GoodsInfo 道具参数信息
type GoodsInfo struct {
ProductID string `json:"ProductId"` // 道具 ID
Quantity int `json:"Quantity"` // 数量
OrigPrice int `json:"OrigPrice"` // 物品原始价格(单位:分)
ActualPrice int `json:"ActualPrice"` // 物品实际支付价格(单位:分)
Attach string `json:"Attach"` // 透传信息
}
// AsyncXPayGoodsDeliverNotifyResponse 异步通知发货响应参数
type AsyncXPayGoodsDeliverNotifyResponse struct {
util.CommonError
}
// AsyncXPayCoinPayNotifyRequest 异步通知代币支付推送,请求参数
type AsyncXPayCoinPayNotifyRequest struct {
ToUserName string `json:"ToUserName"` // 小程序的原始 ID
FromUserName string `json:"FromUserName"` // 发送方帐号(一个 OpenID该事件消息的 openid道具发货场景固定为微信官方的 openid
CreateTime int `json:"CreateTime"` // 消息发送时间(整型)
MsgType string `json:"MsgType"` // 消息类型此时固定为event
Event string `json:"Event"` // 事件类型此时固定为xpay_goods_deliver_notify
Openid string `json:"openid"` // 用户 openid
OutTradeNo string `json:"OutTradeNo"` // 业务订单号
Env Env `json:"env"` // 环境 0-正式环境 1-沙箱环境
WechatPayInfo *WeChatPayInfo `json:"WechatPayInfo"` // 微信支付订单信息
CoinInfo *CoinInfo `json:"GoodsInfo"` // 道具信息
}
// CoinInfo 代币信息
type CoinInfo struct {
Quantity int `json:"Quantity"` // 数量
OrigPrice int `json:"OrigPrice"` // 物品原始价格(单位:分)
ActualPrice int `json:"ActualPrice"` // 物品实际支付价格(单位:分)
Attach string `json:"Attach"` // 透传信息
}
// AsyncXPayCoinPayNotifyResponse 异步通知代币支付推送响应参数
type AsyncXPayCoinPayNotifyResponse struct {
util.CommonError
}
// URLParams url parameter
type URLParams struct {
Path string `json:"path"`
AccessToken string `json:"access_token"`
PaySign string `json:"paySign"`
Signature string `json:"signature"`
Content string `json:"content"`
}

View File

@@ -0,0 +1,516 @@
/*
* Copyright silenceper/wechat Author(https://silenceper.com/wechat/). All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* You can obtain one at https://github.com/silenceper/wechat.
*
*/
package virtualpayment
import (
"context"
"crypto/hmac"
"crypto/sha256"
"encoding/hex"
"encoding/json"
"errors"
"strings"
"github.com/silenceper/wechat/v2/util"
)
// SetSessionKey 设置 sessionKey
func (s *VirtualPayment) SetSessionKey(sessionKey string) {
s.sessionKey = sessionKey
}
// QueryUserBalance 查询虚拟支付余额
func (s *VirtualPayment) QueryUserBalance(ctx context.Context, in *QueryUserBalanceRequest) (out QueryUserBalanceResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
}
var (
params = URLParams{
Path: queryUserBalance,
Content: string(jsonByte),
}
address string
)
if address, err = s.requestAddress(params); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "QueryUserBalance")
return
}
// CurrencyPay currency pay 扣减代币(一般用于代币支付)
func (s *VirtualPayment) CurrencyPay(ctx context.Context, in *CurrencyPayRequest) (out CurrencyPayResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
}
var (
params = URLParams{
Path: currencyPay,
Content: string(jsonByte),
}
address string
)
if address, err = s.requestAddress(params); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "CurrencyPay")
return
}
// QueryOrder 查询创建的订单(现金单,非代币单)
func (s *VirtualPayment) QueryOrder(ctx context.Context, in *QueryOrderRequest) (out QueryOrderResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
}
var (
params = URLParams{
Path: queryOrder,
Signature: EmptyString,
Content: string(jsonByte),
}
address string
)
if address, err = s.requestAddress(params); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "QueryOrder")
return
}
// CancelCurrencyPay 取消订单 代币支付退款 (currency_pay 接口的逆操作)
func (s *VirtualPayment) CancelCurrencyPay(ctx context.Context, in *CancelCurrencyPayRequest) (out CancelCurrencyPayResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
}
var (
params = URLParams{
Path: cancelCurrencyPay,
Content: string(jsonByte),
}
address string
)
if address, err = s.requestAddress(params); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "CancelCurrencyPay")
return
}
// NotifyProvideGoods 通知发货
// 通知已经发货完成(只能通知现金单),正常通过 xpay_goods_deliver_notify 消息推送返回成功就不需要调用这个 api 接口。这个接口用于异常情况推送不成功时手动将单改成已发货状态
func (s *VirtualPayment) NotifyProvideGoods(ctx context.Context, in *NotifyProvideGoodsRequest) (out NotifyProvideGoodsResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
}
var (
params = URLParams{
Path: notifyProvideGoods,
Content: string(jsonByte),
Signature: EmptyString,
}
address string
)
if address, err = s.requestAddress(params); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "NotifyProvideGoods")
return
}
// PresentCurrency 代币赠送接口,由于目前不支付按单号查赠送单的功能,所以当需要赠送的时候可以一直重试到返回 0 或者返回 268490004重复操作为止
func (s *VirtualPayment) PresentCurrency(ctx context.Context, in *PresentCurrencyRequest) (out PresentCurrencyResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
}
var (
params = URLParams{
Path: presentCurrency,
Content: string(jsonByte),
Signature: EmptyString,
}
address string
)
if address, err = s.requestAddress(params); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "PresentCurrency")
return
}
// DownloadBill 下载订单交易账单
func (s *VirtualPayment) DownloadBill(ctx context.Context, in *DownloadBillRequest) (out DownloadBillResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
}
var (
params = URLParams{
Path: downloadBill,
Content: string(jsonByte),
Signature: EmptyString,
}
address string
)
if address, err = s.requestAddress(params); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "DownloadBill")
return
}
// RefundOrder 退款 对使用 jsapi 接口下的单进行退款
func (s *VirtualPayment) RefundOrder(ctx context.Context, in *RefundOrderRequest) (out RefundOrderResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
}
var (
params = URLParams{
Path: refundOrder,
Content: string(jsonByte),
Signature: EmptyString,
}
address string
)
if address, err = s.requestAddress(params); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "RefundOrder")
return
}
// CreateWithdrawOrder 创建提现单
func (s *VirtualPayment) CreateWithdrawOrder(ctx context.Context, in *CreateWithdrawOrderRequest) (out CreateWithdrawOrderResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
}
var (
params = URLParams{
Path: createWithdrawOrder,
Content: string(jsonByte),
Signature: EmptyString,
}
address string
)
if address, err = s.requestAddress(params); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "CreateWithdrawOrder")
return
}
// QueryWithdrawOrder 查询提现单
func (s *VirtualPayment) QueryWithdrawOrder(ctx context.Context, in *QueryWithdrawOrderRequest) (out QueryWithdrawOrderResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
}
var (
params = URLParams{
Path: queryWithdrawOrder,
Content: string(jsonByte),
Signature: EmptyString,
}
address string
)
if address, err = s.requestAddress(params); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "QueryWithdrawOrder")
return
}
// StartUploadGoods 开始上传商品
func (s *VirtualPayment) StartUploadGoods(ctx context.Context, in *StartUploadGoodsRequest) (out StartUploadGoodsResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
}
var (
params = URLParams{
Path: startUploadGoods,
Content: string(jsonByte),
Signature: EmptyString,
}
address string
)
if address, err = s.requestAddress(params); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "StartUploadGoods")
return
}
// QueryUploadGoods 查询上传商品
func (s *VirtualPayment) QueryUploadGoods(ctx context.Context, in *QueryUploadGoodsRequest) (out QueryUploadGoodsResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
}
var (
params = URLParams{
Path: queryUploadGoods,
Content: string(jsonByte),
Signature: EmptyString,
}
address string
)
if address, err = s.requestAddress(params); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "QueryUploadGoods")
return
}
// StartPublishGoods 开始发布商品
func (s *VirtualPayment) StartPublishGoods(ctx context.Context, in *StartPublishGoodsRequest) (out StartPublishGoodsResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
}
var (
params = URLParams{
Path: startPublishGoods,
Content: string(jsonByte),
Signature: EmptyString,
}
address string
)
if address, err = s.requestAddress(params); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "StartPublishGoods")
return
}
// QueryPublishGoods 查询发布商品
func (s *VirtualPayment) QueryPublishGoods(ctx context.Context, in *QueryPublishGoodsRequest) (out QueryPublishGoodsResponse, err error) {
var jsonByte []byte
if jsonByte, err = json.Marshal(in); err != nil {
return
}
var (
params = URLParams{
Path: queryPublishGoods,
Content: string(jsonByte),
Signature: EmptyString,
}
address string
)
if address, err = s.requestAddress(params); err != nil {
return
}
var response []byte
if response, err = util.PostJSONContext(ctx, address, in); err != nil {
return
}
// 使用通用方法返回错误
err = util.DecodeWithError(response, &out, "QueryPublishGoods")
return
}
// hmacSha256 hmac sha256
func (s *VirtualPayment) hmacSha256(key, data string) string {
h := hmac.New(sha256.New, []byte(key))
h.Write([]byte(data))
return hex.EncodeToString(h.Sum(nil))
}
// PaySign pay sign
func (s *VirtualPayment) PaySign(url, data string) (string, error) {
if strings.TrimSpace(s.ctx.Config.AppKey) == "" {
return "", errors.New("appKey is empty")
}
return s.hmacSha256(s.ctx.Config.AppKey, url+"&"+data), nil
}
// Signature user signature
func (s *VirtualPayment) Signature(data string) (string, error) {
if strings.TrimSpace(s.sessionKey) == "" {
return "", errors.New("sessionKey is empty")
}
return s.hmacSha256(s.sessionKey, data), nil
}
// PaySignature pay sign and signature
func (s *VirtualPayment) PaySignature(url, data string) (paySign, signature string, err error) {
if paySign, err = s.PaySign(url, data); err != nil {
return
}
if signature, err = s.Signature(data); err != nil {
return
}
return
}
// requestURL .组合 URL
func (s *VirtualPayment) requestAddress(params URLParams) (url string, err error) {
switch params.Path {
case queryUserBalance:
case currencyPay:
case cancelCurrencyPay:
if params.PaySign, params.Signature, err = s.PaySignature(params.Path, params.Content); err != nil {
return
}
case queryOrder:
case notifyProvideGoods:
case presentCurrency:
case downloadBill:
case refundOrder:
case createWithdrawOrder:
case queryWithdrawOrder:
case startUploadGoods:
case queryUploadGoods:
case startPublishGoods:
case queryPublishGoods:
if params.PaySign, err = s.PaySign(params.Path, params.Content); err != nil {
return
}
default:
err = errors.New("path is not exist")
return
}
if params.AccessToken, err = s.ctx.GetAccessToken(); err != nil {
return
}
url = baseSite + params.Path + "?" + accessToken + "=" + params.AccessToken
if params.PaySign != EmptyString {
url += "&" + paySignature + "=" + params.PaySign
}
if params.Signature != EmptyString {
url += "&" + signature + "=" + params.Signature
}
return
}

View File

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

View File

@@ -79,6 +79,10 @@ type sendRequest struct {
Mpnews map[string]interface{} `json:"mpnews,omitempty"` Mpnews map[string]interface{} `json:"mpnews,omitempty"`
// 发送语音 // 发送语音
Voice map[string]interface{} `json:"voice,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"` Images *Image `json:"images,omitempty"`
// 发送卡券 // 发送卡券
@@ -183,7 +187,13 @@ func (broadcast *Broadcast) SendImage(user *User, images *Image) (*Result, error
ToUser: nil, ToUser: nil,
MsgType: MsgTypeImage, 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) req, sendURL := broadcast.chooseTagOrOpenID(user, req)
url := fmt.Sprintf("%s?access_token=%s", sendURL, ak) url := fmt.Sprintf("%s?access_token=%s", sendURL, ak)
data, err := util.PostJSON(url, req) data, err := util.PostJSON(url, req)
@@ -205,7 +215,7 @@ func (broadcast *Broadcast) SendVideo(user *User, mediaID string, title, descrip
ToUser: nil, ToUser: nil,
MsgType: MsgTypeVideo, MsgType: MsgTypeVideo,
} }
req.Voice = map[string]interface{}{ req.Mpvideo = map[string]interface{}{
"media_id": mediaID, "media_id": mediaID,
"title": title, "title": title,
"description": description, "description": description,

View File

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

View File

@@ -72,11 +72,7 @@ func (csm *Manager) List() (customerServiceList []*KeFuInfo, err error) {
} }
var res resKeFuList var res resKeFuList
err = util.DecodeWithError(response, &res, "ListCustomerService") err = util.DecodeWithError(response, &res, "ListCustomerService")
if err != nil { return res.KfList, err
return
}
customerServiceList = res.KfList
return
} }
// KeFuOnlineInfo 客服在线信息 // KeFuOnlineInfo 客服在线信息
@@ -107,11 +103,7 @@ func (csm *Manager) OnlineList() (customerServiceOnlineList []*KeFuOnlineInfo, e
} }
var res resKeFuOnlineList var res resKeFuOnlineList
err = util.DecodeWithError(response, &res, "ListOnlineCustomerService") err = util.DecodeWithError(response, &res, "ListOnlineCustomerService")
if err != nil { return res.KfOnlineList, err
return
}
customerServiceOnlineList = res.KfOnlineList
return
} }
// Add 添加客服账号 // 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()) uri := fmt.Sprintf("%s?%s", publisherURL, v.Encode())
response, err = util.HTTPGet(uri) response, err = util.HTTPGet(uri)
if err != nil {
return
}
return return
} }

View File

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

View File

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

View File

@@ -1,6 +1,7 @@
package js package js
import ( import (
context2 "context"
"fmt" "fmt"
"github.com/silenceper/wechat/v2/credential" "github.com/silenceper/wechat/v2/credential"
@@ -39,14 +40,31 @@ func (js *Js) SetJsTicketHandle(ticketHandle credential.JsTicketHandle) {
// GetConfig 获取jssdk需要的配置参数 // GetConfig 获取jssdk需要的配置参数
// uri 为当前网页地址 // uri 为当前网页地址
func (js *Js) GetConfig(uri string) (config *Config, err error) { 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 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 { if err != nil {
return return
} }
var ticketStr string 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 { if err != nil {
return 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) str := fmt.Sprintf("jsapi_ticket=%s&noncestr=%s&timestamp=%d&url=%s", ticketStr, nonceStr, timestamp, uri)
sigStr := util.Signature(str) sigStr := util.Signature(str)
config = new(Config)
config.AppID = js.AppID config.AppID = js.AppID
config.NonceStr = nonceStr config.NonceStr = nonceStr
config.Timestamp = timestamp config.Timestamp = timestamp

View File

@@ -4,6 +4,9 @@ import (
"encoding/json" "encoding/json"
"errors" "errors"
"fmt" "fmt"
"io"
"os"
"path"
"github.com/silenceper/wechat/v2/officialaccount/context" "github.com/silenceper/wechat/v2/officialaccount/context"
"github.com/silenceper/wechat/v2/util" "github.com/silenceper/wechat/v2/util"
@@ -27,7 +30,7 @@ const (
PermanentMaterialTypeImage PermanentMaterialType = "image" PermanentMaterialTypeImage PermanentMaterialType = "image"
// PermanentMaterialTypeVideo 永久素材视频类型video // PermanentMaterialTypeVideo 永久素材视频类型video
PermanentMaterialTypeVideo PermanentMaterialType = "video" PermanentMaterialTypeVideo PermanentMaterialType = "video"
// PermanentMaterialTypeVoice 永久素材语音类型 voice // PermanentMaterialTypeVoice 永久素材语音类型voice
PermanentMaterialTypeVoice PermanentMaterialType = "voice" PermanentMaterialTypeVoice PermanentMaterialType = "voice"
// PermanentMaterialTypeNews 永久素材图文类型news // PermanentMaterialTypeNews 永久素材图文类型news
PermanentMaterialTypeNews PermanentMaterialType = "news" PermanentMaterialTypeNews PermanentMaterialType = "news"
@@ -160,8 +163,8 @@ type resAddMaterial struct {
URL string `json:"url"` URL string `json:"url"`
} }
// AddMaterial 上传永久性素材(处理视频需要单独上传) // AddMaterialFromReader 上传永久性素材(处理视频需要单独上传),从 io.Reader 中读取
func (material *Material) AddMaterial(mediaType MediaType, filename string) (mediaID string, url string, err error) { func (material *Material) AddMaterialFromReader(mediaType MediaType, filePath string, reader io.Reader) (mediaID string, url string, err error) {
if mediaType == MediaTypeVideo { if mediaType == MediaTypeVideo {
err = errors.New("永久视频素材上传使用 AddVideo 方法") err = errors.New("永久视频素材上传使用 AddVideo 方法")
return 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) uri := fmt.Sprintf("%s?access_token=%s&type=%s", addMaterialURL, accessToken, mediaType)
// 获取文件名
filename := path.Base(filePath)
var response []byte var response []byte
response, err = util.PostFile("media", filename, uri) response, err = util.PostFileFromReader("media", filePath, filename, uri, reader)
if err != nil { if err != nil {
return return
} }
@@ -192,13 +197,24 @@ func (material *Material) AddMaterial(mediaType MediaType, filename string) (med
return 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 { type reqVideo struct {
Title string `json:"title"` Title string `json:"title"`
Introduction string `json:"introduction"` Introduction string `json:"introduction"`
} }
// AddVideo 永久视频素材文件上传 // AddVideoFromReader 永久视频素材文件上传,从 io.Reader 中读取
func (material *Material) AddVideo(filename, title, introduction string) (mediaID string, url string, err error) { func (material *Material) AddVideoFromReader(filePath, title, introduction string, reader io.Reader) (mediaID string, url string, err error) {
var accessToken string var accessToken string
accessToken, err = material.GetAccessToken() accessToken, err = material.GetAccessToken()
if err != nil { if err != nil {
@@ -216,16 +232,19 @@ func (material *Material) AddVideo(filename, title, introduction string) (mediaI
if err != nil { if err != nil {
return return
} }
fileName := path.Base(filePath)
fields := []util.MultipartFormField{ fields := []util.MultipartFormField{
{ {
IsFile: true, IsFile: true,
Fieldname: "media", Fieldname: "media",
Filename: filename, FilePath: filePath,
Filename: fileName,
FileReader: reader,
}, },
{ {
IsFile: false, IsFile: false,
Fieldname: "description", Fieldname: "description",
Filename: fileName,
Value: fieldValue, Value: fieldValue,
}, },
} }
@@ -250,6 +269,17 @@ func (material *Material) AddVideo(filename, title, introduction string) (mediaI
return 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 { type reqDeleteMaterial struct {
MediaID string `json:"media_id"` MediaID string `json:"media_id"`
} }
@@ -278,7 +308,7 @@ type ArticleList struct {
Item []ArticleListItem `json:"item"` Item []ArticleListItem `json:"item"`
} }
// ArticleListItem 用于ArticleListitem节点 // ArticleListItem 用于 ArticleListitem 节点
type ArticleListItem struct { type ArticleListItem struct {
MediaID string `json:"media_id"` MediaID string `json:"media_id"`
Content ArticleListContent `json:"content"` Content ArticleListContent `json:"content"`
@@ -287,14 +317,14 @@ type ArticleListItem struct {
UpdateTime int64 `json:"update_time"` UpdateTime int64 `json:"update_time"`
} }
// ArticleListContent 用于ArticleListItemcontent节点 // ArticleListContent 用于 ArticleListItemcontent 节点
type ArticleListContent struct { type ArticleListContent struct {
NewsItem []Article `json:"news_item"` NewsItem []Article `json:"news_item"`
UpdateTime int64 `json:"update_time"` UpdateTime int64 `json:"update_time"`
CreateTime int64 `json:"create_time"` CreateTime int64 `json:"create_time"`
} }
// reqBatchGetMaterial BatchGetMaterial请求参数 // reqBatchGetMaterial BatchGetMaterial 请求参数
type reqBatchGetMaterial struct { type reqBatchGetMaterial struct {
Type PermanentMaterialType `json:"type"` Type PermanentMaterialType `json:"type"`
Count int64 `json:"count"` Count int64 `json:"count"`
@@ -337,7 +367,7 @@ type ResMaterialCount struct {
NewsCount int64 `json:"news_count"` // 图文总数量 NewsCount int64 `json:"news_count"` // 图文总数量
} }
// GetMaterialCount 获取素材总数. // GetMaterialCount 获取素材总数
func (material *Material) GetMaterialCount() (res ResMaterialCount, err error) { func (material *Material) GetMaterialCount() (res ResMaterialCount, err error) {
var accessToken string var accessToken string
accessToken, err = material.GetAccessToken() accessToken, err = material.GetAccessToken()

View File

@@ -3,6 +3,7 @@ package material
import ( import (
"encoding/json" "encoding/json"
"fmt" "fmt"
"io"
"github.com/silenceper/wechat/v2/util" "github.com/silenceper/wechat/v2/util"
) )
@@ -62,6 +63,38 @@ func (material *Material) MediaUpload(mediaType MediaType, filename string) (med
return 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 返回临时素材的下载地址供用户自己处理 // GetMediaURL 返回临时素材的下载地址供用户自己处理
// NOTICE: URL 不可公开因为含access_token 需要立即另存文件 // NOTICE: URL 不可公开因为含access_token 需要立即另存文件
func (material *Material) GetMediaURL(mediaID string) (mediaURL string, err error) { func (material *Material) GetMediaURL(mediaID string) (mediaURL string, err error) {

View File

@@ -38,6 +38,7 @@ type CustomerMessage struct {
Wxcard *MediaWxcard `json:"wxcard,omitempty"` // 可选 Wxcard *MediaWxcard `json:"wxcard,omitempty"` // 可选
Msgmenu *MediaMsgmenu `json:"msgmenu,omitempty"` // 可选 Msgmenu *MediaMsgmenu `json:"msgmenu,omitempty"` // 可选
Miniprogrampage *MediaMiniprogrampage `json:"miniprogrampage,omitempty"` // 可选 Miniprogrampage *MediaMiniprogrampage `json:"miniprogrampage,omitempty"` // 可选
Mpnewsarticle *MediaArticle `json:"mpnewsarticle,omitempty"` // 可选
} }
// NewCustomerTextMessage 文本消息结构体构造方法 // NewCustomerTextMessage 文本消息结构体构造方法
@@ -97,6 +98,11 @@ type MediaResource struct {
MediaID string `json:"media_id"` MediaID string `json:"media_id"`
} }
// MediaArticle 消息使用的已发布文章id
type MediaArticle struct {
ArticleID string `json:"article_id"`
}
// MediaVideo 视频消息包含的内容 // MediaVideo 视频消息包含的内容
type MediaVideo struct { type MediaVideo struct {
MediaID string `json:"media_id"` MediaID string `json:"media_id"`

View File

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

View File

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

View File

@@ -29,11 +29,12 @@ func NewTemplate(context *context.Context) *Template {
// TemplateMessage 发送的模板消息内容 // TemplateMessage 发送的模板消息内容
type TemplateMessage struct { type TemplateMessage struct {
ToUser string `json:"touser"` // 必须, 接受者OpenID ToUser string `json:"touser"` // 必须, 接受者OpenID
TemplateID string `json:"template_id"` // 必须, 模版ID TemplateID string `json:"template_id"` // 必须, 模版ID
URL string `json:"url,omitempty"` // 可选, 用户点击后跳转的URL, 该URL必须处于开发者在公众平台网站中设置的域中 URL string `json:"url,omitempty"` // 可选, 用户点击后跳转的URL, 该URL必须处于开发者在公众平台网站中设置的域中
Color string `json:"color,omitempty"` // 可选, 整个消息的颜色, 可以不设置 Color string `json:"color,omitempty"` // 可选, 整个消息的颜色, 可以不设置
Data map[string]*TemplateDataItem `json:"data"` // 必须, 模板数据 Data map[string]*TemplateDataItem `json:"data"` // 必须, 模板数据
ClientMsgID string `json:"client_msg_id,omitempty"` // 可选, 防重入ID
MiniProgram struct { MiniProgram struct {
AppID string `json:"appid"` // 所需跳转到的小程序appid该小程序appid必须与发模板消息的公众号是绑定关联关系 AppID string `json:"appid"` // 所需跳转到的小程序appid该小程序appid必须与发模板消息的公众号是绑定关联关系
@@ -60,15 +61,15 @@ func (tpl *Template) Send(msg *TemplateMessage) (msgID int64, err error) {
if err != nil { if err != nil {
return return
} }
uri := fmt.Sprintf("%s?access_token=%s", templateSendURL, accessToken) var (
var response []byte uri = fmt.Sprintf("%s?access_token=%s", templateSendURL, accessToken)
response, err = util.PostJSON(uri, msg) response []byte
if err != nil { )
if response, err = util.PostJSON(uri, msg); err != nil {
return return
} }
var result resTemplateSend var result resTemplateSend
err = json.Unmarshal(response, &result) if err = json.Unmarshal(response, &result); err != nil {
if err != nil {
return return
} }
if result.ErrCode != 0 { if result.ErrCode != 0 {
@@ -102,19 +103,16 @@ func (tpl *Template) List() (templateList []*TemplateItem, err error) {
if err != nil { if err != nil {
return return
} }
uri := fmt.Sprintf("%s?access_token=%s", templateListURL, accessToken) var (
var response []byte uri = fmt.Sprintf("%s?access_token=%s", templateListURL, accessToken)
response, err = util.HTTPGet(uri) response []byte
if err != nil { )
if response, err = util.HTTPGet(uri); err != nil {
return return
} }
var res resTemplateList var res resTemplateList
err = util.DecodeWithError(response, &res, "ListTemplate") err = util.DecodeWithError(response, &res, "ListTemplate")
if err != nil { return res.TemplateList, err
return
}
templateList = res.TemplateList
return
} }
type resTemplateAdd struct { type resTemplateAdd struct {
@@ -124,29 +122,26 @@ type resTemplateAdd struct {
} }
// Add 添加模板. // 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 var accessToken string
accessToken, err = tpl.GetAccessToken() accessToken, err = tpl.GetAccessToken()
if err != nil { if err != nil {
return return
} }
var msg = struct { var (
ShortID string `json:"template_id_short"` msg = struct {
}{ShortID: shortID} ShortID string `json:"template_id_short"`
uri := fmt.Sprintf("%s?access_token=%s", templateAddURL, accessToken) KeyNameList []string `json:"keyword_name_list"`
var response []byte }{ShortID: shortID, KeyNameList: keyNameList}
response, err = util.PostJSON(uri, msg) uri = fmt.Sprintf("%s?access_token=%s", templateAddURL, accessToken)
if err != nil { response []byte
)
if response, err = util.PostJSON(uri, msg); err != nil {
return return
} }
var result resTemplateAdd var result resTemplateAdd
err = util.DecodeWithError(response, &result, "AddTemplate") err = util.DecodeWithError(response, &result, "AddTemplate")
if err != nil { return result.TemplateID, err
return
}
templateID = result.TemplateID
return
} }
// Delete 删除私有模板. // Delete 删除私有模板.
@@ -156,14 +151,14 @@ func (tpl *Template) Delete(templateID string) (err error) {
if err != nil { if err != nil {
return return
} }
var msg = struct { var (
TemplateID string `json:"template_id"` msg = struct {
}{TemplateID: templateID} TemplateID string `json:"template_id"`
}{TemplateID: templateID}
uri := fmt.Sprintf("%s?access_token=%s", templateDelURL, accessToken) uri = fmt.Sprintf("%s?access_token=%s", templateDelURL, accessToken)
var response []byte response []byte
response, err = util.PostJSON(uri, msg) )
if err != nil { if response, err = util.PostJSON(uri, msg); err != nil {
return return
} }
return util.DecodeWithCommonError(response, "DeleteTemplate") return util.DecodeWithCommonError(response, "DeleteTemplate")

View File

@@ -1,6 +1,7 @@
package oauth package oauth
import ( import (
ctx2 "context"
"encoding/json" "encoding/json"
"fmt" "fmt"
"net/http" "net/http"
@@ -64,16 +65,37 @@ type ResAccessToken struct {
OpenID string `json:"openid"` OpenID string `json:"openid"`
Scope string `json:"scope"` Scope string `json:"scope"`
// IsSnapShotUser 是否为快照页模式虚拟账号只有当用户是快照页模式虚拟账号时返回值为1
// 公众号文档 https://developers.weixin.qq.com/community/minihome/doc/000c2c34068880629ced91a2f56001
IsSnapShotUser int `json:"is_snapshotuser"`
// UnionID 只有在用户将公众号绑定到微信开放平台帐号后,才会出现该字段。 // UnionID 只有在用户将公众号绑定到微信开放平台帐号后,才会出现该字段。
// 公众号文档 https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140842 // 公众号文档 https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140842
UnionID string `json:"unionid"` 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) // GetUserAccessToken 通过网页授权的code 换取access_token(区别于context中的access_token)
func (oauth *Oauth) GetUserAccessToken(code string) (result ResAccessToken, err error) { 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) urlStr := fmt.Sprintf(accessTokenURL, oauth.AppID, oauth.AppSecret, code)
var response []byte var response []byte
response, err = util.HTTPGet(urlStr) response, err = util.HTTPGetContext(ctx, urlStr)
if err != nil { if err != nil {
return return
} }
@@ -90,9 +112,14 @@ func (oauth *Oauth) GetUserAccessToken(code string) (result ResAccessToken, err
// RefreshAccessToken 刷新access_token // RefreshAccessToken 刷新access_token
func (oauth *Oauth) RefreshAccessToken(refreshToken string) (result ResAccessToken, err error) { 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) urlStr := fmt.Sprintf(refreshAccessTokenURL, oauth.AppID, refreshToken)
var response []byte var response []byte
response, err = util.HTTPGet(urlStr) response, err = util.HTTPGetContext(ctx, urlStr)
if err != nil { if err != nil {
return return
} }
@@ -109,9 +136,14 @@ func (oauth *Oauth) RefreshAccessToken(refreshToken string) (result ResAccessTok
// CheckAccessToken 检验access_token是否有效 // CheckAccessToken 检验access_token是否有效
func (oauth *Oauth) CheckAccessToken(accessToken, openID string) (b bool, err error) { 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) urlStr := fmt.Sprintf(checkAccessTokenURL, accessToken, openID)
var response []byte var response []byte
response, err = util.HTTPGet(urlStr) response, err = util.HTTPGetContext(ctx, urlStr)
if err != nil { if err != nil {
return return
} }
@@ -145,12 +177,17 @@ type UserInfo struct {
// GetUserInfo 如果scope为 snsapi_userinfo 则可以通过此方法获取到用户基本信息 // GetUserInfo 如果scope为 snsapi_userinfo 则可以通过此方法获取到用户基本信息
func (oauth *Oauth) GetUserInfo(accessToken, openID, lang string) (result UserInfo, err error) { 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 == "" { if lang == "" {
lang = "zh_CN" lang = "zh_CN"
} }
urlStr := fmt.Sprintf(userInfoURL, accessToken, openID, lang) urlStr := fmt.Sprintf(userInfoURL, accessToken, openID, lang)
var response []byte var response []byte
response, err = util.HTTPGet(urlStr) response, err = util.HTTPGetContext(ctx, urlStr)
if err != nil { if err != nil {
return return
} }

View File

@@ -154,134 +154,120 @@ func NewOCR(c *context.Context) *OCR {
} }
// IDCard 身份证OCR识别接口 // IDCard 身份证OCR识别接口
func (ocr *OCR) IDCard(path string) (ResIDCard ResIDCard, err error) { func (ocr *OCR) IDCard(path string) (resIDCard ResIDCard, err error) {
accessToken, err := ocr.GetAccessToken() accessToken, err := ocr.GetAccessToken()
if err != nil { if err != nil {
return return
} }
uri := fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrIDCardURL, url.QueryEscape(path), accessToken) response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrIDCardURL, url.QueryEscape(path), accessToken), "")
response, err := util.HTTPPost(uri, "")
if err != nil { if err != nil {
return return
} }
err = util.DecodeWithError(response, &ResIDCard, "OCRIDCard") err = util.DecodeWithError(response, &resIDCard, "OCRIDCard")
return return
} }
// BankCard 银行卡OCR识别接口 // BankCard 银行卡OCR识别接口
func (ocr *OCR) BankCard(path string) (ResBankCard ResBankCard, err error) { func (ocr *OCR) BankCard(path string) (resBankCard ResBankCard, err error) {
accessToken, err := ocr.GetAccessToken() accessToken, err := ocr.GetAccessToken()
if err != nil { if err != nil {
return return
} }
uri := fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrBankCardURL, url.QueryEscape(path), accessToken) response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrBankCardURL, url.QueryEscape(path), accessToken), "")
response, err := util.HTTPPost(uri, "")
if err != nil { if err != nil {
return return
} }
err = util.DecodeWithError(response, &ResBankCard, "OCRBankCard") err = util.DecodeWithError(response, &resBankCard, "OCRBankCard")
return return
} }
// Driving 行驶证OCR识别接口 // Driving 行驶证OCR识别接口
func (ocr *OCR) Driving(path string) (ResDriving ResDriving, err error) { func (ocr *OCR) Driving(path string) (resDriving ResDriving, err error) {
accessToken, err := ocr.GetAccessToken() accessToken, err := ocr.GetAccessToken()
if err != nil { if err != nil {
return return
} }
uri := fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrDrivingURL, url.QueryEscape(path), accessToken) response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrDrivingURL, url.QueryEscape(path), accessToken), "")
response, err := util.HTTPPost(uri, "")
if err != nil { if err != nil {
return return
} }
err = util.DecodeWithError(response, &ResDriving, "OCRDriving") err = util.DecodeWithError(response, &resDriving, "OCRDriving")
return return
} }
// DrivingLicense 驾驶证OCR识别接口 // DrivingLicense 驾驶证OCR识别接口
func (ocr *OCR) DrivingLicense(path string) (ResDrivingLicense ResDrivingLicense, err error) { func (ocr *OCR) DrivingLicense(path string) (resDrivingLicense ResDrivingLicense, err error) {
accessToken, err := ocr.GetAccessToken() accessToken, err := ocr.GetAccessToken()
if err != nil { if err != nil {
return return
} }
uri := fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrDrivingLicenseURL, url.QueryEscape(path), accessToken) response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrDrivingLicenseURL, url.QueryEscape(path), accessToken), "")
response, err := util.HTTPPost(uri, "")
if err != nil { if err != nil {
return return
} }
err = util.DecodeWithError(response, &ResDrivingLicense, "OCRDrivingLicense") err = util.DecodeWithError(response, &resDrivingLicense, "OCRDrivingLicense")
return return
} }
// BizLicense 营业执照OCR识别接口 // BizLicense 营业执照OCR识别接口
func (ocr *OCR) BizLicense(path string) (ResBizLicense ResBizLicense, err error) { func (ocr *OCR) BizLicense(path string) (resBizLicense ResBizLicense, err error) {
accessToken, err := ocr.GetAccessToken() accessToken, err := ocr.GetAccessToken()
if err != nil { if err != nil {
return return
} }
uri := fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrBizLicenseURL, url.QueryEscape(path), accessToken) response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrBizLicenseURL, url.QueryEscape(path), accessToken), "")
response, err := util.HTTPPost(uri, "")
if err != nil { if err != nil {
return return
} }
err = util.DecodeWithError(response, &ResBizLicense, "OCRBizLicense") err = util.DecodeWithError(response, &resBizLicense, "OCRBizLicense")
return return
} }
// Common 通用印刷体OCR识别接口 // Common 通用印刷体OCR识别接口
func (ocr *OCR) Common(path string) (ResCommon ResCommon, err error) { func (ocr *OCR) Common(path string) (resCommon ResCommon, err error) {
accessToken, err := ocr.GetAccessToken() accessToken, err := ocr.GetAccessToken()
if err != nil { if err != nil {
return return
} }
uri := fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrCommonURL, url.QueryEscape(path), accessToken) response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrCommonURL, url.QueryEscape(path), accessToken), "")
response, err := util.HTTPPost(uri, "")
if err != nil { if err != nil {
return return
} }
err = util.DecodeWithError(response, &ResCommon, "OCRCommon") err = util.DecodeWithError(response, &resCommon, "OCRCommon")
return return
} }
// PlateNumber 车牌OCR识别接口 // PlateNumber 车牌OCR识别接口
func (ocr *OCR) PlateNumber(path string) (ResPlateNumber ResPlateNumber, err error) { func (ocr *OCR) PlateNumber(path string) (resPlateNumber ResPlateNumber, err error) {
accessToken, err := ocr.GetAccessToken() accessToken, err := ocr.GetAccessToken()
if err != nil { if err != nil {
return return
} }
uri := fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrPlateNumberURL, url.QueryEscape(path), accessToken) response, err := util.HTTPPost(fmt.Sprintf("%s?img_url=%s&access_token=%s", ocrPlateNumberURL, url.QueryEscape(path), accessToken), "")
response, err := util.HTTPPost(uri, "")
if err != nil { if err != nil {
return return
} }
err = util.DecodeWithError(response, &ResPlateNumber, "OCRPlateNumber") err = util.DecodeWithError(response, &resPlateNumber, "OCRPlateNumber")
return return
} }

View File

@@ -4,6 +4,7 @@ import (
stdcontext "context" stdcontext "context"
"net/http" "net/http"
"github.com/silenceper/wechat/v2/internal/openapi"
"github.com/silenceper/wechat/v2/officialaccount/draft" "github.com/silenceper/wechat/v2/officialaccount/draft"
"github.com/silenceper/wechat/v2/officialaccount/freepublish" "github.com/silenceper/wechat/v2/officialaccount/freepublish"
"github.com/silenceper/wechat/v2/officialaccount/ocr" "github.com/silenceper/wechat/v2/officialaccount/ocr"
@@ -48,7 +49,13 @@ type OfficialAccount struct {
// NewOfficialAccount 实例化公众号API // NewOfficialAccount 实例化公众号API
func NewOfficialAccount(cfg *config.Config) *OfficialAccount { 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{ ctx := &context.Context{
Config: cfg, Config: cfg,
AccessTokenHandle: defaultAkHandle, AccessTokenHandle: defaultAkHandle,
@@ -212,3 +219,8 @@ func (officialAccount *OfficialAccount) GetSubscribe() *message.Subscribe {
func (officialAccount *OfficialAccount) GetCustomerServiceManager() *customerservice.Manager { func (officialAccount *OfficialAccount) GetCustomerServiceManager() *customerservice.Manager {
return customerservice.NewCustomerServiceManager(officialAccount.ctx) return customerservice.NewCustomerServiceManager(officialAccount.ctx)
} }
// GetOpenAPI openApi管理接口
func (officialAccount *OfficialAccount) GetOpenAPI() *openapi.OpenAPI {
return openapi.NewOpenAPI(officialAccount.ctx)
}

View File

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

View File

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

View File

@@ -2,6 +2,7 @@ package user
import ( import (
"encoding/json" "encoding/json"
"errors"
"fmt" "fmt"
"net/url" "net/url"
@@ -10,9 +11,10 @@ import (
) )
const ( const (
userInfoURL = "https://api.weixin.qq.com/cgi-bin/user/info?access_token=%s&openid=%s&lang=zh_CN" userInfoURL = "https://api.weixin.qq.com/cgi-bin/user/info?access_token=%s&openid=%s&lang=zh_CN"
updateRemarkURL = "https://api.weixin.qq.com/cgi-bin/user/info/updateremark?access_token=%s" userInfoBatchURL = "https://api.weixin.qq.com/cgi-bin/user/info/batchget"
userListURL = "https://api.weixin.qq.com/cgi-bin/user/get" updateRemarkURL = "https://api.weixin.qq.com/cgi-bin/user/info/updateremark?access_token=%s"
userListURL = "https://api.weixin.qq.com/cgi-bin/user/get"
) )
// User 用户管理 // User 用户管理
@@ -30,7 +32,11 @@ func NewUser(context *context.Context) *User {
// Info 用户基本信息 // Info 用户基本信息
type Info struct { type Info struct {
util.CommonError util.CommonError
userInfo
}
// 用户基本信息
type userInfo struct {
Subscribe int32 `json:"subscribe"` Subscribe int32 `json:"subscribe"`
OpenID string `json:"openid"` OpenID string `json:"openid"`
Nickname string `json:"nickname"` Nickname string `json:"nickname"`
@@ -88,6 +94,48 @@ func (user *User) GetUserInfo(openID string) (userInfo *Info, err error) {
return return
} }
// BatchGetUserInfoParams 批量获取用户基本信息参数
type BatchGetUserInfoParams struct {
UserList []BatchGetUserListItem `json:"user_list"` // 需要批量获取基本信息的用户列表
}
// BatchGetUserListItem 需要获取基本信息的用户
type BatchGetUserListItem struct {
OpenID string `json:"openid"` // 用户的标识,对当前公众号唯一
Lang string `json:"lang"` // 国家地区语言版本zh_CN 简体zh_TW 繁体en 英语默认为zh-CN
}
// InfoList 用户基本信息列表
type InfoList struct {
util.CommonError
UserInfoList []userInfo `json:"user_info_list"`
}
// BatchGetUserInfo 批量获取用户基本信息
func (user *User) BatchGetUserInfo(params BatchGetUserInfoParams) (*InfoList, error) {
if len(params.UserList) > 100 {
return nil, errors.New("params length must be less than or equal to 100")
}
ak, err := user.GetAccessToken()
if err != nil {
return nil, err
}
uri := fmt.Sprintf("%s?access_token=%s", userInfoBatchURL, ak)
res, err := util.PostJSON(uri, params)
if err != nil {
return nil, err
}
var data InfoList
err = util.DecodeWithError(res, &data, "BatchGetUserInfo")
if err != nil {
return nil, err
}
return &data, nil
}
// UpdateRemark 设置用户备注名 // UpdateRemark 设置用户备注名
func (user *User) UpdateRemark(openID, remark string) (err error) { func (user *User) UpdateRemark(openID, remark string) (err error) {
var accessToken string var accessToken string

View File

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

View File

@@ -2,11 +2,13 @@
package context package context
import ( import (
"context"
"encoding/json" "encoding/json"
"fmt" "fmt"
"net/url" "net/url"
"time" "time"
"github.com/silenceper/wechat/v2/cache"
"github.com/silenceper/wechat/v2/util" "github.com/silenceper/wechat/v2/util"
) )
@@ -18,6 +20,7 @@ const (
getComponentInfoURL = "https://api.weixin.qq.com/cgi-bin/component/api_get_authorizer_info?component_access_token=%s" 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" 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" 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 获取授权方选项信息 // TODO 获取授权方选项信息
// getComponentConfigURL = "https://api.weixin.qq.com/cgi-bin/component/api_get_authorizer_option?component_access_token=%s" // getComponentConfigURL = "https://api.weixin.qq.com/cgi-bin/component/api_get_authorizer_option?component_access_token=%s"
// TODO 获取已授权的账号信息 // TODO 获取已授权的账号信息
@@ -31,24 +34,29 @@ type ComponentAccessToken struct {
ExpiresIn int64 `json:"expires_in"` ExpiresIn int64 `json:"expires_in"`
} }
// GetComponentAccessToken 获取 ComponentAccessToken // GetComponentAccessTokenContext 获取 ComponentAccessToken
func (ctx *Context) GetComponentAccessToken() (string, error) { func (ctx *Context) GetComponentAccessTokenContext(stdCtx context.Context) (string, error) {
accessTokenCacheKey := fmt.Sprintf("component_access_token_%s", ctx.AppID) accessTokenCacheKey := fmt.Sprintf("component_access_token_%s", ctx.AppID)
val := ctx.Cache.Get(accessTokenCacheKey) val := cache.GetContext(stdCtx, ctx.Cache, accessTokenCacheKey)
if val == nil { if val == nil {
return "", fmt.Errorf("cann't get component access token") return "", fmt.Errorf("cann't get component access token")
} }
return val.(string), nil return val.(string), nil
} }
// SetComponentAccessToken 通过component_verify_ticket 获取 ComponentAccessToken // GetComponentAccessToken 获取 ComponentAccessToken
func (ctx *Context) SetComponentAccessToken(verifyTicket string) (*ComponentAccessToken, error) { func (ctx *Context) GetComponentAccessToken() (string, error) {
return ctx.GetComponentAccessTokenContext(context.Background())
}
// SetComponentAccessTokenContext 通过component_verify_ticket 获取 ComponentAccessToken
func (ctx *Context) SetComponentAccessTokenContext(stdCtx context.Context, verifyTicket string) (*ComponentAccessToken, error) {
body := map[string]string{ body := map[string]string{
"component_appid": ctx.AppID, "component_appid": ctx.AppID,
"component_appsecret": ctx.AppSecret, "component_appsecret": ctx.AppSecret,
"component_verify_ticket": verifyTicket, "component_verify_ticket": verifyTicket,
} }
respBody, err := util.PostJSON(componentAccessTokenURL, body) respBody, err := util.PostJSONContext(stdCtx, componentAccessTokenURL, body)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -64,15 +72,20 @@ func (ctx *Context) SetComponentAccessToken(verifyTicket string) (*ComponentAcce
accessTokenCacheKey := fmt.Sprintf("component_access_token_%s", ctx.AppID) accessTokenCacheKey := fmt.Sprintf("component_access_token_%s", ctx.AppID)
expires := at.ExpiresIn - 1500 expires := at.ExpiresIn - 1500
if err := ctx.Cache.Set(accessTokenCacheKey, at.AccessToken, time.Duration(expires)*time.Second); err != nil { if err := cache.SetContext(stdCtx, ctx.Cache, accessTokenCacheKey, at.AccessToken, time.Duration(expires)*time.Second); err != nil {
return nil, nil return nil, nil
} }
return at, nil return at, nil
} }
// GetPreCode 获取预授权码 // SetComponentAccessToken 通过component_verify_ticket 获取 ComponentAccessToken
func (ctx *Context) GetPreCode() (string, error) { func (ctx *Context) SetComponentAccessToken(stdCtx context.Context, verifyTicket string) (*ComponentAccessToken, error) {
cat, err := ctx.GetComponentAccessToken() return ctx.SetComponentAccessTokenContext(stdCtx, verifyTicket)
}
// GetPreCodeContext 获取预授权码
func (ctx *Context) GetPreCodeContext(stdCtx context.Context) (string, error) {
cat, err := ctx.GetComponentAccessTokenContext(stdCtx)
if err != nil { if err != nil {
return "", err return "", err
} }
@@ -80,7 +93,7 @@ func (ctx *Context) GetPreCode() (string, error) {
"component_appid": ctx.AppID, "component_appid": ctx.AppID,
} }
uri := fmt.Sprintf(getPreCodeURL, cat) uri := fmt.Sprintf(getPreCodeURL, cat)
body, err := util.PostJSON(uri, req) body, err := util.PostJSONContext(stdCtx, uri, req)
if err != nil { if err != nil {
return "", err return "", err
} }
@@ -88,31 +101,57 @@ func (ctx *Context) GetPreCode() (string, error) {
var ret struct { var ret struct {
PreCode string `json:"pre_auth_code"` PreCode string `json:"pre_auth_code"`
} }
if err := json.Unmarshal(body, &ret); err != nil { err = json.Unmarshal(body, &ret)
return "", err return ret.PreCode, err
}
return ret.PreCode, nil
} }
// GetComponentLoginPage 获取第三方公众号授权链接(扫码授权) // GetPreCode 获取预授权码
func (ctx *Context) GetComponentLoginPage(redirectURI string, authType int, bizAppID string) (string, error) { func (ctx *Context) GetPreCode() (string, error) {
code, err := ctx.GetPreCode() return ctx.GetPreCodeContext(context.Background())
}
// GetComponentLoginPageContext 获取第三方公众号授权链接(扫码授权)
func (ctx *Context) GetComponentLoginPageContext(stdCtx context.Context, redirectURI string, authType int, bizAppID string) (string, error) {
code, err := ctx.GetPreCodeContext(stdCtx)
if err != nil { if err != nil {
return "", err return "", err
} }
return fmt.Sprintf(componentLoginURL, ctx.AppID, code, url.QueryEscape(redirectURI), authType, bizAppID), nil return fmt.Sprintf(componentLoginURL, ctx.AppID, code, url.QueryEscape(redirectURI), authType, bizAppID), nil
} }
// GetBindComponentURL 获取第三方公众号授权链接(链接跳转,适用移动端) // GetComponentLoginPage 获取第三方公众号授权链接(扫码授权)
func (ctx *Context) GetBindComponentURL(redirectURI string, authType int, bizAppID string) (string, error) { func (ctx *Context) GetComponentLoginPage(redirectURI string, authType int, bizAppID string) (string, error) {
code, err := ctx.GetPreCode() return ctx.GetComponentLoginPageContext(context.Background(), redirectURI, authType, bizAppID)
}
// GetBindComponentURLContext 获取第三方公众号授权链接(链接跳转,适用移动端)
func (ctx *Context) GetBindComponentURLContext(stdCtx context.Context, redirectURI string, authType int, bizAppID string) (string, error) {
code, err := ctx.GetPreCodeContext(stdCtx)
if err != nil { if err != nil {
return "", err return "", err
} }
return fmt.Sprintf(bindComponentURL, authType, ctx.AppID, code, url.QueryEscape(redirectURI), bizAppID), nil return fmt.Sprintf(bindComponentURL, authType, ctx.AppID, code, url.QueryEscape(redirectURI), bizAppID), nil
} }
// GetBindComponentURL 获取第三方公众号授权链接(链接跳转,适用移动端)
func (ctx *Context) GetBindComponentURL(redirectURI string, authType int, bizAppID string) (string, error) {
return ctx.GetBindComponentURLContext(context.Background(), redirectURI, authType, bizAppID)
}
// GetBindComponentURLV2Context 获取新版本第三方公众号授权链接(链接跳转,适用移动端)
func (ctx *Context) GetBindComponentURLV2Context(stdCtx context.Context, redirectURI string, authType int, bizAppID string) (string, error) {
code, err := ctx.GetPreCodeContext(stdCtx)
if err != nil {
return "", err
}
return fmt.Sprintf(bindComponentURLV2, authType, ctx.AppID, code, url.QueryEscape(redirectURI), bizAppID), nil
}
// GetBindComponentURLV2 获取新版本第三方公众号授权链接(链接跳转,适用移动端)
func (ctx *Context) GetBindComponentURLV2(redirectURI string, authType int, bizAppID string) (string, error) {
return ctx.GetBindComponentURLContext(context.Background(), redirectURI, authType, bizAppID)
}
// ID 微信返回接口中各种类型字段 // ID 微信返回接口中各种类型字段
type ID struct { type ID struct {
ID int `json:"id"` ID int `json:"id"`
@@ -137,9 +176,9 @@ type AuthrAccessToken struct {
RefreshToken string `json:"authorizer_refresh_token"` RefreshToken string `json:"authorizer_refresh_token"`
} }
// QueryAuthCode 使用授权码换取公众号或小程序的接口调用凭据和授权信息 // QueryAuthCodeContext 使用授权码换取公众号或小程序的接口调用凭据和授权信息
func (ctx *Context) QueryAuthCode(authCode string) (*AuthBaseInfo, error) { func (ctx *Context) QueryAuthCodeContext(stdCtx context.Context, authCode string) (*AuthBaseInfo, error) {
cat, err := ctx.GetComponentAccessToken() cat, err := ctx.GetComponentAccessTokenContext(stdCtx)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -149,7 +188,7 @@ func (ctx *Context) QueryAuthCode(authCode string) (*AuthBaseInfo, error) {
"authorization_code": authCode, "authorization_code": authCode,
} }
uri := fmt.Sprintf(queryAuthURL, cat) uri := fmt.Sprintf(queryAuthURL, cat)
body, err := util.PostJSON(uri, req) body, err := util.PostJSONContext(stdCtx, uri, req)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -169,9 +208,14 @@ func (ctx *Context) QueryAuthCode(authCode string) (*AuthBaseInfo, error) {
return ret.Info, nil return ret.Info, nil
} }
// RefreshAuthrToken 获取(刷新)授权公众号或小程序的接口调用凭据(令牌) // QueryAuthCode 使用授权码换取公众号或小程序的接口调用凭据和授权信息
func (ctx *Context) RefreshAuthrToken(appid, refreshToken string) (*AuthrAccessToken, error) { func (ctx *Context) QueryAuthCode(authCode string) (*AuthBaseInfo, error) {
cat, err := ctx.GetComponentAccessToken() return ctx.QueryAuthCodeContext(context.Background(), authCode)
}
// RefreshAuthrTokenContext 获取(刷新)授权公众号或小程序的接口调用凭据(令牌)
func (ctx *Context) RefreshAuthrTokenContext(stdCtx context.Context, appid, refreshToken string) (*AuthrAccessToken, error) {
cat, err := ctx.GetComponentAccessTokenContext(stdCtx)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -182,7 +226,7 @@ func (ctx *Context) RefreshAuthrToken(appid, refreshToken string) (*AuthrAccessT
"authorizer_refresh_token": refreshToken, "authorizer_refresh_token": refreshToken,
} }
uri := fmt.Sprintf(refreshTokenURL, cat) uri := fmt.Sprintf(refreshTokenURL, cat)
body, err := util.PostJSON(uri, req) body, err := util.PostJSONContext(stdCtx, uri, req)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -193,20 +237,44 @@ func (ctx *Context) RefreshAuthrToken(appid, refreshToken string) (*AuthrAccessT
} }
authrTokenKey := "authorizer_access_token_" + appid authrTokenKey := "authorizer_access_token_" + appid
if err := ctx.Cache.Set(authrTokenKey, ret.AccessToken, time.Minute*80); err != nil { if err := cache.SetContext(stdCtx, ctx.Cache, authrTokenKey, ret.AccessToken, time.Second*time.Duration(ret.ExpiresIn-30)); err != nil {
return nil, err
}
refreshTokenKey := "authorizer_refresh_token_" + appid
if err := cache.SetContext(stdCtx, ctx.Cache, refreshTokenKey, ret.RefreshToken, 10*365*24*60*60*time.Second); err != nil {
return nil, err return nil, err
} }
return ret, nil return ret, nil
} }
// RefreshAuthrToken 获取(刷新)授权公众号或小程序的接口调用凭据(令牌)
func (ctx *Context) RefreshAuthrToken(appid, refreshToken string) (*AuthrAccessToken, error) {
return ctx.RefreshAuthrTokenContext(context.Background(), appid, refreshToken)
}
// GetAuthrAccessTokenContext 获取授权方AccessToken
func (ctx *Context) GetAuthrAccessTokenContext(stdCtx context.Context, appid string) (string, error) {
authrTokenKey := "authorizer_access_token_" + appid
val := cache.GetContext(stdCtx, ctx.Cache, authrTokenKey)
if val == nil {
refreshTokenKey := "authorizer_refresh_token_" + appid
val := cache.GetContext(stdCtx, ctx.Cache, refreshTokenKey)
if val == nil {
return "", fmt.Errorf("cannot get authorizer %s refresh token", appid)
}
token, err := ctx.RefreshAuthrTokenContext(stdCtx, appid, val.(string))
if err != nil {
return "", err
}
return token.AccessToken, nil
}
return val.(string), nil
}
// GetAuthrAccessToken 获取授权方AccessToken // GetAuthrAccessToken 获取授权方AccessToken
func (ctx *Context) GetAuthrAccessToken(appid string) (string, error) { func (ctx *Context) GetAuthrAccessToken(appid string) (string, error) {
authrTokenKey := "authorizer_access_token_" + appid return ctx.GetAuthrAccessTokenContext(context.Background(), appid)
val := ctx.Cache.Get(authrTokenKey)
if val == nil {
return "", fmt.Errorf("cannot get authorizer %s access token", appid)
}
return val.(string), nil
} }
// AuthorizerInfo 授权方详细信息 // AuthorizerInfo 授权方详细信息
@@ -258,9 +326,9 @@ type CategoriesInfo struct {
Second string `wx:"second"` Second string `wx:"second"`
} }
// GetAuthrInfo 获取授权方的帐号基本信息 // GetAuthrInfoContext 获取授权方的帐号基本信息
func (ctx *Context) GetAuthrInfo(appid string) (*AuthorizerInfo, *AuthBaseInfo, error) { func (ctx *Context) GetAuthrInfoContext(stdCtx context.Context, appid string) (*AuthorizerInfo, *AuthBaseInfo, error) {
cat, err := ctx.GetComponentAccessToken() cat, err := ctx.GetComponentAccessTokenContext(stdCtx)
if err != nil { if err != nil {
return nil, nil, err return nil, nil, err
} }
@@ -271,7 +339,7 @@ func (ctx *Context) GetAuthrInfo(appid string) (*AuthorizerInfo, *AuthBaseInfo,
} }
uri := fmt.Sprintf(getComponentInfoURL, cat) uri := fmt.Sprintf(getComponentInfoURL, cat)
body, err := util.PostJSON(uri, req) body, err := util.PostJSONContext(stdCtx, uri, req)
if err != nil { if err != nil {
return nil, nil, err return nil, nil, err
} }
@@ -286,3 +354,8 @@ func (ctx *Context) GetAuthrInfo(appid string) (*AuthorizerInfo, *AuthBaseInfo,
return ret.AuthorizerInfo, ret.AuthorizationInfo, nil return ret.AuthorizerInfo, ret.AuthorizationInfo, nil
} }
// GetAuthrInfo 获取授权方的帐号基本信息
func (ctx *Context) GetAuthrInfo(appid string) (*AuthorizerInfo, *AuthBaseInfo, error) {
return ctx.GetAuthrInfoContext(context.Background(), appid)
}

View File

@@ -9,6 +9,12 @@ import (
const ( const (
getAccountBasicInfoURL = "https://api.weixin.qq.com/cgi-bin/account/getaccountbasicinfo" 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 基础信息设置 // Basic 基础信息设置
@@ -51,3 +57,181 @@ func (basic *Basic) GetAccountBasicInfo() (*AccountBasicInfo, error) {
// TODO // TODO
// func (encryptor *Basic) modifyDomain() { // 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

@@ -36,7 +36,7 @@ type RegisterMiniProgramParam struct {
func (component *Component) RegisterMiniProgram(param *RegisterMiniProgramParam) error { func (component *Component) RegisterMiniProgram(param *RegisterMiniProgramParam) error {
componentAK, err := component.GetComponentAccessToken() componentAK, err := component.GetComponentAccessToken()
if err != nil { if err != nil {
return nil return err
} }
url := fmt.Sprintf(fastregisterweappURL+"?action=create&component_access_token=%s", componentAK) url := fmt.Sprintf(fastregisterweappURL+"?action=create&component_access_token=%s", componentAK)
data, err := util.PostJSON(url, param) data, err := util.PostJSON(url, param)
@@ -58,7 +58,7 @@ type GetRegistrationStatusParam struct {
func (component *Component) GetRegistrationStatus(param *GetRegistrationStatusParam) error { func (component *Component) GetRegistrationStatus(param *GetRegistrationStatusParam) error {
componentAK, err := component.GetComponentAccessToken() componentAK, err := component.GetComponentAccessToken()
if err != nil { if err != nil {
return nil return err
} }
url := fmt.Sprintf(fastregisterweappURL+"?action=search&component_access_token=%s", componentAK) url := fmt.Sprintf(fastregisterweappURL+"?action=search&component_access_token=%s", componentAK)
data, err := util.PostJSON(url, param) data, err := util.PostJSON(url, param)

View File

@@ -1,6 +1,7 @@
package miniprogram package miniprogram
import ( import (
originalContext "context"
"fmt" "fmt"
"github.com/silenceper/wechat/v2/credential" "github.com/silenceper/wechat/v2/credential"
@@ -37,6 +38,22 @@ func (miniProgram *MiniProgram) GetAccessToken() (string, error) {
return akRes.AccessToken, nil 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 // SetAuthorizerRefreshToken 设置代执操作业务授权账号authorizer_refresh_token
func (miniProgram *MiniProgram) SetAuthorizerRefreshToken(authorizerRefreshToken string) *MiniProgram { func (miniProgram *MiniProgram) SetAuthorizerRefreshToken(authorizerRefreshToken string) *MiniProgram {
miniProgram.authorizerRefreshToken = authorizerRefreshToken miniProgram.authorizerRefreshToken = authorizerRefreshToken
@@ -68,7 +85,7 @@ func (miniProgram *MiniProgram) GetBasic() *basic.Basic {
// GetURLLink 小程序URL Link接口 调用前需确认已调用 SetAuthorizerRefreshToken 避免由于缓存中 authorizer_access_token 过期执行中断 // GetURLLink 小程序URL Link接口 调用前需确认已调用 SetAuthorizerRefreshToken 避免由于缓存中 authorizer_access_token 过期执行中断
func (miniProgram *MiniProgram) GetURLLink() *urllink.URLLink { func (miniProgram *MiniProgram) GetURLLink() *urllink.URLLink {
return urllink.NewURLLink(&miniContext.Context{ return urllink.NewURLLink(&miniContext.Context{
AccessTokenHandle: miniProgram, AccessTokenContextHandle: miniProgram,
}) })
} }

View File

@@ -1,6 +1,7 @@
package js package js
import ( import (
context2 "context"
"fmt" "fmt"
"github.com/silenceper/wechat/v2/credential" "github.com/silenceper/wechat/v2/credential"
@@ -32,14 +33,31 @@ func (js *Js) SetJsTicketHandle(ticketHandle credential.JsTicketHandle) {
// GetConfig 第三方平台 - 获取jssdk需要的配置参数 // GetConfig 第三方平台 - 获取jssdk需要的配置参数
// uri 为当前网页地址 // uri 为当前网页地址
func (js *Js) GetConfig(uri, appid string) (config *officialJs.Config, err error) { 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 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 { if err != nil {
return return
} }
var ticketStr string 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 { if err != nil {
return 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) str := fmt.Sprintf("jsapi_ticket=%s&noncestr=%s&timestamp=%d&url=%s", ticketStr, nonceStr, timestamp, uri)
sigStr := util.Signature(str) sigStr := util.Signature(str)
config = new(officialJs.Config)
config.AppID = appid config.AppID = appid
config.NonceStr = nonceStr config.NonceStr = nonceStr
config.Timestamp = timestamp 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

@@ -18,9 +18,6 @@ type OpenPlatform struct {
// NewOpenPlatform new openplatform // NewOpenPlatform new openplatform
func NewOpenPlatform(cfg *config.Config) *OpenPlatform { func NewOpenPlatform(cfg *config.Config) *OpenPlatform {
if cfg.Cache == nil {
panic("cache 未设置")
}
ctx := &context.Context{ ctx := &context.Context{
Config: cfg, Config: cfg,
} }

View File

@@ -4,6 +4,7 @@ import (
"github.com/silenceper/wechat/v2/pay/config" "github.com/silenceper/wechat/v2/pay/config"
"github.com/silenceper/wechat/v2/pay/notify" "github.com/silenceper/wechat/v2/pay/notify"
"github.com/silenceper/wechat/v2/pay/order" "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/refund"
"github.com/silenceper/wechat/v2/pay/transfer" "github.com/silenceper/wechat/v2/pay/transfer"
) )
@@ -37,3 +38,8 @@ func (pay *Pay) GetRefund() *refund.Refund {
func (pay *Pay) GetTransfer() *transfer.Transfer { func (pay *Pay) GetTransfer() *transfer.Transfer {
return transfer.NewTransfer(pay.cfg) 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

@@ -6,7 +6,7 @@ import (
"reflect" "reflect"
) )
// CommonError 微信返回的通用错误json // CommonError 微信返回的通用错误 json
type CommonError struct { type CommonError struct {
apiName string apiName string
ErrCode int64 `json:"errcode"` ErrCode int64 `json:"errcode"`
@@ -17,7 +17,7 @@ func (c *CommonError) Error() string {
return fmt.Sprintf("%s Error , errcode=%d , errmsg=%s", c.apiName, c.ErrCode, c.ErrMsg) return fmt.Sprintf("%s Error , errcode=%d , errmsg=%s", c.apiName, c.ErrCode, c.ErrMsg)
} }
// NewCommonError 新建CommonError错误对于无errcodeerrmsg的返回也可以返回该通用错误 // NewCommonError 新建 CommonError 错误,对于无 errcodeerrmsg 的返回也可以返回该通用错误
func NewCommonError(apiName string, code int64, msg string) *CommonError { func NewCommonError(apiName string, code int64, msg string) *CommonError {
return &CommonError{ return &CommonError{
apiName: apiName, apiName: apiName,
@@ -26,7 +26,7 @@ func NewCommonError(apiName string, code int64, msg string) *CommonError {
} }
} }
// DecodeWithCommonError 将返回值按照CommonError解析 // DecodeWithCommonError 将返回值按照 CommonError 解析
func DecodeWithCommonError(response []byte, apiName string) (err error) { func DecodeWithCommonError(response []byte, apiName string) (err error) {
var commError CommonError var commError CommonError
err = json.Unmarshal(response, &commError) err = json.Unmarshal(response, &commError)

View File

@@ -17,6 +17,19 @@ import (
"golang.org/x/crypto/pkcs12" "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 请求 // HTTPGet get 请求
func HTTPGet(uri string) ([]byte, error) { func HTTPGet(uri string) ([]byte, error) {
return HTTPGetContext(context.Background(), uri) return HTTPGetContext(context.Background(), uri)
@@ -24,11 +37,14 @@ func HTTPGet(uri string) ([]byte, error) {
// HTTPGetContext get 请求 // HTTPGetContext get 请求
func HTTPGetContext(ctx context.Context, uri string) ([]byte, error) { func HTTPGetContext(ctx context.Context, uri string) ([]byte, error) {
if uriModifier != nil {
uri = uriModifier(uri)
}
request, err := http.NewRequestWithContext(ctx, http.MethodGet, uri, nil) request, err := http.NewRequestWithContext(ctx, http.MethodGet, uri, nil)
if err != nil { if err != nil {
return nil, err return nil, err
} }
response, err := http.DefaultClient.Do(request) response, err := DefaultHTTPClient.Do(request)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -47,6 +63,9 @@ func HTTPPost(uri string, data string) ([]byte, error) {
// HTTPPostContext post 请求 // HTTPPostContext post 请求
func HTTPPostContext(ctx context.Context, uri string, data []byte, header map[string]string) ([]byte, error) { 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) body := bytes.NewBuffer(data)
request, err := http.NewRequestWithContext(ctx, http.MethodPost, uri, body) request, err := http.NewRequestWithContext(ctx, http.MethodPost, uri, body)
if err != nil { if err != nil {
@@ -57,7 +76,7 @@ func HTTPPostContext(ctx context.Context, uri string, data []byte, header map[st
request.Header.Set(key, value) request.Header.Set(key, value)
} }
response, err := http.DefaultClient.Do(request) response, err := DefaultHTTPClient.Do(request)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -69,8 +88,11 @@ func HTTPPostContext(ctx context.Context, uri string, data []byte, header map[st
return io.ReadAll(response.Body) return io.ReadAll(response.Body)
} }
// PostJSON post json 数据请求 // PostJSONContext post json 数据请求
func PostJSON(uri string, obj interface{}) ([]byte, error) { func PostJSONContext(ctx context.Context, uri string, obj interface{}) ([]byte, error) {
if uriModifier != nil {
uri = uriModifier(uri)
}
jsonBuf := new(bytes.Buffer) jsonBuf := new(bytes.Buffer)
enc := json.NewEncoder(jsonBuf) enc := json.NewEncoder(jsonBuf)
enc.SetEscapeHTML(false) enc.SetEscapeHTML(false)
@@ -78,7 +100,12 @@ func PostJSON(uri string, obj interface{}) ([]byte, error) {
if err != nil { if err != nil {
return nil, err return nil, err
} }
response, err := http.Post(uri, "application/json;charset=utf-8", jsonBuf) req, err := http.NewRequestWithContext(ctx, "POST", uri, jsonBuf)
if err != nil {
return nil, err
}
req.Header.Set("Content-Type", "application/json;charset=utf-8")
response, err := DefaultHTTPClient.Do(req)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@@ -90,7 +117,12 @@ func PostJSON(uri string, obj interface{}) ([]byte, error) {
return io.ReadAll(response.Body) return io.ReadAll(response.Body)
} }
// PostJSONWithRespContentType post json数据请求,且返回数据类型 // PostJSON post json 数据请求
func PostJSON(uri string, obj interface{}) ([]byte, error) {
return PostJSONContext(context.Background(), uri, obj)
}
// PostJSONWithRespContentType post json 数据请求,且返回数据类型
func PostJSONWithRespContentType(uri string, obj interface{}) ([]byte, string, error) { func PostJSONWithRespContentType(uri string, obj interface{}) ([]byte, string, error) {
jsonBuf := new(bytes.Buffer) jsonBuf := new(bytes.Buffer)
enc := json.NewEncoder(jsonBuf) enc := json.NewEncoder(jsonBuf)
@@ -100,7 +132,7 @@ func PostJSONWithRespContentType(uri string, obj interface{}) ([]byte, string, e
return nil, "", err 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 { if err != nil {
return nil, "", err return nil, "", err
} }
@@ -114,13 +146,41 @@ func PostJSONWithRespContentType(uri string, obj interface{}) ([]byte, string, e
return responseData, contentType, err 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 上传文件 // PostFile 上传文件
func PostFile(fieldName, filename, uri string) ([]byte, error) { func PostFile(fieldName, filePath, uri string) ([]byte, error) {
fields := []MultipartFormField{ fields := []MultipartFormField{
{ {
IsFile: true, IsFile: true,
Fieldname: fieldName, 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) return PostMultipartForm(fields, uri)
@@ -128,14 +188,19 @@ func PostFile(fieldName, filename, uri string) ([]byte, error) {
// MultipartFormField 保存文件或其他字段信息 // MultipartFormField 保存文件或其他字段信息
type MultipartFormField struct { type MultipartFormField struct {
IsFile bool IsFile bool
Fieldname string Fieldname string
Value []byte Value []byte
Filename string FilePath string
Filename string
FileReader io.Reader
} }
// PostMultipartForm 上传文件或其他多个字段 // PostMultipartForm 上传文件或其他多个字段
func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte, err error) { func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte, err error) {
if uriModifier != nil {
uri = uriModifier(uri)
}
bodyBuf := &bytes.Buffer{} bodyBuf := &bytes.Buffer{}
bodyWriter := multipart.NewWriter(bodyBuf) bodyWriter := multipart.NewWriter(bodyBuf)
@@ -147,18 +212,24 @@ func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte
return return
} }
fh, e := os.Open(field.Filename) if field.FileReader == nil {
if e != nil { fh, e := os.Open(field.FilePath)
err = fmt.Errorf("error opening file , err=%v", e) if e != nil {
return err = fmt.Errorf("error opening file , err=%v", e)
} return
defer fh.Close() }
_, err = io.Copy(fileWriter, fh)
if _, err = io.Copy(fileWriter, fh); err != nil { _ = fh.Close()
return if err != nil {
return
}
} else {
if _, err = io.Copy(fileWriter, field.FileReader); err != nil {
return
}
} }
} else { } else {
partWriter, e := bodyWriter.CreateFormField(field.Fieldname) partWriter, e := bodyWriter.CreateFormFile(field.Fieldname, field.Filename)
if e != nil { if e != nil {
err = e err = e
return return
@@ -173,14 +244,14 @@ func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte
contentType := bodyWriter.FormDataContentType() contentType := bodyWriter.FormDataContentType()
bodyWriter.Close() bodyWriter.Close()
resp, e := http.Post(uri, contentType, bodyBuf) resp, e := DefaultHTTPClient.Post(uri, contentType, bodyBuf)
if e != nil { if e != nil {
err = e err = e
return return
} }
defer resp.Body.Close() defer resp.Body.Close()
if resp.StatusCode != http.StatusOK { 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) respBody, err = io.ReadAll(resp.Body)
return return
@@ -188,13 +259,16 @@ func PostMultipartForm(fields []MultipartFormField, uri string) (respBody []byte
// PostXML perform a HTTP/POST request with XML body // PostXML perform a HTTP/POST request with XML body
func PostXML(uri string, obj interface{}) ([]byte, error) { func PostXML(uri string, obj interface{}) ([]byte, error) {
if uriModifier != nil {
uri = uriModifier(uri)
}
xmlData, err := xml.Marshal(obj) xmlData, err := xml.Marshal(obj)
if err != nil { if err != nil {
return nil, err return nil, err
} }
body := bytes.NewBuffer(xmlData) 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 { if err != nil {
return nil, err return nil, err
} }
@@ -206,7 +280,7 @@ func PostXML(uri string, obj interface{}) ([]byte, error) {
return io.ReadAll(response.Body) return io.ReadAll(response.Body)
} }
// httpWithTLS CA证书 // httpWithTLS CA 证书
func httpWithTLS(rootCa, key string) (*http.Client, error) { func httpWithTLS(rootCa, key string) (*http.Client, error) {
var client *http.Client var client *http.Client
certData, err := os.ReadFile(rootCa) certData, err := os.ReadFile(rootCa)
@@ -217,15 +291,14 @@ func httpWithTLS(rootCa, key string) (*http.Client, error) {
config := &tls.Config{ config := &tls.Config{
Certificates: []tls.Certificate{cert}, Certificates: []tls.Certificate{cert},
} }
tr := &http.Transport{ trans := (DefaultHTTPClient.Transport.(*http.Transport)).Clone()
TLSClientConfig: config, trans.TLSClientConfig = config
DisableCompression: true, trans.DisableCompression = true
} client = &http.Client{Transport: trans}
client = &http.Client{Transport: tr}
return client, nil return client, nil
} }
// pkcs12ToPem 将Pkcs12转成Pem // pkcs12ToPem 将 Pkcs12 转成 Pem
func pkcs12ToPem(p12 []byte, password string) tls.Certificate { func pkcs12ToPem(p12 []byte, password string) tls.Certificate {
blocks, err := pkcs12.ToPEM(p12, password) blocks, err := pkcs12.ToPEM(p12, password)
defer func() { defer func() {
@@ -249,6 +322,9 @@ func pkcs12ToPem(p12 []byte, password string) tls.Certificate {
// PostXMLWithTLS perform a HTTP/POST request with XML body and TLS // PostXMLWithTLS perform a HTTP/POST request with XML body and TLS
func PostXMLWithTLS(uri string, obj interface{}, ca, key string) ([]byte, error) { func PostXMLWithTLS(uri string, obj interface{}, ca, key string) ([]byte, error) {
if uriModifier != nil {
uri = uriModifier(uri)
}
xmlData, err := xml.Marshal(obj) xmlData, err := xml.Marshal(obj)
if err != nil { if err != nil {
return nil, err return nil, err

24
util/query.go Normal file
View File

@@ -0,0 +1,24 @@
package util
import (
"fmt"
"strings"
)
// Query 将Map序列化为Query参数
func Query(params map[string]interface{}) string {
finalString := make([]string, 0)
for key, value := range params {
valueString := ""
switch v := value.(type) {
case int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uint64:
valueString = fmt.Sprintf("%d", v)
case bool:
valueString = fmt.Sprintf("%v", v)
default:
valueString = fmt.Sprintf("%s", v)
}
finalString = append(finalString, strings.Join([]string{key, valueString}, "="))
}
return strings.Join(finalString, "&")
}

19
util/query_test.go Normal file
View File

@@ -0,0 +1,19 @@
package util
import (
"testing"
)
// TestQuery query method test case
func TestQuery(t *testing.T) {
result := Query(map[string]interface{}{
"age": 12,
"name": "Alan",
"cat": "Peter",
})
if result == "" {
// 由于hash是乱序 所以没法很好的预测输出的字符串
// 将会输出符合Query规则的字符串 "age=12&name=Alan&cat=Peter"
t.Error("NOT PASS")
}
}

24
util/template.go Normal file
View File

@@ -0,0 +1,24 @@
package util
import (
"fmt"
"strings"
)
// Template 对字符串中的和map的key相同的字符串进行模板替换 仅支持 形如: {name}
func Template(source string, data map[string]interface{}) string {
sourceCopy := &source
for k, val := range data {
valStr := ""
switch v := val.(type) {
case int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uint64:
valStr = fmt.Sprintf("%d", v)
case bool:
valStr = fmt.Sprintf("%v", v)
default:
valStr = fmt.Sprintf("%s", v)
}
*sourceCopy = strings.Replace(*sourceCopy, strings.Join([]string{"{", k, "}"}, ""), valStr, 1)
}
return *sourceCopy
}

20
util/template_test.go Normal file
View File

@@ -0,0 +1,20 @@
package util
import (
"testing"
)
// TestTemplate testing case about Template method
func TestTemplate(t *testing.T) {
result := Template("{name}={age};{with}={another};any={any};boolean={boolean}", map[string]interface{}{
"name": "Helan",
"age": "33",
"with": "Pep",
"another": "C",
"any": 33,
"boolean": false,
})
if result != "Helan=33;Pep=C;any=33;boolean=false" {
t.Error("NOT PSS testing")
}
}

View File

@@ -1,6 +1,7 @@
package wechat package wechat
import ( import (
"net/http"
"os" "os"
log "github.com/sirupsen/logrus" log "github.com/sirupsen/logrus"
@@ -14,6 +15,7 @@ import (
openConfig "github.com/silenceper/wechat/v2/openplatform/config" openConfig "github.com/silenceper/wechat/v2/openplatform/config"
"github.com/silenceper/wechat/v2/pay" "github.com/silenceper/wechat/v2/pay"
payConfig "github.com/silenceper/wechat/v2/pay/config" payConfig "github.com/silenceper/wechat/v2/pay/config"
"github.com/silenceper/wechat/v2/util"
"github.com/silenceper/wechat/v2/work" "github.com/silenceper/wechat/v2/work"
workConfig "github.com/silenceper/wechat/v2/work/config" workConfig "github.com/silenceper/wechat/v2/work/config"
) )
@@ -40,7 +42,7 @@ func NewWechat() *Wechat {
return &Wechat{} return &Wechat{}
} }
// SetCache 设置cache // SetCache 设置 cache
func (wc *Wechat) SetCache(cache cache.Cache) { func (wc *Wechat) SetCache(cache cache.Cache) {
wc.cache = cache wc.cache = cache
} }
@@ -68,10 +70,21 @@ func (wc *Wechat) GetPay(cfg *payConfig.Config) *pay.Pay {
// GetOpenPlatform 获取微信开放平台的实例 // GetOpenPlatform 获取微信开放平台的实例
func (wc *Wechat) GetOpenPlatform(cfg *openConfig.Config) *openplatform.OpenPlatform { func (wc *Wechat) GetOpenPlatform(cfg *openConfig.Config) *openplatform.OpenPlatform {
if cfg.Cache == nil {
cfg.Cache = wc.cache
}
return openplatform.NewOpenPlatform(cfg) return openplatform.NewOpenPlatform(cfg)
} }
// GetWork 获取企业微信的实例 // GetWork 获取企业微信的实例
func (wc *Wechat) GetWork(cfg *workConfig.Config) *work.Work { func (wc *Wechat) GetWork(cfg *workConfig.Config) *work.Work {
if cfg.Cache == nil {
cfg.Cache = wc.cache
}
return work.NewWork(cfg) return work.NewWork(cfg)
} }
// SetHTTPClient 设置HTTPClient
func (wc *Wechat) SetHTTPClient(client *http.Client) {
util.DefaultHTTPClient = client
}

View File

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

View File

@@ -0,0 +1,220 @@
package addresslist
import (
"fmt"
"github.com/silenceper/wechat/v2/util"
)
const (
// getPermListURL 获取应用的可见范围
getPermListURL = "https://qyapi.weixin.qq.com/cgi-bin/linkedcorp/agent/get_perm_list?access_token=%s"
// getLinkedCorpUserURL 获取互联企业成员详细信息
getLinkedCorpUserURL = "https://qyapi.weixin.qq.com/cgi-bin/linkedcorp/user/get?access_token=%s"
// linkedCorpSimpleListURL 获取互联企业部门成员
linkedCorpSimpleListURL = "https://qyapi.weixin.qq.com/cgi-bin/linkedcorp/user/simplelist?access_token=%s"
// linkedCorpUserListURL 获取互联企业部门成员详情
linkedCorpUserListURL = "https://qyapi.weixin.qq.com/cgi-bin/linkedcorp/user/list?access_token=%s"
// linkedCorpDepartmentListURL 获取互联企业部门列表
linkedCorpDepartmentListURL = "https://qyapi.weixin.qq.com/cgi-bin/linkedcorp/department/list?access_token=%s"
)
// GetPermListResponse 获取应用的可见范围响应
type GetPermListResponse struct {
util.CommonError
UserIDs []string `json:"userids"`
DepartmentIDs []string `json:"department_ids"`
}
// GetPermList 获取应用的可见范围
// see https://developer.work.weixin.qq.com/document/path/93172
func (r *Client) GetPermList() (*GetPermListResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.HTTPPost(fmt.Sprintf(getPermListURL, accessToken), ""); err != nil {
return nil, err
}
result := &GetPermListResponse{}
err = util.DecodeWithError(response, result, "GetPermList")
return result, err
}
// GetLinkedCorpUserRequest 获取互联企业成员详细信息请求
type GetLinkedCorpUserRequest struct {
UserID string `json:"userid"`
}
// GetLinkedCorpUserResponse 获取互联企业成员详细信息响应
type GetLinkedCorpUserResponse struct {
util.CommonError
UserInfo LinkedCorpUserInfo `json:"user_info"`
}
// LinkedCorpUserInfo 互联企业成员详细信息
type LinkedCorpUserInfo struct {
UserID string `json:"userid"`
Name string `json:"name"`
Department []string `json:"department"`
Mobile string `json:"mobile"`
Telephone string `json:"telephone"`
Email string `json:"email"`
Position string `json:"position"`
CorpID string `json:"corpid"`
Extattr Extattr `json:"extattr"`
}
// Extattr 互联企业成员详细信息扩展属性
type Extattr struct {
Attrs []ExtattrItem `json:"attrs"`
}
// ExtattrItem 互联企业成员详细信息扩展属性条目
type ExtattrItem struct {
Name string `json:"name"`
Value string `json:"value,omitempty"`
Type int `json:"type"`
Text ExtattrItemText `json:"text,omitempty"`
Web ExtattrItemWeb `json:"web,omitempty"`
}
// ExtattrItemText 互联企业成员详细信息自定义属性(文本)
type ExtattrItemText struct {
Value string `json:"value"`
}
// ExtattrItemWeb 互联企业成员详细信息自定义属性(网页)
type ExtattrItemWeb struct {
URL string `json:"url"`
Title string `json:"title"`
}
// GetLinkedCorpUser 获取互联企业成员详细信息
// see https://developer.work.weixin.qq.com/document/path/93171
func (r *Client) GetLinkedCorpUser(req *GetLinkedCorpUserRequest) (*GetLinkedCorpUserResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(getLinkedCorpUserURL, accessToken), req); err != nil {
return nil, err
}
result := &GetLinkedCorpUserResponse{}
err = util.DecodeWithError(response, result, "GetLinkedCorpUser")
return result, err
}
// LinkedCorpSimpleListRequest 获取互联企业部门成员请求
type LinkedCorpSimpleListRequest struct {
DepartmentID string `json:"department_id"`
}
// LinkedCorpSimpleListResponse 获取互联企业部门成员响应
type LinkedCorpSimpleListResponse struct {
util.CommonError
Userlist []LinkedCorpUser `json:"userlist"`
}
// LinkedCorpUser 企业部门成员
type LinkedCorpUser struct {
UserID string `json:"userid"`
Name string `json:"name"`
Department []string `json:"department"`
CorpID string `json:"corpid"`
}
// LinkedCorpSimpleList 获取互联企业部门成员
// see https://developer.work.weixin.qq.com/document/path/93168
func (r *Client) LinkedCorpSimpleList(req *LinkedCorpSimpleListRequest) (*LinkedCorpSimpleListResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(linkedCorpSimpleListURL, accessToken), req); err != nil {
return nil, err
}
result := &LinkedCorpSimpleListResponse{}
err = util.DecodeWithError(response, result, "LinkedCorpSimpleList")
return result, err
}
// LinkedCorpUserListRequest 获取互联企业部门成员详情请求
type LinkedCorpUserListRequest struct {
DepartmentID string `json:"department_id"`
}
// LinkedCorpUserListResponse 获取互联企业部门成员详情响应
type LinkedCorpUserListResponse struct {
util.CommonError
UserList []LinkedCorpUserInfo `json:"userlist"`
}
// LinkedCorpUserList 获取互联企业部门成员详情
// see https://developer.work.weixin.qq.com/document/path/93169
func (r *Client) LinkedCorpUserList(req *LinkedCorpUserListRequest) (*LinkedCorpUserListResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(linkedCorpUserListURL, accessToken), req); err != nil {
return nil, err
}
result := &LinkedCorpUserListResponse{}
err = util.DecodeWithError(response, result, "LinkedCorpUserList")
return result, err
}
// LinkedCorpDepartmentListRequest 获取互联企业部门列表请求
type LinkedCorpDepartmentListRequest struct {
DepartmentID string `json:"department_id"`
}
// LinkedCorpDepartmentListResponse 获取互联企业部门列表响应
type LinkedCorpDepartmentListResponse struct {
util.CommonError
DepartmentList []LinkedCorpDepartment `json:"department_list"`
}
// LinkedCorpDepartment 互联企业部门
type LinkedCorpDepartment struct {
DepartmentID string `json:"department_id"`
DepartmentName string `json:"department_name"`
ParentID string `json:"parentid"`
Order int `json:"order"`
}
// LinkedCorpDepartmentList 获取互联企业部门列表
// see https://developer.work.weixin.qq.com/document/path/93170
func (r *Client) LinkedCorpDepartmentList(req *LinkedCorpDepartmentListRequest) (*LinkedCorpDepartmentListResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(linkedCorpDepartmentListURL, accessToken), req); err != nil {
return nil, err
}
result := &LinkedCorpDepartmentListResponse{}
err = util.DecodeWithError(response, result, "LinkedCorpDepartmentList")
return result, err
}

232
work/addresslist/tag.go Normal file
View File

@@ -0,0 +1,232 @@
package addresslist
import (
"fmt"
"github.com/silenceper/wechat/v2/util"
)
const (
// createTagURL 创建标签
createTagURL = "https://qyapi.weixin.qq.com/cgi-bin/tag/create?access_token=%s"
// updateTagURL 更新标签名字
updateTagURL = "https://qyapi.weixin.qq.com/cgi-bin/tag/update?access_token=%s"
// deleteTagURL 删除标签
deleteTagURL = "https://qyapi.weixin.qq.com/cgi-bin/tag/delete?access_token=%s&tagid=%d"
// getTagURL 获取标签成员
getTagURL = "https://qyapi.weixin.qq.com/cgi-bin/tag/get?access_token=%s&tagid=%d"
// addTagUsersURL 增加标签成员
addTagUsersURL = "https://qyapi.weixin.qq.com/cgi-bin/tag/addtagusers?access_token=%s"
// delTagUsersURL 删除标签成员
delTagUsersURL = "https://qyapi.weixin.qq.com/cgi-bin/tag/deltagusers?access_token=%s"
// listTagURL 获取标签列表
listTagURL = "https://qyapi.weixin.qq.com/cgi-bin/tag/list?access_token=%s"
)
type (
// CreateTagRequest 创建标签请求
CreateTagRequest struct {
TagName string `json:"tagname"`
TagID int `json:"tagid,omitempty"`
}
// CreateTagResponse 创建标签响应
CreateTagResponse struct {
util.CommonError
TagID int `json:"tagid"`
}
)
// CreateTag 创建标签
// see https://developer.work.weixin.qq.com/document/path/90210
func (r *Client) CreateTag(req *CreateTagRequest) (*CreateTagResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(createTagURL, accessToken), req); err != nil {
return nil, err
}
result := &CreateTagResponse{}
err = util.DecodeWithError(response, result, "CreateTag")
return result, err
}
type (
// UpdateTagRequest 更新标签名字请求
UpdateTagRequest struct {
TagID int `json:"tagid"`
TagName string `json:"tagname"`
}
)
// UpdateTag 更新标签名字
// see https://developer.work.weixin.qq.com/document/path/90211
func (r *Client) UpdateTag(req *UpdateTagRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(updateTagURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "UpdateTag")
}
// DeleteTag 删除标签
// @see https://developer.work.weixin.qq.com/document/path/90212
func (r *Client) DeleteTag(tagID int) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(deleteTagURL, accessToken, tagID)); err != nil {
return err
}
return util.DecodeWithCommonError(response, "DeleteTag")
}
type (
// GetTagResponse 获取标签成员响应
GetTagResponse struct {
util.CommonError
TagName string `json:"tagname"`
UserList []GetTagUserList `json:"userlist"`
PartyList []int `json:"partylist"`
}
// GetTagUserList 标签中包含的成员列表
GetTagUserList struct {
UserID string `json:"userid"`
Name string `json:"name"`
}
)
// GetTag 获取标签成员
// @see https://developer.work.weixin.qq.com/document/path/90213
func (r *Client) GetTag(tagID int) (*GetTagResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(getTagURL, accessToken, tagID)); err != nil {
return nil, err
}
result := &GetTagResponse{}
err = util.DecodeWithError(response, result, "GetTag")
return result, err
}
type (
// AddTagUsersRequest 增加标签成员请求
AddTagUsersRequest struct {
TagID int `json:"tagid"`
UserList []string `json:"userlist"`
PartyList []int `json:"partylist"`
}
// AddTagUsersResponse 增加标签成员响应
AddTagUsersResponse struct {
util.CommonError
InvalidList string `json:"invalidlist"`
InvalidParty []int `json:"invalidparty"`
}
)
// AddTagUsers 增加标签成员
// see https://developer.work.weixin.qq.com/document/path/90214
func (r *Client) AddTagUsers(req *AddTagUsersRequest) (*AddTagUsersResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(addTagUsersURL, accessToken), req); err != nil {
return nil, err
}
result := &AddTagUsersResponse{}
err = util.DecodeWithError(response, result, "AddTagUsers")
return result, err
}
type (
// DelTagUsersRequest 删除标签成员请求
DelTagUsersRequest struct {
TagID int `json:"tagid"`
UserList []string `json:"userlist"`
PartyList []int `json:"partylist"`
}
// DelTagUsersResponse 删除标签成员响应
DelTagUsersResponse struct {
util.CommonError
InvalidList string `json:"invalidlist"`
InvalidParty []int `json:"invalidparty"`
}
)
// DelTagUsers 删除标签成员
// see https://developer.work.weixin.qq.com/document/path/90215
func (r *Client) DelTagUsers(req *DelTagUsersRequest) (*DelTagUsersResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(delTagUsersURL, accessToken), req); err != nil {
return nil, err
}
result := &DelTagUsersResponse{}
err = util.DecodeWithError(response, result, "DelTagUsers")
return result, err
}
type (
// ListTagResponse 获取标签列表响应
ListTagResponse struct {
util.CommonError
TagList []Tag `json:"taglist"`
}
// Tag 标签
Tag struct {
TagID int `json:"tagid"`
TagName string `json:"tagname"`
}
)
// ListTag 获取标签列表
// @see https://developer.work.weixin.qq.com/document/path/90216
func (r *Client) ListTag() (*ListTagResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(listTagURL, accessToken)); err != nil {
return nil, err
}
result := &ListTagResponse{}
err = util.DecodeWithError(response, result, "ListTag")
return result, err
}

View File

@@ -2,15 +2,28 @@ package addresslist
import ( import (
"fmt" "fmt"
"strings"
"github.com/silenceper/wechat/v2/util" "github.com/silenceper/wechat/v2/util"
) )
const ( const (
// UserSimpleListURL 获取部门成员 // userSimpleListURL 获取部门成员
UserSimpleListURL = "https://qyapi.weixin.qq.com/cgi-bin/user/simplelist?access_token=%s&department_id=%d" userSimpleListURL = "https://qyapi.weixin.qq.com/cgi-bin/user/simplelist"
// UserGetURL 读取成员 // userCreateURL 创建成员
UserGetURL = "https://qyapi.weixin.qq.com/cgi-bin/user/get?access_token=%s&userid=%s" 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 删除成员
userDeleteURL = "https://qyapi.weixin.qq.com/cgi-bin/user/delete"
// userListIDURL 获取成员ID列表
userListIDURL = "https://qyapi.weixin.qq.com/cgi-bin/user/list_id"
// convertToOpenIDURL userID转openID
convertToOpenIDURL = "https://qyapi.weixin.qq.com/cgi-bin/user/convert_to_openid"
// convertToUserIDURL openID转userID
convertToUserIDURL = "https://qyapi.weixin.qq.com/cgi-bin/user/convert_to_userid"
) )
type ( type (
@@ -39,15 +52,154 @@ func (r *Client) UserSimpleList(departmentID int) ([]*UserList, error) {
return nil, err return nil, err
} }
var response []byte var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(UserSimpleListURL, accessToken, departmentID)); err != nil { if response, err = util.HTTPGet(strings.Join([]string{
userSimpleListURL,
util.Query(map[string]interface{}{
"access_token": accessToken,
"department_id": departmentID,
}),
}, "?")); err != nil {
return nil, err return nil, err
} }
result := &UserSimpleListResponse{} result := &UserSimpleListResponse{}
err = util.DecodeWithError(response, result, "UserSimpleList") err = util.DecodeWithError(response, result, "UserSimpleList")
if err != nil { return result.UserList, err
}
type (
// UserCreateRequest 创建成员数据请求
UserCreateRequest struct {
UserID string `json:"userid"`
Name string `json:"name"`
Alias string `json:"alias"`
Mobile string `json:"mobile"`
Department []int `json:"department"`
Order []int `json:"order"`
Position string `json:"position"`
Gender int `json:"gender"`
Email string `json:"email"`
BizMail string `json:"biz_mail"`
IsLeaderInDept []int `json:"is_leader_in_dept"`
DirectLeader []string `json:"direct_leader"`
Enable int `json:"enable"`
AvatarMediaid string `json:"avatar_mediaid"`
Telephone string `json:"telephone"`
Address string `json:"address"`
MainDepartment int `json:"main_department"`
Extattr struct {
Attrs []ExtraAttr `json:"attrs"`
} `json:"extattr"`
ToInvite bool `json:"to_invite"`
ExternalPosition string `json:"external_position"`
ExternalProfile ExternalProfile `json:"external_profile"`
}
// ExtraAttr 扩展属性
ExtraAttr struct {
Type int `json:"type"`
Name string `json:"name"`
Text struct {
Value string `json:"value"`
} `json:"text,omitempty"`
Web struct {
URL string `json:"url"`
Title string `json:"title"`
} `json:"web,omitempty"`
}
// ExternalProfile 成员对外信息
ExternalProfile struct {
ExternalCorpName string `json:"external_corp_name"`
WechatChannels struct {
Nickname string `json:"nickname"`
Status int `json:"status"`
} `json:"wechat_channels"`
ExternalAttr []ExternalProfileAttr `json:"external_attr"`
}
// ExternalProfileAttr 成员对外信息属性
ExternalProfileAttr struct {
Type int `json:"type"`
Name string `json:"name"`
Text struct {
Value string `json:"value"`
} `json:"text,omitempty"`
Web struct {
URL string `json:"url"`
Title string `json:"title"`
} `json:"web,omitempty"`
Miniprogram struct {
Appid string `json:"appid"`
Pagepath string `json:"pagepath"`
Title string `json:"title"`
} `json:"miniprogram,omitempty"`
}
// UserCreateResponse 创建成员数据响应
UserCreateResponse struct {
util.CommonError
}
)
// UserCreate 创建成员
// @see https://developer.work.weixin.qq.com/document/path/90195
func (r *Client) UserCreate(req *UserCreateRequest) (*UserCreateResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err return nil, err
} }
return result.UserList, nil var response []byte
if response, err = util.PostJSON(fmt.Sprintf(userCreateURL, accessToken), req); err != nil {
return nil, err
}
result := &UserCreateResponse{}
err = util.DecodeWithError(response, result, "UserCreate")
return result, err
}
// 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 string `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
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(userUpdateURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "UserUpdate")
} }
// UserGetResponse 获取部门成员响应 // UserGetResponse 获取部门成员响应
@@ -112,7 +264,7 @@ type UserGetResponse struct {
} `json:"external_profile"` // 成员对外属性,字段详情见对外属性;代开发自建应用需要管理员授权才返回;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段 } `json:"external_profile"` // 成员对外属性,字段详情见对外属性;代开发自建应用需要管理员授权才返回;第三方仅通讯录应用可获取;对于非第三方创建的成员,第三方通讯录应用也不可获取;上游企业不可获取下游企业成员该字段
} }
// UserGet 获取部门成员 // UserGet 读取成员
// @see https://developer.work.weixin.qq.com/document/path/90196 // @see https://developer.work.weixin.qq.com/document/path/90196
func (r *Client) UserGet(UserID string) (*UserGetResponse, error) { func (r *Client) UserGet(UserID string) (*UserGetResponse, error) {
var ( var (
@@ -123,13 +275,173 @@ func (r *Client) UserGet(UserID string) (*UserGetResponse, error) {
return nil, err return nil, err
} }
var response []byte var response []byte
if response, err = util.HTTPGet(fmt.Sprintf(UserGetURL, accessToken, UserID)); err != nil {
if response, err = util.HTTPGet(
strings.Join([]string{
userGetURL,
util.Query(map[string]interface{}{
"access_token": accessToken,
"userid": UserID,
}),
}, "?")); err != nil {
return nil, err return nil, err
} }
result := &UserGetResponse{} result := &UserGetResponse{}
err = util.DecodeWithError(response, result, "UserGet") err = util.DecodeWithError(response, result, "UserGet")
if err != nil { return result, err
}
type (
// UserDeleteResponse 删除成员数据响应
UserDeleteResponse struct {
util.CommonError
}
)
// UserDelete 删除成员
// @see https://developer.work.weixin.qq.com/document/path/90334
func (r *Client) UserDelete(userID string) (*UserDeleteResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err return nil, err
} }
return result, nil var response []byte
if response, err = util.HTTPGet(strings.Join([]string{
userDeleteURL,
util.Query(map[string]interface{}{
"access_token": accessToken,
"userid": userID,
}),
}, "?")); err != nil {
return nil, err
}
result := &UserDeleteResponse{}
err = util.DecodeWithError(response, result, "UserDelete")
return result, err
}
// UserListIDRequest 获取成员ID列表请求
type UserListIDRequest struct {
Cursor string `json:"cursor"`
Limit int `json:"limit"`
}
// UserListIDResponse 获取成员ID列表响应
type UserListIDResponse struct {
util.CommonError
NextCursor string `json:"next_cursor"`
DeptUser []*DeptUser `json:"dept_user"`
}
// DeptUser 用户-部门关系
type DeptUser struct {
UserID string `json:"userid"`
Department int `json:"department"`
}
// UserListID 获取成员ID列表
// see https://developer.work.weixin.qq.com/document/path/96067
func (r *Client) UserListID(req *UserListIDRequest) (*UserListIDResponse, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return nil, err
}
var response []byte
if response, err = util.PostJSON(strings.Join([]string{
userListIDURL,
util.Query(map[string]interface{}{
"access_token": accessToken,
}),
}, "?"), req); err != nil {
return nil, err
}
result := &UserListIDResponse{}
err = util.DecodeWithError(response, result, "UserListID")
return result, err
}
type (
// convertToOpenIDRequest userID转openID请求
convertToOpenIDRequest struct {
UserID string `json:"userid"`
}
// convertToOpenIDResponse userID转openID响应
convertToOpenIDResponse struct {
util.CommonError
OpenID string `json:"openid"`
}
)
// ConvertToOpenID userID转openID
// see https://developer.work.weixin.qq.com/document/path/90202
func (r *Client) ConvertToOpenID(userID string) (string, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return "", err
}
var response []byte
if response, err = util.PostJSON(strings.Join([]string{
convertToOpenIDURL,
util.Query(map[string]interface{}{
"access_token": accessToken,
}),
}, "?"), &convertToOpenIDRequest{
UserID: userID,
}); err != nil {
return "", err
}
result := &convertToOpenIDResponse{}
err = util.DecodeWithError(response, result, "ConvertToOpenID")
return result.OpenID, err
}
type (
// convertToUserIDRequest openID转userID请求
convertToUserIDRequest struct {
OpenID string `json:"openid"`
}
// convertToUserIDResponse openID转userID响应
convertToUserIDResponse struct {
util.CommonError
UserID string `json:"userid"`
}
)
// ConvertToUserID openID转userID
// see https://developer.work.weixin.qq.com/document/path/90202
func (r *Client) ConvertToUserID(openID string) (string, error) {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return "", err
}
var response []byte
if response, err = util.PostJSON(strings.Join([]string{
convertToUserIDURL,
util.Query(map[string]interface{}{
"access_token": accessToken,
}),
}, "?"), &convertToUserIDRequest{
OpenID: openID,
}); err != nil {
return "", err
}
result := &convertToUserIDResponse{}
err = util.DecodeWithError(response, result, "ConvertToUserID")
return result.UserID, err
} }

113
work/appchat/appchat.go Normal file
View File

@@ -0,0 +1,113 @@
package appchat
import (
"encoding/json"
"fmt"
"github.com/silenceper/wechat/v2/util"
)
const (
// 应用推送消息接口地址
sendURL = "https://qyapi.weixin.qq.com/cgi-bin/appchat/send?access_token=%s"
)
type (
// SendRequestCommon 发送应用推送消息请求公共参数
SendRequestCommon struct {
// 群聊id
ChatID string `json:"chatid"`
// 消息类型
MsgType string `json:"msgtype"`
// 表示是否是保密消息0表示否1表示是默认0
Safe int `json:"safe"`
}
// SendResponse 发送应用消息响应参数
SendResponse struct {
util.CommonError
}
// SendTextRequest 发送文本消息的请求
SendTextRequest struct {
*SendRequestCommon
Text TextField `json:"text"`
}
// TextField 文本消息参数
TextField struct {
// 消息内容最长不超过2048个字节
Content string `json:"content"`
}
// SendImageRequest 发送图片消息的请求
SendImageRequest struct {
*SendRequestCommon
Image ImageField `json:"image"`
}
// ImageField 图片消息参数
ImageField struct {
// 图片媒体文件id可以调用上传临时素材接口获取
MediaID string `json:"media_id"`
}
// SendVoiceRequest 发送语音消息的请求
SendVoiceRequest struct {
*SendRequestCommon
Voice VoiceField `json:"voice"`
}
// VoiceField 语音消息参数
VoiceField struct {
// 语音文件id可以调用上传临时素材接口获取
MediaID string `json:"media_id"`
}
)
// Send 发送应用消息
// @desc 实现企业微信发送应用消息接口https://developer.work.weixin.qq.com/document/path/90248
func (r *Client) Send(apiName string, request interface{}) (*SendResponse, error) {
// 获取accessToken
accessToken, err := r.GetAccessToken()
if err != nil {
return nil, err
}
// 请求参数转 JSON 格式
jsonData, err := json.Marshal(request)
if err != nil {
return nil, err
}
// 发起http请求
response, err := util.HTTPPost(fmt.Sprintf(sendURL, accessToken), string(jsonData))
if err != nil {
return nil, err
}
// 按照结构体解析返回值
result := &SendResponse{}
err = util.DecodeWithError(response, result, apiName)
// 返回数据
return result, err
}
// SendText 发送文本消息
func (r *Client) SendText(request SendTextRequest) (*SendResponse, error) {
// 发送文本消息MsgType参数固定为text
request.MsgType = "text"
return r.Send("MessageSendText", request)
}
// SendImage 发送图片消息
func (r *Client) SendImage(request SendImageRequest) (*SendResponse, error) {
// 发送图片消息MsgType参数固定为image
request.MsgType = "image"
return r.Send("MessageSendImage", request)
}
// SendVoice 发送语音消息
func (r *Client) SendVoice(request SendVoiceRequest) (*SendResponse, error) {
// 发送语音消息MsgType参数固定为voice
request.MsgType = "voice"
return r.Send("MessageSendVoice", request)
}
// 以上实现了部分常用消息推送SendText 发送文本消息、SendImage 发送图片消息、SendVoice 发送语音消息,
// 如需扩展其他消息类型,建议按照以上格式,扩展对应消息类型的参数即可
// 也可以直接使用Send方法按照企业微信消息推送的接口文档传对应消息类型的参数来使用

16
work/appchat/client.go Normal file
View File

@@ -0,0 +1,16 @@
// Package appchat 应用发送消息到群聊会话,企业微信接口https://developer.work.weixin.qq.com/document/path/90248
package appchat
import (
"github.com/silenceper/wechat/v2/work/context"
)
// Client 接口实例
type Client struct {
*context.Context
}
// NewClient 初始化实例
func NewClient(ctx *context.Context) *Client {
return &Client{ctx}
}

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

@@ -0,0 +1,428 @@
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"`
}
// OptionGroupRuleCheckinTime 工作日上下班打卡时间信息
type OptionGroupRuleCheckinTime struct {
TimeID int64 `json:"time_id"`
WorkSec int64 `json:"work_sec"`
OffWorkSec int64 `json:"off_work_sec"`
RemindWorkSec int64 `json:"remind_work_sec"`
RemindOffWorkSec int64 `json:"remind_off_work_sec"`
AllowRest bool `json:"allow_rest"`
RestBeginTime int64 `json:"rest_begin_time"`
RestEndTime int64 `json:"rest_end_time"`
EarliestWorkSec int64 `json:"earliest_work_sec"`
LatestWorkSec int64 `json:"latest_work_sec"`
EarliestOffWorkSec int64 `json:"earliest_off_work_sec"`
LatestOffWorkSec int64 `json:"latest_off_work_sec"`
NoNeedCheckOn bool `json:"no_need_checkon"`
NoNeedCheckOff bool `json:"no_need_checkoff"`
}
// OptionGroupLateRule 晚走晚到时间规则信息
type OptionGroupLateRule struct {
OffWorkAfterTime int64 `json:"offwork_after_time"`
OnWorkFlexTime int64 `json:"onwork_flex_time"`
AllowOffWorkAfterTime int64 `json:"allow_offwork_after_time"`
TimeRules []OptionGroupTimeRule `json:"timerules"`
}
// OptionGroupTimeRule 晚走晚到时间规则
type OptionGroupTimeRule struct {
OffWorkAfterTime int64 `json:"offwork_after_time"`
OnWorkFlexTime int64 `json:"onwork_flex_time"`
}
// OptionGroupSpeWorkdays 特殊工作日
type OptionGroupSpeWorkdays struct {
Timestamp int64 `json:"timestamp"`
Notes string `json:"notes"`
CheckinTime []OptionGroupCheckinTime `json:"checkintime"`
Type int64 `json:"type"`
BegTime int64 `json:"begtime"`
EndTime int64 `json:"endtime"`
}
// OptionGroupCheckinTime 特殊工作日的上下班打卡时间配置
type OptionGroupCheckinTime struct {
TimeID int64 `json:"time_id"`
WorkSec int64 `json:"work_sec"`
OffWorkSec int64 `json:"off_work_sec"`
RemindWorkSec int64 `json:"remind_work_sec"`
RemindOffWorkSec int64 `json:"remind_off_work_sec"`
}
// OptionGroupSpeOffDays 特殊非工作日
type OptionGroupSpeOffDays struct {
Timestamp int64 `json:"timestamp"`
Notes string `json:"notes"`
Type int64 `json:"type"`
BegTime int64 `json:"begtime"`
EndTime int64 `json:"endtime"`
}
// OptionGroupWifiMacInfos WIFI信息
type OptionGroupWifiMacInfos struct {
WifiName string `json:"wifiname"`
WifiMac string `json:"wifimac"`
}
// OptionGroupLocInfos 地点信息
type OptionGroupLocInfos struct {
Lat int64 `json:"lat"`
Lng int64 `json:"lng"`
LocTitle string `json:"loc_title"`
LocDetail string `json:"loc_detail"`
Distance int64 `json:"distance"`
}
// OptionGroupRange 人员信息
type OptionGroupRange struct {
PartyID []string `json:"party_id"`
UserID []string `json:"userid"`
TagID []int64 `json:"tagid"`
}
// OptionGroupReporterInfo 汇报人
type OptionGroupReporterInfo struct {
Reporters []OptionGroupReporters `json:"reporters"`
}
// OptionGroupReporters 汇报对象
type OptionGroupReporters struct {
UserID string `json:"userid"`
TagID int64 `json:"tagid"`
}
// OptionGroupScheduleList 自定义排班规则所有排班
type OptionGroupScheduleList struct {
ScheduleID int64 `json:"schedule_id"`
ScheduleName string `json:"schedule_name"`
TimeSection []OptionGroupTimeSection `json:"time_section"`
AllowFlex bool `json:"allow_flex"`
FlexOnDutyTime int64 `json:"flex_on_duty_time"`
FlexOffDutyTime int64 `json:"flex_off_duty_time"`
LateRule OptionGroupLateRule `json:"late_rule"`
MaxAllowArriveEarly int64 `json:"max_allow_arrive_early"`
MaxAllowArriveLate int64 `json:"max_allow_arrive_late"`
}
// OptionGroupTimeSection 班次上下班时段信息
type OptionGroupTimeSection struct {
TimeID int64 `json:"time_id"`
WorkSec int64 `json:"work_sec"`
OffWorkSec int64 `json:"off_work_sec"`
RemindWorkSec int64 `json:"remind_work_sec"`
RemindOffWorkSec int64 `json:"remind_off_work_sec"`
RestBeginTime int64 `json:"rest_begin_time"`
RestEndTime int64 `json:"rest_end_time"`
AllowRest bool `json:"allow_rest"`
EarliestWorkSec int64 `json:"earliest_work_sec"`
LatestWorkSec int64 `json:"latest_work_sec"`
EarliestOffWorkSec int64 `json:"earliest_off_work_sec"`
LatestOffWorkSec int64 `json:"latest_off_work_sec"`
NoNeedCheckOn bool `json:"no_need_checkon"`
NoNeedCheckOff bool `json:"no_need_checkoff"`
}
// OptionGroupOtInfoV2 加班配置
type OptionGroupOtInfoV2 struct {
WorkdayConf OptionGroupWorkdayConf `json:"workdayconf"`
}
// OptionGroupWorkdayConf 工作日加班配置
type OptionGroupWorkdayConf struct {
AllowOt bool `json:"allow_ot"`
Type int64 `json:"type"`
}
// OptionGroupBukaRemind 补卡提醒
type OptionGroupBukaRemind struct {
OpenRemind bool `json:"open_remind"`
BukaRemindDay int64 `json:"buka_remind_day"`
BukaRemindMonth int64 `json:"buka_remind_month"`
}
// AddOption 创建打卡规则
// see https://developer.work.weixin.qq.com/document/path/98041#%E5%88%9B%E5%BB%BA%E6%89%93%E5%8D%A1%E8%A7%84%E5%88%99
func (r *Client) AddOption(req *AddOptionRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(addOptionURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "AddOption")
}
// UpdateOptionRequest 修改打卡规则请求
type UpdateOptionRequest struct {
EffectiveNow bool `json:"effective_now,omitempty"`
Group OptionGroupRule `json:"group,omitempty"`
}
// UpdateOption 修改打卡规则
// see https://developer.work.weixin.qq.com/document/path/98041#%E4%BF%AE%E6%94%B9%E6%89%93%E5%8D%A1%E8%A7%84%E5%88%99
func (r *Client) UpdateOption(req *UpdateOptionRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(updateOptionURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "UpdateOption")
}
// ClearOptionRequest 清空打卡规则数组元素请求
type ClearOptionRequest struct {
GroupID int64 `json:"groupid"`
ClearField []int64 `json:"clear_field"`
EffectiveNow bool `json:"effective_now"`
}
// ClearOption 清空打卡规则数组元素
// see https://developer.work.weixin.qq.com/document/path/98041#%E6%B8%85%E7%A9%BA%E6%89%93%E5%8D%A1%E8%A7%84%E5%88%99%E6%95%B0%E7%BB%84%E5%85%83%E7%B4%A0
func (r *Client) ClearOption(req *ClearOptionRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(clearOptionURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "ClearOption")
}
// DelOptionRequest 删除打卡规则请求
type DelOptionRequest struct {
GroupID int64 `json:"groupid"`
EffectiveNow bool `json:"effective_now"`
}
// DelOption 删除打卡规则
// see https://developer.work.weixin.qq.com/document/path/98041#%E5%88%A0%E9%99%A4%E6%89%93%E5%8D%A1%E8%A7%84%E5%88%99
func (r *Client) DelOption(req *DelOptionRequest) error {
var (
accessToken string
err error
)
if accessToken, err = r.GetAccessToken(); err != nil {
return err
}
var response []byte
if response, err = util.PostJSON(fmt.Sprintf(delOptionURL, accessToken), req); err != nil {
return err
}
return util.DecodeWithCommonError(response, "DelOption")
}
// 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 企业微信 // Config for 企业微信
type Config struct { type Config struct {
CorpID string `json:"corp_id"` // corp_id CorpID string `json:"corp_id"` // corp_id
CorpSecret string `json:"corp_secret"` // corp_secret,如果需要获取会话存档实例当前参数请填写聊天内容存档的Secret可以在企业微信管理端--管理工具--聊天内容存档查看 CorpSecret string `json:"corp_secret"` // corp_secret,如果需要获取会话存档实例当前参数请填写聊天内容存档的Secret可以在企业微信管理端--管理工具--聊天内容存档查看
AgentID string `json:"agent_id"` // agent_id AgentID string `json:"agent_id"` // agent_id
Cache cache.Cache Cache cache.Cache
RasPrivateKey string // 消息加密私钥,可以在企业微信管理端--管理工具--消息加密公钥查看对用公钥,私钥一般由自己保存 RasPrivateKey string // 消息加密私钥,可以在企业微信管理端--管理工具--消息加密公钥查看对用公钥,私钥一般由自己保存
Token string `json:"token"` // 微信客服回调配置,用于生成签名校验回调请求的合法性 Token string `json:"token"` // 微信客服回调配置,用于生成签名校验回调请求的合法性
EncodingAESKey string `json:"encoding_aes_key"` // 微信客服回调p配置用于解密回调消息内容对应的密文 EncodingAESKey string `json:"encoding_aes_key"` // 微信客服回调p配置用于解密回调消息内容对应的密文
} }

View File

@@ -0,0 +1,43 @@
package externalcontact
import (
"encoding/xml"
"github.com/silenceper/wechat/v2/util"
)
// 原始回调消息内容
type callbackOriginMessage struct {
ToUserName string // 企业微信的CorpID当为第三方套件回调事件时CorpID的内容为suiteid
AgentID string // 接收的应用id可在应用的设置页面获取
Encrypt string // 消息结构体加密后的字符串
}
// EventCallbackMessage 微信客户联系回调消息
// https://developer.work.weixin.qq.com/document/path/92130
type EventCallbackMessage struct {
ToUserName string `json:"to_user_name"`
FromUserName string `json:"from_user_name"`
CreateTime int64 `json:"create_time"`
MsgType string `json:"msg_type"`
Event string `json:"event"`
ChangeType string `json:"change_type"`
UserID string `json:"user_id"`
ExternalUserID string `json:"external_user_id"`
State string `json:"state"`
WelcomeCode string `json:"welcome_code"`
}
// GetCallbackMessage 获取联系客户回调事件中的消息内容
func (r *Client) GetCallbackMessage(encryptedMsg []byte) (msg EventCallbackMessage, err error) {
var origin callbackOriginMessage
if err = xml.Unmarshal(encryptedMsg, &origin); err != nil {
return
}
_, bData, err := util.DecryptMsg(r.CorpID, origin.Encrypt, r.EncodingAESKey)
if err != nil {
return
}
err = xml.Unmarshal(bData, &msg)
return
}

View File

@@ -7,16 +7,16 @@ import (
) )
const ( const (
// AddContactWayURL 配置客户联系「联系我」方式 // addContactWayURL 配置客户联系「联系我」方式
AddContactWayURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_contact_way?access_token=%s" addContactWayURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_contact_way?access_token=%s"
// GetContactWayURL 获取企业已配置的「联系我」方式 // getContactWayURL 获取企业已配置的「联系我」方式
GetContactWayURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_contact_way?access_token=%s" getContactWayURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_contact_way?access_token=%s"
// UpdateContactWayURL 更新企业已配置的「联系我」方式 // updateContactWayURL 更新企业已配置的「联系我」方式
UpdateContactWayURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/update_contact_way?access_token=%s" updateContactWayURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/update_contact_way?access_token=%s"
// ListContactWayURL 获取企业已配置的「联系我」列表 // listContactWayURL 获取企业已配置的「联系我」列表
ListContactWayURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/list_contact_way?access_token=%s" listContactWayURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/list_contact_way?access_token=%s"
// DelContactWayURL 删除企业已配置的「联系我」方式 // delContactWayURL 删除企业已配置的「联系我」方式
DelContactWayURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/del_contact_way?access_token=%s" delContactWayURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/del_contact_way?access_token=%s"
) )
type ( type (
@@ -98,14 +98,12 @@ func (r *Client) AddContactWay(req *AddContactWayRequest) (*AddContactWayRespons
return nil, err return nil, err
} }
var response []byte var response []byte
if response, err = util.PostJSON(fmt.Sprintf(AddContactWayURL, accessToken), req); err != nil { if response, err = util.PostJSON(fmt.Sprintf(addContactWayURL, accessToken), req); err != nil {
return nil, err return nil, err
} }
result := &AddContactWayResponse{} result := &AddContactWayResponse{}
if err = util.DecodeWithError(response, result, "AddContactWay"); err != nil { err = util.DecodeWithError(response, result, "AddContactWay")
return nil, err return result, err
}
return result, nil
} }
type ( type (
@@ -149,14 +147,12 @@ func (r *Client) GetContactWay(req *GetContactWayRequest) (*GetContactWayRespons
return nil, err return nil, err
} }
var response []byte var response []byte
if response, err = util.PostJSON(fmt.Sprintf(GetContactWayURL, accessToken), req); err != nil { if response, err = util.PostJSON(fmt.Sprintf(getContactWayURL, accessToken), req); err != nil {
return nil, err return nil, err
} }
result := &GetContactWayResponse{} result := &GetContactWayResponse{}
if err = util.DecodeWithError(response, result, "GetContactWay"); err != nil { err = util.DecodeWithError(response, result, "GetContactWay")
return nil, err return result, err
}
return result, nil
} }
type ( type (
@@ -191,14 +187,12 @@ func (r *Client) UpdateContactWay(req *UpdateContactWayRequest) (*UpdateContactW
return nil, err return nil, err
} }
var response []byte var response []byte
if response, err = util.PostJSON(fmt.Sprintf(UpdateContactWayURL, accessToken), req); err != nil { if response, err = util.PostJSON(fmt.Sprintf(updateContactWayURL, accessToken), req); err != nil {
return nil, err return nil, err
} }
result := &UpdateContactWayResponse{} result := &UpdateContactWayResponse{}
if err = util.DecodeWithError(response, result, "UpdateContactWay"); err != nil { err = util.DecodeWithError(response, result, "UpdateContactWay")
return nil, err return result, err
}
return result, nil
} }
type ( type (
@@ -232,14 +226,12 @@ func (r *Client) ListContactWay(req *ListContactWayRequest) (*ListContactWayResp
return nil, err return nil, err
} }
var response []byte var response []byte
if response, err = util.PostJSON(fmt.Sprintf(ListContactWayURL, accessToken), req); err != nil { if response, err = util.PostJSON(fmt.Sprintf(listContactWayURL, accessToken), req); err != nil {
return nil, err return nil, err
} }
result := &ListContactWayResponse{} result := &ListContactWayResponse{}
if err = util.DecodeWithError(response, result, "ListContactWay"); err != nil { err = util.DecodeWithError(response, result, "ListContactWay")
return nil, err return result, err
}
return result, nil
} }
type ( type (
@@ -264,12 +256,10 @@ func (r *Client) DelContactWay(req *DelContactWayRequest) (*DelContactWayRespons
return nil, err return nil, err
} }
var response []byte var response []byte
if response, err = util.PostJSON(fmt.Sprintf(DelContactWayURL, accessToken), req); err != nil { if response, err = util.PostJSON(fmt.Sprintf(delContactWayURL, accessToken), req); err != nil {
return nil, err return nil, err
} }
result := &DelContactWayResponse{} result := &DelContactWayResponse{}
if err = util.DecodeWithError(response, result, "DelContactWay"); err != nil { err = util.DecodeWithError(response, result, "DelContactWay")
return nil, err return result, err
}
return result, nil
} }

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