获取获客链接列表

企业可通过此接口获取当前仍然有效的获客链接。

请求方式: POST(HTTP)

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

请求示例

{
   "limit":100,
   "cursor":"CURSOR"
}

参数说明:

权限说明:

• 企业需要使用配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。
• 第三方或代开发应用需具有“企业客户权限->获客助手”权限
• 不支持客户联系系统应用调用

返回结果:

{
    "errcode": 0,
    "errmsg": "ok",
	"link_id_list":
	[
		"LINK_ID_AAA",
		"LINK_ID_BBB",
		"LINK_ID_CCC"
	],
	"next_cursor":"CURSOR"
}

参数说明:

获取获客链接详情

企业可通过此接口根据获客链接id获取链接配置详情。

请求方式: POST(HTTP)

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

请求示例

{
   "link_id":"LINK_ID_AAA"
}

参数说明:

权限说明:

• 企业需要使用配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。
• 第三方或代开发应用需具有“企业客户权限->获客助手”权限
• 不支持客户联系系统应用调用

返回结果:

{
  "errcode": 0,
  "errmsg": "ok",
  "link":
	{
		"link_name":"LINK_NAME",
		"url":"https://work.weixin.qq.com/ca/xxxxxx",
		"create_time":1672502400,
		"skip_verify":true
	},
	"range":
	{
		"user_list":["rocky","sam"],
		"department_list":[1]
	},

}

参数说明:

创建获客链接

企业可通过此接口创建新的获客链接。

请求方式: POST(HTTP)

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

请求示例

{
   "link_name":"获客链接1号",
   "range":
   {
   		"user_list":["zhangsan","lisi"],
		"department_list":[2,3]
   },
   "skip_verify":true
}

参数说明:

range.user_list和range.department_list不可同时为空，range覆盖的总用户数不得超过500人。

权限说明:

• 企业需要使用配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。
• 第三方或代开发应用需具有“企业客户权限->获客助手”权限
• 不支持客户联系系统应用调用

返回结果:

{
    "errcode": 0,
    "errmsg": "ok",
	"link":{
		"link_id":"LINK_ID",
		"link_name":"获客链接1号",
		"url":"URL",
		"create_time":1667232000
	}
}

参数说明:

如为获取更好的跳转体验，也可将获客链接的url调整为scheme使用，方法如下：
scheme = weixin://biz/ww/profile/{urlencode(LINK_URL?customer_channel=STATE)}

示例，如果创建的获客链接为https://work.weixin.qq.com/ca/caXXXXX，
希望配置的customer_channel参数为WORK，则生成的scheme为:
weixin://biz/ww/profile/https%3A%2F%2Fwork.weixin.qq.com%2Fca%2FcaXXXXX%3Fcustomer_channel%3DWORK

编辑获客链接

企业可通过此接口编辑获客链接，修改获客链接的关联范围或修改获客链接的名称。

请求方式: POST(HTTP)

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

请求示例

{
   "link_id":"LINK_ID",
   "link_name":"获客链接1号",
   "range":
   {
   		"user_list":["zhangsan","lisi"],
		"department_list":[2,3]
   },
   "skip_verify":true
}

参数说明:

range为覆盖更新，覆盖的总人数不能超过500人。

权限说明:

• 企业需要使用配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。
• 第三方或代开发应用需具有“企业客户权限->获客助手”权限
• 不支持客户联系系统应用调用

返回结果:

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

参数说明:

删除获客链接

企业可通过此接口删除获客链接，删除后的获客链接将无法继续使用。

请求方式: POST(HTTP)

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

请求示例

{
   "link_id":"LINK_ID"
}

参数说明:

权限说明:

• 企业需要使用配置到“可调用应用”列表中的自建应用secret所获取的accesstoken来调用（accesstoken如何获取？）。
• 第三方或代开发应用需具有“企业客户权限->获客助手”权限
• 不支持客户联系系统应用调用

返回结果:

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

参数说明: