Package com.foxinmy.weixin4j.mp.api

Class HelperApi

  • public class HelperApi
extends MpApi
    辅助相关API
    Since:
    JDK 1.6
    Author:
    jinyu(foxinmy@gmail.com)

    • Field Summary

      • Fields inherited from class com.foxinmy.weixin4j.api.BaseApi

        weixinExecutor

    • Constructor Summary

      Constructors 
      Constructor Description
      HelperApi​(com.foxinmy.weixin4j.token.TokenManager tokenManager)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.foxinmy.weixin4j.http.weixin.ApiResult clearQuota​(String appId)
      接口调用次数调用清零：公众号调用接口并不是无限制的。为了防止公众号的程序错误而引发微信服务器负载异常，默认情况下， 每个公众号调用接口都不能超过一定限制 ，当超过一定限制时，调用对应接口会收到{"errcode":45009,"errmsg":"api freq out of limit" }错误返回码。
      AutoReplySetting getAutoReplySetting()
      获取公众号当前使用的自动回复规则，包括关注后自动回复、消息自动回复（60分钟内触发一次）、关键词自动回复。
      MenuSetting getMenuSetting()
      获取公众号当前使用的自定义菜单的配置，如果公众号是通过API调用设置的菜单，则返回菜单的开发配置， 而如果公众号是在公众平台官网通过网站功能发布菜单，则本接口返回运营者设置的菜单配置。
      String getShorturl​(String url)
      长链接转短链接
      List<String> getWechatServerIp()
      获取微信服务器IP地址
      SemResult semantic​(SemQuery semQuery)
      语义理解

      • Methods inherited from class com.foxinmy.weixin4j.api.BaseApi

        getRequestUri

    • Constructor Detail

      • HelperApi

        public HelperApi​(com.foxinmy.weixin4j.token.TokenManager tokenManager)

    • Method Detail

      • getShorturl

        public String getShorturl​(String url)
                   throws com.foxinmy.weixin4j.exception.WeixinException
        长链接转短链接
        Parameters:
        url - 待转换的链接
        Returns:
        短链接
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        长链接转短链接

      • semantic

        public SemResult semantic​(SemQuery semQuery)
                   throws com.foxinmy.weixin4j.exception.WeixinException
        语义理解
        Parameters:
        semQuery - 语义理解协议
        Returns:
        语义理解结果
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        SemQuery, SemResult, 语义理解

      • getWechatServerIp

        public List<String> getWechatServerIp()
                               throws com.foxinmy.weixin4j.exception.WeixinException
        获取微信服务器IP地址
        Returns:
        IP地址
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        获取IP地址

      • getMenuSetting

        public MenuSetting getMenuSetting()
                           throws com.foxinmy.weixin4j.exception.WeixinException
        获取公众号当前使用的自定义菜单的配置，如果公众号是通过API调用设置的菜单，则返回菜单的开发配置， 而如果公众号是在公众平台官网通过网站功能发布菜单，则本接口返回运营者设置的菜单配置。
        Returns:
        菜单配置信息
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        获取自定义菜单配置, Button, MenuSetting, MpArticle

      • getAutoReplySetting

        public AutoReplySetting getAutoReplySetting()
                                     throws com.foxinmy.weixin4j.exception.WeixinException
        获取公众号当前使用的自动回复规则，包括关注后自动回复、消息自动回复（60分钟内触发一次）、关键词自动回复。
        Returns:
        自定义回复配置信息
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        AutoReplySetting, 获取自动回复规则

      • clearQuota

        public com.foxinmy.weixin4j.http.weixin.ApiResult clearQuota​(String appId)
                                                      throws com.foxinmy.weixin4j.exception.WeixinException
        接口调用次数调用清零：公众号调用接口并不是无限制的。为了防止公众号的程序错误而引发微信服务器负载异常，默认情况下， 每个公众号调用接口都不能超过一定限制 ，当超过一定限制时，调用对应接口会收到{"errcode":45009,"errmsg":"api freq out of limit" }错误返回码。
        Parameters:
        appId - 公众号ID
        Returns:
        操作结果
        Throws:
        com.foxinmy.weixin4j.exception.WeixinException
        See Also:
        接口清零