Serialized Form (wechat 1.8.0 API)

Package me.hao0.wechat.exception
- Class me.hao0.wechat.exception.EventException extends RuntimeException implements Serializable
- Class me.hao0.wechat.exception.WechatException extends RuntimeException implements Serializable
  - Serialized Fields
    - code
```
Integer code
```
      微信返回的errcode
- Class me.hao0.wechat.exception.XmlException extends RuntimeException implements Serializable
Package me.hao0.wechat.model.base
- Class me.hao0.wechat.model.base.AccessToken extends Object implements Serializable
  
  serialVersionUID:
  
  6038499458891708844L
  - Serialized Fields
    - accessToken
```
String accessToken
```
      accessToken
    - expire
```
Integer expire
```
      有效时间(s)
    - expiredAt
```
Long expiredAt
```
      过期时刻(ms)
Package me.hao0.wechat.model.customer
- Class me.hao0.wechat.model.customer.CsSession extends Object implements Serializable
  
  serialVersionUID:
  
  -8380650779042961587L
  - Serialized Fields
    - openId
```
String openId
```
      用户openId
    - createTime
```
Date createTime
```
      会话接入时间
- Class me.hao0.wechat.model.customer.MsgRecord extends Object implements Serializable
  
  serialVersionUID:
  
  -4343547752472563821L
  - Serialized Fields
    - worker
```
String worker
```
      客服帐号
    - openid
```
String openid
```
      用户openid
    - opercode
```
String opercode
```
      客服操作码: 1000 创建未接入会话 1001 接入会话 1002 主动发起会话 1003 转接会话 1004 关闭会话 1005 抢接会话 2001 公众号收到消息 2002 客服发送消息 2003 客服收到消息
    - time
```
Date time
```
      操作时间
    - text
```
String text
```
      聊天记录
- Class me.hao0.wechat.model.customer.UserSession extends Object implements Serializable
  
  serialVersionUID:
  
  2699187929516108564L
  - Serialized Fields
    - kfAccount
```
String kfAccount
```
      客服帐号(包含域名)
    - createTime
```
Date createTime
```
      会话结束时间
- Class me.hao0.wechat.model.customer.WaitingSession extends Object implements Serializable
  
  serialVersionUID:
  
  2699187929516108564L
  - Serialized Fields
    - openId
```
String openId
```
      用户openId
    - kfAccount
```
String kfAccount
```
      客服帐号(包含域名)
    - createTime
```
Date createTime
```
      会话结束时间
Package me.hao0.wechat.model.data.article
- Class me.hao0.wechat.model.data.article.ArticleDailySummary extends CommonSummary implements Serializable
  
  serialVersionUID:
  
  -7195185645683267419L
  - Serialized Fields
    - date
```
String date
```
      日期: yyyy-MM-dd
    - msgId
```
String msgId
```
      群发消息ID: 这里的msgid实际上是由msgid （图文消息id，这也就是群发接口调用后返回的msg_data_id）和index（消息次序索引）组成，例如12003_3，其中12003是msgid，即一次群发的消息的id； 3为index，假设该次群发的图文消息共5个文章（因为可能为多图文），3表示5个中的第3个
    - title
```
String title
```
      图文标题
- Class me.hao0.wechat.model.data.article.ArticleShare extends Object implements Serializable
  
  serialVersionUID:
  
  -2590968439236572137L
  - Serialized Fields
    - date
```
String date
```
      日期
    - scene
```
ArticleShareScene scene
```
      分享场景
    - count
```
Integer count
```
      分享次数
    - user
```
Integer user
```
      分享人数
- Class me.hao0.wechat.model.data.article.ArticleShareHour extends ArticleShare implements Serializable
  
  serialVersionUID:
  
  8015340884882046L
  - Serialized Fields
    - hour
```
Integer hour
```
      小时: 包括从000到2300，分别代表的是[000,100)到[2300,2400)，即每日的第1小时和最后1小时
- Class me.hao0.wechat.model.data.article.ArticleSummary extends CommonSummary implements Serializable
  
  serialVersionUID:
  
  -5668724641461918373L
  - Serialized Fields
    - date
