cloudbase.report

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

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

云开发通用上报接口

调用方式:

HTTPS 调用

请求地址

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

请求参数

属性类型默认值必填说明
reportactionstring上报动作,目前支持(sendSmsTask:发送短信;openH5:H5 打开)
env_idstring环境 ID
activity_idstring活动 ID
task_idstring任务 ID【report_action 取 sendSmsTask 时必填】
phone_countstring下发手机号数量【report_action 取 sendSmsTask 时必填】
channel_idstring渠道 ID(云开发 CMS 使用 _cms_sms)【report_action 取 openH5 时必填】
session_idstring会话 ID【report_action 取 openH5 时必填】

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息

errcode 的合法值

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

sendSmsTask 请求数据示例

  1. {
  2. "report_action": "sendSmsTask",
  3. "env_id": "xxx",
  4. "activity_id": "xxx",
  5. "task_id": "xxx",
  6. "phone_count": "12345"
  7. }

openH5 请求数据示例

  1. {
  2. "report_action":"openH5",
  3. "env_id":"xxx",
  4. "activity_id":"xxx",
  5. "channel_id":"xxx",
  6. "session_id":"xxx"
  7. }

云调用

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

接口方法

  1. openapi.cloudbase.report

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

请求参数

属性类型默认值必填说明
reportActionstring上报动作,目前支持(sendSmsTask:发送短信;openH5:H5 打开)
envIdstring环境 ID
activityIdstring活动 ID
taskIdstring任务 ID【reportaction 取 sendSmsTask 时必填】
phoneCountstring下发手机号数量【report_action 取 sendSmsTask 时必填】
channelIdstring渠道 ID(云开发 CMS 使用 _cms_sms)【report_action 取 openH5 时必填】
sessionIdstring会话 ID【report_action 取 openH5 时必填】

返回值

Object

返回的 JSON 数据包

属性类型说明
errCodenumber错误码
errMsgstring错误信息

errCode 的合法值

说明最低版本
0成功

异常

Object

抛出的异常

属性类型说明
errCodenumber错误码
errMsgstring错误信息

errCode 的合法值

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

sendSmsTask 请求数据示例

  1. const cloud = require('wx-server-sdk')
  2. cloud.init({
  3. env: cloud.DYNAMIC_CURRENT_ENV,
  4. })
  5. exports.main = async (event, context) => {
  6. try {
  7. const result = await cloud.openapi.cloudbase.report({
  8. reportAction: 'sendSmsTask',
  9. envId: 'xxx',
  10. activityId: 'xxx',
  11. taskId: 'xxx',
  12. phoneCount: '12345'
  13. })
  14. return result
  15. } catch (err) {
  16. return err
  17. }
  18. }

openH5 请求数据示例

  1. const cloud = require('wx-server-sdk')
  2. cloud.init({
  3. env: cloud.DYNAMIC_CURRENT_ENV,
  4. })
  5. exports.main = async (event, context) => {
  6. try {
  7. const result = await cloud.openapi.cloudbase.report({
  8. reportAction: 'openH5',
  9. envId: 'xxx',
  10. activityId: 'xxx',
  11. channelId: 'xxx',
  12. sessionId: 'xxx'
  13. })
  14. return result
  15. } catch (err) {
  16. return err
  17. }
  18. }