WxMpGuideServiceImpl (WxJava - MP Java SDK 4.7.0 API)

java.lang.Object
- me.chanjar.weixin.mp.api.impl.WxMpGuideServiceImpl

所有已实现的接口:

WxMpGuideService
```
public class WxMpGuideServiceImpl
extends Object
implements WxMpGuideService
```
.

作者:

Binary Wang created on 2020-10-06

构造器概要

构造器
构造器和说明

WxMpGuideServiceImpl()

构造器
构造器和说明
`WxMpGuideServiceImpl()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addGuide(String account, String openid, String headImgUrl, String nickName)` 为服务号添加顾问请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/addguideacct?
`void`	`addGuide(WxMpGuideInfo guideInfo)` 为服务号添加顾问请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/addguideacct?
`void`	`addGuide2GuideGroup(long groupId, String account)` 分组内添加顾问请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/addguide2guidegroup?
`String`	`createGuideQrCode(String account, String openid, String qrcodeInfo)` 生成顾问二维码生成顾问二维码后，微信用户扫码直接跳转公众号首页。
`void`	`delGuide(String account, String openid)` 删除顾问请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/delguideacct?
`void`	`delGuide2GuideGroup(long groupId, String account)` 分组内删除顾问请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/delguide2guidegroup?
`void`	`delGuideGroup(long groupId)` 删除指定顾问分组请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/delguidegroup?
`List<Long>`	`getGroupByGuide(String account)` 获取顾问所在分组请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getgroupbyguide?
`WxMpGuideGroupInfoList`	`getGroupInfo(long groupId, int page, int num)` 获取指定顾问分组内顾问信息请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getgroupinfo?
`WxMpGuideInfo`	`getGuide(String account, String openid)` 获取顾问信息请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getguideacct?
`WxMpGuideAcctConfig`	`getGuideAcctConfig()` 获取离线自动回复与敏感词请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getguideacctconfig?
`WxMpGuideMsgList`	`getGuideChatRecord(String account, String openid, String clientOpenid, Long beginTime, Long endTime, int page, int num)` 获取顾问聊天记录支持拉取该顾问近 30 天的聊天记录。
`WxMpGuideConfig`	`getGuideConfig(String account, String openid)` 获取快捷回复与关注自动回复如果要获取服务号维度的新客户关注自动回复，不填guide_account与guide_openid即可请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getguideconfig?
`List<WxMpGuideGroup>`	`getGuideGroupList()` 获取服务号下所有顾问分组的列表请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getguidegrouplist?
`WxMpGuideList`	`listGuide(int page, int num)` 获取服务号顾问列表请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getguideacctlist?
`Long`	`newGuideGroup(String groupName)` 新建顾问分组请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/newguidegroup?
`void`	`pushShowWxaPathMenu(String appId, String userName)` 允许微信用户复制小程序页面路径请求成功后，该微信号用户可在微信上复制对应小程序的任意页面path，有效期为60天。
`void`	`setGuideAcctConfig(boolean isDelete, List<String> blackKeyWord, String guideAutoReply)` 为服务号设置敏感词与离线自动回复顾问在小程序离线状态时，客户发消息会收到设置的离线自动回复，最多支持 300 字。
`void`	`setGuideConfig(String account, String openid, boolean isDelete, List<String> guideFastReplyList, WxMpAddGuideAutoReply guideAutoReply, WxMpAddGuideAutoReply guideAutoReplyPlus)` 设置快捷回复与关注自动回复快捷回复：指顾问在对话详情页，可快速选择的回复内容。
`void`	`updateGuide(WxMpGuideInfo guideInfo)` 修改顾问的昵称或头像请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/updateguideacct?

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - WxMpGuideServiceImpl
```
public WxMpGuideServiceImpl()
```
- 方法详细资料
  - addGuide
```
public void addGuide(String account,
                     String openid,
                     String headImgUrl,
                     String nickName)
              throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    为服务号添加顾问
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/addguideacct?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.addGuideAcct.html
 
```
    指定者:
    
    addGuide 在接口中 WxMpGuideService
    
    参数:
    
    account - 顾问微信号（guide_account和guide_openid二选一，若同时请求，默认为guide_account）
    
    openid - 顾问openid或者unionid（guide_account和guide_openid二选一）
    
    headImgUrl - 顾问头像，头像url只能用《上传图文消息内的图片获取URL》 me.chanjar.weixin.mp.api.impl.WxMpMaterialServiceImpl#mediaImgUpload(java.io.File)
    
    nickName - 顾问昵称
    
    抛出:
    
    WxErrorException - .
  - addGuide
```
public void addGuide(WxMpGuideInfo guideInfo)
              throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    为服务号添加顾问
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/addguideacct?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.addGuideAcct.html
 
```
    指定者:
    
    addGuide 在接口中 WxMpGuideService
    
    参数:
    
    guideInfo - 顾问信息
    
    抛出:
    
    WxErrorException - .
  - updateGuide
```
public void updateGuide(WxMpGuideInfo guideInfo)
                 throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    修改顾问的昵称或头像
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/updateguideacct?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.updateGuideAcct.html
 
```
    指定者:
    
    updateGuide 在接口中 WxMpGuideService
    
    参数:
    
    guideInfo - 顾问信息
    
    抛出:
    
    WxErrorException - .
  - getGuide
```
public WxMpGuideInfo getGuide(String account,
                              String openid)
                       throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    获取顾问信息
```
 请求地址：  POST https://api.weixin.qq.com/cgi-bin/guide/getguideacct?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.getGuideAcct.html
 
```
    指定者:
    
    getGuide 在接口中 WxMpGuideService
    
    参数:
    
    account - 顾问微信号（guide_account和guide_openid二选一，若同时请求，默认为guide_account）
    
    openid - 顾问openid或者unionid（guide_account和guide_openid二选一）
    
    返回:
    
    顾问信息 guide
    
    抛出:
    
    WxErrorException - .
  - delGuide
```
public void delGuide(String account,
                     String openid)
              throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    删除顾问
```
 请求地址：  POST https://api.weixin.qq.com/cgi-bin/guide/delguideacct?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.delGuideAcct.html
 
```
    指定者:
    
    delGuide 在接口中 WxMpGuideService
    
    参数:
    
    account - 顾问微信号（guide_account和guide_openid二选一，若同时请求，默认为guide_account）
    
    openid - 顾问openid或者unionid（guide_account和guide_openid二选一）
    
    抛出:
    
    WxErrorException - .
  - listGuide
```
public WxMpGuideList listGuide(int page,
                               int num)
                        throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    获取服务号顾问列表
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getguideacctlist?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.getGuideAcctList.html
 
```
    指定者:
    
    listGuide 在接口中 WxMpGuideService
    
    参数:
    
    page - 分页页数，从0开始
    
    num - 每页数量
    
    返回:
    
    顾问信息列表 wx mp guide list
    
    抛出:
    
    WxErrorException - .
  - createGuideQrCode
```
public String createGuideQrCode(String account,
                                String openid,
                                String qrcodeInfo)
                         throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    生成顾问二维码
    生成顾问二维码后，微信用户扫码直接跳转公众号首页。分为两种情况： 1.微信用户已经关注公众号，扫码后绑定该顾问。 2.微信用户未关注公众号，扫码后 3 分钟内关注该公众号，则绑定该顾问
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/guidecreateqrcode?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.guideCreateQrCode.html
 
```
    指定者:
    
    createGuideQrCode 在接口中 WxMpGuideService
    
    参数:
    
    account - 顾问微信号（guide_account和guide_openid二选一，若同时请求，默认为guide_account）
    
    openid - 顾问openid或者unionid（guide_account和guide_openid二选一）
    
    qrcodeInfo - 额外参数，用于事件推送
    
    返回:
    
    二维码下载链接 string
    
    抛出:
    
    WxErrorException - .
  - getGuideChatRecord
```
public WxMpGuideMsgList getGuideChatRecord(String account,
                                           String openid,
                                           String clientOpenid,
                                           Long beginTime,
                                           Long endTime,
                                           int page,
                                           int num)
                                    throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    获取顾问聊天记录
    支持拉取该顾问近 30 天的聊天记录。begin_time 与 end_time 同时非0情况下，该参数才会生效，否则为默认值。
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getguidebuyerchatrecord?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.getGuideBuyerChatRecord.html
 
```
    指定者:
    
    getGuideChatRecord 在接口中 WxMpGuideService
    
    参数:
    
    account - 顾问微信号（guide_account和guide_openid二选一，若同时请求，默认为guide_account）
    
    openid - 顾问openid或者unionid（guide_account和guide_openid二选一）
    
    clientOpenid - 客户openid 若不填，则拉取该顾问所有客户的聊天记录。若填写，则拉取顾问与某一个客户的聊天记录
    
    beginTime - 消息的起始UNIX时间戳，如果不填，默认当前时间的前30天(仅支持30天范围内的查询)
    
    endTime - 消息的截止UNIX时间戳，如果不填，默认当前时间。
    
    page - 分页页数，从0开始
    
    num - 每页数量
    
    返回:
    
    顾问聊天记录列表 guide chat record
    
    抛出:
    
    WxErrorException - the wx error exception
  - setGuideConfig
```
public void setGuideConfig(String account,
                           String openid,
                           boolean isDelete,
                           List<String> guideFastReplyList,
                           WxMpAddGuideAutoReply guideAutoReply,
                           WxMpAddGuideAutoReply guideAutoReplyPlus)
                    throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    设置快捷回复与关注自动回复
    快捷回复：指顾问在对话详情页，可快速选择的回复内容。注意：1.快捷回复只允许全部删除 2.快捷回复的添加删除需要指定顾问的guide_account和guide_openid二选一
    关注自动回复：是指客户通过扫顾问码、扫顾问分组码、微信广告三种方式主动关注公众号并绑定顾问，顾问会下发的自动回复，即顾问欢迎语。最多可下发两条消息，支持文字、图片或小程序素材，可更新、删除，设置好后先后下发。不指定 guide_account 和 guide_openid 时，可设置所有顾问默认的关注自动回复。对单个顾问来说，如果指定 guide_account 和 guide_openid 设置了自动回复，则下发它，否则下发所有顾问默认的关注自动回复注意：自动回复每次设置会覆盖原有的，自动回复只允许出现两条
    特别注意：删除需要传递 guideAutoReply:{"msgtype":"1"} 删除目前只支持两条全部删除 2021/5/8
    自动回复格式： String content: 新客户关注自动回复内容,图片填mediaid,获取方式同图片素材,小程序卡片填下面请求demo中字段的json格式 int msgtype: 1表示文字，2表示图片，3表示小程序卡片例如：JsonObject：{"content": "abc","msgtype":"1"}
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/setguideconfig?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.setGuideConfig.html
 
```
    指定者:
    
    setGuideConfig 在接口中 WxMpGuideService
    
    参数:
    
    account - 顾问微信号（guide_account和guide_openid二选一，若同时请求，默认为guide_account）
    
    openid - 顾问openid或者unionid（guide_account和guide_openid二选一）
    
    isDelete - 操作类型，false表示添加 true表示删除
    
    guideFastReplyList - 快捷回复列表
    
    guideAutoReply - 第一条新客户关注自动回复
    
    guideAutoReplyPlus - 第二条新客户关注自动回复
    
    抛出:
    
    WxErrorException - .
  - getGuideConfig
```
public WxMpGuideConfig getGuideConfig(String account,
                                      String openid)
                               throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    获取快捷回复与关注自动回复如果要获取服务号维度的新客户关注自动回复，不填guide_account与guide_openid即可
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getguideconfig?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.getGuideConfig.html
 
```
    指定者:
    
    getGuideConfig 在接口中 WxMpGuideService
    
    参数:
    
    account - 顾问微信号（guide_account和guide_openid二选一，若同时请求，默认为guide_account）
    
    openid - 顾问openid或者unionid（guide_account和guide_openid二选一）
    
    返回:
    
    顾问的快捷回复，关注顾问自动回复
    
    抛出:
    
    WxErrorException - the wx error exception
  - setGuideAcctConfig
```
public void setGuideAcctConfig(boolean isDelete,
                               List<String> blackKeyWord,
                               String guideAutoReply)
                        throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    为服务号设置敏感词与离线自动回复顾问在小程序离线状态时，客户发消息会收到设置的离线自动回复，最多支持 300 字。顾问在小程序内发消息，如果触发敏感词将无法发出。
    注意：添加模式 black_keyword字段传递null将删除全部敏感词 black_keyword字段有值将对敏感词进行追加而不是全量更新覆盖（实际测试与官方文档有冲突）
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/setguideacctconfig?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.setGuideAcctConfig.html
 
```
    指定者:
    
    setGuideAcctConfig 在接口中 WxMpGuideService
    
    参数:
    
    isDelete - 操作类型，false表示添加 true表示删除
    
    blackKeyWord - 敏感词，每次全量更新覆盖原来数据（如果不设置就不传black_keyword字段）
    
    guideAutoReply - 离线自动回复（如果不设置就不传guide_auto_reply字段）
    
    抛出:
    
    WxErrorException - .
  - getGuideAcctConfig
```
public WxMpGuideAcctConfig getGuideAcctConfig()
                                       throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    获取离线自动回复与敏感词
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getguideacctconfig?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.getGuideAcctConfig.html
 
```
    指定者:
    
    getGuideAcctConfig 在接口中 WxMpGuideService
    
    返回:
    
    离线自动回复与敏感词 guide acct config
    
    抛出:
    
    WxErrorException - .
  - pushShowWxaPathMenu
```
public void pushShowWxaPathMenu(String appId,
                                String userName)
                         throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    允许微信用户复制小程序页面路径请求成功后，该微信号用户可在微信上复制对应小程序的任意页面path，有效期为60天。若需要添加小程序卡片素材时的path，可以用这个方式获取。
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/pushshowwxapathmenu?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.pushShowWxaPathMenu.html
 
```
    指定者:
    
    pushShowWxaPathMenu 在接口中 WxMpGuideService
    
    参数:
    
    appId - 小程序appid，暂时只支持小程序，不支持小游戏
    
    userName - 关注该公众号的微信号
    
    抛出:
    
    WxErrorException - .
  - newGuideGroup
```
public Long newGuideGroup(String groupName)
                   throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    新建顾问分组
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/newguidegroup?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.newGuideGroup.html
 
```
    指定者:
    
    newGuideGroup 在接口中 WxMpGuideService
    
    参数:
    
    groupName - 顾问分组名称
    
    返回:
    
    顾问分组唯一id long
    
    抛出:
    
    WxErrorException - .
  - getGuideGroupList
```
public List<WxMpGuideGroup> getGuideGroupList()
                                       throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    获取服务号下所有顾问分组的列表
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getguidegrouplist?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.getGuideGroupList.html
 
```
    指定者:
    
    getGuideGroupList 在接口中 WxMpGuideService
    
    返回:
    
    顾问分组列表 guide group list
    
    抛出:
    
    WxErrorException - .
  - getGroupInfo
```
public WxMpGuideGroupInfoList getGroupInfo(long groupId,
                                           int page,
                                           int num)
                                    throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    获取指定顾问分组内顾问信息
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getgroupinfo?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.getGroupInfo.html
 
```
    指定者:
    
    getGroupInfo 在接口中 WxMpGuideService
    
    参数:
    
    groupId - 顾问群组id
    
    page - 分页页数，从0开始，用于组内顾问分页获取
    
    num - 每页数量
    
    返回:
    
    顾问分组内顾问信息 group info
    
    抛出:
    
    WxErrorException - .
  - addGuide2GuideGroup
```
public void addGuide2GuideGroup(long groupId,
                                String account)
                         throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    分组内添加顾问
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/addguide2guidegroup?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.addGuide2GuideGroup.html
 
```
    指定者:
    
    addGuide2GuideGroup 在接口中 WxMpGuideService
    
    参数:
    
    groupId - 顾问分组id
    
    account - 顾问微信号
    
    抛出:
    
    WxErrorException - .
  - delGuide2GuideGroup
```
public void delGuide2GuideGroup(long groupId,
                                String account)
                         throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    分组内删除顾问
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/delguide2guidegroup?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.delGuide2GuideGroup.html
 
```
    指定者:
    
    delGuide2GuideGroup 在接口中 WxMpGuideService
    
    参数:
    
    groupId - 顾问分组id
    
    account - 顾问微信号
    
    抛出:
    
    WxErrorException - .
  - getGroupByGuide
```
public List<Long> getGroupByGuide(String account)
                           throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    获取顾问所在分组
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getgroupbyguide?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.getGroupByGuide.html
 
```
    指定者:
    
    getGroupByGuide 在接口中 WxMpGuideService
    
    参数:
    
    account - 顾问微信号
    
    返回:
    
    顾问分组id列表 group by guide
    
    抛出:
    
    WxErrorException - .
  - delGuideGroup
```
public void delGuideGroup(long groupId)
                   throws WxErrorException
```
    从接口复制的说明: WxMpGuideService
    删除指定顾问分组
```
 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/delguidegroup?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/guide-account/shopping-guide.delGuideGroup.html
 
```
    指定者:
    
    delGuideGroup 在接口中 WxMpGuideService
    
    参数:
    
    groupId - 顾问分组id
    
    抛出:
    
    WxErrorException - .

类 WxMpGuideServiceImpl

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

WxMpGuideServiceImpl

方法详细资料

addGuide

addGuide

updateGuide

getGuide

delGuide

listGuide

createGuideQrCode

getGuideChatRecord

setGuideConfig

getGuideConfig

setGuideAcctConfig

getGuideAcctConfig

pushShowWxaPathMenu

newGuideGroup

getGuideGroupList

getGroupInfo

addGuide2GuideGroup

delGuide2GuideGroup

getGroupByGuide

delGuideGroup