...
| Markdown |
|---|
**接口地址** `自建应用配置` **请求方式** `POST` **consumes** `["application/json"]` **produces** `["application/json"]` **应用权限** `积分 -> 外部积分-增加` **注意事项** 可配置接口安全加密，当勾选数据安全传输加密算法时，会校验是否开通数据安全功能，并配置了加密方式。此时接口入参只有密文，参数名：encryptStr可配置接口安全加密，当勾选数据安全传输加密算法时，会校验是否开通数据安全功能，并配置了加密方式。此时接口入参只有密文，参数名：encryptStr，如果是开放平台企业，还有租户信息。 # 请求参数 *** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | 备注| | ------ | ------ | ------ | ------ | ------ | ------ |------ | | encryptStr| 密文 |body | true | string | | | | uid| 开放平台租户uid |body| false| pointRecordId | 积分记录id |body | true | long | | | | openids | 身份识别标识集合 | body | false | array | [身份识别标识](#身份识别标识) | | | string | | 开放平台租户才有该字段 | | companyId| 开放平台租户companyId |body | false | string | | 开放平台租户才有该字段 | # 密文解析后的参数 | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | 备注| | ------ | ------ | ------ | ------ | ------ | ------ | ------ | | pointRecordId | 积分记录id |body | true | long | | 220531新增| | 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（作品ID） | body | false | string | | | | contentName | 内容名称(作品名称) | body | false | string | | | | ext | 扩展信息 | body | false | string | | json字符串 | ### 流程策略扩展信息字段 ext | 参数名称 instanceAppId| 参数说明 自建应用appid | 请求类型string | 是否必须true | 数据类型String | schema | | ------ | ------ | ------ | ------ | ------ | ------ | componentId |插件id|body |false |string|| strategyId |策略id|body |false |string|| strategyName|策略名称|body |false |string||thirdCompanyId| 开放平台登陆componyId | string | 非开放平台用户为空 | String | | | orgId| 企业id | string | true | 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 | | ### 流程策略扩展信息字段 请求示例 ```json { "appInstanceId":"979696291682721792", "callbackBusinessType":7, "callbackData":[ext | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | componentId |插件id|body |false |string|| strategyId |策略id|body |false |string|| strategyName|策略名称|body |false |string|| ### 请求示例（密文解析后） ```json { "appInstanceId":979696291682721792, "audienceUserId":979745925260394496, "avatar":"https://thirdwx.qlogo.cn/mmopen/vi_32/DYAIOgq83eou6iaViaribcZsV1s7SmS4rgggam4RsCAaMpBJ7rEbuiaV6ofdr0Lm3g505HcTULCHRTj1DtTbrNmibXA/132", "contentId":"dc4223e3-98fe-41a8-b949-ca7614c2aea6", "contentName":"新增积分", "eventType":"pluginChangePoint ", "ext":"{\"componentId\":\"5d28387a-c0ad-492c-acc7-66d8b5ad586d\",\"strategyId\":\"strategy_1653630397090_2\",\"strategyName\":\"策略001\",\"conditionVoList\":[],\"actionVo\":{\"type\":\"plugin\",\"roleType\":null,\"objId\":\"5d28387a-c0ad-492c-acc7-66d8b5ad586d\",\"objExtInfo\":\"[]\",\"componentId\":\"5d28387a-c0ad-492c-acc7-66d8b5ad586d\",\"action\":\"AddPoints\",\"frontAction\":null,\"params\":\"{\\\"action\\\":\\\"AddPoints\\\",\\\"point\\\":\\\"5\\\",\\\"sourceDesc\\\":\\\"新增5个积分\\\",\\\"DATA_BACK_UP_CONTAINER\\\":[{\\\"key\\\":\\\"targetRecord\\\",\\\"value\\\":[\\\"Plugin\\\",[],\\\"5d28387a-c0ad-492c-acc7-66d8b5ad586d\\\"],\\\"nestedRecord\\\":null},{\\\"id\\\":\\\"action\\\",\\\"key\\\":\\\"action\\\",\\\"value\\\":\\\"AddPoints\\\",\\\"paramClass\\\":\\\"PointsNumberSourceActionParam\\\"},{\\\"id\\\":\\\"PointsNumberSourceActionParam\\\",\\\"key\\\":\\\"point\\\",\\\"value\\\":\\\"5\\\",\\\"disableValid\\\":false},{\\\"id\\\":\\\"PointsNumberSourceActionParam_point\\\",\\\"key\\\":\\\"sourceDesc\\\",\\\"value\\\":\\\"新增5个积分\\\",\\\"disableValid\\\":true}],\\\"DATA_BACK_UP_ROLELIST\\\":[]}\"}}", "nickName":"吃藕丑", "openids":[ { "appid":"wxff20c86c51a07c12", "identityType":"openid", "openid":"oQSOnwg7ZLIszZWxLsBJ1OxeJtlE" }, { "appid":"wxff20c86c51a07c12", "identityType":"unionid", "unionid":"oWE6r6ftaCI1GmDLUSIc_JVxgJIM" } ], "orgId":"5a5c8756-a342-4a04-ae01-07ff7bea936a", "instanceAppId": "Ipu_t60KoV-gTTtCSkFMWtrkTIA", "thirdCompanyId": "0707", "phoneList":[ "isVerify": "", "phone": "" ], "point":5, "pointRecordId":979752752991166464, "remark":"通过的策略001,获得5积分" } ], "orgId":"5a5c8756-a342-4a04-ae01-07ff7bea936a" } ``` # 响应参数 *** | 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema | | ------ | ------ | ------ | ------ | ------ | ------ | | code | 状态码 | body | true | string | | | errorCode | 异常码 | body | true | string | | | msg | 描述 | body | true | string | | | data | 客户方的积分记录id | body | true | string | | ### 响应状态 | 状态码 | 说明 | schema | | ------ | ------ | ------ | | 200 | OK | | | 201 | Created | | | 401 | Unauthorized | | | 403 | Forbidden | | | 404 | Not Found | | ### 响应示例 ```json { "code": "200", "errorCode": "SUCCESS", "msg": "ok", "data": "客户积分记录ID" } ``` |
...