七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
合规指南

App使用网易七鱼SDK的合规指引

升级最新版 SDK

请务必确保您已经将网易七鱼 SDK 升级到满足监管新规的最新版本。

SDK 业务功能的配置说明

接入说明:网易七鱼 SDK 包括在线客服基本功能和视频客服、CRM 轻量对接等拓展功能。

基本功能:为 App 提供在线客服能力,实现最终用户与客服之间的消息收发、消息投递、多端同步及客服会话服务。

扩展功能:包括 CRM 轻量对接和视频客服,分别用于用户资料上报与客户服务管理,以及提供实时音视频客服能力。

功能区分业务功能功能介绍相关个人信息及处理目的操作系统配置方式
基本功能在线客服提供 App 用户与客服之间的在线会话能力,支持文字、语音、图片、视频消息收发、后台消息通知、会话内容复制及语音播放模式切换。唯一设备识别码(APNS Token):提供iOS 端的消息推送、消息投递、多端消息同步功能。iOS必选信息用于基础在线客服能力,可选个人信息配置详见"SDK 可选个人信息的配置说明"。
设备类型、品牌、型号、制造商、操作系统版本、名称、构建版本:用于进行运行环境判断,便于排查在线客服服务运行中出现的问题。Android、 iOS、 HarmonyOS
设备运行状态(启动时间):保证消息能够及时发送与收发业务正常。Android、iOS
设备内存及存储大小:用于判断存储空间、内存情况是否够用。Android、iOS
网络信息(网络连接类型/状态、运营商信息、IP地址;Android 在 V9.9.1及以后版本不再获取 IP 地址):用于判断SDK与服务器的网络连接状态,进行线上业务问题处理以及保证服务的稳定性和连续性。Android、 iOS、 HarmonyOS
屏幕分辨率:用于设置缩略图宽高。Android
复制内容到剪切板:用于支持用户在客服会话中复制消息内容、号码、链接等信息到系统剪切板,便于用户留存、粘贴或在其他场景中使用,SDK 本身不读取剪切板内容。Android、 iOS、 HarmonyOS
最终用户的语音信息:提供发送音频消息功能。Android、 iOS、 HarmonyOS
最终用户的图片和视频信息:提供发送图片和视频消息功能。Android、iOS
距离传感器信息:用于判断手机与人的距离,从而在播放语音消息时实现听筒、扬声器模式的切换,提升语音消息收听体验。Android、iOS
历史版本涉及信息:设备识别码(AndroidID、MAC、IMEI;其中 AndroidID:V7.1.1 及之后版本不再收集,其他ID:V5.16.0 及之后版本不再收集):用于消息投递、多端同步、消息漫游及安全风险预防。Android
历史版本涉及信息:Wi-Fi 网络信息(SSID:V10.9.0 及之后版本不再收集;BSSID:V6.11.0 及之后版本不再收集):用于运行环境判断、网络调度优化和服务稳定性保障。Android
拓展功能CRM 轻量对接通过 CRM 轻量对接支持用户资料上报与服务管理。用户名、头像、电话号码、邮箱、性别、注册日期、手机型号、系统版本及其他开发者自行定义的信息:用于帮助开发者更好地管理最终用户,及时联系并解决最终用户售前、售后等服务需求。Android、 iOS、 HarmonyOS开发者自定义上报,须在隐私政策中告知并取得最终用户同意。
拓展功能视频客服通过视频客服提供实时音视频咨询能力。设备类型、设备名称及型号、IP 地址、通话状态、操作系统版本信息、设备运行状态(CPU、内存运行状态):通过了解运行环境,排查兼容问题、崩溃问题等Android、iOS距离传感器和设备通话状态为可选,其余为必选
网络连接类型及状态、Wi-Fi 状态:判断网络连接状态及网络是否可用Android、iOS
距离传感器信息:用于判断手机与人的距离,从而在播放语音消息时实现听筒、扬声器模式的切换,提升语音消息收听体验Android、iOS
设备通话状态:SDK 需要判断电话是否被打断,以实现在电话呼入时停止音频的采集,电话结束时恢复音频采集Android、iOS

SDK 可选个人信息的配置说明

接入说明:可选个人信息主要与语音、图片、视频、通知、CRM 自定义字段等能力相关。关闭可选采集可能影响对应功能,但不应影响基础在线客服能力。

