go-wecom

Wechat Work/Wecom/企业微信 Golang SDK

特性

支持自建应用开发 - AccessToken
支持第三方应用开发 - AuthCorpAccessToken
支持缓存所有带时效的信息 - AccessToken, JsTicket, AgentTicket, SuiteToken, AuthCorpAccessToken, PreAuthCode, ProviderAccessToken
- 缓存支持自定义存储 - 默认内存存储
支持从自定义的存储获取密钥信息 - SuiteTicket, PermanentCode
支持机器人 webhook
没有内部状态和 goroutine
自动尝试提前获取相应的 Token 和 Ticket - 有效期的 80%
实现逻辑清晰 - 没有实现的接口可直接调用
wwcrypt - 企业微信回调加密实现 - 作用同 sbzhu/weworkapi_golang
数据模型大多基于官方接口文档生成 - 包含注释说明
包含 API+Event Mock 测试
支持拉取会话存档

package wecom_test

import (
  "fmt"
  "os"

  "github.com/wenerme/go-req"
  "github.com/wenerme/go-wecom/wecom"
)

func ExampleNewClient() {
	// token store - 默认内存 Map - 可以使用数据库实现
	store := &wecom.SyncMapStore{}
	// 加载缓存 - 复用之前的 Token
	if bytes, err := os.ReadFile("wecom-cache.json"); err == nil {
		_ = store.Restore(bytes)
	}
	// 当 Token 变化时生成缓存文件
	store.OnChange = func(s *wecom.SyncMapStore) {
		_ = os.WriteFile("wecom-cache.json", s.Dump(), 0o600)
	}

	client := wecom.NewClient(wecom.Conf{
		CorpID:     "",
		AgentID:    0,
		CorpSecret: "",
		// 不配置默认使用 内存缓存
		TokenProvider: &wecom.TokenCache{
			Store: store,
		},
	})

	// 访问接口会自动获取或使用当前缓存
	token, err := client.AccessToken()
	if err != nil {
		panic(err)
	}
	fmt.Println("Token", token)
	ticket, err := client.JsAPITicket()
	if err != nil {
		panic(err)
	}
	fmt.Println("Ticket", ticket)

	// 访问没有实现的接口
	dto := wecom.IPListResponse{}
	err = client.Request.With(req.Request{
		URL:     "/cgi-bin/get_api_domain_ip",
		Options: []interface{}{
			// 如果不需要 access_token
			// wecom.WithoutAccessToken,
		},
	}).Fetch(&dto)
	if err != nil {
		panic(err)
	}
	fmt.Println("response", dto)
}

Webhook 开发

wecom.WebhookSend(&wecom.WebhookSendRequest{
  Key:     "KEY",
  Content: wecom.SendTextContent{Content: "Hello"},
  // debug for test only
  Request: req.Request{
    Options: []interface{}{req.DebugHook(&req.DebugOptions{
      Body: true,
    })},
  },
})

第三方应用开发配置

根据使用的接口不同，用到的信息也会不同

client := wecom.NewClient(wecom.Conf{
  CorpID:   "",
  ProviderSecret: "",
  AuthCorpID:   "",
  AuthCorpPermanentCode: "",
  SuiteID:      "",
  SuiteSecret:  "",
  SuiteTicket:  "",
})

接口支持情况

应用授权 - 100%

通讯录管理 - 100%

客户联系 - 100%

身份验证 - 100%

获取访问用户身份

推广二维码

应用管理 - 100%

消息推送 - 100%

消息类型

素材管理

上传临时素材
上传永久图片
获取临时素材
获取高清语音素材

效率工具 - 20%

企业支付

企业互联

获取应用共享信息
获取下级企业的access_token
获取下级企业的小程序session

会话内容存档 - 100%

获取会话内容存档开启成员列表
获取会话同意情况
客户同意进行聊天内容存档事件回调
获取会话内容存档内部群信息

电子发票

查询电子发票
更新发票状态
批量更新发票状态
批量查询电子发票

TBD
- 将企业管理员添加为外部联系人 https://work.weixin.qq.com/api/doc/13613
- change_external_tag shuffle
- 批量安装应用 https://open.work.weixin.qq.com/api/doc/20990

会话存档

Note

会话存档保存 5 天

从 Sequence+1 拉取，不包含 Sequence

limit 最大 1000

图片 jpg, 音频 amr, 视频 mp4

MediaData 的 MD5 可能匹配不上，可以一直重试

MediaData 单次最多返回 512K

libWeWorkFinanceSdk_C.so
- 依赖 GLIBC
- 使用了 libcurl
  - https_proxy 能生效
实际请求 qyapi.weixin.qq.com
RSA2048 key
- openssl genrsa -out private.pem 2048
- openssl rsa -in private.pem -pubout -out public.pem
wwfinance-libs 内嵌了 libWeWorkFinanceSdk_C.so，可以解压出来
wwfinance-poller 提供基础的验证工具
- 拉取所有数据到 sqlite wwfinance.db

命令行工具

make bin

# 配置
cp .env.example .env
# extract lib
./bin/wwfinance-libs

LD_LIBRARY_PATH=/tmp/wwf/libs ./bin/wwfinance-poller

# Docker 运行
docker run --rm -it -v $PWD/.env:/app/.env -v $PWD/data:/app/data wener/go-wecom

# 开发测试
LD_LIBRARY_PATH=$PWD/WeWorkFinanceSDK/libs go run ./cmd/wwfinance-poller/main.go

代码调用

package main

import (
	"fmt"
	dotenv "github.com/joho/godotenv"
	"github.com/wenerme/go-wecom/WeWorkFinanceSDK"
)

func main() {
	_ = dotenv.Load()

	client, err := WeWorkFinanceSDK.NewClientFromEnv()
	if err != nil {
		panic(err)
	}

	data, err := client.GetChatData(WeWorkFinanceSDK.GetChatDataOptions{
		Limit:   10,
		Timeout: 5,
	})

	if err != nil {
		panic(err)
	}
	for _, v := range data {
		fmt.Println(v.Message)
	}
}

支持代理
- https_proxy=127.0.0.1:1080

Reference

wenerme/go-req
- 接口底层库
xen0n/go-workwx
- 比较成熟的 Golang 企业微信 SDK
- 没有第三方接口、服务商接口、会话存档
NICEXAI/WeWorkFinanceSDK
- 封装 WeWorkFinanceSDK
sbzhu/weworkapi_golang
- 官方 Golang 加密库

wenerme / go-wecom Goto Github PK

go-wecom's Introduction

go-wecom

特性

Webhook 开发

第三方应用开发配置

接口支持情况

消息类型

会话存档

Reference

go-wecom's People

Contributors

Stargazers

Watchers

Forkers

go-wecom's Issues

Recommend Projects

Recommend Topics

Recommend Org