gochat

README

gochat

📦 微信 Go SDK

模块	功能
支付 > mch	下单 . 支付 . 退款 . 查询 . 委托代扣 . 红包 . 企业付款 . 账单 . 评价数据 . 验签 . 解密
公众号 > offia	授权 . 用户 . 消息 . 素材 . 菜单 . 发布能力 . 草稿箱 . 客服 . 二维码 . OCR . 回复 . 事件处理
小程序 > minip	授权 . 解密 . 二维码 . 消息 . 客服 . 素材 . 插件 . URL Scheme . URL Link . OCR . 事件处理
企业微信 > corp	支持几乎所有服务端API

获取

go get -u github.com/shenghui0779/gochat

使用须知

• 微信API被封装成 Action 接口（授权 和 AccessToken 等部分API除外）
• 每个API对应一个 Action，统一由 Do 方法执行
• 除支付 (mch) 外，返回结果均以 Result 为前缀的结构体指针接收
• 对于微信支付的回调通知处理，提供了两个方法：
  • 验签 - VerifyWXMLResult
  • 解密 - DecryptWithAES256ECB (退款)
• 对于微信推送的事件消息处理，提供了三个方法：
  • 验签 - VerifyEventSign
  • 解密 - DecryptEventMessage
  • 回复 - Reply
• 企业微信按照不同功能模块划分了相应的目录，根据URL可以找到对应的目录和文件
• 所有API均采用Mock单元测试（Mock数据来源于官方文档，如遇问题，欢迎提Issue）

• 执行单元测试时，有些不能通过（如：因时间戳导致等），代码中有相关注释说明
• 执行 mch 单元测试时，还需要使用用于单元测试的 FormatMap2XMLForTest

支付

• 版本：v2
• 模式：普通商户 & 服务商

import (
    "github.com/shenghui0779/gochat"
    "github.com/shenghui0779/gochat/wx"
    "github.com/shenghui0779/gochat/mch"
)

// 创建实例
pay := gochat.NewMch("mchid", "apikey", options...)

// --------------- 统一下单 -------------------------------

action := mch.UnifyOrder("appid", &mch.ParamsUnifyOrder{...})
result, err := pay.Do(ctx, action)

if err != nil {
    log.Fatal(err)
}

fmt.Println(result)

// --------------- 拉起支付 -------------------------------

// APP支付
pay.APPAPI("appid", "prepayID")

// JSAPI/小程序支付
pay.JSAPI("appid", "prepayID")

// 小程序红包
pay.MinipRedpackJSAPI("appid", "package")

公众号

import (
    "github.com/shenghui0779/gochat"
    "github.com/shenghui0779/gochat/wx"
    "github.com/shenghui0779/gochat/offia"
)

// 创建实例
oa := gochat.NewOffia("appid", "appsecret", options...)

// --------------- 生成网页授权URL -------------------------------

url := oa.OAuth2URL(offia.ScopeSnsapiBase, "redirectURL", "state")

fmt.Println(url)

// --------------- 获取网页授权Token -------------------------------

result, err := oa.Code2OAuthToken(ctx, "code")

if err != nil {
    log.Fatal(err)
}

fmt.Println(result)

// --------------- 获取AccessToken -------------------------------

result, err := oa.AccessToken(ctx)

if err != nil {
    log.Fatal(err)
}

fmt.Println(result)

// --------------- 获取关注的用户列表 -------------------------------

result := new(offia.ResultUserList)
action := offia.GetUserList("nextOpenID", result)

if err := oa.Do(ctx, action); err != nil {
    log.Fatal(err)
}

fmt.Println(result)

小程序

import (
    "github.com/shenghui0779/gochat"
    "github.com/shenghui0779/gochat/wx"
    "github.com/shenghui0779/gochat/minip"
)

// 创建实例
mp := gochat.NewMinip("appid", "appsecret", options...)

// --------------- 获取授权SessionKey -------------------------------

result, err := mp.Code2Session(ctx, "code")

if err != nil {
    log.Fatal(err)
}

fmt.Println(result)

// --------------- 获取AccessToken -------------------------------

result, err := mp.AccessToken(ctx)

if err != nil {
    log.Fatal(err)
}

fmt.Println(result)

// --------------- 解密授权的用户信息 -------------------------------

result := new(minip.UserInfo)

if err := mp.DecryptAuthInfo("sessionKey", "iv", "encryptedData", result); err != nil {
    log.Fatal(err)
}

fmt.Println(result)

// --------------- 获取用户手机号 -------------------------------

result := new(minip.ResultPhoneNumber)

if err := minip.GetPhoneNumber("code", result); err != nil {
    log.Fatal(err)
}

fmt.Println(result)

// --------------- 创建小程序二维码 -------------------------------

qrcode := new(minip.QRCode)
action := minip.CreateQRCode("pagepath", 120, qrcode)

if err := minip.Do(ctx, action); err != nil {
    log.Fatal(err)
}

fmt.Println(base64.StdEncoding.EncodeToString(qrcode.Buffer))

企业微信

import (
    "github.com/shenghui0779/gochat"
    "github.com/shenghui0779/gochat/wx"
    "github.com/shenghui0779/gochat/corp"
    "github.com/shenghui0779/gochat/corp/addrbook"
)

// 创建实例
cp := gochat.NewCorp("corpid", options...)

// --------------- 生成网页授权URL -------------------------------

url := cp.OAuth2URL(corp.ScopeSnsapiBase, "redirectURL", "state")

fmt.Println(url)

// --------------- 生成扫码授权URL -------------------------------

url := cp.QRCodeAuthURL("agentID", "redirectURL", "state")

fmt.Println(url)

// --------------- 获取AccessToken -------------------------------

result, err := cp.AccessToken(ctx, "secret")

if err != nil {
    log.Fatal(err)
}

fmt.Println(result)

// --------------- 获取部门列表 -------------------------------

result := new(addrbook.ResultDepartmentList)
action := addrbook.ListDepartment(0, result)

if err := cp.Do(ctx, action); err != nil {
    log.Fatal(err)
}

fmt.Println(result)

说明

• API Reference
• 注意：因 access_token 每日获取次数有限且含有效期，故服务端应妥善保存 access_token 并定时刷新
• 配合 yiigo 使用，可以更方便的操作 MySQL、MongoDB 与 Redis 等

Enjoy 😊

Documentation

Index

• func NewCorp(corpid string, options ...corp.Option) *corp.Corp
• func NewMch(mchid, apikey string, options ...mch.Option) *mch.Mch
• func NewMinip(appid, appsecret string, options ...minip.Option) *minip.Minip
• func NewOffia(appid, appsecret string, options ...offia.Option) *offia.Offia

Functions

func NewCorp

func NewCorp(corpid string, options ...corp.Option) *corp.Corp

NewCorp 企业微信

func NewMch

func NewMch(mchid, apikey string, options ...mch.Option) *mch.Mch

NewMch 微信商户

func NewMinip

func NewMinip(appid, appsecret string, options ...minip.Option) *minip.Minip

NewMinip 微信小程序

func NewOffia

func NewOffia(appid, appsecret string, options ...offia.Option) *offia.Offia

NewOffia 微信公众号