执行函数
执行基于飞书应用引擎开发的应用的自定义函数
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/apaas/v1/applications/:namespace/functions/:function_api_name/invoke |
| HTTP Method | POST |
| 接口频率限制 | 10 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | app_engine:application.function:write 执行函数 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
namespace | string | 应用命名空间 示例值:"package_test__c" |
function_api_name | string | 函数 API 名称 示例值:"printParam" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
params | string | 否 | 函数输入参数(JSON 序列化后的字符串) 示例值:" {\"key1\":\"value1\",\"key2\":\"value2\",\"key3\":1718313981794}" |
请求体示例
json
{
"params": "{\"key1\":\"value1\",\"key2\":\"value2\",\"key3\":1718313981794}"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ result | string | 函数执行的返回结果(JSON 序列化后的字符串) |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"result": "{\"key1\":\"value1\",\"key2\":\"value2\",\"key3\":1718313981794}"
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 2320001 | param is invalid | 请检查输入参数 |