个人信息类型个人信息采集目的配置方式
语音信息发送语音消息或进行音视频通话。Android:
设置示例:
AndroidManifest 中配置 RECORD_AUDIO 权限。
默认收集,如不需要通过 tools:node="remove" 移除。

iOS:
设置示例:
Info.plist 中配置 NSMicrophoneUsageDescription;默认不收集,如需要在 Info.plist 中配置。

HarmonyOS:
设置示例:
requestPermissions 中配置 MICROPHONE;
默认不收集,如需要在 requestPermissions 中配置。
图片和视频信息发送图片、视频消息,或保存图片、视频。Android:
设置示例:
AndroidManifest 配置 CAMERA、READ_EXTERNAL_STORAGE、WRITE_EXTERNAL_STORAGE、READ_MEDIA_IMAGES、READ_MEDIA_VIDEO 权限。
默认收集,如不需要应通过 tools:node="remove" 移除。

iOS:
设置示例:
Info.plist 配置 NSCameraUsageDescription、NSPhotoLibraryUsageDescription、NSPhotoLibraryAddUsageDescription;
默认不收集,如需要在 Info.plist 中配置。

HarmonyOS:
不收集。
通知栏后台接收客服消息通知。Android:
设置示例:
YSFOptions options = new YSFOptions();
options.statusBarNotificationConfig = new StatusBarNotificationConfig();
参数:statusBarNotificationConfig:通知栏设置。
AndroidManifest 配置 POST_NOTIFICATIONS。
默认不收集,配置该参数后收集,如不使用通知能力则不需要配置该参数,并通过 tools:node="remove" 移除权限。

iOS、HarmonyOS:
不收集。
分辨率用于客服页面、弹窗、图片/视频预览及悬浮窗等UI 展示适配Android:
设置示例:
YSFOptions options = new YSFOptions();
options.screenDisplayMetrics = DisplayMetrics
参数:screenDisplayMetrics:屏幕相关参数,默认收集,设置后不收集。

iOS、HarmonyOS:
不收集。
复制内容到剪切板用于支持用户在客服会话中复制消息内容、号码、链接等信息到系统剪切板,便于用户留存、粘贴或在其他场景中使用,SDK本身不读取剪切板内容Android:
设置示例:
YSFOptions options = new YSFOptions();
options.messageCopyBtnSwitch = boolean;
参数:messageCopyBtnSwitch:是否允许复制消息到剪切板,true:允许;false:不允许;默认为 true。

iOS:
设置示例:
[QYSDK sharedSDK].customActionConfig.messageCopyBtnSwitch = boolean;
参数:messageCopyBtnSwitch:是否允许复制消息到剪切板,YES:允许;NO:不允许;默认为 YES。

HarmonyOS:
设置示例:
setCustomConfig(config: CustomConfig): void
config.messageCopyBtnSwitch = 0|1
参数:messageCopyBtnSwitch:是否允许复制消息到剪切板,1:允许;0:不允许;默认为 1。
HarmonyOS 不收集。
传感器用于判断手机与人的距离,从而在播放语音消息时实现听筒、扬声器模式的切换,提升语音消息收听体验Android:
设置示例:
YSFOptions options = new YSFOptions();
options.proximitySensorEnable = boolean;
参数:proximitySensorEnable:是否使用传感器功能,true:允许;false:不允许;默认为 true。

iOS:
设置示例:
[QYSDK sharedSDK].customActionConfig.proximitySensorEnable = boolean;
参数:proximitySensorEnable:是否使用传感器功能,YES:允许;NO:不允许;默认为 YES。

HarmonyOS:
不收集。
CRM 自定义字段客服识别和服务最终用户仅在业务需要时,调用 setUserInfo 方法上报,并在App隐私政策或第三方共享清单中披露。

SDK 个人信息收集频次、精度说明

网易七鱼 SDK 按最小必要原则处理个人信息。基础信息通常在初始化、建立连接、消息收发、问题排查等必要场景触发;语音、图片、视频、通知、视频客服等信息仅在用户使用对应功能或授权后触发。频次由 SDK 业务逻辑决定,精度以实现在线客服、消息投递、服务稳定和安全保障为限。

SDK 申请系统权限的说明

接入说明:以下权限按业务场景配置。未使用对应功能时,请勿申请非必要权限;涉及敏感权限时,应在用户触发功能时申请并说明用途。

