使用场景:

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

场景1:工作台 - 用户 - 全部用户 - 用户详情 - 积分记录(历史总积分、可用积分、消耗积分、过期积分的查询)


接口地址 自建应用配置

请求方式 POST

consumes ["application/json"]

produces ["application/json"]

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

应用权限 积分 -> 外部积分-总额查询

注意事项

请求参数


请求头参数

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

公共参数

参数名称参数说明请求类型是否必须数据类型schema
openids身份识别标识集合bodyfalsearray身份识别标识
phoneList手机号码列表bodyfalsearray手机号码
audienceUserId客户档案IDbodyfalselong
instanceAppId自建应用appidstringtrueString
thirdCompanyId开放平台登陆componyIdstring非开放平台用户为空String
orgId企业idstringtrueString

身份识别标识

参数名称参数说明请求类型是否必须数据类型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,
	"openids": [
		{
			"appid": "",
			"fromTo": "",
			"identityId": "",
			"identityType": "",
			"jcappid": 0,
			"openid": "",
			"unionid": ""
		}
	],
	"orgId": "d515fa4b-8def-4188-8415-92632581795c",
    "instanceAppId": "Ipu_t60KoV-gTTtCSkFMWtrkTIA",
    "thirdCompanyId": "0707",
	"phoneList": [
		{
			"isVerify": "",
			"phone": ""
		}
	]
}

响应参数


参数名称参数说明请求类型是否必须数据类型schema
code状态码bodytruestring
errorCode异常码bodytruestring
msg描述bodytruestring
data积分总额信息bodytrueobject积分总额信息

积分总额信息

参数名称参数说明请求类型是否必须数据类型schema
totalPoint累计积分bodytrueint
validPoint可用积分bodytrueint
expendPoint已消耗积分bodytrueint
expirePoint已过期积分bodytrueint

响应状态

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

响应示例

{
  "code": "200",
  "errorCode": "SUCCESS",
  "msg": "ok",
  "data": {
    "totalPoint": 30,
    "validPoint": 20,
    "expendPoint": 10,
    "expirePoint": 0
  }
}
  • 无标签