npm 包 qiyujsip 的使用教程

qiyujsip 是一款基于 JSSIP 封装的 npm 包,用于前端与七鱼客服系统进行呼叫通讯。本教程将详细介绍 qiyujsip 的使用方法,包括安装、初始化、呼叫等流程,并提供示例代码及其讲解。

安装

在使用 qiyujsip 前,需要先安装这个 npm 包。安装命令如下:

--- ------- --------

初始化

在使用 qiyujsip 前,需要先初始化并配置相关参数。初始化示例代码如下:

------ -------- ---- -----------

----- ---- - --- -------------

------------
  ---- ------------------ -- -------- --- --
  --------- ------
  ------------ ------
  ---------- ---------------------- -- -------- --- --
  -------------------- --- ------------------------------
  ------ -----
  ---------------------------------------- -
    -- --------------
  --
---

上述代码中,我们首先通过 import 引入 qiyujsip 包,并创建一个 qiyu 实例。然后,通过 setup() 方法设置相关参数,其中具体参数含义如下:

参数 参数类型 参数作用 是否必填 备注
uri string SIP 协议中指定唯一用户的地址 适用于电商平台的 URI 格式
password string SIP 协议中用户认证的密码
displayName string 显示在 SIP 界面上的名称
wsServers string[] WebSocket 服务器地址 适用于电商平台的 wss 格式
mediaHandlerFactory CustomMediaHandler 自定义音视频处理函数 若不需要音视频功能,可以不填
debug boolean 是否开启调试模式
sessionDescriptionHandlerFactoryOptions object 其他配置参数 若不需要音视频功能,可以不填

呼叫

完成初始化后,我们可以使用 qiyu 实例来发起呼叫。呼叫示例代码如下:

----- ------ - ----------------------------------

----- ------- - -
  ----------------- -
    ------ ------
    ------ -----
  --
  -------------- -
    -------- -- -- -
      ------------------ ----------
    --
    --------- -- -- -
      ------------------------
    --
    --------- -- -- -
      ----------------- -----------
    --
    ----------- -- -- -
      ----------------- -------------
    --
    ------- -- -- -
      ----------------- ---------
    -
  -
--

----------------- ---------

上述代码中,我们首先定义了呼叫的目标地址 target,然后通过 call() 方法发起呼叫。在发起呼叫时,可以通过 options 对象传入其他参数,具体参数含义如下:

参数 参数类型 参数作用 是否必填 备注
mediaConstraints object 媒体限制条件 通过该属性可以指定呼叫是否需要音视频功能
eventHandlers object 呼叫过程中的事件处理函数 可以监听呼叫过程中的各种事件,如进度、接通、结束等等

结语

本文介绍了 qiyujsip 的安装、初始化、呼叫等流程,同时提供了示例代码及其讲解。通过本文的学习,读者可以掌握如何使用 qiyujsip 进行前端与七鱼客服系统的呼叫通讯,对于涉及此类功能的项目开发有一定的指导意义。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600572c481e8991b448e8df6


