文档

网页应用和小程序对话窗部署

更新时间:

渠道部署是对话机器人为客户提供的快速接入功能,目前支持H5咨询窗口、PC的部署方式,支持卡片、模板等多种运营手段,丰富对话首页,可参考本文档将智能对话机器人快速接入到您的业务中

部署方式说明

独立页面部署:整个页面都是对话框,适用于移动端用户。

悬浮挂件部署:如阿里云官网右下角的AI助理,点击后显示一个对话框,适用于PC端用户。

独立页面部署

部署案例

2→点击“在线沟通”打开咨询页面 →3

部署配置

image

如图,配置好独立页面部署后,点击最下方的部署按钮后,再复制地址进行访问对应的独立页面。假如部署后无法打开聊天窗,建议检查网络是否配置了代理。

用户登录

独立页面部署默认是无需登录(游客身份)即可访问。如您现有系统中已存在用户登录逻辑,可以通过GenerateUserAccessToken - 获取用户免登Token接口,得到用户免登的Token,在url拼接上此Token。使用示例如下:

https://chatbot.aliyuncs.com/intl/index.htm?locale=zh-CN&from=xxx&_user_access_token=${Token}

悬浮挂件部署

部署案例

image

一般在PC网站的右下角提供一个按钮或者头像,用户点击后弹出一个对话窗口,在对话窗口中和机器人进行问答。

部署配置

image

  1. 悬浮按钮图标,如不配置则展示默认图标

  2. 悬浮按钮文案,如不填则不展示任何文字

  3. 悬浮页面地址(也叫“宿主页面地址”),输入悬浮挂件需要悬浮的页面地址,最多可添加20个

    1. 此地址只需页面地址,无需填写参数。例如商品详情页的为https://detail.tmall.com/item.html?id=58335634352721&spm=a1z10.1-b-s.w5003-112312312,只需填写https://detail.tmall.com/item.html

    2. 支持通配符,例如:https://*.aliyun.com

  4. 部署脚本,把部署脚本插入到悬浮的网站代码中,如下示例:

    <!DOCTYPE html>
    <html lang="en">
    <head>
        <meta charset="UTF-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <title>咨询助理</title>
    </head>
    <body>
        <!-- 复制的部署脚本 -->
        <script src="https://o.alicdn.com/mecloud/shell/dialog.js"></script>
        <script>
          window.AlimeDialog({
            from: 'xxxxxxxxx'
          });
        </script>
    </body>
    </html>

用户登录

悬浮挂件部署默认是无需登录(游客身份)即可访问。如您现有系统中已存在用户登录逻辑,可以通过GenerateUserAccessToken - 获取用户免登Token接口,得到用户免登的Token,在部署脚本中配置此参数即可。脚本示例如下:

<script src="https://o.alicdn.com/mecloud/shell/dialog.js"></script>
<script>
    window.AlimeDialog({
    from: 'xxxxxxxxx',
    params: { _user_access_token: '${Token}' }
    });
</script>

平台授权配置

微信公众号/小程序授权

进入微信H5管理页面点击微信授权管理可查看当前业务空间下的所有微信端授权;

image

微信公众号授权

  1. 关联微信点击新增授权微信新增微信授权,具体操作步骤如下:

    1. 新增授权信息,点击新增授权微信后,通过手机端扫码添加公众号扫码授权imageimage

    2. 绑定关联渠道,点击绑定至当前渠道,如下图为公众号已绑定状态。image

  1. 应用部署。点击部署按钮,然后使用独立页面部署中添加的链接,可配置到公众号的菜单栏按钮、自定回复中。image

