群组管理


群组数据结构


群组角色


管理群组


分页获取APP下的群组

  • Path: /api/v1/groups/page/{page_no}/{page_size}
  • 方式: GET
  • 作用:群信息分页查询
  • 请求参数描述
参数名 IN 类型 必填 描述
page_no path int 第几页
page_size path int 每页查询数量
  • 响应参数说明
Name IN Type Description
success body String 成功/失败
Code body String 状态码
Msg body String 异常信息
datas body String 返回数据
isFirstPage body Boolean 是否第一页
isLastPage body Boolean 是否最后一页
pageNum body Integer 第几页
pageSize body Integer 每页查询数量
pages body Integer 总页数
total body Integer 总记录数
list body List 查询结果
id body String 群ID
name body String 群名称
Owner body String 群管理员
Description body String 描述
groupMemberNum body Object 群成员数量
maxUsers body String 群成员上限
expiration body Object Token有效截止时间
extraInfo body String 扩展信息
  • 成功示例
{
    "success": true,
    "code": 200,
    "msg": null,
    "datas": "{\"isFirstPage\":false,\"isLastPage\":false,\"list\":[{\"canAnyoneDiscoverJID\":false,\"canChangeNickname\":false,\"canOccupantsChangeSubject\":false,\"canOccupantsInvite\":false,\"creationDate\":\"001537601079122\",\"description\":\"都那么呃呃呃\",\"logEnabled\":false,\"loginRestrictedToNickname\":false,\"maxUsers\":30,\"membersOnly\":false,\"moderated\":false,\"persistent\":false,\"publicRoom\":false,\"registrationEnabled\":false,\"id\":52,\"name\":123}],\"pageNum\":10,\"pageSize\":1,\"pages\":161,\"total\":161}",
    "extraInfo": null
}

获取一个用户参与的所有群组

  • Path: /api/v1/groups/user/in/{username}
  • 方式: GET
  • 作用:查询用户参与的群
  • 请求参数描述
参数名 IN 类型 必填 描述
username path String 用户名
  • 响应参数说明
Name IN Type Description
success body String 成功/失败
Code body String 状态码
Msg body String 异常信息
datas body Object 返回数据
id body String 群ID
name body String 群名称
Owner body String 群管理员
Description body String 描述
groupMemberNum body Object 群成员数量
maxUsers body String 群成员上限
expiration body Object Token有效截止时间
extraInfo body String 扩展信息
  • 成功示例
{
    "success": true,
    "code": 200,
    "msg": null,
    "datas": [
        {
            "serviceId": 1,
            "id": 100,
            "name": "112121",
            "description": "",
            "naturalName": "112121",
            "owner": "admin@openfire.ditingai.cn",
            "maxUsers": 30,
            "nickname": null
        },
        {
            "serviceId": 1,
            "id": 9,
            "name": "123",
            "description": "123",
            "naturalName": "123",
            "owner": "admin@openfire.ditingai.cn",
            "maxUsers": 30,
            "nickname": null
        },
        {
            "serviceId": 1,
            "id": 76,
            "name": "666",
            "description": "",
            "naturalName": "666",
            "owner": "admin@openfire.ditingai.cn",
            "maxUsers": 30,
            "nickname": null
        },
        {
            "serviceId": 1,
            "id": 77,
            "name": "777",
            "description": "",
            "naturalName": "777",
            "owner": "admin@openfire.ditingai.cn",
            "maxUsers": 30,
            "nickname": null
        },
        {
            "serviceId": 1,
            "id": 78,
            "name": "888",
            "description": "",
            "naturalName": "888",
            "owner": "admin@openfire.ditingai.cn",
            "maxUsers": 30,
            "nickname": null
        },
        {
            "serviceId": 1,
            "id": 21,
            "name": "admin01",
            "description": "",
            "naturalName": "admin01",
            "owner": "admin@openfire.ditingai.cn",
            "maxUsers": 30,
            "nickname": null
        },
        {
            "serviceId": 1,
            "id": 102,
            "name": "ddasdasd",
            "description": "dasdasd",
            "naturalName": "ddasdasd",
            "owner": "admin@openfire.ditingai.cn",
            "maxUsers": 30,
            "nickname": null
        },
        {
            "serviceId": 1,
            "id": 12,
            "name": "hhhhhhhhh",
            "description": "hhhhhhhhh",
            "naturalName": "hhhhhhhhh",
            "owner": "admin@openfire.ditingai.cn",
            "maxUsers": 30,
            "nickname": null
        },
        {
            "serviceId": 1,
            "id": 18,
            "name": "wwwwww",
            "description": "wwwwww",
            "naturalName": "wwwwww",
            "owner": "admin@openfire.ditingai.cn",
            "maxUsers": 30,
            "nickname": null
        }
    ],
    "extraInfo": null
}