Android 操作系统应用权限列表

权限是否可选用途申请时机
INTERNET必选网络通信,保障 SDK 正常运行。初始化或启用业务功能时。
ACCESS_NETWORK_STATE必选判断网络连接状态。初始化或网络重连时。
ACCESS_WIFI_STATE必选判断 Wi-Fi 网络状态。初始化或网络诊断时。
RECORD_AUDIO可选录制语音消息、音视频通话采集声音。用户录音或通话时。
CAMERA可选拍摄图片、录制视频、视频通话。用户拍摄或通话时。
MODIFY_AUDIO_SETTINGS可选调整音频或视频音量。调整音频或视频音量时。
READ/WRITE 外部存储可选读取/保存图片、视频、日志或配置文件。用户读取、保存文件或配置外部日志目录时。
POST_NOTIFICATIONS可选展示客服消息通知。开启消息通知时。
BLUETOOTH / WAKE_LOCK可选连接蓝牙耳机、防止通话锁屏。音视频通话连接蓝牙耳机时。
设备信息可选判断电话是否被打断,以实现在电话呼入时停止音频的采集,电话结束时恢复音频采集。音视频通话过程中。
更改设备的网络状态可选依据网络质量,实现Wi-Fi与数据网络相互切换音视频通话过程中。

iOS 操作系统应用权限列表

权限是否可选用途申请时机
网络访问必选保障 SDK联网和会话服务正常运行。初始化或启用业务功能时。
麦克风可选录制语音消息、音视频通话采集声音。用户录音或通话时。
摄像头可选拍摄图片、录制视频、视频通话。用户拍摄或通话时。
相册读取/写入可选发送相册图片/视频,保存图片/视频。用户读取或保存相册内容时。
蓝牙/音频设备可选连接蓝牙耳机、切换音频设备。音视频通话相关场景。

HarmonyOS 操作系统应用权限列表

权限是否可选用途申请时机
INTERNET必选保障 SDK联网和会话服务正常运行。初始化或启用业务功能时。
MICROPHONE可选录制语音消息。用户录音时。

SDK 权限控制

Android 必选权限

以下为必选权限,必须配置以下权限才能满足基本功能

<!-- 网络权限 -->
<uses-permission android:name="android.permission.INTERNET" />
<!-- 获取网络状态 -->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<!-- 获取Wi-Fi状态 -->
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

Android 可选权限

以下为可选权限,声明在 AndroidManifest 中,如不需要,可通过 tools:node="remove" 移除

<!-- 修改音频设置,用于音视频播放或通话时调整音频路由、音量等配置 -->
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<!-- 读取外部存储,用于读取本地图片、视频、音频等文件;Android 13 以下适用 -->
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<!-- 写入外部存储,用于保存图片、视频、音频等文件;Android 10 及以下常见适用 -->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<!-- 使用摄像头,用于拍摄图片、录制视频或视频通话 -->
<uses-permission android:name="android.permission.CAMERA" />
<!-- 使用麦克风,用于录制语音消息、录制视频声音或音视频通话 -->
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<!-- 读取音频媒体文件,用于选择或读取本地音频;Android 13 及以上适用 -->
<uses-permission android:name="android.permission.READ_MEDIA_AUDIO" />
<!-- 读取图片媒体文件,用于选择或读取本地图片;Android 13 及以上适用 -->
<uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />
<!-- 读取视频媒体文件,用于选择或读取本地视频;Android 13 及以上适用 -->
<uses-permission android:name="android.permission.READ_MEDIA_VIDEO" />

视频客服扩展功能额外权限

以下为可选权限,声明在 AndroidManifest 中,如不需要,可通过 tools:node="remove" 移除

<!-- 使用蓝牙,用于连接蓝牙耳机、蓝牙耳麦等音频设备 -->
<uses-permission android:name="android.permission.BLUETOOTH" />
<!-- Android 12 及以上连接蓝牙设备,用于连接蓝牙耳机、蓝牙耳麦等音频设备 -->
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
<!-- 保持设备唤醒,用于音视频通话过程中防止设备锁屏或休眠 -->
<uses-permission android:name="android.permission.WAKE_LOCK" />
<!-- 读取手机状态,用于获取设备状态或设备标识等信息;如不使用请移除 -->
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<!-- 修改网络状态,用于切换或调整网络连接状态;如不使用请移除 -->
<uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />

iOS 可选权限

如需使用拍照、发送语音、图片、视频等功能,需要在 Info.plist 中增加以下权限

<key>NSCameraUsageDescription</key>
<string>App的拍照功能,需要您的同意,才能访问相机</string>
<key>NSMicrophoneUsageDescription</key>
<string>App的发送语音,需要您的同意,才能访问麦克风</string>
<key>NSPhotoLibraryAddUsageDescription</key>
<string>App的保存图片功能,需要您的同意,才能添加照片到相册</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>App的发送照片功能需要您的同意,才能访问相册</string>

视频客服扩展功能额外添加了以下权限

<key>NSBluetoothAlwaysUsageDescription</key>
<string>App的视频客服功能,需要您的同意,才能使用蓝牙设备</string>

HarmonyOS 必选权限

以下为必选权限,必须配置以下权限才能满足基本功能

"requestPermissions": [
  {
    // 网络权限
    "name": "ohos.permission.INTERNET"
  }
]

HarmonyOS 可选权限

如需使用语音功能,需配置如下权限

"requestPermissions": [
  {
    // 麦克风权限
    "name": "ohos.permission.MICROPHONE"
  }
]

SDK 隐私政策披露要求与示例

接入说明:根据相关法律法规和监管要求,请在App的隐私政策中披露使用的第三方SDK信息,并详细说明该第三方SDK的名称、第三方公司名称及隐私政策链接;SDK收集和处理的个人信息类型、用途、处理方式、存储地点等相关信息,以便用户充分了解SDK的使用情况和对用户个人信息权益的影响。如果App没有按照法律法规要求披露第三方SDK的上述信息,将可能面临约谈、通报、责令整改和监管处罚等法律风险,同时也会损害最终用户的权益。

披露示例(仅供参考,请以实际合作情况为准):

SDK名称:网易七鱼 SDK

第三方主体:杭州网易智企科技有限公司

合作目的:为 App 用户提供在线客服、消息收发等能力。

处理个人信息类型及用途:设备信息、网络信息、APNS Token、Bundle ID/包名、设备运行状态、用户主动提交的语音/图片/视频信息、视频客服相关音视频信息、CRM 自定义字段等;用于在线客服服务、消息投递、多端同步、问题排查、账户安全保障及客服服务管理。

数据处理方式:通过去标识化、加密传输及其他安全方式

官网链接:https://b.163.com/

最终用户同意方式的说明及示例

接入说明:App⾸次运⾏时应当有隐私弹窗,隐私弹窗中应公示简版隐私政策内容并附完整版隐私政策链接,并明确提示最终⽤户阅读并选择是否同意隐私政策;隐私弹窗应提供同意按钮和拒绝同意的按钮,并由最终⽤户主动选择。如涉及敏感个⼈信息,应当取得您最终⽤户的单独授权同意,您可以通过单独弹窗的形式来实现最终⽤户的授权,并在您的《隐私政策》中针对敏感个⼈信息通过字体加粗或其他显著标识显示。

隐私政策授权弹窗示例:

敏感个人信息授权弹窗示例敏感个人信息授权弹窗示例

最终用户行使权利说明

开发者在其 APP 中集成七鱼 SDK 后,七鱼SDK 的正常运⾏会收集必要的最终⽤户信息⽤于消息收发或扩展功能⽬的。开发者应根据相关法律法规为最终⽤户提供⾏使个⼈信息主体权利的路径或功能,需七鱼 SDK 配合的,请与网易智企公司及时进⾏联系,我们将与开发者协同妥善解决最终⽤户的诉求。

SDK 业务功能调用时机

接入说明:请务必在⽤户同意您 APP 中的隐私政策后,再进⾏七鱼SDK 的业务功能调用。⽤户同意隐私政策之前,避免动态申请涉及⽤户个⼈信息的敏感设备权限;⽤户同意隐私政策前,您应避免私⾃采集和上报个⼈信息。

隐私保护机制

如果您对七鱼SDK 权限有任何疑问、意见和建议,或者因为需要网易智企协助关闭某项权限采集能力,可通过以下联系方式与我们联系:

联系地址:杭州市滨江区长河街道天马路399号

您还可以随时通过访问网易智企·云商官网在线客服系统与我们联系,我们将及时为您提供咨询和服务,确保隐私保护机制的落实和执行。



这篇文档有帮助吗?

目录