小友

mtl支持版本6.0.11及以上

插件名称:小友

初始化

initXiaoYou

支持平台

微信 友空间 安卓 iOS
✔︎ ✔︎

参数

字段 类型 必填 默认值 说明
bodyDomainId string
body中的领域区分标识
tenantid string
租户ID
domain string
VPA服务地址
token string
VPA机器人token
robotid string
机器人ID,指定意图
userid string
用户ID
yhtAccessToken string
友互通token
domainid string yonapppro 极速版APP标识
robotVersion string v2 机器人版本
isDialog boolean false 是否半屏显示
locale string zh_cn 语种
sessionid string
会话id
msgtype string text 消息类型
devicetype string app 设备类型
location obj null 用户所处位置说明
type number 0
showModel boolean true 是否移动端适配的卡片格式返回数据
testFlag boolean false 标记是否是测试状态
isShowInputBox boolean true 是否使用输入框
isShowHelpBox boolean true 是否显示帮助入口
bosTime number 3000 静音超时时间(1--10000ms)
eosTime number 1000 停止说话检测时间(1--10000ms)

示例

mtl.vui.initXiaoYou({
  domain: '',
  domainid: '',
  ...
  success: function(res) {
    // 成功回调
        ...
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

打开小友页面

openXiaoYou

支持平台

微信 友空间 安卓 iOS
✔︎ ✔︎

参数

字段 类型 必填 说明
registerCallback function 数据回调方法
callbackName stirng 方法名称

注意:6.0.6及以上去掉改registerCallback和callbackName, 数据会在success返回。
示例

mtl.vui.openXiaoYou({
  success: function(res) {
    // 成功回调
        ...
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

关闭小友页面

closeXY

支持平台

微信 友空间 安卓 iOS
✔︎ ✔︎

参数
-无-
示例

mtl.vui.closeXY({
  success: function(res) {
    // 成功回调
        ...
  },
  fail: function(err) {
    var message = err.message; // 错误信息
  }
});

是否仍需要帮助? 请保持联络!
最后更新于 2023/01/18