获客助手事件通知 - 文档 - 企业微信开发者中心

第三方应用开发

快速入门服务端API 客户端API 工具与资源运营规范附录更新日志联系我们

第三方应用开发

服务端API

客户联系

回调通知

获客助手事件通知

最后更新：2024/09/14

企业使用量即将耗尽事件

当获客助手的使用量低于20次时，企业微信服务器会向应用的“指令回调URL”推送该事件。

事件示例：

<xml>
	<SuiteId><![CDATA[ww4asffe99e54c0f4c]]></SuiteId>
	<AuthCorpId><![CDATA[wxf8b4f85f3a794e77]]></AuthCorpId>
	<InfoType><![CDATA[customer_acquisition]]></InfoType>
	<TimeStamp>1403610513</TimeStamp>
	<ChangeType><![CDATA[balance_low]]></ChangeType>
</xml>

参数说明：

参数	说明
SuiteId	第三方应用ID
AuthCorpId	授权企业的CorpID
InfoType	固定为customer_acquisition
TimeStamp	时间戳
ChangeType	此时固定为balance_low

使用量已经耗尽事件

当获客助手的使用量已经消耗完时，企业微信服务器会向应用的“指令回调URL”推送该事件。

事件示例：

<xml>
	<SuiteId><![CDATA[ww4asffe99e54c0f4c]]></SuiteId>
	<AuthCorpId><![CDATA[wxf8b4f85f3a794e77]]></AuthCorpId>
	<InfoType><![CDATA[customer_acquisition]]></InfoType>
	<TimeStamp>1403610513</TimeStamp>
	<ChangeType><![CDATA[balance_exhausted]]></ChangeType>
</xml>

参数说明：

参数	说明
SuiteId	第三方应用ID
AuthCorpId	授权企业的CorpID
InfoType	固定为customer_acquisition
TimeStamp	时间戳
ChangeType	此时固定为balance_exhausted

使用量增加事件事件

当获客助手的使用量从0变到非0时，企业微信服务器会向应用的“指令回调URL”推送该事件。

事件示例：

<xml>
	<SuiteId><![CDATA[ww4asffe99e54c0f4c]]></SuiteId>
	<AuthCorpId><![CDATA[wxf8b4f85f3a794e77]]></AuthCorpId>
	<InfoType><![CDATA[customer_acquisition]]></InfoType>
	<TimeStamp>1403610513</TimeStamp>
	<ChangeType><![CDATA[balance_increased]]></ChangeType>
</xml>

获客链接异常事件

若链接中的成员暂时无法添加客户时，会在分配时自动跳过该成员。当链接中配置的全部成员账号异常，暂时无法继续添加客户时，企业微信服务器会向组件应用的“指令回调URL”推送该事件，可及时调整链接配置或流量曝光策略，避免流量浪费。

事件示例：

<xml>
	<SuiteId><![CDATA[ww4asffe99e54c0f4c]]></SuiteId>
	<AuthCorpId><![CDATA[wxf8b4f85f3a794e77]]></AuthCorpId>
	<InfoType><![CDATA[customer_acquisition]]></InfoType>
	<TimeStamp>1403610513</TimeStamp>
	<ChangeType><![CDATA[link_unavailable]]></ChangeType>
	<LinkId><![CDATA[cawcdea7783d7330c6]]></LinkId>
</xml>

参数说明：

参数	说明
SuiteId	第三方应用ID
AuthCorpId	授权企业的CorpID
InfoType	固定为customer_aqcuisition
TimeStamp	时间戳
ChangeType	此时固定为link_unavailable
LinkId	失效的获客链接ID

删除获客链接事件

当API创建的获客链接在管理端或终端被删除时，企业微信服务器会向创建相关链接应用的“指令回调URL”推送该事件。

事件示例：

<xml>
	<SuiteId><![CDATA[ww4asffe99e54c0f4c]]></SuiteId>
	<AuthCorpId><![CDATA[wxf8b4f85f3a794e77]]></AuthCorpId>
	<InfoType><![CDATA[customer_acquisition]]></InfoType>
	<TimeStamp>1403610513</TimeStamp>
	<ChangeType><![CDATA[delete_link]]></ChangeType>
	<LinkId><![CDATA[cawcdea7783d7330c6]]></LinkId>
</xml>

参数说明：

参数	说明
SuiteId	第三方应用ID
AuthCorpId	授权企业的CorpID
InfoType	固定为customer_aqcuisition
TimeStamp	时间戳
ChangeType	此时固定为delete_link
LinkId	被删除的获客链接ID

注意，通过API接口删除获客链接不会触发此回调事件

获客使用量即将过期事件

当企业购买的获客助手使用量即将过期时，企业微信将在过期前的14天、7天、3天、2天及1天向具有获客助手权限的第三方应用的“指令回调URL”推送该事件。

事件示例：

