事件格式

[TOC]

添加企业客户事件

配置了客户联系功能的成员添加外部联系人时,回调该事件

请求示例:

<xml>
    <ToUserName><![CDATA[toUser]]></ToUserName>
    <FromUserName><![CDATA[sys]]></FromUserName> 
    <CreateTime>1403610513</CreateTime>
    <MsgType><![CDATA[event]]></MsgType>
    <Event><![CDATA[change_external_contact]]></Event>
    <ChangeType><![CDATA[add_external_contact]]></ChangeType>
    <UserID><![CDATA[zhangsan]]></UserID>
    <ExternalUserID><![CDATA[woAJ2GCAAAXtWyujaWJHDDGi0mAAAA]]></ExternalUserID>
    <State><![CDATA[teststate]]></State>
    <WelcomeCode><![CDATA[WELCOMECODE]]></WelcomeCode>
</xml>

参数说明:

参数 说明
ToUserName 企业微信CorpID
FromUserName 此事件该值固定为sys,表示该消息由系统生成
CreateTime 消息创建时间 (整型)
MsgType 消息的类型,此时固定为event
Event 事件的类型,此时固定为change_external_contact
ChangeType 此时固定为add_external_contact
UserID 企业服务人员的UserID
ExternalUserID 外部联系人的userid,注意不是企业成员的帐号
State 添加此用户的「联系我」方式配置的state参数,可用于识别添加此用户的渠道
WelcomeCode 欢迎语code,可用于发送欢迎语

企业可以根据ExternalUserID调用“获取客户详情”读取详情。
企业可以通过配置客户联系「联系我」方式接口来指定State参数,当有客户通过这个联系方式添加企业成员时会回调此参数。
注意:如果外部联系人和成员已经开始聊天或已通过「外部联系人免验证添加成员事件」得到的welcomecode发送欢迎语,则不会继续返回welcomecode。

编辑企业客户事件

配置了客户联系功能的成员修改外部联系人的备注、手机号或标签时,回调该事件

请求示例:

<xml>
    <ToUserName><![CDATA[toUser]]></ToUserName>
    <FromUserName><![CDATA[sys]]></FromUserName> 
    <CreateTime>1403610513</CreateTime>
    <MsgType><![CDATA[event]]></MsgType>
    <Event><![CDATA[change_external_contact]]></Event>
    <ChangeType><![CDATA[edit_external_contact]]></ChangeType>
    <UserID><![CDATA[zhangsan]]></UserID>
    <ExternalUserID><![CDATA[woAJ2GCAAAXtWyujaWJHDDGi0mAAAA]]></ExternalUserID>
    <State><![CDATA[teststate]]></State>
</xml>

参数说明:

参数 说明
ToUserName 企业微信CorpID
FromUserName 此事件该值固定为sys,表示该消息由系统生成
CreateTime 消息创建时间 (整型)
MsgType 消息的类型,此时固定为event
Event 事件的类型,此时固定为change_external_contact
ChangeType 此时固定为edit_external_contact
UserID 企业服务人员的UserID
ExternalUserID 外部联系人的userid,注意不是企业成员的帐号
State 添加此用户的「联系我」方式配置的state参数,可用于识别添加此用户的渠道

外部联系人免验证添加成员事件

外部联系人添加了配置了客户联系功能且开启了免验证的成员时(此时成员尚未确认添加对方为好友),回调该事件

请求示例:

<xml>
    <ToUserName><![CDATA[toUser]]></ToUserName>
    <FromUserName><![CDATA[sys]]></FromUserName> 
    <CreateTime>1403610513</CreateTime>
    <MsgType><![CDATA[event]]></MsgType>
    <Event><![CDATA[change_external_contact]]></Event>
    <ChangeType><![CDATA[add_half_external_contact]]></ChangeType>
    <UserID><![CDATA[zhangsan]]></UserID>
    <ExternalUserID><![CDATA[woAJ2GCAAAXtWyujaWJHDDGi0mACAAAA]]></ExternalUserID>
    <State><![CDATA[teststate]]></State>
    <WelcomeCode><![CDATA[WELCOMECODE]]></WelcomeCode>
</xml>

参数说明:

参数 说明
ToUserName 企业微信CorpID
FromUserName 此事件该值固定为sys,表示该消息由系统生成
CreateTime 消息创建时间 (整型)
MsgType 消息的类型,此时固定为event
Event 事件的类型,此时固定为change_external_contact
ChangeType 此时固定为add_half_external_contact
UserID 企业服务人员的UserID
ExternalUserID 外部联系人的userid,注意不是企业成员的帐号
State 添加此用户的「联系我」方式配置的state参数,可用于识别添加此用户的渠道
WelcomeCode 欢迎语code,可用于发送欢迎语

企业可以根据ExternalUserID调用“获取客户详情”读取详情。
企业可以通过配置客户联系「联系我」方式接口来指定State参数,当有客户通过这个联系方式添加企业成员时会回调此参数。
注意:如果外部联系人和成员已经开始聊天,则不会返回welcomecode。

删除企业客户事件

配置了客户联系功能的成员删除外部联系人时,回调该事件

请求示例:

<xml>
    <ToUserName><![CDATA[toUser]]></ToUserName>
    <FromUserName><![CDATA[sys]]></FromUserName> 
    <CreateTime>1403610513</CreateTime>
    <MsgType><![CDATA[event]]></MsgType>
    <Event><![CDATA[change_external_contact]]></Event>
    <ChangeType><![CDATA[del_external_contact]]></ChangeType>
    <UserID><![CDATA[zhangsan]]></UserID>
    <ExternalUserID><![CDATA[woAJ2GCAAAXtWyujaWJHDDGi0mACAAAA]]></ExternalUserID>
</xml>

参数说明:

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

删除跟进成员事件

配置了客户联系功能的成员被外部联系人删除时,回调该事件

请求示例:

<xml>
    <ToUserName><![CDATA[toUser]]></ToUserName>
    <FromUserName><![CDATA[sys]]></FromUserName> 
    <CreateTime>1403610513</CreateTime>
    <MsgType><![CDATA[event]]></MsgType>
    <Event><![CDATA[change_external_contact]]></Event>
    <ChangeType><![CDATA[del_follow_user]]></ChangeType>
    <UserID><![CDATA[zhangsan]]></UserID>
    <ExternalUserID><![CDATA[woAJ2GCAAAXtWyujaWJHDDGi0mACHAAA]]></ExternalUserID>
</xml>

参数说明:

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

客户群变更事件

客户群被修改后(群名变更,群成员增加或移除),回调该事件。收到该事件后,企业需要再调用获取客户群详情接口,以获取最新的群详情。

请求示例:

<xml>
    <ToUserName><![CDATA[toUser]]></ToUserName>
    <FromUserName><![CDATA[sys]]></FromUserName> 
    <CreateTime>1403610513</CreateTime>
    <MsgType><![CDATA[event]]></MsgType>
    <Event><![CDATA[change_external_chat]]></Event>
    <ChatId><![CDATA[CHAT_ID]]></ChatId>
</xml>

参数说明:

参数 说明
ToUserName 企业微信CorpID
FromUserName 此事件该值固定为sys,表示该消息由系统生成
CreateTime 消息创建时间 (unix时间戳)
MsgType 消息的类型,此时固定为event
Event 事件的类型,此时固定为 change_external_chat
ChatId 群ID
© 1998 - 2020 Tencent Inc. All Rights Reserved