使用场景:

当积分主体配置为“外部积分系统”时,触发积分增加业务时,积分集成服务会请求积分类型自建应用中所配置的接口地址。


接口地址 自建应用配置

请求方式 POST

consumes ["application/json"]

produces ["application/json"]

接口描述 企业级接口,hearer必须携带X-Token

应用权限 积分 -> 外部积分-增加

注意事项 可配置接口安全加密,当勾选数据安全传输加密算法时,会校验是否开通数据安全功能,并配置了加密方式。此时接口入参只有密文,参数名:encryptStr

请求参数


请求头参数

参数名称参数说明请求类型是否必须数据类型schema
X-Token自建应用访问tokenheadertruestring

公共参数

参数名称参数说明请求类型是否必须数据类型schema备注
openids身份识别标识集合bodyfalsearray身份识别标识
phoneList手机号码列表bodyfalsearray手机号码
audienceUserId客户档案IDbodyfalselong
point积分变动值bodytrueint
remark备注bodytruestring
eventType行为类型bodyfalsestring
avatar用户头像bodyfalsestring
nickName用户昵称bodyfalsestring
contentId内容ID(作品ID)bodyfalsestring
contentName内容名称(作品名称)bodyfalsestring
ext扩展信息bodyfalsestringjson字符串

流程策略扩展信息字段 ext

参数名称参数说明请求类型是否必须数据类型schema
componentId插件idbodyfalsestring
strategyId策略idbodyfalsestring
strategyName策略名称bodyfalsestring

身份识别标识

参数名称参数说明请求类型是否必须数据类型schema
openidbodyfalsestring
unionidbodyfalsestring
fromTo应用类型(contentminiapp:小程序, workwechat:企业微信外部联系人, gzh:公众号, workwechatgroup:客户群)bodyfalsestring
appid应用IDbodyfalsestring
jcappid系统集成应用实例IDbodyfalselong
identityId身份识别类型IDbodyfalsestring
identityType身份识别类型(phone: 手机号码, id: 第三方用户ID, openid: 公众号openid, unionid: 开放平台unionid)bodyfalsestring

手机号码

参数名称参数说明请求类型是否必须数据类型schema
phone手机号bodyfalsestring
isVerify是否验证(0:未验证, 1:已验证)bodyfalsestring

请求示例

{
	"appInstanceId": 0,
	"audienceUserId": 860484273911119872,
	"avatar": "",
	"contentId": "内容ID",
	"contentName": "内容明细",
	"eventType": "test",
	"ext": "",
	"nickName": "用户昵称",
	"openids": [
		{
			"appid": "",
			"fromTo": "",
			"identityId": "",
			"identityType": "",
			"jcappid": 0,
			"openid": "",
			"unionid": ""
		}
	],
	"orgId": "d515fa4b-8def-4188-8415-92632581795c",
	"phoneList": [
		{
			"isVerify": "",
			"phone": ""
		}
	],
	"point": 10,
	"remark": "积分自建应用测试"
}

响应参数


参数名称参数说明请求类型是否必须数据类型schema
code状态码bodytruestring
errorCode异常码bodytruestring
msg描述bodytruestring
data操作是否成功bodytrueboolean

响应状态

状态码说明schema
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

响应示例

{
  "code": "200",
  "errorCode": "SUCCESS",
  "msg": "ok",
  "data": true
}
  • 无标签