echat_platform_flutter_sdk

Description:

echat platform flutter sdk

EChat Platform Flutter SDK. #
一洽专业在线客服系统，可通过网站、微信、APP、小程序、微博、Facebook、Line、WhatsApp、邮件、贴子等任意渠道接入。系统智能支持：多样式选择、多路由接入、多业务整合、多角色监控、多维度分析，多平台统一管理
SDK 简介 #
一洽 echat_platform_flutter_sdk 插件，封装了Android & iOS原生SDK常用API，使用该插件，无须调用原生API即可使用一洽服务。
集成文档 #
完整文档请参考：Flutter 插件集成文档
使用方式 #
1. 集成Flutter插件 #
在 Flutter 项目的 pubspec.yaml 文件中 dependencies 里面添加 echat_platform_flutter_sdk 依赖。

当前版本 {{flutterVersion}}，请将代码块中[version]替换成{{flutterVersion}}

dependencies:
# 添加一洽SDK插件
echat_platform_flutter_sdk: ^[version]
copied to clipboard
执行 flutter pub get 命令安装插件。
flutter pub get
copied to clipboard
!> 注意：Android需要手动添加一洽maven服务器地址，否则会出现打包Android失败的情况
在 Flutter 项目的 android/build.gradle中
allprojects {
repositories {
google()
mavenCentral()
// 添加一洽maven服务器地址
maven { url "https://nexus.rainbowred.com/repository/sdk/" }
}
}
copied to clipboard
2. 配置权限 #
2.1 Android 权限配置
在 Flutter 项目，打开android/app/src/main/AndroidManifest.xml，将下面权限添加到
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-permission android:name="android.permission.FLASHLIGHT" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.VIBRATE" />

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" android:maxSdkVersion="32"/>
<uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />
<uses-permission android:name="android.permission.READ_MEDIA_VIDEO" />
copied to clipboard
若当前android项目的targetSdkVersion较低，可能打包出现AndroidManifest.xml merge合并错误，请删除READ_MEDIA_IMAGES与READ_MEDIA_VIDEO权限。
2.2 iOS 权限配置 #
打开iOS项目中的podfile文件.添加如下代码至文件末尾
post_install do |installer|
installer.pods_project.targets.each do |target|
flutter_additional_ios_build_settings(target)
target.build_configurations.each do |config|
config.build_settings['EXCLUDED_ARCHS[sdk=iphonesimulator*]'] = 'arm64'
config.build_settings['ENABLE_BITCODE'] = 'NO'
config.build_settings["ONLY_ACTIVE_ARCH"] = "NO"
end
target.build_configurations.each do |config|
config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= [
'$(inherited)',
'PERMISSION_MICROPHONE=1',
'PERMISSION_CAMERA=1',
'PERMISSION_PHOTOS=1',
]
end
end
end
copied to clipboard
3. 配置参数 #
关于配置参数，请联系技术支持获取，请勿随意配置参数。



参数
类型
作用
必须




appId
String
SDK初始化参数
是


appSecret
String
SDK初始化参数
是


serverAppId
String
SDK初始化参数
是


serverEncodingKey
String
SDK加密参数
是


serverToken
String
SDK加密参数
是


serverToken
String
SDK加密参数
是


companyId
int
公司/平台id
是


isAgreePrivacy
bool
客户是否已经同意隐私协议
是


serverUrl
String
服务器地址，非必要误填
否




配置参数必须在Flutter启动时，第一时间设置，兼容了隐私合规。


首次App启动，此时客户还未同意隐私协议，设置setConfig，isAgreePrivacy = false
用户同意隐私协议后，每次App启动，都需要设置setConfig，且isAgreePrivacy = true

EChatFlutterSdk.setConfig(
appId: 'SDKCV5XSSVPFGSKXXXX',
appSecret: "CTBMXIKRDRYTFQVRZQ3ZJAPIMN2QVK62D53MBGXXXX",
serverAppId: "8546F8346D6BB48840B763000231XXXX",
serverEncodingKey: "7k263sdcmyvEY3OZjAsZ4RONB4zaZgOZEgEKntEXXXX",
serverToken: "2fr6XXXX",
companyId: 5230XX,
isAgreePrivacy: isAgreePrivacy,
);
copied to clipboard
!> 注意：原生SDK没有专门用于配置参数的接口，是在初始化时进行配置参数。若选择Flutter端配置参数，就不需要再原生端调用任何与初始化有关的API。
4. 初始化 #
EChatFlutterSdk.init();
copied to clipboard

若App有合规需求，可以参考 隐私合规

5. 对话窗口 #
5.1 打开对话窗口
接口参数：



参数
类型
作用
必须




companyId
int
公司id
是


echatTag
String
对话入口标识
否


myData
String
会员补充信息
否


routeEntranceId
String
咨询入口
否


visEvt
EchatVisEvtModel
图文消息
否


acdStaffId
String
指派接待客服的ID
否


acdType
String
分配优先级，0-优先，1-指派
否


fm
EchatFMModel
接入对话带入访客消息
否



仅打开对话
EChatFlutterSdk.openChat(companyId: xxx);
copied to clipboard