小组控制台 iframe 接入
本文档将详细介绍如何在您的网站中嵌入句子「小组控制台」。
iframe接入
iframe接入的形式,「小组控制台」将会隐藏左侧菜单和顶部,要将「小组控制台」相关功能页面嵌入您的网站,请使用iframe标签,并设置src属性为ssoUrl。例如:
<iframe src="https://miaohui.juzibot.com/sso/oidc?code=***&redirectPath=***"></iframe>
查询参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
code | string | 是 | sso授权code。 |
clientId | string | 是 | sso client id。 |
redirectPath | string | 否 | 跳转路径,需encodeURIComponent处理。 格式为:/main/:orgId/menuXxx/:groupId/yyy,可在“小组控制台”各个页面查看 url。 :groupId表示默认小组,多小组用户可将其替换为具体的小组 id。 :orgId表示默认企业, 请勿替换, 一个 sso用户应当只有一个企业 。 |
state | string | 否 | 附加此参数,要求同redirectPath。 部分企业 sso 安全过严,redirectPath只能是固定值无法达到传参的效果,可将state当做redirectPath传递。 |
hideHeader | string | 否 | 是否隐藏头部,true或false。如下图所示位置: |
visibleTabs | string | 否 | 可见标签页tabs,多个值用逗号隔开,为空时默认显示全部tabs。 不同页面有不同的tabs。具体可参考下表『不同页面的visibleTabs取值』。 示例:visibleTabs=list,config |
不同页面的visibleTabs取值
页面 | 描述 |
---|---|
群发相关页面 (包括:私聊群发、群聊群发、私聊SOP、群聊SOP) | list: 任务列表 loop: 循环任务 config: 群发设置 tabs如下图所示位置: |
示例代码
const ssoBaseUrl = 'https://miaohui.juzibot.com/sso/oidc'; // 注意:私有部署环境请替换为部署的域名
const redirectPath = encodeURIComponent('/main/:orgId/member-crm/:groupId/contact-list');
// 或将:groupId替换为具体小组 id
// const redirectPath = encodeURIComponent('/main/:orgId/member-crm/646d818baf71f175124fac59/contact-list');
const ssoUrl = `${ssoBaseUrl}?code=***&client_id=***&redirectPath=${redirectPath}`;
// 使用ssoUrl作为iframe的src属性值
document.getElementById('your-iframe-id').src = ssoUrl;