jing-openplatform-api
  1. 线索管理(Lead Management)
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)
        POST
      • 线索更新(Lead Update)
        POST
      • 线索查询(Lead Query)
        POST
      • 线索状态列表查询(Get Lead Status List)
        POST
      • 线索状态更新(Get Status Update)
        POST
      • 线索布局列表查询(Lead List)
        POST
      • 更新线索协作人(Update Lead Collaborators)
        POST
      • 查询线索详情链接(Query Lead Details Link)
        POST
    • 客户管理(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 Management)

线索创建(Lead Creation)

live-阿里云(Alibaba Cloud)
https://jingopenapi.jingsocial.com
live-阿里云(Alibaba Cloud)
https://jingopenapi.jingsocial.com
POST
https://jingopenapi.jingsocial.com
/v1/leads/create
接口说明:
如需操作自定义属性,则通过调用《获取对象所有字段》接口来获取相关属性code,自定义属性与预设字段同级。
接口返回的is_preset=0是自定义字段,is_preset=1是预设字段。
预设字段即标准字段可操作属性看该接口文档
自定义字段的type为department, multi_departmemt, image, look_up的不能创建或更新
接口调用限制为:
每秒10次;每天10000次
Interface Description:
If you need to operate custom attributes, you can get the relevant attribute code by calling the "Get all fields of an object" interface. The custom attributes are at the same level as the preset fields.
The interface returns is_preset=0 is a custom field and is_preset=1 is a preset field.
The operable attribute of the preset fields i.e. standard fields should refer to the interface documentation
The type of the custom field is department, multi_ departmemt, image, look_up cannot be created or updated
Interface calls are limited to:
10 times per second; 10,000 times per day

请求参数

Header 参数
app_id
string 
应用id
必需
默认值:
{{app_id}}
access_token
string 
应用密钥
必需
默认值:
{{access_token}}
Body 参数application/json
business_type
string 
必需
业务类型(通过《获取业务类型》接口获取:外层的jing_uuid字段)
(English)business type (obtained through the "Get Business Type" interface: the outer jing_uuid field)
mobile
string 
必需
手机号(和邮箱只要有一个有值就行)
(English)mobile (and email as long as one of them has a value)
email
string 
必需
邮箱(和手机号只要有一个有值就行)
(English)email (and mobile as long as one of them has a value)
name
string 
必需
姓名
(English)name
first_name
string 
可选
名
(English)first name
last_name
string 
可选
姓
(English)last name
lead_status
string 
可选
线索状态(通过《来源字段类型(获取下拉选项》获取)
(English)lead status (obtained through "Source Field Type (get dropdown options)")
account_id
string 
可选
所属客户(用过《获取对象实体列表》)
(English)affiliated account (used "Obtain Object Entity List")
company_id
string 
可选
公司名称(非id)
(English)company name (non-id)
official_website
string 
可选
公司官网
(English)company official website
industry
string 
可选
行业
(English)industry
title
string 
可选
职务
(English)title
country_region
string 
可选
国家/地区(选项集)(通过《获取选项集字段》获取:取最内层child的jing_uuid)
(English)country / region (option set) (obtained through "Get Option Set Field": take the innermost child's jing_uuid)
address
string 
可选
详细地址
(English)detailed address
description
string 
可选
描述
(English)description
latest_remark
string 
最新备注
可选
最新备注
(English)the latest remark
department
string 
可选
部门id
(English)department id
param_1
string 
可选
最新推广参数1(后面这十个字段通过《来源字段类型》获取)
(English)the latest promotion parameter1 (the following ten fields are obtained through "Source Field Type")
param_2
string 
可选
最新推广参数2
(English)the latest promotion parameter 2
param_3
string 
可选
最新推广参数3
(English)the latest promotion parameter 3
param_4
string 
可选
最新推广参数4
(English)the latest promotion parameter 4
param_5
string 
可选
最新推广参数5
(English)the latest promotion parameter 5
utm_source
string 
可选
最新投放来源
(English)the latest advertising source
utm_medium
string 
可选
最新投放渠道1
(English)the latest advertising channel 1
utm_terms
string 
可选
最新投放关键词
(English)the latest advertising keyword
utm_campaign
string 
可选
最新投放活动
(English)the latest advertising campaign
utm_content
string 
可选
最新投放内容
(English)the latest advertising content
source_type
string 
可选
最新来源类型
(English)the latest source type
source_name
string 
可选
最新来源名称
(English)the latest source name
website_name
string 
可选
最新微站名称
(English)the latest microsite name
website_page_name
string 
可选
最新微站页面名称
(English)the latest microsite page name
source_custom_param
string 
可选
最新自定义来源字段
(English)the latest custom source field
owner
string 
负责人id
可选
示例
{
    "business_type": "string",
    "mobile": "string",
    "email": "string",
    "name": "string",
    "first_name": "string",
    "last_name": "string",
    "lead_status": "string",
    "account_id": "string",
    "company_id": "string",
    "official_website": "string",
    "industry": "string",
    "title": "string",
    "country_region": "string",
    "address": "string",
    "description": "string",
    "latest_remark": "string",
    "department": "string",
    "param_1": "string",
    "param_2": "string",
    "param_3": "string",
    "param_4": "string",
    "param_5": "string",
    "utm_source": "string",
    "utm_medium": "string",
    "utm_terms": "string",
    "utm_campaign": "string",
    "utm_content": "string",
    "source_type": "string",
    "source_name": "string",
    "website_name": "string",
    "website_page_name": "string",
    "source_custom_param": "string",
    "owner": "string"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://jingopenapi.jingsocial.com/v1/leads/create' \
--header 'app_id;' \
--header 'access_token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "business_type": "string",
    "mobile": "string",
    "email": "string",
    "name": "string",
    "first_name": "string",
    "last_name": "string",
    "lead_status": "string",
    "account_id": "string",
    "company_id": "string",
    "official_website": "string",
    "industry": "string",
    "title": "string",
    "country_region": "string",
    "address": "string",
    "description": "string",
    "latest_remark": "string",
    "department": "string",
    "param_1": "string",
    "param_2": "string",
    "param_3": "string",
    "param_4": "string",
    "param_5": "string",
    "utm_source": "string",
    "utm_medium": "string",
    "utm_terms": "string",
    "utm_campaign": "string",
    "utm_content": "string",
    "source_type": "string",
    "source_name": "string",
    "website_name": "string",
    "website_page_name": "string",
    "source_custom_param": "string",
    "owner": "string"
}'

返回响应

🟢200成功
application/json
Body
request_id
string 
必需
请求唯一id
(English)request unique id
code
integer 
必需
成功返回0
(English)success then return 0
msg
string 
success
必需
data
object 
必需
jing_uuid
string 
必需
线索id
(English)lead id
示例
{
    "request_id": "string",
    "code": 0,
    "msg": "string",
    "data": {
        "jing_uuid": "string"
    }
}
上一页
获取用户的openid和关注状态
下一页
线索更新(Lead Update)
Built with