Serialized Form

Package com.foxinmy.weixin4j.mp.datacube

Class com.foxinmy.weixin4j.mp.datacube.ArticleDatacube1 extends Object implements Serializable

serialVersionUID: 4140706754295502971L

Serialized Fields

intPageReadUser

int intPageReadUser

图文页（点击群发图文卡片进入的页面）的阅读人数

intPageReadCount

int intPageReadCount

图文页的阅读次数

oriPageReadUser

int oriPageReadUser

原文页（点击图文页“阅读原文”进入的页面）的阅读人数，无原文页时此处数据为0

oriPageReadCount

int oriPageReadCount

原文页的阅读次数

shareUser

int shareUser

分享的人数

shareCount

int shareCount

分享的次数

favUser

int favUser

收藏的人数

favCount

int favCount

收藏的次数

Class com.foxinmy.weixin4j.mp.datacube.ArticleDatacube2 extends ArticleDatacube1 implements Serializable

serialVersionUID: -2924534868674264316L

Serialized Fields

statDate

Date statDate

统计的日期

targetUser

int targetUser

送达人数，一般约等于总粉丝数（需排除黑名单或其他异常情况下无法收到消息的粉丝）

Class com.foxinmy.weixin4j.mp.datacube.ArticleDatacubeShare extends Object implements Serializable

serialVersionUID: 3841239305410294553L

Serialized Fields

refDate

Date refDate

数据的日期

refHour

int refHour

数据的小时，包括从000到2300，分别代表的是[000,100)到[2300,2400)，即每日的第1小时和最后1小时

shareUser

int shareUser

分享的人数

shareCount

int shareCount

分享的次数

shareScene

int shareScene

分享的场景

Class com.foxinmy.weixin4j.mp.datacube.ArticleSummary extends ArticleDatacube1 implements Serializable

serialVersionUID: 4820605570501368550L

Serialized Fields

refDate

Date refDate

数据的日期

refHour

int refHour

数据的小时，包括从000到2300，分别代表的是[000,100)到[2300,2400)，即每日的第1小时和最后1小时

msgId

String msgId

请注意：这里的msgid实际上是由msgid（图文消息id，这也就是群发接口调用后返回的msg_data_id）和index（消息次序索引）组成， 例如12003_3， 其中12003是msgid，即一次群发的消息的id； 3为index，假设该次群发的图文消息共5个文章（因为可能为多图文），3表示5个中的第3个

title

String title

图文消息的标题

Class com.foxinmy.weixin4j.mp.datacube.ArticleTotal extends Object implements Serializable

serialVersionUID: -6820948857241500950L

Serialized Fields

refDate

Date refDate

数据的日期

msgId

String msgId

这里的msgid实际上是由msgid（图文消息id）和index（消息次序索引）组成， 例如12003_3， 其中12003是msgid，即一次群发的id消息的； 3为index，假设该次群发的图文消息共5个文章（因为可能为多图文）， 3表示5个中的第3个

title

String title

图文消息的标题

details

List<E> details

详细信息

Class com.foxinmy.weixin4j.mp.datacube.InterfaceSummary extends Object implements Serializable

serialVersionUID: -8812979112580350988L

Serialized Fields

refDate

Date refDate

引用的日期

refHour

int refHour

数据的小时，包括从000到2300，分别代表的是[000,100)到[2300,2400)，即每日的第1小时和最后1小时

callbackCount

int callbackCount

通过服务器配置地址获得消息后，被动回复用户消息的次数

failCount

int failCount

上述动作的失败次数

totalTimeCost

int totalTimeCost

总耗时，除以callback_count即为平均耗时

maxTimeCost

int maxTimeCost

最大耗时

Class com.foxinmy.weixin4j.mp.datacube.UpstreamMsg extends Object implements Serializable

serialVersionUID: -2605207523094962029L

Serialized Fields

refDate

Date refDate

引用的日期

refHour

int refHour

数据的小时，包括从000到2300，分别代表的是[000,100)到[2300,2400)，即每日的第1小时和最后1小时

msgType

int msgType

消息类型

msgUser

int msgUser

上行发送了（向公众号发送了）消息的用户数

msgCount

int msgCount

上行发送了消息的消息总数

Class com.foxinmy.weixin4j.mp.datacube.UpstreamMsgDist extends Object implements Serializable

serialVersionUID: -2605207523094962029L

Serialized Fields

refDate

Date refDate

引用的日期

msgUser

int msgUser

上行发送了（向公众号发送了）消息的用户数

countInterval

int countInterval

当日发送消息量分布的区间，0代表 “0”，1代表“1-5”，2代表“6-10”，3代表“10次以上

Class com.foxinmy.weixin4j.mp.datacube.UserSummary extends Object implements Serializable

serialVersionUID: 5303181828798568052L

Serialized Fields

refDate

Date refDate

数据的日期

userSource

int userSource

用户的渠道

newUser

int newUser

新增的用户数量

cancelUser

int cancelUser

取消关注的用户数量，new_user减去cancel_user即为净增用户数量

cumulateUser

int cumulateUser

总用户量

Package com.foxinmy.weixin4j.mp.message

Class com.foxinmy.weixin4j.mp.message.NotifyMessage extends Object implements Serializable

serialVersionUID: 7190233634431087729L

Serialized Fields

touser

String touser

用户的openid

tuple

NotifyTuple tuple

消息对象

Class com.foxinmy.weixin4j.mp.message.TemplateMessage extends Object implements Serializable

serialVersionUID: 7950608393821661436L

Serialized Fields

toUser

String toUser

用户的openid

templateId

String templateId

模板ID

url

String url

点击消息跳转的url

head

NameValue head

头部信息(first第一行)

tail

NameValue tail

尾部信息(remark最后行)

content

Map<K,V> content

数据项

Package com.foxinmy.weixin4j.mp.model

Class com.foxinmy.weixin4j.mp.model.AuthorizerOption extends Object implements Serializable

serialVersionUID: -3124882411789627403L

Serialized Fields

name

AuthorizerOption.AuthorizerOptionName name

value

int value

options

List<E> options

Class com.foxinmy.weixin4j.mp.model.AutoReplySetting extends Object implements Serializable

serialVersionUID: 8164017927864497009L

Serialized Fields

isAddFriendReplyOpen

boolean isAddFriendReplyOpen

关注后自动回复是否开启

isAutoreplyOpen

boolean isAutoreplyOpen

消息自动回复是否开启

addFriendReply

AutoReplySetting.Entry addFriendReply

关注后自动回复的信息

See Also:

AutoReplySetting.Entry

defaultReply

AutoReplySetting.Entry defaultReply

默认自动回复的信息

See Also:

AutoReplySetting.Entry

keywordReplyList

List<E> keywordReplyList

关键词自动回复的信息

See Also:

AutoReplySetting.Rule

Class com.foxinmy.weixin4j.mp.model.AutoReplySetting.Entry extends Object implements Serializable

serialVersionUID: -187922224547974025L

Serialized Fields

type

ButtonType type

自动回复的类型。关注后自动回复和消息自动回复的类型仅支持文本（text）、图片（img）、语音（voice）、视频（video）， 关键词自动回复则还多了图文消息(news)

content

Serializable content

对于文本类型，content是文本内容，对于图片、语音、视频类型，content是mediaID,news是article

See Also:

MpArticle

matchMode

AutomatchMode matchMode

匹配模式(仅但关键字列表)

See Also:

AutomatchMode

Class com.foxinmy.weixin4j.mp.model.AutoReplySetting.Rule extends Object implements Serializable

serialVersionUID: -7299903545861946025L

Serialized Fields

ruleName

String ruleName

规则名称

createTime

Date createTime

创建时间

replyMode

