cloudbase.report

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

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

云开发通用上报接口

调用方式:

HTTPS 调用

请求地址

POST https://api.weixin.qq.com/tcb/cloudbasereport?access_token=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 时必填】

返回值

Object

返回的 JSON 数据包

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

errcode 的合法值

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

sendSmsTask 请求数据示例

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

openH5 请求数据示例

{
  "report_action":"openH5",
  "env_id":"xxx",
  "activity_id":"xxx",
  "channel_id":"xxx",
  "session_id":"xxx"
}

返回数据示例

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

云调用

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

接口方法

openapi.cloudbase.report

需在 config.json 中配置 cloudbase.report API 的权限,详情

请求参数

属性 类型 默认值 必填 说明
reportAction string 上报动作,目前支持(sendSmsTask:发送短信;openH5:H5 打开)
envId string 环境 ID
activityId string 活动 ID
taskId string 任务 ID【report_action 取 sendSmsTask 时必填】
phoneCount string 下发手机号数量【report_action 取 sendSmsTask 时必填】
channelId string 渠道 ID(云开发 CMS 使用 _cms_sms_)【report_action 取 openH5 时必填】
sessionId string 会话 ID【report_action 取 openH5 时必填】

返回值

Object

返回的 JSON 数据包

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

errCode 的合法值

说明 最低版本
0 成功

异常

Object

抛出的异常

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

errCode 的合法值

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

sendSmsTask 请求数据示例

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
  }
}

openH5 请求数据示例

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": 'openH5',
        "envId": 'xxx',
        "activityId": 'xxx',
        "channelId": 'xxx',
        "sessionId": 'xxx'
      })
    return result
  } catch (err) {
    return err
  }
}

返回数据示例

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