类 com.jfinal.weixin.sdk.api.ApiResult的使用 (jfinal-weixin 1.8 API)

使用ApiResult的程序包
程序包说明

com.jfinal.weixin.sdk.api

com.jfinal.weixin.sdk.api.shakearound

使用ApiResult的程序包
程序包	说明
com.jfinal.weixin.sdk.api
com.jfinal.weixin.sdk.api.shakearound

com.jfinal.weixin.sdk.api中ApiResult的使用

返回ApiResult的com.jfinal.weixin.sdk.api中的方法
限定符和类型	方法和说明
`static ApiResult`	MenuApi.`addConditional(String jsonStr)` 创建个性化菜单
`static ApiResult`	CustomServiceApi.`addKfAccount(String kf_account, String nickname, String password)` 添加客服帐号
`static ApiResult`	MediaApi.`addMaterial(File file)` 新增其他类型永久素材
`static ApiResult`	MediaApi.`addMaterial(File file, String title, String introduction)` 新增视频永久素材素材的格式大小等要求与公众平台官网一致。
`static ApiResult`	MediaApi.`addNews(List<MediaArticles> mediaArticles)` 新增永久图文素材
`static ApiResult`	TagApi.`batchAddTag(int tagId, List<String> openIdList)` 批量为用户打标签
`static ApiResult`	TagApi.`batchDelTag(int tagId, List<String> openIdList)` 批量为用户取消标签
`static ApiResult`	MediaApi.`batchGetMaterial(MediaApi.MediaType mediaType, int offset, int count)` 获取素材列表
`static ApiResult`	UserApi.`batchGetUserInfo(List<String> openIdList)` 批量获取用户基本信息
`static ApiResult`	UserApi.`batchGetUserInfo(String jsonStr)` 批量获取用户基本信息, by Unas
`static ApiResult`	TagApi.`create(String name)`
`static ApiResult`	QrcodeApi.`create(String jsonStr)`
`static ApiResult`	GroupsApi.`create(String name)` 创建分组，一个公众账号，最多支持创建100个分组。
`static ApiResult`	CardApi.`create(String jsonStr)` 创建会员卡接口
`static ApiResult`	ApiResult.`create(String jsonStr)` 通过 json 创建 ApiResult 对象，等价于 new ApiResult(jsonStr)
`static ApiResult`	MenuApi.`createMenu(String jsonStr)` 创建自定义菜单
`static ApiResult`	QrcodeApi.`createPermanent(int sceneId)` 创建永久二维码
`static ApiResult`	QrcodeApi.`createPermanent(String sceneStr)` 创建永久二维码
`static ApiResult`	QrcodeApi.`createTemporary(int expireSeconds, int sceneId)` 创建临时二维码
`static ApiResult`	MenuApi.`delConditional(String menuid)` 删除个性化菜单
`static ApiResult`	TagApi.`delete(int id)` 删除标签
`static ApiResult`	GroupsApi.`delete(int id)` 删除分组
`static ApiResult`	MessageApi.`delete(String msgId)` 删除群发【订阅号与服务号认证后均可用】由于技术限制，群发只有在刚发出的半小时内可以删除，发出半小时之后将无法被删除。
`static ApiResult`	MenuApi.`deleteMenu()` 自定义菜单删除接口
`static ApiResult`	CustomServiceApi.`delKfAccount(String kf_account)` 删除客服帐号
`static ApiResult`	MediaApi.`delMaterial(String media_id)` 删除永久素材
`static ApiResult`	TagApi.`get()` 获取公众号已创建的标签
`static ApiResult`	GroupsApi.`get()` 查询所有分组
`static ApiResult`	MessageApi.`get(String msgId)` 查询群发消息发送状态【订阅号与服务号认证后均可用】
`static ApiResult`	DatacubeApi.`getArticleSummary(String begin_date, String end_date)` 获取图文群发每日数据，最大跨度1天
`static ApiResult`	DatacubeApi.`getArticlEtotal(String begin_date, String end_date)` 获取图文群发总数据，最大跨度1天
`static ApiResult`	CallbackIpApi.`getCallbackIp()` 获取微信服务器IP地址
`static ApiResult`	AutoReplyInfoApi.`getCurrent()`
`static ApiResult`	MenuApi.`getCurrentSelfMenuInfo()` 获取自定义菜单配置接口
`static ApiResult`	UserApi.`getFollowers(String nextOpenid)` 获取用户列表
`static ApiResult`	UserApi.`getFollows()` 获取用户列表
`static ApiResult`	GroupsApi.`getId(String openid)` 通过用户的OpenID查询其所在的GroupID
`static ApiResult`	DatacubeApi.`getInterFaceSummary(String begin_date, String end_date)` 获取接口分析数据，最大跨度30天
`static ApiResult`	DatacubeApi.`getInterFaceSummaryHour(String begin_date, String end_date)` 获取接口分析分时数据，最大跨度1天
`static ApiResult`	CustomServiceApi.`getKfList()` 获取所有客服账号
`static ApiResult`	MediaApi.`getMaterialCount()` 获取素材总数
`static ApiResult`	MenuApi.`getMenu()` 查询自定义菜单
`static ApiResult`	CustomServiceApi.`getOnlineKFList()` 获取在线客服接待信息
`static ApiResult`	CustomServiceApi.`getRecord(int pageindex, int pagesize, long starttime, long endtime)` 获取客服聊天记录
`static ApiResult`	CustomServiceApi.`getRecord(String jsonStr)` 获取客服聊天记录
`static ApiResult`	ShorturlApi.`getShorturl(String jsonStr)`
`static ApiResult`	ShorturlApi.`getShortUrl(String longUrl)` 长链接转短链接接口
`static ApiResult`	DatacubeApi.`getUpStreamMsg(String begin_date, String end_date)` 获取消息发送概况数据，最大跨度7天
`static ApiResult`	DatacubeApi.`getUpStreamMsgDist(String begin_date, String end_date)` 获取消息发送分布数据，最大跨度15天
`static ApiResult`	DatacubeApi.`getUpStreamMsgDistMonth(String begin_date, String end_date)` 获取消息发送分布月数据，最大跨度30天
`static ApiResult`	DatacubeApi.`getUpStreamMsgDistWeek(String begin_date, String end_date)` 获取消息发送分布周数据，最大跨度30天
`static ApiResult`	DatacubeApi.`getUpStreamMsgHour(String begin_date, String end_date)` 获取消息分送分时数据，最大跨度1天
`static ApiResult`	DatacubeApi.`getUpStreamMsgMonth(String begin_date, String end_date)` 获取消息发送月数据，最大跨度30天
`static ApiResult`	DatacubeApi.`getUpStreamMsgWeekMsg(String begin_date, String end_date)` 获取消息发送周数据，最大跨度30天
`static ApiResult`	TagApi.`getUser(int tagId)` 根据标签获取标签下粉丝列表
`static ApiResult`	TagApi.`getUser(int tagId, String nextOpenId)` 根据标签获取标签下粉丝列表
`static ApiResult`	TagApi.`getUser(String openId)` 获取用户身上的标签列表
`static ApiResult`	DatacubeApi.`getUserCumulate(String begin_date, String end_date)` 用户分析数据接口，最大时间跨度：7天
`static ApiResult`	UserApi.`getUserInfo(String openId)` 获取用户基本信息（包括UnionID机制）
`static ApiResult`	SnsApi.`getUserInfo(String accessToken, String openId)` 获取用户个人信
`static ApiResult`	DatacubeApi.`getUserRead(String begin_date, String end_date)` 获取图文统计数据，最大跨度3天
`static ApiResult`	DatacubeApi.`getUserReadHour(String begin_date, String end_date)` 获取图文统计分时数据，最大跨度1天
`static ApiResult`	DatacubeApi.`getUserShare(String begin_date, String end_date)` 获取图文分享转发数据，最大跨度7天
`static ApiResult`	DatacubeApi.`getUserShareHour(String begin_date, String end_date)` 获取图文分享转发分时数据，最大跨度1天
`static ApiResult`	DatacubeApi.`getUserSummary(String begin_date, String end_date)` 用户分析数据接口，最大时间跨度：7天
`static ApiResult`	GroupsApi.`membersBatchUpdate(List<String> openidList, int to_groupid)` 批量移动用户分组
`static ApiResult`	GroupsApi.`membersUpdate(String openid, int to_groupid)` 移动用户分组
`static ApiResult`	MessageApi.`preview(String jsonStr)` 预览接口【订阅号与服务号认证后均可用】
`static ApiResult`	SemanticApi.`search(String jsonStr)` 发送语义理解请求
`static ApiResult`	TemplateMsgApi.`send(String jsonStr)` 发送模板消息
`static ApiResult`	MessageApi.`send(String jsonStr)` 根据OpenID列表群发【订阅号不可用，服务号认证后可用】
`static ApiResult`	MessageApi.`sendAll(String jsonStr)` 根据分组进行群发【订阅号与服务号认证后均可用】
`static ApiResult`	CustomServiceApi.`sendCoupon(String openId, String card_id, String card_ext)` 发送卡券
`static ApiResult`	CustomServiceApi.`sendImage(String openId, String media_id)` 发送图片消息
`static ApiResult`	CustomServiceApi.`sendMpNews(String openId, String mediaId)` 发送图文消息（点击跳转到图文消息页面），图文消息条数限制在8条以内
`static ApiResult`	CustomServiceApi.`sendMusic(String openId, String musicurl, String hqmusicurl, String thumb_media_id, String title, String description)` 发送音乐回复
`static ApiResult`	CustomServiceApi.`sendNews(String openId, List<CustomServiceApi.Articles> articles)` 发送图文回复，图文消息条数限制在8条以内
`static ApiResult`	CustomServiceApi.`sendText(String openId, String text)` 发送文本客服消息
`static ApiResult`	CustomServiceApi.`sendVideo(String openId, String media_id, String title, String description)` 发送视频回复
`static ApiResult`	CustomServiceApi.`sendVoice(String openId, String media_id)` 发送语言回复
`static ApiResult`	MenuApi.`tryMatch(String userId)` 测试个性化菜单匹配结果
`static ApiResult`	TagApi.`update(int id, String name)` 编辑标签
`static ApiResult`	GroupsApi.`update(int id, String name)` 修改分组名
`static ApiResult`	CustomServiceApi.`updateKfAccount(String kf_account, String nickname, String password)` 修改客服帐号
`static ApiResult`	MediaApi.`updateNews(String media_id, int index, MediaArticles mediaArticles)` 修改永久图文素材
`static ApiResult`	UserApi.`updateRemark(String openid, String remark)` 设置备注名
`static ApiResult`	MediaApi.`uploadImg(File imgFile)` 上传图文消息内的图片获取URL 请注意，本接口所上传的图片不占用公众号的素材库中图片数量的5000个的限制。
`static ApiResult`	CustomServiceApi.`uploadKfAccountHeadImg(String kf_account, File headImg)` 设置客服帐号的头像
`static ApiResult`	MediaApi.`uploadMedia(MediaApi.MediaType mediaType, File file)` 上传临时素材
`static ApiResult`	MediaApi.`uploadVideo(String mediaId, String title, String description)` 视频群发的消息素材上传

