企业内部开发 服务端API 客户联系 回调通知 获客助手事件通知
获客助手事件通知
最后更新:2024/04/15
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
获客助手事件通知
最后更新:2024/04/15

目录

  • 企业使用量即将耗尽事件
  • 使用量已经耗尽事件
  • 使用量增加事件事件
  • 获客链接异常事件
  • 微信客户发起会话事件
  • 删除获客链接事件
  • 获客使用量即将过期事件
  • 通过获客链接发起好友请求事件
  • 企业使用量即将耗尽事件

    当获客助手的使用量低于20次时,将回调此事件。

    事件示例:

    <xml>
    	<ToUserName><![CDATA[toUser]]></ToUserName>
    	<FromUserName><![CDATA[sys]]></FromUserName> 
    	<CreateTime>1403610513</CreateTime>
    	<MsgType><![CDATA[event]]></MsgType>
    	<Event><![CDATA[customer_acquisition]]></Event>
    	<ChangeType><![CDATA[balance_low]]></ChangeType>
    </xml>

    参数说明:

    参数说明
    ToUserName企业微信CorpID
    FromUserName此事件该值固定为sys,表示该消息由系统生成
    CreateTime消息创建时间 (整型)
    MsgType消息的类型,此时固定为event
    Event事件的类型,此时固定为customer_acquisition
    ChangeType此时固定为balance_low

     

    使用量已经耗尽事件

    当获客助手的使用量已经消耗完时,回调此事件。

    事件示例:

    <xml>
    	<ToUserName><![CDATA[toUser]]></ToUserName>
    	<FromUserName><![CDATA[sys]]></FromUserName> 
    	<CreateTime>1403610513</CreateTime>
    	<MsgType><![CDATA[event]]></MsgType>
    	<Event><![CDATA[customer_acquisition]]></Event>
    	<ChangeType><![CDATA[balance_exhausted]]></ChangeType>
    </xml>

    参数说明:

    参数说明
    ToUserName企业微信CorpID
    FromUserName此事件该值固定为sys,表示该消息由系统生成
    CreateTime消息创建时间 (整型)
    MsgType消息的类型,此时固定为event
    Event事件的类型,此时固定为customer_acquisition
    ChangeType此时固定为balance_exhausted

    使用量增加事件事件

    当获客助手的使用量从0变到非0时,回调此事件。

    事件示例:

    <xml>
    	<ToUserName><![CDATA[toUser]]></ToUserName>
    	<FromUserName><![CDATA[sys]]></FromUserName> 
    	<CreateTime>1403610513</CreateTime>
    	<MsgType><![CDATA[event]]></MsgType>
    	<Event><![CDATA[customer_acquisition]]></Event>
    	<ChangeType><![CDATA[balance_increased]]></ChangeType>
    </xml>

    参数说明:

    参数说明
    ToUserName企业微信CorpID
    FromUserName此事件该值固定为sys,表示该消息由系统生成
    CreateTime消息创建时间 (整型)
    MsgType消息的类型,此时固定为event
    Event事件的类型,此时固定为customer_acquisition
    ChangeType此时固定为balance_increased

    获客链接异常事件

    若链接中的成员暂时无法添加客户时,会在分配时自动跳过该成员。当链接中配置的全部成员账号异常,暂时无法继续添加客户时,回调此事件到创建相应链接的应用,可及时调整链接配置或流量曝光策略,避免流量浪费。

    事件示例:

    <xml>
    	<ToUserName><![CDATA[toUser]]></ToUserName>
    	<FromUserName><![CDATA[sys]]></FromUserName> 
    	<CreateTime>1403610513</CreateTime>
    	<MsgType><![CDATA[event]]></MsgType>
    	<Event><![CDATA[customer_acquisition]]></Event>
    	<ChangeType><![CDATA[link_unavailable]]></ChangeType>
    	<LinkId><![CDATA[cawcdea7783d7330b4]]></LinkId>
    </xml>

    参数说明:

    参数说明
    ToUserName企业微信CorpID
    FromUserName此事件该值固定为sys,表示该消息由系统生成
    CreateTime消息创建时间 (整型)
    MsgType消息的类型,此时固定为event
    Event事件的类型,此时固定为customer_acquisition
    ChangeType此时固定为link_unavailable
    LinkId失效的获客链接ID

     

    微信客户发起会话事件

    授权企业中配置了客户联系功能的成员通过获客链接添加微信客户后,当微信用户首次向成员发起会话时,回调此事件到创建相应链接的应用。

    请求示例:

    <xml>
    <ToUserName><![CDATA[toUser]]></ToUserName>
    <FromUserName><![CDATA[sys]]></FromUserName> 
    <CreateTime>1403610513</CreateTime>
    <MsgType><![CDATA[event]]></MsgType>
    <Event><![CDATA[customer_acquisition]]></Event>
    <ChangeType><![CDATA[customer_start_chat]]></ChangeType>
    <UserID><![CDATA[zhangsan]]></UserID>
    <ExternalUserID><![CDATA[woAJ2GCAAAXtWyujaWJHDDGi0mAAAA]]></ExternalUserID>
    <LinkId><![CDATA[cawcdea7783d7330c6]]></LinkId>
    </xml>

    参数说明:

    参数说明
    ToUserName企业微信CorpID
    FromUserName此事件该值固定为sys,表示该消息由系统生成
    CreateTime消息创建时间 (整型)
    MsgType消息的类型,此时固定为event
    Event固定为customer_acquisition
    ChangeType此时固定为customer_start_chat
    UserID企业服务人员的UserID
    ExternalUserID外部联系人的userid,注意不是企业成员的账号
    LinkId获客链接ID

     

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

     

    删除获客链接事件

    当API创建的获客链接在管理端或终端被删除时,回调此事件到创建相应链接的应用。

    事件示例:

    <xml>
    	<ToUserName><![CDATA[toUser]]></ToUserName>
    	<FromUserName><![CDATA[sys]]></FromUserName> 
    	<CreateTime>1403610513</CreateTime>
    	<MsgType><![CDATA[event]]></MsgType>
    	<Event><![CDATA[customer_acquisition]]></Event>
    	<ChangeType><![CDATA[delete_link]]></ChangeType>
    	<LinkId><![CDATA[cawcdea7783d7330b4]]></LinkId>
    </xml>

    参数说明:

    参数说明
    ToUserName企业微信CorpID
    FromUserName此事件该值固定为sys,表示该消息由系统生成
    CreateTime消息创建时间 (整型)
    MsgType消息的类型,此时固定为event
    Event事件的类型,此时固定为customer_acquisition
    ChangeType此时固定为delete_link
    LinkId被删除的获客链接ID
    注意,通过API接口删除获客链接不会触发此回调事件

    获客使用量即将过期事件

    当企业购买的获客助手使用量即将过期时,将在过期前的14天、7天、3天、2天及1天回调此事件。

    事件示例:

    <xml>
    	<ToUserName><![CDATA[toUser]]></ToUserName>
    	<FromUserName><![CDATA[sys]]></FromUserName> 
    	<CreateTime>1689171577</CreateTime>
    	<MsgType><![CDATA[event]]></MsgType>
    	<Event><![CDATA[customer_acquisition]]></Event>
    	<ChangeType><![CDATA[quota_expire_soon]]></ChangeType>
    	<ExpireTime>1690819200</ExpireTime>
    	<ExpireQuotaNum>100</ExpireQuotaNum>
    </xml>

    参数说明:

    参数说明
    ToUserName企业微信CorpID
    FromUserName此事件该值固定为sys,表示该消息由系统生成
    CreateTime消息创建时间 (整型)
    MsgType消息的类型,此时固定为event
    Event事件的类型,此时固定为customer_acquisition
    ChangeType此时固定为quota_expire_soon
    ExpireTime额度过期时间戳
    ExpireQuotaNum即将过期的获客额度数

    通过获客链接发起好友请求事件

    当微信用户通过获客链接点击添加到通讯录,成功发起好友请求,回调此事件到创建该链接的应用。

    事件示例:

    <xml>
    	<ToUserName><![CDATA[toUser]]></ToUserName>
    	<FromUserName><![CDATA[sys]]></FromUserName> 
    	<CreateTime>1689171577</CreateTime>
    	<MsgType><![CDATA[event]]></MsgType>
    	<Event><![CDATA[customer_acquisition]]></Event>
    	<ChangeType><![CDATA[friend_request]]></ChangeType>
    	<LinkId><![CDATA[cawcdea7783d7330b4]]></LinkId>
    	<State><![CDATA[STATE]]></State>
    </xml>

    参数说明:

    参数说明
    ToUserName企业微信CorpID
    FromUserName此事件该值固定为sys,表示该消息由系统生成
    CreateTime消息创建时间 (整型)
    MsgType消息的类型,此时固定为event
    Event事件的类型,此时固定为customer_acquisition
    ChangeType此时固定为friend_request
    LinkId点击的获客链接ID
    State点击的获客链接配置的customer_channel值

     

    上一篇
    事件格式
    下一篇
    管理商品图册