mp

package
Version: v0.0.0-...-7011273 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 17, 2017 License: Apache-2.0 Imports: 19 Imported by: 0

README

微信公众平台(订阅号、服务号) golang SDK

整体架构图

架构图

示例

主動調用微信 api,mp 子包裏面的 Client 基本都是這樣的調用方式
package main

import (
	"fmt"

	"github.com/c77cc/wechat/mp"
	"github.com/c77cc/wechat/mp/menu"
)

var AccessTokenServer = mp.NewDefaultAccessTokenServer("appId", "appSecret", nil) // 一個應用只能有一個實例
var WechatClient = mp.NewWechatClient(AccessTokenServer, nil)

func main() {
	var mn menu.Menu
	mn.Buttons = make([]menu.Button, 3)
	mn.Buttons[0].SetAsClickButton("今日歌曲", "V1001_TODAY_MUSIC")
	mn.Buttons[1].SetAsViewButton("视频", "http://v.qq.com/")

	var subButtons = make([]menu.Button, 2)
	subButtons[0].SetAsViewButton("搜索", "http://www.soso.com/")
	subButtons[1].SetAsClickButton("赞一下我们", "V1001_GOOD")

	mn.Buttons[2].SetAsSubMenuButton("子菜单", subButtons)

	clt := menu.Client{WechatClient: WechatClient}
	if err := clt.CreateMenu(mn); err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println("ok")
}
被動接收消息(事件)推送,一个 URL 监听一个公众号的消息
package main

import (
	"log"
	"net/http"

	"github.com/c77cc/wechat/mp"
	"github.com/c77cc/wechat/mp/message/request"
	"github.com/c77cc/wechat/mp/message/response"
	"github.com/c77cc/wechat/util"
)

// 非法请求的 Handler
func InvalidRequestHandler(w http.ResponseWriter, r *http.Request, err error) {
	log.Println(err.Error())
}

// 文本消息的 Handler
func TextMessageHandler(w http.ResponseWriter, r *mp.Request) {
	// 简单起见,把用户发送过来的文本原样回复过去
	text := request.GetText(r.MixedMsg) // 可以省略...
	resp := response.NewText(text.FromUserName, text.ToUserName, text.CreateTime, text.Content)
	//mp.WriteRawResponse(w, r, resp) // 明文模式
	mp.WriteAESResponse(w, r, resp) // 安全模式
}

func main() {
	aesKey, err := util.AESKeyDecode("encodedAESKey") // 这里 encodedAESKey 改成你自己的参数
	if err != nil {
		panic(err)
	}

	messageServeMux := mp.NewMessageServeMux()
	messageServeMux.MessageHandleFunc(request.MsgTypeText, TextMessageHandler) // 注册文本处理 Handler

	// 下面函数的几个参数设置成你自己的参数: wechatId, token, appId
	wechatServer := mp.NewDefaultWechatServer("wechatId", "token", "appId", aesKey, messageServeMux)

	wechatServerFrontend := mp.NewWechatServerFrontend(wechatServer, mp.InvalidRequestHandlerFunc(InvalidRequestHandler))

	// 如果你在微信后台设置的回调地址是
	//   http://xxx.yyy.zzz/wechat
	// 那么可以这么注册 http.Handler
	http.Handle("/wechat", wechatServerFrontend)
	http.ListenAndServe(":80", nil)
}
被動接收消息(事件)推送,一个 URL 监听多个公众号的消息
package main

import (
	"log"
	"net/http"

	"github.com/c77cc/wechat/mp"
	"github.com/c77cc/wechat/mp/message/request"
	"github.com/c77cc/wechat/mp/message/response"
	"github.com/c77cc/wechat/util"
)

// 非法请求处理函数
func InvalidRequestHandler(w http.ResponseWriter, r *http.Request, err error) {
	log.Println(err.Error())
}

// 文本消息的处理
func TextMessageHandler(w http.ResponseWriter, r *mp.Request) {
	// 简单起见,把用户发送过来的文本原样回复过去
	text := request.GetText(r.MixedMsg) // 可以省略...
	resp := response.NewText(text.FromUserName, text.ToUserName, text.CreateTime, text.Content)
	//mp.WriteRawResponse(w, r, resp) // 明文模式
	mp.WriteAESResponse(w, r, resp) // 安全模式
}

