使用场景:

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


接口地址 自建应用配置

请求方式 POST

consumes ["application/json"]

produces ["application/json"]

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

应用权限 积分 -> 外部积分-明细查询

注意事项

请求参数


请求头参数

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

公共参数

参数名称参数说明请求类型是否必须数据类型schema
openids身份识别标识集合bodyfalsearray身份识别标识
phoneList手机号码列表bodyfalsearray手机号码
audienceUserIds客户档案ID集合,客户档案ID为long类型bodyfalsearray
exchangeTypes变动类型集合,1 获得;2 消耗;3 过期积分bodyfalsearray
startTime开始时间bodyfalsedate
endTime截止时间bodyfalsedate
pageNo页码,默认为1bodyfalseint
pageSize页面大小,默认为20bodyfalseint
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,
	"audienceUserIds": [860484273911119872],
	"endTime": "",
	"exchangeTypes": [],
	"openids": [
		{
			"appid": "",
			"fromTo": "",
			"identityId": "",
			"identityType": "",
			"jcappid": 0,
			"openid": "",
			"unionid": ""
		}
	],
	"orgId": "d515fa4b-8def-4188-8415-92632581795c",
    "instanceAppId": "Ipu_t60KoV-gTTtCSkFMWtrkTIA",
    "thirdCompanyId": "0707",
	"pageNo": 1,
	"pageSize": 10,
	"phoneList": [
		{
			"isVerify": "",
			"phone": ""
		}
	],
	"startTime": ""
}

响应参数


参数名称参数说明请求类型是否必须数据类型schema
code状态码bodytruestring
errorCode异常码bodytruestring
msg描述bodytruestring
data积分明细分页结果bodytrueobject积分明细分页结果

积分明细分页结果

参数名称参数说明请求类型是否必须数据类型schema
pageNo页码bodytrueint
pageSize页面大小bodytrueint
sort排序规则bodytruestring
order排序字段bodytruestring
totalCount总记录数bodytrueint
list当页数据bodytruearray积分明细信息

积分明细信息

参数名称参数说明请求类型是否必须数据类型schema
pointRecordId积分记录IDbodyfalselong
pointRuleId积分规则IDbodyfalselong
orgId企业IDbodytruestring
audienceUserId客户档案IDbodytruestring
nickName用户昵称bodyfalseint
avatar用户头像bodyfalsestring
contentId内容IDbodyfalsestring
contentName内容名称bodyfalsestring
eventType行为类型bodyfalsestring
exchangeType变动类型,1 获得;2 消耗;3 过期积分bodytrueint
exchangePoint变动积分值bodytrueint
remark备注bodytruestring
actionTime操作时间bodytruedate
pointSource积分来源 1 行为积分 2 分销积分bodyfalseint
ext扩展信息bodyfalsestring

响应状态

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

响应示例

{
  "code": "200",
  "errorCode": "SUCCESS",
  "msg": "ok",
  "data": {
    "pageNo": 1,
    "pageSize": 10,
    "sort": "desc",
    "order": "action_time",
    "totalCount": 4,
    "list": [
      {
        "pointRecordId": null,
        "pointRuleId": null,
        "orgId": "d515fa4b-8def-4188-8415-92632581795c",
        "audienceUserId": "860484273911119872",
        "nickName": null,
        "avatar": null,
        "contentId": null,
        "contentName": null,
        "eventType": "",
        "exchangeType": 2,
        "exchangePoint": 10,
        "remark": "测试减少",
        "actionTime": 1636025874340,
        "pointSource": 1,
        "ext": "{\"relateBizCode\":\"业务编码\"}"
      }
    ]
  }
}
  • 无标签