# 触发云函数

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

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

接口英文名：invokeCloudFunction

通过本接口可以触发指定云开发环境中的云函数。

云函数是云开发中运行在云端的代码，可用于处理业务逻辑。

**重要提示**：使用本 API 触发的云函数无法获取 OpenID 等用户登录态信息，因此无法使用涉及用户登录态的其他 API。

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 本接口不支持云调用。

### 第三方调用

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

- 该接口所属的权限集 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",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "env",
    "类型": "string",
    "必填": "是",
    "说明": "云开发环境 ID，用于指定要触发云函数的环境"
  },
  {
    "参数名": "name",
    "类型": "string",
    "必填": "是",
    "说明": "云函数名称，即要触发的云函数的函数名"
  },
  {
    "参数名": "req_data",
    "类型": "string",
    "必填": "是",
    "说明": "传递给云函数的输入参数，为 JSON 字符串格式。具体结构由开发者根据云函数业务逻辑自定义定义"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码，0 表示成功，其他值表示失败"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息，成功时返回 \"ok\""
  },
  {
    "参数名": "resp_data",
    "类型": "string",
    "说明": "云函数返回的数据，为 JSON 字符串格式。内容由云函数业务逻辑决定"
  }
]
```

## 4. 注意事项

- 使用本 API 触发云函数，在云函数中无法获取 OpenID 等用户相关信息，无法使用涉及用户登录态的其他 API。
- 注意 POST BODY 部分会传递给云函数作为输入参数。
- 由 HTTP API 触发的云函数可以使用云调用。
- 由 HTTP API 触发云函数的超时时间为 5s，请注意云函数的执行时间不能过长。
- 如果是服务商模式-批量代云开发，则使用 [component_access_token](/doc/oplatform/openApi/ticket-token/api_getcomponentaccesstoken)；
- 如果是服务商模式-普通代云开发，则使用 [authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken)；
- 如果是小程序普通调用，则使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken.md)。

## 5. 代码示例

请求示例

```
curl -d '{}' \
'https://api.weixin.qq.com/tcb/invokecloudfunction?access_token=ACCESS_TOKEN&env=ENV&name=login'
```

返回示例

```json
{
  "errcode": 0,
  "errmsg": "ok",
  "resp_data": "{\"event\":{\"userInfo\":{\"appId\":\"SAMPLE_APPID\"}},\"appid\":\"SAMPLE_APPID\"}"
}
```

## 6. 错误码

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

```json
[
  {
    "错误码": "-1",
    "错误描述": "system error",
    "解决方案": "系统繁忙，此时请开发者稍候再试"
  },
  {
    "错误码": "40014",
    "错误描述": "invalid access_token",
    "解决方案": "不合法的 access_token ，请开发者认真比对 access_token 的有效性（如是否过期），或查看是否正在为恰当的公众号调用接口"
  },
  {
    "错误码": "40101",
    "错误描述": "missing parameter",
    "解决方案": "缺少必填参数"
  },
  {
    "错误码": "41001",
    "错误描述": "access_token missing",
    "解决方案": "缺少 access_token 参数"
  },
  {
    "错误码": "42001",
    "错误描述": "access_token expired",
    "解决方案": "access_token 超时，请检查 access_token 的有效期，请参考基础支持 - 获取 access_token 中，对 access_token 的详细机制说明"
  },
  {
    "错误码": "43002",
    "错误描述": "require POST method",
    "解决方案": "需要 POST 请求"
  },
  {
    "错误码": "44002",
    "错误描述": "empty post data",
    "解决方案": "POST 的数据包为空。post请求body参数不能为空。"
  },
  {
    "错误码": "85088",
    "错误描述": "no qbase privilege",
    "解决方案": "该APP未开通云开发"
  }
]
```

## 7. 适用范围

本接口支持「第三方平台」账号类型代调用，权限集请参考「调用方式」部分。其他账号类型如无特殊说明，均不可调用。