2019-10-22 09:57:26 +08:00
|
|
|
|
#
|
|
|
|
|
|
#
|
|
|
|
|
|
# 本配置文件为debug使用,修改这里不会在Release包中生效。Release中包含的配置文件在 ${Porject_Path}/distribution/src/main/resources目录下
|
|
|
|
|
|
#
|
|
|
|
|
|
#
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2019-03-16 17:04:23 +08:00
|
|
|
|
#*********************************************************************
|
|
|
|
|
|
# Server configuration
|
|
|
|
|
|
#*********************************************************************
|
2020-04-23 18:44:45 +08:00
|
|
|
|
#服务器的接入IP。给客户端提供是${server.ip}和${http_port}。
|
|
|
|
|
|
#客户端会从${http_port}端口获取到长链接端口。这个地址一定要改成客户端可以访问到的IP地址
|
2021-07-28 15:53:28 +08:00
|
|
|
|
#(如果您部署云服务器上或者具有独立公网出口的服务器上,请改为对应的公网IP;如果您部署在在内网环境下,在内网使用,这个地方改成内网地址)
|
2023-03-24 15:55:11 +08:00
|
|
|
|
server.ip 192.168.1.81
|
2019-03-16 17:04:23 +08:00
|
|
|
|
|
|
|
|
|
|
##原生客户端长链接端口
|
|
|
|
|
|
port 1883
|
|
|
|
|
|
|
2021-07-28 15:53:28 +08:00
|
|
|
|
##客户端短链接端口,客户端固定使用80端口,不要修改此端口。
|
2020-04-23 18:44:45 +08:00
|
|
|
|
http_port 80
|
|
|
|
|
|
|
2019-03-16 17:04:23 +08:00
|
|
|
|
#管理端口
|
|
|
|
|
|
http.admin.port 18080
|
|
|
|
|
|
|
|
|
|
|
|
##节点ID,当集群部署时,一定不能有重复。
|
|
|
|
|
|
node_id 1
|
|
|
|
|
|
|
2022-06-28 08:34:17 +08:00
|
|
|
|
##绑定IP,不要打开,除非有特殊需求才可以打开
|
|
|
|
|
|
#host 0.0.0.0
|
2019-03-16 17:04:23 +08:00
|
|
|
|
|
|
|
|
|
|
##本地绑定端口
|
2019-03-27 22:35:22 +08:00
|
|
|
|
local_port 80
|
2019-03-16 17:04:23 +08:00
|
|
|
|
|
2021-12-24 22:02:40 +08:00
|
|
|
|
## 是否使用内置DB。0使用mysql;1使用h2db。
|
|
|
|
|
|
## MySQL需要把事物隔离级别改成"Read committed",使用命令来修改"set global transaction_isolation='read-committed';",其他数据库默认已经是这个级别不用修改
|
2020-02-19 14:04:44 +08:00
|
|
|
|
embed.db 1
|
2019-03-16 17:04:23 +08:00
|
|
|
|
|
2021-01-23 18:01:28 +08:00
|
|
|
|
## 是否自动清理历史消息记录,当为true时,IM服务会定时扫描t_messages_x和t_user_messages_x表,清除掉3年前的历史消息。
|
|
|
|
|
|
## 如果不开启自动清理,需要手动清理t_messages_x和t_user_messages_x表内的历史数据,保存数据不能超过3年。
|
2022-06-28 08:34:17 +08:00
|
|
|
|
## 如果需要消息保存更长时间,可以把临近销毁的消息转储到别的数据库,客户端在拉取不到服务器消息时,再去转储的数据库拉取。
|
2021-07-28 15:53:28 +08:00
|
|
|
|
## 使用mongodb时次开关无效(因为mongodb设置了消息过期时间,会自动清理,仅专业版支持mongodb)。
|
2021-01-23 18:01:28 +08:00
|
|
|
|
db.auto_clean_history_messages true
|
|
|
|
|
|
|
2022-10-23 09:48:13 +08:00
|
|
|
|
## h2db数据库的路径,默认为程序目录下的,可以指定其他目录。如果使用MySQL,可以忽略此配置
|
|
|
|
|
|
h2db.path ./h2db/wfchat
|
|
|
|
|
|
|
2021-07-28 15:53:28 +08:00
|
|
|
|
##服务器管理接口密钥。如果修改此端口需要同步修改使用管理API的地方,比如应用服务。
|
2019-03-16 17:04:23 +08:00
|
|
|
|
http.admin.secret_key 123456
|
|
|
|
|
|
|
2019-05-20 19:33:22 +08:00
|
|
|
|
##服务器API接口参数是否检查时间。当设置为false时,所有的请求会检查时间的有效性;当设置为true时,可以在http.admin.secret_key保持不变的情况下,使用固定的服务API签名
|
|
|
|
|
|
##nonce = "76616", timestamp = "1558350862502", sign = "b98f9b0717f59febccf1440067a7f50d9b31bdde"
|
2019-10-10 20:16:36 +08:00
|
|
|
|
##这个地方上线前要改为false
|
2019-05-20 19:33:22 +08:00
|
|
|
|
http.admin.no_check_time true
|
|
|
|
|
|
|
2019-03-27 22:35:22 +08:00
|
|
|
|
##用来生产im token的私钥,只在服务器使用,客户端不用。正式使用时为了安全一定要修改这个值,切记切记
|
|
|
|
|
|
token.key testim
|
|
|
|
|
|
|
2020-03-07 15:19:50 +08:00
|
|
|
|
##token的过期时间,单位为毫秒,默认为无限期。如果需要设置无限期,客户端上一定需要加上token过期的处理。token过期的处理请参考文档的常见问题
|
|
|
|
|
|
##token.expire_time 2592000000
|
|
|
|
|
|
|
2022-11-18 16:01:17 +08:00
|
|
|
|
##客户端(目前只有android)的应用签名(一个应用最取第一个签名),如果有多个签名(多个客户端),用英文逗号分开。获取签名方法请参考文档:https://docs.wildfirechat.cn/blogs/签名验证.html
|
|
|
|
|
|
#connect.client_signature_list eNkezQ1g9OsnhfLSFUY1vzKDzhs=,xykezQ1g9OsnhfLSFUY1vzKDzhs=
|
|
|
|
|
|
|
|
|
|
|
|
##是否拒绝空签名的android客户端, 默认为true。当有旧的客户端需要兼容时改成false,当所有都是新客户端时,改成true。
|
|
|
|
|
|
#connect.reject_empty_signature true
|
|
|
|
|
|
|
2023-04-24 11:51:13 +08:00
|
|
|
|
##是否使用AES256加密。默认客户端和服务器都是AES128加密,如果需要开启AES256,需要客户端和IM服务同时开通。
|
|
|
|
|
|
#encrypt.use_aes256 true
|
|
|
|
|
|
|
2024-09-10 10:53:21 +08:00
|
|
|
|
##当创建一个对象时(用户,群组,频道,机器人等),如果没有传入ID,野火会为这个对象生成一个ID。如果id.use_uuid为true,会使用uuid作为对象ID,否则会使用野火短ID,默认为false。
|
|
|
|
|
|
## 短ID有个很大的风险是容易被人穷举进行攻击。建议用UUID。
|
|
|
|
|
|
id.use_uuid true
|
|
|
|
|
|
|
2020-05-13 19:13:17 +08:00
|
|
|
|
##首次登录,是否接收之前的历史消息。
|
2022-08-14 15:25:00 +08:00
|
|
|
|
##0 不接收历史消息,只接收${message.compensate_time_limit}毫秒以内的消息,由于服务器没有保存已经收取记录,所以如果有超过${message.compensate_time_limit}毫秒之前未收取的消息也不会收取下拉;
|
2020-05-13 19:13:17 +08:00
|
|
|
|
##1接收,会接收 message.max_queue 配置的条数的历史消息
|
2019-08-09 13:44:44 +08:00
|
|
|
|
message.roaming 0
|
|
|
|
|
|
|
2022-08-14 15:25:00 +08:00
|
|
|
|
## 消息补偿时限,当${message.roaming}为0时,会同步时限以内且小于${message.max_queue}的消息,默认时限为5分钟。当${message.roaming}为1时,会接收 message.max_queue 配置的条数的历史消息。
|
|
|
|
|
|
message.compensate_time_limit 300000
|
|
|
|
|
|
|
2020-05-13 19:13:17 +08:00
|
|
|
|
##是否开启拉取远程历史消息。如果为1,客户端在会话内如果本地消息读取完了,可以下拉继续加载在服务器上的该会话的消息;如果为0则不能。
|
2019-08-09 13:44:44 +08:00
|
|
|
|
message.remote_history_message 0
|
2019-07-19 20:52:25 +08:00
|
|
|
|
|
2019-12-03 08:24:15 +08:00
|
|
|
|
##服务器为每个用户缓存的消息数量。这个值改得太大,拉取消息时间变长,另外会占用大量内存。
|
2019-12-03 08:10:38 +08:00
|
|
|
|
message.max_queue 1024
|
|
|
|
|
|
|
2021-11-19 21:12:11 +08:00
|
|
|
|
##是否开启拉取聊天室远程历史消息。如果为1,可以下拉继续加载在服务器上的该聊天室的消息;如果为0则不能。默认为1
|
|
|
|
|
|
message.chatroom_remote_history_message 1
|
|
|
|
|
|
|
2019-12-30 08:47:35 +08:00
|
|
|
|
##是否禁止陌生人聊天
|
2019-12-26 19:32:17 +08:00
|
|
|
|
message.disable_stranger_chat false
|
|
|
|
|
|
|
2022-11-14 15:23:03 +08:00
|
|
|
|
##当禁止陌生人聊天时,允许聊天的用户id,比如管理员或者文件传输助手等。用户id以英文逗号分割。
|
|
|
|
|
|
message.allow_stranger_chat_list admin,FireRobot,wfc_file_transfer
|
|
|
|
|
|
|
2024-12-06 16:06:04 +08:00
|
|
|
|
##当禁止陌生人聊天时,允许聊天的线路。
|
|
|
|
|
|
#message.allow_stranger_line 100,101
|
|
|
|
|
|
|
2020-08-08 08:15:59 +08:00
|
|
|
|
##黑名单策略,0 发送失败,返回被拉黑的错误码;1 发送成功但消息被服务器直接丢弃
|
2019-12-30 08:54:46 +08:00
|
|
|
|
message.blacklist.strategy 0
|
|
|
|
|
|
|
2024-09-14 09:53:50 +08:00
|
|
|
|
##拉黑对方后,对方不能发送消息给你。这个开关确定拉黑对方后你还能不能给对方发送消息。
|
|
|
|
|
|
message.blacklist.allow_send_to_black false
|
|
|
|
|
|
|
2020-04-25 20:34:14 +08:00
|
|
|
|
##是否禁止服务器端消息搜索,该功能暂未实现。目前的影响是如果打开,则存储消息时不单独保存_searchable_content字段
|
|
|
|
|
|
message.disable_remote_search false
|
|
|
|
|
|
|
2021-07-12 11:20:26 +08:00
|
|
|
|
##是否数据库中加密消息内容。注意这个开关在服务运行起来后不能改变了,避免读取数据库时无法恢复历史消息。
|
|
|
|
|
|
##如果要避免数据库中明文存储消息内容,请打开这个开关和message.disable_remote_search开关
|
|
|
|
|
|
message.encrypt_message_content false
|
|
|
|
|
|
|
2025-05-10 08:12:20 +08:00
|
|
|
|
##允许客户端撤回用户自己发送的消息时限,单位是秒。0是不允许撤回;-1是无限制撤回。
|
2021-07-28 15:53:28 +08:00
|
|
|
|
##Server API不受此限制,可以撤回任意时限内的消息
|
|
|
|
|
|
##群组管理员或群主撤回群成员消息不受此限制,可以撤回任意时限内的消息。但管理员或群主撤回自己的消息还是需要准守此时间限制。
|
|
|
|
|
|
##修改此参数需要同步修改客户端UI,客户端UI代码有判断撤回是否显示的逻辑。
|
2020-08-08 09:39:15 +08:00
|
|
|
|
message.recall_time_limit 120
|
|
|
|
|
|
|
2021-07-28 15:53:28 +08:00
|
|
|
|
##禁止群主/群管理员撤回群内消息,关闭时群主/群管理员可以撤回任意时间段内群内成员的消息。
|
2021-04-24 08:06:09 +08:00
|
|
|
|
message.disable_group_manager_recall false
|
|
|
|
|
|
|
2021-07-28 15:53:28 +08:00
|
|
|
|
##禁止客户端发送消息类型,消息类型以逗号分开,下面3个值为示例,可以删除。
|
|
|
|
|
|
##一般用于重要类型消息,比如交易、充值等,禁止客户端发送,仅限于服务器发送,提高安全性。
|
2021-04-24 08:06:09 +08:00
|
|
|
|
#message.forbidden_client_send_types 3999,4000,4001
|
2020-12-02 15:38:16 +08:00
|
|
|
|
|
2021-03-19 14:33:17 +08:00
|
|
|
|
## 当禁止发送消息时,允许例外发送的消息。这种一般用户需要被动回应的消息。比如群中被禁言的用户,他无法主动发起音视频,但可以接听未被禁言用户的音视频
|
|
|
|
|
|
## 因为音视频使用了消息作为信令,所以就需要允许发送音视频信令。如果开发了其它场景也需要被动回应消息,可以加在这里。
|
|
|
|
|
|
## 黑名单时允许发送的消息类型
|
|
|
|
|
|
message.blacklist_exception_types 401,402,403,404,405,407,408,410,411
|
|
|
|
|
|
## 群禁言或者聊天室或者频道禁言时允许发送的消息类型
|
|
|
|
|
|
message.group_mute_exception_types 401,402,403,404,405,407,408,410,411
|
|
|
|
|
|
## 用户被全局禁言时允许发送的消息类型
|
|
|
|
|
|
message.global_mute_exception_types 401,402,403,404,405,407,408,410,411
|
|
|
|
|
|
|
2023-09-13 11:16:54 +08:00
|
|
|
|
## 离线用户推送过期天数,0是永不过期,建议配置为7天。
|
|
|
|
|
|
message.push_expired_days 7
|
|
|
|
|
|
|
2024-04-03 10:49:28 +08:00
|
|
|
|
## 当会话静音/全局静音/PC在线静音时,普通消息都不会有推送,如果有某些消息类型需要此时保持推送,可以配置到这里。此配置对消息免打扰时段无效。
|
|
|
|
|
|
## 此配置只影响远程推送,需要客户端处理客户端在线且在后台收到此消息的处理,需要针对这些消息类型加上本地通知。
|
|
|
|
|
|
## 强制推送消息的MessagePayload中pushContent和pushData至少要存在一个才可以推送。
|
|
|
|
|
|
## 消息类型以英文逗号分割。
|
2024-04-03 10:51:06 +08:00
|
|
|
|
#message.force_push_types 401,402
|
2024-04-03 10:49:28 +08:00
|
|
|
|
|
2023-12-02 23:03:00 +08:00
|
|
|
|
## 群发消息(包括server api群发和全局频道群发)时,目标用户是否来自于t_user表。如果使用野火托管用户信息,请设置为true,否则设置为false。
|
|
|
|
|
|
message.broadcast.target_from_user_table true
|
|
|
|
|
|
|
2021-09-07 22:07:54 +08:00
|
|
|
|
## 消息转发功能开启时,开关是否不转发server api接口消息。
|
|
|
|
|
|
## 当为true时,不转发server api发送的消息;当为false时,转发server api发送的消息。
|
|
|
|
|
|
message.no_forward_admin_message false
|
|
|
|
|
|
|
2022-07-27 11:36:04 +08:00
|
|
|
|
## 消息转发功能开启时,转发信息是否带上用户clientId和平台类型。
|
|
|
|
|
|
message.forward_with_client_info false
|
|
|
|
|
|
|
2025-03-27 20:52:12 +08:00
|
|
|
|
## 消息转发功能开启时,转发信息是否带上发送者的用户信息
|
|
|
|
|
|
message.forward_with_sender_info false
|
|
|
|
|
|
|
|
|
|
|
|
## 消息转发功能开启时,转发信息是否带上目标的信息,单聊时是对方用户信息,群聊时是群组信息,频道时是频道信息
|
|
|
|
|
|
message.forward_with_target_info false
|
|
|
|
|
|
|
2025-04-12 14:00:55 +08:00
|
|
|
|
## 允许发送单聊消息给被封禁用户
|
|
|
|
|
|
message.allow_send_to_forbidden_user false
|
|
|
|
|
|
|
2022-07-27 11:36:04 +08:00
|
|
|
|
## 机器人回调信息是否带上用户clientId和平台类型。
|
|
|
|
|
|
robot.callback_with_client_info false
|
|
|
|
|
|
|
2025-03-27 20:52:12 +08:00
|
|
|
|
## 机器人回调信息是否带上发送者的用户信息
|
|
|
|
|
|
robot.callback_with_sender_info false
|
|
|
|
|
|
|
|
|
|
|
|
## 机器人回调信息是否带上目标的信息,单聊时是对方用户信息,群聊时是群组信息,频道时是频道信息
|
|
|
|
|
|
robot.callback_with_target_info false
|
|
|
|
|
|
|
2025-09-06 23:29:09 +08:00
|
|
|
|
## 是否允许@会话外的机器人。如果为true,单聊或者群聊时,可以@不在会话中的机器人。当机器人收到消息后,可以回复消息。
|
|
|
|
|
|
## 如果为false,不能@不在会话中的机器人。机器人不在会话中时,也不能回复消息。
|
|
|
|
|
|
robot.mention_external_robot true
|
|
|
|
|
|
|
2026-02-03 11:24:28 +08:00
|
|
|
|
## 机器人获取信息允许的字段,可以获取userId/displayName/portrait,其他需要这里配置允许。
|
|
|
|
|
|
## 第一位(1)是name, 第二位(2)是mobile,第三(4)位是email,第四位(8)是address,第五位(16)是company,第六位(32)是extra,
|
|
|
|
|
|
## 第七位(64)是updateDt,第八位(128)是gender,第九位(256)是social,第十位(512)是type。
|
|
|
|
|
|
## 比如允许获取name和email就是5(1+4),允许获取name和mobile和company和type就是531(1+2+16+512),允许全部是1023(1+2+...+512)
|
|
|
|
|
|
#robot.get_user_info_mask 1023
|
|
|
|
|
|
|
2022-07-27 11:36:04 +08:00
|
|
|
|
## 频道回调信息是否带上用户clientId和平台类型。
|
|
|
|
|
|
channel.callback_with_client_info false
|
|
|
|
|
|
|
2025-03-27 20:52:12 +08:00
|
|
|
|
## 频道回调信息是否带上发送者的用户信息。
|
|
|
|
|
|
channel.callback_with_sender_info false
|
|
|
|
|
|
|
|
|
|
|
|
## 频道回调信息是否带上频道信息
|
|
|
|
|
|
channel.callback_with_target_info false
|
|
|
|
|
|
|
2024-05-29 16:30:54 +08:00
|
|
|
|
## 频道回调新方式,在新方式下,如果有callback地址就会总是回调客户端发送的消息(包括owner和订阅者)。automatic属性控制订阅者发送的消息是否发给owner, 0发,1不发。
|
|
|
|
|
|
## 旧的方式是,automatic为0时,订阅者的消息发给owner,不转发消息到callback地址。为1时,把订阅者的消息转发给callback地址,不发给owner。
|
|
|
|
|
|
channel.new_callback_feature true
|
|
|
|
|
|
|
2020-04-04 09:51:53 +08:00
|
|
|
|
##禁止搜索用户
|
|
|
|
|
|
friend.disable_search false
|
|
|
|
|
|
|
|
|
|
|
|
##禁止按照昵称搜索用户。
|
|
|
|
|
|
friend.disable_nick_name_search false
|
|
|
|
|
|
|
2025-10-31 07:31:57 +08:00
|
|
|
|
##禁止按照用户id搜索用户,默认为false。
|
|
|
|
|
|
friend.disable_user_id_search false
|
2023-11-15 15:38:22 +08:00
|
|
|
|
|
2021-10-16 22:20:01 +08:00
|
|
|
|
##禁止发送好友邀请,通过server api添加好友不受此限制(force参数需要为true)
|
2020-04-04 10:11:42 +08:00
|
|
|
|
friend.disable_friend_request false
|
|
|
|
|
|
|
2022-02-24 21:37:05 +08:00
|
|
|
|
##好友请求重复发送的间隔,单位是毫秒,默认是7天,0为无限长期限。
|
2019-12-30 08:47:35 +08:00
|
|
|
|
friend.repeat_request_duration 604800000
|
|
|
|
|
|
|
2022-02-24 21:37:05 +08:00
|
|
|
|
##好友请求被拒绝后再次发送的间隔,单位是毫秒,默认是30天,0为不限制。不能小于friend.repeat_request_duration。
|
2019-12-30 08:47:35 +08:00
|
|
|
|
friend.reject_request_duration 2592000000
|
|
|
|
|
|
|
2022-02-24 21:37:05 +08:00
|
|
|
|
##好友请求过期时间,单位是毫秒,默认是7天,0为无限长期限。
|
2020-01-14 10:39:36 +08:00
|
|
|
|
friend.request_expiration_duration 604800000
|
|
|
|
|
|
|
2024-09-12 21:34:12 +08:00
|
|
|
|
##好友请求限制频率,一个用户24小时之内允许请求好友的次数,默认不限频。
|
|
|
|
|
|
friend.request_rate_limit 30
|
|
|
|
|
|
|
2025-11-23 13:59:11 +08:00
|
|
|
|
##如果搜索电话号码,24小时内搜索错误号码几次就不再允许电话号码搜素。防止有人遍历搜索电话号码
|
|
|
|
|
|
friend.search_mobile_empty_rate_limit 5
|
|
|
|
|
|
|
|
|
|
|
|
##如果搜索用户,24小时内搜索次数。防止有人遍历用户名或者用户ID乱加好友。另外可以禁止ID搜索friend.disable_user_id_search
|
|
|
|
|
|
friend.search_rate_limit 100
|
|
|
|
|
|
|
2023-05-04 21:39:45 +08:00
|
|
|
|
##请求添加机器人为好友时,机器人是否自动接受,默认为true
|
|
|
|
|
|
friend.robot_auto_accept true
|
|
|
|
|
|
|
2020-01-05 12:32:35 +08:00
|
|
|
|
## 聊天室观众空闲退出时间,单位为毫秒,默认为15分钟,0为永远不退出
|
|
|
|
|
|
chatroom.participant_idle_time 900000
|
|
|
|
|
|
|
|
|
|
|
|
## 用户向聊天室发送消息,自动加入聊天室
|
|
|
|
|
|
chatroom.rejoin_when_active true
|
|
|
|
|
|
|
2021-06-22 11:05:41 +08:00
|
|
|
|
## 当一个聊天室不存在时,如果有用户加入就自动创建
|
|
|
|
|
|
chatroom.create_when_not_exist true
|
|
|
|
|
|
|
2023-11-17 09:06:49 +08:00
|
|
|
|
## 一个用户同一时刻只能加入一个聊天室。
|
|
|
|
|
|
## 当一个客户端加入一个聊天室时,如果这个客户端已经加入另外一个聊天室了,会自动退出之前的聊天室。
|
|
|
|
|
|
## 当一个客户端加入一个聊天室时,如果这个用户的其他端已经加入一个聊天室了,kickoff_other_platform为true时会自动退出之前的聊天室,为false时会返回225的错误码。
|
|
|
|
|
|
## 当自动退出聊天室时,客户端不会收到任何通知,只是不会再收到消息。
|
|
|
|
|
|
chatroom.kickoff_other_platform true
|
|
|
|
|
|
|
2023-10-10 21:53:03 +08:00
|
|
|
|
## 是否允许群主不受限制地撤回自己发送的消息。false可以${message.recall_time_limit}撤回自己的消息;true可以撤回任意时间自己的消息。默认为true。
|
|
|
|
|
|
group.allow_owner_recall_self_msg true
|
|
|
|
|
|
|
|
|
|
|
|
## 是否允许群管理员不受限制地撤回自己发送的消息。false可以${message.recall_time_limit}撤回自己的消息;true可以撤回任意时间自己的消息。默认为false。
|
|
|
|
|
|
group.allow_manager_recall_self_msg false
|
|
|
|
|
|
|
2020-12-02 15:32:46 +08:00
|
|
|
|
## 是否允许客户端发送操作群的自定义群通知消息
|
2021-01-30 21:45:45 +08:00
|
|
|
|
group.allow_client_custom_operation_notification true
|
2020-12-02 15:32:46 +08:00
|
|
|
|
|
2021-12-07 13:46:14 +08:00
|
|
|
|
## 是否允许机器人发送操作群的自定义群通知消息
|
|
|
|
|
|
group.allow_robot_custom_operation_notification true
|
|
|
|
|
|
|
2020-12-10 18:03:41 +08:00
|
|
|
|
## 当群成员退出或者被移除时,是否同时给管理员和相关人员发送显式通知消息。
|
|
|
|
|
|
## 0 不发送,1 退群时发送,2 踢人时发送,3 退群和踢人时都发送。
|
2020-12-10 18:20:39 +08:00
|
|
|
|
group.visible_quit_or_kickoff_notification 0
|
2020-12-10 18:03:41 +08:00
|
|
|
|
|
2022-11-26 22:21:43 +08:00
|
|
|
|
## 禁止客户端群操作。第1位是禁止创建群组,第2位是禁止销毁群组,3位禁止加入群,4位禁止退出群,5位禁止邀请群成员,6位禁止移出群成员,7位禁止转移群,8位禁止设置群管理员,9位禁止白名单处理,10位禁止群禁言,11位禁止修改群组信息,12位禁止群成员禁言。
|
|
|
|
|
|
## Server API不受此限制。
|
|
|
|
|
|
#group.forbidden_client_operation 0xFFF
|
|
|
|
|
|
|
2024-01-14 09:42:42 +08:00
|
|
|
|
## 是否禁止陌生人拉人入群,默认为false
|
|
|
|
|
|
group.disable_stranger_invite false
|
|
|
|
|
|
|
2025-07-05 16:47:15 +08:00
|
|
|
|
## 创建群组或者加人时。可能会有成员加入失败(黑名单,或者不允许陌生人拉入群)。当出现有成员失败时,如果此开关为关,操作会失败。
|
|
|
|
|
|
## 如果此开关打开,操作会返回成功,另外在群里发送一条通知消息 XXX 拒绝加入群组。默认为开。
|
|
|
|
|
|
group.add_member_allow_part_success true
|
|
|
|
|
|
|
2024-03-30 12:06:51 +08:00
|
|
|
|
## 群组信息是否标记删除
|
|
|
|
|
|
group.enable_mark_deletion true
|
|
|
|
|
|
|
2021-01-11 11:56:32 +08:00
|
|
|
|
## 隐藏用户信息属性类型,2是性别,3是电话号码,4是邮箱,5是地址,6是公司信息,7是社交账号,8是Extra信息。当需要隐藏多个时以英文逗号分开;
|
|
|
|
|
|
## 本配置是为了提高安全性,避免把对应信息同步到客户端,这样就能防止程序被破解从而拿到用户关键信息。仅对客户端有效,server api不受影响。
|
|
|
|
|
|
## 注意,修改本配置不会对已经同步的信息产生影响。
|
|
|
|
|
|
#user.hide_properties 3,4,5
|
|
|
|
|
|
|
2022-04-26 19:50:53 +08:00
|
|
|
|
## 销毁用户时,用户信息会被清空,deleted字段设置为1,这个开关控制是否保留用户昵称,默认为true。
|
|
|
|
|
|
user.keep_display_name_when_destroy true
|
|
|
|
|
|
|
2025-11-22 23:02:56 +08:00
|
|
|
|
## 销毁用户时deleted字段设置为1,这个开关控制是否保留其他信息,默认是false。
|
|
|
|
|
|
user.keep_full_info_when_destroy false
|
|
|
|
|
|
|
|
|
|
|
|
## 销毁用户时,如果user.keep_full_info_when_destroy为true,会保留所有信息,这个开关控制是否保留这个用户信息的电话号码,默认为false。
|
|
|
|
|
|
## 当保留所有信息且保留电话号码时,用户如果再注册会用到原来的UID,能够看到原来用户的消息,需要考虑一下是否让已删除用户再次注册登录看到之前的消息。
|
|
|
|
|
|
user.keep_mobile_when_destroy false
|
|
|
|
|
|
|
|
|
|
|
|
## 销毁用户时是否保留归属于这个用户的所有消息记录,默认为false。
|
|
|
|
|
|
user.keep_messages_when_destroy false
|
|
|
|
|
|
|
2021-05-24 07:59:43 +08:00
|
|
|
|
# 好友/好友请求/用户设置 这三类数据同步的最大条目数。之前是客户第一次登录时,会把所有的对应数据一次下载到客户端,但如果有特别多的信息,会导致无法同步到客户端,
|
|
|
|
|
|
# 因此需要分段多次同步,此开关定义了每次同步的数据的条数。此需要客户端支持,客户端SDK在2021.5.25日后支持此功能。如果确认所有客户端都在这个日志之后才可以打开此设置。
|
|
|
|
|
|
#sync.data_part_size 1000
|
|
|
|
|
|
|
2023-10-12 15:44:00 +08:00
|
|
|
|
## 是否关闭api/version接口。api/version方法可以用来检查IM服务版本,上线确认无问题后,可以关掉这个接口。
|
|
|
|
|
|
#http.close_api_version false
|
|
|
|
|
|
|
2021-10-26 10:11:05 +08:00
|
|
|
|
#*********************************************************************
|
|
|
|
|
|
# 限频配置
|
|
|
|
|
|
#*********************************************************************
|
|
|
|
|
|
##API接口限频设置,时间是10秒内允许的请求次数。
|
|
|
|
|
|
##管理api频率限制,默认是10秒10000次。
|
|
|
|
|
|
http.admin.rate_limit 10000
|
|
|
|
|
|
##机器人api频率限制,默认是10秒1000次,按照机器人ID区分。
|
|
|
|
|
|
http.robot.rate_limit 1000
|
|
|
|
|
|
##频道api频率限制,默认是10秒1000次,按照频道ID区分。
|
|
|
|
|
|
http.channel.rate_limit 1000
|
|
|
|
|
|
|
|
|
|
|
|
##客户端请求频率限制,默认是5秒100次。通常情况下不要修改这个值。
|
|
|
|
|
|
client.request_rate_limit 100
|
2021-07-28 16:16:11 +08:00
|
|
|
|
|
2019-03-16 17:04:23 +08:00
|
|
|
|
#*********************************************************************
|
|
|
|
|
|
# Media server configuration
|
|
|
|
|
|
#*********************************************************************
|
2020-08-08 17:16:34 +08:00
|
|
|
|
##是否使用七牛云存储。1使用七牛;0使用内存文件服务器。默认的七牛账户信息不可用,请在七牛官网申请账户并配置
|
2021-10-16 18:11:46 +08:00
|
|
|
|
##专业版另外支持阿里云存储和野火私有存储,关于野火私有存储请参考:https://github.com/wildfirechat/WF-minio
|
|
|
|
|
|
##关于对象存储的详细信息请参考:https://docs.wildfirechat.cn/server/oss.html
|
2019-03-16 17:04:23 +08:00
|
|
|
|
media.server.use_qiniu 0
|
|
|
|
|
|
|
|
|
|
|
|
# qiniu media server configuration
|
|
|
|
|
|
qiniu.server_url http://up.qbox.me
|
|
|
|
|
|
qiniu.access_key tU3vdBK5BL5j4N7jI5N5uZgq_HQDo170w5C9Amnn
|
|
|
|
|
|
qiniu.secret_key YfQIJdgp5YGhwEw14vGpaD2HJZsuJldWtqens7i5
|
|
|
|
|
|
qiniu.bucket_general_name media
|
|
|
|
|
|
qiniu.bucket_general_domain http://pghnpyzos.bkt.clouddn.com
|
|
|
|
|
|
qiniu.bucket_image_name media
|
|
|
|
|
|
qiniu.bucket_image_domain http://pghnpyzos.bkt.clouddn.com
|
|
|
|
|
|
qiniu.bucket_voice_name media
|
|
|
|
|
|
qiniu.bucket_voice_domain http://pghnpyzos.bkt.clouddn.com
|
|
|
|
|
|
qiniu.bucket_video_name media
|
|
|
|
|
|
qiniu.bucket_video_domain http://pghnpyzos.bkt.clouddn.com
|
|
|
|
|
|
qiniu.bucket_file_name media
|
|
|
|
|
|
qiniu.bucket_file_domain http://pghnpyzos.bkt.clouddn.com
|
2020-04-14 15:54:55 +08:00
|
|
|
|
qiniu.bucket_sticker_name media
|
|
|
|
|
|
qiniu.bucket_sticker_domain http://pghnpyzos.bkt.clouddn.com
|
|
|
|
|
|
qiniu.bucket_moments_name media
|
|
|
|
|
|
qiniu.bucket_moments_domain http://pghnpyzos.bkt.clouddn.com
|
2019-03-16 17:04:23 +08:00
|
|
|
|
qiniu.bucket_portrait_name storage
|
|
|
|
|
|
qiniu.bucket_portrait_domain http://cdn2.wildfirechat.cn
|
|
|
|
|
|
qiniu.bucket_favorite_name storage
|
|
|
|
|
|
qiniu.bucket_favorite_domain http://cdn2.wildfirechat.cn
|
2025-12-25 16:02:38 +08:00
|
|
|
|
## custom的桶是给客户预留的,客户可以上传自己的文件到这3个桶中,野火不会用到这几个桶。如果不需要,可以忽略这几个配置
|
|
|
|
|
|
qiniu.bucket_custom1_name temp1
|
|
|
|
|
|
qiniu.bucket_custom1_domain http://temp1.wildfirechat.cn
|
|
|
|
|
|
qiniu.bucket_custom2_name temp2
|
|
|
|
|
|
qiniu.bucket_custom2_domain http://temp2.wildfirechat.cn
|
|
|
|
|
|
qiniu.bucket_custom3_name temp3
|
|
|
|
|
|
qiniu.bucket_custom3_domain http://temp3.wildfirechat.cn
|
2026-02-26 14:20:02 +08:00
|
|
|
|
qiniu.bucket_pan_name pan
|
|
|
|
|
|
qiniu.bucket_pan_domain http://pan.wildfirechat.cn
|
2019-03-16 17:04:23 +08:00
|
|
|
|
|
2024-07-10 11:14:07 +08:00
|
|
|
|
##媒体类型分类
|
|
|
|
|
|
#Media_Type_GENERAL = 0,
|
|
|
|
|
|
#Media_Type_IMAGE = 1,
|
|
|
|
|
|
#Media_Type_VOICE = 2,
|
|
|
|
|
|
#Media_Type_VIDEO = 3,
|
|
|
|
|
|
#Media_Type_FILE = 4,
|
|
|
|
|
|
#Media_Type_PORTRAIT = 5,
|
|
|
|
|
|
#Media_Type_FAVORITE = 6,
|
|
|
|
|
|
#Media_Type_STICKER = 7,
|
|
|
|
|
|
#Media_Type_MOMENTS = 8
|
2019-03-16 17:04:23 +08:00
|
|
|
|
|
|
|
|
|
|
# local media server configuration
|
|
|
|
|
|
# 本地媒体服务器配置。
|
|
|
|
|
|
local.media.storage.root media
|
2024-07-10 11:14:07 +08:00
|
|
|
|
# 如果使用内置文件存储,文件上传后地址默认为 http://server.ip:http_port/fs/5/2021/03/27/08/filename。fs目录下按照类型存放文件,媒体类型见上面注释,比如5就是Media_Type_PORTRAIT,是客户端的头像文件。
|
2021-05-19 14:02:49 +08:00
|
|
|
|
# 如果需要使用nginx添加https支持,请打开下面配置,这样客户端得到的文件地址为 https://example.com/media/fs/5/2021/03/27/08/filename。
|
|
|
|
|
|
# 需要nginx把请求从https://example.com/media/fs 转到 http://server.ip:http_port/fs。注意需要带上所有header。
|
|
|
|
|
|
# 尽管内置文件存储可以使用,但是我们还是建议使用专业级别的对象存储服务,社区版可以使用七牛,专业版另外支持阿里云和也是私有对象存储。详情请参考 https://docs.wildfirechat.cn/server/oss.html
|
|
|
|
|
|
# local.media.storage.remote_server_url https://example.com/media
|
2019-03-16 17:04:23 +08:00
|
|
|
|
|
2021-07-28 15:53:28 +08:00
|
|
|
|
# 是否支持任意多端登陆,为true时支持任意平台任意多个客户端同时登录;为false时每个平台只支持一个端登录,但不同平台可以同时登录。
|
2021-07-22 19:38:14 +08:00
|
|
|
|
# Android/iOS为移动平台,windows/mac/linux为pc平台,web为web平台,小程序为小程序平台。
|
2021-07-28 15:53:28 +08:00
|
|
|
|
# 建议使用false
|
2019-11-25 11:16:36 +08:00
|
|
|
|
server.multi_endpoint false
|
|
|
|
|
|
|
2022-06-06 09:37:37 +08:00
|
|
|
|
## 是否支持PC多端登陆,当server.multi_endpoint为true时,此开关无意义,当为false时,可以单独打开PC端多端登录。
|
|
|
|
|
|
server.multi_pc_endpoint false
|
|
|
|
|
|
|
2024-02-04 17:02:20 +08:00
|
|
|
|
## 是否支持PAD多端登陆,当server.multi_endpoint为true时,此开关无意义,当为false时,可以单独打开PAD端多端登录。
|
|
|
|
|
|
server.multi_pad_endpoint false
|
|
|
|
|
|
|
2026-03-06 19:15:22 +08:00
|
|
|
|
## 是否支持可穿戴设备多端登陆,当server.multi_endpoint为true时,此开关无意义,当为false时,可以单独打开可穿戴设备多端登录。
|
|
|
|
|
|
server.multi_wearable_endpoint false
|
|
|
|
|
|
|
|
|
|
|
|
## 是否支持TV设备多端登陆,当server.multi_endpoint为true时,此开关无意义,当为false时,可以单独打开TV多端登录。
|
|
|
|
|
|
server.multi_tv_endpoint false
|
|
|
|
|
|
|
2024-02-04 17:02:20 +08:00
|
|
|
|
# 多平台连接状态通知(仅当multi_endpoint为false时有效),true时移动端可以收到pc或pad或web端登录的通知。
|
2021-07-22 19:38:14 +08:00
|
|
|
|
server.multi_platform_notification true
|
|
|
|
|
|
|
2021-07-23 11:40:04 +08:00
|
|
|
|
# 当pc或者web在线时,手机是否默认静音,默认为true。注意仅影响默认值,用户可以手动切换是否静音。
|
|
|
|
|
|
# 如果这里改为false,客户端那边需要同步修改pc在线默认通知状态,方法是client的setDefaultSilentWhenPcOnline函数。
|
|
|
|
|
|
server.mobile_default_silent_when_pc_online true
|
2020-04-05 17:18:48 +08:00
|
|
|
|
|
2021-09-07 22:07:54 +08:00
|
|
|
|
## 客户端是否支持kickoff事件。当客户端被其他端登录踢出时,如果此开关为false时,客户端协议栈上报secret_mismatch。如果此开关为ture时,客户端协议栈上报kicked_off。
|
|
|
|
|
|
## 客户端被踢时上报kicked_off是在2021.9.15之后才加上的。如果客户端协议栈全部为此日期之后的版本才可以打开此开关。
|
2024-12-11 16:24:19 +08:00
|
|
|
|
server.client_support_kickoff_event true
|
2021-09-07 22:07:54 +08:00
|
|
|
|
|
2019-03-16 17:04:23 +08:00
|
|
|
|
#*********************************************************************
|
|
|
|
|
|
# Push server configuration
|
|
|
|
|
|
#*********************************************************************
|
2021-01-08 21:15:00 +08:00
|
|
|
|
##推送服务项目地址:https://github.com/wildfirechat/push_server。
|
2019-03-16 17:04:23 +08:00
|
|
|
|
##安卓推送服务器地址
|
2020-10-15 17:49:14 +08:00
|
|
|
|
##注意回调是单线程回调,接收服务必须在同一内网,且异步处理快速返回,否则会有延迟问题!!
|
2019-03-16 17:04:23 +08:00
|
|
|
|
push.android.server.address http://localhost:8085/android/push
|
2020-10-15 17:49:14 +08:00
|
|
|
|
|
2019-03-16 17:04:23 +08:00
|
|
|
|
##苹果推送服务器地址
|
2020-10-15 17:49:14 +08:00
|
|
|
|
##注意回调是单线程回调,接收服务必须在同一内网,且异步处理快速返回,否则会有延迟问题!!
|
2019-03-16 17:04:23 +08:00
|
|
|
|
push.ios.server.address http://localhost:8085/ios/push
|
|
|
|
|
|
|
2024-09-18 13:01:49 +08:00
|
|
|
|
##鸿蒙推送服务器地址
|
2024-09-18 12:50:19 +08:00
|
|
|
|
##注意回调是单线程回调,接收服务必须在同一内网,且异步处理快速返回,否则会有延迟问题!!
|
|
|
|
|
|
push.harmony.server.address http://localhost:8085/harmony/push
|
|
|
|
|
|
|
2020-12-12 16:15:13 +08:00
|
|
|
|
#*********************************************************************
|
|
|
|
|
|
# 监控配置
|
|
|
|
|
|
#*********************************************************************
|
2021-07-28 15:53:28 +08:00
|
|
|
|
##异常事件产生回调
|
|
|
|
|
|
##注意回调是单线程回调,接收服务必须在同一内网,且异步处理快速返回,否则会有延迟问题!!
|
2020-12-12 16:15:13 +08:00
|
|
|
|
#monitor.exception_event_address http://localhost:8888/im_exception_event/
|
|
|
|
|
|
|
2020-01-04 12:12:53 +08:00
|
|
|
|
#*********************************************************************
|
2020-10-15 17:49:14 +08:00
|
|
|
|
# 各种事件回调
|
2020-01-04 12:12:53 +08:00
|
|
|
|
#*********************************************************************
|
|
|
|
|
|
##用户在线状态事件回调地址
|
2020-10-15 17:49:14 +08:00
|
|
|
|
##注意回调是单线程回调,接收服务必须在同一内网,且异步处理快速返回,否则会有延迟问题!!
|
2020-10-19 09:09:53 +08:00
|
|
|
|
#user.online_status_callback http://localhost:8888/im_event/user/online
|
|
|
|
|
|
|
|
|
|
|
|
##用户信息变动事件回调地址
|
|
|
|
|
|
##注意回调是单线程回调,接收服务必须在同一内网,且异步处理快速返回,否则会有延迟问题!!
|
|
|
|
|
|
#relation.relation_update_callback http://localhost:8888/im_event/user/relation
|
|
|
|
|
|
|
|
|
|
|
|
##用户信息变动事件回调地址
|
|
|
|
|
|
##注意回调是单线程回调,接收服务必须在同一内网,且异步处理快速返回,否则会有延迟问题!!
|
|
|
|
|
|
#user.user_info_update_callback http://localhost:8888/im_event/user/info
|
2019-03-16 17:04:23 +08:00
|
|
|
|
|
2020-10-15 17:49:14 +08:00
|
|
|
|
##消息转发地址
|
|
|
|
|
|
##注意回调是单线程回调,接收服务必须在同一内网,且异步处理快速返回,否则会有延迟问题!!
|
2020-10-19 09:09:53 +08:00
|
|
|
|
#message.forward.url http://localhost:8888/im_event/message
|
2022-11-12 12:51:25 +08:00
|
|
|
|
##需要转发的消息类型,当有多个时以英文逗号分割,可以用-来指定区间,注意区间不能太大,因为要把区间内的所有数字都放入到Set中。如果转发所有消息,请注释掉配置或者设置为空
|
|
|
|
|
|
#message.forward.types 1,2,3,5-10
|
|
|
|
|
|
##需要转发的消息类型,当有多个时以英文逗号分割,可以用-来指定区间,注意区间不能太大,因为要把区间内的所有数字都放入到Set中。
|
|
|
|
|
|
#message.forward.exclude_types 1,2,3,5-10
|
2020-10-15 17:49:14 +08:00
|
|
|
|
|
2022-08-23 14:17:31 +08:00
|
|
|
|
##敏感消息转发地址
|
|
|
|
|
|
##注意回调是单线程回调,接收服务必须在同一内网,且异步处理快速返回,否则会有延迟问题!!
|
|
|
|
|
|
#message.sensitive.forward.url http://localhost:8888/im_event/message
|
|
|
|
|
|
|
2022-11-12 12:51:25 +08:00
|
|
|
|
##提醒消息转发地址,@全体用户和@某个用户消息会回调此地址。
|
|
|
|
|
|
##此转发不受${message.forward.types}和${message.forward.exclude_types}限制。
|
2021-09-29 10:17:32 +08:00
|
|
|
|
##注意回调是单线程回调,接收服务必须在同一内网,且异步处理快速返回,否则会有延迟问题!!
|
|
|
|
|
|
#message.mentionmsg.forward.url http://localhost:8888/im_event/message
|
|
|
|
|
|
|
2023-03-24 15:55:11 +08:00
|
|
|
|
##撤回消息转发地址,当用户撤回消息会回调此地址。
|
|
|
|
|
|
##注意回调是单线程回调,接收服务必须在同一内网,且异步处理快速返回,否则会有延迟问题!!
|
|
|
|
|
|
#message.recallmsg.forward.url http://localhost:8888/im_event/recall_message
|
2021-09-29 10:17:32 +08:00
|
|
|
|
|
2020-10-15 17:49:14 +08:00
|
|
|
|
##设备信息转发地址
|
|
|
|
|
|
##注意回调是单线程回调,接收服务必须在同一内网,且异步处理快速返回,否则会有延迟问题!!
|
2020-10-19 09:09:53 +08:00
|
|
|
|
#things_message.forward.url http://localhost:8888/im_event/things/message
|
|
|
|
|
|
|
|
|
|
|
|
##群组信息变动事件回调地址
|
|
|
|
|
|
##注意回调是单线程回调,接收服务必须在同一内网,且异步处理快速返回,否则会有延迟问题!!
|
|
|
|
|
|
#group.group_info_update_callback http://localhost:8888/im_event/group/info
|
|
|
|
|
|
|
|
|
|
|
|
##群组信息变动事件回调地址
|
|
|
|
|
|
##注意回调是单线程回调,接收服务必须在同一内网,且异步处理快速返回,否则会有延迟问题!!
|
|
|
|
|
|
#group.group_member_update_callback http://localhost:8888/im_event/group/member
|
|
|
|
|
|
|
|
|
|
|
|
##频道信息变动回调地址
|
|
|
|
|
|
##注意回调是单线程回调,接收服务必须在同一内网,且异步处理快速返回,否则会有延迟问题!!
|
|
|
|
|
|
#channel.channel_info_update_callback http://localhost:8888/im_event/channel/info
|
|
|
|
|
|
|
|
|
|
|
|
##聊天室信息变动回调地址
|
|
|
|
|
|
##注意回调是单线程回调,接收服务必须在同一内网,且异步处理快速返回,否则会有延迟问题!!
|
|
|
|
|
|
#chatroom.chatroom_info_update_callback http://localhost:8888/im_event/chatroom/info
|
|
|
|
|
|
|
|
|
|
|
|
##聊天室成员变动回调地址
|
|
|
|
|
|
##注意回调是单线程回调,接收服务必须在同一内网,且异步处理快速返回,否则会有延迟问题!!
|
|
|
|
|
|
#chatroom.chatroom_member_update_callback http://localhost:8888/im_event/chatroom/member
|
2019-07-21 15:11:24 +08:00
|
|
|
|
|
2019-03-16 17:04:23 +08:00
|
|
|
|
#*********************************************************************
|
|
|
|
|
|
# Sensitive configuration
|
|
|
|
|
|
#*********************************************************************
|
2023-09-07 09:56:41 +08:00
|
|
|
|
## 内置文本敏感词过滤处理方法,当命中敏感词后,消息会被记录到t_sensitive_messages表中,然后根据type类型做不同的处理,处理方式如下:
|
|
|
|
|
|
## 0 发送失败;1 发送成功但消息被服务器直接丢弃;2 命中的敏感词被替换成***然后正常发送;3 正常发送。
|
|
|
|
|
|
## 如果开启 message.sensitive.forward.url 配置,命中敏感词的消息还会被回调到这个地址
|
2024-12-15 10:47:45 +08:00
|
|
|
|
sensitive.filter.type 2
|
|
|
|
|
|
|
2025-08-05 15:32:20 +08:00
|
|
|
|
## 敏感词是否只处理消息。如果为true,只过滤消息;如果为false,会同时过滤用户昵称、群组名和群昵称。
|
|
|
|
|
|
## 除了消息之外的信息只支持内部敏感词处理,不支持外置审核。
|
|
|
|
|
|
sensitive.only_message false
|
|
|
|
|
|
|
2024-12-15 10:47:45 +08:00
|
|
|
|
## 敏感词添加或者删除有2种方式,一种是通过Server API进行,这种方式会立即生效。另外一种方法是修改数据库,直接中数据库的t_sensitive_word表中处理
|
|
|
|
|
|
## 修改数据库的方法不会立即生效,IM服务会2个小时重新加载一次敏感词。所以如果直接修改敏感词表,需要等2个小时,或者重启才能生效。
|
2021-02-14 12:30:31 +08:00
|
|
|
|
|
2023-09-07 09:56:41 +08:00
|
|
|
|
## 如果内置敏感词库无法满足您的需求,可以开发部署独立敏感词审核服务。配置如下地址和消息类型,IM服务会把指定消息类型的消息回调到指定地址,内置的敏感词审核和敏感词转发功能就不再起作用了。
|
2021-02-14 12:30:31 +08:00
|
|
|
|
## 审核服务返回状态码200表示继续发送,如果需要替换内容,返回状态码200并且内容为替换后的内容。返回403表示不允许发送。其它错误继续发送。
|
|
|
|
|
|
## 独立审核服务地址,IM服务会post SendMessageData。如果需要修改消息内容,返回 MessagePayload。请参考应用服务中 "/message/censor" Mapping.
|
|
|
|
|
|
#sensitive.remote_server_url http://192.168.3.202:8888/message/censor
|
|
|
|
|
|
## 需要进行敏感词审核的消息类型,当有多个时以英文逗号分割
|
|
|
|
|
|
#sensitive.remote_sensitive_message_type 1,2,3
|
2021-07-28 15:53:28 +08:00
|
|
|
|
## 如果远程审核服务返回403,返回给发送端发送失败还是成功?实际上这个值影响发送响应是否等待审核结果,当为false时,消息发送给审核服务就立即返回成功给客户端。
|
|
|
|
|
|
## 当为true时,消息发送给审核服务,等待审核结果,如果结果为继续发送就返回给客户端为成功,结果为禁止发送就返回失败给客户端。
|
2021-02-14 12:30:31 +08:00
|
|
|
|
## 客户端操作的超时一般为10s左右,且考虑到复杂的网络情况,建议处理时间不要超过3s。建议这个值为false。
|
|
|
|
|
|
#sensitive.remote_fail_when_matched false
|