微信小程序授权

  1. 关联微信。点击新增授权微信新增微信授权,具体操作步骤如下:

    1. 配置域名&下载授权文件,在微信小程序端完成域名配置和授权文件下载。操作路径:小程序页面→开发管理→开发设置→业务域名。imageimage

    2. 点击修改对应域名并完成下载校验文件image

      说明

      当微信小程序中绑定出现“域名最多被100个主体小程序绑定”时,请改为域名配置为“https://chatbot-001.biz.aliyun.com”,且小程序嵌入或者跳转到的渠道部署的url链接中的域名替换成此域名

    3. 点击新增授权微信后,通过手机端扫码添加小程序扫码授权imageimage

    4. 上传授权文件

      说明
      • 文件内容为第一步在微信端下载的校验文件,此处域名为自动生成。

      • 微信小程序需要上传授权文件,微信公众号则不需要上传授权文件。

      • 微信小程序会对授权文件进行校验,不允许其重复,故请确保有关授权文件未重复。

    5. 绑定关联渠道,点击绑定至当前渠道,如下图为小程序已绑定状态。image

重要
  1. 已经授权过的公众号/小程序,扫码则会提示:该公众号/小程序在其他业务空间下已授权,请先解绑后再操作。图1

  2. 解除绑定后,授权信息、已关联的渠道和关联数据都会自动删除。

报错图示如下:image

支付宝授权

点击“支付宝授权管理”可查看当前业务空间下的所有支付宝端授权;

image

关联支付宝小程序

  1. 关联支付宝小程序。点击“新增支付宝授权”可新增业务空间内支付宝授权;

  2. 新增域名&下载授权文件,在支付宝端完成域名配置和授权文件下载imageimage

  3. 点击新增支付宝小程序,填写支付宝端appid和对应账号名称。imageimage

  4. 上传授权文件,上传支付宝端下载的校验文件。image

  5. 关联当前已部署好的渠道image

  6. 部署。点击“部署”按钮才能生效。image

抖音小程序授权

点击“抖音授权管理”可查看当前业务空间下的所有抖音端授权;

image

关联抖音小程序

  1. 点击“新增抖音小程序”,填写抖音开放平台账号名称和对应AppID。image

  2. 上传抖音端下载的授权文件。image

  3. 域名配置。将“域名配置栏”的域名配置到抖音小程序的“h5域名配置”中image

  4. 抖音侧配置路径:控制台→我的应用→打开小程序→小程序配置页点击“前往配置”→点击“开发配置”→“服务器域名”→在“request合法域名”里添加配置。imageimageimage

  5. 关联当前已部署好的渠道image

  6. 部署。点击“部署”按钮才能生效。image

常见问题

安全校验如何去除?

聊天窗默认支持游客身份访问,为了防刷,游客访问时需要进行安全校验;通过接口GenerateUserAccessToken - 获取用户免登Token实现免登的用户访问,不会有安全校验。

用户咨询的聊天记录保存多久?

游客身份访问时会生成一个临时token,token有效期8小时,8小时后聊天记录会自动清除;如需要聊天记录长时间保存,可通过GenerateUserAccessToken - 获取用户免登Token接口,实现用户登录状态,聊天记录将长期保留。

调整悬浮挂件位置

悬浮挂件位置不支持配置,如果想调整,请参考下方代码根据自身需求添加到悬浮挂件代码中。

window.AlimeDialog({
  from: 'ptUzpffYsV',
  /** 后续配置请根据需要配置 */
  params: {
    _user_access_token: 'xxxxxxxx',
    /** 指定语言,zh-CN或者en-US  */
    locale: 'en-US',
  },

  /** [optional] 希望停靠的容器,可选,提供了之后,会计算容器的位置从而使服务窗悬浮在容器的一侧 */
  container: {
    /* 停靠容器的选择器 */
    selector: '#main',
    /* 值可以为 'left' 或者 'right',表示停靠在容器的左侧还是右侧,默认为 'right' */
    align: 'left',
    /* 基于容器位置做相对偏移,可选,x 为水平偏移量,y 为垂直偏移量,值必须是数字,可以是正数或者负数,默认单位为 px */
    offset: {
      x: 10,
      y: 25,
    },
  },
  /*
 // [可选] 在页面上出现的绝对位置
 // 注意:此配置移动端和pc端可能会有兼容问题,可以自己使用css选择器直接更改挂件位置
 // 可填入的属性为 'left', 'right', 'top', 'bottom',
 // 位置设置为固定数值时,填写数字即可,默认单位为 px, 例如:12,
 // 位置设置百分比时,默认填写格式为数字 + '%', 例如:'12%'。
 // 默认值:right: 40, bottom: 50
 // 同时设置 top & bottom 时,top 优先
 // 同时设置 left & right 时,left 优先 */
  position: {
    bottom: 100 /** 像素 */,
    right: '10%',
  },
});

