API 参考
在线调试

API 概览与频控

更新时间: 2024/07/17 16:46:45

本文主要罗列了云信 IM 的新版 API 接口列表,以及各个接口的使用限制(频控)。

新版 API 大部分接口都对应并兼容旧版相关接口,对应关系也在下列表格中说明。

频控说明

网易云信 IM 即时通信于 2024 年上线四大全新套餐:2024 标准版、2024 高级版、2024 旗舰版、2024 专属版。各套餐详情请参考 新套餐计费概述

IM 各套餐包下不同 频控类别 的 API 频控限制情况不同,具体限值需要参考对应的套餐包。

目前云信 IM 频控类别 包括:

  • 用户&关系:包含用户账号、用户名片、好友关系、静音以及黑名单等用户管理相关的单次类 API 频控调整。

  • 云端会话:包含云端会话、会话分组、会话未读数等会话功能相关的单次类 API 频控调整。

  • 消息:包含发送消息、查询消息等消息相关、广播消息相关以及系统通知相关的单次类 API 频控调整。

    • 批量发送单聊消息批量发送自定义系统通知 接口统一至 批量发送消息分类中调整。
    • 发送广播消息发送聊天室全服广播 接口统一至 发送广播消息 分类中调整。(广播消息的删除和查询接口仍在 消息分类 中调整。)
  • 群组:包含创建群、群列表获取、群成员管理等群组相关的单次类 API 频控调整。

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

  • 圈组:包含创建圈组服务器、圈组频道列表获取、身份组管理等圈组相关的单次类 API 频控调整。

  • 批量发送消息:针对批量发送消息操作(批量发送单聊消息、批量发送自定义系统通知)的 API 频控调整。

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

  • 单个应用内的用户在一定时间内调用云信 IM 接口的次数超出限制,云信服务端会返回 416 错误码,并且会有一定的惩罚时间,即超出限制后在一定时间内再调用该接口会被屏蔽。
  • 若根据业务需要调整部分接口的频控,可在云信控制台 自行调整,或通过官网首页右侧的联系方式联系云信商务经理进行调整。

用户&关系

包含用户账号、用户名片、好友关系、静音以及黑名单等用户管理相关的单次类 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

    云信 IM 账号管理

    API 请求 URL 对应并兼容的旧版接口
    注册云信 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 -

    用户名片管理

    API 请求 URL 对应并兼容的旧版接口
    更新用户名片 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 获取用户名片

    好友管理

    API 请求 URL 对应并兼容的旧版接口
    添加好友 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 获取好友列表

    静音管理

    API 请求 URL 对应并兼容的旧版接口
    设置静音 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 查看指定用户的黑名单和静音列表

    黑名单管理

    API 请求 URL 对应并兼容的旧版接口
    列入黑名单 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 查看指定用户的黑名单和静音列表

    消息

    频控限制

    版本 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 请求 URL 对应并兼容的旧版接口
    发送消息 POST https://open.yunxinapi.com/im/v2/conversations/:{conversation_id}/messages 发送消息
    批量发送单聊消息 POST https://open.yunxinapi.com/im/v2/conversations/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 聊天室云端历史消息查询

    广播消息管理

    API 请求 URL 对应并兼容的旧版接口
    发送广播消息 POST https://open.yunxinapi.com/im/v2/broadcast_notification 发送广播消息
    删除广播消息 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/broadcast_notification/actions/chatroom 发送聊天室全服广播消息

    系统通知管理

    API 请求 URL 对应并兼容的旧版接口
    发送自定义系统通知 POST https://open.yunxinapi.com/im/v2/custom_notification 发送自定义系统通知
    批量发送自定义系统通知 POST https://open.yunxinapi.com/im/v2/custom_notification/batch 批量发送自定义系统通知

    会话功能

    频控限制

    版本 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 请求 URL 对应并兼容的旧版接口
    获取会话总未读数 GET https://open.yunxinapi.com/im/v2/conversation_overviews/:{account_id} -

    会话分组

    API 请求 URL 对应并兼容的旧版接口
    创建会话分组 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 请求 URL 对应并兼容的旧版接口
    创建会话 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 -

    群组功能

    频控限制

    版本 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 请求 URL 对应并兼容的旧版接口
    创建群组 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/actions/online_members_count 批量获取群组的在线成员数量
    分页查询群成员列表 GET https://open.yunxinapi.com/im/v2/teams/:{team_id}/actions/list_members
  • 批量获取群组信息与成员列表
  • 获取群组禁言列表
  • 获取超大群禁言成员信息
  • 获取超大群成员信息
  • 群成员管理

    API 请求 URL 对应并兼容的旧版接口
    拉人入群 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}
  • 禁言指定群成员
  • 修改群昵称
  • 设置群消息提醒开关
  • 修改超大群成员信息
  • 修改超大群昵称
  • 批量禁言群成员 PATCH https://open.yunxinapi.com/im/v2/team_members/actions/batch_mute 禁言指定超大群成员
    分页查询指定账号已加入的群组信息 GET https://open.yunxinapi.com/im/v2/team_members/:{account_id}/actions/joined_teams
  • 获取用户已加入的群组信息
  • 获取已加入的超大群信息
  • 获取用户已加入的群组的所有群成员信息
  • 聊天室

    频控限制

    版本 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 请求 URL 对应并兼容的旧版接口
    创建聊天室 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

    聊天室成员管理

    API 请求 URL 对应并兼容的旧版接口
    设置聊天室成员角色 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
    批量查询聊天室固定成员信息 GET https://open.yunxinapi.com/im/v2/room_members/:{room_id}/actions/batch
    聊天室标签禁言 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 -

    圈组

    频控限制

    版本 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 概览

    批量发送消息

    频控限制

    版本 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 批量发送自定义系统通知

    发送广播消息

    频控限制

    版本 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 发送聊天室全服广播消息

    调整接口频控

    对于部分接口支持在云信控制台自行调整,其他接口频控的变更需要联系云信商务经理处理。

    云信控制台配置频控

    1. 在控制台首页应用管理中选择应用,然后单击 IM 即时通讯下的功能配置按钮进入功能配置页。

      image.png
    2. 顶部选择服务端频控页签,开启需要调整的接口频控。

      开启频控.png

    3. 开启后,可单击编辑,输入频控值。

      后续会根据新设置的频控进行计费。

    此文档是否对你有帮助?
    有帮助
    去反馈
    • 频控说明
    • 用户&关系
    • 频控限制
    • 所属 API
    • 云信 IM 账号管理
    • 用户名片管理
    • 好友管理
    • 静音管理
    • 黑名单管理
    • 消息
    • 频控限制
    • 所属 API
    • 消息管理
    • 广播消息管理
    • 系统通知管理
    • 会话功能
    • 频控限制
    • 所属 API
    • 会话未读数管理
    • 会话分组
    • 会话管理
    • 群组功能
    • 频控限制
    • 所属 API
    • 群组管理
    • 群成员管理
    • 聊天室
    • 频控限制
    • 所属 API
    • 聊天室管理
    • 聊天室成员管理
    • 圈组
    • 频控限制
    • 所属 API
    • 批量发送消息
    • 频控限制
    • 所属 API
    • 发送广播消息
    • 频控限制
    • 所属 API
    • 调整接口频控