@wecom/cloudbase-framework-plugin

@wecom/cloudbase-framework-plugin

云开发 CloudBase Framework 框架「企业微信第三方应用」插件：通过云开发 CloudBase Framework 框架将企业微信第三方应用一键部署到云开发环境。

Usage

通过云函数调用插件提供的能力：

const res = await app.callFunction({
  name: 'ww-action',
  data: {
    name: 'getSuiteTicket',
    data: { suiteId }
  }
})

console.log(res.result.suiteTicket)

Inputs

属性	类型	必填	默认值	说明
providerId	string	是		服务商企业 ID
providerSecret	string	是		ProviderSecret
token	string	是		加解密 Token
encodingAESKey	string	是		加解密 encodingAESKey
suiteList	Array	是		第三方应用列表
callbackEntry	string	否	/ww-callback	企业微信回调函数入口
customCallbackFunction	string	否		自定义企业微信回调处理函数
debug	boolean	否	false	开启 debug 模式

Actions

getSuiteTicket

获取第三方应用 ticket

参数

属性	类型	必填	说明
suiteId	string	是	第三方应用 ID

返回

属性	类型	说明
suiteTicket	string	第三方应用 ticket

getSuiteSecret

获取第三方应用 secret

参数

属性	类型	必填	说明
suiteId	string	是	第三方应用 ID

返回

属性	类型	说明
suiteSecret	string	第三方应用 secret

setSuiteSecret

设置第三方应用 secret

参数

属性	类型	必填	说明
suiteId	string	是	第三方应用 ID
suiteSecret	string	是	第三方应用 secret

getSuiteAccessToken

获取第三方应用凭证

参数

属性	类型	必填	说明
suiteId	string	是	第三方应用 ID

返回

属性	类型	说明
suiteAccessToken	string	第三方应用

consumeAuthCode

消费临时授权码并记录企业授权信息

参数

属性	类型	必填	说明
suiteId	string	是	第三方应用 ID
code	string	是	临时授权码

返回

属性	类型	说明
permanentCode	string	永久授权码
corpId	string	授权企业 ID
agentId	number	授权企业应用 ID
response	Object	OpenAPI 返回数据

getAuthInfo

获取企业授权信息

参数

属性	类型	必填	说明
suiteId	string	是	第三方应用 ID
corpId	string	是	授权企业 ID

返回

属性	类型	说明
permanentCode	string	永久授权码
agentId	number	授权方应用 ID

setAuthInfo

记录企业授权信息

参数

属性	类型	必填	说明
suiteId	string	是	第三方应用 ID
corpId	string	是	授权企业 ID
permanentCode	string	是	永久授权码
agentId	number	是	授权企业应用 ID

deleteAuthInfo

删除企业授权信息

参数

属性	类型	必填	说明
suiteId	string	是	第三方应用 ID
corpId	string	是	授权企业 ID

getCorpAccessToken

获取企业凭证

参数

属性	类型	必填	说明
suiteId	string	是	第三方应用 ID
corpId	string	是	授权企业 ID

返回

属性	类型	说明
corpAccessToken	string	企业凭证

getCorpJSAPITicket

获取企业 jsapi_ticket

参数

属性	类型	必填	说明
suiteId	string	是	第三方应用 ID
corpId	string	是	授权企业 ID

返回

属性	类型	说明
corpJSAPITicket	string	企业 jsapi_ticket

getAgentJSAPITicket

获取应用 jsapi_ticket

参数

属性	类型	必填	说明
suiteId	string	是	第三方应用 ID
corpId	string	是	授权企业 ID

返回

属性	类型	说明
agentJSAPITicket	string	企业 jsapi_ticket

getProviderAccessToken

获取服务商凭证

返回

属性	类型	说明
providerAccessToken	string	服务商凭证

request

请求企业微信 Open API

参数

属性	类型	必填	说明
name	string	是	API 名称
query	Object	否	请求 query 参数
body	Object	否	请求 body 参数
method	string	否	请求方法，请求有 body 时默认为 POST，否则默认为 GET

返回

Open API 返回数据

Collections

ww-provider-access-token

属性	类型	说明
provider_id	string	服务商 ID
provider_access_token	string	服务商凭证
timestamp	number	记录创建时间戳（毫秒）
expires_in	number	有效时间（毫秒）

ww-suite

属性	类型	说明
suite_id	string	第三方应用 ID
suite_secret	string	第三方应用 secret

ww-suite-ticket

属性	类型	说明
suite_id	string	第三方应用 ID
suite_ticket	string	第三方应用 ticket
timestamp	number	获取时间

ww-suite-access-token

属性	类型	说明
suite_id	string	第三方应用 ID
suite_access_token	string	第三方应用凭证
timestamp	number	记录创建时间戳（毫秒）
expires_in	number	有效时间（毫秒）

ww-auth-info

属性	类型	说明
suite_id	string	第三方应用 ID
corp_id	string	授权企业 ID
permanent_code	string	永久授权码
agent_id	number	授权企业方应用 ID
timestamp	number	授权时间

ww-corp-access-token

属性	类型	说明
suite_id	string	第三方应用 ID
corp_id	string	授权企业 ID
corp_access_token	string	企业凭证
timestamp	number	记录创建时间戳（毫秒）
expires_in	number	有效时间（毫秒）

ww-corp-jsapi-ticket

属性	类型	说明
suite_id	string	第三方应用 ID
corp_id	string	授权企业 ID
corp_jsapi_ticket	string	企业 jsapi_ticket
timestamp	number	记录创建时间戳（毫秒）
expires_in	number	有效时间（毫秒）

ww-agent-jsapi-ticket

属性	类型	说明
suite_id	string	第三方应用 ID
corp_id	string	授权企业 ID
agent_jsapi_ticket	string	应用 jsapi_ticket
timestamp	number	记录创建时间戳（毫秒）
expires_in	number	有效时间（毫秒）