SDK 文档

服务端 API

使用限制

最近更新时间:2020-10-29 14:56:35

业务特性限制

功能特性 限制项 限制说明
单聊/群聊消息 内容长度 单聊、群聊消息,单条消息最大长度限制为8000字节,超过此长度会被系统丢弃
发送频率 单条消息长度不能超过8000字节
对同一帐号发送单聊消息时,建议频率不要超过10条/秒。
单个文件大小 发送文件消息时,SDK 最大支持发送单个文件大小为100MB
历史消息存储时长 单聊消息及非直播群消息具备历史消息存储能力,您可以登录 即时通信 IM 控制台 修改相关配置。不同套餐包默认配置如下:
  • 体验版:7天,不支持延长
  • 专业版:7天,支持延长
  • 旗舰版:30天,支持延长
延长历史消息存储时长是付费增值服务,具体计费说明请参见 增值服务资费
系统消息 数量及存储时间 最多保存100条,存储时长不超过7天
UserID 命名规则 用户帐号长度不超过32字节,不支持使用特殊字符,建议使用英文字母或数字
用户资料 自定义字段 自定义字段的关键字必须是英文字母且长度不得超过8字节,自定义字段的值最长不能超过500字节
UserSig 有效期 用户密码,即时通信 IM 后台 SDK 默认接口生成的签名有效期为180天
会话管理 最近联系人数量 普通用户最多保存100个最近联系人
用户关系链 好友及分组
  • 单个用户支持3000个好友
  • 添加好友时未决消息最多支持100条
  • 好友分组最多支持32个
  • 每个分组的名称最长30字节
  • 好友备注最长支持96字节
黑名单 单个用户最多允许的黑名单人数为1000人
群组 群组数量 指单个 SDKAppID 中同时存在的所有群组类型群数之和,已解散的群组不计数,若已达峰值,可先解散无需使用的群组再创建新群组。不同套餐包限制如下:
  • 体验版: 100个
  • 专业版或旗舰版:无上限

  • 日净增群组数最多支持1万个,免费峰值群组数为10万个/月。若峰值群组数超出免费量将产生套餐外超量费用,计费详情请参见 套餐外超量费用
    群成员数量 直播群(AvChatRoom):无成员数量上限
    非直播群,不同套餐包默认配置如下:
    • 体验版:20人/群
    • 专业版 :200人/群,支持拓展至2000人/群
    • 旗舰版:2000人/群,支持拓展至6000人/群
    • 拓展群成员人数上限是付费增值服务,具体计费说明请参见增值服务资费
    用户可加入群组数 指用户同时加入的所有群组类型群数之和,不同套餐包限制如下:
    • 体验版:50个群/人
    • 专业版:500个群/人,支持扩展至1000个群/人
    • 旗舰版:支持扩展至3000个群/人
    拓展单人可加入群组数上限是付费增值服务,具体计费说明请参见 增值服务资费
    群资料
    • 群名称最长30字节
    • 群简介最长240字节
    • 群公告最长300字节
    • 群头像 URL 最长100字节
    • 群名片最大不超过50个字节
    自定义群组 ID 自定义群组 ID 必须为可打印 ASCII 字符(0x20-0x7e),最长48个字节,且前缀不能为 @TGS#(避免与默认分配的群组 ID 混淆)
    群组维度自定义字段 群组维度最多支持20个自定义字段:
    • 字段 Key 为 String 类型,长度不超过16字节,其命名仅支持英文大小写字母、数字、下划线
    • 字段 Value 为用户自定义 Buffer,可以为二进制数据,群维度的 Value 长度不超过512字节
    群成员维度自定义字段 群成员维度最多支持5个自定义字段:
    • 字段 Key 为 String 类型,长度不超过16字节,其命名仅支持英文大小写字母、数字、下划线
    • 字段 Value 为用户自定义 Buffer,可以为二进制数据,群成员维度的 Value 长度不超过64字节

    接口相关限制

    说明:

    本文仅列出涉及使用限制的 REST API,更全面的 API 列表请参见 REST API 接口列表

    通用限制

    限制项 限制说明
    调用频率

    帐号管理

    接口 限制说明
    导入多个帐号 单次最多导入100个用户名,且本接口不支持直接导入帐号的昵称和头像信息
    查询帐号在线状态 一次请求最多可以查询500个用户的状态

    单聊消息

    接口 限制说明
    批量发单聊消息 一次请求最多可给500个用户发送单聊消息

    关系链管理

    接口 限制说明
    导入好友 一次请求最多只能导入1000个好友

    群组管理

    接口 限制说明
    增加群组成员 一次最多支持添加100个成员
    删除群组成员 一次请求最多可删除500个成员
    查询用户在群组中的身份 一次请求最多支持查询500个帐号
    批量禁言和取消禁言 一次请求最多可禁言/取消禁言500个帐号
    在群组中发送普通消息 单个群的默认发送频率限制为40条/秒
    如果5分钟内同一发送者的两条消息的随机值(Random 参数)相同,后面的消息将被当做重复消息而丢弃
    导入群消息 一次请求最多可导入20条消息,要求按消息时间戳递增的顺序导入,消息时间戳必须大于建群时间且小于当前时间,否则失败
    导入群成员 直播群(AvChatRoom)不支持导入群成员
    一次请求最多可导入500个成员,但群成员数上限同时受不同群组类型的特性约束,详情请参见 群组功能
    目录