jing-openplatform-api
  1. 开发前必读（Must Read Before Development）
jing-openplatform-api
  • 开放接口-V1文档 (Interface Document_V1)
    • 开发前必读（Must Read Before Development）
      • 接口更新日志 (Interface Update Log)
      • 接入指南（Access Guide）
      • 接口权限（Interface Permissions）
      • 访问频率和并发限制（Access Frequency & Concurrency Restrictions）
      • 全局错误码说明（Global Error Code Description）
    • OAuth授权（Authorization）
      • 获取访问Token（Get Access Token）
      • 刷新 Token（Refresh Token）
    • 用户管理（User Management）
      • 用户批量创建（User Batch Creation）
      • 用户查询（User Query）
      • 用户批量更新（User Batch Update）
      • 批量查询用户身份 (User Batch Query)
      • 用户列表查询（User List Query）
    • 用户群组 (User Group)
      • 查询静态人群列表 (Query Static Group)
      • 获取静态人群详情 (Get Static Group Details)
      • 查询静态人群详情用户列表 (Query Static Group User List)
      • 创建静态人群 (Creat Static Group)
      • 更新静态人群 (Update Static Group)
      • 删除静态人群 (Delete Static Group)
      • 导入群组用户 (Import Group User)
    • 用户标签（User Tags）
      • 批量创建普通标签（Batch Creating Tags）
      • 批量给用户打标签（Batch Tagging Users）
      • 查询普通标签 (Query Tags)
      • 移除用户标签 (Remove Tags)
    • 活动管理 (Activities Management)
      • 查询活动详情 (Query Activity Details)
      • 查询活动列表 (Query Activity List)
      • 查询活动报名用户列表 (Query Activity Registered User List)
      • 批量更新活动用户状态 (Batch Update Activity User Status)
    • 邮件管理 (EDM Management)
      • 查询邮箱列表 (Query Email Address List)
      • 创建发送邮件 (Crest Send Email)
      • 查询发送邮件详情 (Query Send Email Details)
      • 更新发送邮件 (Update Send Email)
      • 删除发送邮件 (Delete Send Email)
      • 查询发送邮件列表 (Query Send-Email List)
      • 查询发送明细 (Query Send Details)
    • 短信管理 (SMS Management)
      • 查询短信列表 (Query Message List)
      • 查询短信发送详情 (Query Send Message Detail)
      • 创建任务 (Create Task)
      • 发送 (Send Message)
    • 来源管理 (Source Management)
      • 查询来源选项 (Query Source Option)
      • 创建自定义来源选项 (Create Custom Source Option)
      • 更新自定义来源选项 (Update Custom Source Option)
      • 查询来源下所有选项 (Query all Options from Source)
    • 二维码管理 (QR Code Management)
      • 创建临时二维码 (Create Temporary QR Code)
      • 创建永久二维码 (Create Permanent QR Code)
    • 会员管理 (Member Management)
      • 会员创建 (Create Member)
      • 会员查询 (Query Member)
      • 会员更新 (Update Member)
      • 查询会员剩余积分 (Query Member Remaining Points)
      • 查询会员规则列表 (Query Member Rule List)
      • 查询会员列表 (Query Member List)
      • 扣减会员积分 (Deduct Member Points)
      • 增加会员积分 (Add Member Points)
    • 成员管理 (Employee Management)
      • 查询成员信息（Query Member Information）
    • 微信公众号 (WeChat Account)
      • 发送微信模版消息 (Send WeChat Template Message)
      • 获取用户的openid和关注状态 (Get User Openid & Follow Status)
    • 线索管理（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 Management)
      • 查询CTA列表 (Query CTA List)
      • 查询CTA明细列表 (Query CTA Detail List)
    • 模板消息 (Template Message)
      • 创建模版消息 (Create Template Message)
      • 创建模板消息推送 (Create Template Message Send)
      • 更新模板消息 (Update Template Message)
      • 查询模版消息详情 (Query Template Message Detail)
      • 删除模版消息 (Delete Template Message)
      • 查询模板消息列表 (Query Template Message List)
      • 查询微信模板列表 (Query WeChat Template Message List)
      • 查询消息模板推送明细 (Query Template Message Send Detail)
      • 查询消息模板点击明细 (Query Template Message Chick Detail)
      • 查询模板消息推送记录列表 (Query Template Message Send Record List)
    • 隐私条款v1（Privacy Policy_V1）
      • 查询隐私条款列表（Query Privacy Policy List）
      • 查询隐私条款授权记录列表（Query Privacy Policy Authorization Record List）
    • 隐私条款v2（Privacy Policy_V2）
      • 查询隐私条款列表（Query Privacy Policy List）
      • 新增用户授权记录（Add User Authorization Record）
      • 查询用户授权状态（Query User Authorization Status）
      • 移除用户授权记录（Delete User Authorization Record）
      • 查询隐私条款模版（Query Privacy Policy Templete）
    • 企业微信 (WeCom Management)
      • 发送企微应用消息（Send WeCom App Message）
      • 获取用户的企微好友状态(Get User's WeCom Friendship Status )
    • 评分管理 (Scoring Management)
      • 批量查询用户意向评分 (Batch Query User Intention Scoring)
      • 批量查询用户行为评分 (Batch Query User Active Scoring)
      • 批量查询线索身份评分 (Batch Query Lead Identity Scoring)
      • 批量查询线索行为评分 (Batch Query Lead Active Scoring)
      • 批量查询线索意向评分 (Batch Query Lead Intention Scoring)
      • 批量查询用户身份评分 (Batch Query User Identity Scoring)
      • 批量用户行为评分清零 (Batch Delete User Action Scoring)
    • 自定义事件 (Custom Events)
      • 创建自定义事件 (Creat Custom Events)
      • 上报自定义事件 (Report Custom Events)
    • 公司管理 (Company Management)
      • 批量创建公司 (Batch Create Company)
      • 批量更新公司 (Batch Update Company)
      • 批量删除公司 (Batch Delete Company)
      • 批量获取公司列表 (Batch Get Company List)
  • 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. 开发前必读（Must Read Before Development）

全局错误码说明（Global Error Code Description）

以下是全局通用错误码，具体接口的特别错误码请参见接口定义。

错误码列表#

错误码说明子错误说明
0success
20000服务不可用
20000服务不可用服务暂不可用
20000服务不可用服务不可用
20000服务不可用服务暂不可用
20000服务不可用服务暂不可用
20000服务不可用网关响应超时
20001授权权限不足
20001授权权限不足无效的访问令牌
20001授权权限不足访问令牌已过期
20001授权权限不足无效的应用授权令牌或token失效
20001授权权限不足应用授权令牌不能为空
20001授权权限不足商户未授权当前接口
20001授权权限不足应用授权令牌已过期
20001授权权限不足商户未签约任何产品
20002请求被限流
20002请求被限流超出请求并发限制
20002请求被限流超出当天请求数量限制
20002请求被限流超出当前接口请求总量限制
20002请求被限流超出请求总量限制
20002请求被限流超出平台请求并发限制
20002请求被限流超出当天请求数量限制
| 40001 | 缺少必选参数 | |
| 40001 | 缺少必选参数 | 缺少方法名参数 |
| 40001 | 缺少必选参数 | 缺少appId参数 |
| 40001 | 缺少必选参数 | 缺少时间戳参数 |
| 40001 | 缺少必选参数 | 缺少版本参数 |
| 40001 | 缺少必选参数 | 解密出错, 未指定加密算法 |
| 40002 | 非法的参数 | |
| 40002 | 非法的参数 | 参数无效 |
| 40002 | 非法的参数 | 文件上传失败 |
| 40002 | 非法的参数 | 文件扩展名无效 |
| 40002 | 非法的参数 | {0}文件大小无效，单文件不得超过{1} |
| 40002 | 非法的参数 | 不存在的方法名 |
| 40002 | 非法的参数 | 无效的数据格式 |
| 40002 | 非法的参数 | 无效的tid参数 |
| 40002 | 非法的参数 | 无效的appId参数 |
| 40002 | 非法的参数 | 非法的时间戳参数 |
| 40002 | 非法的参数 | 字符集错误 |
| 40002 | 非法的参数 | 摘要错误 |
| 40002 | 非法的参数 | 解密出错，不支持的加密算法 |
| 40002 | 非法的参数 | 解密出错, 未配置加密密钥或加密密钥格式错误 |
| 40002 | 非法的参数 | 解密出错，未知异常 |
| 40002 | 非法的参数 | 验签出错, 未配置对应签名算法的公钥或者证书 |
| 40002 | 非法的参数 | 本接口不支持第三方代理调用 |
| 40002 | 非法的参数 | 可疑的攻击请求 |
| 40002 | 非法的参数 | 无效的content-type |
| 40004 | 业务处理失败 | 具体看业务返回 |
| 40005 | 服务调用异常 | 服务接口调用异常 |
| 40006 | 权限不足 | |
| 40006 | 权限不足 | 请检查配置的账户是否有当前接口权限 |
| 40006 | 权限不足 | 代理的商户没有当前接口权限 |
| 40006 | 权限不足 | 没有当前接口权限 |
| 40006 | 权限不足 | 无权访问 |
| 40006 | 权限不足 | IP无权访问 |
The following are global generic error codes. Please refer to the interface definition for special error codes of interface-specific.

Error Code List#

Error Code ListDescriptionSub-error Description
0success
20000Service Unavailable
20000Service UnavailableService Temporarily Unavailable
20000Service UnavailableService Unavailable
20000Service UnavailableService Temporarily Unavailable
20000Service UnavailableService Temporarily Unavailable
20000Service UnavailableGateway response overtime
20000Service UnavailableServer Busy
20001Insufficient Authorization Rights
20001Insufficient Authorization RightsInvalid Access Token
20001Insufficient Authorization RightsAccess token has expired
20001Insufficient Authorization RightsInvalid Application Authorization Token
20001Insufficient Authorization RightsApplication authorization token cannot be empty
20001Insufficient Authorization RightsMerchant not authorized for current interface
20001Insufficient Authorization RightsApplication authorization token has expired
20001Insufficient Authorization RightsThe merchant has not signed up for any products
20001Insufficient Authorization RightsThe service available for the day has been used up
20001Insufficient Authorization RightsThe service time is used up, please purchase the service in time
40001Missing Required Parameters
40001Missing Required ParametersMissing parameter of method name
40001Missing Required ParametersMissing parameter of appId
40001Missing Required ParametersMissing parameter of timestamp
40001Missing Required ParametersMissing parameter of version
40001Missing Required ParametersDecryption error, no encryption algorithm specified
40002Invalid Parameter
40002Invalid ParameterParameter Invalid
40002Invalid ParameterFile Upload Failed
40002Invalid ParameterInvalid File Extension
40002Invalid Parameter{0} File size is invalid, single file cannot exceed {1}
40002Invalid ParameterNon-existent Method Name
40002Invalid ParameterInvalid Data Forma
40002Invalid ParameterInvalid tid Parameter
40002Invalid ParameterInvalid appId Parameter
40002Invalid ParameterInvalid Timestamp Parameter
40002Invalid ParameterCharacter Set Error
40002Invalid ParameterSummary Error
40002Invalid ParameterDecryption error, unsupported encryption algorithm
40002Invalid ParameterDecryption error, encryption key not configured, or encryption key format error
40002Invalid ParameterDecryption error, unknown exception
40002Invalid ParameterSignature verification error, no public key or certificate is configured for the corresponding signature algorithm
40002Invalid ParameterThis interface does not support third-party proxy calls
40002Invalid ParameterSuspicious Attack Request
40002Invalid ParameterInvalid content-type
40004Business Processing FailedSee business return for details
40005Service Call ExceptionService Interface Call Exception
40006Insufficient Permissions
40006Insufficient PermissionsPlease check whether the configured account has current interface permissions
40006Insufficient PermissionsThe agent merchant does not have current interface permissions
40006Insufficient PermissionsNo current interface permissions
40006Insufficient PermissionsNo Access
40006Insufficient PermissionsIP does not have access
修改于 2025-06-04 08:11:12
上一页
访问频率和并发限制（Access Frequency & Concurrency Restrictions）
下一页
获取访问Token（Get Access Token）
Built with