触发云函数

触发云函数

调试工具

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

接口说明

接口英文名

invokeCloudFunction

功能描述

通过本接口可以触发云函数。 使用过程中如遇到问题，可在开放平台服务商专区发帖交流

注意事项

• 使用本 API 触发云函数，在云函数中无法获取 OpenID 等用户相关信息，无法使用涉及用户登录态的其他API。
• 注意 POST BODY 部分会传递给云函数作为输入参数。
• 由 HTTP API 触发的云函数可以使用云调用。
• 由 HTTP API 触发云函数的超时时间为5s，请注意云函数的执行时间不能过长。
• 如果是服务商模式-批量代云开发，则使用component_access_token；
• 如果是服务商模式-普通代云开发，则使用authorizer_access_token;
• 如果是小程序普通调用，则用access_token。

调用方式

HTTPS 调用

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

第三方调用

• 调用方式以及出入参和HTTPS相同，仅是调用的token不同
• 该接口所属的权限集id为：49、64
• 服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证，该参数为 URL 参数，非 Body 参数。使用access_token或者authorizer_access_token
env	string	是	云开发环境ID
name	string	是	云函数名称
req_data	string	是	云函数的传入参数，具体结构由开发者定义

返回参数

属性	类型	说明
errcode	number	错误码
errmsg	string	错误信息
resp_data	string	云函数返回的buffer

调用示例

示例说明: CURL请求示例

请求数据示例

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

返回数据示例

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

错误码

错误码	错误码取值	解决方案
-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未开通云开发