跳到主要内容

IM 基础功能配置

相关说明​

  1. 针对融云原控制台的各个功能模块，现允许开发者将需要的功能模块页面嵌入到自己的应用中进行配置管理（新控制台不再支持直接配置），详细配置方式请参见 控制台嵌入指南 。
  2. 关于页面嵌入有做一个 Demo 方便您直接进行配置体验，为了避免影响您的业务，后续还请尽快接入嵌入式页面。

体验 Demo 的方式参考下图： 点击应用管理，选择对应应用的密钥管理

neiqian1

创建 Access Key ，然后点击 体验内嵌 Demo 进入临时页面

neiqian2

neiqian3

内嵌页面展示如图：

neiqian4

提示

以下功能全部免费，开通后 15 分钟生效。

用户​

gnpz-yh

新用户接收注册前全量用户落地通知​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：默认新用户可以接收到注册之前 7 天内的广播消息，关闭后新用户不会接收到之前的全量用户落地通知。

用户注销或激活回调地址​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：用户注销或激活完成时，会将处理结果同步到您的应用服务器，便于您知晓单个或批量注销与激活用户的处理进度与结果，详细查看开发文档。

用户资料变更回调​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：当用户资料发生变更时，实时同步到您的应用服务器，详细查看开发文档。

客户端用户资料变更订阅​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：通过客户端 SDK 订阅指定用户的资料变更信息，当用户资料发生变更时，实时向订阅用户同步，变更通知计入单聊分发、下行消息统计中，SDK 从移动端 5.10.0、Web 端 5.10.1 版本开始支持，详细查看开发文档。

用户资料默认权限​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：设置应用下用户资料的可见权限，默认为都不可见，仅支持获取到用户的名称和头像信息，SDK 从移动端 5.10.0、Web 端 5.10.1 版本开始支持。详细查看开发文档。

服务端订阅用户在线状态​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：将应用中用户在线状态实时同步到您的应用服务器，实现对用户状态（在线、离线、登出）的逻辑处理，详细查看开发文档。

用户自定义属性​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：使用融云的用户信息托管功能后，支持设置自定义的用户属性信息。详细查看开发文档。

离线推送​

gnpz-lxts

应用标识及推送证书管理​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：融云推送服务已对接小米、华为、鸿蒙、荣耀、魅族、OPPO、vivo、FCM、APNs 推送平台。详细查看 超链到控制台的推送文档。

推送自定义铃声​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：提供按消息类型（ObjectName）设置第三方推送铃声，目前支持设置 APNs、小米、华为推送通道，每个推送通道最多设置 5 个。

多语言推送模板​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：支持发送消息时携带创建的模板 ID，当目标用户离线时，使用模板中对应的配置内容进行推送，最多设置 100 个自定义推送模板。

Web/PC 在线手机端接收 Push​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：默认 Web 端或 PC 端在线，移动端未在线状态下，有新消息时移动端不会收到 Push，开启后移动端会收到 Push。

push 语言​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：内置图片、语音、小视频、文件、音视频通讯消息推送语言设置，默认为中文。

好友​

gnpz-hy

仅好友可以相互发送单聊消息​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：通过客户端 SDK 发送单聊消息时，是否进行好友身份验证，默认不判断好友关系，开启后只有在目标用户的好友列表中才能发送单聊消息。通过服务端 API 发送单聊消息没有限制，用户黑名单、白名单限制优先级大于好友关系。

好友关系状态回调​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：应用中有申请添加好友、同意/拒绝好友请求、添加好友成功、移除好友成功等好友相关的操作行为时，实时同步到您的应用服务器，功能开通后 15 分钟生效，详细查看开发文档。

添加好友权限​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：设置应用默认的添加好友权限，在用户未修改自己的加好友权限时，以应用默认设置为准，默认为"需要目标用户同意"才能添加为好友，详细查看开发文档。

客户端好友资料变更通知​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：用户资料发生变更时，实时同步给该用户的所有好友，好友资料变更通知计入单聊分发、下行消息统计中，详细查看开发文档。

客户端好友在线状态变更通知​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：用户在线状态发生变更时，实时同步给用户的所有好友，好友在线状态变更通知计入单聊分发、下行消息数据统计中，SDK 从移动端 5.12.0、Web 端 5.12.0 版本开始支持，详细查看开发文档。