```
String date
```
- Class me.hao0.wechat.model.data.article.ArticleSummaryHour extends CommonSummary implements Serializable
  
  serialVersionUID:
  
  -5668724641461918373L
  - Serialized Fields
    - source
```
ArticleSource source
```
      用户渠道
    - hour
```
Integer hour
```
      小时: 包括从000到2300，分别代表的是[000,100)到[2300,2400)，即每日的第1小时和最后1小时
- Class me.hao0.wechat.model.data.article.ArticleTotal extends Object implements Serializable
  
  serialVersionUID:
  
  -4800022767823366024L
  - Serialized Fields
    - date
```
String date
```
      日期: yyyy-MM-dd
    - msgId
```
String msgId
```
      群发消息ID: 这里的msgid实际上是由msgid （图文消息id，这也就是群发接口调用后返回的msg_data_id）和index（消息次序索引）组成，例如12003_3，其中12003是msgid，即一次群发的消息的id； 3为index，假设该次群发的图文消息共5个文章（因为可能为多图文），3表示5个中的第3个
    - title
```
String title
```
      图文标题
    - details
```
List<E> details
```
      每天对应的数值为该文章到该日为止的总量（而不是当日的量）
- Class me.hao0.wechat.model.data.article.ArticleTotalDetail extends CommonSummary implements Serializable
  
  serialVersionUID:
  
  3233729188265417152L
  - Serialized Fields
    - statDate
```
String statDate
```
      统计的日期，ref_date指的是文章群发出日期，而stat_date是数据统计日期
    - targetUser
```
Integer targetUser
```
      送达人数，一般约等于总粉丝数（需排除黑名单或其他异常情况下无法收到消息的粉丝）
- Class me.hao0.wechat.model.data.article.CommonSummary extends Object implements Serializable
  - Serialized Fields
    - readUser
```
Integer readUser
```
      图文页（点击群发图文卡片进入的页面）的阅读人数
    - readCount
```
Integer readCount
```
      图文页的阅读次数
    - originReadUser
```
Integer originReadUser
```
      原文页（点击图文页“阅读原文”进入的页面）的阅读人数，无原文页时此处数据为0
    - originReadCount
```
Integer originReadCount
```
      原文页的阅读次数
    - shareUser
```
Integer shareUser
```
      分享的人数
    - shareCount
```
Integer shareCount
```
      分享的次数
    - favUser
```
Integer favUser
```
      收藏人数
    - favCount
```
Integer favCount
```
      收藏次数
Package me.hao0.wechat.model.data.interfaces
- Class me.hao0.wechat.model.data.interfaces.InterfaceSummary extends Object implements Serializable
  
  serialVersionUID:
  
  6383545997391007323L
  - Serialized Fields
    - date
```
String date
```
    - callbackCount
```
Integer callbackCount
```
      通过服务器配置地址获得消息后，被动回复用户消息的次数
    - failCount
```
Integer failCount
```
      上述动作的失败次数
    - totalTime
```
Integer totalTime
```
      总耗时，除以callbackCount即为平均耗时
    - maxTime
```
Integer maxTime
```
      最大耗时
- Class me.hao0.wechat.model.data.interfaces.InterfaceSummaryHour extends InterfaceSummary implements Serializable
  
  serialVersionUID:
  
  7437638903080411923L
  - Serialized Fields
    - hour
```
Integer hour
```
      数据的小时
Package me.hao0.wechat.model.data.msg
- Class me.hao0.wechat.model.data.msg.MsgSendDist extends Object implements Serializable
  
  serialVersionUID:
  
  -2677208070764939927L
  - Serialized Fields
    - date
```
String date
```
      日期
    - countInterval
```
Integer countInterval
```
      当日发送消息量分布的区间: 0代表 “0”，1代表“1-5”，2代表“6-10”，3代表“10次以上”
    - msgUser
```
Integer msgUser
```
      想公众号发送消息的用户数
- Class me.hao0.wechat.model.data.msg.MsgSendSummary extends Object implements Serializable
  
  serialVersionUID:
  
  -8877051363122800450L
  - Serialized Fields
    - date
```
String date
```
      日期
    - msgType
```
MsgType msgType
```
      消息类型
    - msgUser
```
Integer msgUser
```
      向公众号发送了消息的用户数
    - msgCount
