# 云开发上报接口

调试工具

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

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

# 接口说明

# 接口英文名

cloudbaseReportAPI

# 功能描述

该接口为云开发通用上报接口。

# 调用方式

# HTTPS 调用


POST https://api.weixin.qq.com/tcb/cloudbasereport?access_token=ACCESS_TOKEN 

# 云调用

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

  • 接口方法为: openapi.cloudbase.report

# 第三方调用

  • 调用方式以及出入参和HTTPS相同,仅是调用的token不同

  • 该接口所属的权限集id为:49、64

  • 服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用

# 请求参数

属性 类型 必填 说明
access_token string 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用access_token或者authorizer_access_token
report_action string 上报动作,目前支持(sendSmsTask:发送短信;openH5:H5 打开)
env_id string 环境 ID
activity_id string 活动 ID
task_id string 任务 ID【report_action 取 sendSmsTask 时必填】
phone_count string 下发手机号数量【report_action 取 sendSmsTask 时必填】
channel_id string 渠道 ID(云开发 CMS 使用 cms_sms)【report_action 取 openH5 时必填】
session_id string 会话 ID【report_action 取 openH5 时必填】

# 返回参数

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

# 调用示例

示例说明: sendSmsTask 请求数据示例

# 请求数据示例


{
  "report_action": "sendSmsTask",
  "env_id": "xxx",
  "activity_id": "xxx",
  "task_id": "xxx",
  "phone_count": "12345"
} 

# 返回数据示例


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

示例说明: 云函数调用示例

# 请求数据示例


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.report({
        "reportAction": 'sendSmsTask',
        "envId": 'xxx',
        "activityId": 'xxx',
        "taskId": 'xxx',
        "phoneCount": '12345'
      })
    return result
  } catch (err) {
    return err
  }
} 

# 返回数据示例


{
  "errCode": 0,
  "errMsg": "openapi.cloudbase.report:ok"
} 

# 错误码

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