structure.go 13 KB

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