```
Integer msgCount
```
      向公众号发送的消息数
- Class me.hao0.wechat.model.data.msg.MsgSendSummaryHour extends MsgSendSummary implements Serializable
  
  serialVersionUID:
  
  -1978665674344648838L
  - Serialized Fields
    - hour
```
Integer hour
```
Package me.hao0.wechat.model.data.user
- Class me.hao0.wechat.model.data.user.UserCumulate extends Object implements Serializable
  
  serialVersionUID:
  
  -1481652103074271866L
  - Serialized Fields
    - date
```
String date
```
      日期: yyyy-MM-dd
    - cumulateCount
```
Integer cumulateCount
```
      总用户量
- Class me.hao0.wechat.model.data.user.UserSummary extends Object implements Serializable
  
  serialVersionUID:
  
  -6612438038581745613L
  - Serialized Fields
    - date
```
String date
```
      日期: yyyy-MM-dd
    - source
```
UserSource source
```
      用户的渠道
      
      See Also:
      UserSource
    - newCount
```
Integer newCount
```
      新增的用户数量
    - cancelCount
```
Integer cancelCount
```
      取消关注的用户数量，new_user减去cancel_user即为净增用户数量
Package me.hao0.wechat.model.js
- Class me.hao0.wechat.model.js.Config extends Object implements Serializable
  
  serialVersionUID:
  
  -8263857663686622616L
  - Serialized Fields
    - appId
```
String appId
```
      微信APP ID
    - timestamp
```
Long timestamp
```
      时间戳(秒)
    - nonStr
```
String nonStr
```
      随机字符串
    - signature
```
String signature
```
      签名
- Class me.hao0.wechat.model.js.Ticket extends Object implements Serializable
  
  serialVersionUID:
  
  978451551258121101L
  - Serialized Fields
    - ticket
```
String ticket
```
      凭证字符串
    - type
```
TicketType type
```
      凭证类型
    - expire
```
Integer expire
```
      有效时间(s)
    - expireAt
```
Long expireAt
```
      过期时刻(ms)
Package me.hao0.wechat.model.material
- Class me.hao0.wechat.model.material.CommonMaterial extends Material implements Serializable
  
  serialVersionUID:
  
  -6397218526074423143L
  - Serialized Fields
    - name
```
String name
```
      文件名称
    - url
```
String url
```
      图文页的URL，或者，当获取的列表是图片素材列表时，该字段是图片的URL
- Class me.hao0.wechat.model.material.Material extends Object implements Serializable
  - Serialized Fields
    - mediaId
```
String mediaId
```
    - updateTime
```
Date updateTime
```
- Class me.hao0.wechat.model.material.MaterialCount extends Object implements Serializable
  
  serialVersionUID:
  
  8269265985082026069L
  - Serialized Fields
    - image
```
Integer image
```
      图片数
    - news
```
Integer news
```
      图文数
    - voice
```
Integer voice
```
      语音数
    - video
```
Integer video
```
      视频数
- Class me.hao0.wechat.model.material.NewsContent extends Object implements Serializable
  
  serialVersionUID:
  
  8483540691949616866L
  - Serialized Fields
    - items
```
List<E> items
```
- Class me.hao0.wechat.model.material.NewsContentItem extends Object implements Serializable
  
  serialVersionUID:
  
  8483540691949616866L
  - Serialized Fields
    - title
```
String title
```
      图文消息的标题
    - thumbMediaId
```
String thumbMediaId
```
      图文消息的封面图片素材id（必须是永久mediaID）
    - showCoverPic
```
Integer showCoverPic
```
      是否显示封面，0为false，即不显示，1为true，即显示
    - author
```
String author
```
      作者
    - digest
```
String digest
```
      图文消息的摘要，仅有单图文消息才有摘要，多图文此处为空
    - content
```
String content
```
      内容
    - url
```
String url
```
      URL
    - contentSourceUrl
```
String contentSourceUrl
```
      图文消息的原文地址，即点击“阅读原文”后的URL
- Class me.hao0.wechat.model.material.NewsMaterial extends Material implements Serializable
  
  serialVersionUID:
  
  8483540691949616866L
  - Serialized Fields
    - content
