invokeCloudFunction

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

触发云函数。注意：HTTP API 途径触发云函数不包含用户信息。

请求地址

  1. POST https://api.weixin.qq.com/tcb/invokecloudfunction?access_token=ACCESS_TOKEN&env=ENV&name=FUNCTION_NAME

请求参数

属性类型默认值必填说明
access_tokenstring是接口调用凭证
envstring是云开发环境ID
namestring是云函数名称
POSTBODYstring是云函数的传入参数，具体结构由开发者定义。

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息
resp_datastring云函数返回的buffer

errcode 的合法值

值说明最低版本
0请求成功
-1系统错误
-1000系统错误
40014AccessToken 不合法
40101缺少必填参数
41001缺少AccessToken
42001AccessToken过期
43002HTTP METHOD 错误
44002POST BODY 为空
85088该APP未开通云开发
其他错误码云开发错误码

示例代码

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

返回数据示例

  1. {
  2.     "errcode": 0,
  3.     "errmsg": "ok",
  4.     "resp_data": "{\"event\":{\"userInfo\":{\"appId\":\"SAMPLE_APPID\"}},\"appid\":\"SAMPLE_APPID\"}"
  5. }

Tips

  • 使用本API触发云函数，在云函数中无法获取OpenID等用户相关信息，无法使用涉及用户登录态的其他API。
  • 注意 POST BODY 部分会传递给云函数作为输入参数。
  • 由 HTTP API 触发的云函数可以使用云调用。
  • 由 HTTP API 触发云函数的超时时间为5s，请注意云函数的执行时间不能过长。