Restful API 调用频率限制

大约 11 分钟

Restful API 调用频率限制

除部分 API 接口有特殊说明外,API 调用频率限制默认为 100 次/秒,具体每个接口限制以下表为准。

按模块查看接口调用频率限制:

用户帐号管理

Restful API 接口方法接口 URL
注册单个用户POST/{org_name}/{app_name}/users
批量注册用户POST/{org_name}/{app_name}/users
设置推送消息显示昵称PUT/{org_name}/{app_name}/users/{username}
设置推送消息展示方式PUT/{org_name}/{app_name}/users/{username}
设置免打扰PUT/{org_name}/{app_name}/users/{username}

以上五个接口的总调用频率(默认值)为 100 次/秒/App Key。

Rest API 接口方法接口 URL接口最高调用频率(默认值)
获取 app/用户 tokenPOST/{org_name}/{app_name}/token300 次/秒/App Key
获取单个用户GET/{org_name}/{app_name}/users/{username}100 次/秒/App Key
批量获取用户GET/{org_name}/{app_name}/users100 次/秒/App Key
删除单个用户DELETE/{org_name}/{app_name}/users/{username}100 次/秒/App Key
批量删除用户DELETE/{org_name}/{app_name}/users30 次/秒/App Key
修改用户密码POST/{org_name}/{app_name}/users/{username}/password100 次/秒/App Key
获取用户在线状态GET/{org_name}/{app_name}/users/{username}/status100 次/秒/App Key
批量获取用户在线状态POST/{org_name}/{app_name}/users/batch/status50 次/秒/App Key
获取离线消息数GET/{org_name}/{app_name}/users/{owner_username}/offline_msg_count100 次/秒/App Key
获取离线消息的状态GET/{org_name}/{app_name}/users/{username}/offline_msg_status/{msg_id}100 次/秒/App Key
账号封禁POST/{org_name}/{app_name}/users/{username}/deactivate100 次/秒/App Key
账号解禁POST/{org_name}/{app_name}/users/{username}/activate100 次/秒/App Key
强制下线GET/{org_name}/{app_name}/users/{username}/disconnect100 次/秒/App Key

消息推送

RESTful API 接口方法接口 URL接口最高调用频率(默认值)
设置离线推送PUT/{org}/{app_name}/users/{username}/notification/{chattype}/{key}100 次/秒/App Key
查询离线推送设置GET/{org_name}/{app_name}/users/{username}/notification/{chattype}/{key}100 次/秒/App Key
设置推送通知的首选语言PUT/{org_name}/{app_name}/users/{username}/notification/language100 次/秒/App Key
获取推送通知的首选语言PUT/{org_name}/{app_name}/users/{username}/notification/language100 次/秒/App Key
创建离线推送模板POST/{org_name}/{app_name}/notification/template10 次/秒/App Key
查询离线推送模板GET/{org_name}/{app_name}/notification/template/{name}10 次/秒/App Key
删除离线推送模板DELETE/{org_name}/{app_name}/notification/template/{name}10 次/秒/App Key

消息管理

Rest API 接口方法接口 URL接口最高调用频率(默认值)
发送单聊消息POST/{org_name}/{app_name}/messages/users6000 条/分钟/App Key
发送群聊消息POST/{org_name}/{app_name}/messages/chatgroups20 条/秒/App Key
发送聊天室消息POST/{org_name}/{app_name}/messages/chatrooms100 条/秒/App Key
上传文件POST/{org_name}/{app_name}/chatfiles100 次/秒/App Key
下载文件GET/{org_name}/{app_name}/chatfiles/{file_uuid}100 次/秒/App Key
获取历史消息(聊天记录)文件GET/{org_name}/{app_name}/chatmessages/${time}10 次/分钟/App Key
服务端消息撤回POST/{org_name}/{app_name}/messages/recall100 次/秒/App Key
服务端单向删除会话DELETE/{org_name}/{app_name}/users/{userName}/user_channel5 次/分钟/单用户 ID,100 次/秒/App Key
拉取会话列表GET/{org_name}/{app_name}/user/{username}/user_channels5 次/分钟/单用户 ID,100 次/秒/App Key

用户属性

Rest API 接口方法接口 URL接口最高调用频率(默认值)
设置用户属性PUT/{org_name}/{app_name}/metadata/user/{username}100 次/秒/App Key
批量获取用户属性POST/{org_name}/{app_name}/metadata/user/get100 次/秒/App Key
删除用户属性DELETE/{org_name}/{app_name}/metadata/user/{username}100 次/秒/App Key
获取指定用户的所有用户属性GET/{org_name}/{app_name}/metadata/user/{username}100 次/秒/App Key
获取 app 下的用户属性总大小GET/{org_name}/{app_name}/metadata/user/capacity100 次/秒/App Key