```
NewsContent content
```
- Class me.hao0.wechat.model.material.PermMaterial extends Object implements Serializable
  
  serialVersionUID:
  
  4907386605074554874L
  - Serialized Fields
    - mediaId
```
String mediaId
```
    - url
```
String url
```
- Class me.hao0.wechat.model.material.TempMaterial extends Object implements Serializable
  
  serialVersionUID:
  
  -824128825701922924L
  - Serialized Fields
    - type
```
MaterialUploadType type
```
    - mediaId
```
String mediaId
```
    - createdAt
```
Date createdAt
```
Package me.hao0.wechat.model.menu
- Class me.hao0.wechat.model.menu.Menu extends Object implements Serializable
  
  serialVersionUID:
  
  3569890088693211989L
  - Serialized Fields
    - name
```
String name
```
      名称: 一级最多4个字，二级最多7个字
    - type
```
String type
```
      类型
    - key
```
String key
```
      菜单key，当type="click"时
    - url
```
String url
```
      菜单url，当type="view"时
    - children
```
List<E> children
```
      最多3个一级，5个二级
Package me.hao0.wechat.model.message.receive
- Class me.hao0.wechat.model.message.receive.RecvMessage extends Object implements Serializable
  - Serialized Fields
    - toUserName
```
String toUserName
```
      开发者微信号
    - fromUserName
```
String fromUserName
```
      用户openId
    - createTime
```
Integer createTime
```
      消息创建时间
    - msgType
```
String msgType
```
      消息类型:
      
      See Also:
      RespMessageType
Package me.hao0.wechat.model.message.receive.event
- Class me.hao0.wechat.model.message.receive.event.RecvEvent extends RecvMessage implements Serializable
  - Serialized Fields
    - eventType
```
String eventType
```
      事件类型:
      
      See Also:
      RecvEvent
- Class me.hao0.wechat.model.message.receive.event.RecvLocationEvent extends RecvEvent implements Serializable
  - Serialized Fields
    - latitude
```
String latitude
```
      纬度
    - longitude
```
String longitude
```
      经度
    - precision
```
String precision
```
      精度
- Class me.hao0.wechat.model.message.receive.event.RecvMenuEvent extends RecvEvent implements Serializable
  - Serialized Fields
    - eventKey
```
String eventKey
```
      eventType为CLICK时: 与自定义菜单接口中KEY值对应 eventType为VIEW时: 设置的跳转URL
- Class me.hao0.wechat.model.message.receive.event.RecvScanEvent extends RecvEvent implements Serializable
  - Serialized Fields
    - eventKey
```
String eventKey
```
      事件KEY值，是一个32位无符号整数，即创建二维码时的二维码scene_id
    - ticket
```
String ticket
```
      二维码的ticket，可用来换取二维码图片
- Class me.hao0.wechat.model.message.receive.event.RecvSubscribeEvent extends RecvEvent implements Serializable
  - Serialized Fields
    - eventKey
```
String eventKey
```
      事件KEY值，是一个32位无符号整数，即创建二维码时的二维码scene_id
    - ticket
```
String ticket
```
      二维码的ticket，可用来换取二维码图片
- Class me.hao0.wechat.model.message.receive.event.RecvUnSubscribeEvent extends RecvEvent implements Serializable
Package me.hao0.wechat.model.message.receive.msg
- Class me.hao0.wechat.model.message.receive.msg.RecvImageMessage extends RecvMsg implements Serializable
  
  serialVersionUID:
  
  3465602607733657276L
  - Serialized Fields
    - picUrl
```
String picUrl
```
      图片链接
    - mediaId
```
String mediaId
```
      图片消息媒体id，可以调用多媒体文件下载接口拉取数据。
- Class me.hao0.wechat.model.message.receive.msg.RecvLinkMessage extends RecvMsg implements Serializable
  
  serialVersionUID:
  
  -8070100690774814611L
  - Serialized Fields
    - title
```
String title
```
      消息标题
    - description
```
String description
```
      消息描述
    - url
```
String url
```
      消息链接
- Class me.hao0.wechat.model.message.receive.msg.RecvLocationMessage extends RecvMsg implements Serializable
  
  serialVersionUID:
  
  2468731105380952027L
  - Serialized Fields
    - locationX
```
String locationX
```
      纬度
    - locationY
```
String locationY
```
      经度
    - scale
```
Integer scale
```
      缩放大小
    - label
```
String label
```
      位置信息
- Class me.hao0.wechat.model.message.receive.msg.RecvMsg extends RecvMessage implements Serializable
  
  serialVersionUID:
  
  8863935279441026878L
  - Serialized Fields
    - msgId
```
Long msgId
```
      消息ID
- Class me.hao0.wechat.model.message.receive.msg.RecvShortVideoMessage extends RecvVideoMessage implements Serializable
  
  serialVersionUID:
  
  4589295453710532536L
- Class me.hao0.wechat.model.message.receive.msg.RecvTextMessage extends RecvMsg implements Serializable
  
  serialVersionUID:
  
  -8070100690774814611L
  - Serialized Fields
    - content
```
String content
```
      文本内容
- Class me.hao0.wechat.model.message.receive.msg.RecvVideoMessage extends RecvMsg implements Serializable
  
  serialVersionUID:
  
  -3750491257934605285L
  - Serialized Fields
    - mediaId
```
String mediaId
```
      视频消息媒体id，可以调用多媒体文件下载接口拉取数据。
    - thumbMediaId
```
String thumbMediaId
```
      视频消息缩略图的媒体id，可以调用多媒体文件下载接口拉取数据。
- Class me.hao0.wechat.model.message.receive.msg.RecvVoiceMessage extends RecvMsg implements Serializable
  
  serialVersionUID:
  
  4578361001225765322L
  - Serialized Fields
    - mediaId
```
String mediaId
```
      语音消息媒体id，可以调用多媒体文件下载接口拉取数据。
    - format
```
String format
```
      语音格式，如amr，speex等
    - recognition
```
String recognition
```
      语音识别结果，使用UTF8编码
Package me.hao0.wechat.model.message.resp
- Class me.hao0.wechat.model.message.resp.Article extends Object implements Serializable
  
  serialVersionUID:
  
  -5038606046133238683L
  - Serialized Fields
    - title
```
String title
```
    - desc
```
String desc
```
    - picUrl
```
String picUrl
```
      图片链接，支持JPG、PNG格式，较好的效果为大图360*200，小图200*200
    - url
```
String url
```
      点击图文消息跳转链接
Package me.hao0.wechat.model.message.send
- Class me.hao0.wechat.model.message.send.SendMessage extends Object implements Serializable
  
  serialVersionUID:
  
  8803986913007718602L
  - Serialized Fields
    - type
```
SendMessageType type
```
      消息类型:
      
      See Also:
      SendMessageType
    - scope
```
SendMessageScope scope
```
      发送范围
      
      See Also:
      SendMessageScope
    - groupId
```
Integer groupId
```
      分组群发消息时分组ID
    - isToAll
```
Boolean isToAll
```
      分组群发消息时用于设定是否向全部用户发送，值为true或false，选择true该消息群发给所有用户，选择false可根据group_id发送给指定群组的用户
    - openIds
```
List<E> openIds
```
      OpenID列表群发用户openId列表，与groupId和isToAll排斥
    - content
```
String content
```
      文本消息内容，当type为文本时
    - mediaId
```
String mediaId
```
      用于群发的消息的media_id，当type为语音，图文，视频，图片时
    - cardId
```
String cardId
```
      卡券ID，当type为卡券时
    - thumbMediaId
```
String thumbMediaId
```
      视频缩略图的媒体ID
    - title
```
String title
```
      消息的标题
    - description
```
String description
```
      消息的描述
- Class me.hao0.wechat.model.message.send.SendPreviewMessage extends Object implements Serializable
  
  serialVersionUID:
  
  -5227718099852463553L
  - Serialized Fields
    - type
```
SendMessageType type
```
      消息类型:
      
      See Also:
      SendMessageType
    - openId
```
String openId
```
      用户openId
    - content
```
String content
```
      文本消息内容，当type为文本时
    - mediaId
```
String mediaId
```
      用于群发的消息的media_id，当type为语音，图文，视频，图片时
    - cardId
```
String cardId
```
      卡券ID，当type为卡券时