假如需要修改悬浮挂件展示大小,可通过css覆盖样式,例如将挂件弹出大小改为800px

#J_xiaomi_dialog .J_Dialog {
    width: 800px !important;
    left: -804px !important;
}

#J_xiaomi_dialog .J_Dialog .alicare-frame {
   width: 800px  !important;
}

微信配置自定义菜单弹出“发布失败,链接内容不属于当前公众号”

请先在微信中认证,认证后的公众号中可以添加外链,没有认证只能填写你自己公众号的内容链接。

支持联想输入功能吗?

支持。联想输入效果:用户咨询手动输入问题时,自动根据知识库配置问法推荐相关问题供用户点选(见下图),降低用户输入成本的同时提升问题解决率。

image

在自研app中内嵌渠道部署网页,输入框被输入法遮挡如何解决?

请参考https://zhuanlan.zhihu.com/p/343569217文档进行解决。

调用通义系列大模型开发应用上架应用商店/微信小程序如何进行备案?

请参考调用通义系列大模型开发应用上架应用商店/微信小程序申请指南文档进行解决。

如何在渠道部署中传入变量?

要求传入的变量都必须添加_biz_作为变量的前缀,避免覆盖系统自带的运行信息。如果不添加此前缀,传入的参数将会被忽略。

独立页面部署传入

  1. 假设传入的变量为city=hangzhou

  2. 添加前缀后为:_biz_city=hangzhou,完整示例:https://chatbot.aliyuncs.com/intl/index.htm?locale=zh-CN&from=xx&_biz_city=hangzhou

  3. 在流程里引用需要此变量的地方,填写:${envVars['VENDOR_PARAM']['_biz_city']}

悬浮挂件部署传入

  1. 假设传入的变量为city: 'hangzhou'

  2. 添加前缀后为:_biz_city: 'hangzhou',完整示例:

    <script src="https://o.alicdn.com/mecloud/shell/dialog.js"></script>
    <script>
        window.AlimeDialog({
            from: 'xxxxx',
            params: {
                _user_access_token: '${Token}',
                _biz_city: 'hangzhou'
            }
        },
        );
    </script>
  3. 在流程里引用需要此变量的地方,填写:${envVars['VENDOR_PARAM']['_biz_city']}

登录的用户信息

  1. 通过GenerateUserAccessToken - 获取用户免登Token接口接入后,按照用户登录配置了免登后,可以在随路参数里拿到用户信息

  2. 在流程里引用需要用户信息的地方,按需填写变量表达式。例如:${envVars['VENDOR_PARAM']['userInfo']['extraInfo']['customerNameCard'][0]['value']}

  3. 可用的用户信息字段有

{
    "userInfo": {
        // 智能对话机器人客户用户体系id
        "id": 1018397757,
        // GenerateUserAccessToken接口传入的Nick
        "nick": "克霖",
        // GenerateUserAccessToken接口传入的ForeignId
        "foreignId": "b01f2f81",
        // GenerateUserAccessToken接口传入的Telephone
        "telephone": "1882222****",
        // GenerateUserAccessToken接口传入的Email
        "email": "xxx@aliyunid.com",
        // GenerateUserAccessToken接口传入的ExtraInfo
        "extraInfo": {
            "exp": 1221,
            "city": "hangzhou",
            "customerNameCard": [
                {
                    "value": "v2",
                    "key": "等级"
                }
            ]
        },
        // 用户类型,user为已登录的用户,guest为游客
        "userType": "user"
    }
}