2.0.0 • Published 12 days ago

hlytx-phone-bar v2.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
12 days ago

九五云客服话条SDK

电话条SDK对底层通讯和上层业务逻辑深度封装,简化WEB页面集成流程,降低WEB编程难度。开放话务API和基础通话事件,可灵活自定义个性化功能。

文档:集成解决方案

在 Vue 中使用

通过npm安装

npm i hlytx-phone-bar

在项目用引入

以 Vue3 为例

<template>
  <div id="phoneBarBox" class="phone-bar"></div>
</template>

<script lang="ts" setup>
import { onMounted, onUnmounted, markRaw } from "vue";
import { ElMessageBox } from "element-plus";
import { WarningFilled } from "@element-plus/icons-vue";
import PhoneBar from "hlytx-phone-bar";

let phoneBar: any = null;

const initPhoneBar = () => {
  phoneBar = new PhoneBar({
    renderTo: "phoneBarBox",
    proxyUrl: "ws://192.168.1.111:8787/websocket",
    sipServerUrl: "192.168.1.111:5188",
    startupSoftPhone: true,
    tid: "xxxxx", // 租户标识/企业标识  企业id:900003
    thisDN: "xxxxxxxxx",
    agentID: "xxxxxxxxx",
    password: "xxxxxxxxxx",
    loginType: 0,
    thisQueues: [],
    defaultQueue: "",
    pstnDN: "",

    autoIdleWhenAfterWork: true,
    autoIdleWhenLogin: false,
    isPhoneTakeAlong: false,

    onAgentStatusChange: function (newState: string, beforeValue: string) {
      console.log("坐席状态由[" + beforeValue + "]变更为[" + newState + "]");
    },

    onScreenPopup: function (lineState: string, callInfo: IObject) {
      console.log("弹屏事件:", lineState, callInfo);
    },

    onRinging: function (callInfo: IObject) {
      console.log("振铃事件:", callInfo);
    },

    onTalking: function (callInfo: IObject) {
      console.log("接通事件:", callInfo);
    },

    onHangup: function (callInfo: IObject) {
      console.log("挂机事件:", callInfo);
    },

    onLinkDisconnected: function () {
      console.log("已断开连接");
    }
  });

  if (phoneBar) {
    // 覆盖弹窗方法
    PhoneBar.utils.showMessage = function (msg: string) {
      ElMessageBox.close();
      ElMessageBox.alert(msg, "提示", {
        confirmButtonText: "确定",
        type: "warning",
        icon: markRaw(WarningFilled)
      });
    };
  }
};

// 加载组件
onMounted(() => {
  initPhoneBar();
});

// 销毁组件
onUnmounted(() => {
  phoneBar.destroy();
});

</script>

传统 html 中使用

引用文件

需要引用的jscss可以通过 releases 下载,也可以通过npm run build:prod命令重新打包获得。

<!--引入css-->
<link rel="stylesheet" type="text/css" href="./css/PhoneBar.css">
<!--引入js-->
<script src='./PhoneBar.js'></script>

创建组件

创建组件时需要配置服务器信息、坐席信息、坐席配置信息和自定义事件回调等,该组件提供了默认配置,可以只写入服务器连接和坐席账号即可生成电话条。如下示例:

phoneBar = new PhoneBar({
  renderTo: 'test1',
  proxyUrl: 'ws://192.168.1.111:8787/websocket',
  sipServerUrl: '192.168.1.111:5188',
  startupSoftPhone: true,
  tid: 'xxxxx',
  thisDN: 'xxxxx',
  agentID: 'xxxxx',
  password: 'xxxxx',
  thisQueues: ['xxxxx', 'xxxxx'],
  defaultQueue: 'xxxxx'
})

示例图片

开发

安装

npm install

启动调试

npm start

构建打包

构建用于生产环境

npm run build:prod

构建用于开发环境

npm run build:dev
1.0.11

12 days ago

2.0.1

12 days ago

2.0.0

12 days ago

1.1.9

23 days ago

1.1.8

23 days ago

1.1.7

23 days ago

1.1.6

27 days ago

1.1.5

27 days ago

1.1.4

29 days ago

1.1.1

1 month ago

1.1.0

1 month ago

1.1.3

1 month ago

1.1.2

1 month ago

1.0.10

4 months ago

1.0.9

4 months ago

1.0.8

1 year ago