AutoreplyMode replyMode

回复模式

See Also:

AutoreplyMode

keywordList

List<E> keywordList

匹配的关键词列表

See Also:

AutoReplySetting.Entry

replyList

List<E> replyList

回复的信息列表

See Also:

AutoReplySetting.Entry

Class com.foxinmy.weixin4j.mp.model.ComponentAuthInfo extends Object implements Serializable

serialVersionUID: -3610172415045923599L

Serialized Fields

appId

String appId

授权方appId

nickName

String nickName

授权方昵称

headImg

String headImg

授权方头像

serviceType

int serviceType

授权方公众号类型，0代表订阅号，1代表由历史老帐号升级后的订阅号，2代表服务号

verifyType

int verifyType

授权方认证类型，-1代表未认证，0代表微信认证，1代表新浪微博认证，2代表腾讯微博认证，3代表已资质认证通过但还未通过名称认证，4 代表已资质认证通过、还未通过名称认证，但通过了新浪微博认证，5代表已资质认证通过、还未通过名称认证，但通过了腾讯微博认证

userName

String userName

授权方公众号的原始ID

alias

String alias

授权方公众号所设置的微信号，可能为空

qrcodeUrl

String qrcodeUrl

二维码图片的URL，开发者最好自行也进行保存

businessInfo

ComponentAuthInfo.BusinessInfo businessInfo

公众号功能的开通状况

privileges

List<E> privileges

公众号授权给开发者的权限集列表，ID为1到15时分别代表： 消息管理权限 用户管理权限 帐号服务权限 网页服务权限 微信小店权限 微信多客服权限 群发与通知权限 微信卡券权限 微信扫一扫权限 微信连WIFI权限 素材管理权限 微信摇周边权限 微信门店权限 微信支付权限 自定义菜单权限

Class com.foxinmy.weixin4j.mp.model.ComponentAuthInfo.BusinessInfo extends Object implements Serializable

serialVersionUID: 3106626182191149662L

Serialized Fields

openStore

boolean openStore

是否开通微信门店功能

openScan

boolean openScan

是否开通微信扫商品功能

openPay

boolean openPay

是否开通微信支付功能

openCard

boolean openCard

是否开通微信卡券功能

openShake

boolean openShake

是否开通微信摇一摇功能

Class com.foxinmy.weixin4j.mp.model.Following extends Object implements Serializable

serialVersionUID: 1917454368271027134L

Serialized Fields

total

int total

关注总数

count

int count

拉取的OPENID个数，最大值为10000

openIds

List<E> openIds

列表数据，OPENID的列表

nextOpenId

String nextOpenId

拉取列表的后一个用户的OPENID

userList

List<E> userList

用户详情列表

See Also:

User

Class com.foxinmy.weixin4j.mp.model.Group extends Object implements Serializable

serialVersionUID: 6979565973974005954L

Serialized Fields

id

int id

分组id，由微信分配

name

String name

分组名

count

int count

分组内用户数量

Class com.foxinmy.weixin4j.mp.model.KfAccount extends Object implements Serializable

serialVersionUID: -4565570894727129245L

Serialized Fields

id

String id

客服工号

account

String account

客服账号@微信别名 微信别名如有修改，旧账号返回旧的微信别名，新增的账号返回新的微信别名

nickName

String nickName

客服昵称

headimgurl

String headimgurl

客服头像

wx

String wx

客服微信

inviteWx

String inviteWx

客服绑定邀请的微信号

inviteExpireTime

long inviteExpireTime

客服邀请的过期时间

inviteStatus

String inviteStatus

客服邀请的状态

Class com.foxinmy.weixin4j.mp.model.KfChatRecord extends Object implements Serializable

serialVersionUID: -4024147769411601325L

Serialized Fields

worker

String worker

客服账号

openId

String openId

用户的标识

operCode

int operCode

操作ID（会话状态）

time

long time

操作时间

text

