wxofficial

README

微信公众号

API

• 开始开发
  • 获取Access token：GetAccessToken
  • 获取微信服务器IP地址
  • 网络检测
• 自定义菜单
• 消息管理
• 微信网页开发
  • 网页授权
    • 通过code换取网页授权access_token：GetWebAuthAccessToken
    • 刷新access_token：RefreshWebAuthAccessToken
    • 拉取用户信息：GetAuthUserInfo
    • 检验授权凭证(access_token)是否有效：CheckWebAuthAccessToken
  • JS-SDK使用权限签名算法
    • jsapi_ticket：GetJsApiTicket
    • 签名算法：GetJsApiTicketSign
• 素材管理
• 图文消息留言管理
• 用户管理
  • 用户标签管理
  • 设置备注用户名
  • 获取用户基本信息(UnionID机制)：GetUserInfo
  • 获取用户列表
  • 获取用户地理位置
  • 黑名单管理
• 账号管理
• 数据统计
• 微信卡券
• 微信门店
• 微信小店
• 智能接口
• 微信设备功能
• 新版客服功能
• 微信导购助手
• 微信摇一摇周边
• 微信连Wi-Fi
• 微信"一物一码"
• 微信发票
• 微信非税缴费

相关文档

• 微信官方文档-公众号

Documentation

Index

• Constants
• func CheckWebAuthAccessToken(accessToken string, openId string) (wxRsp constant.BaseResponse, err error)
• func GetJsApiTicketSign(nonceStr string, ticket string, timeStamp string, url string) (ticketSign string)
• type AccessTokenResponse
  • func GetAccessToken(appId string, appSecret string) (wxRsp AccessTokenResponse, err error)
  • func GetWebAuthAccessToken(appId string, appSecret string, code string) (wxRsp AccessTokenResponse, err error)
  • func RefreshWebAuthAccessToken(appId string, refreshToken string) (wxRsp AccessTokenResponse, err error)
• type GetJsApiTicketResponse
  • func GetJsApiTicket(accessToken string) (wxRsp GetJsApiTicketResponse, err error)
• type SendTemplateMessageItem
• type SendTemplateMessageResponse
  • func SendTemplateMessage(accessToken string, toUserOpenID string, templateID string, detailURL string, ...) (rsp SendTemplateMessageResponse, err error)
• type UserInfoResponse
  • func GetSnsUserInfo(accessToken string, openId string, lang string) (wxRsp UserInfoResponse, err error)
  • func GetUserInfo(accessToken string, openId string, lang string) (wxRsp UserInfoResponse, err error)

Constants

const (
	// 语言
	LanguageZhCn = "zh_CN" // 简体
	LanguageZhTw = "zh_TW" // 繁体
	LanguageEn   = "en"    // 英语
)

Functions

func CheckWebAuthAccessToken

func CheckWebAuthAccessToken(accessToken string, openId string) (wxRsp constant.BaseResponse, err error)

网页授权-检验授权凭证(access_token)是否有效

func GetJsApiTicketSign

func GetJsApiTicketSign(
	nonceStr string,
	ticket string,
	timeStamp string,
	url string,
) (ticketSign string)

JS-SDK使用权限-签名算法

Types

type AccessTokenResponse

type AccessTokenResponse struct {
	AccessToken  string `json:"access_token"`  // 获取到的凭证
	ExpiresIn    int64  `json:"expires_in"`    // SessionKey超时时间（秒）
	RefreshToken string `json:"refresh_token"` // 用户刷新access_token
	OpenId       string `json:"openid"`        // 用户唯一标识
	Scope        string `json:"scope"`         // 用户授权的作用域
	ErrCode      int    `json:"errcode"`       // 错误码
	ErrMsg       string `json:"errmsg"`        // 错误信息
}

func GetAccessToken

func GetAccessToken(appId string, appSecret string) (wxRsp AccessTokenResponse, err error)

获取AccessToken

func GetWebAuthAccessToken

func GetWebAuthAccessToken(
	appId string,
	appSecret string,
	code string,
) (wxRsp AccessTokenResponse, err error)

网页授权-通过code换取网页授权access_token

func RefreshWebAuthAccessToken

func RefreshWebAuthAccessToken(appId string, refreshToken string) (wxRsp AccessTokenResponse, err error)

网页授权-刷新access_token

type GetJsApiTicketResponse

