登录与消息
登录配置
1. 登录与消息页面,单击登录配置右侧的前往配置。
2. 在登录配置中,设置多端登录策略,设置 Web 端以及其他平台的实例同时在线数量。
说明:
专业版、专业版 Plus、企业版选择多平台登录时,
Web 端可同时在线个数最多为10个;
Android、iPhone、iPad、Windows、Mac、Linux 平台,每种平台可同时在线设备个数最多为3个。
3. 自动保存设置并生效。
消息可撤回时间
1. 登录与消息页面,单击消息可撤回时间右侧的编辑。
2. 在弹出的消息撤回设置弹框中,设置消息可撤回时间。
3. 单击保存配置。
消息扩展设置
登录与消息页面,在消息扩展设置区域可以开启功能开关。
说明:
消息扩展可以为消息增加 key/value 状态标识,基于此功能可实现投票、接龙、问卷调查等功能,详情请参见 功能文档。 该功能仅对专业版、专业版 Plus、企业版客户开放,并且仅支持终端 SDK 增强版 6.7.3184 及以上版本,低版本用户请升级 SDK 版本。
全局免打扰功能
登录与消息页面,在全局免打扰功能区域可以开启功能开关。
说明:
Chat 允许用户开启 全局免打扰。该功能仅支持终端 SDK 7.4.4643 及以上版本。 启用本设置项后,会在收到消息后检查当前用户的全局免打扰状态。该功能默认关闭,此时客户端开启全局免打扰会收到后台返回错误码 72011。
历史消息存储
历史消息默认存储7天,延长历史消息存储时长为标准版、专业版、专业版 Plus 和企业版增值服务,具体计费说明请参见 价格说明。每个自然月仅支持更改一次配置。 1. 在登录与消息页面,单击历史消息存储右侧的编辑。
2. 在弹出的历史消息存储时长配置对话框中,设置延长历史消息存储时长。
3. 单击确定保存配置,该配置即刻生效。
用户
接收被踢离线状态
用户页面,在接收被踢离线状态区域可以选择开启或关闭被踢离线状态,按钮分为断网重连与主动登录:
同时启用断网重连时触发,主动登录时触发时,在任何情况下重连登录,均会收到 错误码 6208。 仅启用断网重连时触发,不开启主动登录时触发时,在除主动登录的情况下,会收到 错误码 6208 。 说明:
此功能仅对 Native SDK 生效,Web SDK 不会返回 6208。
用户状态查询及状态变更通知配置
用户页面,在用户状态查询及状态变更通知配置区域可以开启用户状态查询及状态变更通知开关。
说明:
用户状态查询及状态变更通知默认关闭,此时客户端查询/订阅/取消订阅用户状态会收到 72001 错误码。支持终端 SDK 6.3 及以上版本开启。
该功能仅支持专业版、专业版 Plus、企业版使用,可点击 升级应用 。 订阅用户资料变更
用户页面,在订阅用户资料变更区域可以选择开启或关闭是否订阅用户资料变更。详情请参见 用户资料变更通知。 根据用户类型的不同,用户资料变更可以分为如下三种:
自己的资料变更。
好友的资料变更。
订阅用户(非好友)的资料变更。
注意:
该功能默认关闭,此时客户端订阅用户资料变更会收到错误码 72012。 仅支持终端 SDK 7.4.4643 及以上版本。
该功能仅对专业版、专业版 Plus、企业版用户开放,可点击 升级应用。 默认只支持订阅 200 个用户,当超过限制后,会淘汰掉最早订阅的用户。
资料自定义字段设置
注意:
最多可添加20个用户自定义字段,该字段不支持删除,且不支持修改字段名与字段类型,仅支持修改读写权限,请根据业务需求合理规划该字段。
1. 用户页面,在资料自定义字段设置区域,单击右侧新增按钮。
2. 在弹出的用户自定义字段对话框中,输入自定义字段名,设置字段类型,设置读写权限。
说明:
字段名必须是英文字母,且长度不能超过8个字符。
需至少设置一种读权限和一种写权限。
3. 单击确定保存设置。
会话
删除会话后多端同步
会话页面,在删除会话后多端同步区域可以选择开启或关闭删除会话后多端同步:
开启:如果多端同时在线,删除会话会同步至各端,同步删除会话。
关闭:如果多端同时在线,一端删除会话后不同步至其它端。默认为关闭。
说明:
删除会话后多端同步仅支持终端 SDK 5.1.1,Web SDK 2.14.0及以上版本,低版本用户如需开启同步请升级 SDK 版本。
会话列表拉取数
会话页面,在会话列表拉取数区域可以配置从云端拉取的会话个数,客户端默认可从云端拉取100个会话,可配置从云端拉取最多500个会话。
说明:
会话列表拉取个数配置仅支持终端 SDK 5.1.1,Web SDK 2.0及以上版本,低版本用户如需配置请升级 SDK 版本。
会话列表拉取个数配置仅支持专业版、专业版 Plus、企业版使用,可点击 升级应用 。 好友
登录 即时通信 Chat 控制台,在顶部选择目标应用,在左侧导航栏选择 Chat > 功能配置 > 好友,您可以根据实际业务需求管理好友与关系链相关配置。 加好友验证方式
好友页面,在加好友验证方式区域右侧选择合适的默认加好友验证方式,选择后自动生效:
需要验证信息并本人确认;
允许任何人;
不允许任何人。
黑名单用户消息发送展示
好友页面,在黑名单用户消息发送展示区域右侧选择展示发送成功(消息不送达)或展示发送失败:
展示发送成功(消息不送达):表示被拉黑用户发消息后仍显示发送成功(实际对方不会收到)。
选择后自动生效。
将好友加入黑名单后的处理方式
好友页面,在将好友加入黑名单后的处理方式区域右侧选择把好友拉黑后的处理方式,解除好友关系或保留好友关系,选择后自动生效。
关注 / 粉丝功能
好友页面,在关注 / 粉丝功能设置区域右侧可以选择开启或关闭关注 / 粉丝功能。
说明:
该功能仅支持专业版、专业版 Plus、企业版使用,可点击 升级应用 。 粉丝回调功能,需要同时开启 回调配置 开关才可以使用。 陌生人单聊消息限制
好友页面,在陌生人单聊消息限制区域可以选择开启或关闭陌生人单聊消息限制:
开启:发起单聊时会先检查好友关系,仅允许好友之间发送单聊消息,陌生人发送单聊消息时 SDK 会收到 错误码 20009。 关闭:发起单聊时无需检查好友关系,允许用户和好友、陌生人之间发送单聊消息。默认为关闭。
好友自定义字段
注意:
最多可添加20个好友自定义字段,该字段不支持删除,且不支持修改字段名与字段类型,仅支持修改读写权限,请根据业务需求合理规划该字段。
1. 单击好友自定义字段功能卡片右侧的新增。
2. 在弹出的好友自定义字段对话框中,输入自定义字段名,设置字段类型。
说明:
字段名必须是英文字母,且长度不能超过8个字符。
3. 单击确定保存设置。
群组通用配置
登录 即时通信 Chat 控制台,在顶部选择目标应用,在左侧导航栏选择 Chat > 功能配置 > 群组,您可以根据实际业务需求管理群成员自定义字段。 群成员封禁
群组页面,在群成员封禁区域可以选择开启或关闭陌生人单聊消息限制。
开启后,可对所有类型群的群成员进行封禁。成员封禁后无法接收消息,且封禁时间内无法再进群。
说明:
该功能仅支持终端 SDK 6.6,Web SDK 2.22 及以上版本使用,低版本用户如需使用请升级 SDK 版本。
该功能仅支持专业版、专业版 Plus、企业版使用,可点击 升级应用 。 群成员在线状态
群组页面,在群成员在线状态区域可以选择开启或关闭群成员在线状态。
说明:
开关默认关闭,开启后可获取好友工作群、陌生人社交群、临时会议群的群成员在线状态及群成员在线人数,服务端 REST API 相关接口可参考获取 群成员详细资料。 功能仅对专业版、专业版 Plus、企业版客户开放,并且仅支持终端 SDK 7.3.4358 增强版、Web SDK 3.2.0及以上版本使用,Web SDK 升级请参照 参照文档。 群组群类型配置
1. 在开始群功能配置前,需先选择群类型:好友工作群、陌生人社交群、临时会议群、直播群、社群。
2. 开始群类型功能配置。群类型可支持配置功能如下:
|
✓ | ✓ | ✓ | - | - |
✓ | ✓ | ✓ | - | ✓ |
✓ | ✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ | ✓ |
✓ | ✓ | ✓ | ✓ | ✓ |
- | - | - | ✓ | - |
- | - | - | ✓ | - |
- | - | - | ✓ | - |
- | - | - | - | ✓ |
- | - | - | - | ✓ |
群消息已读回执
群消息已读回执,高效沟通必备功能。作为一种强反馈工具,支持查看已读/未读已发送消息的人数和成员,尤其在商务、办公场景下,可帮助团队构建更加及时、高效的沟通氛围。
在群消息已读回执区域,打开右侧开关,即可开启功能。
说明:
该功能仅支持专业版、专业版 Plus、企业版使用,可点击 升级应用 。 Chat 允许用户查看发送消息的已读未读状态。支持终端 SDK 6.1.2155、Web SDK 2.18.0及以上版本,适用于群容量200以内的好友工作群(Work)、陌生人社交群(Public)、临时会议群(Meeting)。
新成员消息历史
直播群新成员查看入群前消息,提升直播间用户粘性的重要功能,可帮助用户了解“前情提要”,迅速融入互动讨论中,让用户更有参与感,无论何时进入直播间都可获得高沉浸式体验,进而提升直播间用户停留时长。
在新成员消息历史区域,打开右侧开关,即可开启功能。开启后,新成员入群可拉取入群前的群历史消息;关闭后仅可拉取入群后的消息。
群成员变更通知
在群成员变更通知区域,右侧下拉框选择变更通知类型。
关闭:关闭之后,终端不会收到的通知,会导致无法更新群变更相关信息,也不会通过 V2TIMGroupListener 回调通知。
下发通知/存漫游:终端收到通知,然后更新群变更相关信息,并通过 V2TIMGroupListener 回调出来。同时群内也会收到 onRecvNewMessage 每个信息变更的通知(如进群通知和群资料变更消息等),也能通过 getHistoryMessageList 拉取到该通知消息。
下发通知/不存漫游:终端收到通知,然后更新群变更相关信息,并通过 V2TIMGroupListener 回调出来。但是群内不会收到 onRecvNewMessage 任何信息变更的通知,也无法通过 getHistoryMessageList 拉取到该通知消息。(一般用于接收并更新群资料变更,但是不想接收群内消息提醒,如进群通知和群资料变更等消息。)
配置修改后约十分钟生效。请耐心等待。
群成员资料变更通知
在群成员资料变更通知区域,右侧下拉框选择群成员禁言变更通知类型和群管理员变更通知类型。
下发通知/存漫游:终端收到通知,然后更新群变更相关信息,并通过 V2TIMGroupListener 回调出来。同时群内也会收到 onRecvNewMessage 每个信息变更的通知(如进群通知和群资料变更消息等),也能通过 getHistoryMessageList 拉取到该通知消息。
下发通知/不存漫游:终端收到通知,然后更新群变更相关信息,并通过 V2TIMGroupListener 回调出来。但是群内不会收到 onRecvNewMessage 任何信息变更的通知,也无法通过 getHistoryMessageList 拉取到该通知消息。(一般用于接收并更新群资料变更,但是不想接收群内消息提醒,如进群通知和群资料变更等消息。)
配置修改后约十分钟生效。请耐心等待。
群资料变更通知
在群资料变更通知区域,右侧下拉框选择配置,可配置功能包括:群名称变更通知、群通知变更通知、群简介变更通知、群头像变更通知、群主变更通知、群禁言变更通知、申请加群方式变更通知和群自定义字段变更通知。
关闭:关闭之后,终端不会收到的通知,会导致无法更新群变更相关信息,也不会通过 V2TIMGroupListener 回调通知。
下发通知/存漫游:终端收到通知,然后更新群变更相关信息,并通过 V2TIMGroupListener 回调出来。同时群内也会收到 onRecvNewMessage 每个信息变更的通知(如进群通知和群资料变更消息等),也能通过 getHistoryMessageList 拉取到该通知消息。
下发通知/不存漫游:终端收到通知,然后更新群变更相关信息,并通过 V2TIMGroupListener 回调出来。但是群内不会收到 onRecvNewMessage 任何信息变更的通知,也无法通过 getHistoryMessageList 拉取到该通知消息。(一般用于接收并更新群资料变更,但是不想接收群内消息提醒,如进群通知和群资料变更等消息。)
关闭后,群资料变更内容缓存无法及时更新(预计延迟 1 小时),请谨慎操作。
配置修改后约十分钟生效。请耐心等待。
群成员自定义字段
注意:
最多可添加5个群成员自定义字段,在字段创建后,该字段不支持删除,且不支持修改字段名与字段类型,仅支持修改读写权限,请根据业务需求合理规划该字段。
1. 在群成员自定义字段区域,右侧单击新增按键。
2. 在弹出的群成员维度自定义字段对话框中,输入字段名称,设置群组类型及其对应的读写权限。
说明:
字段名称只能由字母、数字以及下划线(_)组成,不能以数字开头,且长度不能超过16个字符。
群成员自定义字段名称不允许与群自定义字段名称一致。
单击添加群组类型可新增一组群组类型参数,群组类型不可重复。
单击目标群组类型参数组所在行的删除可删除该组群组类型参数,需至少保留一组群组类型参数。
3. 勾选我已知道“群成员自定义字段”添加后,仅可修改已添加群组类型的读写权限;无法删除该字段,无法重新选择也无法删除已添加的群组类型。
4. 单击确定保存设置。
群自定义字段
注意:
最多可添加10个群自定义字段,该字段不支持删除,且不支持修改字段名与字段类型,仅支持修改读写权限,请根据业务需求合理规划该字段。
1. 在群自定义字段区域,右侧单击新增按键。
2. 在弹出的群维度自定义字段对话框中,输入字段名称,设置群组类型及其对应的读写权限。
说明:
字段名称只能由字母、数字以及下划线(_)组成,不能以数字开头,且长度不能超过16个字符。
群自定义字段名称不允许与群成员自定义字段名称一致。
单击添加群组类型可新增一组群组类型参数,群组类型不可重复。
单击目标群组类型参数组所在行的删除可删除该组群组类型参数,需至少保留一组群组类型参数。
3. 勾选我已知道“群维度自定义字段”添加后,仅可修改已添加群组类型的读写权限;无法删除该字段,无法重新选择也无法删除已添加的群组类型。
4. 单击确定保存设置。
直播群在线成员列表
直播群在线成员列表默认关闭。开启之后,直播群成员将保存最新入群并且在线的1000人,客户端可以拉取该列表。
说明:
该功能仅支持终端 SDK 6.3 及以上版本开启,低版本用户如需使用请升级 SDK 版本。
该功能仅支持专业版、专业版 Plus、企业版使用,可点击 升级应用 。 直播群广播消息
直播群广播消息功能开关默认关闭,可开启。开启该功能后可配置直播群广播消息调用频率,默认1条/秒,最高可配置为5条/秒。
说明:
该功能仅支持终端 SDK 6.5 及以上版本开启,低版本用户如需使用请升级 SDK 版本。
该功能仅支持专业版、专业版 Plus、企业版使用,可点击 升级应用 。 拉取入群前漫游消息
在拉取入群前漫游消息区域,支持配置新成员可查看最近消息数和新成员可查看最近消息类型。
新成员可查看最近消息数:单击编辑,在弹出的直播群新成员查看入群前消息量配置弹框中,设置可查看消息量。
新成员可查看最近消息类型:右侧下拉框选择配置新成员可查看最近消息类型,可勾选文本消息,自定义消息和其他类型消息(表情、图片、语音、视频、文件等)。
配置修改后约十分钟生效。请耐心等待。
社群状态
社群,是可容纳10万人的超大群组,创建后可随意进出,支持历史消息存储。开通社群开关默认关闭,开启后可创建社群并使用社群相关功能。如果需要使用话题功能,请在开通社群后,打开开通话题开关。
说明:
仅支持终端 SDK 5.8.1668 增强版,Web SDK 2.17.0 及以上版本使用,低版本用户如需使用社群功能请升级 SDK 版本。
社群功能仅对专业版、专业版 Plus、企业版客户开放,可点击 升级应用 。 服务端 API 调频
1. 单击需要调频的服务端 API 右侧的编辑。
2. 滑动滑杆至所需的频率大小,并单击保存。
3. 在弹出的保存当前配置对话框中,单击确认保存配置。
支持调整的服务端 API:
|
| v4/openim/batchsendmsg | 12000条/分钟, 200次/秒 | 6000条/分钟, 可免费提升至1000次/秒 |
| v4/openim/sendmsg | 200条/秒 | 100条/秒 |
| v4/group_open_http_svc/send_group_msg | 200条/秒 | 100条/秒 |
| v4/group_open_http_svc/send_group_system_notification | 200条/秒 | 100条/秒 |
| v4/openim/get_c2c_unread_msg_num | 200次/秒 | 100次/秒 |
| v4/group_open_http_svc/add_group_member | 200次/秒 | 100次/秒 |
| v4/group_open_http_svc/delete_group_member | 200次/秒 | 100次/秒 |
| v4/group_open_http_svc/create_group | 200次/秒 | 100次/秒 |
| v4/group_open_http_svc/destroy_group | 200次/秒 | 100次/秒 |
| v4/group_open_http_svc/get_group_info | 200次/秒 | 100次/秒 |
| v4/group_open_http_svc/get_group_member_info | 200次/秒 | 100次/秒 |
| v4/group_open_http_svc/get_joined_group_list | 200次/秒 | 100次/秒 |
| v4/group_open_http_svc/get_role_in_group | 200次/秒 | 100次/秒 |
| v4/group_open_http_svc/group_msg_get_simple | 200次/秒 | 100次/秒 |
| v4/profile/portrait_set | 200次/秒 | 100次/秒 |
| v4/profile/portrait_get | 200次/秒 | 100次/秒 |
| v4/openim/query_online_status | 200次/秒 | 100次/秒 |
| v4/sns/black_list_get | 200次/秒 | 100次/秒 |