com.jfinal.weixin.sdk.api.shakearound中ApiResult的使用

返回ApiResult的com.jfinal.weixin.sdk.api.shakearound中的方法
限定符和类型	方法和说明
`static ApiResult`	ShakeAroundDeviceApi.`addDeviceToGroup(int groupId, List<DeviceIdentifier> deviceIdentifierList)` 添加设备到分组，每个分组能够持有的设备上限为10000，并且每次添加操作的添加上限为1000。
`static ApiResult`	ShakeAroundDeviceApi.`addGroup(String groupName)` 新建设备分组，每个帐号下最多只有1000个分组。
`static ApiResult`	ShakeAroundMaterialApi.`addMaterial(File file)` 上传在摇一摇功能中需使用到的图片素材，素材保存在微信侧服务器上。
`static ApiResult`	ShakeAroundMaterialApi.`addMaterial(File file, ShakeAroundMaterialApi.MaterialType materialType)` 上传在摇一摇功能中需使用到的图片素材，素材保存在微信侧服务器上。
`static ApiResult`	ShakeAroundPageApi.`addPage(String title, String pageUrl, String description, String iconUrl)` 新增摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。
`static ApiResult`	ShakeAroundPageApi.`addPage(String title, String pageUrl, String description, String comment, String iconUrl)` 新增摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。
`static ApiResult`	ShakeAroundDeviceApi.`applyId(int quantity, String applyReason, String comment, Integer poiId)` 申请配置设备所需的UUID、Major、Minor。
`static ApiResult`	ShakeAroundDeviceApi.`bindLocation(DeviceIdentifier deviceIdentifier, String poiId)` 配置设备与门店的关联关系支持创建门店后直接关联在设备上，无需为审核通过状态，摇周边后台自动更新门店的最新信息和状态。
`static ApiResult`	ShakeAroundDeviceApi.`bindPage(DeviceIdentifier deviceIdentifier, int... pageIds)` 配置设备与页面的关联关系。
`static ApiResult`	ShakeAroundDeviceApi.`deleteDeviceFromGroup(int groupId, List<DeviceIdentifier> deviceIdentifierList)` 从分组中移除设备，每次删除操作的上限为1000。
`static ApiResult`	ShakeAroundDeviceApi.`deleteGroup(int groupId)` 删除设备分组，若分组中还存在设备，则不能删除成功。
`static ApiResult`	ShakeAroundPageApi.`deletePage(int pageId)` 删除已有的页面，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。
`static ApiResult`	ShakeAroundDeviceApi.`getApplyStatus(int applyId)` 查询设备ID申请的审核状态。
`static ApiResult`	ShakeAroundAccountApi.`getAuditStatus()` 查询已经提交的开通摇一摇周边功能申请的审核状态。
`static ApiResult`	ShakeAroundStatisticsApi.`getByDevice(DeviceIdentifier deviceIdentifier, Date beginDate, Date endDate)` 以设备为维度的数据统计接口
`static ApiResult`	ShakeAroundStatisticsApi.`getByPage(int pageId, Date beginDate, Date endDate)` 以页面为维度的数据统计接口
`static ApiResult`	ShakeAroundStatisticsApi.`getDeviceList(Date date, int pageIndex)` 批量查询设备统计数据接口查询指定时间商家帐号下的每个设备进行摇周边操作的人数、次数，点击摇周边消息的人数、次数。
`static ApiResult`	ShakeAroundDeviceApi.`getGroupDetail(int groupId, int begin, int count)` 查询分组详情，包括分组名，分组id，分组里的设备列表。
`static ApiResult`	ShakeAroundDeviceApi.`getGroupList(int begin, int count)` 查询账号下所有的分组。
`static ApiResult`	ShakeAroundStatisticsApi.`getPageList(Date date, int pageIndex)` 批量查询设备统计数据接口查询指定时间商家帐号下的每个设备进行摇周边操作的人数、次数，点击摇周边消息的人数、次数。
`static ApiResult`	ShakeAroundUserApi.`getShakeInfo(String ticket)` 获取设备信息，包括UUID、major、minor，以及距离、openID等信息。
`static ApiResult`	ShakeAroundUserApi.`getShakeInfo(String ticket, boolean needPoi)` 获取设备信息，包括UUID、major、minor，以及距离、openID等信息。
`static ApiResult`	ShakeAroundAccountApi.`register(String name, String phoneNumber, String email, String industryId, String applyReason, String... qualificationCertUrls)` 申请开通摇一摇周边功能。
`static ApiResult`	ShakeAroundDeviceApi.`searchByDevice(DeviceIdentifier deviceIdentifier)` 查询设备列表
`static ApiResult`	ShakeAroundPageApi.`searchByIds(int... pageIds)` 查询已有的页面，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。
`static ApiResult`	ShakeAroundPageApi.`searchPage(int begin, int count)` 查询已有的页面，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。
`static ApiResult`	ShakeAroundDeviceApi.`searchPage(int begin, int count)` 需要分页查询或者指定范围内的设备时
`static ApiResult`	ShakeAroundDeviceApi.`searchPage(int applyId, int begin, int count)` 根据批次id查找
`static ApiResult`	ShakeAroundDeviceApi.`searchRelation(DeviceIdentifier deviceIdentifier, int type)` 查询设备与页面的关联关系。
`static ApiResult`	ShakeAroundDeviceApi.`updateDeviceInfo(DeviceIdentifier deviceIdentifier, String comment)` 编辑设备的备注信息。
`static ApiResult`	ShakeAroundDeviceApi.`updateGroup(int groupId, String groupName)` 编辑设备分组信息，目前只能修改分组名。
`static ApiResult`	ShakeAroundPageApi.`updatePage(int pageId, String title, String pageUrl, String description, String iconUrl)` 新增摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。
`static ApiResult`	ShakeAroundPageApi.`updatePage(int pageId, String title, String pageUrl, String description, String comment, String iconUrl)` 新增摇一摇出来的页面信息，包括在摇一摇页面出现的主标题、副标题、图片和点击进去的超链接。