有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

ActivityDetail

活动详情

被如下接口引用:QueryActivityList。

名称 类型 描述
ActivityId Integer 活动id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1381619428653346818
ActivityName String 活动名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:留资活动
ActivityState Integer 活动状态,10:未开始状态、20:已开始(进行中)状态、30:已结束状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
ActivityType Integer 活动类型,100:留资活动
注意:此字段可能返回 null,表示取不到有效值。
示例值:100
StartTime Integer 活动开始时间戳,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618243200
EndTime Integer 活动结束时间戳,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618329600
MainPhoto String 活动主图
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://tmap-travel-didi-1255598736.cos.ap-guangzhou.myqcloud.co
PrivacyAgreementId String 协议编号
注意:此字段可能返回 null,表示取不到有效值。
示例值:1380815131099852801
UpdateTime Integer 活动更新时间戳,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1621500202
ActivityDataList String 活动数据列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{ "optionalCityCodeList": [

ActivityJoinDetail

活动参与详情

被如下接口引用:QueryActivityJoinList。

名称 类型 描述
ActivityId Integer 活动id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1381619428653346818
ActivityName String 活动名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:留资活动
SalesName String 销售姓名
注意:此字段可能返回 null,表示取不到有效值。
示例值:销售1
SalesPhone String 销售电话
注意:此字段可能返回 null,表示取不到有效值。
示例值:13000000000
JoinId Integer 参与id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1381612531432296450
LiveCodeId Integer 活码id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1381612531432296450
UserPhone String 用户电话
注意:此字段可能返回 null,表示取不到有效值。
示例值:13000000000
UserName String 用户姓名
注意:此字段可能返回 null,表示取不到有效值。
示例值:用户1
ActivityData String 活动数据
注意:此字段可能返回 null,表示取不到有效值。
示例值:"{"cityInfo":{"cityCode":"420100","cityName":"武汉市","p
LeadId Integer 线索id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1381612531432296450
JoinTime Integer 参与时间戳,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618329600
Duplicate Integer 线索是否是重复创建, 0 :新建、 1:合并、 2:重复, 默认为0
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
DuplicateLeadId Integer 重复线索id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1391954669730611201
JoinState Integer 是否为参与多次活动, 1:参与一次、2、参与多次,默认为0
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
CreateTime Integer 创建时间戳,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618329600
UpdateTime Integer 更新时间戳,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618329600

ArrivalInfo

发生过到店的潜客到店信息

被如下接口引用:QueryArrivalList。

名称 类型 描述
ClueId Integer 线索id
示例值:1348080105398452226
CustomerId Integer 客户id
示例值:1348080105398452226
UserName String 客户姓名
示例值:张三
Phone String 客户的手机号
示例值:134xxxx4321
FirstArrival Integer 是否首次到店,0否,1是
示例值:1
ArrivalTime Integer 到店时间
注意:此字段可能返回 null,表示取不到有效值。
示例值: 1618322621
EventType Integer 发生事件
示例值:1
EventTypeName String 发生事件名称
示例值:首次到店
FollowRecord String 跟进记录

ChannelCodeInnerDetail

渠道活码详情

被如下接口引用:QueryChannelCodeList。

名称 类型 描述
Id Integer 渠道活码id
示例值:1397103193143300098
Type Integer 欢迎语类型,0:普通欢迎语、1:渠道欢迎语
示例值:1
Source String 渠道来源
示例值:1
SourceName String 渠道来源名称
示例值:自然到店
Name String 二维码名称
示例值:测试企业标签的活码
UseUserIdList Array of Integer 使用成员用户id集
示例值:[ 1386218784692961300 ]
UseUserOpenIdList Array of String 使用成员企微账号id集
示例值:[ "544064e019b53e4791115020ffc68f33"
TagList Array of WeComTagDetail 标签
示例值:[ { "GroupName": "测试
SkipVerify Integer 自动通过好友,0:开启、1:关闭,默认0开启
示例值:0
Friends Integer 添加好友人数
示例值:0
Remark String 备注
示例值:备注
MsgId Integer 欢迎语id(通过欢迎语新增返回的id)
示例值:1397103192673538050
ConfigId String 联系我config_id
示例值:13ef26feea8c92e2b0c895db45987fb9
QrCodeUrl String 联系我二维码地址
示例值:https://wework.qpic.cn/wwpic/142302_fc9KKS9RSyS58cp_1621930333/0
RecStatus Integer 记录状态, 0:有效、1:无效
示例值:0
AppId String 应用ID
示例值:LXC

ChannelTag

客户渠道标签

被如下接口引用:QueryCustomerProfileList。

名称 类型 描述
TagName String 该客户档案当前已成功关联的渠道标签名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:标签名称
TagId String 该客户档案当前已成功关联的渠道标签的id
注意:此字段可能返回 null,表示取不到有效值。
示例值:etAJ2GCAAAXtWyujaWJHDDGi0mACHAAA

ChatArchivingDetail

会话存档数据详情

被如下接口引用:QueryChatArchivingList。

名称 类型 描述
MsgId String 消息id
Action String 动作名称,switch表示切换企微账号,send表示企微普通消息
示例值:switch, send
MsgType String 消息类型,当Action != "switch"时存在,例如video, text, voice 等,和企微开放文档一一对应
https://open.work.weixin.qq.com/api/doc/90000/90135/91774
注意:此字段可能返回 null,表示取不到有效值。
示例值:video, text, voice
From String 消息发送人
注意:此字段可能返回 null,表示取不到有效值。
ToList Array of String 消息接收人列表,注意接收人可能只有一个
注意:此字段可能返回 null,表示取不到有效值。
示例值:["xx"]
RoomId String 如果是群消息,则不为空
注意:此字段可能返回 null,表示取不到有效值。
示例值:roomId
MsgTime Integer 消息发送的时间戳,单位为秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1621496513
Video ChatArchivingMsgTypeVideo MsgType=video时的消息体,忽略此字段,见BodyJson字段
注意:此字段可能返回 null,表示取不到有效值。
BodyJson String 根据MsgType的不同取值,解析内容不同,参考:https://open.work.weixin.qq.com/api/doc/90000/90135/91774
注意:此字段可能返回 null,表示取不到有效值。
示例值:{}

ChatArchivingMsgTypeVideo

会话存档的视频消息类型

被如下接口引用:QueryChatArchivingList。

名称 类型 描述
PlayLength Integer 视频时长,单位秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:4
FileSize Integer 文件大小
注意:此字段可能返回 null,表示取不到有效值。
示例值:645990
CosKey String 视频资源对象Cos下载地址
示例值:http://xx

ClueInfoDetail

线索信息详情

被如下接口引用:QueryClueInfoList。

名称 类型 描述
ClueId String 线索id,线索唯一识别编码
示例值:1348080105398452226
DealerId String 接待客户经销商顾问所属经销商code
示例值:P1234
EnquireTime Integer 线索获取时间,用户添加企业微信时间,单位是秒
示例值:1618556502
UnionId String 客户在微信生态中唯一识别码
示例值:ozynqsulJFCZ2z1aYeS8h
Name String 微信昵称
示例值:文
Phone String 联系方式
示例值:134xxxx3232
SeriesCode String 车系编号
ModelCode String 车型编号
ProvinceCode String 省份编号
CityCode String 城市编号
SalesName String 顾问名称
示例值:张三
SalesPhone String 顾问电话
示例值:134xxxx4321
Remark String 备注
示例值:备注
TagList Array of String 标签
示例值:["标签1","标签2"]
UserName String 客户姓名
注意:此字段可能返回 null,表示取不到有效值。
示例值:李四
LeadUserType Integer 线索属性,0:个人,1:企业
示例值:0
LeadType Integer 线索来源类型,1:线上,2:线下
示例值:1
ChannelId Integer 线索渠道对应ID
示例值:1
ChannelName String 线索渠道类型,与线索来源对应的渠道名称
示例值:渠道1
SourceChannelName String 线索渠道名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:渠道1
Gender Integer 0:未知,1:男,2:女
示例值:1
CreateTime String 线索创建时间戳,单位:秒
示例值:1618322621
UpdateTime String 线索创建时间戳,单位:秒
LeadStatus Integer 线索所处状态,101-待分配 201-待建档 301-已建档 401-已邀约 501-跟进中 601-已下订单 701-已成交 801-战败申请中 901-已战败 1001-未知状态 1101-转移申请中 1201-已完成
示例值:101
LevelCode String 线索意向等级
示例值:101
ImportAtTime Integer 线索成功导入的时间戳,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
DistributeTime Integer 完成线索分配的时间戳,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
CreateAtTime Integer 获取线索的时间戳,单位:秒
示例值:1618322621
WxId String 客户微信id
BrandCode String 意向车型对应品牌code
BuildTime Integer 建档时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
OrderTime Integer 下订时间,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
ArrivalTime Integer 到店时间,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
DeliveryTime Integer 交车时间,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
FollowTime Integer 上次跟进时间,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
NextFollowTime Integer 下次跟进时间,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
OrgId Integer 线索所属组织id
示例值:1
OrgName String 线索所属组织名称
示例值:org1
Introducer String 介绍人姓名
示例值:introducer
IntroducerPhone String 介绍人电话
示例值:134xxxx4321
IsBindWx Integer 是否关联微信 1 是 0 否
示例值:1
IsMerge Integer 是否经过合并 1 是 0 否
示例值:1
IsInvalid Integer 是否无效 1 是 0 否
示例值:0
InvalidType String 无效类型
示例值:1
InvalidTypeName String 无效类型枚举:
无意向购买、空错号、未接听、其他
示例值:空错号
InvalidRemark String 由顾问手动输入的无效原因文字
InvalidTime Integer 无效时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
DealerName String 经销商名称
示例值:dealer1
ShopId Integer 经销商下级门店ID
示例值:1234567890
ShopName String 经销商下级门店名称
示例值:shop1
Position String 职位
示例值:销售
CorpShopId String 自定义的门店id
示例值:S1234

CorpUserInfo

企业成员信息

被如下接口引用:QueryUserInfoList。

名称 类型 描述
UserId Integer 企业成员UserId
示例值:1323253932850728968
UserName String 企业成员在SaaS名片内填写的姓名
注意:此字段可能返回 null,表示取不到有效值。
示例值:杨过
UserOpenId String 企业成员在企微原生通讯录内的id
注意:此字段可能返回 null,表示取不到有效值。
示例值:YangGuo
DealerId Integer 成员所属经销商id,可为空
注意:此字段可能返回 null,表示取不到有效值。
示例值:1438427185617956866
ShopId Integer 成员所属门店id,可为空
注意:此字段可能返回 null,表示取不到有效值。
示例值:1381564121059749890
Phone String 企业成员手机号
注意:此字段可能返回 null,表示取不到有效值。
示例值:134****1234
OrgIds String 成员所属部门id列表,仅返回该应用有查看权限的部门id;成员授权模式下,固定返回根部门id,即固定为1;多个部门使用逗号分割
注意:此字段可能返回 null,表示取不到有效值。
示例值:3,5
MainDepartment String 主部门,仅当应用对主部门有查看权限时返回
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
IsLeaderInDept String 是否为部门负责人,第三方应用可为空。与orgIds值一一对应,多个部门使用逗号隔开,0-否, 1-是
注意:此字段可能返回 null,表示取不到有效值。
示例值:0,1
Status Integer 激活状态: 0=已激活,1=已禁用,-1=退出企业"
示例值:0
JobNumber String 工号
注意:此字段可能返回 null,表示取不到有效值。
示例值:12345678

CrmStatisticsData

CRM统计数据响应

被如下接口引用:QueryCrmStatistics。

名称 类型 描述
LeadCnt Integer 新增线索
示例值:10
BuildCnt Integer 新增建档
示例值:5
InvitedCnt Integer 新增到店
示例值:1
OrderedCnt Integer 新增下订
示例值:5
DeliveredCnt Integer 新增成交
示例值:10
DefeatCnt Integer 新增战败
示例值:3
NewContactCnt Integer 新增好友
示例值:2
StatisticalTime String 统计时间, 单位:天
示例值:2022-11-11

CustomerActionEventDetail

外部联系人SaaS使用明细数据

被如下接口引用:QueryCustomerEventDetailStatistics。

名称 类型 描述
EventCode String 事件码
示例值:1000
EventType Integer 事件类型
示例值:1
EventSource Integer 事件来源
示例值:1
ExternalUserId String 外部联系人id
示例值:wmQIM2CwAAL1ZKqK-icQG9XAMa3AhP-A
SalesId Integer 销售顾问id
示例值:1323253932850728968
MaterialType Integer 素材类型
示例值:1
MaterialId Integer 素材编号id
示例值:1348495383617208321
EventTime Integer 事件上报时间,单位:秒
示例值:1647423519

CustomerProfile

潜客客户档案信息

被如下接口引用:QueryCustomerProfileList。

名称 类型 描述
CustomerId Integer 客户档案id,客户唯一识别编码
示例值:1234567890
DealerCode String 所属经销商id
UnionId String 客户在微信生态中唯一识别码
示例值:ozynqsulJFCZ2z1aYeS8h
CreateTime String 档案创建时间戳,单位:秒
示例值:2023-01-01 00:00:00
UserName String 客户姓名
示例值:张三
Gender Integer 0未知,1:男,2:女
示例值:1
Phone String 客户联系手机号
示例值:123****4567
AgeRangeName String 客户年龄段名称
示例值:26-30
JobTypeName String 客户行业类型名称信息,如教师、医生
Address String 客户居住地址
示例值:地址1
LeadsProcessStatus Integer 客户所处状态
0:已分配 1:未分配 1 待建档, 2 已建档, 3 已到店 4 已经试驾 5 战败申请中 6 已战败 7 已成交
示例值:0
LeadType Integer 客户来源类型,1:线上,2:线下
示例值:1
SourceName String 与客户来源类型对应的渠道名称
示例值:自然到店
LeadsLevelCode String 客户购车的意向等级
示例值:101
VehicleBrandCode String 客户意向品牌编号
示例值:品牌编号
VehicleSeriesCode String 客户意向车系编号
示例值:车系编号
VehicleTypeCode String 客户意向车型编号
示例值:车型编号
VehiclePurpose VehiclePurpose 购车用途信息
PurchaseConcern Array of PurchaseConcern 购车关注点信息
SalesName String 客户所属顾问姓名
示例值:张三
SalesPhone String 客户所属顾问手机号
示例值:123****4567
RealArrivalTime Integer 客户实际到店时间戳,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
CompleteTestDriveTime String 客户到店完成试乘试驾时间戳,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:2023-01-01 00:00:00
OrderTime Integer 客户完成下订的时间戳,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
DeliveryTime Integer 客户成交的时间戳,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
InvoiceTime Integer 开票时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
LoseTime Integer 完成对此客户战败审批的时间戳,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
CreatedAtTime Integer 线索成功获取的时间戳,单位:秒
示例值:1618322621
ImportAtTime Integer 线索成功导入的时间戳,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
DistributeTime Integer 完成线索分配的时间戳,单位:秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
LeadCreateTime Integer 线索成功创建的时间戳,单位:秒
示例值:1618322621
Nickname String 线索关联微信昵称
示例值:jack
OrgIdList Array of String 线索归属部门节点
示例值:["1", "2"]
Introducer String 客户的介绍人姓名
注意:此字段可能返回 null,表示取不到有效值。
示例值:李四
IntroducerPhone String 客户的介绍人手机号码
注意:此字段可能返回 null,表示取不到有效值。
示例值:123****4567
FollowTime Integer 最近一次完成跟进的时间戳,单位:秒
示例值:1618322621
NextFollowTime Integer 最近一次计划跟进的时间戳,单位:秒
示例值:1618322621
EnterpriseTags Array of EnterpriseTag 已为该客户添加的企业标签信息
注意:此字段可能返回 null,表示取不到有效值。
ChannelTags Array of ChannelTag 已为该客户添加的渠道标签信息
注意:此字段可能返回 null,表示取不到有效值。
LeadId Integer 关联线索id
WxId String 客户微信id
Position String 顾问职位
IsBindWx Integer 是否关联微信 1 是 0 否
IsInvalid Integer 是否无效
InvalidType String 无效类型
InvalidTypeName String 无效类型名称
InvalidTime Integer 无效时间
注意:此字段可能返回 null,表示取不到有效值。
InvalidRemark String 由顾问手动输入的无效原因文字
IsLose Integer 线索是否战败
LoseType String 战败类型
LoseTypeName String 战败类型名称
LoseRemark String 战败申请原因

DealerInfo

经销商信息

被如下接口引用:QueryDealerInfoList。

名称 类型 描述
DealerId Integer 企微SaaS平台经销商id
示例值:1438393844623261698
DealerName String 经销商名称
示例值:深圳神车经销商
ProvinceCode String 所属省份编号
注意:此字段可能返回 null,表示取不到有效值。
示例值:110100
CityCodeList Array of String 所属城市编号列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[110100]
BrandIdList Array of String 业务覆盖品牌id列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[1,2]

EnterpriseTag

客户企业标签

被如下接口引用:QueryCustomerProfileList。

名称 类型 描述
GroupName String 该客户档案当前已成功关联的企业标签分组名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:标签分组名称
TagName String 该客户档案当前已成功关联的企业标签名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:标签名称
TagId String 该客户档案当前已成功关联的企业标签的id
注意:此字段可能返回 null,表示取不到有效值。
示例值:etAJ2GCAAAXtWyujaWJHDDGi0mACHAAA

ExternalContact

客户信息

被如下接口引用:QueryExternalContactDetail, QueryExternalContactDetailByDate。

名称 类型 描述
ExternalUserId String 外部联系人的userId
示例值:wmQIM2CwAAE-JSOVGMzsRayI3ow5kGzQ
Gender Integer 外部联系人性别 0-未知 1-男性 2-女性
示例值:1
Name String 外部联系人的名称
示例值:文
Type Integer 外部联系人的类型,1表示该外部联系人是微信用户,2表示该外部联系人是企业微信用户
示例值:1
UnionId String 外部联系人在微信开放平台的唯一身份标识(微信unionid),通过此字段企业可将外部联系人与公众号/小程序用户关联起来。仅当联系人类型是微信用户,且企业或第三方服务商绑定了微信开发者ID有此字段。
注意:此字段可能返回 null,表示取不到有效值。
示例值:ozynqsulJFCZ2z1aYeS8h-nuasdAAA
Phone String 外部联系人联系电话
注意:此字段可能返回 null,表示取不到有效值。
示例值:134****3232

ExternalContactDetailPro

具备更多信息的外部联系人详细信息

被如下接口引用:QueryExternalContactDetailByDate。

名称 类型 描述
Customer ExternalContact 客户信息
注意:此字段可能返回 null,表示取不到有效值。
FollowUser Array of FollowUserPro 添加了此外部联系人的企业成员信息
注意:此字段可能返回 null,表示取不到有效值。

ExternalContactSimpleInfo

外部联系人简短信息

被如下接口引用:QueryExternalContactList。

名称 类型 描述
ExternalUserId String 外部联系人的userId
示例值:woAJ2GCAAAXtWyujaWJHDDGi0mACAAA
UserId String 添加了此外部联系人的企业成员userId
示例值:yangGuo
SalesName String 添加了此外部联系人的企业成员的姓名
注意:此字段可能返回 null,表示取不到有效值。
示例值:销售名称
DepartmentIdList Array of Integer 添加了此外部联系人的企业成员的归属部门id列表
示例值:[0,1]

ExternalContactTag

外部联系人标签

被如下接口引用:QueryExternalContactDetail, QueryExternalContactDetailByDate。

名称 类型 描述
GroupName String 该成员添加此外部联系人所打标签的分组名称(标签功能需要企业微信升级到2.7.5及以上版本)
注意:此字段可能返回 null,表示取不到有效值。
示例值:标签分组名称
TagName String 该成员添加此外部联系人所打标签名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:标签名称
Type Integer 该成员添加此外部联系人所打标签类型, 1-企业设置, 2-用户自定义
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TagId String 该成员添加此外部联系人所打企业标签的id,仅企业设置(type为1)的标签返回
注意:此字段可能返回 null,表示取不到有效值。
示例值:etAJ2GCAAAXtWyujaWJHDDGi0mACHAAA

ExternalUserEventInfo

外部联系人事件信息

被如下接口引用:QueryExternalUserEventList。

名称 类型 描述
EventCode String 事件编码, 添加外部联系人(ADD_EXTERNAL_CUSTOMER)/成员删除外部联系人(DELETE_EXTERNAL_CUSTOMER)/外部联系人删除成员(DELETE_FOLLOW_USER)
示例值:ADD_EXTERNAL_CUSTOMER
ExternalUserId String 外部联系人id
示例值:woQIM2CwAA8BPLSVDDBZUYIlviX3_9DQ
SalesId String 企微SaaS的成员id
示例值:1323253932850728968
EventTime Integer 事件上报时间戳,单位:秒
示例值:1614923098

ExternalUserMappingInfo

外部联系人映射信息

被如下接口引用:QueryExternalUserMappingInfo。

名称 类型 描述
CorpExternalUserId String 企业主体对应的外部联系人userId
示例值:wmQIM2CwAAywHqH07voRw9iuAAA09eQ
ExternalUserId String 乐销车应用主体对应的外部联系人, 当不存在好友关系时,该字段值为空
注意:此字段可能返回 null,表示取不到有效值。
示例值:wmQIM2CwAAywHqH07voRw9feafe9eQ

FollowInfo

发生过跟进的潜客信息

被如下接口引用:QueryFollowList。

名称 类型 描述
ClueId Integer 线索id
示例值:1348080105398452226
CustomerId Integer 客户档案id
示例值:1348080105398452226
UserName String 客户姓名
示例值:张三
Phone String 客户的手机号
示例值:134xxxx4321
IsOverdue Integer 是否逾期
示例值:0
OverdueTime Integer 逾期时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
EventType Integer 发生事件
示例值:1
EventTypeName String 发生事件名称
示例值:再次到店
FollowWayType String 跟进方式
示例值:1
FollowWayName String 跟进方式名称
示例值:线上跟进
FollowTime Integer 本次跟进时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
NextFollowTime Integer 下次跟进时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1618322621
FollowRecord String 跟进记录

FollowUser

添加了此外部联系人的企业成员信息

被如下接口引用:QueryExternalContactDetail。

名称 类型 描述
UserId String 添加了此外部联系人的企业成员userid
示例值:rocky
Remark String 该成员对此外部联系人的备注
注意:此字段可能返回 null,表示取不到有效值。
示例值:备注
Description String 该成员对此外部联系人的描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:描述
CreateTime Integer 该成员添加此外部联系人的时间戳,单位为秒
示例值:1618322621
AddWay Integer 该成员添加此客户的来源,具体含义详见来源定义
示例值:1
OperUserId String 发起添加的userid,如果成员主动添加,为成员的userid;如果是客户主动添加,则为客户的外部联系人userid;如果是内部成员共享/管理员分配,则为对应的成员/管理员userid
示例值:wmQIM2CwAAE-JSOVGMzsRayI3ow5kGzQ
Tags Array of ExternalContactTag 该成员添加此外部联系人所打标签信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]

FollowUserPro

具备更多信息的添加了此外部联系人的企业成员信息

被如下接口引用:QueryExternalContactDetailByDate。

名称 类型 描述
UserId String 添加了此外部联系人的企业成员userid
示例值:rocky
Remark String 该成员对此外部联系人的备注
注意:此字段可能返回 null,表示取不到有效值。
示例值:备注
Description String 该成员对此外部联系人的描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:描述
CreateTime Integer 该成员添加此外部联系人的时间戳,单位为秒
示例值:1618322621
AddWay Integer 该成员添加此客户的来源,具体含义详见来源定义
示例值:0
OperUserId String 发起添加的userid,如果成员主动添加,为成员的userid;如果是客户主动添加,则为客户的外部联系人userid;如果是内部成员共享/管理员分配,则为对应的成员/管理员userid
示例值:wmQIM2CwAAE-JSOVGMzsRayI3ow5kGzQ
Tags Array of ExternalContactTag 该成员添加此外部联系人所打标签信息
注意:此字段可能返回 null,表示取不到有效值。
SalesName String 添加了此外部联系人的企业成员的姓名
注意:此字段可能返回 null,表示取不到有效值。
示例值:张三
DepartmentIdList Array of Integer 企业成员的归属部门id列表
示例值:[1,2,3]

LicenseInfo

license相关信息

被如下接口引用:QueryLicenseInfo。

名称 类型 描述
License String license编号
示例值:A1c0tVAAAGSB1
LicenseEdition Integer license版本;1-基础版,2-标准版,3-增值版
示例值:1
ResourceStartTime String 生效开始时间, 格式yyyy-MM-dd HH:mm:ss
示例值:2021-07-01 00:00:00
ResourceEndTime String 生效结束时间, 格式yyyy-MM-dd HH:mm:ss
示例值:2022-07-01 00:00:00
IsolationDeadline String 隔离截止时间, 格式yyyy-MM-dd HH:mm:ss
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-07-08 00:00:00
DestroyTime String 资源计划销毁时间, 格式yyyy-MM-dd HH:mm:ss
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-07-15 00:00:00
Status Integer 资源状态,1.正常,2.隔离,3.销毁
示例值:1
Extra String 扩展信息
注意:此字段可能返回 null,表示取不到有效值。

LiveCodeDetail

活动活码详情

被如下接口引用:QueryActivityLiveCodeList。

名称 类型 描述
LiveCodeId Integer 活码id
示例值:1381612531432296450
LiveCodeName String 活码名称
示例值:留资活动活码
ShortChainAddress String 短链url
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://aggretrip.map.qq.com/wework_saas/dist/index.html?wexin_t
LiveCodePreview String 活码二维码
注意:此字段可能返回 null,表示取不到有效值。
示例值:https://aggretrip.map.qq.com/wework_saas/dist/index.html?wexin_t
ActivityId Integer 活动id
示例值:1381619428653346818
ActivityName String 活动名称
示例值:留资活动名称
LiveCodeState Integer 活码状态,-1:删除,0:启用,1禁用,默认为0
示例值:0
LiveCodeData String 活码参数,每个活码参数都是不一样的, 这个的值对应的是字符串json类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"channel": { "chan
CreateTime Integer 创建时间戳,单位为秒
示例值:1621496513
UpdateTime Integer 更新时间戳,单位为秒
示例值:1621496513

MaterialInfo

素材信息响应体

被如下接口引用:QueryMaterialList。

名称 类型 描述
MaterialId Integer 素材id
示例值:1348481184631488514
MaterialName String 素材名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:图片名称
Status Integer 素材状态, -1: 删除 0: 启用 1: 禁用
示例值:0

MiniAppCodeInfo

小程序码信息

被如下接口引用:QueryMiniAppCodeList。

名称 类型 描述
Id Integer 主键id
示例值:30
MiniAppName String 小程序名称
示例值:小程序名称
MiniAppLogo String 小程序logo
示例值:https://xxx.jpg
MiniAdminUrl String 小程序管理端地址
示例值:https://www.xxx.com
State Integer 状态:0正常,1删除
示例值:0
CreateTime Integer 创建时间戳,单位为秒
示例值:1621496513
UpdateTime Integer 更新时间戳,单位为秒
示例值:1621496513

PurchaseConcern

购车关注点

被如下接口引用:QueryCustomerProfileList。

名称 类型 描述
Code String 购车关注点code
Description String 购车关注点描述

SalesActionEventDetail

企业成员SaaS使用明细数据

被如下接口引用:QueryStaffEventDetailStatistics。

名称 类型 描述
EventCode String 事件码
示例值:1000
EventType Integer 事件类型
示例值:1
EventSource Integer 事件来源
示例值:1
SalesId Integer 销售顾问id
示例值:1323253932850728968
MaterialType Integer 素材类型
示例值:1
MaterialId Integer 素材编号id
示例值:1348495383617208321
EventTime Integer 事件上报时间,单位:秒
示例值:1647423519

TagDetailInfo

标签详细信息

被如下接口引用:CreateCorpTag。

名称 类型 描述
TagName String 标签名称
示例值:标签名称
BizTagId String 标签业务ID
示例值:1394843909254754300
TagId String 企微标签ID
示例值:etQIM2CwAA6_HurtDtzSyK68jfiaX0UQ
Sort Integer 标签排序的次序值,sort值大的排序靠前。有效的值范围是[0, 2^32)
示例值:0
CreateTime Integer 标签创建时间,单位为秒
示例值:1621500202

TagGroup

标签组信息

被如下接口引用:CreateCorpTag。

名称 类型 描述
GroupId String 企微标签组id
示例值:etQIM2CwAAbJ-IpFWKlyEHrWD1Z6qYkw
BizGroupId String 标签组业务id
示例值:1348107208961921026
GroupName String 企微标签组名称,不能超过15个字符
示例值:组名
Sort Integer 标签组次序值。sort值大的排序靠前。有效的值范围是[0, 2^32)
示例值:1
CreateTime Integer 标签组创建时间,单位为秒
示例值:1621500202
Tags Array of TagDetailInfo 标签组内的标签列表, 上限为20

TagInfo

标签信息

被如下接口引用:CreateCorpTag。

名称 类型 必选 描述
TagName String 标签名称, 最大长度限制15个字符
示例值:标签名称
Sort Integer 标签组排序,值越大,排序越靠前
示例值:1

VehicleInfo

车型车系信息

被如下接口引用:QueryVehicleInfoList。

名称 类型 描述
BrandId Integer 品牌id
示例值:1334702033519960066
BrandName String 品牌名称
示例值:品牌名称
SeriesId Integer 车系id
示例值:1334702033528348674
SeriesName String 车系名称
示例值:车系名称
ModelId Integer 车型id
示例值:1334740794876203009
ModelName String 车型名称
示例值:车型名称

VehiclePurpose

购车用途详细信息

被如下接口引用:QueryCustomerProfileList。

名称 类型 描述
VehiclePurposeCode String 购车用途code
VehiclePurposeName String 购车用途名称

WeComTagDetail

企微个人标签信息,渠道活码使用

被如下接口引用:CreateChannelCode, QueryChannelCodeList。

名称 类型 必选 描述
GroupName String 标签分组名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:测试111
BizGroupId String 标签分组业务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1394843720913727500
TagName String 标签名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:涛涛涛涛涛涛涛涛涛涛涛涛涛11
TagId String 标签ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:etQIM2CwAA6_HurtDtzSyK68jfiaX0UQ
BizTagId String 标签业务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1394843909254754300
Type Integer 标签分类,1:企业设置、2:用户自定义
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
BizTagIdStr String 标签业务ID字符串格式
注意:此字段可能返回 null,表示取不到有效值。
示例值:1394843909254754300