storage.removeUserStorage

本接口应在服务器端调用,详细说明参见服务端API

本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载),wx-server-sdk >= 0.4.0

删除已经上报到微信的key-value数据

调用方式:

HTTPS 调用

请求地址

POST https://api.weixin.qq.com/wxa/remove_user_storage?access_token=ACCESS_TOKEN&signature=SIGNATURE&openid=OPENID&sig_method=SIG_METHOD

请求参数

属性 类型 默认值 必填 说明
access_token string 接口调用凭证
openid string 用户唯一标识符
signature string 用户登录态签名,签名算法请参考用户登录态签名算法
sig_method string 用户登录态签名的哈希方法,如hmac_sha256等,请参考用户登录态签名算法
key string 要删除的数据key列表

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errcode number 错误码
errmsg number 错误信息

errcode 的合法值

说明 最低版本
0 请求成功
-1 系统繁忙,此时请开发者稍候再试

示例代码

curl -d '{ "key":["gold", "score"] }' \
'https://api.weixin.qq.com/wxa/remove_user_storage?access_token=ACCESS_TOKEN&signature=SIGNATURE&openid=OPENID&sig_method=SIG_METHOD'

云调用

云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

接口方法

openapi.storage.removeUserStorage

需在 config.json 中配置 storage.removeUserStorage API 的权限,详情

请求参数

属性 类型 默认值 必填 说明
openid string 用户唯一标识符
key string 要删除的数据key列表

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errCode number 错误码
errMsg number 错误信息

errCode 的合法值

说明 最低版本
0 成功

异常

Object

抛出的异常

属性 类型 说明
errCode number 错误码
errMsg number 错误信息

errCode 的合法值

说明 最低版本
-1 系统繁忙,此时请开发者稍候再试

SDK 调用示例

// cloud = require('wx-server-sdk')
// ...
// 方法返回 Promise
cloud.openapi.storage.removeUserStorage({
  key: ['a', 'b']
})