<xml>
	<SuiteId><![CDATA[ww4asffe99e54c0f4c]]></SuiteId>
	<AuthCorpId><![CDATA[wxf8b4f85f3a794e77]]></AuthCorpId>
	<InfoType><![CDATA[customer_acquisition]]></InfoType>
	<TimeStamp>1689171577</TimeStamp>
	<ChangeType><![CDATA[quota_expire_soon]]></ChangeType>
	<ExpireTime>1690819200</ExpireTime>
	<ExpireQuotaNum>100</ExpireQuotaNum>
</xml>

参数说明：

参数	说明
SuiteId	第三方应用ID
AuthCorpId	授权企业的CorpID
InfoType	固定为customer_aqcuisition
TimeStamp	时间戳
ChangeType	此时固定为quota_expire_soon
ExpireTime	额度过期时间戳
ExpireQuotaNum	即将过期的获客额度数

微信客户打开获客链接事件

当微信客户通过获客链接进入成员的profile页时，企业微信将向创建该链接的第三方应用的“指令回调URL”推送该事件。仅部分经营类目企业支持，当前企业是否支持可在「高级功能-获客助手」中查看该类目对应的功能是否包含「链接打开回调」。

事件示例：

<xml>
	<SuiteId><![CDATA[ww4asffe99e54c0f4c]]></SuiteId>
	<AuthCorpId><![CDATA[wxf8b4f85f3a794e77]]></AuthCorpId>
	<InfoType><![CDATA[customer_acquisition]]></InfoType>
	<TimeStamp>1689171577</TimeStamp>
	<ChangeType><![CDATA[open_profile]]></ChangeType>
	<LinkId><![CDATA[cawcdea7783d7330c6]]></LinkId>
	<State><![CDATA[STATE]]></State>
</xml>

参数说明：

参数	说明
SuiteId	第三方应用ID
AuthCorpId	授权企业的CorpID
InfoType	固定为customer_aqcuisition
TimeStamp	时间戳
ChangeType	此时固定为open_profile
LinkId	点击的获客链接ID
State	点击的获客链接配置的customer_channel值

微信客户发起好友申请

当用户通过获客链接发起添加好友请求时，企业微信将向创建该链接的第三方应用的“指令回调URL”推送该事件。

事件示例：

<xml>
	<SuiteId><![CDATA[ww4asffe99e54c0f4c]]></SuiteId>
	<AuthCorpId><![CDATA[wxf8b4f85f3a794e77]]></AuthCorpId>
	<InfoType><![CDATA[customer_acquisition]]></InfoType>
	<TimeStamp>1689171577</TimeStamp>
	<ChangeType><![CDATA[friend_request]]></ChangeType>
	<LinkId><![CDATA[cawcdea7783d7330c6]]></LinkId>
	<State><![CDATA[STATE]]></State>
</xml>

参数说明：

参数	说明
SuiteId	第三方应用ID
AuthCorpId	授权企业的CorpID
InfoType	固定为customer_aqcuisition
TimeStamp	时间戳
ChangeType	此时固定为friend_request
LinkId	点击的获客链接ID
State	点击的获客链接配置的customer_channel值

成员首次收消息事件

授权企业中配置了客户联系功能的成员通过获客链接添加微信客户后，当成员首次收到客户消息时，企业微信服务器会向创建对应链接应用的“指令回调URL”推送该事件。

请求示例：

<xml>
	<SuiteId><![CDATA[ww4asffe99e54c0f4c]]></SuiteId>
	<AuthCorpId><![CDATA[wxf8b4f85f3a794e77]]></AuthCorpId>
	<InfoType><![CDATA[customer_acquisition]]></InfoType>
	<TimeStamp>1403610513</TimeStamp>
	<ChangeType><![CDATA[customer_start_chat]]></ChangeType>
	<UserID><![CDATA[zhangsan]]></UserID>
	<ExternalUserID><![CDATA[woAJ2GCAAAXtWyujaWJHDDGi0mACH71w]]>
	<LinkId><![CDATA[cawcdea7783d7330c6]]></LinkId>
</xml>

参数说明：

参数	说明
SuiteId	第三方应用ID
AuthCorpId	授权企业的CorpID
InfoType	固定为customer_acquisition
TimeStamp	时间戳
ChangeType	此时固定为customer_start_chat
UserID	企业服务人员的UserID
ExternalUserID	外部联系人的userid，注意不是企业成员的账号
LinkId	获客链接ID

第三方应用可以根据ExternalUserID调用“获取客户详情”读取详情。
目前仅对微信客户支持此事件

成员多次收消息事件

授权企业中配置了客户联系功能的成员通过获客链接添加微信客户后，当成员第3、5、10次收到客户消息时，企业微信服务器会向创建对应链接应用的“指令回调URL”推送该事件。该事件仅在获客助手内测期限时免费提供。