structure.go 13 KB

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