jing-openplatform-api
  1. 线索(Lead)
jing-openplatform-api
  • 开放接口-V1文档
    • 开发前必读(Must Read Before Development)
      • 接口更新日志
      • 接入指南(Access Guide)
      • 接口权限(Interface Permissions)
      • 访问频率和并发限制(Access Frequency & Concurrency Restrictions)
      • 全局错误码说明(Global Error Code Description)
    • OAuth授权(Authorization)
      • 获取访问Token(Get Access Token)
      • 刷新 Token(Refresh Token)
    • 用户管理(User Management)
      • 用户批量创建(User Creation)
      • 用户查询(User Query)
      • 用户批量更新(User Update)
      • 批量查询用户身份
    • 用户群组
      • 查询静态人群列表
      • 获取静态人群详情
      • 查询静态人群详情用户列表
      • 创建静态人群
      • 更新静态人群
      • 删除静态人群
      • 导入群组用户
    • 用户标签(User Tags)
      • 批量创建普通标签(Batch Creating Tags)
      • 批量给用户打标签(Batch Tagging Users)
      • 查询普通标签
      • 移除用户标签
    • 活动管理
      • 查询活动详情
      • 查询活动列表
      • 查询活动报名用户列表
      • 批量更新活动用户状态
    • 邮件管理
      • 查询邮箱列表
      • 创建发送邮件
      • 查询发送邮件详情
      • 更新发送邮件
      • 删除发送邮件
      • 查询发送邮件列表
      • 查询发送明细
    • 短信管理
      • 查询短信列表
      • 查询短信发送详情
      • 创建任务
      • 发送
    • 来源管理
      • 查询来源选项
      • 创建自定义来源选项
      • 更新自定义来源选项
      • 查询来源下所有选项
    • 二维码管理
      • 创建临时二维码
      • 创建永久二维码
    • 会员管理
      • 会员创建
      • 会员查询
      • 会员更新
      • 查询会员剩余积分
      • 查询会员规则列表
      • 查询会员列表
      • 扣减会员积分
      • 增加会员积分
    • 成员管理
      • 查询成员信息(Query Member Information)
    • 微信公众号
      • 发送微信模版消息
      • 获取用户的openid和关注状态
    • 线索管理(Lead Management)
      • 线索创建(Lead Creation)
      • 线索更新(Lead Update)
      • 线索查询(Lead Query)
      • 线索状态列表查询(Get Lead Status List)
      • 线索状态更新(Get Status Update)
      • 线索布局列表查询(Lead List)
      • 更新线索协作人(Update Lead Collaborators)
      • 查询线索详情链接(Query Lead Details Link)
    • 客户管理(Account Management)
      • 客户创建(Account Creation)
      • 客户查询(Account Query)
      • 客户更新(Account Update)
      • 客户布局列表查询(Account List)
    • CRM 对象通用接口(CRM Object Interface)
      • 查询业务类型列表(Get Business Type)
      • 查询选项集字段(Get Option Set Fields)
      • 查询来源选项字段(获取下拉选项)(Source Field Type (Get Drop-down Options))
      • 查询自定义选项字段(Get Custom Option Set Fields)
      • 查询对象所有字段(Get All Fields of the Object)
    • CTA管理
      • 查询CTA列表
      • 查询CTA明细列表
    • 模板消息
      • 创建模版消息
      • 创建模板消息推送
      • 更新模板消息
      • 查询模版消息详情
      • 删除模版消息
      • 查询模板消息列表
      • 查询微信模板列表
      • 查询消息模板推送明细
      • 查询消息模板点击明细
      • 查询模板消息推送记录列表
    • 隐私条款v1(Privacy Policy)
      • 查询隐私条款列表(Query Privacy Policy List)
      • 查询隐私条款授权记录列表(Query Privacy Policy Authorization Record List)
    • 隐私条款v2
      • 查询隐私条款列表
      • 新增用户授权记录
      • 查询用户授权状态
      • 移除用户授权记录
      • 查询隐私条款模版
    • 企业微信
      • 发送企微应用消息(Send WeCom App Message)
      • 获取用户的企微好友状态(Get User's WeCom Friendship Status )
    • 评分管理
      • 批量查询用户意向评分
      • 批量查询用户行为评分
      • 批量查询线索身份评分
      • 批量查询线索行为评分
      • 批量查询线索意向评分
      • 批量查询用户身份评分
      • 批量用户行为评分清零
    • 自定义事件
      • 创建自定义事件
      • 上报自定义事件
    • 公司管理
      • 批量创建公司
      • 批量更新公司
      • 批量删除公司
      • 批量获取公司列表
  • webhook
    • 用户(User)
      • 用户创建(User Creation)
      • 创建用户webhook推送事件(Create Push Events of User webhook)
        • add_omni_user_success事件(add_omni_user_success event)
      • 修改用户webhook推送事件
        • custom_field事件(修改用户信息)
    • 活动
      • 创建活动
        • 活动webhook-直播
        • 活动webhook-会议
      • 更新活动
        • 更改直播活动webhook
        • 更改会议活动webhook
      • 删除活动
        • 删除直播活动webhook
        • 删除会议活动webhook
    • 线索(Lead)
      • 线索事件说明文档(Description Document of Lead Event)
      • 创建线索webhook推送事件(Create Push Events of User webhook)
        • add_omni_user_success事件(add_omni_user_success event)
        • object_create事件(object_create event)
        • object_update_life_cycle事件(object_update_life_cycle event)
        • object_source_info事件(object_source_info event)
      • 线索更新(Lead Update)
        • object_update_life_cycle事件(object_update_life_cycle event)
        • object_update事件(object_update event)
      • 线索状态更新(Lead Update Status)
        • object_update_status事件(object_update_status event)
      • 线索作废(Lead Voided)
        • object_voids事件(object_voids event)
      • 线索负责人变更(Lead Owner Change)
        • object_change_owner事件(不包含线索信息)(object_change_owner event (without lead information))
        • object_change_owner事件(包含线索信息,需要平台人员手动配置启用)
      • 线索生命周期变更(Lead Lifecycle Change)
        • object_update_life_cycle事件(object_update_life_cycle event)
      • 线索添加备注(Lead Add Notes)
        • object_add_notes事件(object_add_notes event)
      • 线索添加协作人(Lead Add Collaborator)
        • object_add_team_member事件(object_add_team_member event)
      • 线索移除协作人(Lead Remove Collaborator)
        • object_remove_team_member事件(object_remove_team_member event)
      • 公海池变更(Lead Pool Change)
        • object_change_lead_pool事件(object_change_lead_pool event)
      • 线索关联(Lead Association)
        • object_relation事件(object_relation event)
      • 线索恢复(Lead Restore)
        • object_restore事件(object_restore event)
      • 线索来源 (Lead Source)
        • 线索来源(Lead Source)
    • 客户(Account)
      • 客户(Account)
      • 客户webhook推送(Account webhook Push)
        • 创建客户(Create Account)
          • object_create事件-客户(object_create event-Account)
        • 更新客户(Update Account)
          • object_update事件-客户(object_update event-Account)
        • 客户负责人变更(Object_Change_Owner)
          • object_change_owner事件-客户(object_change_owner event-Account)
        • 客户作废(object_voids)
          • object_voids事件-客户(object_voids event-Account)
        • 客户关联线索(object_relation)
          • object_relation事件-客户(object_relation event-Account)
    • 模板消息(Template Message)
      • 点击模板消息
      • 模板消息推送成功(Template Send Success)
      • 模板消息推送失败(Template Send Error)
      • 模板消息推送通知(Template Message Push Notification)
        • template_send事件(template_send event)
    • Jingtrack
      • JINGtrack-H5
        • 访问页面(pageView)
        • 自定义事件(customEvent)
      • JINGtrack-小程序
        • 访问页面 (小程序)(View Page)
          • pages/store/detail/detail事件(pages/store/detail/detail event)
        • 小程序自定义事件(tracking_customevent)
          • RemoveFromCart事件(RemoveFromCart Event)
        • 打开小程序(Open Mini Program)
          • tracking_vst事件(tracking_vst event)
        • 关闭小程序(Close Mini Program)
          • tracking_cls事件(tracking_cls event)
    • 评分(Scoring)
      • 身份等级变更(Identity Grade Updated)
        • 身份等级变更事件(custom_field_update event)
      • 行为等级变更(Active Level Update)
        • 行为等级变更事件(total_update event)
    • 用户行为(User Action)
      • 活动用户行为
        • 提交活动报名信息
      • CTA用户行为
        • CTA提交信息
      • 用户标签行为
        • 用户打标签
      • 授权隐私条款行为
        • 授权隐私条款(Authorized Privacy Policy)
    • 系统行为(System Action)
      • 活动系统行为
        • 活动报名用户状态变更(Change Activity Registered User Status)
  1. 线索(Lead)

线索事件说明文档(Description Document of Lead Event)

  • 返回字段说明
字段 解释
mid 租户Id
event_category 行为分类
event_type 行为的类型
action_keyword 具体的行为(大部分情况event_type和action_keyword保持一致,变更负责人行为除外(分 手动分配-manual_distribution、 自动分配-auto_distribution、 ) )
create_time 行为创建时间
extra_data 行为数据
字段 解释
object_id 对象Id
object_name 对象code,如:lead , account
entity_id 对象实体id,如线索uuid,客户uuid
operator_type 操作者类型,0 - 无操作人 1 - 后台登录用户 2 - 成员
operator_id 操作者id
omni_user_uuid 操作者绑定的成员对应的用户id
is_follow_up 是否为跟进行为:1-是 0-否
notes 备注
login_platform 登陆的平台,如member_center,jingsocial
login_source_value 登陆的渠道信息,如微信号对应的app_id
login_source_type 登陆的渠道类型,如jingmodule,wechat,workwechat_user
login_environment 登陆的环境,如pc,mobile
business_type 业务类型uuid
created_timestamp 行为的创建时间
owner 当前负责人uuid
life_status 当前所处的生命周期阶段
lead_omni_user_uuid 线索对应的用户id
mapping_data 变更字段的value"name": ["张三", "张三二"],//第一个变更钱,第二个变更后
字段 解释
name 解释
business_type 解释
first_name 解释
last_name 解释
last_name 解释
mobile 解释
email 解释
company_id 解释
country_region 解释
industry 解释
department 解释
account_id 解释
title 解释
official_website 解释
life_status 解释
lead_pool 解释
market 解释
to_baby_lead_timestamp 解释
mapping_data_text 变更字段的label
字段 解释
name 解释
business_type 解释
first_name 解释
last_name 解释
last_name 解释
mobile 解释
email 解释
company_id 解释
country_region 解释
industry 解释
department 解释
account_id 解释
title 解释
official_website 解释
life_status 解释
lead_pool 解释
market 解释
to_baby_lead_timestamp 解释
former_owner 前负责人uuid
former_owner_name 前负责人的名称
scene_type 负责人变更的场景类型:1-自动分配 2-手动分配 3-公海池认领 4-手动退回,5-自动回收,6-查重合并
entity_change_mapping 前后信息对比,比如 负责人变更行为的前后负责人的信息对比
from_leads_status 前线索状态uuid
to_leads_status 当前线索状态uuid
members 协作人的uuid(s)
from_life_status 上一个生命周期阶段
to_life_status 下一个生命周期阶段
from_lead_pool 变更前公海池
to_lead_pool 变更后公海池
target_object_id 关联对象的id
target_entity_id 关联对象实体uuid
target_object_name 关联对象name,如account
  • 返回数据结构

  • Description of Return field

Field Description
mid Tenant ID
event_category Action Category
event_type Action Type
action_keyword Specific action(in most cases event_type和action_keyword remain the same,except for the action of changing person in charge(divided into-manual_distribution、 auto_distribution-auto_distribution、 ) )
create_time Create Time of Action
extra_data Action Data
Field Description
object_id Object ID
object_name Object code, such as:lead , account
entity_id Object entity id, such as lead uuid, account uuid
operator_type Operator type,0 - no operator 1 - backend login user 2 - member
operator_id Operator ID
omni_user_uuid The user id that correspond to the member bound by the operator
is_follow_up Is it a follow-up action: 1-yes 0-no
notes notes
login_platform Login platform, such as member_center,jingsocial
login_source_value Login channel information, such as the app_id corresponding to Wechat
login_source_type Type of login channel, such as jingmodule,wechat,workwechat_user
login_environment Login environment, such as pc,mobile
business_type business type uuid
created_timestamp Create Time of Action
owner Current responsible person uuid
life_status Current life cycle stage
lead_omni_user_uuid User ID corresponding to lead
mapping_data Change field value"name": ["张三", "张三二"],//the first is before change,the second is after change
Field Description
name Description
business_type Description
first_name Description
last_name Description
last_name Description
mobile Description
email Description
company_id Description
country_region Description
industry Description
department Description
account_id Description
title Description
official_website Description
life_status Description
lead_pool Description
market Description
to_baby_lead_timestamp Description
mapping_data_text Change field label
Field Description
name Description
business_type Description
first_name Description
last_name Description
last_name Description
mobile Description
email Description
company_id Description
country_region Description
industry Description
department Description
account_id Description
title Description
official_website Description
life_status Description
lead_pool Description
market Description
to_baby_lead_timestamp Description
former_owner Former owner uuid
former_owner_name Former owner name
scene_type Scenario types for owner change: 1-automatic allocation 2-manual allocation 3-lead pool 4-manual return,5-automatic restore,6-duplicate checking and merging
entity_change_mapping Comparison of before and after information, such as before and after changing owner
from_leads_status Former lead status uuid
to_leads_status Current lead status uuid
members Collaborator's uuid(s)
from_life_status Previous lifecycle stage
to_life_status Next lifecycle stage
from_lead_pool Lead pool before change
to_lead_pool Lead pool after change
target_object_id id of associated object
target_entity_id uuid of associated object entity
target_object_name associated object name, such as account
  • Structure of Return Data
{
	"mid": "941",
	"event_category": "object_v2",
	"event_type": "object_create",
	"action_keyword": "object_create",
	"create_time": 1676962253,
	"extra_data": {
		"object_id": "56",
		"object_name": "lead",
		"entity_id": "e9vMaiGWybEQ3Nc9xGgwV4",
		"operator_type": 0,
		"operator_id": 0,
		"omni_user_uuid": "",
		"is_follow_up": 0,
		"notes": "",
		"login_platform": "",
		"login_source_value": "",
		"login_source_type": "",
		"login_environment": "",
		"timeline_data": {
			"login_platform": "",
			"login_environment": "",
			"login_source_type": "",
			"login_source_name": ""
		},
		"business_type": "WNh7rwLXUQPFwACQ6EKPqD",
		"created_timestamp": "2023-02-21 14:50:53",
		"owner": null,
		"life_status": "baby_lead",
		"lead_omni_user_uuid": "7wJy7CNpCPWnP7XMYwEHdn",
		"mapping_data": {
			"name": ["赵拥晨"],
			"business_type": ["WNh7rwLXUQPFwACQ6EKPqD"],
			"headimgurl": ["[\"http:\\\\/\\\\/wx.qlogo.cn\\\\/mmhead\\\\/Q3auHgzwzM4EHT2nacEdibOYV8bxFnmIT6PynWABJYDA5RpFAUrbAgA\\\\/0\"]"],
			"lead_pool": ["market"],
			"life_status": ["baby_lead"],
			"to_baby_lead_timestamp": ["2023-02-21 14:50:53"]
		},
		"mapping_data_text": {
			"name": "赵拥晨",
			"business_type": "Authing",
			"headimgurl": "image",
			"lead_pool": "市场公海",
			"life_status": "初始线索",
			"to_baby_lead_timestamp": "2023-02-21 14:50:53"
		},
		"business_type_name": "Authing"
	}
}


  • 线索订阅事件名称
事件类型事件对象事件名称
object_createlead线索创建
object_updatelead线索更新
object_update_statuslead线索状态更新
object_voidslead线索作废
object_change_ownerlead变更负责人(scene_type 1-自动分配 2-手动分配 3-公海池认领 4-手动退回,5-自动回收)
object_createlead线索创建
object_update_life_cyclelead线索阶段变更
object_add_noteslead线索添加备注
object_add_team_memberlead线索添加协作人
object_remove_team_memberlead线索移除协作人
object_change_lead_poollead公海池变更
object_restorelead线索恢复
object_relationlead线索关联
object_source_infolead来源信息变更
  • Name of Lead Subscription Event
Event TypeEvent ObjectEvent Name
object_createleadLead Creation
object_updateleadLead Updates
object_update_statusleadLead Status Update
object_voidsleadLead Voided
object_change_ownerleadChange the person in charge(scene_type 1-automatic allocation 2-manual allocation 3-lead pool claim 4-manual return,5-automatic restore)
object_createleadLead Creation
object_update_life_cycleleadLead Stage Change
object_add_notesleadLead Add Notes
object_add_team_memberleadLead Add Collaborators
object_remove_team_memberleadLead Remove Collaborators
object_change_lead_poolleadLead Pool Change
object_restoreleadLead Restore
object_relationleadLead Association
object_source_infoleadSource Information Change
上一页
删除会议活动webhook
下一页
add_omni_user_success事件(add_omni_user_success event)
Built with