mirror of
https://github.com/silenceper/wechat.git
synced 2026-03-01 00:35:26 +08:00
houseme
56a3734546
* 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>
328 lines
12 KiB
Go
328 lines
12 KiB
Go
package message
|
|
|
|
import (
|
|
"encoding/xml"
|
|
|
|
"github.com/silenceper/wechat/v2/officialaccount/device"
|
|
"github.com/silenceper/wechat/v2/officialaccount/freepublish"
|
|
)
|
|
|
|
// MsgType 基本消息类型
|
|
type MsgType string
|
|
|
|
// EventType 事件类型
|
|
type EventType string
|
|
|
|
// InfoType 第三方平台授权事件类型
|
|
type InfoType string
|
|
|
|
const (
|
|
// MsgTypeText 表示文本消息
|
|
MsgTypeText MsgType = "text"
|
|
// MsgTypeImage 表示图片消息
|
|
MsgTypeImage MsgType = "image"
|
|
// MsgTypeVoice 表示语音消息
|
|
MsgTypeVoice MsgType = "voice"
|
|
// MsgTypeVideo 表示视频消息
|
|
MsgTypeVideo MsgType = "video"
|
|
// MsgTypeMiniprogrampage 表示小程序卡片消息
|
|
MsgTypeMiniprogrampage MsgType = "miniprogrampage"
|
|
// MsgTypeShortVideo 表示短视频消息 [限接收]
|
|
MsgTypeShortVideo MsgType = "shortvideo"
|
|
// MsgTypeLocation 表示坐标消息 [限接收]
|
|
MsgTypeLocation MsgType = "location"
|
|
// MsgTypeLink 表示链接消息 [限接收]
|
|
MsgTypeLink MsgType = "link"
|
|
// MsgTypeMusic 表示音乐消息 [限回复]
|
|
MsgTypeMusic MsgType = "music"
|
|
// MsgTypeNews 表示图文消息 [限回复]
|
|
MsgTypeNews MsgType = "news"
|
|
// MsgTypeTransfer 表示消息消息转发到客服
|
|
MsgTypeTransfer MsgType = "transfer_customer_service"
|
|
// MsgTypeEvent 表示事件推送消息
|
|
MsgTypeEvent MsgType = "event"
|
|
)
|
|
|
|
const (
|
|
// EventSubscribe 订阅
|
|
EventSubscribe EventType = "subscribe"
|
|
// EventUnsubscribe 取消订阅
|
|
EventUnsubscribe EventType = "unsubscribe"
|
|
// EventScan 用户已经关注公众号，则微信会将带场景值扫描事件推送给开发者
|
|
EventScan EventType = "SCAN"
|
|
// EventLocation 上报地理位置事件
|
|
EventLocation EventType = "LOCATION"
|
|
// EventClick 点击菜单拉取消息时的事件推送
|
|
EventClick EventType = "CLICK"
|
|
// EventView 点击菜单跳转链接时的事件推送
|
|
EventView EventType = "VIEW"
|
|
// EventScancodePush 扫码推事件的事件推送
|
|
EventScancodePush EventType = "scancode_push"
|
|
// EventScancodeWaitmsg 扫码推事件且弹出“消息接收中”提示框的事件推送
|
|
EventScancodeWaitmsg EventType = "scancode_waitmsg"
|
|
// EventPicSysphoto 弹出系统拍照发图的事件推送
|
|
EventPicSysphoto EventType = "pic_sysphoto"
|
|
// EventPicPhotoOrAlbum 弹出拍照或者相册发图的事件推送
|
|
EventPicPhotoOrAlbum EventType = "pic_photo_or_album"
|
|
// EventPicWeixin 弹出微信相册发图器的事件推送
|
|
EventPicWeixin EventType = "pic_weixin"
|
|
// EventLocationSelect 弹出地理位置选择器的事件推送
|
|
EventLocationSelect EventType = "location_select"
|
|
// EventViewMiniprogram 点击菜单跳转小程序的事件推送
|
|
EventViewMiniprogram EventType = "view_miniprogram"
|
|
// EventTemplateSendJobFinish 发送模板消息推送通知
|
|
EventTemplateSendJobFinish EventType = "TEMPLATESENDJOBFINISH"
|
|
// EventMassSendJobFinish 群发消息推送通知
|
|
EventMassSendJobFinish EventType = "MASSSENDJOBFINISH"
|
|
// EventWxaMediaCheck 异步校验图片/音频是否含有违法违规内容推送事件
|
|
EventWxaMediaCheck EventType = "wxa_media_check"
|
|
// EventSubscribeMsgPopupEvent 订阅通知事件推送
|
|
EventSubscribeMsgPopupEvent EventType = "subscribe_msg_popup_event"
|
|
// EventPublishJobFinish 发布任务完成
|
|
EventPublishJobFinish EventType = "PUBLISHJOBFINISH"
|
|
// EventWeappAuditSuccess 审核通过
|
|
EventWeappAuditSuccess EventType = "weapp_audit_success"
|
|
// EventWeappAuditFail 审核不通过
|
|
EventWeappAuditFail EventType = "weapp_audit_fail"
|
|
// EventWeappAuditDelay 审核延后
|
|
EventWeappAuditDelay EventType = "weapp_audit_delay"
|
|
)
|
|
|
|
const (
|
|
// 微信开放平台需要用到
|
|
|
|
// InfoTypeVerifyTicket 返回 ticket
|
|
InfoTypeVerifyTicket InfoType = "component_verify_ticket"
|
|
// InfoTypeAuthorized 授权
|
|
InfoTypeAuthorized InfoType = "authorized"
|
|
// InfoTypeUnauthorized 取消授权
|
|
InfoTypeUnauthorized InfoType = "unauthorized"
|
|
// InfoTypeUpdateAuthorized 更新授权
|
|
InfoTypeUpdateAuthorized InfoType = "updateauthorized"
|
|
// InfoTypeNotifyThirdFasterRegister 注册审核事件推送
|
|
InfoTypeNotifyThirdFasterRegister InfoType = "notify_third_fasteregister"
|
|
)
|
|
|
|
// MixMessage 存放所有微信发送过来的消息和事件
|
|
type MixMessage struct {
|
|
CommonToken
|
|
|
|
// 基本消息
|
|
MsgID int64 `xml:"MsgId"` // 其他消息推送过来是 MsgId
|
|
TemplateMsgID int64 `xml:"MsgID"` // 模板消息推送成功的消息是 MsgID
|
|
Content string `xml:"Content"`
|
|
Recognition string `xml:"Recognition"`
|
|
PicURL string `xml:"PicUrl"`
|
|
MediaID string `xml:"MediaId"`
|
|
Format string `xml:"Format"`
|
|
ThumbMediaID string `xml:"ThumbMediaId"`
|
|
LocationX float64 `xml:"Location_X"`
|
|
LocationY float64 `xml:"Location_Y"`
|
|
Scale float64 `xml:"Scale"`
|
|
Label string `xml:"Label"`
|
|
Title string `xml:"Title"`
|
|
Description string `xml:"Description"`
|
|
URL string `xml:"Url"`
|
|
BizMsgMenuID int64 `xml:"bizmsgmenuid"`
|
|
|
|
// 事件相关
|
|
Event EventType `xml:"Event" json:"Event"`
|
|
EventKey string `xml:"EventKey"`
|
|
Ticket string `xml:"Ticket"`
|
|
Latitude string `xml:"Latitude"`
|
|
Longitude string `xml:"Longitude"`
|
|
Precision string `xml:"Precision"`
|
|
MenuID string `xml:"MenuId"`
|
|
Status string `xml:"Status"`
|
|
SessionFrom string `xml:"SessionFrom"`
|
|
TotalCount int64 `xml:"TotalCount"`
|
|
FilterCount int64 `xml:"FilterCount"`
|
|
SentCount int64 `xml:"SentCount"`
|
|
ErrorCount int64 `xml:"ErrorCount"`
|
|
|
|
ScanCodeInfo struct {
|
|
ScanType string `xml:"ScanType"`
|
|
ScanResult string `xml:"ScanResult"`
|
|
} `xml:"ScanCodeInfo"`
|
|
|
|
SendPicsInfo struct {
|
|
Count int32 `xml:"Count"`
|
|
PicList []EventPic `xml:"PicList>item"`
|
|
} `xml:"SendPicsInfo"`
|
|
|
|
SendLocationInfo struct {
|
|
LocationX float64 `xml:"Location_X"`
|
|
LocationY float64 `xml:"Location_Y"`
|
|
Scale float64 `xml:"Scale"`
|
|
Label string `xml:"Label"`
|
|
Poiname string `xml:"Poiname"`
|
|
}
|
|
|
|
subscribeMsgPopupEventList []SubscribeMsgPopupEvent `json:"-"`
|
|
|
|
SubscribeMsgPopupEvent []struct {
|
|
List SubscribeMsgPopupEvent `xml:"List"`
|
|
} `xml:"SubscribeMsgPopupEvent"`
|
|
|
|
// 事件相关：发布能力
|
|
PublishEventInfo struct {
|
|
PublishID int64 `xml:"publish_id"` // 发布任务 id
|
|
PublishStatus freepublish.PublishStatus `xml:"publish_status"` // 发布状态
|
|
ArticleID string `xml:"article_id"` // 当发布状态为 0 时（即成功）时，返回图文的 article_id，可用于“客服消息”场景
|
|
ArticleDetail struct {
|
|
Count uint `xml:"count"` // 文章数量
|
|
Item []struct {
|
|
Index uint `xml:"idx"` // 文章对应的编号
|
|
ArticleURL string `xml:"article_url"` // 图文的永久链接
|
|
} `xml:"item"`
|
|
} `xml:"article_detail"` // 当发布状态为 0 时（即成功）时，返回内容
|
|
FailIndex []uint `xml:"fail_idx"` // 当发布状态为 2 或 4 时，返回不通过的文章编号，第一篇为 1；其他发布状态则为空
|
|
} `xml:"PublishEventInfo"`
|
|
|
|
// 第三方平台相关
|
|
InfoType InfoType `xml:"InfoType"`
|
|
AppID string `xml:"AppId"`
|
|
ComponentVerifyTicket string `xml:"ComponentVerifyTicket"`
|
|
AuthorizerAppid string `xml:"AuthorizerAppid"`
|
|
AuthorizationCode string `xml:"AuthorizationCode"`
|
|
AuthorizationCodeExpiredTime int64 `xml:"AuthorizationCodeExpiredTime"`
|
|
PreAuthCode string `xml:"PreAuthCode"`
|
|
AuthCode string `xml:"auth_code"`
|
|
Info struct {
|
|
Name string `xml:"name"`
|
|
Code string `xml:"code"`
|
|
CodeType int `xml:"code_type"`
|
|
LegalPersonaWechat string `xml:"legal_persona_wechat"`
|
|
LegalPersonaName string `xml:"legal_persona_name"`
|
|
ComponentPhone string `xml:"component_phone"`
|
|
} `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"`
|
|
RefuseReason string `xml:"RefuseReason"`
|
|
IsGiveByFriend int32 `xml:"IsGiveByFriend"`
|
|
FriendUserName string `xml:"FriendUserName"`
|
|
UserCardCode string `xml:"UserCardCode"`
|
|
OldUserCardCode string `xml:"OldUserCardCode"`
|
|
OuterStr string `xml:"OuterStr"`
|
|
IsRestoreMemberCard int32 `xml:"IsRestoreMemberCard"`
|
|
UnionID string `xml:"UnionId"`
|
|
|
|
// 内容审核相关
|
|
IsRisky bool `xml:"isrisky"`
|
|
ExtraInfoJSON string `xml:"extra_info_json"`
|
|
TraceID string `xml:"trace_id"`
|
|
StatusCode int `xml:"status_code"`
|
|
|
|
// 小程序名称审核结果事件推送
|
|
Ret int32 `xml:"ret"` // 审核结果 2：失败，3：成功
|
|
NickName string `xml:"nickname"` // 小程序昵称
|
|
|
|
// 设备相关
|
|
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 订阅通知事件推送的消息体
|
|
type SubscribeMsgPopupEvent struct {
|
|
TemplateID string `xml:"TemplateId" json:"TemplateId"`
|
|
SubscribeStatusString string `xml:"SubscribeStatusString" json:"SubscribeStatusString"`
|
|
PopupScene int `xml:"PopupScene" json:"PopupScene,string"`
|
|
}
|
|
|
|
// SetSubscribeMsgPopupEvents 设置订阅消息事件
|
|
func (s *MixMessage) SetSubscribeMsgPopupEvents(list []SubscribeMsgPopupEvent) {
|
|
s.subscribeMsgPopupEventList = list
|
|
}
|
|
|
|
// GetSubscribeMsgPopupEvents 获取订阅消息事件数据
|
|
func (s *MixMessage) GetSubscribeMsgPopupEvents() []SubscribeMsgPopupEvent {
|
|
if s.subscribeMsgPopupEventList != nil {
|
|
return s.subscribeMsgPopupEventList
|
|
}
|
|
list := make([]SubscribeMsgPopupEvent, len(s.SubscribeMsgPopupEvent))
|
|
for i, item := range s.SubscribeMsgPopupEvent {
|
|
list[i] = item.List
|
|
}
|
|
return list
|
|
}
|
|
|
|
// EventPic 发图事件推送
|
|
type EventPic struct {
|
|
PicMd5Sum string `xml:"PicMd5Sum"`
|
|
}
|
|
|
|
// EncryptedXMLMsg 安全模式下的消息体
|
|
type EncryptedXMLMsg struct {
|
|
XMLName struct{} `xml:"xml" json:"-"`
|
|
ToUserName string `xml:"ToUserName" json:"ToUserName"`
|
|
EncryptedMsg string `xml:"Encrypt" json:"Encrypt"`
|
|
}
|
|
|
|
// ResponseEncryptedXMLMsg 需要返回的消息体
|
|
type ResponseEncryptedXMLMsg struct {
|
|
XMLName struct{} `xml:"xml" json:"-"`
|
|
EncryptedMsg string `xml:"Encrypt" json:"Encrypt"`
|
|
MsgSignature string `xml:"MsgSignature" json:"MsgSignature"`
|
|
Timestamp int64 `xml:"TimeStamp" json:"TimeStamp"`
|
|
Nonce string `xml:"Nonce" json:"Nonce"`
|
|
}
|
|
|
|
// CDATA 使用该类型，在序列化为 xml 文本时文本会被解析器忽略
|
|
type CDATA string
|
|
|
|
// MarshalXML 实现自己的序列化方法
|
|
func (c CDATA) MarshalXML(e *xml.Encoder, start xml.StartElement) error {
|
|
return e.EncodeElement(struct {
|
|
string `xml:",cdata"`
|
|
}{string(c)}, start)
|
|
}
|
|
|
|
// CommonToken 消息中通用的结构
|
|
type CommonToken struct {
|
|
XMLName xml.Name `xml:"xml"`
|
|
ToUserName CDATA `xml:"ToUserName" json:"ToUserName"`
|
|
FromUserName CDATA `xml:"FromUserName" json:"FromUserName"`
|
|
CreateTime int64 `xml:"CreateTime" json:"CreateTime"`
|
|
MsgType MsgType `xml:"MsgType" json:"MsgType"`
|
|
}
|
|
|
|
// SetToUserName set ToUserName
|
|
func (msg *CommonToken) SetToUserName(toUserName CDATA) {
|
|
msg.ToUserName = toUserName
|
|
}
|
|
|
|
// SetFromUserName set FromUserName
|
|
func (msg *CommonToken) SetFromUserName(fromUserName CDATA) {
|
|
msg.FromUserName = fromUserName
|
|
}
|
|
|
|
// SetCreateTime set createTime
|
|
func (msg *CommonToken) SetCreateTime(createTime int64) {
|
|
msg.CreateTime = createTime
|
|
}
|
|
|
|
// SetMsgType set MsgType
|
|
func (msg *CommonToken) SetMsgType(msgType MsgType) {
|
|
msg.MsgType = msgType
|
|
}
|
|
|
|
// GetOpenID get the FromUserName value
|
|
func (msg *CommonToken) GetOpenID() string {
|
|
return string(msg.FromUserName)
|
|
}
|