Documentation
¶
Index ¶
- Variables
- type Article
- type CDATA
- type CommonToken
- type CustomerMessage
- func NewCustomerImgMessage(toUser, mediaID string) *CustomerMessage
- func NewCustomerMiniprogrampageMessage(toUser, title, appID, pagePath, thumbMediaID string) *CustomerMessage
- func NewCustomerTextMessage(toUser, text string) *CustomerMessage
- func NewCustomerVoiceMessage(toUser, mediaID string) *CustomerMessage
- type EncryptedXMLMsg
- type EventPic
- type EventType
- type Image
- type InfoType
- type Manager
- type MediaArticle
- type MediaArticles
- type MediaMiniprogrampage
- type MediaMsgmenu
- type MediaMusic
- type MediaNews
- type MediaResource
- type MediaText
- type MediaVideo
- type MediaWxcard
- type MixMessage
- type MsgType
- type MsgmenuItem
- type Music
- type News
- type PrivateSubscribeItem
- type PublicTemplateCategory
- type PublicTemplateKeyWords
- type PublicTemplateTitle
- type Reply
- type ResponseEncryptedXMLMsg
- type Subscribe
- func (tpl *Subscribe) Add(ShortID string, kidList []int, sceneDesc string) (templateID string, err error)
- func (tpl *Subscribe) Delete(templateID string) (err error)
- func (tpl *Subscribe) GetCategory() (categoryList []*PublicTemplateCategory, err error)
- func (tpl *Subscribe) GetPubTplKeyWordsByID(titleID string) (keyWordsList []*PublicTemplateKeyWords, err error)
- func (tpl *Subscribe) GetPublicTemplateTitleList(ids string, start int, limit int) (count int, templateTitleList []*PublicTemplateTitle, err error)
- func (tpl *Subscribe) List() (templateList []*PrivateSubscribeItem, err error)
- func (tpl *Subscribe) Send(msg *SubscribeMessage) (err error)
- type SubscribeDataItem
- type SubscribeMessage
- type SubscribeMsgPopupEvent
- type Template
- type TemplateDataItem
- type TemplateItem
- type TemplateMessage
- type Text
- type TransInfo
- type TransferCustomer
- type Video
- type Voice
Constants ¶
This section is empty.
Variables ¶
var ErrInvalidReply = errors.New("无效的回复消息")
ErrInvalidReply 无效的回复
var ErrUnsupportReply = errors.New("不支持的回复消息")
ErrUnsupportReply 不支持的回复类型
Functions ¶
This section is empty.
Types ¶
type Article ¶
type Article struct {
Title string `xml:"Title,omitempty"`
Description string `xml:"Description,omitempty"`
PicURL string `xml:"PicUrl,omitempty"`
URL string `xml:"Url,omitempty"`
}
Article 单篇文章
type CDATA ¶
type CDATA string
CDATA 使用该类型,在序列化为 xml 文本时文本会被解析器忽略
func (CDATA) MarshalXML ¶
MarshalXML 实现自己的序列化方法
type 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"`
}
CommonToken 消息中通用的结构
func (*CommonToken) GetOpenID ¶
func (msg *CommonToken) GetOpenID() string
GetOpenID get the FromUserName value
func (*CommonToken) SetCreateTime ¶
func (msg *CommonToken) SetCreateTime(createTime int64)
SetCreateTime set createTime
func (*CommonToken) SetFromUserName ¶
func (msg *CommonToken) SetFromUserName(fromUserName CDATA)
SetFromUserName set FromUserName
func (*CommonToken) SetMsgType ¶
func (msg *CommonToken) SetMsgType(msgType MsgType)
SetMsgType set MsgType
func (*CommonToken) SetToUserName ¶
func (msg *CommonToken) SetToUserName(toUserName CDATA)
SetToUserName set ToUserName
type CustomerMessage ¶
type CustomerMessage struct {
ToUser string `json:"touser"` // 接受者OpenID
Msgtype MsgType `json:"msgtype"` // 客服消息类型
Text *MediaText `json:"text,omitempty"` // 可选
Image *MediaResource `json:"image,omitempty"` // 可选
Voice *MediaResource `json:"voice,omitempty"` // 可选
Video *MediaVideo `json:"video,omitempty"` // 可选
Music *MediaMusic `json:"music,omitempty"` // 可选
News *MediaNews `json:"news,omitempty"` // 可选
Mpnews *MediaResource `json:"mpnews,omitempty"` // 可选
Wxcard *MediaWxcard `json:"wxcard,omitempty"` // 可选
Miniprogrampage *MediaMiniprogrampage `json:"miniprogrampage,omitempty"` // 可选
Mpnewsarticle *MediaArticle `json:"mpnewsarticle,omitempty"` // 可选
}
CustomerMessage 客服消息
func NewCustomerImgMessage ¶
func NewCustomerImgMessage(toUser, mediaID string) *CustomerMessage
NewCustomerImgMessage 图片消息的构造方法
func NewCustomerMiniprogrampageMessage ¶
func NewCustomerMiniprogrampageMessage(toUser, title, appID, pagePath, thumbMediaID string) *CustomerMessage
NewCustomerMiniprogrampageMessage 小程序卡片消息的构造方法
func NewCustomerTextMessage ¶
func NewCustomerTextMessage(toUser, text string) *CustomerMessage
NewCustomerTextMessage 文本消息结构体构造方法
func NewCustomerVoiceMessage ¶
func NewCustomerVoiceMessage(toUser, mediaID string) *CustomerMessage
NewCustomerVoiceMessage 语音消息的构造方法
type EncryptedXMLMsg ¶
type EncryptedXMLMsg struct {
XMLName struct{} `xml:"xml" json:"-"`
ToUserName string `xml:"ToUserName" json:"ToUserName"`
EncryptedMsg string `xml:"Encrypt" json:"Encrypt"`
}
EncryptedXMLMsg 安全模式下的消息体
type EventType ¶
type EventType string
EventType 事件类型
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" )
type Image ¶
type Image struct {
CommonToken
Image struct {
MediaID string `xml:"MediaId"`
} `xml:"Image"`
}
Image 图片消息
type InfoType ¶
type InfoType string
InfoType 第三方平台授权事件类型
const ( // InfoTypeVerifyTicket 返回ticket InfoTypeVerifyTicket InfoType = "component_verify_ticket" // InfoTypeAuthorized 授权 InfoTypeAuthorized InfoType = "authorized" InfoTypeUnauthorized InfoType = "unauthorized" // InfoTypeUpdateAuthorized 更新授权 InfoTypeUpdateAuthorized InfoType = "updateauthorized" // InfoTypeNotifyThirdFasterRegister 注册审核事件推送 InfoTypeNotifyThirdFasterRegister InfoType = "notify_third_fasteregister" )
type MediaArticle ¶
type MediaArticle struct {
ArticleID string `json:"article_id"`
}
MediaArticle 消息使用的已发布文章id
type MediaArticles ¶
type MediaArticles struct {
Title string `json:"title"`
Description string `json:"description"`
URL string `json:"url"`
Picurl string `json:"picurl"`
}
MediaArticles 图文消息的内容的文章列表中的单独一条
type MediaMiniprogrampage ¶
type MediaMiniprogrampage struct {
Title string `json:"title"`
AppID string `json:"appid"`
Pagepath string `json:"pagepath"`
ThumbMediaID string `json:"thumb_media_id"`
}
MediaMiniprogrampage 小程序消息
type MediaMusic ¶
type MediaMusic struct {
Title string `json:"title"`
Description string `json:"description"`
Musicurl string `json:"musicurl"`
Hqmusicurl string `json:"hqmusicurl"`
ThumbMediaID string `json:"thumb_media_id"`
}
MediaMusic 音乐消息包括的内容
type MediaNews ¶
type MediaNews struct {
Articles []MediaArticles `json:"articles"`
}
MediaNews 图文消息的内容
type MediaResource ¶
type MediaResource struct {
MediaID string `json:"media_id"`
}
MediaResource 消息使用的永久素材id
type MediaVideo ¶
type MediaVideo struct {
MediaID string `json:"media_id"`
ThumbMediaID string `json:"thumb_media_id"`
Title string `json:"title"`
Description string `json:"description"`
}
MediaVideo 视频消息包含的内容
type 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"`
// 事件相关
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"`
}
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"`
// 卡券相关
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"`
// 设备相关
device.MsgDevice
//小程序审核通知
SuccTime int `xml:"SuccTime"` //审核成功时的时间戳
FailTime int `xml:"FailTime"` //审核不通过的时间戳
DelayTime int `xml:"DelayTime"` //审核延后时的时间戳
Reason string `xml:"Reason"` //审核不通过的原因
ScreenShot string `xml:"ScreenShot"` //审核不通过的截图示例。用 | 分隔的 media_id 的列表,可通过获取永久素材接口拉取截图内容
// contains filtered or unexported fields
}
MixMessage 存放所有微信发送过来的消息和事件
func (*MixMessage) GetSubscribeMsgPopupEvents ¶
func (s *MixMessage) GetSubscribeMsgPopupEvents() []SubscribeMsgPopupEvent
GetSubscribeMsgPopupEvents 获取订阅消息事件数据
func (*MixMessage) SetSubscribeMsgPopupEvents ¶
func (s *MixMessage) SetSubscribeMsgPopupEvents(list []SubscribeMsgPopupEvent)
SetSubscribeMsgPopupEvents 设置订阅消息事件
type MsgType ¶
type MsgType string
MsgType 基本消息类型
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" )
type Music ¶
type Music struct {
CommonToken
Music struct {
Title string `xml:"Title" `
Description string `xml:"Description" `
MusicURL string `xml:"MusicUrl" `
HQMusicURL string `xml:"HQMusicUrl" `
ThumbMediaID string `xml:"ThumbMediaId"`
} `xml:"Music"`
}
Music 音乐消息
type News ¶
type News struct {
CommonToken
ArticleCount int `xml:"ArticleCount"`
Articles []*Article `xml:"Articles>item,omitempty"`
}
News 图文消息
type PrivateSubscribeItem ¶
type PrivateSubscribeItem struct {
PriTmplID string `json:"priTmplId"` // 添加至帐号下的模板 id,发送订阅通知时所需
Title string `json:"title"` // 模版标题
Content string `json:"content"` // 模版内容
Example string `json:"example"` // 模板内容示例
SubType int `json:"type"` // 模版类型,2 为一次性订阅,3 为长期订阅
}
PrivateSubscribeItem 私有订阅消息模板
type PublicTemplateCategory ¶
type PublicTemplateCategory struct {
ID int `json:"id"` // 类目ID
Name string `json:"name"` // 类目的中文名
}
PublicTemplateCategory 公众号类目
type PublicTemplateKeyWords ¶
type PublicTemplateKeyWords struct {
KeyWordsID int `json:"kid"` // 关键词 id
Name string `json:"name"` // 关键词内容
Example string `json:"example"` // 关键词内容对应的示例
Rule string `json:"rule"` // 参数类型
}
PublicTemplateKeyWords 模板中的关键词
type PublicTemplateTitle ¶
type PublicTemplateTitle struct {
TitleID int `json:"tid"` // 模版标题 id
Title string `json:"title"` // 模版标题
Type int `json:"type"` // 模版类型,2 为一次性订阅,3 为长期订阅
CategoryID string `json:"categoryId"` // 模版所属类目 id
}
PublicTemplateTitle 类目下的公共模板
type 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"`
}
ResponseEncryptedXMLMsg 需要返回的消息体
type Subscribe ¶
Subscribe 订阅消息
func (*Subscribe) Add ¶
func (tpl *Subscribe) Add(ShortID string, kidList []int, sceneDesc string) (templateID string, err error)
Add 添加订阅消息模板
func (*Subscribe) GetCategory ¶
func (tpl *Subscribe) GetCategory() (categoryList []*PublicTemplateCategory, err error)
GetCategory 获取公众号类目
func (*Subscribe) GetPubTplKeyWordsByID ¶
func (tpl *Subscribe) GetPubTplKeyWordsByID(titleID string) (keyWordsList []*PublicTemplateKeyWords, err error)
GetPubTplKeyWordsByID 获取模板中的关键词
func (*Subscribe) GetPublicTemplateTitleList ¶
func (tpl *Subscribe) GetPublicTemplateTitleList(ids string, start int, limit int) (count int, templateTitleList []*PublicTemplateTitle, err error)
GetPublicTemplateTitleList 获取类目下的公共模板
func (*Subscribe) List ¶
func (tpl *Subscribe) List() (templateList []*PrivateSubscribeItem, err error)
List 获取私有订阅消息模板列表
type SubscribeDataItem ¶
type SubscribeDataItem struct {
Value string `json:"value"`
}
SubscribeDataItem 模版内某个 .DATA 的值
type SubscribeMessage ¶
type SubscribeMessage struct {
ToUser string `json:"touser"` // 必须, 接受者OpenID
TemplateID string `json:"template_id"` // 必须, 模版ID
Page string `json:"page,omitempty"` // 可选, 跳转网页时填写
Data map[string]*SubscribeDataItem `json:"data"` // 必须, 模板数据
MiniProgram struct {
AppID string `json:"appid"` // 所需跳转到的小程序appid(该小程序appid必须与发模板消息的公众号是绑定关联关系)
PagePath string `json:"pagepath"` // 所需跳转到小程序的具体页面路径,支持带参数,(示例index?foo=bar)
} `json:"miniprogram"` // 可选,跳转至小程序地址
}
SubscribeMessage 发送的订阅消息内容
type SubscribeMsgPopupEvent ¶
type SubscribeMsgPopupEvent struct {
TemplateID string `xml:"TemplateId" json:"TemplateId"`
SubscribeStatusString string `xml:"SubscribeStatusString" json:"SubscribeStatusString"`
PopupScene int `xml:"PopupScene" json:"PopupScene,string"`
}
SubscribeMsgPopupEvent 订阅通知事件推送的消息体
type Template ¶
Template 模板消息
func (*Template) List ¶
func (tpl *Template) List() (templateList []*TemplateItem, err error)
List 获取模板列表
type TemplateDataItem ¶
TemplateDataItem 模版内某个 .DATA 的值
type TemplateItem ¶
type TemplateItem struct {
TemplateID string `json:"template_id"`
Title string `json:"title"`
PrimaryIndustry string `json:"primary_industry"`
DeputyIndustry string `json:"deputy_industry"`
Content string `json:"content"`
Example string `json:"example"`
}
TemplateItem 模板消息.
type TemplateMessage ¶
type TemplateMessage struct {
ToUser string `json:"touser"` // 必须, 接受者OpenID
TemplateID string `json:"template_id"` // 必须, 模版ID
URL string `json:"url,omitempty"` // 可选, 用户点击后跳转的URL, 该URL必须处于开发者在公众平台网站中设置的域中
Color string `json:"color,omitempty"` // 可选, 整个消息的颜色, 可以不设置
Data map[string]*TemplateDataItem `json:"data"` // 必须, 模板数据
ClientMsgID string `json:"client_msg_id,omitempty"` // 可选, 防重入ID
MiniProgram struct {
AppID string `json:"appid"` // 所需跳转到的小程序appid(该小程序appid必须与发模板消息的公众号是绑定关联关系)
PagePath string `json:"pagepath"` // 所需跳转到小程序的具体页面路径,支持带参数,(示例index?foo=bar)
} `json:"miniprogram"` // 可选,跳转至小程序地址
}
TemplateMessage 发送的模板消息内容
type TransferCustomer ¶
type TransferCustomer struct {
CommonToken
TransInfo *TransInfo `xml:"TransInfo,omitempty"`
}
TransferCustomer 转发客服消息
func NewTransferCustomer ¶
func NewTransferCustomer(kfAccount string) *TransferCustomer
NewTransferCustomer 实例化