频控说明

更新时间: 2024/05/06 15:19:38

本文将帮助您快速了解网易云信即时通讯 IM 的 REST API 接口以及对应的频控分类。

V10 版本为云信推出的全新 SDK 接口版本,同时配套了全新的服务端 API 2.0 接口,该版本新增云端会话功能,以及云端会话分组功能,采用该版本接口可以实现一系列即时通讯能力。全量服务端 API 列表请参见 API 概览

V9 版本为云信长期维护的历史版本,同样可以实现一系列即时通讯能力,若您仍在使用 V9 版本,同样可按需调整相应的频控。全量服务端 API 列表请参见 API 概览

以下主要介绍各套餐包下不同频控类别的 API 频控限制情况。

用户&关系

包含用户账号、好友关系等用户管理相关的单次类 API 频控调整。

频控限制

版本 2024标准版 2024高级版 2024旗舰版 2024专属版 增值费用(2024国内) 增值费用(2024海外)
默认值 100/s 100/s 500/s 5000/s
  • 2024高级版:每超100功能费+400元/月
  • 2024旗舰版:每超100功能费+300元/月
  • 2024专属版:每超100功能费+200元/月
  • 2024高级版:每超100功能费+600元/月
  • 2024旗舰版:每超100功能费+500元/月
  • 2024专属版:每超100功能费+300元/月
  • 可配置最高值 不可调整 5000/s 10000/s 50000/s - -

    所属 API

    V10 版本 API 请求 URL V9 版本 API
    注册云信 IM 账号 POST https://open.yunxinapi.com/im/v2/accounts 注册云信 IM 账号
    更新账号属性 PATCH https://open.yunxinapi.com/im/v2/accounts/:{account_id} 账号功能模块禁言
    刷新 Token PATCH https://open.yunxinapi.com/im/v2/accounts/:{account_id}/actions/refresh_token 刷新 Token
    封禁账号 PATCH https://open.yunxinapi.com/im/v2/accounts/:{account_id}/actions/disable 封禁账号
    更新移动端推送配置 PATCH https://open.yunxinapi.com/im/v2/accounts/:{account_id}/actions/push_config 设置移动端是否需要推送(桌面端在线时)
    查询账号属性 GET https://open.yunxinapi.com/im/v2/accounts/:{account_id} -
    批量查询账号信息 GET https://open.yunxinapi.com/im/v2/accounts -
    更新用户名片 PATCH https://open.yunxinapi.com/im/v2/users/:{account_id} 更新用户名片
    查询用户名片 GET https://open.yunxinapi.com/im/v2/users/:{account_id} -
    批量查询用户名片 GET https://open.yunxinapi.com/im/v2/users 获取用户名片
    添加好友 POST https://open.yunxinapi.com/im/v2/friends 添加好友
    删除好友 DELETE https://open.yunxinapi.com/im/v2/friends/:{account_id} 删除好友关系
    更新好友信息 PATCH https://open.yunxinapi.com/im/v2/friends/:{account_id} 更新好友相关信息
    查询好友信息 GET https://open.yunxinapi.com/im/v2/friends/:{account_id} 获取好友关系
    分页查询好友信息 GET https://open.yunxinapi.com/im/v2/friends 获取好友列表
    设置静音 POST https://open.yunxinapi.com/im/v2/mute_contacts 设置黑名单/静音
    解除静音 DELETE https://open.yunxinapi.com/im/v2/mute_contacts/:{account_id}
    分页查询静音列表 GET https://open.yunxinapi.com/im/v2/mute_contacts 查看指定用户的黑名单和静音列表
    列入黑名单 POST https://open.yunxinapi.com/im/v2/block_contacts 设置黑名单/静音
    移出黑名单 DELETE https://open.yunxinapi.com/im/v2/block_contacts/:{account_id}
    分页查询黑名单列表 GET https://open.yunxinapi.com/im/v2/block_contacts 查看指定用户的黑名单和静音列表

    云端会话

    包含会话获取、更新、分组管理相关的单次类 API 频控调整。

    云端会话分类仅支持 V10 版本。

    频控限制

    版本 2024标准版 2024高级版 2024旗舰版 2024专属版 增值费用(2024国内) 增值费用(2024海外)
    默认值 100/s 100/s 500/s 5000/s
  • 2024高级版:每超100功能费+400元/月
  • 2024旗舰版:每超100功能费+300元/月
  • 2024专属版:每超100功能费+200元/月
  • 2024高级版:每超100功能费+600元/月
  • 2024旗舰版:每超100功能费+500元/月
  • 2024专属版:每超100功能费+300元/月
  • 可配置最高值 不可调整 5000/s 10000/s 50000/s - -

    所属 API

    V10 版本 API 请求 URL V9 版本 API
    获取会话总未读数 GET https://open.yunxinapi.com/im/v2/conversation_overviews/:{account_id} 不支持
    创建会话 POST https://open.yunxinapi.com/im/v2/conversations
    更新会话 PATCH https://open.yunxinapi.com/im/v2/conversations/:{conversation_id}
    删除会话 DELETE https://open.yunxinapi.com/im/v2/conversations/:{conversation_id}
    批量删除会话 DELETE https://open.yunxinapi.com/im/v2/conversations/actions/conversation_ids
    查询会话 GET https://open.yunxinapi.com/im/v2/conversations/:{conversation_id}
    批量查询会话 GET https://open.yunxinapi.com/im/v2/conversations/actions/conversation_ids
    分页查询用户的所有会话列表 GET https://open.yunxinapi.com/im/v2/conversations
    创建会话分组 POST https://open.yunxinapi.com/im/v2/conversation_groups
    更新会话分组 PATCH https://open.yunxinapi.com/im/v2/conversation_groups/:{group_id}
    删除会话分组 DELETE https://open.yunxinapi.com/im/v2/conversation_groups/:{group_id}
    查询会话分组 GET https://open.yunxinapi.com/im/v2/conversation_groups/:{group_id}
    批量查询会话分组 GET https://open.yunxinapi.com/im/v2/conversation_groups/actions/group_ids
    查询所有会话分组 GET https://open.yunxinapi.com/im/v2/conversation_groups

    消息

    包含发送消息、查询消息等消息相关的单次类 API 频控调整。

    • 批量发送单聊消息批量发送自定义系统通知接口统一至批量消息分类中调整。
    • 发送广播消息发送聊天室全服广播接口统一至广播消息分类中调整。(广播消息的删除和查询接口仍在消息分类中调整。)

    频控限制

    版本 2024标准版 2024高级版 2024旗舰版 2024专属版 增值费用(2024国内) 增值费用(2024海外)
    默认值 100/s 100/s 500/s 5000/s
  • 2024高级版:每超100功能费+400元/月
  • 2024旗舰版:每超100功能费+300元/月
  • 2024专属版:每超100功能费+200元/月
  • 2024高级版:每超100功能费+600元/月
  • 2024旗舰版:每超100功能费+500元/月
  • 2024专属版:每超100功能费+300元/月
  • 可配置最高值 不可调整 5000/s 10000/s 50000/s - -

    所属 API

    V10 版本 API 请求 URL V9 版本 API
    发送消息 POST https://open.yunxinapi.com/im/v2/conversations/:{conversation_id}/messages 发送消息
    撤回/删除消息 DELETE https://open.yunxinapi.com/im/v2/conversations/:{conversation_id}/messages/:{message_server_id}
  • 消息撤回
  • 删除单条消息
  • 删除会话中漫游/历史消息 DELETE https://open.yunxinapi.com/im/v2/conversations/:{conversation_id}/messages 删除漫游消息
    发送单聊已读回执 POST https://open.yunxinapi.com/im/v2/messages/actions/p2p_read_receipt 发送单聊已读回执
    发送高级群已读回执 POST https://open.yunxinapi.com/im/v2/messages/actions/team_read_receipt 发送群聊消息回执
    查询群消息已读未读详情 GET https://open.yunxinapi.com/im/v2/messages/actions/team_read_receipt 获取群消息已读未读详情
    查询单条消息 GET https://open.yunxinapi.com/im/v2/conversations/:{conversation_id}/messages/:{message_server_id} 单聊云端历史消息查询
    分页查询历史消息 GET https://open.yunxinapi.com/im/v2/conversations/:{conversation_id}/messages
  • 单聊云端历史消息查询
  • 群聊云端历史消息查询
  • 超大群云端历史消息查询
  • 发送聊天室消息 POST https://open.yunxinapi.com/im/v2/chatrooms/:{room_id}/messages 发送聊天室消息
    批量发送聊天室消息 POST https://open.yunxinapi.com/im/v2/chatrooms/messages 批量发送聊天室消息
    撤回/删除聊天室历史消息 DELETE https://open.yunxinapi.com/im/v2/chatrooms/:{room_id}/messages/:{message_client_id}
  • 撤回聊天室消息
  • 删除聊天室云端历史消息
  • 分页查询聊天室历史消息 GET https://open.yunxinapi.com/im/v2/chatrooms/:{room_id}/messages 聊天室云端历史消息查询
    删除广播消息 DELETE https://open.yunxinapi.com/im/v2/broadcast_notification/:{broadcast_id} 删除单条广播消息
    查询广播消息 GET https://open.yunxinapi.com/im/v2/broadcast_notification/:{broadcast_id} 查询单条广播消息
    分页查询广播消息 GET https://open.yunxinapi.com/im/v2/broadcast_notification 批量查询广播消息
    发送自定义系统通知 POST https://open.yunxinapi.com/im/v2/custom_notification 发送自定义系统通知

    群组

    包含创建群、群列表获取、群成员管理等群组相关的单次类 API 频控调整。

    频控限制

    版本 2024标准版 2024高级版 2024旗舰版 2024专属版 增值费用(2024国内) 增值费用(2024海外)
    默认值 100/s 100/s 500/s 5000/s
  • 2024高级版:每超100功能费+400元/月
  • 2024旗舰版:每超100功能费+300元/月
  • 2024专属版:每超100功能费+200元/月
  • 2024高级版:每超100功能费+600元/月
  • 2024旗舰版:每超100功能费+500元/月
  • 2024专属版:每超100功能费+300元/月
  • 可配置最高值 不可调整 5000/s 10000/s 50000/s - -

    所属 API

    V10 版本 API 请求 URL V9 版本 API
    创建群组 POST https://open.yunxinapi.com/im/v2/teams
  • 创建高级群
  • 创建超大群
  • 更新群组信息 PATCH https://open.yunxinapi.com/im/v2/teams/:{team_id}
  • 修改群组信息
  • 修改超大群信息
  • 修改超大群人数级别
  • 禁言群组
  • 禁言超大群
  • 转让群组 PATCH https://open.yunxinapi.com/im/v2/teams/:{team_id}/actions/transfer_owner
  • 转让群组
  • 转让超大群
  • 添加管理员 POST https://open.yunxinapi.com/im/v2/teams/:{team_id}/actions/add_manager
  • 添加管理员
  • 添加超大群管理员
  • 移除管理员 DELETE https://open.yunxinapi.com/im/v2/teams/:{team_id}/actions/remove_manager
  • 移除管理员
  • 移除超大群管理员
  • 解散群组 DELETE https://open.yunxinapi.com/im/v2/teams/:{team_id}
  • 解散群组
  • 解散超大群
  • 查询群组信息 GET https://open.yunxinapi.com/im/v2/teams/:{team_id}
  • 获取群组详细信息
  • 获取超大群信息
  • 批量查询群组信息列表 GET https://open.yunxinapi.com/im/v2/teams 批量获取群组信息与成员列表
    查询高级群在线成员列表 GET https://open.yunxinapi.com/im/v2/teams/:{team_id}/actions/list_online_members 获取群组的在线成员列表
    分页查询群成员列表 GET https://open.yunxinapi.com/im/v2/teams/:{team_id}/actions/list_members
  • 批量获取群组信息与成员列表
  • 获取群组禁言列表
  • 获取超大群禁言成员信息
  • 获取超大群成员信息
  • 批量查询高级群在线成员数 GET https://open.yunxinapi.com/im/v2/teams/actions/online_members_count 批量获取群组的在线成员数量
    拉人入群 POST https://open.yunxinapi.com/im/v2/team_members
  • 拉人入群
  • 拉人入超大群
  • 踢人出群 DELETE https://open.yunxinapi.com/im/v2/team_members/actions/kick_member
  • 踢人出群
  • 踢人出超大群
  • 主动退群 DELETE https://open.yunxinapi.com/im/v2/team_members/actions/leave
  • 主动退群
  • 主动退出超大群
  • 更新群成员信息 PATCH https://open.yunxinapi.com/im/v2/team_members/:{account_id}
  • 禁言指定群成员
  • 修改群昵称
  • 设置群消息提醒开关
  • 修改超大群成员信息
  • 修改超大群昵称
  • 分页查询指定账号已加入的群组信息 GET https://open.yunxinapi.com/im/v2/team_members/:{account_id}/actions/joined_teams
  • 获取用户已加入的群组信息
  • 获取已加入的超大群信息
  • 获取用户已加入的群组的所有群成员信息
  • 批量禁言群成员 PATCH https://open.yunxinapi.com/im/v2/team_members/actions/batch_mute 禁言指定超大群成员

    聊天室

    包含获取聊天室地址、获取聊天室信息、聊天室用户管理等聊天室相关的单次类 API 频控调整。

    频控限制

    版本 2024标准版 2024高级版 2024旗舰版 2024专属版 增值费用(2024国内) 增值费用(2024海外)
    默认值 100/s 100/s 500/s 5000/s
  • 2024高级版:每超100功能费+400元/月
  • 2024旗舰版:每超100功能费+300元/月
  • 2024专属版:每超100功能费+200元/月
  • 2024高级版:每超100功能费+600元/月
  • 2024旗舰版:每超100功能费+500元/月
  • 2024专属版:每超100功能费+300元/月
  • 可配置最高值 不可调整 5000/s 10000/s 50000/s - -

    所属 API

    V10 版本 API 请求 URL V9 版本 API
    创建聊天室 POST https://open.yunxinapi.com/im/v2/chatrooms 创建聊天室
    获取聊天室地址 GET https://open.yunxinapi.com/im/v2/chatrooms/:{room_id}/actions/address 获取聊天室地址
    更新聊天室信息 PATCH https://open.yunxinapi.com/im/v2/chatrooms/:{room_id} 更新聊天室信息
    开放/关闭聊天室 PATCH https://open.yunxinapi.com/im/v2/chatrooms/:{room_id}/actions/update_status 开放/关闭聊天室
    聊天室禁言 PATCH https://open.yunxinapi.com/im/v2/chatrooms/:{room_id}/actions/chat_banned 将聊天室整体禁言
    开启/关闭进出聊天室事件通知 PATCH https://open.yunxinapi.com/im/v2/chatrooms/:{room_id}/actions/in_out_notification 开启/关闭进出聊天室事件通知
    查询聊天室信息 GET https://open.yunxinapi.com/im/v2/chatrooms/:{room_id} 查询聊天室信息
    查询开放状态的聊天室 GET https://open.yunxinapi.com/im/v2/chatrooms/actions/opend_chatrooms 查询开放状态的聊天室
    分页查询聊天室在线成员列表 GET https://open.yunxinapi.com/im/v2/chatrooms/:{room_id}/actions/list_online_members 获取聊天室成员列表
    查询聊天室固定成员列表 GET https://open.yunxinapi.com/im/v2/chatrooms/:{room_id}/actions/list_members
    批量查询聊天室固定成员信息 GET https://open.yunxinapi.com/im/v2/room_members/:{room_id}/actions/batch
    设置聊天室成员角色 POST https://open.yunxinapi.com/im/v2/room_members/:{account_id} 管理聊天室用户角色
    更新聊天室成员信息 PATCH https://open.yunxinapi.com/im/v2/room_members/:{account_id}
    禁言聊天室成员 PATCH https://open.yunxinapi.com/im/v2/room_members/:{account_id}/actions/chat_banned 设置角色
    临时禁言聊天室成员 PATCH https://open.yunxinapi.com/im/v2/room_members/:{account_id}/actions/temp_chat_banned 设置临时禁言状态
    拉黑聊天室成员 PATCH https://open.yunxinapi.com/im/v2/room_members/:{account_id}/actions/blocked 设置角色
    查询聊天室禁言列表 GET https://open.yunxinapi.com/im/v2/room_members/:{room_id}/actions/chat_banned 获取聊天室成员列表
    查询聊天室黑名单列表 GET https://open.yunxinapi.com/im/v2/room_members/:{room_id}/actions/blocked
    聊天室标签禁言 PATCH https://open.yunxinapi.com/im/v2/room_members/actions/chat_banned_tagged_members 标签禁言
    修改聊天室在线成员标签 PATCH https://open.yunxinapi.com/im/v2/room_members/:{account_id}/actions/tags 修改聊天室用户标签
    查询标签下的在线成员数 GET https://open.yunxinapi.com/im/v2/room_members/:{room_id}/actions/tagged_members_count 查询标签下的在线用户数
    分页查询标签下的在线成员列表 GET https://open.yunxinapi.com/im/v2/room_members/:{room_id}/actions/list_tag_members 根据标签查询在线成员列表
    添加聊天室虚构用户 POST https://open.yunxinapi.com/im/v2/room_members/actions/virtual_members 添加聊天室机器人
    删除聊天室虚构用户 DELETE https://open.yunxinapi.com/im/v2/room_members/actions/virtual_members 删除聊天室机器人
    清空聊天室虚构用户 DELETE https://open.yunxinapi.com/im/v2/room_members/actions/clear_virtual_members 清空聊天室机器人
    查询聊天室虚构用户 GET https://open.yunxinapi.com/im/v2/room_members/actions/virtual_members -

    圈组

    包含创建 server、channel 列表获取、身份组管理等圈组相关的单次类 API 频控调整。

    频控限制

    版本 2024标准版 2024高级版 2024旗舰版 2024专属版 增值费用(2024国内) 增值费用(2024海外)
    默认值 100/s 100/s 500/s 5000/s
  • 2024高级版:每超100功能费+400元/月
  • 2024旗舰版:每超100功能费+300元/月
  • 2024专属版:每超100功能费+200元/月
  • 2024高级版:每超100功能费+600元/月
  • 2024旗舰版:每超100功能费+500元/月
  • 2024专属版:每超100功能费+300元/月
  • 可配置最高值 不可调整 5000/s 10000/s 50000/s - -

    所属 API

    圈组相关 API 请参考圈组 API 概览

    批量发送消息

    针对批量发送消息操作的 API 频控调整。

    频控限制

    版本 2024标准版 2024高级版 2024旗舰版 2024专属版 增值费用(2024国内) 增值费用(2024海外)
    默认值 120/min 120/min 200/min 2000/min
  • 2024高级版:每超100功能费+1000元/月
  • 2024旗舰版:每超100功能费+800元/月
  • 2024专属版:每超100功能费+300元/月
  • 2024高级版:每超10功能费+1000元/月
  • 2024旗舰版:每超10功能费+800元/月
  • 2024专属版:每超10功能费+300元/月
  • 可配置最高值 不可调整 2000/min 5000/min 10000/min - -

    所属 API

    V10 版本 API 请求 URL V9 版本 API
    批量发送单聊消息 POST https://open.yunxinapi.com/im/v2/conversations/messages 批量发送单聊消息
    批量发送自定义系统通知 POST https://open.yunxinapi.com/im/v2/custom_notification/batch 批量发送自定义系统通知

    广播消息

    包含发送广播消息、发送聊天室全服广播接口的 API 频控调整。

    频控限制

    版本 2024标准版 2024高级版 2024旗舰版 2024专属版 增值费用(2024国内) 增值费用(2024海外)
    默认值 不支持 10/min 50/min 1000/min
  • 2024高级版:每超10功能费+800元/月
  • 2024旗舰版:每超10功能费+500元/月
  • 2024专属版:每超10功能费+200元/月
  • 2024高级版:每超10功能费+1000元/月
  • 2024旗舰版:每超10功能费+800元/月
  • 2024专属版:每超10功能费+300元/月
  • 可配置最高值 不支持 1000/min 2000/min 5000/min - -

    所属 API

    V10 版本 API 请求 URL V9 版本 API
    发送广播消息 POST https://open.yunxinapi.com/im/v2/broadcast_notification 发送广播消息
    发送聊天室全服广播消息 POST https://open.yunxinapi.com/im/v2/broadcast_notification/actions/chatroom 发送聊天室全服广播消息
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 用户&关系
    • 频控限制
    • 所属 API
    • 云端会话
    • 频控限制
    • 所属 API
    • 消息
    • 频控限制
    • 所属 API
    • 群组
    • 频控限制
    • 所属 API
    • 聊天室
    • 频控限制
    • 所属 API
    • 圈组
    • 频控限制
    • 所属 API
    • 批量发送消息
    • 频控限制
    • 所属 API
    • 广播消息
    • 频控限制
    • 所属 API