pendingToken
云函数调用文档
功能描述
pendingToken
云函数用于对用户进行积分操作。支持购物赠送、退货扣除、其他操作等功能,并能通过微信订阅消息通知用户积分变动情况。
参数说明
输入参数 event
参数名 |
类型 |
必填 |
说明 |
id |
String |
否 |
目标用户的 _id ,如果未提供,将通过 openid 获取 |
openid |
String |
是 |
目标用户的 openid |
number |
Number |
是 |
操作的积分数额,正数表示增加,负数表示减少 |
mark |
String |
是 |
操作类型描述,如“购物赠送”或“退货扣除积分” |
module |
String |
否 |
模块名称,需与 moduleId 一同存在或不存在 |
moduleId |
String |
否 |
模块 ID,需与 module 一同存在或不存在 |
orderId |
String |
视情况必填 |
当 mark 为“购物赠送”或“退货扣除积分”时,orderId 必填 |
输出参数
参数名 |
类型 |
说明 |
success |
Boolean |
操作是否成功 |
resId |
String |
积分流水记录的 _id ,仅在操作成功时返回 |
error |
String |
错误信息,操作失败时返回 |
返回值
- 成功时,返回
success: true
和生成的积分流水 resId
。 - 失败时,返回
success: false
以及错误信息 error
。
调用示例
const cloud = require('wx-server-sdk')
cloud.init()
// 调用 `pendingToken` 云函数的示例
exports.main = async (event, context) => {
const res = await cloud.callFunction({
name: 'pendingToken',
data: {
id: 'USER_ID',
openid: 'USER_OPENID',
number: 100,
mark: '购物赠送',
module: '商城',
moduleId: 'MODULE_ID',
orderId: 'ORDER_ID'
}
})
if (res.result.success) {
console.log('积分操作成功,流水ID:', res.result.resId)
} else {
console.error('积分操作失败,错误信息:', res.result.error)
}
}