ww.register - 文档 - 企业微信开发者中心

第三方应用开发

快速入门服务端API 客户端API 工具与资源运营规范附录更新日志联系我们

第三方应用开发

客户端API

WECOM-JSSDK

基础接口

ww.register

最后更新：2023/03/30

ww.register(options)

功能描述

注册应用信息。

ww.register({
  corpId: 'ww7ca4776b2a70000',
  jsApiList: ['getExternalContact'],
  getConfigSignature
})

参数说明

options: Object

属性

类型

默认值

必填

说明

最低版本

corpId

string

是

当前用户所属企业 ID

agentId

string / number

否

当前第三方应用 AgentID

suiteId

string

否

应用套件 ID

jsApiList

string[]

否

需要使用的JS接口列表

openTagList

string[]

否

需要使用的开放标签列表，例如['wx-open-launch-app']

getConfigSignature

Function

否

config 签名生成函数

参数

url: string

用于生成签名的 URL

返回值

Object / Promise<Object>

属性	类型	必填	说明
timestamp	string / number	是	生成签名的时间戳
nonceStr	string	是	生成签名的随机串
signature	string	是	签名

onConfigSuccess

Function

否

config 成功回调

参数

res: Object

属性	类型	必填	说明
checkResult	Object	是	jsApiList 权限检查结果
errMsg	string	是	通用错误信息
errCode	number	是	通用错误码

onConfigFail

Function

否

config 失败回调

参数

res: Error / Object

	属性	类型	默认值	必填	说明	最低版本
	errMsg	string		是	通用错误信息
	errCode	number		是	通用错误码

onConfigComplete

Function

否

config 完成回调

参数

res: Error / Object

可能为以下类型

	属性	类型	默认值	必填	说明	最低版本
	errMsg	string		是	通用错误信息
	errCode	number		是	通用错误码

或

属性	类型	必填	说明
checkResult	Object	是	jsApiList 权限检查结果
errMsg	string	是	通用错误信息
errCode	number	是	通用错误码

getAgentConfigSignature

Function

否

agentConfig 签名生成函数

参数

url: string

用于生成签名的 URL

返回值

Object / Promise<Object>

属性	类型	必填	说明
timestamp	string / number	是	生成签名的时间戳
nonceStr	string	是	生成签名的随机串
signature	string	是	签名

onAgentConfigSuccess

Function

否

agentConfig 成功回调

参数

res: Object

属性	类型	必填	说明
checkResult	Object	是	jsApiList 权限检查结果
errMsg	string	是	通用错误信息
errCode	number	是	通用错误码

onAgentConfigFail

Function

否

agentConfig 失败回调

参数

res: Error / Object

	属性	类型	默认值	必填	说明	最低版本
	errMsg	string		是	通用错误信息
	errCode	number		是	通用错误码

onAgentConfigComplete

Function

否

agentConfig 完成回调

参数

res: Error / Object

可能为以下类型

	属性	类型	默认值	必填	说明	最低版本
	errMsg	string		是	通用错误信息
	errCode	number		是	通用错误码

或

属性	类型	必填	说明
checkResult	Object	是	jsApiList 权限检查结果
errMsg	string	是	通用错误信息
errCode	number	是	通用错误码

getSuiteConfigSignature

Function

否

suiteConfig 签名生成函数

参数

url: string

用于生成签名的 URL

返回值

Object / Promise<Object>

属性	类型	必填	说明
timestamp	string / number	是	生成签名的时间戳
nonceStr	string	是	生成签名的随机串
signature	string	是	签名

附加说明

参数中的回调函数（如 getConfigSignature、onConfigSuccess 等）调用时机由 JSSDK 自行控制，开发者无需关心具体的调用顺序。在非微信、企业微信内置浏览器的环境下，JSSDK 不会主动调用 getConfigSignature 回调。