用户关系管理

Rest API 接口方法接口 URL接口最高调用频率
添加好友POST/{org_name}/{app_name}/users/{owner_username}/contacts/users/{friend_username}100 次/秒/App Key
移除好友DELETE/{org_name}/{app_name}/users/{owner_username}/contacts/users/{friend_username}100 次/秒/App Key
获取好友列表GET/{org_name}/{app_name}/users/{owner_username}/contacts/users100 次/秒/App Key
获取黑名单列表GET/{org_name}/{app_name}/users/{owner_username}/blocks/users50 次/秒/App Key
添加用户至黑名单POST/{org_name}/{app_name}/users/{owner_username}/blocks/users50 次/秒/App Key
从黑名单移除用户DELETE/{org_name}/{app_name}/users/{owner_username}/blocks/users/{blocked_username}50 次/秒/App Key

群组管理

Rest API 接口方法接口 URL接口最高调用频率(默认值)
分页获取 app 中的群组GET/{org_name}/{app_name}/chatgroups?limit={N}&cursor={cursor}100 次/秒/App Key
获取一个用户加入的所有群组GET/{org_name}/{app_name}/users/{username}/joined_chatgroups50 次/秒/App Key
获取群组详情GET/{org_name}/{app_name}/chatgroups/{group_ids}100 次/秒/App Key
创建一个群组POST/{org_name}/{app_name}/chatgroups100 次/秒/App Key
修改群组信息PUT/{org_name}/{app_name}/chatgroups/{group_id}100 次/秒/App Key
删除群组DELETE/{org_name}/{app_name}/chatgroups/{group_id}100 次/秒/App Key
获取群组公告GET/{org_name}/{app_name}/chatgroups/{group_id}/announcement100 次/秒/App Key
修改群组公告POST/{org_name}/{app_name}/chatgroups/{group_id}/announcement100 次/秒/App Key
分页获取群组共享文件GET/{org_name}/{app_name}/chatgroups/{group_id}/share_files?pagenum=1&pagesize=10100 次/秒/App Key
上传群组共享文件POST/{org_name}/{app_name}/chatgroups/{group_id}/share_files100 次/秒/App Key
下载群组共享文件GET/{org_name}/{app_name}/chatgroups/{group_id}/share_files/{file_id}100 次/秒/App Key
删除群组共享文件DELETE/{org_name}/{app_name}/chatgroups/{group_id}/share_files/{file_id}100 次/秒/App Key

群成员管理

Rest API 接口方法接口 URL接口最高调用频率(默认值)
分页获取群组成员GET/{org_name}/{app_name}/chatgroups/{group_id}/users100 次/秒/App Key
添加单个群组成员POST/{org_name}/{app_name}/chatgroups/{group_id}/users/{username}100 次/秒/App Key
批量添加群组成员POST/{org_name}/{app_name}/chatgroups/{group_id}/users100 次/秒/App Key
移除单个群组成员DELETE/{org_name}/{app_name}/chatgroups/{group_id}/users/{username}100 次/秒/App Key
批量移除群组成员DELETE/{org_name}/{app_name}/chatgroups/{group_id}/users/{usernames}100 次/秒/App Key
设置群成员自定义属性PUT/{org_name}/{app_name}/metadata/chatgroup/{group_id}/user/{username}100 次/秒/App Key
获取单个群成员的所有自定义属性GET/{org_name}/{app_name}/metadata/chatgroup/{group_id}/user/{username}100 次/秒/App Key
根据属性 key 获取多个群成员的自定义属性GET/{org_name}/{app_name}/metadata/chatgroup/{group_id}/get100 次/秒/App Key
获取群管理员列表GET/{org_name}/{app_name}/chatgroups/{group_id}/admin100 次/秒/App Key
添加群管理员POST/{org_name}/{app_name}/chatgroups/{group_id}/admin100 次/秒/App Key
移除群管理员DELETE/{org_name}/{app_name}/chatgroups/{group_id}/admin/{oldadmin}100 次/秒/App Key
转让群组PUT/{org_name}/{app_name}/chatgroups/{group_id}100 次/秒/App Key
查询群组黑名单GET/{org_name}/{app_name}/chatgroups/{group_id}/blocks/users100 次/秒/App Key
添加单个用户至群组黑名单POST/{org_name}/{app_name}/chatgroups/{group_id}/blocks/users/{username}100 次/秒/App Key
批量添加用户至群组黑名单POST/{org_name}/{app_name}/chatgroups/{group_id}/blocks/users100 次/秒/App Key
从群组黑名单移除单个用户DELETE/{org_name}/{app_name}/chatgroups/{group_id}/blocks/users/{username}100 次/秒/App Key
批量从群组黑名单移除用户DELETE/{org_name}/{app_name}/chatgroups/{group_id}/blocks/users/{usernames}100 次/秒/App Key
查询群组白名单GET/{org_name}/{app_name}/chatgroups/{group_id}/white/users100 次/秒/App Key
添加单个用户至群组白名单POST/{org_name}/{app_name}/chatgroups/{group_id}/white/users/{username}100 次/秒/App Key
批量添加用户至群组白名单POST/{org_name}/{app_name}/chatgroups/{group_id}/blocks/users100 次/秒/App Key
将用户移除群组白名单DELETE/{org_name}/{app_name}/chatgroups/{group_id}/white/users/{username}100 次/秒/App Key
获取禁言列表GET/{org_name}/{app_name}/chatgroups/{group_id}/mute100 次/秒/App Key
禁言单个群成员POST/{org_name}/{app_name}/chatgroups/{group_id}/mute100 次/秒/App Key
禁言全体成员POST/{org_name}/{app_name}/chatgroups/{group_id}/ban100 次/秒/App Key
解除成员禁言DELETE/{org_name}/{app_name}/chatgroups/{group_id}/mute/{member1}(,{member2},…)100 次/秒/App Key
解除全员禁言DELETE/{org_name}/{app_name}/chatgroups/{group_id}/ban100 次/秒/App Key

