SDK 文档

服务端 API

有奖调研

功能配置

最近更新时间:2021-11-22 16:52:06

登录与消息

登录 即时通信 IM 控制台 ,单击目标应用卡片,在左侧导航栏选择功能配置>登录与消息,您可以根据实际业务需求管理登录与消息相关配置。

登录设置

  1. 登录与消息页面,单击登录设置右侧的编辑
  2. 在弹出的登录设置对话框中,选择多端登录类型,设置 Web 端以及其他平台实例同时在线数量。
    说明

    旗舰版选择多平台登录时,Web 端可同时在线个数最多为10个;Android、iPhone、iPad、Windows、Mac 平台可同时在线设备个数最多为3个。

  3. 单击确定保存设置。

历史消息存储时长配置

历史消息默认存储7天,延长历史消息存储时长为增值服务,具体计费说明请参见 价格说明。每个自然月仅支持更改一次配置。

  1. 登录与消息页面,单击历史消息存储时长配置右侧的编辑
  2. 在弹出的历史消息存储时长配置对话框中,设置延长历史消息存储时长。
  3. 单击确定保存配置,该配置即刻生效。

消息撤回设置

  1. 登录与消息页面,单击消息撤回设置右侧的编辑
  2. 在弹出的消息撤回设置对话框中,设置消息可撤回时长。
  3. 单击确定保存配置。

直播群新成员查看入群前消息配置

  1. 登录与消息页面,单击直播群新成员查看入群前消息配置右侧的编辑
  2. 在弹出的直播群新成员查看入群前消息配置对话框中,设置新成员可查看的消息数。
  3. 单击确定保存配置。
说明:

该功能仅对旗舰版用户开放,非旗舰版用户请升级后使用。为确保功能正常使用,请将终端 SDK 更新至v5.8.0版本及以上

黑名单检查

登录与消息页面,在黑名单检查区域可以选择开启或关闭发送消息后展示发送成功:

  • 启用:若对方已将您的帐号加入黑名单,您向对方发送单聊消息时将提示消息发送成功,实际对方不会收到消息。默认为启用。
  • 关闭:若对方已将您的帐号加入黑名单,您向对方发送单聊消息时将提示消息发送失败。

好友关系检查

登录与消息页面,在好友关系检查区域可以选择开启或关闭发送单聊消息检查关系链:

  • 开启:发起单聊时会先检查好友关系,仅允许好友之间发送单聊消息,陌生人发送单聊消息时 SDK 会收到 错误码 20009
  • 关闭:发起单聊时无需检查好友关系,允许用户和好友、陌生人之间发送单聊消息。默认为关闭。

好友与关系链

设置添加好友的验证方式、好友自定义字段。

设置添加好友验证方式

  1. 登录 即时通信 IM 控制台 ,单击目标应用卡片。
  2. 在左侧导航栏选择功能配置>好友与关系链,在默认加好友验证方式设置功能卡片右侧单击编辑
  3. 选择合适的方式单击确定进行保存。

好友自定义字段

说明:

最多可添加20个好友自定义字段,该字段不支持修改字段名与字段类型且不支持删除,请根据业务需求合理规划该字段。

  1. 登录 即时通信 IM 控制台 ,单击目标应用卡片。
  2. 在左侧导航栏选择功能配置>好友与关系链
  3. 单击好友自定义字段功能卡片右侧的新增
  4. 在弹出的好友自定义字段对话框中,输入自定义字段名,设置字段类型。
说明

字段名必须是英文字母,且长度不能超过8个字符。

用户自定义字段

登录 即时通信 IM 控制台 ,单击目标应用卡片,在左侧导航栏选择功能配置>用户自定义字段,您可以根据实际业务需求管理用户自定义字段。

注意:

最多可添加20个用户自定义字段,该字段不支持修改字段名与字段类型且不支持删除,请根据业务需求合理规划该字段。

