第三方应用开发 服务端API 客户联系 客户标签管理 管理企业标签
管理企业标签

目录

  • 获取企业标签库
  • 添加企业客户标签
  • 编辑企业客户标签
  • 删除企业客户标签
  • 企业客户标签是针对企业的外部联系人进行标记和分类的标签,由企业统一配置后,企业成员可使用此标签对客户进行标记。

    权限说明:

    • 对于获取企业标签库接口,企业需要使用“客户联系”secret或配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用(accesstoken如何获取?
    • 第三方可读写企业标签,但需有企业客户权限。特别的,添加/编辑/删除客户标签,需具有“企业客户权限->客户联系->管理企业客户标签”权限
    • 自建/第三方应用仅能编辑和删除本应用创建的标签,使用“客户联系”所获取的accesstoken进行调用则可编辑/删除所有的标签和标签组。

     

    获取企业标签库

    企业可通过此接口获取企业客户标签详情。

     

    请求方式: POST(HTTP)

    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_corp_tag_list?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"tag_id": 
    	[
    		"etXXXXXXXXXX",
    		"etYYYYYYYYYY"
    	],
    	"group_id":
    	[
    		"etZZZZZZZZZZZZZ",
    		"etYYYYYYYYYYYYY"
    	]
    }

     

    参数说明:

    参数必须说明
    access_token调用接口凭证
    tag_id要查询的标签id
    group_id要查询的标签组id,返回该标签组以及其下的所有标签信息
    若tag_id和group_id均为空,则返回所有标签。
    同时传递tag_id和group_id时,忽略tag_id,仅以group_id作为过滤条件

    返回结果:

    {
    	"errcode": 0,
    	"errmsg": "ok",
    	"tag_group": [{
    		"group_id": "TAG_GROUPID1",
    		"group_name": "GOURP_NAME",
    		"create_time": 1557838797,
    		"order": 1,
    		"deleted": false,
    		"tag": [{
    				"id": "TAG_ID1",
    				"name": "NAME1",
    				"create_time": 1557838797,
    				"order": 1,
    				"deleted": false
    			},
    			{
    				"id": "TAG_ID2",
    				"name": "NAME2",
    				"create_time": 1557838797,
    				"order": 2,
    				"deleted": true
    			}
    		]
    	}]
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    tag_group标签组列表
    tag_group.group_id标签组id
    tag_group.group_name标签组名称
    tag_group.create_time标签组创建时间
    tag_group.order标签组排序的次序值,order值大的排序靠前。有效的值范围是[0, 2^32)
    tag_group.deleted标签组是否已经被删除,只在指定tag_id进行查询时返回
    tag_group.tag标签组内的标签列表
    tag_group.tag.id标签id
    tag_group.tag.name标签名称
    tag_group.tag.create_time标签创建时间
    tag_group.tag.order标签排序的次序值,order值大的排序靠前。有效的值范围是[0, 2^32)
    tag_group.tag.deleted标签是否已经被删除,只在指定tag_id/group_id进行查询时返回

     

    添加企业客户标签

    企业可通过此接口向客户标签库中添加新的标签组和标签,每个企业最多可配置3000个企业标签

     

    请求方式: POST(HTTP)

    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_corp_tag?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"group_id": "GROUP_ID",
    	"group_name": "GROUP_NAME",
    	"order": 1,
    	"tag": [{
    			"name": "TAG_NAME_1",
    			"order": 1
    		},
    		{
    			"name": "TAG_NAME_2",
    			"order": 2
    		}
    	],
    	 "agentid" : 1000014
    }

    参数说明:

    参数必须说明
    access_token调用接口凭证
    group_id标签组id
    group_name标签组名称,最长为30个字符
    order标签组次序值。order值大的排序靠前。有效的值范围是[0, 2^32)
    tag.name添加的标签名称,最长为30个字符
    tag.order标签次序值。order值大的排序靠前。有效的值范围是[0, 2^32)
    agentid授权方安装的应用agentid。仅旧的第三方多应用套件需要填此参数
    注意:
    如果要向指定的标签组下添加标签,需要填写group_id参数;如果要创建一个全新的标签组以及标签,则需要通过group_name参数指定新标签组名称,如果填写的groupname已经存在,则会在此标签组下新建标签。
    如果填写了group_id参数,则group_name和标签组的order参数会被忽略。
    不支持创建空标签组。
    标签组内的标签不可同名,如果传入多个同名标签,则只会创建一个。

     

    返回结果:

    {
    	"errcode": 0,
    	"errmsg": "ok",
    	"tag_group": {
    		"group_id": "TAG_GROUPID1",
    		"group_name": "GOURP_NAME",
    		"create_time": 1557838797,
    		"order": 1,
    		"tag": [{
    				"id": "TAG_ID1",
    				"name": "NAME1",
    				"create_time": 1557838797,
    				"order": 1
    			},
    			{
    				"id": "TAG_ID2",
    				"name": "NAME2",
    				"create_time": 1557838797,
    				"order": 2
    			}
    		]
    	}
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    tag_group.group_id标签组id
    tag_group.group_name标签组名称
    tag_group.create_time标签组创建时间
    tag_group.order标签组次序值。order值大的排序靠前。有效的值范围是[0, 2^32)
    tag_group.tag标签组内的标签列表
    tag_group.tag.id新建标签id
    tag_group.tag.name新建标签名称
    tag_group.tag.create_time标签创建时间
    tag_group.tag.order标签次序值。order值大的排序靠前。有效的值范围是[0, 2^32)

    编辑企业客户标签

    企业可通过此接口编辑客户标签/标签组的名称或次序值。

     

    请求方式: POST(HTTP)

    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/edit_corp_tag?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"id": "TAG_ID",
    	"name": "NEW_TAG_NAME",
    	"order": 1,
    	"agentid" : 1000014
    }

    参数说明:

    参数必须说明
    access_token调用接口凭证
    id标签或标签组的id
    name新的标签或标签组名称,最长为30个字符
    order标签/标签组的次序值。order值大的排序靠前。有效的值范围是[0, 2^32)
    agentid授权方安装的应用agentid。仅旧的第三方多应用套件需要填此参数
    注意:修改后的标签组不能和已有的标签组重名,标签也不能和同一标签组下的其他标签重名。

     

    返回结果:

    {
        "errcode": 0,
        "errmsg": "ok"
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容

     

    删除企业客户标签

    企业可通过此接口删除客户标签库中的标签,或删除整个标签组。

    请求方式: POST(HTTP)

    请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/del_corp_tag?access_token=ACCESS_TOKEN

    请求示例:

    {
    	"tag_id": [
    		"TAG_ID_1",
    		"TAG_ID_2"
    	],
    	"group_id": [
    		"GROUP_ID_1",
    		"GROUP_ID_2"
    	],
    	"agentid" : 1000014
    }

    参数说明:

    参数必须说明
    access_token调用接口凭证
    tag_id标签的id列表
    group_id标签组的id列表
    agentid授权方安装的应用agentid。仅旧的第三方多应用套件需要填此参数
    tag_id和group_id不可同时为空。
    如果一个标签组下所有的标签均被删除,则标签组会被自动删除。

     

    返回结果:

    {
        "errcode": 0,
        "errmsg": "ok"
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容

     

    上一篇
    代开发应用external_userid转换
    下一篇
    编辑客户企业标签