好友自定义属性​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：使用融云的用户信息托管功能后，支持设置自定义的好友属性信息，详细查看开发文档。

多端​

gnpz-dd

允许客户端 SDK 控制重连互踢策略​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：默认情况下，融云会使得同一用户新登录的设备在连接成功后自动踢出已登录的设备。启用该功能后，您可以通过客户端 SDK （包括所有移动端和 Electron） 来调整这一策略，使得已经正常登录的移动端设备不受影响。如果设备在尝试重连时发现其他设备已在线，将停止重连，并提示用户其他设备已登录。

小程序多端​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：默认融云小程序 SDK 仅支持一个端连接 IM 服务，如需要支持多端同时连接可开通此功能。

多设备消息同步​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：开启后可以支持 Web 端、桌面端、Android、iOS 之间的消息同步。

全局消息​

gnpz-qjxx

全量用户通知服务​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：向应用中所有或指定用户发送消息或推送，实现将活动预告、内容动态精准及时地发送给目标用户，满足您的运营需求，详细查看开发文档。

全量消息路由​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：将消息数据实时同步到您的应用服务器，实现对用户之间的消息处理、新老系统的消息对接、聊天机器人等功能，详细查看开发文档。

Server API 发送消息实时路由​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置

  • 功能说明：默认服务端 API 发送的消息不会路由到客户应用服务器，开启后可通过全量消息路由功能同步到客户应用服务器。

    提示

    使用该功能前需要先按控制台内嵌指南将 IM 服务功能配置页面（page_code: im_service_config）嵌入到自己的管理后台；完成后，在自己的管理后台中开启全量消息路由功能。

Serve API 历史消息日志下载​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：通过服务端 API 获取应用内指定某天某小时内的所有会话消息记录，详细查看开发文档。

离线消息存储时长​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：目标用户未在线时，该用户接收的消息会保存到离线消息中，默认存储 7 天，下次登录时会获取到离线消息，如果需要调整可设置范围为 1 ~ 7 天。（仅针对单聊、群聊、系统消息会话类型有效）。

消息回调服务​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：根据发送用户 ID、接收用户 ID、消息类型、会话类型等多重维度进行设置，将满足条件的消息同步到指定客户服务器，由客户服务端决定消息是否正常发送，详细查看开发文档。

广播消息云存储​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：开通单群聊消息云存储功能后，默认全量广播消息不会存储到历史消息中，如需要存储可开通此功能。

群定向消息云存储​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：默认群组发送定向消息，不支持存储到历史消息中，开通后定向消息将存储到单群聊历史消息中。

操作事件回调​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：针对会话中消息的操作行为实时同步到您设置的应用服务器地址，目前仅支持单聊、群聊、系统会话类型，详细查看开发文档。

单群聊​

gnpz-dql

单聊状态消息路由​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：单聊状态消息是否进行消息路由及消息历史日志存储，如开通后如客户使用了单聊 " 正在输入的状态 ” 功能，该正在输入的状态消息也会进行路由和消息日志存储，消息量较大请谨慎开通，默认为不路由。

单聊用户白名单​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：只有互为白名单的用户可以相互发送消息，默认为关闭状态，开启后融云黑名单功能失效，详细查看功能文档。

用户不在群组时是否可以拉取历史消息​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：默认用户不在群组中不能获取群组中的历史消息，开启后用户未在指定群组中时，也可以获取群组历史消息。

新用户获取加入群组前历史消息​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置

  • 功能说明：默认用户只能查看他们加入群组后的群聊消息。开启服务后，新入群用户可以获取他们加入群组之前的群聊历史消息。

    提示

    若使用此功能需要先开通单群聊消息云存储功能后，才能开启。

群组资料变更回调​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：当群组资料发生变更时，实时同步到您的应用服务器，功能开通后 15 分钟生效，详细查看开发文档。

群组操作状态回调​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：当应用中有创建、加入、踢出、退出、解散、添加管理员、移除管理员、转移群主等群操作行为时，实时同步到您的应用服务器，功能开通后 15 分钟生效，详细查看开发文档。

允许通过客户端 SDK 进行群组操作​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：默认允许通过 SDK 进行群组操作，可根据业务需要设置操作权限，SDK 从移动端 5.12.0、Web 端 5.12.0 版本开始支持。

