structure.go 13 KB

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