企业内部开发 客户端API WECOM-JSSDK 开放接口 创建企业微信登录面板
创建企业微信登录面板
最后更新:2024/04/12
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
创建企业微信登录面板
最后更新:2024/04/12

目录

  • ww.createWWLoginPanel(options)
  • 功能描述
  • 参数说明
  • options: Object
  • 返回说明
  • 使用场景
  • 特别说明
  • ww.createWWLoginPanel(options)

    功能描述

    初始化企业微信Web登录组件,创建登录面板。

    // 初始化登录组件
    const wwLogin = ww.createWWLoginPanel({
      el: '#ww_login',
      params: {
        login_type: 'CorpApp',
        appid: 'wwbbb6a7b539f2xxxxx',
        agentid: '10000xx',
        redirect_uri: 'https://work.weixin.qq.com',
        state: 'loginState',
        redirect_type: 'callback',
      },
      onCheckWeComLogin({ isWeComLogin }) {
        console.log(isWeComLogin)
      },
      onLoginSuccess({ code }) {
        console.log({ code })
      },
      onLoginFail(err) {
        console.log(err)
      },
    })

    参数说明

    options: Object

    属性类型默认值必填说明最低版本
    elstring / Element

    登录组件挂载元素

    可以指定 DOM 元素或 CSS 选择器

    paramsObject

    登录参数

    属性类型默认值必填说明最低版本
    login_typestring

    登录类型

    appidstring

    AppID

    登录类型为企业自建应用/服务商代开发应用时填企业 CorpID,第三方登录时填登录授权 SuiteID

    agentidstring

    企业自建应用/服务商代开发应用 AgentID

    redirect_uristring

    登录成功重定向 url

    无需进行 URLEncode

    statestring

    登录 state

    用于保持请求和回调的状态,授权请求后原样带回给企业。该参数可用于防止 CSRF 攻击(跨站请求伪造攻击),
    建议带上该参数,可设置为简单的随机数加 session 进行校验

    redirect_typestring

    登录成功跳转类型

    合法值说明
    top

    默认 top window 顶层页面跳转

    callback

    通过 onLoginSuccess 回调用户授权 code,开发者自行处理跳转

    self

    登录组件跳转

    panel_sizestring

    登录面板大小

    合法值说明
    middle

    默认: 480x416px

    small

    小尺寸: 320x380px

    langstring

    语言类型

    合法值说明
    zh

    中文

    en

    英文

    onCheckWeComLoginFunction

    获取企业微信桌面端登录状态回调

    参数

    event: Object

    属性类型默认值必填说明最低版本
    isWeComLoginboolean

    企业微信桌面端是否已登录

    onLoginSuccessFunction

    企业微信登录成功回调

    需配置 redirect_type=callback

    参数

    res: Object

    属性类型默认值必填说明最低版本
    codestring

    Auth Code

    onLoginFailFunction

    企业微信登录错误回调

    登录相关错误码

    参数

    res: Object

    属性类型默认值必填说明最低版本
    errCodenumber

    错误码

    errMsgstring

    错误信息

    onOpenInWecomFunction

    打开企业微信客户端成功回调

    返回说明

    Object

    属性类型默认值必填说明最低版本
    elHTMLIFrameElement

    登录面板 iframe 元素

    unmountFunction

    卸载登录面板

    使用场景

    特别说明

    ww.createWWLoginPanel 使用场景:在桌面端系统浏览器中直接初始化Web登录组件,无需调用 ww.registerww.checkJsApi等接口。

    上一篇
    语音转文字
    下一篇
    预览文件