structure.go 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374
  1. package wechat
  2. import (
  3. "encoding/xml"
  4. )
  5. // FormSignature signature
  6. type FormSignature struct {
  7. TimeStamp string `form:"timestamp" json:"timestamp"`
  8. Nonce string `form:"nonce" json:"nonce"`
  9. Signature string `form:"signature" json:"signature"`
  10. Echostr string `form:"echostr" json:"echostr"`
  11. }
  12. // FormAuthorize get code
  13. type FormAuthorize struct {
  14. Code string `form:"code"`
  15. State string `form:"state"`
  16. URL string `form:"url"`
  17. }
  18. // FormOpenID openid
  19. type FormOpenID struct {
  20. OpenID string `form:"openid"`
  21. }
  22. // FormCode code
  23. type FormCode struct {
  24. Code string `form:"code"`
  25. }
  26. // FormSignPackage js sign package
  27. type FormSignPackage struct {
  28. URL string `form:"url"`
  29. }
  30. // FormURLState redirect url and state
  31. type FormURLState struct {
  32. RedirectURL string `form:"url" json:"url" xml:"url"`
  33. State string `form:"state" json:"state" xml:"state"`
  34. }
  35. // ResponseMsg response
  36. type ResponseMsg struct {
  37. ErrCode int `json:"errcode"`
  38. ErrMsg string `json:"errmsg"`
  39. }
  40. /*
  41. // Response response
  42. type Response struct {
  43. ErrCode int `json:"errcode"`
  44. ErrMsg string `json:"errmsg"`
  45. // token
  46. AccessToken string `json:"access_token"`
  47. ExpiresIn int `json:"expires_in"`
  48. // openid
  49. RefreshToken string `json:"refresh_token"`
  50. OpenID string `json:"openid"`
  51. Scope string `json:"scope"`
  52. // user info
  53. NickName string `json:"nickname"`
  54. Sex string `json:"sex"`
  55. Province string `json:"province"`
  56. City string `json:"city"`
  57. Country string `json:"country"`
  58. HeadImgURL string `json:"headimgurl"`
  59. Privilege string `json:"privilege"`
  60. UnionID string `json:"unionid"`
  61. // template message
  62. MsgID int64 `json:"msgid"`
  63. // jsapi_ticket
  64. Ticket string `json:"ticket"`
  65. // mini get openid by code
  66. SessionKey string `json:"session_key"`
  67. }
  68. // */
  69. // Message message
  70. type Message struct {
  71. XMLName xml.Name `xml:"xml"`
  72. ToUserName string `xml:"ToUserName" json:"ToUserName"`
  73. FromUserName string `xml:"FromUserName" json:"FromUserName"`
  74. CreateTime int64 `xml:"CreateTime" json:"CreateTime"`
  75. MsgType string `xml:"MsgType" json:"MsgType"` // text/image/voice/video/shortvideo/location/link
  76. // 文本 Text Text message
  77. Text string `xml:"Content,omitempty" json:"Content,omitempty"`
  78. // 图片 PicURL / MediaID image messgae
  79. PicURL string `xml:"PicUrl,omitempty" json:"PicUrl,omitempty"`
  80. // MediaID 媒体
  81. MediaID string `xml:"MediaId,omitempty" json:"MediaId,omitempty"`
  82. // 语音 MediaID / Format voice message
  83. Format string `xml:"Format,omitempty" json:"Format,omitempty"`
  84. // 视频/小视频 ThumbMediaID / MediaID video/shortvideo message
  85. ThumbMediaID string `xml:"ThumbMediaId,omitempty" json:"ThumbMediaId,omitempty"`
  86. // 地理位置 location message
  87. LocationX string `xml:"Location_X,omitempty" json:"Location_X,omitempty"` // 纬度
  88. LocationY string `xml:"Location_Y,omitempty" json:"Location_Y,omitempty"` // 经度
  89. Scale string `xml:"Scale,omitempty" json:"Scale,omitempty"` // 地图缩放大小
  90. Label string `xml:"Label,omitempty" json:"Label,omitempty"` // 地理位置信息
  91. // 链接消息 link
  92. Title string `xml:"Title,omitempty" json:"Title,omitempty"` // 消息标题
  93. Description string `xml:"Description,omitempty" json:"Description,omitempty"` // 消息描述
  94. URL string `xml:"Url,omitempty" json:"Url,omitempty"` // 消息链接
  95. Event string `xml:"Event,omitempty" json:"Event,omitempty"` // 事件 subscribe(订阅)、unsubscribe(取消订阅)、CLICK(自定义菜单事件)、SCAN
  96. // 扫描带参数二维码事件
  97. EventKey string `xml:"EventKey,omitempty" json:"EventKey,omitempty"` // 事件KEY 值,扫码未关注的 qrscene_ 为前缀(subscribe 事件, 已关注的推送 SCAN 事件),后面为二维码的参数值, 自定义菜单事件与自定义菜单接口中 KEY 值对应
  98. Ticket string `xml:"Ticket,omitempty" json:"Ticket,omitempty"` // 二维码的ticket,可用来换取二维码图片
  99. // 地理位置 location message
  100. Latitude string `xml:"Latitude,omitempty" json:"Latitude,omitempty"` // 纬度
  101. Longitude string `xml:"Longitude,omitempty" json:"Longitude,omitempty"` // 经度
  102. Precision string `xml:"Precision,omitempty" json:"Precision,omitempty"` // 地理位置精度
  103. MsgID int64 `xml:"MsgId,omitempty" json:"MsgId,omitempty"` // 消息id
  104. Status string `xml:"Status,omitempty" json:"Status,omitempty"` // 消息发送状态
  105. }
  106. // ArticleItem article item
  107. type ArticleItem struct {
  108. Title string `xml:"Title" json:"Title"`
  109. Description string `xml:"Description" json:"Description"`
  110. PicURL string `xml:"PicUrl" json:"PicUrl"`
  111. URL string `xml:"Url" json:"Url"`
  112. }
  113. type articleItems struct {
  114. Items []ArticleItem `xml:"item" json:"item"`
  115. }
  116. // ReplyMessage reply message
  117. type ReplyMessage struct {
  118. XMLName xml.Name `xml:"xml"`
  119. ToUserName string `xml:"ToUserName" json:"ToUserName"`
  120. FromUserName string `xml:"FromUserName" json:"FromUserName"`
  121. CreateTime int64 `xml:"CreateTime" json:"CreateTime"`
  122. MsgType string `xml:"MsgType" json:"MsgType"` // text/image/voice/video/music/news
  123. // 文本 Content Text message
  124. Content string `xml:"Content,omitempty" json:"Content,omitempty"`
  125. // image
  126. ArticleCount int `xml:"ArticleCount,omitempty" json:"ArticleCount,omitempty"`
  127. Articles *articleItems `xml:"Articles,omitempty" json:"Articles,omitempty"`
  128. }
  129. /*
  130. <xml>
  131. <ToUserName><![CDATA[toUser]]></ToUserName>
  132. <FromUserName><![CDATA[fromUser]]></FromUserName>
  133. <CreateTime>12345678</CreateTime>
  134. <MsgType><![CDATA[news]]></MsgType>
  135. <ArticleCount>1</ArticleCount>
  136. <Articles>
  137. <item>
  138. <Title><![CDATA[title1]]></Title>
  139. <Description><![CDATA[description1]]></Description>
  140. <PicUrl><![CDATA[picurl]]></PicUrl>
  141. <Url><![CDATA[url]]></Url>
  142. </item>
  143. </Articles>
  144. </xml>
  145. // */
  146. // EventTemplateReply event reply
  147. type EventTemplateReply struct {
  148. XMLName xml.Name `xml:"xml"`
  149. ToUserName string `xml:"ToUserName"`
  150. FromUserName string `xml:"FromUserName"`
  151. CreateTime string `xml:"CreateTime"`
  152. MsgType string `xml:"MsgType"`
  153. Event string `xml:"Event"`
  154. MsgID string `xml:"MsgID"`
  155. Status string `xml:"Status"`
  156. }
  157. // SignPackage sign package
  158. type SignPackage struct {
  159. AppID string `json:"appId"`
  160. NonceStr string `json:"nonceStr"`
  161. Timestamp int64 `json:"timestamp"`
  162. Signature string `json:"signature"`
  163. Ticket string `json:"ticket"`
  164. URL string `json:"url"`
  165. }
  166. // Client wechat
  167. type Client struct {
  168. AppID string `json:"appid"`
  169. AppSecret string `json:"appsecret"`
  170. Token string `json:"token"`
  171. EncodingAESKey string `json:"encodingaeskey"`
  172. //ReadLock *sync.Mutex
  173. AccessToken string
  174. LastTokenTime int64
  175. Ticket string
  176. LastTicketTime int64
  177. }
  178. // MiniClient wechat mini
  179. type MiniClient struct {
  180. AppID string `json:"appid"`
  181. AppSecret string `json:"appsecret"`
  182. AccessToken string
  183. LastTokenTime int64
  184. }
  185. // FormMaterial Material
  186. type FormMaterial struct {
  187. Type string `form:"type"`
  188. Offset int `form:"offset"`
  189. Count int `form:"count"`
  190. }
  191. // UserInfo userinfo
  192. type UserInfo struct {
  193. SubScribe int `json:"subscribe"`
  194. OpenID string `json:"openid"`
  195. NickName string `json:"nickname"`
  196. Sex int `json:"sex"`
  197. Language string `json:"language"`
  198. City string `json:"city"`
  199. Province string `json:"province"`
  200. Country string `json:"country"`
  201. HeadImgURL string `json:"headimgurl"`
  202. SubscribeTime int `json:"subscribe_time"`
  203. UnionID string `json:"unionid"`
  204. Remark string `json:"remark"`
  205. GroupID int `json:"groupid"`
  206. TagidList []int `json:"tagid_list"`
  207. SubscribeScene string `json:"subscribe_scene"`
  208. QrScene int `json:"qr_scene"`
  209. QrSceneStr string `json:"qr_scene_str"`
  210. }
  211. // List openid list
  212. type List struct {
  213. OpenID []string `json:"openid"`
  214. }
  215. // UserList user list
  216. type UserList struct {
  217. Total int `json:"total"`
  218. Count int `json:"count"`
  219. Data List `json:"data"`
  220. NextOpenID string `json:"next_openid"`
  221. }
  222. // MaterialNewsItem 图片素材
  223. type MaterialNewsItem struct {
  224. Title string `json:"title"`
  225. Author string `json:"author"`
  226. Digest string `json:"digest"`
  227. Content string `json:"content"`
  228. ContentSourceURL string `json:"content_source_url"`
  229. ThumbMediaID string `json:"thumb_media_id"`
  230. ShowCoverPic int `json:"show_cover_pic"`
  231. URL string `json:"url"`
  232. ThumbURL string `json:"thumb_url"`
  233. NeedOpenComment int `json:"need_open_comment"`
  234. OnlyFansCanComment int `json:"only_fans_can_comment"`
  235. }
  236. // MaterialContent 素材内容
  237. type MaterialContent struct {
  238. NewsItem []*MaterialNewsItem `json:"news_item,omitempty"`
  239. CreateTime int `json:"create_time,omitempty"`
  240. UpdateTime int `json:"update_time,omitempty"`
  241. }
  242. // MaterialItem 素材信息
  243. type MaterialItem struct {
  244. MediaID string `json:"media_id"`
  245. Name string `json:"name,omitempty"`
  246. UpdateTime int `json:"update_time"`
  247. URL string `json:"url,omitempty"`
  248. Content *MaterialContent `json:"content,omitempty"`
  249. }
  250. // Material 素材
  251. type Material struct {
  252. TotalCount int `json:"total_count"`
  253. ItemCount int `json:"item_count"`
  254. Item []MaterialItem `json:"item"`
  255. }
  256. // MiniProgramPage mini
  257. type MiniProgramPage struct {
  258. AppID string `json:"appid,omitempty"`
  259. PagePath string `json:"pagepath,omitempty"`
  260. }
  261. // ValueColor value color
  262. type ValueColor struct {
  263. Value string `json:"value"`
  264. Color string `json:"color,omitempty"`
  265. }
  266. // TemplateData data
  267. type TemplateData struct {
  268. First *ValueColor `json:"first"`
  269. Keyword1 *ValueColor `json:"keyword1,omitempty"`
  270. Keyword2 *ValueColor `json:"keyword2,omitempty"`
  271. Keyword3 *ValueColor `json:"keyword3,omitempty"`
  272. Keyword4 *ValueColor `json:"keyword4,omitempty"`
  273. Keyword5 *ValueColor `json:"keyword5,omitempty"`
  274. Keyword6 *ValueColor `json:"keyword6,omitempty"`
  275. Keyword7 *ValueColor `json:"keyword7,omitempty"`
  276. Keyword8 *ValueColor `json:"keyword8,omitempty"`
  277. Keyword9 *ValueColor `json:"keyword9,omitempty"`
  278. Keyword10 *ValueColor `json:"keyword10,omitempty"`
  279. Name *ValueColor `json:"name,omitempty"`
  280. ExpDate *ValueColor `json:"expDate,omitempty"`
  281. Remark *ValueColor `json:"remark,omitempty"`
  282. }
  283. // TemplateMessage template message
  284. type TemplateMessage struct {
  285. ToUser string `json:"touser"`
  286. TemplateID string `json:"template_id"`
  287. URL string `json:"url"`
  288. MiniProgram *MiniProgramPage `json:"miniprogram,omitempty"`
  289. Data TemplateData `json:"data"`
  290. }
  291. // MiniTemplateMessage mini template message
  292. type MiniTemplateMessage struct {
  293. ToUser string `json:"touser"`
  294. TemplateID string `json:"template_id"`
  295. Page string `json:"page"`
  296. FormID string `json:"form_id"`
  297. Data TemplateData `json:"data"`
  298. }
  299. // WeappTemplateMessage mini message
  300. type WeappTemplateMessage struct {
  301. TemplateID string `json:"template_id"`
  302. Page string `json:"page"`
  303. FormID string `json:"form_id"`
  304. Data TemplateData `json:"data"`
  305. Emphasis string `json:"emphasis_keyword"`
  306. }
  307. // MpTemplateMessage wechat public message
  308. type MpTemplateMessage struct {
  309. AppID string `json:"appid"`
  310. TemplateID string `json:"template_id"`
  311. URL string `json:"url"`
  312. Mini MiniProgramPage `json:"miniprogram"`
  313. Data TemplateData `json:"data"`
  314. }
  315. // MiniUniformMessage mini uniform send
  316. type MiniUniformMessage struct {
  317. ToUser string `json:"touser"`
  318. WeApp *WeappTemplateMessage `json:"weapp_template_msg,omitempty"`
  319. MP *MpTemplateMessage `json:"mp_template_msg,omitempty"`
  320. }