使用场景:
当积分主体配置为“外部积分系统”时,触发积分增加业务时,积分集成服务会请求积分类型自建应用中所配置的接口地址。
接口地址 自建应用配置
请求方式 POST
consumes ["application/json"]
produces ["application/json"]
接口描述 企业级接口,hearer必须携带X-Token
应用权限 积分 -> 外部积分-增加
注意事项 可配置接口安全加密,当勾选数据安全传输加密算法时,会校验是否开通数据安全功能,并配置了加密方式。此时接口入参只有密文,参数名:encryptStr
请求参数
请求头参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
X-Token | 自建应用访问token | header | true | string |
公共参数
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | 备注 |
---|---|---|---|---|---|---|
openids | 身份识别标识集合 | body | false | array | 身份识别标识 | |
phoneList | 手机号码列表 | body | false | array | 手机号码 | |
audienceUserId | 客户档案ID | body | false | long | ||
point | 积分变动值 | body | true | int | ||
remark | 备注 | body | true | string | ||
eventType | 行为类型 | body | false | string | ||
avatar | 用户头像 | body | false | string | ||
nickName | 用户昵称 | body | false | string | ||
contentId | 内容ID | body | false | string | ||
contentName | 内容名称 | body | false | string | ||
ext | 扩展信息 | body | false | string | json字符串 |
流程策略扩展信息字段 ext
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
componentId | 插件id | body | false | string | |
strategyId | 策略id | body | false | string | |
strategyName | 策略名称 | body | false | string |
身份识别标识
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | 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 |
手机号码
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
---|---|---|---|---|---|
phone | 手机号 | body | false | string | |
isVerify | 是否验证(0:未验证, 1:已验证) | body | false | string |
请求示例
{
"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 | 状态码 | body | true | string | |
errorCode | 异常码 | body | true | string | |
msg | 描述 | body | true | string | |
data | 操作是否成功 | body | true | boolean |
响应状态
状态码 | 说明 | schema |
---|---|---|
200 | OK | |
201 | Created | |
401 | Unauthorized | |
403 | Forbidden | |
404 | Not Found |
响应示例
{
"code": "200",
"errorCode": "SUCCESS",
"msg": "ok",
"data": true
}