小程序
取消
开发
中文
EN
取消
  • 指南

    • # 获取cloudID对应的数据

    调试诊断

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

    接口英文名：getOpenData

    该接口用于换取 cloudID 对应的开放数据

    # 1. 调用方式

    # HTTPS 调用

    POST https://api.weixin.qq.com/wxa/getopendata?access_token=ACCESS_TOKEN

    # 云调用

    • 调用方法：cloudbase.getOpenData

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

    # 第三方调用

    • 本接口支持第三方平台代商家调用。

    • 该接口所属的权限集 id 为：18、49

    • 服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。

    # 2. 请求参数

    # 查询参数 Query String parameters

    参数名类型必填说明
    access_tokenstring是接口调用凭证，可使用 access_token、authorizer_access_token

    # 请求体 Request Payload

    参数名类型必填说明
    cloudid_listarray是CloudID 列表

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber错误码
    errmsgstring错误信息
    data_listobjarray开放数据列表

    # Res.data_list(Array) Object Payload

    开放数据列表

    参数名类型说明
    cloud_idstringcloud id
    jsonstring数据详情

    # 4. 注意事项

    本接口无特殊注意事项

    # 5. 代码示例

    # 5.1 HTTPS调用

    请求示例

    // POST https://api.weixin.qq.com/wxa/getopendata?openid=OPENID&access_token=TOKEN
// url中支持传openid
{
 "cloudid_list": ["xxx"]
}

    返回示例

    {
  "errcode": 0,
  "errmsg": "ok",
  "data_list": [
    {
      "cloud_id": "xxx",
      "json": {
        "cloudID": "xxx",
        "data": {
          "stepInfoList": [
            {
              "timestamp": 1603641600,
              "step": 1234
            }
          ]
        }
      }
    }
  ]
}

    # 5.2 云函数调用

    请求示例

    const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.cloudbase.getOpenData({
        "cloudidList": [
          "xxx"
        ]
      })
    return result
  } catch (err) {
    return err
  }
}

    返回示例

    {
  "errCode": 0,
  "errMsg": "openapi.cloudbase.getOpenData:ok",
  "dataList": [
    {
      "json": {
        "cloudID": "xxx",
        "data": {
          "stepInfoList": [
            {
              "timestamp": 1603641600,
              "step": 1234
            }
          ]
        }
      },
      "cloudId": "xxx"
    }
  ]
}

    # 6. 错误码

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

    错误码错误描述解决方案
    -1system error系统繁忙，此时请开发者稍候再试

    # 7. 适用范围

    本接口在不同账号类型下的可调用情况：
    小程序公众号服务号小游戏
    ✔ ✔ ✔ ✔
    • ✔：该账号可调用此接口
    • 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口；