获取群组详情

创建一个群组

  • Path: /api/v1/groups/
  • 方式: POST
  • 作用:创建群
  • 请求参数描述
参数名 IN 类型 必填 描述
name body String 用户名
description body String 群简介
owner body String 创建人姓名
  • 响应参数说明
Name IN Type Description
success body String 成功/失败
Code body String 状态码
Msg body String 异常信息
datas body Object 返回数据
id body String 群ID
name body String 群名称
Owner body String 群管理员
Description body String 描述
groupMemberNum body Object 群成员数量
maxUsers body String 群成员上限
expiration body Object Token有效截止时间
extraInfo body String 扩展信息
  • 成功示例
{
    "success": true,
    "code": 200,
    "msg": null,
    "datas": "{\"id\":null,\"name\":\"dsdssdsds21\",\"owner\":null,\"description\":null,\"groupMemberNum\":null,\"maxUsers\":null,\"type\":null}\n",
    "extraInfo": null
}

  • 失败示例
{
    "success": false,
    "code": 10001,
    "msg": "系统内部错误",
    "datas": null,
    "extraInfo": null
}

修改群组信息

  • Path: /api/v1/groups/replace
  • 方式: POST
  • 作用:修改群组信息
  • 请求参数描述
参数名 IN 类型 必填 描述
id body Integer 群ID
name body String 群名称
description body String 描述
maxUsers body Integer 最大用户数
  • 请求参数示例
 {
   "id":1,
   "name":"111",
   "description":"skkkk",
   "maxUsers":100
}

  • 响应参数说明
Name IN Type Description
success body String true/false
code body String 状态码
message body String 消息
datas body Object 数据体
extraInfo body String

删除群组

  • Path: /api/v1/groups/{id}
  • 方式: DELETE
  • 作用:删除群组

  • 响应参数说明

Name IN Type Description
success body String true/false
code body String 状态码
message body String 消息
datas body Object 数据体
extraInfo body String

管理群组成员


分页获取群组成员

  • Path: /api/v1/group_members/{group_id}/page/{page_no}/{page_size}
  • 方式: GET
  • 作用:分页获取群成员群成员
  • 请求参数描述
参数名 IN 类型 必填 描述
group_id path Integer 群ID
page_id path Integer 页码
page_size path Integer 每页显示数
  • 响应参数说明
Name IN Type Description
isFirstPage body Boolean 是否第一页
isLastPage body Boolean 是否最后一页
pageNum body Integer 第几页
pageSize body Integer 每页查询数量
pages body Integer 总页数
total body Integer 总记录数
list body List 查询结果
username body String 用户名
password body String 昵称

-成功示例

{
    "success": true,
    "code": 200,
    "msg": null,
    "datas": {
        "pageNum": 1,
        "pageSize": 3,
        "total": 3,
        "pages": 1,
        "list": [
            {
                "username": "lxc",
                "nickname": null
            },
            {
                "username": null,
                "nickname": "lsj"
            },
            {
                "username": null,
                "nickname": "plpl"
            }
        ],
        "isFirstPage": true,
        "isLastPage": true
    },
    "extraInfo": null
}


添加群组成员[单个]

  • Path: /api/v1/group_members/{group_id}/users/{username}
  • 方式: POST
  • 作用:添加群成员
  • 请求参数描述
参数名 IN 类型 必填 描述
username path String 用户名
group_id path Integer 群ID
  • 响应参数说明
Name IN Type Description
true body Boolean 成功
false body Boolean 失败

-成功示例

{
    "success": true,
    "code": 200,
    "msg": null,
    "datas": true,
    "extraInfo": null
}

添加群组成员[批量]

移除群组成员[单个]

  • Path: /api/v1/group_members/{group_id}/users/{username}
  • 方式: DELETE
  • 作用:移除群成员
  • 请求参数描述
参数名 IN 类型 必填 描述
username path String 用户名
group_id path Integer 群ID
  • 响应参数说明
Name IN Type Description
true body Boolean 成功
false body Boolean 失败

-成功示例

{
    "success": true,
    "code": 200,
    "msg": null,
    "datas": true,
    "extraInfo": null
}


移除群组成员[批量]

获取群管理员列表

添加群管理员

移除群管理员

转让群组


管理黑名单


查询群组黑名单

添加用户至群组黑名单[单个]

添加用户至群组黑名单[批量]

从群组黑名单移除用户[单个]

从群组黑名单移除用户[批量]


管理禁言


添加禁言

移除禁言

获取禁言列表