func main() {
	// wechatServer1
	aesKey1, err := util.AESKeyDecode("encodedAESKey1") // 这里 encodedAESKey1 改成你自己的参数
	if err != nil {
		panic(err)
	}

	messageServeMux1 := mp.NewMessageServeMux()
	messageServeMux1.MessageHandleFunc(request.MsgTypeText, TextMessageHandler) // 注册文本处理 Handler

	// 下面函数的几个参数设置成你自己的参数: wechatId1, token1, appId1
	wechatServer1 := mp.NewDefaultWechatServer("wechatId1", "token1", "appId1", aesKey1, messageServeMux1)

	// wechatServer2
	aesKey2, err := util.AESKeyDecode("encodedAESKey2") // 这里 encodedAESKey2 改成你自己的参数
	if err != nil {
		panic(err)
	}

	messageServeMux2 := mp.NewMessageServeMux()
	messageServeMux2.MessageHandleFunc(request.MsgTypeText, TextMessageHandler) // 注册文本处理 Handler

	// 下面函数的几个参数设置成你自己的参数: wechatId2, token2, appId2
	wechatServer2 := mp.NewDefaultWechatServer("wechatId2", "token2", "appId2", aesKey2, messageServeMux2)

	// multiWechatServerFrontend
	var multiWechatServerFrontend mp.MultiWechatServerFrontend
	multiWechatServerFrontend.SetInvalidRequestHandler(mp.InvalidRequestHandlerFunc(InvalidRequestHandler))
	multiWechatServerFrontend.SetWechatServer("wechat1", wechatServer1) // 回調url上面要加上 wechat_server=wechat1
	multiWechatServerFrontend.SetWechatServer("wechat2", wechatServer2) // 回調url上面要加上 wechat_server=wechat2

	// 如果你在微信后台设置的回调地址是
	//   http://xxx.yyy.zzz/wechat
	// 那么可以这么注册 http.Handler
	http.Handle("/wechat", &multiWechatServerFrontend)
	http.ListenAndServe(":80", nil)
}

Documentation

Overview

微信公众平台(订阅号, 服务号)SDK

Index

Constants

View Source
const (
	ErrCodeOK                 = 0
	ErrCodeInvalidCredential  = 40001 // access_token 过期(无效)返回这个错误
	ErrCodeAccessTokenExpired = 42001 // access_token 过期(无效)返回这个错误(maybe!!!)
)
View Source
const URLQueryWechatServerKeyName = "wechat_server"

回调 URL 上索引 WechatServer 的 key 的名称.

比如下面的回调地址里面就可以根据 wechat1 来索引对应的 WechatServer.
http://www.xxx.com/?wechat_server=wechat1&signature=XXX&timestamp=123456789&nonce=12345678

Variables

View Source
var DefaultInvalidRequestHandler = InvalidRequestHandlerFunc(func(http.ResponseWriter, *http.Request, error) {})
View Source
var LogInfoln = log.Println
View Source
var MediaHttpClient = &http.Client{
	Timeout: 300 * time.Second,
}

多媒体上传下载请求的 http.Client

View Source
var TextHttpClient = &http.Client{
	Timeout: 60 * time.Second,
}

一般请求的 http.Client

Functions

func ServeHTTP

func ServeHTTP(w http.ResponseWriter, r *http.Request, queryValues url.Values, ws WechatServer, irh InvalidRequestHandler)

ServeHTTP 处理 http 消息请求

NOTE: 调用者保证所有参数有效

func SetLogInfoln

func SetLogInfoln(fn func(v ...interface{}))

沒有加锁, 请确保在初始化阶段调用!

func WriteAESResponse

func WriteAESResponse(w http.ResponseWriter, r *Request, msg interface{}) (err error)

回复消息给微信服务器(安全模式).

要求 msg 是有效的消息数据结构(经过 encoding/xml marshal 后符合消息的格式);
如果有必要可以修改 Request 里面的某些值, 比如 Timestamp.

func WriteRawResponse