type GetJsApiTicketResponse struct {
	Ticket    string `json:"ticket"`     // 获取到的凭证
	ExpiresIn int64  `json:"expires_in"` // SessionKey超时时间（秒）
	ErrCode   int    `json:"errcode"`    // 错误码
	ErrMsg    string `json:"errmsg"`     // 错误信息
}

func GetJsApiTicket

func GetJsApiTicket(accessToken string) (wxRsp GetJsApiTicketResponse, err error)

JS-SDK使用权限-jsapi_ticket

type SendTemplateMessageItem

type SendTemplateMessageItem struct {
	Value string `json:"value"` // 值
	Color string `json:"color"` // 颜色
}

type SendTemplateMessageResponse

type SendTemplateMessageResponse struct {
	ErrCode    int64  `json:"errcode"`    // 错误编码
	ErrMessage string `json:"errmsg"`     // 错误信息
	MessageID  int64  `json:"message_id"` // 消息ID
}

func SendTemplateMessage

func SendTemplateMessage(
	accessToken string,
	toUserOpenID string,
	templateID string,
	detailURL string,
	topColor string,
	data map[string]SendTemplateMessageItem,
) (rsp SendTemplateMessageResponse, err error)

模板消息发送接口 https://mp.weixin.qq.com/advanced/tmplmsg?action=faq&lang=zh_CN

type UserInfoResponse

type UserInfoResponse struct {
	OpenId         string   `json:"openid"`          // 用户唯一标识
	Nickname       string   `json:"nickname"`        // 用户的昵称
	Sex            int      `json:"sex"`             // 用户的性别，值为1时是男性，值为2时是女性，值为0时是未知
	Language       string   `json:"language"`        // 用户的语言，简体中文为zh_CN
	Province       string   `json:"province"`        // 用户所在省份
	City           string   `json:"city"`            // 用户所在城市
	Country        string   `json:"country"`         // 用户所在国家
	HeadimgUrl     string   `json:"headimgurl"`      // 用户头像，最后一个数值代表正方形头像大小（有0、46、64、96、132数值可选，0代表640*640正方形头像），用户没有头像时该项为空。若用户更换头像，原有头像URL将失效。
	Privilege      []string `json:"privilege"`       // 用户特权信息
	UnionId        string   `json:"unionid"`         // 只有在用户将公众号绑定到微信开放平台帐号后，才会出现该字段。
	Subscribe      int      `json:"subscribe"`       // 用户是否订阅该公众号标识，值为0时，代表此用户没有关注该公众号，拉取不到其余信息。
	SubscribeTime  int      `json:"subscribe_time"`  // 用户关注时间，为时间戳。如果用户曾多次关注，则取最后关注时间
	SubscribeScene string   `json:"subscribe_scene"` // 返回用户关注的渠道来源，ADD_SCENE_SEARCH 公众号搜索，ADD_SCENE_ACCOUNT_MIGRATION 公众号迁移，ADD_SCENE_PROFILE_CARD 名片分享，ADD_SCENE_QR_CODE 扫描二维码，ADD_SCENEPROFILE LINK 图文页内名称点击，ADD_SCENE_PROFILE_ITEM 图文页右上角菜单，ADD_SCENE_PAID 支付后关注，ADD_SCENE_OTHERS 其他
	Remark         string   `json:"remark"`          // 公众号运营者对粉丝的备注，公众号运营者可在微信公众平台用户管理界面对粉丝添加备注
	GroupId        int      `json:"groupid"`         // 用户所在的分组ID（兼容旧的用户分组接口）
	TagidList      []int    `json:"tagid_list"`      // 用户被打上的标签ID列表
	QrScene        int      `json:"qr_scene"`        // 二维码扫码场景（开发者自定义）
	QrSceneStr     string   `json:"qr_scene_str"`    // 二维码扫码场景描述（开发者自定义）
	ErrCode        int      `json:"errcode"`         // 错误码
	ErrMsg         string   `json:"errmsg"`          // 错误信息
}

func GetSnsUserInfo

func GetSnsUserInfo(accessToken string, openId string, lang string) (wxRsp UserInfoResponse, err error)

网页授权-拉取用户信息(需scope为snsapi_userinfo)

func GetUserInfo

func GetUserInfo(accessToken string, openId string, lang string) (wxRsp UserInfoResponse, err error)

获取用户基本信息(UnionID机制)