开发者中心
首页
教程
接口
社区
工具
第三方应用开发
快速入门 服务端API 客户端API 运营规范 附录 更新日志 联系我们
第三方应用开发 服务端API 客户联系 获客助手组件 获客助手事件通知
获客助手事件通知
最后更新：2024/01/25
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
获客助手事件通知
最后更新：2024/01/25

目录

  • 发起好友请求事件
  • 添加成功事件
  • 微信用户首次发消息事件
  • 企业使用量即将耗尽事件
  • 企业使用量已经耗尽事件
  • 企业使用量增加事件
  • 服务商获客使用量即将耗尽事件
  • 服务商获客使用量已经耗尽事件
  • 消耗服务商使用量事件
  • 获客链接异常事件
  • 删除获客链接事件

    • 发起好友请求事件

    当微信用户通过获客链接点击添加到通讯录，成功发起好友请求，且State非空时，企业微信将向对应组件的“指令回调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_acquisition
    TimeStamp时间戳
    ChangeType此时固定为friend_request
    LinkId点击的获客链接ID
    State点击的获客链接配置的customer_channel值

    添加成功事件

    当微信用户通过获客链接添加外部联系人且State非空时，企业微信将向对应组件的“指令回调URL”推送该事件。

    请求示例：

    <xml>
	<SuiteId><![CDATA[ww4asffe99e54c0f4c]]></SuiteId>
	<AuthCorpId><![CDATA[wxf8b4f85f3a794e77]]></AuthCorpId>
	<InfoType><![CDATA[change_external_contact]]></InfoType>
	<TimeStamp>1403610513</TimeStamp>
	<ChangeType><![CDATA[add_external_contact]]></ChangeType>
	<LinkId><![CDATA[cawcdea7783d7330c6]]></LinkId>
	<State><![CDATA[teststate]]></State>
</xml>

    参数说明：

    参数说明
    SuiteId获客助手组件应用ID
    AuthCorpId授权企业的CorpID
    InfoType固定为change_external_contact
    TimeStamp时间戳
    ChangeType此时固定为add_external_contact
    LinkId添加此用户的获客链接Id
    State添加此用户配置的state参数，可用于识别添加此用户的渠道

    微信用户首次发消息事件

    当微信用户首次向成员发消息且State非空时，企业微信将向对应组件的“指令回调URL”推送该事件。

    请求示例：

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

    参数说明：

    参数说明
    SuiteId获客助手组件应用ID
    AuthCorpId授权企业的CorpID
    InfoType固定为customer_acquisition
    TimeStamp时间戳
    ChangeType此时固定为customer_start_chat
    LinkId获客链接ID
    State在获客链接中指定的customer_channel参数，可用于识别添加此用户的渠道

    企业使用量即将耗尽事件

    当获客助手的使用量低于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>

    参数说明：

    参数说明
    SuiteId获客助手组件应用ID
    AuthCorpId授权企业的CorpID
    InfoType固定为customer_acquisition
    TimeStamp时间戳
    ChangeType此时固定为balance_increased

    服务商获客使用量即将耗尽事件

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

    事件示例：

    <xml>
	<SuiteId><![CDATA[ww4asffe99e54c0f4c]]></SuiteId>
	<InfoType><![CDATA[customer_acquisition]]></InfoType>
	<TimeStamp>1403610513</TimeStamp>
	<ChangeType><![CDATA[service_balance_low]]></ChangeType>
</xml>

    参数说明：

    参数说明
    SuiteId获客助手组件应用ID
    InfoType固定为customer_acquisition
    TimeStamp时间戳
    ChangeType此时固定为service_balance_low

    服务商获客使用量已经耗尽事件

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

    事件示例：

    <xml>
	<SuiteId><![CDATA[ww4asffe99e54c0f4c]]></SuiteId>
	<InfoType><![CDATA[customer_acquisition]]></InfoType>
	<TimeStamp>1403610513</TimeStamp>
	<ChangeType><![CDATA[service_balance_exhausted]]></ChangeType>
</xml>

    参数说明：

    参数说明
    SuiteId获客助手组件应用ID
    InfoType固定为customer_acquisition
    TimeStamp时间戳
    ChangeType此时固定为service_balance_exhausted

    消耗服务商使用量事件

    当微信用户通过获客链接添加外部联系人时，若消耗的是服务商使用量，企业微信将向对应组件的“指令回调URL”推送该事件。

    事件示例：

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

    参数说明：

    参数说明
    SuiteId获客助手组件应用ID
    AuthCorpId授权企业的CorpID
    InfoType固定为customer_acquisition
    TimeStamp时间戳
    ChangeType此时固定为service_balance_consumed
    LinkId获客链接ID
    State获客链接配置的customer_channel值
    OnceKey拼接的once_key参数

    获客链接异常事件

    若链接中的成员暂时无法添加客户时，会在分配时自动跳过该成员。当链接中配置的全部成员账号异常，暂时无法继续添加客户时，企业微信将向对应组件的“指令回调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_acquisition
    TimeStamp时间戳
    ChangeType此时固定为link_unavailable
    LinkId失效的获客链接ID

     

    删除获客链接事件

    当授权给组件的链接被删除时，企业微信服务器会向组件的“指令回调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_acquisition
    TimeStamp时间戳
    ChangeType此时固定为delete_link
    LinkId被删除的获客链接ID

     

    在获客链接中指定customer_channel参数，当有客户通过对应的联系方式添加企业成员时，State即为用户配置的customer_channel参数。

     

    上一篇
    获取代支付流水
    下一篇
    授权通知事件