String text

聊天记录

Class com.foxinmy.weixin4j.mp.model.KfOnlineAccount extends Object implements Serializable

serialVersionUID: -4565570894727129245L

Serialized Fields

id

String id

客服工号

account

String account

客服账号@微信别名 微信别名如有修改，旧账号返回旧的微信别名，新增的账号返回新的微信别名

status

int status

客服在线状态 1：pc在线，2：手机在线 若pc和手机同时在线则为 1+2=3

autoAccept

int autoAccept

客服设置的最大自动接入数

acceptedCase

int acceptedCase

客服当前正在接待的会话数

Class com.foxinmy.weixin4j.mp.model.KfSession extends Object implements Serializable

serialVersionUID: 7236468333492555458L

Serialized Fields

kfAccount

String kfAccount

客服账号

userOpenId

String userOpenId

用户ID

createTime

Date createTime

创建时间

latestTime

Date latestTime

最后一条消息的时间,在`获取未接入会话列表`接口中有值

Class com.foxinmy.weixin4j.mp.model.KfSession.KfSessionCounter extends Object implements Serializable

serialVersionUID: -2200434961546270829L

Serialized Fields

count

int count

kfSessions

List<E> kfSessions

Class com.foxinmy.weixin4j.mp.model.Menu extends Object implements Serializable

serialVersionUID: -915139819768888593L

Serialized Fields

menuId

String menuId

buttons

List<E> buttons

matchRule

MenuMatchRule matchRule

Class com.foxinmy.weixin4j.mp.model.MenuMatchRule extends Object implements Serializable

serialVersionUID: 8115117407710728580L

Serialized Fields

matchRule

com.alibaba.fastjson.JSONObject matchRule

groupId

Integer groupId

用户分组id，可通过用户分组管理接口获取

gender

Gender gender

性别

platformType

ClientPlatformType platformType

客户端版本

country

String country

province

String province

city

String city

language

Lang language

语言信息，是用户在微信中设置的语言

Class com.foxinmy.weixin4j.mp.model.MenuSetting extends Object implements Serializable

serialVersionUID: 2461505572495855830L

Serialized Fields

isMenuOpen

boolean isMenuOpen

菜单是否开启

buttons

List<E> buttons

菜单列表

Class com.foxinmy.weixin4j.mp.model.OauthToken extends Token implements Serializable

serialVersionUID: 1L

Serialized Fields

openId

String openId

用户的openid

unionId

String unionId

只有在用户将公众号绑定到微信开放平台帐号后，才会出现该字段

refreshToken

String refreshToken

刷新token时的凭证

scope

String scope

Class com.foxinmy.weixin4j.mp.model.SemQuery extends Object implements Serializable

serialVersionUID: 679548284525912436L

Serialized Fields

jsonObj

com.alibaba.fastjson.JSONObject jsonObj

Class com.foxinmy.weixin4j.mp.model.SemResult extends ApiResult implements Serializable

serialVersionUID: 9051214458161068387L

Serialized Fields

query

String query

用户的输入字符串

type

String type

服务的全局类型id，详见协议文档中垂直服务协议定义

semantic

com.alibaba.fastjson.JSONObject semantic

语义理解后的结构化标识，各服务不同

result

com.alibaba.fastjson.JSONArray result

部分类别的结果

answer

String answer

部分类别的结果html5展示，目前不支持

text

String text

特殊回复说明

Class com.foxinmy.weixin4j.mp.model.Tag extends Object implements Serializable

serialVersionUID: 5204620476267654921L

Serialized Fields

id

int id

标签ID

name

String name

标签名称

count

int count

人员数量

Class com.foxinmy.weixin4j.mp.model.TemplateMessageInfo extends Object implements Serializable

serialVersionUID: 2130414666704670905L

Serialized Fields

templateId

String templateId

模板ID

title

String title

模板标题

primaryIndustry

String primaryIndustry

