齐成云·IM消息服务
  1. 群组管理
齐成云·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
  • 群组消息
    • 发送群消息
    • 获取群消息历史
    • 撤回群消息
  • 群组消息已读状态
    • 获取消息已读状态
    • 标记消息为已读
    • 搜索群消息
  • 订阅日志管理
    • 获取推送统计信息
    • 获取清理服务状态
    • 手动执行清理
    • 获取清理预估信息
    • 控制清理服务
  • 连接WEBSOCKET
  • 连接WEBSOCKET-创建好友对话
  • 连接WEBSOCKET-测试发送订阅消息
  • 连接WEBSOCKET-测试发送消息给某个用户(全部客户端都会收到)
  • 连接WEBSOCKET-测试发送消息给某些客户端(支持同时发多个)
  1. 群组管理

创建群组

POST
/group/createGroup
创建新群组,可设置群名、头像、描述等基本信息,并邀请初始成员

请求参数

Header 参数
Authorization
string 
可选
默认值:
Bearer QC2b8fd0ca342c72f857f5f96
Appid
string 
可选
默认值:
1001
ClientId
string 
可选
默认值:
131231231223
TimeStamp
string 
可选
默认值:
{{$date.timestamp}}
Client-Type
string 
可选
默认值:
EnterpriseCenterWEB
Body 参数application/json
groupName
string 
群组名称
必需
>= 1 字符<= 100 字符
示例值:
技术交流群
groupAvatar
string 
群头像URL
可选
<= 255 字符
示例值:
https://example.com/avatar.jpg
groupDescription
string 
群描述
可选
<= 500 字符
示例值:
这是一个技术交流群,欢迎大家分享学习心得
groupType
enum<string> 
群类型
可选
枚举值:
normalofficial
示例值:
normal
initialMembers
array[string]
可选
初始成员用户ID列表
示例值:
["user_123","user_456"]
示例
{
    "groupName": "技术交流群",
    "groupAvatar": "https://example.com/avatar.jpg",
    "groupDescription": "这是一个技术交流群,欢迎大家分享学习心得",
    "groupType": "normal",
    "initialMembers": [
        "user_123",
        "user_456"
    ]
}

返回响应

🟢200成功
application/json
创建成功
Body
object {0}
示例
{
    "code": 1,
    "message": "群组创建成功",
    "data": {
        "group_id": "g_Ab3Xy9Mn4Kp8",
        "group_code": "1234567890",
        "group_name": "技术交流群",
        "group_avatar": "https://example.com/avatar.jpg",
        "group_description": "这是一个技术交流群,欢迎大家分享学习心得",
        "group_type": "normal",
        "group_owner_id": "user_owner",
        "group_status": "active",
        "created_at": "2024-01-01T12:00:00Z"
    }
}
🟠400请求有误
上一页
批量获取多个客户端的订阅列表
下一页
解散群组
Built with