func WriteRawResponse(w http.ResponseWriter, r *Request, msg interface{}) (err error)

回复消息给微信服务器(明文模式).

要求 msg 是有效的消息数据结构(经过 encoding/xml marshal 后符合消息的格式);
如果有必要可以修改 Request 里面的某些值, 比如 Timestamp.

Types

type AccessTokenServer

type AccessTokenServer interface {
	// 从中控服务器获取被缓存的 access_token.
	Token() (token string, err error)

	// 请求中控服务器到微信服务器刷新 access_token.
	//
	//  高并发场景下某个时间点可能有很多请求(比如缓存的access_token刚好过期时), 但是我们
	//  不期望也没有必要让这些请求都去微信服务器获取 access_token(有可能导致api超过调用限制),
	//  实际上这些请求只需要一个新的 access_token 即可, 所以建议 AccessTokenServer 从微信服务器
	//  获取一次 access_token 之后的至多5秒内(收敛时间, 视情况而定, 理论上至多5个http或tcp周期)
	//  再次调用该函数不再去微信服务器获取, 而是直接返回之前的结果.
	TokenRefresh() (token string, err error)
}

access_token 中控服务器接口, see access_token_server.png

type CommonMessageHeader

type CommonMessageHeader struct {
	ToUserName   string `xml:"ToUserName"   json:"ToUserName"`
	FromUserName string `xml:"FromUserName" json:"FromUserName"`
	CreateTime   int64  `xml:"CreateTime"   json:"CreateTime"`
	MsgType      string `xml:"MsgType"      json:"MsgType"`
}

微信服务器推送过来的消息(事件)通用的消息头

type DefaultAccessTokenServer

type DefaultAccessTokenServer struct {
	// contains filtered or unexported fields
}

AccessTokenServer 的简单实现.

NOTE:
1. 用于单进程环境.
2. 因为 DefaultAccessTokenServer 同时也是一个简单的中控服务器, 而不是仅仅实现 AccessTokenServer 接口,
   所以整个系统只能存在一个 DefaultAccessTokenServer 实例!

func NewDefaultAccessTokenServer

func NewDefaultAccessTokenServer(appId, appSecret string, clt *http.Client) (srv *DefaultAccessTokenServer)

创建一个新的 DefaultAccessTokenServer.

如果 clt == nil 则默认使用 http.DefaultClient.

func (*DefaultAccessTokenServer) Token

func (srv *DefaultAccessTokenServer) Token() (token string, err error)

func (*DefaultAccessTokenServer) TokenRefresh

func (srv *DefaultAccessTokenServer) TokenRefresh() (token string, err error)

type DefaultWechatServer

type DefaultWechatServer struct {
	// contains filtered or unexported fields
}

func NewDefaultWechatServer

func NewDefaultWechatServer(oriId, token, appId string, AESKey []byte, handler MessageHandler) (srv *DefaultWechatServer)

func (*DefaultWechatServer) AppId

func (srv *DefaultWechatServer) AppId() string

func (*DefaultWechatServer) CurrentAESKey

func (srv *DefaultWechatServer) CurrentAESKey() (key [32]byte)

func (*DefaultWechatServer) LastAESKey

func (srv *DefaultWechatServer) LastAESKey() (key [32]byte, valid bool)

func (*DefaultWechatServer) MessageHandler

func (srv *DefaultWechatServer) MessageHandler() MessageHandler

func (*DefaultWechatServer) MessageSizeLimit

func (srv *DefaultWechatServer) MessageSizeLimit() int64

func (*DefaultWechatServer) OriId

func (srv *DefaultWechatServer) OriId() string

func (*DefaultWechatServer) Token

func (srv *DefaultWechatServer) Token() string

func (*DefaultWechatServer) UpdateAESKey

func (srv *DefaultWechatServer) UpdateAESKey(aesKey []byte) (err error)

更新當前的 aesKey

type Error

type Error struct {
	// StructField 固定这个顺序, RETRY 依赖这个顺序
	ErrCode int    `json:"errcode"`
	ErrMsg  string `json:"errmsg"`
}

func (*Error) Error

func (e *Error) Error() string