模板所属行业的一级行业

secondaryIndustry

String secondaryIndustry

模板所属行业的二级行业

content

String content

模板内容

example

String example

模板示例

Class com.foxinmy.weixin4j.mp.model.User extends Object implements Serializable

serialVersionUID: 1638176217299286265L

Serialized Fields

openId

String openId

用户的唯一标识

nickName

String nickName

用户昵称

gender

int gender

用户的性别，值为1时是男性，值为2时是女性，值为0时是未知

province

String province

用户个人资料填写的省份

city

String city

普通用户个人资料填写的城市

country

String country

国家，如中国为CN

headimgurl

String headimgurl

用户头像，最后一个数值代表正方形头像大小（有0、46、64、96、132数值可选，0代表640*640正方形头像），用户没有头像时该项为空

privilege

com.alibaba.fastjson.JSONArray privilege

用户特权信息，json 数组，如微信沃卡用户为（chinaunicom）

isSubscribe

boolean isSubscribe

用户是否订阅该公众号标识，值为0时，代表此用户没有关注该公众号，拉取不到其余信息。

subscribeTime

long subscribeTime

关注时间

language

String language

使用语言

unionId

String unionId

只有在用户将公众号绑定到微信开放平台帐号后，才会出现该字段

remark

String remark

公众号运营者对粉丝的备注，公众号运营者可在微信公众平台用户管理界面对粉丝添加备注

groupId

int groupId

用户所在的分组ID

tagIds

List<E> tagIds

用户被打上的标签ID列表

Class com.foxinmy.weixin4j.mp.model.WeixinMpAccount extends WeixinAccount implements Serializable

serialVersionUID: 3689999353867189585L

Serialized Fields

components

List<E> components

多个应用组件信息

Package com.foxinmy.weixin4j.mp.oldpayment

Class com.foxinmy.weixin4j.mp.oldpayment.ApiResultV2 extends Object implements Serializable

serialVersionUID: -2876899595643466203L

Serialized Fields

retCode

Integer retCode

是查询结果状态码,0 表明成功,其他表明错误;

retMsg

String retMsg

是查询结果出错信息;

inputCharset

String inputCharset

是返回信息中的编码方式;

partner

String partner

是财付通商户号,即前文的 partnerid;

signKeyIndex

Integer signKeyIndex

多密钥支持的密钥序号,默认 1

sign

String sign

签名 调用者无需关注

signType

String signType

签名类型,取值:MD5、RSA

Class com.foxinmy.weixin4j.mp.oldpayment.NativePayNotifyV2 extends JsPayNotify implements Serializable

serialVersionUID: 1868431159301749988L

Serialized Fields

productId

String productId

产品ID 可视为订单ID

Class com.foxinmy.weixin4j.mp.oldpayment.NativePayResponseV2 extends PayRequest implements Serializable

serialVersionUID: 6119895998783333012L

Serialized Fields

retCode

String retCode

返回码

retMsg

String retMsg

返回消息

Class com.foxinmy.weixin4j.mp.oldpayment.OrderV2 extends ApiResultV2 implements Serializable

serialVersionUID: 4543552984506609920L

Serialized Fields

tradeState

int tradeState

是订单状态,0 为成功,其他为失败;

tradeMode

int tradeMode

是交易模式,1 为即时到帐,其他保留;

bankType

String bankType

是银行类型;

bankBillno

String bankBillno

是银行订单号;

totalFee

int totalFee

是总金额,单位为分;

feeType

int feeType

是币种,1 为人民币;

transactionId

String transactionId

是财付通订单号;

outTradeNo

String outTradeNo

是第三方订单号;

isSplit

boolean isSplit

表明是否分账,false 为无分账,true 为有分账;

isRefund

boolean isRefund

表明是否退款,false 为无退款,ture 为退款;

attach

String attach

attach 是商户数据包,即生成订单package 时商户填入的 attach;

timeEnd

String timeEnd

