structure.go 11 KB

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