群组自定义属性​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：使用融云的用户信息托管功能后，支持设置自定义的群组属性信息。

聊天室​

gnpz-lts

加入聊天室时获取指定消息​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置

  • 功能说明：用户在客户端加入聊天室 时，SDK 默认获取最新消息（最多 50 条），不区分消息类型。开启服务后，可配置允许获取的消息类型。新加入聊天室的客户会获取到指定类型的最新消息。该配置不影响加入聊天室后在线收取消息。

  • 点击设置 ，在弹窗中填写消息类型的 Object Name。融云内置消息类型的 Object Name ，详细查看消息类型概述。 xxlxsz

单个用户加入多个聊天室​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：默认一个用户只能加入一个聊天室中，开启后一个用户可以同时加入到多个聊天室中。

多端同时在线情况下，一端退出聊天室其他端也同步退出聊天室​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：用户当前多端同时在线，都加入了同一聊天室，一端退出聊天室后其他端不进行退出，开启后多端在线情况下如果需要一端退出后其他端也退出聊天室。

聊天室成员变化监听​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：用户加入、退出聊天室后，向聊天室中的其他成员发送回调通知，通知使用的是消息方式，开通后会增加消息量，SDK 版本 >= 5.1.4 支持此功能。

聊天室状态同步​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置

  • 功能说明：聊天室状态同步是融云提供的服务端回调服务。开启同步后，应用下聊天室发生状态变化时，融云服务端会将状态实时同步到开发者的应用服务器。

    提示

    不支持同一用户多端同时在线情况下的聊天室状态同步。

聊天室属性自定义（KV）设置​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：启用设置聊天室属性自定义（KV）服务。融云支持在指定聊天室中设置自定义属性（KV），用于在指定聊天室中设置自定义属性。在语音直播聊天室场景中，可利用此功能记录聊天室中各麦位的属性；或在狼人杀等卡牌类游戏场景中记录用户的角色和牌局状态等，详细查看开发文档。

SDK 用户不在聊天室中不能发送消息​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：用户未加入聊天室时可以向聊天室中发送消息。开启后，不在聊天室的用户不能发送消息。

超级群​

gnpz-cjq

用户未加入超级群是否能获取历史消息​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：开启后用户未加入群组时，也可以获取群组的历史消息。

新用户加入群后是否拉取加入群之前的消息​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：开启后新用户加入群组后，也可以获取群组之前的历史消息，包括普通群和超级群。

超级群默认推送频率​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：默认用户每分钟在每个群、群频道中的可接收一条推送，每分钟可设置上限不超过 60 条。

会话列表支持超级群默认频道​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：是否需要在会话列表中获取到超级群的默认频道(RCDefault)。

安全&审核​

gnpz-aqsh

1、IM 消息审核​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：即时通讯支持对 IM 内容进行审核，提供基础审核能力、专业审核服务，以及自行对接审核服务的能力。

2、IM 信息托管审核​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：支持设置用户、好友、群组、群成员的资料审核。

3、安全域名设置​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：设置 Web 安全域名后，生产环境下仅可在该域名下通过 JavaScript SDK 调用服务器资源 ，开发环境没有限制。

4、单聊含敏感词消息不保存到发送者历史消息​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：默认单聊发送的消息，含有敏感词或审核不通过时，该条消息会进入发送者的服务端历史消息中存储，同时该用户在其他终端登录时，也会补偿收到该条消息，如不希望收到消息补偿及进入发送者的历史消息中，可开启此功能。

5、Serve API 发送消息过滤敏感词​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：默认服务端 API 发送的消息不过审核，开启后，服务端 API 发送消息会过滤设置的敏感词、内容审核规则以及消息回调服务设置的过滤规则。

6、含敏感词消息开启路由​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：默认消息中包含屏蔽敏感词时，不会同步到应用服务器，如果含有替换敏感词时，会将消息中的敏感词替换成设置的内容同步到应用服务器。开通此功能后，含有屏蔽敏感词的消息也会同步到应用服务器。

7、含敏感词消息屏蔽状态回调发送端​

  • 开关位置：内嵌页面 - IM 服务 - 功能配置
  • 功能说明：发送的消息中含有敏感词时（包括：融云敏感词、第三方审核、消息回调返回不下发的状态），向消息发送者进行回调通知，仅 5.1.4 及以上版本支持此功能。