# cloudbase.addDelayedFunctionTask

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

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

延时调用云函数

调用方式:

# HTTPS 调用

# 请求地址

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

# 请求参数

属性 类型 默认值 必填 说明
access_token / cloudbase_access_token string 接口调用凭证
env string 环境ID
function_name string 函数名称
delay_time number 延迟时间,单位:秒,合法范围:6s-30天
data string 发送的数据包,格式必须为JSONString

# 返回值

# Object

返回的 JSON 数据包

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

# 请求数据示例

{
 "env": "test-env-6gni9ity244a6ea3",
 "function_name": "echo",
 "delay_time": 10,
 "data": "{\"test\":true}"
}

# 返回数据示例

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

# 云调用

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

# 接口方法

openapi.cloudbase.addDelayedFunctionTask

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

# 请求参数

属性 类型 默认值 必填 说明
env string 环境ID
functionName string 函数名称
delayTime number 延迟时间,单位:秒,合法范围:6s-30天
data string 发送的数据包,格式必须为JSONString

# 返回值

# Object

返回的 JSON 数据包

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

# 异常

# Object

抛出的异常

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

errCode 的合法值

说明 最低版本

# 请求数据示例

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.addDelayedFunctionTask({
        "env": 'test-env-6gni9ity244a6ea3',
        "data": '{\'test\":true}",
        "functionName": 'echo',
        "delayTime": 10
      })
    return result
  } catch (err) {
    return err
  }
}

# 返回数据示例

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