- Class me.hao0.wechat.model.message.send.TemplateField extends Object implements Serializable
  
  serialVersionUID:
  
  8228081012066368310L
  - Serialized Fields
    - name
```
String name
```
      名称
    - value
```
String value
```
      值
    - color
```
String color
```
      颜色
Package me.hao0.wechat.model.qrcode
- Class me.hao0.wechat.model.qrcode.Qrcode extends Object implements Serializable
  
  serialVersionUID:
  
  -8864173402832984445L
  - Serialized Fields
    - ticket
```
String ticket
```
      获取的二维码ticket，凭借此ticket可以在有效时间内换取二维码。
    - expireSeconds
```
String expireSeconds
```
      有效时间(秒)
    - url
```
String url
```
      二维码图片解析后的地址，开发者可根据该地址自行生成需要的二维码图片
Package me.hao0.wechat.model.user
- Class me.hao0.wechat.model.user.Group extends Object implements Serializable
  
  serialVersionUID:
  
  2140215642384090492L
  - Serialized Fields
    - id
```
Integer id
```
      微信分配的ID
    - name
```
String name
```
      名称
    - count
```
Integer count
```
      分组内用户量
- Class me.hao0.wechat.model.user.User extends Object implements Serializable
  - Serialized Fields
    - subscribe
```
Integer subscribe
```
      0未关注，1已关注
    - openId
```
String openId
```
    - nickName
```
String nickName
```
    - sex
```
Integer sex
```
      0未知，1男，2女
    - city
```
String city
```
    - province
```
String province
```
    - country
```
String country
```
    - headImgUrl
```
String headImgUrl
```
    - subscribeTime
```
Date subscribeTime
```
    - unionId
```
String unionId
```
    - remark
```
String remark
```
    - groupId
```
Integer groupId
```

Serialized Form

Package me.hao0.wechat.exception

Class me.hao0.wechat.exception.EventException extends RuntimeException implements Serializable

Class me.hao0.wechat.exception.WechatException extends RuntimeException implements Serializable

Serialized Fields

code

Class me.hao0.wechat.exception.XmlException extends RuntimeException implements Serializable

Package me.hao0.wechat.model.base

Class me.hao0.wechat.model.base.AccessToken extends Object implements Serializable

Serialized Fields

accessToken

expire

expiredAt

Package me.hao0.wechat.model.customer

Class me.hao0.wechat.model.customer.CsSession extends Object implements Serializable

Serialized Fields

openId

createTime

Class me.hao0.wechat.model.customer.MsgRecord extends Object implements Serializable

Serialized Fields

worker

openid

opercode

time

text

Class me.hao0.wechat.model.customer.UserSession extends Object implements Serializable

Serialized Fields

kfAccount

createTime

Class me.hao0.wechat.model.customer.WaitingSession extends Object implements Serializable

Serialized Fields

openId

kfAccount

createTime

Package me.hao0.wechat.model.data.article

Class me.hao0.wechat.model.data.article.ArticleDailySummary extends CommonSummary implements Serializable

Serialized Fields

date

msgId

title

Class me.hao0.wechat.model.data.article.ArticleShare extends Object implements Serializable

Serialized Fields

date

scene

count

user

Class me.hao0.wechat.model.data.article.ArticleShareHour extends ArticleShare implements Serializable

Serialized Fields

hour

Class me.hao0.wechat.model.data.article.ArticleSummary extends CommonSummary implements Serializable

Serialized Fields

date

Class me.hao0.wechat.model.data.article.ArticleSummaryHour extends CommonSummary implements Serializable

Serialized Fields

source

hour

Class me.hao0.wechat.model.data.article.ArticleTotal extends Object implements Serializable

Serialized Fields

date

msgId

title

details

Class me.hao0.wechat.model.data.article.ArticleTotalDetail extends CommonSummary implements Serializable

Serialized Fields

statDate

targetUser

Class me.hao0.wechat.model.data.article.CommonSummary extends Object implements Serializable

Serialized Fields

readUser

readCount

originReadUser

originReadCount

shareUser

shareCount

favUser

favCount

Package me.hao0.wechat.model.data.interfaces

Class me.hao0.wechat.model.data.interfaces.InterfaceSummary extends Object implements Serializable

Serialized Fields

date