事件格式
添加企业客户事件
参数 | 说明 |
---|---|
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。
编辑企业客户事件
参数 | 说明 |
---|---|
ToUserName | 企业微信CorpID |
FromUserName | 此事件该值固定为sys,表示该消息由系统生成 |
CreateTime | 消息创建时间 (整型) |
MsgType | 消息的类型,此时固定为event |
Event | 事件的类型,此时固定为change_external_contact |
ChangeType | 此时固定为edit_external_contact |
UserID | 企业服务人员的UserID |
ExternalUserID | 外部联系人的userid,注意不是企业成员的帐号 |
外部联系人免验证添加成员事件
参数 | 说明 |
---|---|
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。
删除企业客户事件
参数 | 说明 |
---|---|
ToUserName | 企业微信CorpID |
FromUserName | 此事件该值固定为sys,表示该消息由系统生成 |
CreateTime | 消息创建时间 (整型) |
MsgType | 消息的类型,此时固定为event |
Event | 事件的类型,此时固定为change_external_contact |
ChangeType | 此时固定为del_external_contact |
UserID | 企业服务人员的UserID |
ExternalUserID | 外部联系人的userid,注意不是企业成员的帐号 |
Source | 删除客户的操作来源,DELETE_BY_TRANSFER 表示此客户是因在职继承自动被转接成员删除 |
删除跟进成员事件
参数 | 说明 |
---|---|
ToUserName | 企业微信CorpID |
FromUserName | 此事件该值固定为sys,表示该消息由系统生成 |
CreateTime | 消息创建时间 (整型) |
MsgType | 消息的类型,此时固定为event |
Event | 事件的类型,此时固定为change_external_contact |
ChangeType | 此时固定为del_follow_user |
UserID | 企业服务人员的UserID |
ExternalUserID | 外部联系人的userid,注意不是企业成员的帐号 |
客户接替失败事件
参数 | 说明 |
---|---|
ToUserName | 企业微信CorpID |
FromUserName | 此事件该值固定为sys,表示该消息由系统生成 |
CreateTime | 消息创建时间 (整型) |
MsgType | 消息的类型,此时固定为event |
Event | 事件的类型,此时固定为change_external_contact |
ChangeType | 此时固定为transfer_fail |
FailReason | 接替失败的原因, customer_refused-客户拒绝, customer_limit_exceed-接替成员的客户数达到上限 |
UserID | 接替失败的企业服务人员的UserID |
ExternalUserID | 外部联系人的userid,注意不是企业成员的帐号 |
如果此客户在企业内仍有其他在职的跟进人,则企业仍可以根据ExternalUserID调用“获取客户详情”读取详情,否则无法获取。
客户群创建事件
参数 | 说明 |
---|---|
ToUserName | 企业微信CorpID |
FromUserName | 此事件该值固定为sys,表示该消息由系统生成 |
CreateTime | 消息创建时间 (unix时间戳) |
MsgType | 消息的类型,此时固定为event |
Event | 事件的类型,此时固定为change_external_chat |
ChatId | 群ID |
ChangeType | 此时固定为create |
客户群变更事件
参数 | 说明 |
---|---|
ToUserName | 企业微信CorpID |
FromUserName | 此事件该值固定为sys,表示该消息由系统生成 |
CreateTime | 消息创建时间 (unix时间戳) |
MsgType | 消息的类型,此时固定为event |
Event | 事件的类型,此时固定为change_external_chat |
ChatId | 群ID |
ChangeType | 此时固定为update |
UpdateDetail | 变更详情。目前有以下几种: add_member : 成员入群 del_member : 成员退群 change_owner : 群主变更 change_name : 群名变更 change_notice : 群公告变更 |
JoinScene | 当是成员入群时有值。表示成员的入群方式 0 - 由成员邀请入群(包括直接邀请入群和通过邀请链接入群) 3 - 通过扫描群二维码入群 |
QuitScene | 当是成员退群时有值。表示成员的退群方式 0 - 自己退群 1 - 群主/群管理员移出 |
MemChangeCnt | 当是成员入群或退群时有值。表示成员变更数量 |
客户群解散事件
需注意的是,如果发生群信息变动,会立即收到此事件,但是部分信息是异步处理,可能需要等一段时间(例如2秒)调用获取客户群详情接口才能得到最新结果
参数 | 说明 |
---|---|
ToUserName | 企业微信CorpID |
FromUserName | 此事件该值固定为sys,表示该消息由系统生成 |
CreateTime | 消息创建时间 (unix时间戳) |
MsgType | 消息的类型,此时固定为event |
Event | 事件的类型,此时固定为change_external_chat |
ChatId | 群ID |
ChangeType | 此时固定为dismiss |
企业客户标签创建事件
参数 | 说明 |
---|---|
ToUserName | 企业微信CorpID |
FromUserName | 此事件该值固定为sys,表示该消息由系统生成 |
CreateTime | 消息创建时间 (unix时间戳) |
MsgType | 消息的类型,此时固定为event |
Event | 事件的类型, 此时固定为change_external_tag |
Id | 标签或标签组的ID |
TagType | 创建标签时,此项为tag ,创建标签组时,此项为tag_group |
ChangeType | 此时固定为create |
StrategyId | 标签或标签组所属的规则组id,只回调给“客户联系”应用 |
企业客户标签变更事件
参数 | 说明 |
---|---|
ToUserName | 企业微信CorpID |
FromUserName | 此事件该值固定为sys,表示该消息由系统生成 |
CreateTime | 消息创建时间 (unix时间戳) |
MsgType | 消息的类型,此时固定为event |
Event | 事件的类型,此时固定为change_external_tag |
Id | 标签或标签组的ID |
TagType | 变更标签时,此项为tag ,变更标签组时,此项为tag_group |
ChangeType | 此时固定为update |
StrategyId | 标签或标签组所属的规则组id,只回调给“客户联系”应用 |
企业客户标签删除事件
参数 | 说明 |
---|---|
ToUserName | 企业微信CorpID |
FromUserName | 此事件该值固定为sys,表示该消息由系统生成 |
CreateTime | 消息创建时间 (unix时间戳) |
MsgType | 消息的类型,此时固定为event |
Event | 事件的类型,此时固定为change_external_tag |
Id | 标签或标签组的ID |
TagType | 删除标签时,此项为tag ,删除标签组时,此项为tag_group |
ChangeType | 此时固定为delete |
StrategyId | 标签或标签组所属的规则组id,只回调给“客户联系”应用 |
企业客户标签重排事件
参数 | 说明 |
---|---|
ToUserName | 企业微信CorpID |
FromUserName | 此事件该值固定为sys,表示该消息由系统生成 |
CreateTime | 消息创建时间 (unix时间戳) |
MsgType | 消息的类型,此时固定为event |
Event | 事件的类型,此时固定为change_external_tag |
Id | 标签组的id,表示只有此标签组内的标签发生了重排,如果为空,则表示全部标签组顺序都发生了变化 |
StrategyId | 规则组id,如果修改了规则组标签的顺序,则回调时会带上此标签所属规则组的id |
ChangeType | 此时固定为shuffle |
修改于 2022-12-01 08:45:09