me.chanjar.weixin.mp.api

接口 WxMpGuideTagService

所有已知实现类:

WxMpGuideTagServiceImpl

public interface WxMpGuideTagService

微信导购助手（现在叫对话能力）标签相关接口.

作者:

广州跨界-宋心成

方法概要

限定符和类型	方法和说明
void	addGuideBuyerDisplayTag(String account, String openid, String userOpenid, List<String> msgList) 设置自定义客户信息 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/addguidebuyerdisplaytag?
List<WxMpGuideBuyerResp>	addGuideBuyerTag(String account, String openid, String value, List<String> userOpenIds) 为客户设置标签（批量） 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/addguidebuyertag?
void	addGuideBuyerTag(String account, String openid, String value, String userOpenid) 为客户设置标签（单个）
void	addGuideTagOption(String tagName, List<String> values) 为标签添加可选值 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/addguidetagoption?
List<WxMpGuideBuyerResp>	delGuideBuyerTag(String account, String openid, String value, List<String> userOpenIds) 删除客户标签(批量) 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/delguidebuyertag?
void	delGuideBuyerTag(String account, String openid, String value, String userOpenid) 删除客户标签(单个)
void	delGuideTagOption(String tagName) 删除指定标签类型 此操作会更新所有相关客户的标签信息，存在延迟。
List<String>	getGuideBuyerDisplayTag(String account, String openid, String userOpenid) 获取自定义客户信息 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getguidebuyerdisplaytag?
List<String>	getGuideBuyerTag(String account, String openid, String userOpenid, Boolean isExclude) 查询客户标签 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getguidebuyertag?
List<WxMpGuideTagInfo>	getGuideTagOption() 获取标签和可选值 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getguidetagoption?
void	newGuideTagOption(String tagName, List<String> values) 新建标签类型 最多 4 类标签类型，50 个可选值，所有的标签可选值不能有相等重复的值。
List<String>	queryGuideBuyerByTag(String account, String openid, Integer pushCount, List<String> value) 根据标签值筛选客户 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/queryguidebuyerbytag?

方法详细资料

newGuideTagOption

void newGuideTagOption(String tagName,
                       List<String> values)
                throws WxErrorException

新建标签类型 最多 4 类标签类型，50 个可选值，所有的标签可选值不能有相等重复的值。

 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/newguidetagoption?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/tag-account/shopping-guide.newGuideTagOption.html
 

参数:

tagName - 标签类型的名字

values - 标签可选值列表，可选值不能为空值，所有的标签可选值不能有相等重复的值

抛出:

WxErrorException - 。

delGuideTagOption

void delGuideTagOption(String tagName)
                throws WxErrorException

删除指定标签类型 此操作会更新所有相关客户的标签信息，存在延迟。

 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/delguidetagoption?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/tag-account/shopping-guide.delguidetagoption.html
 

参数:

tagName - 标签类型的名字

抛出:

WxErrorException - 。

addGuideTagOption

void addGuideTagOption(String tagName,
                       List<String> values)
                throws WxErrorException

为标签添加可选值

 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/addguidetagoption?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/tag-account/shopping-guide.addGuideTagOption.html
 

参数:

tagName - 标签类型的名字

values - 标签可选值列表，可选值不能为空值，所有的标签可选值不能有相等重复的值

抛出:

WxErrorException - 。

getGuideTagOption

List<WxMpGuideTagInfo> getGuideTagOption()
                                  throws WxErrorException

获取标签和可选值

 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getguidetagoption?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/tag-account/shopping-guide.getGuideTagOption.html
 

返回:

标签信息列表

抛出:

WxErrorException

addGuideBuyerTag

List<WxMpGuideBuyerResp> addGuideBuyerTag(String account,
                                          String openid,
                                          String value,
                                          List<String> userOpenIds)
                                   throws WxErrorException

为客户设置标签（批量）

 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/addguidebuyertag?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/tag-account/shopping-guide.addGuideBuyerTag.html
 

参数:

account - 顾问微信号（guide_account和guide_openid二选一）

openid - 顾问openid或者unionid（guide_account和guide_openid二选一）

value - 标签的可选值，该值必须在标签的可选值集合中

userOpenIds - 客户列表，不超过200

返回:

客户列表添加结果

抛出:

WxErrorException - .

addGuideBuyerTag

void addGuideBuyerTag(String account,
                      String openid,
                      String value,
                      String userOpenid)
               throws WxErrorException

为客户设置标签（单个）

参数:

account - 顾问微信号（guide_account和guide_openid二选一）

openid - 顾问openid或者unionid（guide_account和guide_openid二选一）

value - 标签的可选值，该值必须在标签的可选值集合中

userOpenid - 用户openid

抛出:

WxErrorException - .

getGuideBuyerTag

List<String> getGuideBuyerTag(String account,
                              String openid,
                              String userOpenid,
                              Boolean isExclude)
                       throws WxErrorException

查询客户标签

 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getguidebuyertag?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/tag-account/shopping-guide.getGuideBuyerTag.html
 

踩坑记录（2021/5/12）：这里不只是返回标签值 如果该客户设置了自定义信息也会同样返回在标签数组的末尾 未设置则只返回客户标签列表 为此坑我添加一个参数是否排除客户自定义信息

参数:

account - 顾问微信号（guide_account和guide_openid二选一）

openid - 顾问openid或者unionid（guide_account和guide_openid二选一）

userOpenid - 用户openid

isExclude - 是否排除客户自定义信息

返回:

标签值列表

抛出:

WxErrorException - 。

queryGuideBuyerByTag

List<String> queryGuideBuyerByTag(String account,
                                  String openid,
                                  Integer pushCount,
                                  List<String> value)
                           throws WxErrorException

根据标签值筛选客户

 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/queryguidebuyerbytag?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/tag-account/shopping-guide.queryGuideBuyerByTag.html
 

踩坑记录（2021/5/12）： 不传递pushCount参数会返回-1 传递0查询所有 （推荐传递0） 当pushCount > 0 该条件查询逻辑有问题 目前发现：传递1可以查询出可发次数为4次的用户，而传递4是查询不出来的。

注意：该查询是查询所有条件均符合的 例如：查询A标签的客户 假如客户标签为A,B两个 将无法查询到该客户

参数:

account - 顾问微信号（guide_account和guide_openid二选一）

openid - 顾问openid或者unionid（guide_account和guide_openid二选一）

pushCount - 本月还可主动发消息次数 （建议传递0查询）

value - 标签值集合，该值必须在标签可选值集合中

返回:

客户openid集合

抛出:

WxErrorException - 。

delGuideBuyerTag

List<WxMpGuideBuyerResp> delGuideBuyerTag(String account,
                                          String openid,
                                          String value,
                                          List<String> userOpenIds)
                                   throws WxErrorException

删除客户标签(批量)

 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/delguidebuyertag?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/tag-account/shopping-guide.delGuideBuyerTag.html
 

参数:

account - 顾问微信号（guide_account和guide_openid二选一）

openid - 顾问openid或者unionid（guide_account和guide_openid二选一）

value - 标签的可选值，该值必须在标签的可选值集合中

userOpenIds - 客户列表，不超过200

返回:

客户列表处理结果

抛出:

WxErrorException。

WxErrorException

delGuideBuyerTag

void delGuideBuyerTag(String account,
                      String openid,
                      String value,
                      String userOpenid)
               throws WxErrorException

删除客户标签(单个)

参数:

account - 顾问微信号（guide_account和guide_openid二选一）

openid - 顾问openid或者unionid（guide_account和guide_openid二选一）

value - 标签的可选值，该值必须在标签的可选值集合中

userOpenid - 用户openid

抛出:

WxErrorException - .

addGuideBuyerDisplayTag

void addGuideBuyerDisplayTag(String account,
                             String openid,
                             String userOpenid,
                             List<String> msgList)
                      throws WxErrorException

设置自定义客户信息

 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/addguidebuyerdisplaytag?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/tag-account/shopping-guide.addGuideBuyerDisplayTag.html
 

参数:

account - 顾问微信号（guide_account和guide_openid二选一）

openid - 顾问openid或者unionid（guide_account和guide_openid二选一）

userOpenid - 用户openid

msgList - 自定义客户信息，全量更新，调用时传所有信息

抛出:

WxErrorException - .

getGuideBuyerDisplayTag

List<String> getGuideBuyerDisplayTag(String account,
                                     String openid,
                                     String userOpenid)
                              throws WxErrorException

获取自定义客户信息

 请求地址： POST https://api.weixin.qq.com/cgi-bin/guide/getguidebuyerdisplaytag?access_token=ACCESS_TOKEN
 文档地址：https://developers.weixin.qq.com/doc/offiaccount/Shopping_Guide/tag-account/shopping-guide.getGuideBuyerDisplayTag.html
 

参数:

account - 顾问微信号（guide_account和guide_openid二选一）

openid - 顾问openid或者unionid（guide_account和guide_openid二选一）

userOpenid - 用户openid

返回:

自定义客户信息列表

抛出:

WxErrorException - 。