# 删除已上报KV数据

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:storage.removeUserStorage

本接口用于删除已经上报到微信的 key-value 数据。

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 调用方法:storage.removeUserStorage

  • 调用说明:openid(用户唯一标识符)需作为参数传入,详情查看下文调用示例

  • 出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档。

# 第三方调用

  • 本接口不支持第三方平台调用。

# 2. 请求参数

# 查询参数 Query String Parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_token
openidstring-用户唯一标识符
signaturestring-用户登录态签名,签名算法请参考用户登录态签名算法
sig_methodstring-用户登录态签名的哈希方法,如 hmac_sha256 等,请参考用户登录态签名算法

# 请求体 Request Payload

参数名类型必填说明
keyarray要删除的数据 key 列表

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

# 5.1 HTTP 示例

请求示例

{
    "key": ["gold", "score"]
}

返回示例

{
    "errcode": 0,
    "errmsg": "ok"
}

# 5.2 云调用示例

请求示例

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

返回示例

{
    "errcode": 0,
    "errmsg": 0
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述
-1系统繁忙,此时请开发者稍候再试
0请求成功

# 7. 适用范围

本接口支持「小游戏」账号类型调用。其他账号类型如无特殊说明,均不可调用。

点击咨询小助手