type InvalidRequestHandler

type InvalidRequestHandler interface {
	// err 是错误信息
	ServeInvalidRequest(w http.ResponseWriter, r *http.Request, err error)
}

无效请求(非法或者错误)的处理接口.

type InvalidRequestHandlerFunc

type InvalidRequestHandlerFunc func(http.ResponseWriter, *http.Request, error)

func (InvalidRequestHandlerFunc) ServeInvalidRequest

func (fn InvalidRequestHandlerFunc) ServeInvalidRequest(w http.ResponseWriter, r *http.Request, err error)

type MessageHandler

type MessageHandler interface {
	ServeMessage(w http.ResponseWriter, r *Request)
}

微信服务器推送过来的消息(事件)处理接口

type MessageHandlerFunc

type MessageHandlerFunc func(http.ResponseWriter, *Request)

func (MessageHandlerFunc) ServeMessage

func (fn MessageHandlerFunc) ServeMessage(w http.ResponseWriter, r *Request)

type MessageServeMux

type MessageServeMux struct {
	// contains filtered or unexported fields
}

MessageServeMux 实现了一个简单的消息路由器, 同时也是一个 MessageHandler.

func NewMessageServeMux

func NewMessageServeMux() *MessageServeMux

func (*MessageServeMux) DefaultEventHandle

func (mux *MessageServeMux) DefaultEventHandle(handler MessageHandler)

注册 MessageHandler, 处理未知类型的事件.

func (*MessageServeMux) DefaultEventHandleFunc

func (mux *MessageServeMux) DefaultEventHandleFunc(handler func(http.ResponseWriter, *Request))

注册 MessageHandlerFunc, 处理未知类型的事件.

func (*MessageServeMux) DefaultMessageHandle

func (mux *MessageServeMux) DefaultMessageHandle(handler MessageHandler)

注册 MessageHandler, 处理未知类型的消息.

func (*MessageServeMux) DefaultMessageHandleFunc

func (mux *MessageServeMux) DefaultMessageHandleFunc(handler func(http.ResponseWriter, *Request))

注册 MessageHandlerFunc, 处理未知类型的消息.

func (*MessageServeMux) EventHandle

func (mux *MessageServeMux) EventHandle(eventType string, handler MessageHandler)

注册 MessageHandler, 处理特定类型的事件.

func (*MessageServeMux) EventHandleFunc

func (mux *MessageServeMux) EventHandleFunc(eventType string, handler func(http.ResponseWriter, *Request))

注册 MessageHandlerFunc, 处理特定类型的事件.

func (*MessageServeMux) MessageHandle

func (mux *MessageServeMux) MessageHandle(msgType string, handler MessageHandler)

注册 MessageHandler, 处理特定类型的消息.

func (*MessageServeMux) MessageHandleFunc

func (mux *MessageServeMux) MessageHandleFunc(msgType string, handler func(http.ResponseWriter, *Request))

注册 MessageHandlerFunc, 处理特定类型的消息.

func (*MessageServeMux) ServeMessage

func (mux *MessageServeMux) ServeMessage(w http.ResponseWriter, r *Request)

MessageServeMux 实现了 MessageHandler 接口.

type MixedMessage

