小程序
取消
开发
中文
EN
取消
  • 服务端

    • # 延时调用云函数

    调试诊断

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

    接口英文名：addDelayedFunctionTask

    该接口用于延时调用云函数。

    # 1. 调用方式

    # HTTPS 调用

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

    # 云调用

    • 调用方法：cloudbase.addDelayedFunctionTask

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

    # 第三方调用

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

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

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

    # 2. 请求参数

    # 查询参数 Query String Parameters

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

    # 请求体 Request Payload

    参数名类型必填说明
    envstring是环境ID
    function_namestring是函数名称
    datastring是发送的数据包，格式必须为JSONString
    delay_timenumber是延迟时间，单位：秒，合法范围：6秒-30天

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber错误码
    errmsgstring错误信息

    # 4. 注意事项

    本接口无特殊注意事项

    # 5. 代码示例

    # 5.1 HTTPS调用

    请求示例

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

    返回示例

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

    # 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.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"
}

    # 6. 错误码

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

    错误码错误描述解决方案
    -501000Param Invalid: env check invalid be filterd
    -1000system error系统错误

    # 7. 适用范围

    本接口在不同账号类型下的可调用情况：
    小程序小游戏第三方平台
    ✔ ✔ 〇
    • ✔：该账号可调用此接口。
    • 〇：第三方平台可使用 component_access_token 调用，是否支持代商家调用需看本文档 调用方式 部分。
    • 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。