# 延时调用云函数

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：addDelayedFunctionTask

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

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 调用方法：cloudbase.addDelayedFunctionTask

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

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

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

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "env",
    "类型": "string",
    "必填": "是",
    "说明": "环境ID"
  },
  {
    "参数名": "function_name",
    "类型": "string",
    "必填": "是",
    "说明": "函数名称"
  },
  {
    "参数名": "data",
    "类型": "string",
    "必填": "是",
    "说明": "发送的数据包，格式必须为JSONString"
  },
  {
    "参数名": "delay_time",
    "类型": "number",
    "必填": "是",
    "说明": "延迟时间，单位：秒，合法范围：6秒-30天"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

### 5.1 HTTPS调用

请求示例

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

返回示例

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

### 5.2 云函数调用

请求示例

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

返回示例

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

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "-501000",
    "错误描述": "Param Invalid: env check invalid be filterd",
    "解决方案": ""
  },
  {
    "错误码": "-1000",
    "错误描述": "system error",
    "解决方案": "系统错误"
  }
]
```

## 7. 适用范围

本接口在不同账号类型下的可调用情况：

```json
[
  {
    "小程序": "✔",
    "小游戏": "✔",
    "第三方平台": "〇"
  }
]
```

- ✔：该账号可调用此接口。
- 〇：第三方平台可使用 [component_access_token](/doc/oplatform/developers/dev/ComponentAccessToken.md) 调用，是否支持代商家调用需看本文档 调用方式 部分。
- 其他未明确声明的账号类型，如无特殊说明，均不可调用此接口。