使用场景:
当积分主体配置为“外部积分系统”时,触发积分总额查询业务时,积分集成服务会请求积分类型自建应用中所配置的接口地址。企业查询用户积分
Markdown |
---|
**接口地址** `自建应用配置``/api/open/audience/point/list` **请求方式** `POST``GET` **consumes** `["application/jsonx-www-form-urlencoded"]` **produces** `["application/json"]` **接口描述** `企业级接口,hearer必须携带X-Token` **应用权限** `积分 -> 外部积分-总额查询``无需授权` **注意事项** # 请求参数 #请求参数 *** ### 请求头参数###请求头参数 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | X-Token | 自建应用访问token | header | true | string | | ### 公共参数 ###公共参数 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | orgIdnonce | 企业ID6位随机字符串 | bodyparam | falsetrue | string | | | appInstanceIdtimestamp | 应用实例ID | body | false | long | | | openids | 身份识别标识集合 | body | false | array | [身份识别标识](#身份识别标识) | | phoneList | 手机号码列表 | body | false | array | [手机号码](#手机号码) | | audienceUserId | 客户档案ID | body | false | unix时间戳(毫秒) | param | true | long | | ### 身份识别标识 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | openid | | body | false | string | | | unionid | | body | false | string | | | fromTo | 应用类型(contentminiapp:小程序, workwechat:企业微信外部联系人, gzh:公众号, workwechatgroup:客户群) | body | false | string | | | appid | 应用ID | body | false | string | | | jcappid | 系统集成应用实例ID | body | false | long | | | identityId | 身份识别类型ID | body | false | string | | | identityType | 身份识别类型(phone: 手机号码, id: 第三方用户ID, openid: 公众号openid, unionid: 开放平台unionid) | body | false | string | | ### 手机号码 | ###用户积分查询条件 - **查询限制** ID集合总长度最大为100 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | phoneaudienceUserIds | 手机号用户ID集合 | bodyparam | false | stringLong[] | | | isVerifythirdIds | 是否验证(0:未验证, 1:已验证) 第三方用户ID集合 | bodyparam | false | stringString[] | | ### 请求示例 ###请求示例 ```json { "appInstanceId": 0, "audienceUserId": 860484273911119872, "openids": [ { "appid": "", "fromTo": "", "identityId": "", "identityType": "", "jcappid": 0, "openid": "", "unionid": "" } ], "orgId": "d515fa4b-8def-4188-8415-92632581795c", "phoneList": [ { "isVerify": "", "phone": "" } ] }``` https:// ``` # 响应参数 #响应参数 *** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | code | 状态码 | body | true | string | | | errorCode | 异常码 | body | true | string | | | msg | 描述 | body | true | string | | | data | 积分总额信息响应数据 | body | true | objectarray | [积分总额信息用户积分](#积分总额信息#用户积分) | ### 积分总额信息 ###用户积分 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ----------- | ---------- | -------- | -------- | -------- | ------ | | totalPointaudienceUserId | 累计积分用户ID | body | false | Long | true| | thirdId | 第三方用户ID | intbody | false | String | | | validPointtotalPointSum | 可用积分 总积分 | body | true | int | | | validPointSum | 剩余可用积分 | body | true | int | | | expendPointexpendPointSum | 已消耗积分已使用积分 | body | true | int | | | expirePointSum | 已过期积分 | body | true | int | | | expirePointmemberFlag | 已过期积分 是否是会员(0:否, 1:是) | body | true | int | | | memberLevel | 会员等级 | body | true | String | | ### 响应状态###响应状态 | 状态码 | 说明 | schema | | ------ | ------ | ------ | | 200 | OK | | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 响应示例 ###响应示例 ```json { "code": "200", "errorCode": "SUCCESS", "msg": "ok", "data": { "totalPointdata": 30,[ "validPoint": 20, "expendPoint": 10, "expirePoint": 0 }] } ``` |