web-vtm-sdk

1.19.0 • Public • Published

开始

快速上手

时代 VTM 视频提供了 Web 客户端 SDK,既包括音视频聊天界面的样式,也包含相应的业务逻辑。企业开发者可以方便的将视频客服功能集成到自己的系统中。

安装 web-vtm-sdk 之后,让我们来初始化创建一个实例,创建过程直截了当——仅需要提供一个在时代 VTM 后台管理系统注册好的租户 appKey 以及客服的用户名/手机号即可:

//快速实例化sdk函数
import TimesVtm from 'web-vtm-sdk'
// 创建 vtm 实例
const vtm = new TimesVtm({
  //租户账号
  account: 'xxx',
  //授权租户appkey (后续可前往vtm后管系统管理员索取)
  //vtm后管系统地址:https://times-vtm-uat.linli580.cn:1834
  appKey: 'xxx',
  //以下该参数可不传
  mqtt: {
    // pingTimeout 未收到消息多少秒之后发送ping请求,默认15000毫秒
    // pongTimeout  发送ping之后,未收到消息超时时间,默认10000毫秒
    // reconnectTimeout onreconnect之后2秒, 进行init
    // 心跳推送消息 pingMsg
    // 异常之后轮训20次
    pingTimeout: 15000,
    pongTimeout: 10000,
    reconnectTimeout: 2000,
    pingMsg: 'heartbeat',
    repeatLimit: 20,
  },
})

实例化后,如果 appKey 和用户名/手机号正确,则会在右下角生成一个小图标入口,用户可点击最大化进行交互,不用时可以点击缩小还原成小图标。

参考调用项目

生命周期 web-vtm-sdk 之后,让我们来初始化创建一个实例,并参考 vue3 最新的生命周期进行封装了,一系列的详细挂载回调生命周期的方法

sdk 官方在线文档预览地址

Readme

Keywords

none

Package Sidebar

Install

npm i web-vtm-sdk

Weekly Downloads

4

Version

1.19.0

License

ISC

Unpacked Size

5.25 MB

Total Files

219

Last publish

Collaborators

  • ldm_git
  • share_ho
  • lizhang
  • liguotuan