jing-openplatform-api
  1. CRM 对象通用接口(CRM Object Interface)
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)
        POST
      • 查询选项集字段(Get Option Set Fields)
        POST
      • 查询来源选项字段(获取下拉选项)(Source Field Type (Get Drop-down Options))
        POST
      • 查询自定义选项字段(Get Custom Option Set Fields)
        POST
      • 查询对象所有字段(Get All Fields of the Object)
        POST
    • 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. CRM 对象通用接口(CRM Object Interface)

查询对象所有字段(Get All Fields of the Object)

live-阿里云(Alibaba Cloud)
https://jingopenapi.jingsocial.com
live-阿里云(Alibaba Cloud)
https://jingopenapi.jingsocial.com
POST
https://jingopenapi.jingsocial.com
/v1/common/entityField/list

请求参数

Header 参数
app_id
string 
应用id
必需
默认值:
{{app_id}}
access_token
string 
应用密钥
必需
默认值:
{{access_token}}
Body 参数application/json
type
string 
必需
对象类型:线索lead;客户account
(English)object type: lead: lead; object: account
query
object 
可选
filter
object 
可选
示例
{
    "type": "lead"
}

示例代码

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/common/entityField/list' \
--header 'app_id;' \
--header 'access_token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "lead"
}'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
data
array [object {50}] 
字段配置
必需
jing_uuid
string 
字段ID
必需
mid
number 
mid
必需
object_id
number 
对象ID
必需
code
string 
字段code
必需
label
string 
字段label
必需
english_label
string 
英文label
必需
position
string 
必需
字段存放在表中的位置
type
string 
字段类型
必需
status
number 
必需
字段状态0-禁用1-启用
is_allowed_disabled
number 
是否允许被禁用
必需
basic_type
string 
字段基础类型
必需
quote_field_id
string 
引用的字段的ID
必需
quote_related_field_id
string 
必需
引用字段所属查找关联字段的id
count_type
string 
必需
统计类型:count,sum,avg,max,min
count_field_id
string 
统计字段的id
必需
count_related_field_id
string 
必需
统计字段所属查找关联字段的id
related_to_name
string 
必需
关联父对象的name
child_relationship_name
string 
必需
对象父子关系中子关系名称,用于对象关系中从父对象实例数据反查子对象实例数据
sort
number 
字段排序
必需
default_value
string 
默认值
必需
parent_field_id
string 
父字段ID
必需
data_set_id
string 
选项集ID
必需
is_save
number 
必需
是否在entity中保存数据,1-是,0-否
is_search
number 
必需
是否支持搜索,1-是,0-否
is_required
number 
必需
是否必填,1-是,0-否
is_sort
number 
必需
字段是否支持排序,1-是,0-否
is_unique
number 
必需
是否唯一,1-是,0-否
is_edit
number 
必需
是否能编辑,1-是,0-否
is_preset
number 
必需
字段类型 0:自定义字段;1:系统预设字段;2:第三方字段
is_system
number 
必需
是否系统字段,1-是,0-否
list_type
number 
必需
单选/多选字段选项集类型:0-自定义,1-通用
is_encrypt
number 
必需
是否加密:0-否,1-是
validation_regexp
string 
必需
验证数据的正则表达式
validation_message
string 
必需
正则不通过的错误提示
min_length
number  | null 
必需
textarea,text类型的最小字符长度
max_length
number  | null 
必需
textarea,text类型的最大字符长度
scale
number  | null 
必需
number类型小数部分的最大位数不大于6
max_value
null  | string 
必需
number类型最大值
min_value
null  | string 
必需
number类型最小值
option_type
number 
必需
用于对象筛选器的分类
remark
string 
字段备注
必需
created_by
string 
创建者
必需
updated_by
string 
上次编辑者
必需
created_timestamp
string 
创建时间
必需
updated_timestamp
string 
更新时间
必需
deleted_at
null 
删除时间
必需
from_table
string 
必需
字段所属表,当空时默认对象表
owner_name
string 
创建者姓名
必需
type_label
string 
必需
字段类型中文label
type_en_label
string 
必需
字段类型英文label
msg
string 
必需
request_id
string 
必需
示例
{
    "request_id": "882396bf66074e33b1504437f1a6e616",
    "code": 0,
    "msg": "success",
    "data": [
        {
            "jing_uuid": "a6ZpQdh5NWxhKJzfRvKhc3",
            "mid": 124,
            "object_id": 628,
            "code": "email",
            "label": "email",
            "english_label": "E-mail",
            "position": "email",
            "type": "email",
            "status": 1,
            "is_allowed_disabled": 0,
            "basic_type": "text",
            "quote_field_id": "",
            "quote_related_field_id": "",
            "count_type": "",
            "count_field_id": "",
            "count_related_field_id": "",
            "related_to_name": "",
            "child_relationship_name": "",
            "default_value": "",
            "parent_field_id": "",
            "data_set_id": "",
            "field_detail_json": "{\"el\": \"email\", \"key\": \"email\", \"icon\": \"jing_icon-Message-Unreadx\", \"name\": {\"en\": \"E-mail\", \"zh\": \"email\"}, \"type\": \"input\", \"model\": \"email\", \"rules\": [{\"message\": {\"en\": \"Please enter the correct E-mail address\", \"zh\": \"请输入正确的邮箱地址\"}, \"pattern\": \"/^[A-Za-z\\\\d]+([-_.][A-Za-z\\\\d]+)*@([A-Za-z\\\\d]+[-.])+[A-Za-z\\\\d]{2,4}$/\"}], \"status\": 1, \"options\": {\"tags\": [], \"width\": \"\", \"hidden\": false, \"pattern\": \"/^[A-Za-z\\\\d]+([-_.][A-Za-z\\\\d]+)*@([A-Za-z\\\\d]+[-.])+[A-Za-z\\\\d]{2,4}$/\", \"dataBind\": true, \"dataType\": \"\", \"disabled\": false, \"isRepeat\": false, \"required\": false, \"validator\": \"\", \"labelWidth\": 100, \"remoteFunc\": \"func_phmd83b8\", \"customClass\": \"\", \"placeholder\": {\"en\": \"Please input...\", \"zh\": \"请输入...\"}, \"defaultValue\": \"\", \"isLabelWidth\": false, \"patternCheck\": true, \"remoteOption\": \"option_phmd83b8\", \"showPassword\": false, \"dataTypeCheck\": false, \"patternMessage\": \"请输入正确的邮箱地址\", \"validatorCheck\": false, \"dataTypeMessage\": \"\", \"requiredMessage\": \"\"}, \"field_sort\": 7, \"showSetting\": {\"is_editable\": 1, \"show_in_form\": 1, \"show_in_detail\": 1, \"is_edit_field_type\": 4, \"is_allowed_disabled\": 0, \"layout_default_field\": 1, \"import_can_be_updated\": 1, \"is_default_display_list\": 1, \"allow_to_edit_field_name\": 1, \"import_creation_assignable\": 1}, \"backendParams\": {\"logic_type\": \"email\"}}",
            "show_setting": "{\"is_editable\": 1, \"show_in_form\": 1, \"show_in_detail\": 1, \"is_edit_field_type\": 4, \"is_allowed_disabled\": 0, \"layout_default_field\": 1, \"import_can_be_updated\": 1, \"is_default_display_list\": 1, \"allow_to_edit_field_name\": 1, \"import_creation_assignable\": 1}",
            "sort": 7,
            "is_save": 1,
            "is_search": 1,
            "is_required": 0,
            "is_sort": 1,
            "is_unique": 0,
            "is_edit": 1,
            "is_preset": 1,
            "is_system": 0,
            "list_type": 0,
            "validation_regexp": "",
            "is_encrypt": 0,
            "validation_message": "",
            "option_type": 0,
            "segment_display": 119,
            "segment_operator": "{\"empty\": 87, \"equal\": 87, \"one_of\": 1, \"contains\": 1, \"not_empty\": 87, \"not_equal\": 87, \"not_contains\": 1}",
            "remark": "",
            "created_by": "13927",
            "updated_by": "admin:19219",
            "created_timestamp": "2022-06-06 09:54:18",
            "updated_timestamp": "2023-01-04 18:40:19",
            "from_table": ""
        }
    ]
}
上一页
查询自定义选项字段(Get Custom Option Set Fields)
下一页
查询CTA列表
Built with