type MixedMessage struct {
	XMLName struct{} `xml:"xml" json:"-"`
	CommonMessageHeader

	// fuck, MsgId != MsgID
	MsgId int64 `xml:"MsgId" json:"MsgId"`
	MsgID int64 `xml:"MsgID" json:"MsgID"`

	Content      string  `xml:"Content"      json:"Content"`
	MediaId      string  `xml:"MediaId"      json:"MediaId"`
	PicURL       string  `xml:"PicUrl"       json:"PicUrl"`
	Format       string  `xml:"Format"       json:"Format"`
	Recognition  string  `xml:"Recognition"  json:"Recognition"`
	ThumbMediaId string  `xml:"ThumbMediaId" json:"ThumbMediaId"`
	LocationX    float64 `xml:"Location_X"   json:"Location_X"`
	LocationY    float64 `xml:"Location_Y"   json:"Location_Y"`
	Scale        int     `xml:"Scale"        json:"Scale"`
	Label        string  `xml:"Label"        json:"Label"`
	Title        string  `xml:"Title"        json:"Title"`
	Description  string  `xml:"Description"  json:"Description"`
	URL          string  `xml:"Url"          json:"Url"`

	Event    string `xml:"Event"    json:"Event"`
	EventKey string `xml:"EventKey" json:"EventKey"`

	ScanCodeInfo struct {
		ScanType   string `xml:"ScanType"   json:"ScanType"`
		ScanResult string `xml:"ScanResult" json:"ScanResult"`
	} `xml:"ScanCodeInfo" json:"ScanCodeInfo"`

	SendPicsInfo struct {
		Count   int `xml:"Count" json:"Count"`
		PicList []struct {
			PicMD5Sum string `xml:"PicMd5Sum" json:"PicMd5Sum"`
		} `xml:"PicList>item,omitempty" json:"PicList,omitempty"`
	} `xml:"SendPicsInfo" json:"SendPicsInfo"`

	SendLocationInfo struct {
		LocationX float64 `xml:"Location_X" json:"Location_X"`
		LocationY float64 `xml:"Location_Y" json:"Location_Y"`
		Scale     int     `xml:"Scale"      json:"Scale"`
		Label     string  `xml:"Label"      json:"Label"`
		Poiname   string  `xml:"Poiname"    json:"Poiname"`
	} `xml:"SendLocationInfo" json:"SendLocationInfo"`

	Ticket      string  `xml:"Ticket"      json:"Ticket"`
	Latitude    float64 `xml:"Latitude"    json:"Latitude"`
	Longitude   float64 `xml:"Longitude"   json:"Longitude"`
	Precision   float64 `xml:"Precision"   json:"Precision"`
	Status      string  `xml:"Status"      json:"Status"`
	TotalCount  int     `xml:"TotalCount"  json:"TotalCount"`
	FilterCount int     `xml:"FilterCount" json:"FilterCount"`
	SentCount   int     `xml:"SentCount"   json:"SentCount"`
	ErrorCount  int     `xml:"ErrorCount"  json:"ErrorCount"`
	OrderId     string  `xml:"OrderId"     json:"OrderId"`
	OrderStatus int     `xml:"OrderStatus" json:"OrderStatus"`
	ProductId   string  `xml:"ProductId"   json:"ProductId"`
	SKUInfo     string  `xml:"SkuInfo"     json:"SkuInfo"`

	// card
	CardId         string `xml:"CardId"         json:"CardId"`
	IsGiveByFriend int    `xml:"IsGiveByFriend" json:"IsGiveByFriend"`
	FriendUserName string `xml:"FriendUserName" json:"FriendUserName"`
	UserCardCode   string `xml:"UserCardCode"   json:"UserCardCode"`
	OuterId        int64  `xml:"OuterId"        json:"OuterId"`

	// poi
	UniqId string `xml:"UniqId" json:"UniqId"`
	PoiId  string `xml:"PoiId"  json:"PoiId"`
	Result string `xml:"Result" json:"Result"`
	Msg    string `xml:"Msg"    json:"Msg"`
}

微信服务器推送过来的消息(事件)的合集.

type MultiWechatServerFrontend

type MultiWechatServerFrontend struct {
	// contains filtered or unexported fields
}

多个 WechatServer 的前端, 负责处理 http 请求, net/http.Handler 的实现

NOTE:
MultiWechatServerFrontend 可以处理多个公众号的消息(事件),但是要求在回调 URL 上加上一个
查询参数,参考常量 URLQueryWechatServerKeyName,这个参数的值就是 MultiWechatServerFrontend
索引 WechatServer 的 key。

例如回调 URL 为 http://www.xxx.com/weixin?wechat_server=1234567890,那么就可以在后端调用

  MultiWechatServerFrontend.SetWechatServer("1234567890", WechatServer)

来增加一个 WechatServer 来处理 wechat_server=1234567890 的消息(事件)。

MultiWechatServerFrontend 并发安全,可以在运行中动态增加和删除 WechatServer。

func (*MultiWechatServerFrontend) DeleteAllWechatServer

