控制台操作
更新时间:
创建RTM项目
登录云上曲率控制台(https://www.ilivedata.com/)后,在“实时数据传输”页面可以创建项目,创建页面如下图:
RTM服务区域
目前RTM公有云共有两个服务区域:
- RTM-intl为国际版,服务器部署在海外;
- RTM-nx为国内版,服务器部署在中国宁夏;
请根据主要用户所在地区选择RTM服务区域。
注意如果您在国内使用国际版RTM,可能会遇到连接不稳定等情况,可尝试新建一个国内版RTM项目作为测试环境使用。
获取接入信息
创建RTM项目后,可在项目的“服务配置”页看到项目的接入信息,如下图所示:
接入信息用途
名称
用途
备注
项目编号(PID)
项目唯一标识ID,用于区分不同项目
-
客户端SDK版本选择
客户端的接入点地址,使用客户端SDK需要该地址
不同RTM服务区该地址不同,请注意区分
客户端SDK接入点
使用WebSocket SDK且强制要求使用SSL加密连接时(如微信小程序),使用该接入点
不同RTM服务区该地址不同,请注意区分
WebSocket SSL接入点
如果使用WebSocket SDK,且强制要求使用SSL加密连接时(如微信小程序),使用该接入点
不同RTM服务区该地址不同,请注意区分
服务端SDK接入点
服务端的接入点地址,使用服务端SDK需要该地址
不同RTM服务区该地址不同,请注意区分
实时音视频RTC接入点
RTC接入点地址,使用RTC功能时需要该地址
不同RTM服务区该地址不同,请注意区分
密钥
服务端SDK的请求密钥
该密钥为服务端请求RTM的唯一凭证,请妥善保管防止泄露
账号设置
配置项解释
名称
解释
官方管理员ID
用于发送广播消息的管理员用户ID,默认为111,可根据应用需要自行修改,该用户将被禁止通过客户端登录。
客户端禁用接口
客户端禁止调用的接口名称,以英文逗号分隔。设置后将无法通过应用客户端调用该接口。
服务端禁用接口
服务端禁止调用的接口名称,以英文逗号分隔。设置后将无法通过应用服务端调用该接口。
支持多点登录
是否允许同一用户在多个设备同时登录和收发消息,该配置打开后新设备登录时不会将该用户从旧设备中强制踢出。
支持多房间
是否允许同一用户同时进入多个房间,即进入新的房间不会自动离开旧的房间。
允许黑名单过滤
只有将该选项开启,应用黑名单才会生效,加入黑名单的用户将无法登录和收发消息。
允许群组禁言
只有将该选项开启,群组的禁言列表才会生效,加入禁言列表的用户无法在群组发消息。
允许房间禁言
只有将该选项开启,房间的禁言列表才会生效,加入禁言列表的用户无法在房间发消息。
注意
群组和房间禁言功能,仅针对聊天消息生效,自定义消息类型(mtype=51-127)不支持禁言设置
禁言相关文档请参考:
消息设置
配置项解释
名称
解释
P2P消息黑名单验证
开启后,如用户A将用户B加入黑名单,则用户A可以向用户B发送消息,反之则不可行。用户A和用户B可以生成会话并获取历史消息。
P2P消息好友验证
默认发消息无需好友验证,即任意两个用户之间无论是否为好友,均可以互相发一对一消息,如果设置为需要验证,则只有好友之间才可以发一对一消息。
需要保存的消息类型
业务设置哪些消息类型需要保存,消息类型只支持51-127范围内,以英文逗号分隔。
保存聊天消息
默认保存,无需修改。
消息刷屏数量限制
限制指定消息类型(51-127)。每秒最多发送和接收条数,多组设置之间英文逗号分隔。
其他设置
配置项解释
名称
解释
好友人数上限
单个用户最多可以拥有的好友人数。
好友操作的人数上限
调用好友操作相关接口,如:添加好友,删除好友等接口时,单次调用最多可操作的人数。
群组成员数量上限
单个群组最多可以拥有的成员数量。
群组操作的人数上限
调用群组相关接口,如:添加群组成员,删除群组成员等接口时,单次调用最多可操作的人数。
“加入房间"的数量上限
单个用户同时可以"加入房间"的最大数量(需开启支持多房间)。
用户操作的人数上限
调用用户操作相关接口,如:获取在线用户,获取用户信息等接口时,单次调用最多可操作的人数。
多人消息的人数上限
调用发送多人消息接口时,单次调用最多可操作的人数。
消息长度上限
单条消息的内容最大可允许的长度。
文件大小限制
发送文件时,最大允许的文件内容大小。
语音长度限制
调用音频相关接口,如:发送音频消息,发送多人音频消息等接口时,音频文件的最大允许的时长。
消息属性长度上限
单条消息的属性最大可允许的长度。
发送文件频率限制
每秒最多发送文件的次数。
单个会话保存消息数量
单个会话保存消息的最大数量,单个会话指:一个群组,一个房间,一个P2P对话。
历史消息单页数量限制
调用获取消息相关接口,如:获取群组消息,获取房间消息等接口时,每页可显示的最大消息数量。
历史消息频率限制
调用获取历史消息接口,如:获取群组消息,获取房间消息时,每秒允许的调用次数。
服务端接口频率限制
调用服务端接口时的频率限制。
客户端接口频率限制
调用客户端接口时的频率限制。
注意修改上述频率限制需要提交工单或联系云上曲率客服人员。
增值服务配置
回调消息设置
回调消息设置面板如下图所示:
- 需要回调的消息类型
业务可以设置哪些消息类型(mtype, 51-127)需要回调,以英文逗号分隔,设置后,对应类型的消息在发送的同时回调给业务服务器指定接口。
- 回调聊天消息
该开关打开后,客户端通过RTM发送的聊天消息将转发回调至业务服务器。
- 需要回调的事件
业务可以设置哪些事件需要回调,目前仅支持登录和退出两种事件。
- 回调并继续
该设置开启表示消息回调只作为旁路监听,完成回调操作后继续原有的消息处理流程,继续发送给相应客户端;如果该设置关闭则表示消息回调后流程即结束,如需业务服务器处理完成后继续发送消息,则业务服务器应通过服务端SDK再次调用RTM接口,完成消息发送操作。
- 回调模式
回调模式分为两种:
- 服务器直接推送
- 通过HTTP回调
当选择”通过HTTP回调“时,需同时设置“回调令牌(token)“
- 回调地址
业务设置用于接收回调消息的HTTP接口地址。
关于消息回调的详细使用,请参考:基本操作-增值服务-消息回调
注意只有客户端通过RTM SDK发送的消息会被回调给业务服务器,由业务服务器通过服务端RTM SDK发送的消息并不会被转发。
推送通知消息设置
离线消息推送,是指当通过RTM给不在线的用户发送消息时,可通过iOS和安卓的系统推送,在手机的通知栏(状态栏)上显示的一条信息,主要用来达到提示用户的目的,应用于聊天信息提醒、APP活动提醒、版本更新提醒等多种场景。云上曲率RTM会通过APNs和FCM将消息以远程推送的形式下发到客户端。
关联推送项目
在“增值服务-推送设置”中点击编辑按钮,选择您需要关联的推送系统的项目(或者是通过创建新项目进行关联),如下图所示:
配置推送证书
在关联的推送项目页面,证书配置模块中,需要配置推送的APNs证书和FCM API Key。
推送相关设置
- 需要推送通知的消息类型
业务可以设置哪些消息类型(mtype,51-127)需要推送通知,以英文逗号分隔。
- 推送聊天消息
配置聊天消息是否需要推送。
- 推送聊天控制命令
配置聊天相关的控制命令是否需要推送。
- 推送文件消息
配置文件消息(包括图片、离线语音、音频、视频、和通用文件类型)是否需要推送。
关于离线消息推送的详细使用,请参考:基本操作-增值服务-离线消息推送
AI增值服务设置
实时翻译服务
实时翻译服务,是将应用内的聊天信息、邮件信息等翻译为用户设置的语言,让全球的用户都能进行顺畅交流。配置页面如下图所示:
配置说明
在增值服务-实时翻译中点击编辑按钮,选择您需要关联的推送系统的项目(或者是通过创建新项目进行关联)。
- 自动翻译
自动翻译是指,不需要客户端主动调用翻译接口,直接将聊天中的其他语言翻译为用户登录RTM时,通过SDK中语言设置接口设置的用户目标语言。例如,如果用户的语言为中文,开启自动翻译后会将聊天中的非中文语言都翻译为中文后再推送给客户端。
- 过滤目标语言中的敏感词
是指经过自动翻译后的文本,会检测译文中是否含有敏感内容,如果含有的话,会进行屏蔽。
语音识别服务
语音识别服务开启后,可以通过RTM SDK中提供的相关接口,将应用内的语音转换为文字,提升用户的体验。
云上风声舆情服务
云上风声舆情服务开启后,可以自动对用户聊天内容结合人工智能技术对文本数据进行分析、归纳和推理,识别出文本背后的情感倾向和消费意愿,实时掌握用户关心的热点,为用户创造更高价值。。
内容审核增值服务
文本审核服务
文本审核,是识别聊天中的涉政、色情、辱骂、歧视、暴恐、违禁、广告等内容,并屏蔽这些内容。
- 自动检测
是不需要再发送请求,在服务器发送聊天信息时,会自动去屏蔽文本中的敏感内容。
图片审核服务
图片审核,是识别聊天中的涉政、色情、暴恐、违禁、广告等违规内容。
- 自动检测
是不需要再发送请求,在服务器发送聊天信息时,会自动去检测聊天图片中是否含有违规内容。
语音审核服务
语音审核,是识别语音聊天中的涉政、色情、暴恐、违禁、广告等违规内容。
视频审核服务
视频审核,是识别视频中的涉政、色情、暴恐、违禁、广告等违规内容。
接口工具
云上曲率RTM控制台提供了一套完整的接口工具,用户可直接通过控制台模拟使用服务端SDK进行所有操作,并获得返回结果:
数据统计
云上曲率RTM控制台提供了丰富的数据统计功能,主要统计包括:
- 实时监控
可实时显示项目近24小时的在线用户、消息数、客户端和服务端接口调用量及QPS等信息,以图标形式展现。
- 用户统计
可展示项目的历史DAU数据、用户在线峰值、在线时长等信息,以图标形式展现。
- 消息统计
可展示普通消息、文件类消息、回调消息的历史使用情况,以图标形式展现。
- 接口调用
可展示项目的客户端与服务端接口调用情况,以图标形式展现。
创建RTM项目
登录云上曲率控制台(https://www.ilivedata.com/)后,在“实时数据传输”页面可以创建项目,创建页面如下图:
RTM服务区域
目前RTM公有云共有两个服务区域:
- RTM-intl为国际版,服务器部署在海外;
- RTM-nx为国内版,服务器部署在中国宁夏;
请根据主要用户所在地区选择RTM服务区域。
获取接入信息
创建RTM项目后,可在项目的“服务配置”页看到项目的接入信息,如下图所示:
接入信息用途
名称 | 用途 | 备注 |
---|---|---|
项目编号(PID) | 项目唯一标识ID,用于区分不同项目 | - |
客户端SDK版本选择 | 客户端的接入点地址,使用客户端SDK需要该地址 | 不同RTM服务区该地址不同,请注意区分 |
客户端SDK接入点 | 使用WebSocket SDK且强制要求使用SSL加密连接时(如微信小程序),使用该接入点 | 不同RTM服务区该地址不同,请注意区分 |
WebSocket SSL接入点 | 如果使用WebSocket SDK,且强制要求使用SSL加密连接时(如微信小程序),使用该接入点 | 不同RTM服务区该地址不同,请注意区分 |
服务端SDK接入点 | 服务端的接入点地址,使用服务端SDK需要该地址 | 不同RTM服务区该地址不同,请注意区分 |
实时音视频RTC接入点 | RTC接入点地址,使用RTC功能时需要该地址 | 不同RTM服务区该地址不同,请注意区分 |
密钥 | 服务端SDK的请求密钥 | 该密钥为服务端请求RTM的唯一凭证,请妥善保管防止泄露 |
账号设置
配置项解释
名称 | 解释 |
---|---|
官方管理员ID | 用于发送广播消息的管理员用户ID,默认为111,可根据应用需要自行修改,该用户将被禁止通过客户端登录。 |
客户端禁用接口 | 客户端禁止调用的接口名称,以英文逗号分隔。设置后将无法通过应用客户端调用该接口。 |
服务端禁用接口 | 服务端禁止调用的接口名称,以英文逗号分隔。设置后将无法通过应用服务端调用该接口。 |
支持多点登录 | 是否允许同一用户在多个设备同时登录和收发消息,该配置打开后新设备登录时不会将该用户从旧设备中强制踢出。 |
支持多房间 | 是否允许同一用户同时进入多个房间,即进入新的房间不会自动离开旧的房间。 |
允许黑名单过滤 | 只有将该选项开启,应用黑名单才会生效,加入黑名单的用户将无法登录和收发消息。 |
允许群组禁言 | 只有将该选项开启,群组的禁言列表才会生效,加入禁言列表的用户无法在群组发消息。 |
允许房间禁言 | 只有将该选项开启,房间的禁言列表才会生效,加入禁言列表的用户无法在房间发消息。 |
群组和房间禁言功能,仅针对聊天消息生效,自定义消息类型(mtype=51-127)不支持禁言设置
禁言相关文档请参考:
消息设置
配置项解释
名称 | 解释 |
---|---|
P2P消息黑名单验证 | 开启后,如用户A将用户B加入黑名单,则用户A可以向用户B发送消息,反之则不可行。用户A和用户B可以生成会话并获取历史消息。 |
P2P消息好友验证 | 默认发消息无需好友验证,即任意两个用户之间无论是否为好友,均可以互相发一对一消息,如果设置为需要验证,则只有好友之间才可以发一对一消息。 |
需要保存的消息类型 | 业务设置哪些消息类型需要保存,消息类型只支持51-127范围内,以英文逗号分隔。 |
保存聊天消息 | 默认保存,无需修改。 |
消息刷屏数量限制 | 限制指定消息类型(51-127)。每秒最多发送和接收条数,多组设置之间英文逗号分隔。 |
其他设置
配置项解释
名称 | 解释 |
---|---|
好友人数上限 | 单个用户最多可以拥有的好友人数。 |
好友操作的人数上限 | 调用好友操作相关接口,如:添加好友,删除好友等接口时,单次调用最多可操作的人数。 |
群组成员数量上限 | 单个群组最多可以拥有的成员数量。 |
群组操作的人数上限 | 调用群组相关接口,如:添加群组成员,删除群组成员等接口时,单次调用最多可操作的人数。 |
“加入房间"的数量上限 | 单个用户同时可以"加入房间"的最大数量(需开启支持多房间)。 |
用户操作的人数上限 | 调用用户操作相关接口,如:获取在线用户,获取用户信息等接口时,单次调用最多可操作的人数。 |
多人消息的人数上限 | 调用发送多人消息接口时,单次调用最多可操作的人数。 |
消息长度上限 | 单条消息的内容最大可允许的长度。 |
文件大小限制 | 发送文件时,最大允许的文件内容大小。 |
语音长度限制 | 调用音频相关接口,如:发送音频消息,发送多人音频消息等接口时,音频文件的最大允许的时长。 |
消息属性长度上限 | 单条消息的属性最大可允许的长度。 |
发送文件频率限制 | 每秒最多发送文件的次数。 |
单个会话保存消息数量 | 单个会话保存消息的最大数量,单个会话指:一个群组,一个房间,一个P2P对话。 |
历史消息单页数量限制 | 调用获取消息相关接口,如:获取群组消息,获取房间消息等接口时,每页可显示的最大消息数量。 |
历史消息频率限制 | 调用获取历史消息接口,如:获取群组消息,获取房间消息时,每秒允许的调用次数。 |
服务端接口频率限制 | 调用服务端接口时的频率限制。 |
客户端接口频率限制 | 调用客户端接口时的频率限制。 |
增值服务配置
回调消息设置
回调消息设置面板如下图所示:
- 需要回调的消息类型
业务可以设置哪些消息类型(mtype, 51-127)需要回调,以英文逗号分隔,设置后,对应类型的消息在发送的同时回调给业务服务器指定接口。
- 回调聊天消息
该开关打开后,客户端通过RTM发送的聊天消息将转发回调至业务服务器。
- 需要回调的事件
业务可以设置哪些事件需要回调,目前仅支持登录和退出两种事件。
- 回调并继续
该设置开启表示消息回调只作为旁路监听,完成回调操作后继续原有的消息处理流程,继续发送给相应客户端;如果该设置关闭则表示消息回调后流程即结束,如需业务服务器处理完成后继续发送消息,则业务服务器应通过服务端SDK再次调用RTM接口,完成消息发送操作。
- 回调模式
回调模式分为两种:
- 服务器直接推送
- 通过HTTP回调
当选择”通过HTTP回调“时,需同时设置“回调令牌(token)“
- 回调地址
业务设置用于接收回调消息的HTTP接口地址。
关于消息回调的详细使用,请参考:基本操作-增值服务-消息回调
推送通知消息设置
离线消息推送,是指当通过RTM给不在线的用户发送消息时,可通过iOS和安卓的系统推送,在手机的通知栏(状态栏)上显示的一条信息,主要用来达到提示用户的目的,应用于聊天信息提醒、APP活动提醒、版本更新提醒等多种场景。云上曲率RTM会通过APNs和FCM将消息以远程推送的形式下发到客户端。
关联推送项目
在“增值服务-推送设置”中点击编辑按钮,选择您需要关联的推送系统的项目(或者是通过创建新项目进行关联),如下图所示:
配置推送证书
在关联的推送项目页面,证书配置模块中,需要配置推送的APNs证书和FCM API Key。
推送相关设置
- 需要推送通知的消息类型
业务可以设置哪些消息类型(mtype,51-127)需要推送通知,以英文逗号分隔。
- 推送聊天消息
配置聊天消息是否需要推送。
- 推送聊天控制命令
配置聊天相关的控制命令是否需要推送。
- 推送文件消息
配置文件消息(包括图片、离线语音、音频、视频、和通用文件类型)是否需要推送。
关于离线消息推送的详细使用,请参考:基本操作-增值服务-离线消息推送
AI增值服务设置
实时翻译服务
实时翻译服务,是将应用内的聊天信息、邮件信息等翻译为用户设置的语言,让全球的用户都能进行顺畅交流。配置页面如下图所示:
配置说明
在增值服务-实时翻译中点击编辑按钮,选择您需要关联的推送系统的项目(或者是通过创建新项目进行关联)。
- 自动翻译
自动翻译是指,不需要客户端主动调用翻译接口,直接将聊天中的其他语言翻译为用户登录RTM时,通过SDK中语言设置接口设置的用户目标语言。例如,如果用户的语言为中文,开启自动翻译后会将聊天中的非中文语言都翻译为中文后再推送给客户端。
- 过滤目标语言中的敏感词
是指经过自动翻译后的文本,会检测译文中是否含有敏感内容,如果含有的话,会进行屏蔽。
语音识别服务
语音识别服务开启后,可以通过RTM SDK中提供的相关接口,将应用内的语音转换为文字,提升用户的体验。
云上风声舆情服务
云上风声舆情服务开启后,可以自动对用户聊天内容结合人工智能技术对文本数据进行分析、归纳和推理,识别出文本背后的情感倾向和消费意愿,实时掌握用户关心的热点,为用户创造更高价值。。
内容审核增值服务
文本审核服务
文本审核,是识别聊天中的涉政、色情、辱骂、歧视、暴恐、违禁、广告等内容,并屏蔽这些内容。
- 自动检测
是不需要再发送请求,在服务器发送聊天信息时,会自动去屏蔽文本中的敏感内容。
图片审核服务
图片审核,是识别聊天中的涉政、色情、暴恐、违禁、广告等违规内容。
- 自动检测
是不需要再发送请求,在服务器发送聊天信息时,会自动去检测聊天图片中是否含有违规内容。
语音审核服务
语音审核,是识别语音聊天中的涉政、色情、暴恐、违禁、广告等违规内容。
视频审核服务
视频审核,是识别视频中的涉政、色情、暴恐、违禁、广告等违规内容。
接口工具
云上曲率RTM控制台提供了一套完整的接口工具,用户可直接通过控制台模拟使用服务端SDK进行所有操作,并获得返回结果:
数据统计
云上曲率RTM控制台提供了丰富的数据统计功能,主要统计包括:
- 实时监控
可实时显示项目近24小时的在线用户、消息数、客户端和服务端接口调用量及QPS等信息,以图标形式展现。
- 用户统计
可展示项目的历史DAU数据、用户在线峰值、在线时长等信息,以图标形式展现。
- 消息统计
可展示普通消息、文件类消息、回调消息的历史使用情况,以图标形式展现。
- 接口调用
可展示项目的客户端与服务端接口调用情况,以图标形式展现。