提交工单
咨询集成、功能及报价等问题
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
即时通讯 中文站 English
- 文档中心
- 即时通讯
- 离线推送
- 自定义通知铃声
自定义通知铃声
更新时间：2024-08-28 19:02
功能简介
ZIM 消息推送默认使用在手机系统设置的铃声与震动提示状态，但也支持自定义通知铃声。
本文档仅适用于配置了 APNs 或接入了 Google FCM 离线推送通道的项目。
前提条件
在自定义通知铃声之前，请确保：
已在 ZEGO 控制台 创建项目，获取到了接入 ZIM SDK 服务所需的 AppID、AppSign。ZIM 服务权限不是默认开启的，使用前，请先在 ZEGO 控制台 自助开通 ZIM 服务（详情请参考控制台的 服务配置 - 即时通讯 - 开通服务），若无法开通 ZIM 服务，请联系 ZEGO 技术支持开通。
已集成 ZIM SDK，详情请参考 快速开始 - 实现基本收发消息 的 “2 集成 SDK”。
已集成 ZPNs SDK，详情请参考 实现离线推送。
已在控制台配置离线推送证书。
实现流程
如需自定义铃声，您必须将铃声文件打包到应用程序中，同时需要在 ZEGO 控制台配置自定义铃声文件的地址，随后在发送离线推送时传入已配置的 resourceID。
准备声音资源
iOS 项目
Android 项目
准备声音资源
准备满足以下要求的音频资源：
- 音频长度必须小于 30 秒，否则系统将播放默认铃声。
- 音频数据格式为以下格式：
- Linear PCM
- MA4（IMA/ADPCM）
- µLaw
- aLaw
- 音频文件格式为以下格式：
- AIFF
- WAV
- CAF
详情请参考 Apple 开发者文档 UNNotificationSound。
将声音资源加入到项目工程中
使用 XCode 打开您的项目，选择您的项目，选择合适的 Target，点击 Build Phrases 页签，展开 Copy Bundle Resources，添加声音资源，如图所示：
)
将声音资源加入到项目工程
将声音资源文件加入到“您的项目/res/raw”目录下。
如果您的项目支持 Android 8.0 (API 26) 及以上版本，需要创建 channel 以自定义铃声。
示例代码：
Android - Java
Flutter - Dart
React Native - JavaScript
uni-app - JavaScript
// 如下代码为创建 channel 并为 channel 绑定铃声的示例代码。
// 代码中的 callChannel 为示例的 Channel ID。
// callChannel、ChannelName 为示例，可根据实际情况自定义。
if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.O) {
NotificationChannel channel = new NotificationChannel("callChannel", "ChannelName", NotificationManager.IMPORTANCE_HIGH);
Uri sound = Uri.parse("android.resource://" + getPackageName() + "/raw/call_sound");
channel.setSound(sound, null);
NotificationManager notificationManager = getSystemService(NotificationManager.class);
notificationManager.createNotificationChannel(channel);
}// 如下代码为创建 channel 并为 channel 绑定铃声的示例代码。
// 代码中的 callChannel 为示例的 Channel ID。
// callChannel、ChannelName 为示例，可根据实际情况自定义。
ZPNsNotificationChannel channel = ZPNsNotificationChannel();
channel.channelID = "channelID";
channel.channelName = "channelName";
channel.androidSound = "sound";
ZPNs.getInstance().createNotificationChannel(channel);// 如下代码为创建 channel 并为 channel 绑定铃声的示例代码。
// 代码中的 callChannel 为示例的 Channel ID。
// callChannel、ChannelName 为示例，可根据实际情况自定义。
var channel = {
channelID: "channelID",
channelName: "channelName",
androidSound: "sound"
};
ZPNs.getInstance().createNotificationChannel(channel);// 如下代码为创建 channel 并为 channel 绑定铃声的示例代码。
// 代码中的 callChannel 为示例的 Channel ID。
// callChannel、ChannelName 为示例，可根据实际情况自定义。
var channel = {
channelID: "channelID",
channelName: "channelName",
androidSound: "sound"
};
ZPNs.getInstance().createNotificationChannel(channel);在 ZEGO 控制台添加声音资源
登录 ZEGO 控制台，在 “项目管理” 页签中单击合适的项目，进入项目详情页。
)
选择“服务配置 > 即时通讯” 页签。
)
找到 “自定义推送策略（resourceID）配置”，单击 “添加 reourcesID”。
)
在弹窗中输入声音资源的相关信息并单击 “确定”。
请根据您的项目实际情况，按需配置适用于 APNs 和 FCM 的 Sound 文件地址（可二选一）。
)
相关信息的说明如下：
信息 说明 resourceID 名称需要推送的资源的 ID。您可以自定义此 ID。APNs推送类型必须为 “alert”。Sound声音资源文件在您的应用中的地址。例如，如果您是通过 Xcode 打开项目并在 Build Phrases > Copy Bundle Resources 将声音资源引入项目，此时，该声音资源已位于根目录中，地址为“声音资源名称 + 后缀”，如 callSound.caf）。如何将声音资源加入到 iOS 项目工程，详情请参考 自定义通知铃声。FCM推送类型仅支持为 “Notification Message” 自定义铃声。Chanel ID如果您的项目支持 Android 8.0 (API 26) 及以上版本，需要创建 channel 以自定义铃声。如何创建 channel，详情请参考 自定义通知铃声。Sound声音资源文件的名称，无需后缀，如 call_sound。如何将声音资源加入到 Android 项目工程，详情请参考 自定义通知铃声。完成输入后，“自定义推送策略（resourceID）配置” 下会出现该声音资源的具体信息，请拷贝对应的 Resource ID。
)
发送离线推送时使用自定义铃声
在 ZIMPushConfig 中填入之前拷贝的 Push Resource ID。
iOS - objective-C
Android - Java
Flutter - Dart
React Native - JavaScript
uni-app - JavaScript
ZIMPushConfig *pushConfig = [[ZIMPushConfig alloc] init];
pushConfig.resourcesID = @"push_resources_soundlimit"; // 从 ZEGO 控制台拷贝的 Push Resource ID
pushConfig.title = @"your title";
pushConfig.content = @"your content";
// 调用包含 pushConfig 参数的 APIZIMPushConfig pushConfig = new ZIMPushConfig();
pushConfig.title = "your title";
pushConfig.content = "your content";
pushConfig.resourcesID = "push_resources_soundlimit"; // 从 ZEGO 控制台拷贝的 Push Resource ID
// 调用包含 pushConfig 参数的 APIZIMPushConfig pushConfig = ZIMPushConfig();
pushConfig.resourcesID = "push_resources_soundlimit"; // 从 ZEGO 控制台拷贝的 Push Resource ID
pushConfig.title = "your title";
pushConfig.content = "your content";
// 调用包含 pushConfig 参数的 APIvar pushConfig = {
resourcesID: "push_resources_soundlimit", // 从 ZEGO 控制台拷贝的 Push Resource ID
title: "your title",
content: "your content"
};
var sendConfig = {
priority: 2,
pushConfig: pushConfig
};
// 调用包含 pushConfig 参数的 APIvar pushConfig = {
resourcesID: "push_resources_soundlimit", // 从 ZEGO 控制台拷贝的 Push Resource ID
title: "your title",
content: "your content"
};
var sendConfig = {
priority: 2,
pushConfig: pushConfig
};
// 调用包含 pushConfig 参数的 API本篇目录
- 免费试用
- 电话咨询400 1006 604咨询客服微信扫码，24h在线
联系我们
文档反馈