猜你喜欢

  • npm 包 telegraf-userbased-ratelimit 使用教程

    前言 在开发 Telegram 机器人时,我们可能需要控制用户的操作频率,避免用户频繁回复导致机器人出现问题。而 npm 包 telegraf-userbased-ratelimit 就是一款专门用于...

    3 年前
  • npm 包 CoinX 使用教程

    CoinX 是一个用于操作比特币(Bitcoin)和以太坊(Ethereum)的 JavaScript 库,它提供了一些简单易用的方法来简化比特币和以太坊的交互。 在这篇文章中,我将会详细介绍如何使用...

    3 年前
  • npm 包 multipleable-slider 使用教程

    简介 multipleable-slider 是一个基于原生 JavaScript 开发的轻量级多样式滑动组件,支持自定义样式,以及多个滑动条同时操作。本文将介绍如何在前端项目中使用 multiple...

    3 年前
  • npm 包 babel-plugin-react-rename 使用教程

    很多前端开发者都熟悉 babel 这个工具,它可以将 ES6 代码转译成兼容旧版浏览器的代码。同时,babel 还带有更多功能。其中,babel 插件是一种非常有用的功能,可以帮助开发者快速、方便地完...

    3 年前
  • npm 包 donejs-survey-ad 使用教程

    简介 donejs-survey-ad 是一个基于 DoneJS 开发的轮流展示多个广告图片、链接的调查问卷组件,支持通过问卷收集用户反馈信息。使用该组件可以方便快捷地创建一个广告调查问卷,提高网站的...

    3 年前
  • npm 包 ember-fuse-shim 使用教程

    前言 在现代 Web 开发中,前端框架和技术层出不穷,每个框架都有自己的优势和特点。而在实际的项目中,我们往往需要使用多种技术和框架,以防止某一技术或框架的不足导致项目开发的失败。

    3 年前
  • npm 包 react-openfb 使用教程

    什么是 react-openfb? react-openfb 是一个基于 React 框架开发的 Facebook SDK 封装。它为 React 应用程序提供了一个简便可靠的方法来集成 Facebo...

    3 年前
  • npm包ss-paginationbar使用教程

    在前端开发中,分页是一个常见的需求,为了提高分页效率,我们可以使用npm包ss-paginationbar。本文将对该npm包进行介绍和使用示范。 安装 安装过程十分简单,只需在终端输入以下命令即可:...

    3 年前
  • npm 包 ss-treeview 使用教程

    前言 在前端开发中,经常会遇到需要展示树形结构数据的场景,而 ss-treeview 就是一个非常方便的 npm 组件,可以帮助我们快速渲染出树形结构数据的视图。 本篇文章将详细介绍如何使用 ss-t...

    3 年前
  • npm 包 cryptoticker-ts 使用教程

    简述 cryptoticker-ts 是一个支持 TypeScript 的加密货币市场行情数据获取工具,通过调用 API 来获取市场行情数据。该库依赖于 Node.js。

    3 年前
  • npm 包 ss-progress 使用教程

    在前端开发中,我们经常需要使用进度条来展示任务的进度,而 ss-progress 是一个基于 CSS3 动画实现的 npm 包,提供了简单易用的进度条组件,本文将介绍如何使用该组件。

    3 年前
  • npm 包 homebridge-mqtt-temperature-tasmota 使用教程

    背景 Homebridge 是一个基于 Node.js 的开源项目,它可以让你将非 HomeKit 的设备接入 HomeKit 中,并实现 Siri 操控,从而方便地控制室内的智能设备。

    3 年前
  • npm 包 nuxt-universal-cookies 使用教程

    在前端开发中,有时我们需要在客户端和服务端都可以访问到的 cookie。而解决这个问题的 npm 包就是 nuxt-universal-cookies。本文将介绍该 npm 包的使用方法以及实际应用场...

    3 年前
  • npm 包 php-crud-app 使用教程

    php-crud-app 是一个基于 PHP 的简单的增删改查应用程序,提供了基本的 CRUD 操作方式,使您能够快速地开发一个 PHP Web 应用程序。我们可以使用 npm 来安装它,并在自己的项...

    3 年前
  • npm 包 react-bootstrap-daterangepicker-fork2 使用教程

    前言 随着 React 技术的不断壮大,React 组件也愈加丰富。其中一个组件库就是 bootstrap-daterangepicker-fork2,它是 bootstrap-daterangepi...

    3 年前
  • npm 包 vue-universal-cookies 使用教程

    前言 前端领域的技术发展日新月异,尤其是在近年来,前端开发出现了非常大的变化和创新。其中,从传统的基于后端渲染的 web 应用,到 SPA(Single-Page Application)的兴起,再到...

    3 年前
  • npm 包 pbot 使用教程

    介绍 pbot 是一个 Node.js 的 npm 包,用于快速创建 Slack 机器人。Slack 是一个团队办公软件,可以方便地进行群组协作和信息共享。而机器人可以帮助我们实现自动化操作、消息提醒...

    3 年前
  • npm 包 objects-compare 使用教程

    简介 在前端开发中,我们经常要比较两个对象是否相等,在不同的业务场景下,比较的情形也不同。为了解决这个问题,有人写了一个 npm 包:objects-compare。

    3 年前
  • npm 包 ts-inspector 使用教程

    介绍 在开发 TypeScript 项目时,有时需要检查代码的类型,这个检查可以手动完成,但往往会有较大的误差。此时,我们可以使用一个 npm 包 ts-inspector,它可以自动化地完成代码类型...

    3 年前
  • npm 包 ibird-cli 使用教程

    ibird-cli 是一款基于 Node.js 平台的命令行工具,用于快速构建基于 ibird 框架的前端应用。使用 ibird-cli,您可以快速生成互联网应用的脚手架,并可以快速进行前后端分离的开...

    3 年前

相关推荐

    暂无文章