func (frontend *MultiWechatServerFrontend) DeleteAllWechatServer()

删除所有的 WechatServer

func (*MultiWechatServerFrontend) DeleteWechatServer

func (frontend *MultiWechatServerFrontend) DeleteWechatServer(serverKey string)

删除 serverKey 对应的 WechatServer

func (*MultiWechatServerFrontend) ServeHTTP

func (frontend *MultiWechatServerFrontend) ServeHTTP(w http.ResponseWriter, r *http.Request)

实现 http.Handler

func (*MultiWechatServerFrontend) SetInvalidRequestHandler

func (frontend *MultiWechatServerFrontend) SetInvalidRequestHandler(handler InvalidRequestHandler)

设置 InvalidRequestHandler, 如果 handler == nil 则使用默认的 DefaultInvalidRequestHandler

func (*MultiWechatServerFrontend) SetWechatServer

func (frontend *MultiWechatServerFrontend) SetWechatServer(serverKey string, server WechatServer)

设置 serverKey-WechatServer pair. 如果 serverKey == "" 或者 server == nil 则不做任何操作

type MultipartFormField

type MultipartFormField struct {
	ContentType int // 0==文件field, 1==普通的文本field
	FieldName   string
	FileName    string
	Value       io.Reader
}

type Request

type Request struct {
	HttpRequest *http.Request // 可以为 nil, 因为某些 http 框架没有提供此参数

	QueryValues url.Values // 回调请求 URL 中的查询参数集合
	Signature   string     // 回调请求 URL URL 中的签名: signature
	Timestamp   int64      // 回调请求 URL URL 中的时间戳: timestamp
	Nonce       string     // 回调请求 URL URL 中的随机数: nonce

	RawMsgXML []byte        // "明文"消息的 XML 文本
	MixedMsg  *MixedMessage // RawMsgXML 解析后的消息

	// 下面的字段是 AES 模式才有的
	MsgSignature string   // 请求 URL 中的消息体签名: msg_signature
	EncryptType  string   // 请求 URL 中的加密方式: encrypt_type
	AESKey       [32]byte // 当前消息 AES 加密的 key
	Random       []byte   // 当前消息加密时所用的 random, 16 bytes

	// 下面字段是公众号的基本信息, 回包需要
	WechatAppId string // 请求消息所属公众号的 AppId
	WechatToken string // 请求消息所属公众号的 Token
}

消息(事件)请求信息

type RequestHttpBody

type RequestHttpBody struct {
	XMLName struct{} `xml:"xml" json:"-"`

	ToUserName   string `xml:"ToUserName" json:"ToUserName"`
	EncryptedMsg string `xml:"Encrypt"    json:"Encrypt"`
}

安全模式, 微信服务器推送过来的 http body

type ResponseHttpBody

type ResponseHttpBody struct {
	XMLName      struct{} `xml:"xml" json:"-"`
	EncryptedMsg string   `xml:"Encrypt"`
	MsgSignature string   `xml:"MsgSignature"`
	Timestamp    int64    `xml:"TimeStamp"`
	Nonce        string   `xml:"Nonce"`
}

安全模式回复消息的 http body

type WechatClient

type WechatClient struct {
	AccessTokenServer
	HttpClient *http.Client
}

微信公众号"主动"请求功能的基本封装.

func NewWechatClient

func NewWechatClient(srv AccessTokenServer, clt *http.Client) *WechatClient

创建一个新的 WechatClient.

如果 clt == nil 则默认用 http.DefaultClient

func (*WechatClient) GetCallbackIP

func (clt *WechatClient) GetCallbackIP() (ipList []string, err error)

获取微信服务器IP地址.

如果公众号基于安全等考虑,需要获知微信服务器的IP地址列表,以便进行相关限制,
可以通过该接口获得微信服务器IP地址列表。

func (*WechatClient) GetJSON

func (clt *WechatClient) GetJSON(incompleteURL string, response interface{}) (err error)

GET 微信资源, 然后将微信服务器返回的 JSON 用 encoding/json 解析到 response.

