版本比较

标识

  • 该行被添加。
  • 该行被删除。
  • 格式已经改变。

...

字段名称

字段类型

是否必传

字段说明

interfaceName

stringtrue接口鉴权名称

checkType

stringfalse

校验类型: 

false:自定义设置 

true:外部接口回调

externalConditionUrl

stringfalse外部接口回调-获取鉴权条件URL

externalInformUrl

stringfalse外部接口回调-保存通知接口

externalConfigId

stringfalse外部接口配置的ID
userParamObjecttrue用户参数。对应自建应用中的系统参数中的固定参数
└─ audidstringtrue客户档案id
└─ openidstringfalseopenid
└─ appIdstringtrue作品id
└─ componentIdstringfalse组件id
└─ flowIdstringfalse流程策略id
└─ appInstanceIdstringfalse自建应用的id
└─ identityIdstringfalse自建应用的识别的身份id
└─ identityTypestringfalse自建应用的身份类型
└─ realName stringfalse真实姓名
└─ phone   stringfalse手机号码
└─ addressstringfalse地址信息
└─ devicestringfalse手机型号 ios/Android
└─ markFlagintegerfalse

是否星标 1 0

└─ payFeaturestringfalse消费特点
└─ sexintegerfalse性别 1男 2女
└─ identitysArrayfalse用户多身份信息
     └─ identityId stringfalse自建应用的识别的身份id。platform=EXTERNAL(自建应用)
     └─ identityType stringfalse自建应用的身份类型。platform=EXTERNAL(自建应用)
     └─ fromTostringfalse标识来源
     └─ platformstringfalse标识来源平台。平台标识,gzh(微信公众号)、contentminiapp(微信小程序)、EXTERNAL(自建应用)
     └─ openidstringfalseopenid (当 fromTo 为 gzh(微信公众号) 时,openid有值)
     └─ unionidstringfalseunionid (当 fromTo 为 gzh(微信公众号) 时,unionid有值)

     └─ jcappid

Long

true系统集成Id
     └─ appid stringfalse公众号appid

└─ customFields

Arrayfalse

自定义字段可能会存在多个。对应工作台中的用户-字段管理中的字段

此参数已删除

     └─ fieldId

stringfalse

自定义字段ID

     └─ fieldType

stringfalse

自定义字段类型 1 文本输入(默认) 2 单选 3 复选 4 数值

     └─ fieldValue

Arrayfalse

自定义字段值

authParams

Arraytrue鉴权参数集合。对应工作台中的校验参数列表,用于客户侧校验的字段
└─ chineseNamestringtrue参数中文名
└─ englishNamestringtrue参数英文名

└─ paramType

stringtrue

参数类型:

文本-text,数值-number,多选-select,单选-checkbox,区间-area

(文本:可输入string类型,支持字母+数字+下划线+中文

数值:支持双精度小数,整数;支持大于、大于等于、小于等于、小于、区间(闭区间) 

单选、复选: 取值 选项标识参数值去string类型,单选仅满足其中之一;复选可以满足所有选项,也可满足其中之一 )

└─ valuesObjectfalse

参数值

└─ option

Arrayfalse多选值
     └─ keystringfalse复选框key
     └─ valuestringfalse复选框value
└─ operatorstringfalse操作符(EQ(相等)、GT(大于)、GTEQ(大于等于)、LT(小于)、LTEQ(小于等于)、NEQ(不等)、IN(在枚举范围内)、ALL(全部)、BETWEEN(范围比较) )
externalExtras
Objectfalse外部扩展参数
└─ key1Stringfalse外部参数key1,根据实际传递的参数
└─ key2Stringfalse外部参数key2,根据实际传递的参数

接口响应参数说明:

Field

Type

Description

Required

code

string

响应状态码。

200 : 成功。非200都是失败

true

msg

string

响应状态描述

true

data

object

数据。"true"

true

errorCodestring

错误状态码。

如果code返回非200,建议接口提供方必填

false

...

代码块
languagejs
linenumberstrue
{
    "interfaceName": "接口通过",
    "checkType":true,
    "externalConditionUrl":"",
    "externalInformUrl":"",
    "externalConfigId": "7697ac58-0e30-4111-a169-9c96023aacf8",
    "externalConfigOperator": "ALL",
    "externalConfigValues": [
        [
            "shenfen"
        ]
    ],
    "userParam": {
        "audid": "720332229959618560",
        "openid": "wx35c610c7c049ce8287-8",
        "appId":"xxxxxxx",
        "componentId":"xxxxxxx",
        "flowId":"xxxxxxx",
        "appInstanceId": "自建应用的id",
        "identityId": "12345678",
        "identityType": "customerNo;",
        "phone": "18777777777",
        "realName": "张三",
        "address": "广东省深圳市南山区",
        "device": "ios/Android",
        "markFlag": "1",
        "payFeature": "厉害",
        "sex": "1",
        "customFields": [
            {
                "fieldId": "132",
                "fieldType": "text",
                "fieldValue": "434334199111113445",
                "fieldNumValue": "自定义数值"
            },
            {
                "fieldId": "133",
                "fieldType": "text",
                "fieldValue": "231231321222221113",
                "fieldNumValuemarkFlag": "自定义数值1",
        "payFeature": "厉害",
   }
        ]"sex": "1"
    },
    "authParams": [
        {
            "chineseName": "开始日期",
            "englishName": "start_date",
            "paramType": "text",
            "values": "2021-07-01",
            "operator": null,
            "option": [],
        },
        {
            "chineseName": "结束日期",
            "englishName": "end_date",
            "paramType": "text",
            "values": "2021-07-31",
            "operator": null,
            "option": [],
        },
        {
            "chineseName": "首次办理",
            "englishName": "first_deal",
            "paramType": "select",
            "values": "1",
            "operator": null,
            "option": [],
        },
		{
			"chineseName": "111",
			"englishName": "aa",
			"option": [],
			"paramType": "number",
			"values": "222",
			"operator": "EQ"
		},
		{
			"chineseName": "版本",
			"englishName": "bb",
			"option": [
				{
					"key": "我",
					"value": "哈哈"
				},
				{
					"key": "你",
					"value": "哦哦发"
				}
			],
			"paramType": "checkbox",
			"values": "我"
		},
		{
			"chineseName": "此次",
			"englishName": "cc",
			"option": [],
			"paramType": "area",
			"values": [
				20,
				202
			]
		},
{
			"chineseName": "此次",
			"englishName": "cc",
			"option": [],
			"paramType": "dateTimeRange",
			"values": [
				20,
				202
			]
		},
		{
			"chineseName": "外部接口参数",
			"englishName": "externalInterface",
			"paramType": "cascader",
			"option": [
				{
					"label": "小程序分组",
					"value": "mini_app_group",
					"type": null,
					"children": [
						{
							"label": "小程序新客",
							"value": "500500",
							"type": null,
							"children": []
						},
						{
							"label": "单位人员",
							"value": "7000661",
							"type": null,
							"children": []
						}
					]
				}
			],
			"values": [
				[
					"mini_app_group"
				]
			],
			"operator": "IN"
		}
    ],
    "externalExtras":{
      "key1":"value1",
    "key2":"value2"
   }
}



返回结果示例:

代码块
languagejs
themeMidnight
linenumberstrue
{
    "code":"200",
    "msg":"鉴权成功",
    "data": "true",
    "errorCode" : ""
}

...