支付完成时间;

transportFee

int transportFee

物流费用,单位为分;

productFee

int productFee

物品费用,单位为分;

discount

int discount

折扣价格,单位为分;

rmbTotalFee

Integer rmbTotalFee

换算成人民币之后的总金额,单位为分,一般看 total_fee 即可。

Class com.foxinmy.weixin4j.mp.oldpayment.PayFeedback extends PayBaseInfo implements Serializable

serialVersionUID: 7230049346213966310L

Serialized Fields

feedbackId

String feedbackId

投诉单号

openId

String openId

用户ID

transId

String transId

订单交易单号

reason

String reason

投诉原因

solution

String solution

用户希望解决方案

extInfo

String extInfo

备注信息+电话

picInfo

String picInfo

用户上传的图片凭证,最多五张

status

String status

通知类型 request 用户提交投诉 confirm 用户确认消除 投诉 reject 用户拒绝消除投诉

Class com.foxinmy.weixin4j.mp.oldpayment.PayPackageV2 extends PayPackage implements Serializable

serialVersionUID: 5557542103637795834L

Serialized Fields

bankType

String bankType

银行通道类型 固定为"WX" 非空

partner

String partner

商户号 注册时分配的财付通商户号 非空

feeType

String feeType

支付币种 默认值是"1" 非空

transportFee

Integer transportFee

物流费用 可为空 如果有值,必须保 证 transport_fee + product_fee=total_fee

productFee

Integer productFee

商品费用 可为空 商品费用,单位为分。如果有值,必须保 证 transport_fee +product_fee=total_fee;

inputCharset

String inputCharset

传入参数字符编码 取值范围:"GBK"、"UTF-8",默认:"GBK" 可为空

Class com.foxinmy.weixin4j.mp.oldpayment.PayWarn extends PayBaseInfo implements Serializable

serialVersionUID: 2334592957844332640L

Serialized Fields

errortype

String errortype

错误代号 1001=发货超时

description

String description

错误描述

alarmcontent

String alarmcontent

错误详情

Class com.foxinmy.weixin4j.mp.oldpayment.RefundDetailV2 extends ApiResultV2 implements Serializable

serialVersionUID: -3687863914168618620L

Serialized Fields

outRefundNo

String outRefundNo

商户退款单号

refundId

String refundId

微信退款单号

refundChannel

int refundChannel

退款渠道 0:退到财付通、1:退到银行;

refundFee

int refundFee

退款总金额,单位为分,可以做部分退款

refundStatus

int refundStatus

退款状态

recvUserId

String recvUserId

转账退款接收退款的财付通帐号

reccvUserName

String reccvUserName

转账退款接收退款的姓名(需与接收退款的财付通帐号绑定的姓名一致)

Class com.foxinmy.weixin4j.mp.oldpayment.RefundRecordV2 extends ApiResultV2 implements Serializable

serialVersionUID: -2971132874939642721L

Serialized Fields

transactionId

String transactionId

微信订单号

outTradeNo

String outTradeNo

商户订单号

refundCount

int refundCount

退款笔数

refundList

List<E> refundList

退款详情

Class com.foxinmy.weixin4j.mp.oldpayment.RefundResultV2 extends RefundDetailV2 implements Serializable

serialVersionUID: -3687863914168618620L

Serialized Fields

transactionId

String transactionId

微信订单号

outTradeNo

String outTradeNo

商户系统内部的订单号

Class com.foxinmy.weixin4j.mp.oldpayment.WeixinOldPayAccount extends WeixinAccount implements Serializable

serialVersionUID: -2791256176906048632L

Serialized Fields

paySignKey

String paySignKey

公众号支付请求中用于加密的密钥 Key,可验证商户唯一身份,PaySignKey 对应于支付场景中的 appKey 值

partnerId

String partnerId

财付通商户身份的标识

partnerKey

String partnerKey

财付通商户权限密钥Key