NOTE:
1. 一般不用调用这个方法, 请直接调用高层次的封装方法;
2. 最终的 URL == incompleteURL + access_token;
3. response 格式有要求, 要么是 *Error, 要么是下面结构体的指针(注意 Error 必须是第一个 Field):
    struct {
        Error
        ...
    }

func (*WechatClient) PostJSON

func (clt *WechatClient) PostJSON(incompleteURL string, request interface{}, response interface{}) (err error)

用 encoding/json 把 request marshal 为 JSON, 放入 http 请求的 body 中, POST 到微信服务器, 然后将微信服务器返回的 JSON 用 encoding/json 解析到 response.

NOTE:
1. 一般不用调用这个方法, 请直接调用高层次的封装方法;
2. 最终的 URL == incompleteURL + access_token;
3. response 格式有要求, 要么是 *Error, 要么是下面结构体的指针(注意 Error 必须是第一个 Field):
    struct {
        Error
        ...
    }

func (*WechatClient) PostMultipartForm

func (clt *WechatClient) PostMultipartForm(incompleteURL string, fields []MultipartFormField, response interface{}) (err error)

通用上传接口.

--BOUNDARY
Content-Disposition: form-data; name="FIELDNAME"; filename="FILENAME"
Content-Type: application/octet-stream

FILE-CONTENT
--BOUNDARY
Content-Disposition: form-data; name="FIELDNAME"

JSON-DESCRIPTION
--BOUNDARY--

NOTE:
1. 一般不需要调用这个方法, 请直接调用高层次的封装方法;
2. 最终的 URL == incompleteURL + access_token;
3. response 格式有要求, 要么是 *Error, 要么是下面结构体的指针(注意 Error 必须是第一个 Field):
    struct {
        Error
        ...
    }

type WechatServer

type WechatServer interface {
	OriId() string // 获取公众号的 原始ID, 如果爲空則不檢查消息的 ToUserName
	AppId() string // 获取公众号的 AppId
	Token() string // 获取公众号的 Token

	CurrentAESKey() [32]byte                // 获取当前有效的 AES 加密 Key
	LastAESKey() (key [32]byte, valid bool) // 获取最后一个有效的 AES 加密 Key

	MessageHandler() MessageHandler // 获取 MessageHandler

	MessageSizeLimit() int64 // 消息請求的 http body 大小限制, 如果 <= 0 則不做限制
}

公众号服务端接口, 处理单个公众号的消息(事件)请求.

type WechatServerFrontend

type WechatServerFrontend struct {
	// contains filtered or unexported fields
}

实现了 http.Handler, 处理一个公众号的消息(事件)请求.

func NewWechatServerFrontend

func NewWechatServerFrontend(server WechatServer, handler InvalidRequestHandler) *WechatServerFrontend

func (*WechatServerFrontend) ServeHTTP

func (frontend *WechatServerFrontend) ServeHTTP(w http.ResponseWriter, r *http.Request)

实现 http.Handler.

Directories

Path Synopsis
帐号管理接口.
帐号管理接口.
微信卡券接口, V2.0
微信卡券接口, V2.0
公众号第三方平台接口
公众号第三方平台接口
数据统计接口.
数据统计接口.
多客服接口.
多客服接口.
js-sdk 服务器端接口.
js-sdk 服务器端接口.
永久素材API.
永久素材API.
临时素材API.
临时素材API.
自定义菜单接口.
自定义菜单接口.
消息(接收和发送)接口.
消息(接收和发送)接口.
custom
客服主动回复消息.
客服主动回复消息.
mass
群发消息.
群发消息.
mass/mass2all
群发消息给所有用户.
群发消息给所有用户.
mass/mass2group
根据分组进行群发消息.
根据分组进行群发消息.
mass/mass2users
根据OpenID列表群发消息.
根据OpenID列表群发消息.
mass/preview
预览接口.
预览接口.
request
被动接收基本的消息(事件).
被动接收基本的消息(事件).
response
被动回复用户消息.
被动回复用户消息.
template
模板消息接口.
模板消息接口.
Poi 门店管理接口, v2.2.3
Poi 门店管理接口, v2.2.3
用户管理接口.
用户管理接口.
oauth2
网页授权获取用户基本信息.
网页授权获取用户基本信息.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL