me.chanjar.weixin.cp.tp.service

接口 WxCpTpTagService

所有已知实现类:

WxCpTpTagServiceImpl

public interface WxCpTpTagService

   企业微信第三方开发-标签相关接口
 

从以下版本开始:

2021-02-14 16:02

作者:

zhangq

方法概要

限定符和类型	方法和说明
WxCpTpTagAddOrRemoveUsersResult	addUsers2Tag(String tagId, List<String> userIds, List<String> partyIds) 增加标签成员.
String	create(String name, Integer id) 创建标签.
void	delete(String tagId) 删除标签.
WxCpTpTagGetResult	get(String tagId) 获取标签成员
List<WxCpTpTag>	listAll() 获得标签列表.
WxCpTpTagAddOrRemoveUsersResult	removeUsersFromTag(String tagId, List<String> userIds, List<String> partyIds) 移除标签成员.
void	update(String tagId, String tagName) 更新标签.

方法详细资料

create

String create(String name,
              Integer id)
       throws WxErrorException

创建标签.

 请求地址：https://qyapi.weixin.qq.com/cgi-bin/tag/create?access_token=ACCESS_TOKEN
 文档地址：https://work.weixin.qq.com/api/doc/90001/90143/90346
 

参数:

name - 标签名称，长度限制为32个字以内（汉字或英文字母），标签名不可与其他标签重名。

id - 标签id，非负整型，指定此参数时新增的标签会生成对应的标签id，不指定时则以目前最大的id自增。

返回:

标签id

抛出:

WxErrorException

update

void update(String tagId,
            String tagName)
     throws WxErrorException

更新标签.

参数:

tagId - 标签id

tagName - 标签名

抛出:

WxErrorException - .

delete

void delete(String tagId)
     throws WxErrorException

删除标签.

参数:

tagId - 标签id

抛出:

WxErrorException - .

get

WxCpTpTagGetResult get(String tagId)
                throws WxErrorException

获取标签成员

参数:

tagId -

返回:

抛出:

WxErrorException

addUsers2Tag

WxCpTpTagAddOrRemoveUsersResult addUsers2Tag(String tagId,
                                             List<String> userIds,
                                             List<String> partyIds)
                                      throws WxErrorException

增加标签成员.

参数:

tagId - 标签id

userIds - 用户ID 列表

partyIds - 企业部门ID列表

返回:

.

抛出:

WxErrorException - .

removeUsersFromTag

WxCpTpTagAddOrRemoveUsersResult removeUsersFromTag(String tagId,
                                                   List<String> userIds,
                                                   List<String> partyIds)
                                            throws WxErrorException

移除标签成员.

参数:

tagId - 标签id

userIds - 用户id列表

partyIds - 企业部门ID列表

返回:

.

抛出:

WxErrorException - .

listAll

List<WxCpTpTag> listAll()
                 throws WxErrorException

获得标签列表.

返回:

标签列表

抛出:

WxErrorException - .