聊天室管理

Rest API 接口方法接口 URL接口最高调用频率(默认值)
获取 app 中的聊天室GET/{org_name}/{app_name}/chatrooms?limit={N}&cursor={cursor}50 次/秒/App Key
获取用户加入的聊天室GET/{org_name}/{app_name}/users/{username}/joined_chatrooms50 次/秒/App Key
获取聊天室详情GET/{org_name}/{app_name}/chatrooms/{chatroom_id}100 次/秒/App Key
创建一个聊天室POST/{org_name}/{app_name}/chatrooms50 次/秒/App Key
修改聊天室信息PUT/{org_name}/{app_name}/chatrooms/{chatroom_id}100 次/秒/App Key
删除聊天室DELETE/{org_name}/{app_name}/chatrooms/{chatroom_id}100 次/秒/App Key
获取聊天室公告GET/{org_name}/{app_name}/chatrooms/{chatroom_id}/announcement100 次/秒/App Key
修改聊天室公告POST/{org_name}/{app_name}/chatrooms/{chatroom_id}/announcement100 次/秒/App Key
获取聊天室自定义属性POST/{org_name}/{app_name}/chatrooms/{chatroom_id}/announcement100 次/秒/App Key
设置聊天室自定义属性PUT/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user/{username}100 次/秒/App Key
强制设置聊天室自定义属性PUT/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user/{username}/forced100 次/秒/App Key
删除聊天室自定义属性DELETE/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user/{username}100 次/秒/App Key
强制删除聊天室自定义属性DELETE/{org_name}/{app_name}/metadata/chatroom/{chatroom_id}/user/{username}/forced100 次/秒/App Key

聊天室成员管理

