齐成云·IM消息服务
群组管理
复制页面
齐成云·IM消息服务
项目说明
基础介绍
消息类型介绍
对话类型介绍
会话管理
创建或获取会话
POST
获取会话列表
POST
设置会话置顶
POST
设置会话免打扰
POST
删除会话
POST
用户管理
设置用户语言
POST
获取支持的语言列表
POST
获取用户在线客户端
POST
强制用户下线
POST
通过用户名搜索用户
POST
更新好友验证设置
POST
获取用户信息
POST
检查用户是否存在
POST
好友管理
添加好友请求
接受好友请求
拒绝好友请求
删除好友
获取好友列表
获取好友请求列表
设置好友昵称
设置好友备注
设置星标好友
设置好友消息提醒
设置会话置顶
获取好友设置信息
获取置顶会话列表
黑名单管理
添加用户到黑名单
从黑名单中移除用户
获取黑名单列表
检查黑名单状态
消息管理
发送消息
获取对话的所有消息
分页获取消息列表
更新消息状态
撤回消息
删除消息
批量标记消息为已读
搜索消息
客户端管理
获取用户在线客户端
强制客户端下线
向用户发送消息
向指定客户端发送消息
服务器管理
获取当前服务器状态
获取所有服务器信息
获取客户端分布情况
查找客户端所在服务器
发布订阅
发送消息到指定主题
客户端订阅主题
客户端取消订阅主题
获取客户端订阅列表
批量获取多个客户端的订阅列表
群组管理
创建群组
POST
解散群组
POST
更新群组信息
POST
获取群组信息
POST
获取群组成员列表
POST
邀请用户加入群组
POST
将用户踢出群组
POST
退出群组
POST
设置群管理员
POST
取消群管理员
POST
禁言群成员
POST
解除群成员禁言
POST
更新群组设置
POST
获取群组设置
POST
获取我的群组列表
POST
搜索群组
POST
通过群号码获取群组信息
POST
群组消息
发送群消息
获取群消息历史
撤回群消息
群组消息已读状态
获取消息已读状态
标记消息为已读
搜索群消息
订阅日志管理
获取推送统计信息
获取清理服务状态
手动执行清理
获取清理预估信息
控制清理服务
数据模型
Schemas
SuccessResponse
ErrorResponse
LanguageCode
PaginatedResponse
LanguageInfo
Friend
FriendRequest
FriendVerifyType
MessageType
MessageStatus
UserInfo
ChatsType
BlacklistItem
PriorityLevel
UserId
Conversation
ClientId
Message
MessageId
ChatsKey
Timestamp
Pagination
MessagePagination
MessageContent
MessageExtra
ClientInfo
ServerInfo
SubscriptionInfo
BaseResponse
CreateChatsResponse
ChatsListResponse
ChatsInfo
SendMessageResponse
MessagesResponse
PaginatedMessagesResponse
MessageInfo
群组管理
复制页面
将用户踢出群组
POST
/group/kickFromGroup
调试
Run in Apifox
Run in Apifox
将用户踢出群组,只有群主和管理员可以执行此操作
请求参数
Header 参数
生成代码
Body 参数
application/json
生成代码
示例
{
"groupId"
:
"g_Ab3Xy9Mn4Kp8"
,
"userId"
:
"user_789"
,
"reason"
:
"违反群规"
}
返回响应
🟢
200
成功
application/json
踢出成功
Body
生成代码
示例
{
}
上一页
邀请用户加入群组
下一页
退出群组