@neysf/qiyu-web-sdk
v1.1.4
Published
七鱼 Web SDK
Downloads
1,170
Readme
@neysf/qiyu-web-sdk
qiyu-web-sdk
一、功能简介
七鱼访客端 sdk 支持 npm 包接入
注:sdk 依赖 Promise,如果浏览器不支持 Promise,需要接入方自行引入 Promise polyfill(import 'core-js/modules/es.promise';)
二、使用示例
2.1 安装
$ npm install @neysf/qiyu-web-sdk --save
2.2 使用说明(示例)
import YSF from '@neysf/qiyu-web-sdk';
/**
* 第一个参数是 企业 appkey
* 第二个参数是 配置参数
* 第三个参数 环境配置 默认普通企业,传入overseas为海外企业
*/
YSF.init('f13509f5e8b8e1fbb388b3ddbee238c2', {
templateId: 123,
shuntId: 11,
// hidden: 1
}).then(ysf => {
ysf('open');
}).catch(error => {
console.log('sdk加载失败---', error);
});
参数说明请参考 官网文档
| 字段名 | 类型 | 说明 | 是否必须 | 默认值 | |---|---|---| ---| ---| | 第一个参数(appkey) | String | 企业 appkey | 是 | -- | | 第二个参数(配置) | Object | sdk 入口配置 | 否 | -- | | 第三个参数(配置) | String | 普通企业不需要传,海外版本企业:'overseas' | 否 | -- |