添加用户自定义字段

  1. 用户自定义字段页面,单击右侧新增按键。
  2. 在弹出的用户自定义字段对话框中,输入自定义字段名,设置字段类型,设置读写权限。
    说明
    • 字段名必须是英文字母,且长度不能超过8个字符。
    • 需至少设置一种读权限和一种写权限。

  1. 单击确定保存配置。

修改用户自定义字段权限

  1. 用户自定义字段页面,单击目标自定义字段所在行的修改权限

  2. 在弹出的用户自定义字段对话框中,修改读写权限。

  3. 单击确认保存配置。

  4. 单击确定保存配置。

群成员自定义字段

登录 即时通信 IM 控制台 ,单击目标应用卡片,在左侧导航栏选择功能配置>群成员自定义字段,您可以根据实际业务需求管理群成员自定义字段。

注意:

最多可添加5个群成员自定义字段,该字段仅支持修改群组类型及其对应的读写权限且不支持删除,请根据业务需求合理规划该字段。

添加群成员自定义字段

  1. 群成员自定义字段页面,右侧单击新增按键。
  2. 在弹出的群成员维度自定义字段对话框中,输入字段名称,设置群组类型及其对应的读写权限。
说明
  • 字段名称只能由字母、数字以及下划线(_)组成,不能以数字开头,且长度不能超过16个字符。
  • 群成员自定义字段名称不允许与群自定义字段名称一致。
  • 单击添加群组类型可新增一组群组类型参数,群组类型不可重复。
  • 单击目标群组类型参数组所在行的删除可删除该组群组类型参数,需至少保留一组群组类型参数。
    1. 勾选我已知道“群成员自定义字段”添加后,仅可修改已添加群组类型的读写权限;无法删除该字段,无法重新选择也无法删除已添加的群组类型。
    2. 单击确定保存设置。

编辑群成员自定义字段

  1. 群成员自定义字段页面,单击目标群成员自定义字段所在行的编辑
  2. 在弹出的群成员维度自定义字段对话框中,修改已选群组类型的读写权限,或单击添加群组类型新增群组类型并设置其参数,群组类型不可重复。
  3. 勾选我已知道“群成员自定义字段”添加后,仅可修改已添加群组类型的读写权限;无法删除该字段,无法重新选择也无法删除已添加的群组类型。
  4. 单击确定保存设置。

群自定义字段

登录 即时通信 IM 控制台 ,单击目标应用卡片,在左侧导航栏选择功能配置>群自定义字段,您可以根据实际业务需求管理群自定义字段。

注意:

最多可添加5个群自定义字段,该字段仅支持修改群组类型及其对应的读写权限且不支持删除,请根据业务需求合理规划该字段。

添加群自定义字段

  1. 在群自定义字段页面,单击添加群维度自定义字段。
  2. 在弹出的群维度自定义字段对话框中,输入字段名称,设置群组类型及其对应的读写权限。
说明:

  • 字段名称只能由字母、数字以及下划线(_)组成,不能以数字开头,且长度不能超过16个字符。
  • 群自定义字段名称不允许与群成员自定义字段名称一致。
  • 单击添加群组类型可新增一组群组类型参数,群组类型不可重复。
  • 单击目标群组类型参数组所在行的删除可删除该组群组类型参数,需至少保留一组群组类型参数。
    1. 勾选我已知道“群成员自定义字段”添加后,仅可修改已添加群组类型的读写权限;无法删除该字段,无法重新选择也无法删除已添加的群组类型。
    2. 单击确定保存设置。

编辑群自定义字段

  1. 在群自定义字段页面,单击目标群自定义字段所在行的编辑。
  2. 在弹出的群维度自定义字段对话框中,修改已选群组类型的读写权限,或单击添加群组类型新增群组类型并设置其参数,群组类型不可重复。
  3. 勾选我已知道“群成员自定义字段”添加后,仅可修改已添加群组类型的读写权限;无法删除该字段,无法重新选择也无法删除已添加的群组类型。
  4. 单击确定保存设置。
目录