Rest API 接口方法接口 URL接口最高调用频率(默认值)
分页获取聊天室成员GET/{org_name}/{app_name}/chatrooms/{chatroom_id}/users100 次/秒/App Key
添加单个聊天室成员POST/{org_name}/{app_name}/chatrooms/{chatroom_id}/users/{username}100 次/秒/App Key
批量添加聊天室成员POST/{org_name}/{app_name}/chatrooms/{chatroom_id}/users100 次/秒/App Key
删除单个聊天室成员DELETE/{org_name}/{app_name}/chatrooms/{chatroom_id}/users/{username}100 次/秒/App Key
批量删除聊天室成员DELETE/{org_name}/{app_name}/chatrooms/{chatroom_id}/users/{usernames}100 次/秒/App Key
获取聊天室管理员列表GET/{org_name}/{app_name}/chatrooms/{chatroom_id}/admin100 次/秒/App Key
添加聊天室管理员POST/{org_name}/{app_name}/chatrooms/{chatroom_id}/admin100 次/秒/App Key
移除聊天室管理员DELETE/{org_name}/{app_name}/chatrooms/{chatroom_id}/admin/{oldadmin}100 次/秒/App Key
查询聊天室黑名单GET/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users100 次/秒/App Key
添加单个用户至聊天室黑名单POST/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users/{username}100 次/秒/App Key
批量添加用户至聊天室黑名单POST/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users100 次/秒/App Key
从聊天室黑名单移除单个用户DELETE/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users/{username}100 次/秒/App Key
批量从聊天室黑名单移除用户DELETE/{org_name}/{app_name}/chatrooms/{chatroom_id}/blocks/users/{usernames}100 次/秒/App Key
查询聊天室白名单GET/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users`100 次/秒/App Key
添加单个用户至聊天室白名单POST/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users/{username}100 次/秒/App Key
批量添加用户至聊天室白名单POST/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users100 次/秒/App Key
将用户移除聊天室白名单DELETE/{org_name}/{app_name}/chatrooms/{chatroom_id}/white/users/{username}100 次/秒/App Key
获取聊天室的禁言列表GET/{org_name}/{app_name}/chatrooms/{chatroom_id}/mute100 次/秒/App Key
禁言聊天室成员POST/{org_name}/{app_name}/chatrooms/{chatroom_id}/mute100 次/秒/App Key
禁言聊天室全体成员POST/{org_name}/{app_name}/chatrooms/{chatroom_id}/ban100 次/秒/App Key
解除聊天室禁言成员DELETE/{org_name}/{app_name}/chatrooms/{chatroom_id}/mute/{member1}(,{member2},…)100 次/秒/App Key
解除聊天室全员禁言DELETE/{org_name}/{app_name}/chatrooms/{chatroom_id}/ban100 次/秒/App Key
获取超级管理员列表GET/{org_name}/{app_name}/chatrooms/super_admin100 次/秒/App Key
添加超级管理员POST/{org_name}/{app_name}/chatrooms/super_admin100 次/秒/App Key
移除超级管理员DELETE/{org_name}/{app_name}/chatrooms/super_admin/{superAdmin}100 次/秒/App Key

全局禁言

Rest API 接口方法接口 URL接口最高调用频率(默认值)
设置用户全局禁言POST/{org_name}/{app_name}/mutes100 次/秒/App Key
查询单个用户 ID 全局禁言GET/{org_name}/{appName}/mutes/username100 次/秒/App Key
查询 app 下的所有全局禁言的用户GET/{org_name}/{app_name}/mutes100 次/秒/App Key

用户在线状态管理

Rest API 接口方法接口 URL接口最高调用频率(默认值)
设置用户在线状态信息POST/{org_name}/{app_name}/users/{uid}/presence/{resource}/{status}50 次/秒/App Key
批量订阅在线状态POST/{org_name}/{app_name}/users/{uid}/presence/{expiry}50 次/秒/App Key
批量获取在线状态信息POST/{org_name}/{app_name}/users/{uid}/presence50 次/秒/App Key
取消订阅多个用户的在线状态DELETE/{org_name}/{app_name}/users/{uid}/presence50 次/秒/App Key
查询订阅列表GET/{org_name}/{app_name}/users/{uid}/presence/sublist?pageNum=1&pageSize=10050 次/秒/App Key

消息表情回复 Reaction

RESTful API 接口方法接口 URL接口最高调用频率(默认值)
创建/添加 ReactionPOST/{org_name}/{app_name}/reaction/user/{userId}100/second
根据消息 ID 获取 ReactionGET/{org_name}/{app_name}/reaction/user/{userId}100/second
删除 ReactionDELETE/{org_name}/{app_name}/reaction/user/{userId}100/second
根据消息 ID 和表情 ID 获取 Reaction 信息GET/{org_name}/{app_name}/reaction/user/{userId}/detail100/second

子区管理

RESTful API 接口方法接口 URL接口最高调用频率(默认值)
分页获取 app 中的子区GET/{org_name}/{app_name}/thread100/second
分页获取单个用户加入的所有子区GET/{org_name}/{app_name}/threads/user/{username}100/second
分页获取单个用户在指定群组中加入的所有子区GET/{org_name}/{app_name}/threads/chatgroups/{group_id}/user/{username}100/second
创建子区POST/{org_name}/{app_name}/thread100/second
修改子区PUT/{org_name}/{app_name}/thread/{thread_id}100/second
删除子区DELETE/{org_name}/{app_name}/thread/{thread_id}100/second
分页获取子区成员列表GET/{org_name}/{app_name}/thread/{thread_id}/users100/second
用户批量加入子区POST/{org_name}/{app_name}/thread/{thread_id}/users100/second
批量踢出子区成员DELETE/{org_name}/{app_name}/threads/{thread_id}/users100/second