群组

群组的所有写操作都有可选的linepayload参数。因为写操作会触发通知消息,如果系统默认通知消息不符合您的需求,可以使用这两个参数来自定义通知消息,详情请参考常见问题

1. 创建群组

1.0.1. 地址

http://domain:18080/admin/group/create

1.0.2. body

参数 类型 必需 描述
operator string 操作者用户ID
group json 群参数,建议不填写群ID,由系统自动生成
line int 会话线路,默认为0
payload json 消息负载,如果不填写,系统会发出内置通知消息,如果填写,覆盖系统通知消息

1.0.3. 响应

参数 类型 必需 描述
group_id string 群组ID

1.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"operator\":\"a\",       \
    \"group\":{                 \
        \"group_info\":{              \
               \"name\": \"老王的朋友们\",     \
               \"owner\": \"laowang\",      \
             \"type\": 3                  \
          },                              \
          \"members\": [                  \
          {                              \
                 \"member_id\": \"memberId1\",  \
                 \"name\": \"老王的朋友们\",       \
                 \"owner\": \"laowang\"        \
            }                            \
        ]                            \
      }                             \
    }"                                \
  http://localhost:18080/admin/group/create

{
  "code":0,
  "msg":"success",
  "result":{
    "group_id":"groupId1"
  }
}

2. 销毁群组

2.0.1. 地址

http://domain:18080/admin/group/del

2.0.2. body

参数 类型 必需 描述
operator string 操作者用户ID
group_id string 群组ID
line int 会话线路,默认为0
payload json 消息负载,如果不填写,系统会发出内置通知消息,如果填写,覆盖系统通知消息

2.0.3. 响应

2.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"operator\":\"a\",       \
    \"group_id\":\"groupId1\"    \
    }"                                \
  http://localhost:18080/admin/group/del

{
  "code":0,
  "msg":"success"
}

3. 获取群组信息

3.0.1. 地址

http://domain:18080/admin/group/get_info

3.0.2. body

参数 类型 必需 描述
groupId string 群组ID,参数是驼峰式的,为了兼容旧的SDK保持现状吧

3.0.3. 响应

参数 类型 必需 描述
GroupInfo json 群资料

3.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"groupId\":\"groupId1\"    \
    }"                                \
  http://localhost:18080/admin/group/get_info

{
  "code":0,
  "msg":"success",
  "result":{
    "target_id":"groupId1",
    "name":"老王的朋友们",
    "owner":"laowang",
    "type":3
  }
}

4. 转移群组

4.0.1. 地址

http://domain:18080/admin/group/transfer

4.0.2. body

参数 类型 必需 描述
operator string 操作者用户ID
group_id string 群组ID
new_owner string 新群主用户ID
line int 会话线路,默认为0
payload json 消息负载,如果不填写,系统会发出内置通知消息,如果填写,覆盖系统通知消息

4.0.3. 响应

4.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"operator\":\"a\",       \
    \"group_id\":\"groupId1\",    \
    \"new_owner\":\"newOwner\",    \
    }"                                \
  http://localhost:18080/admin/group/transfer

{
  "code":0,
  "msg":"success"
}

5. 修改群组信息

5.0.1. 地址

http://domain:18080/admin/group/modify

5.0.2. body

参数 类型 必需 描述
operator string 操作者用户ID
group_id string 群组ID
type int 修改资料类型, 0 群名, 1 群头像, 2 群extra, 3 群全局禁言, 4 群加入方式, 5 禁止私聊
value string 群组ID
new_owner string 新群主用户ID
line int 会话线路,默认为0
payload json 消息负载,如果不填写,系统会发出内置通知消息,如果填写,覆盖系统通知消息

Value在不同的type下具有不同的意义。boolean值转化为"0"和"1", int类型转化为字符串,比如“1”/”2“/“3”。

type type含义 value类型 value含义
0 群名 string 群名称
1 群头像 string 群头像链接地址
2 群extra string 群附加信息,系统不会发默认群通知,如果需要群通知,请自定义新的群通知,然后发送时带上对应消息payload
3 群全局禁言 boolean 0 取消禁言;1全局禁言
4 群加入方式 int 0 所有人都可以加入;1 仅群成员邀请加入;2仅群管理员或群主邀请加入。更复杂控制,请应用服务进行二次开发
5 禁止私聊 boolean 0 允许私聊;1 禁止群成员私聊

5.0.3. 响应

5.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"operator\":\"a\",       \
    \"group_id\":\"groupId1\",    \
    \"type\":3,    \
    \"value\":\"1\"    \
    }"                                \
  http://localhost:18080/admin/group/modify

{
  "code":0,
  "msg":"success"
}

6. 获取群组成员列表

6.0.1. 地址

http://domain:18080/admin/group/member/list

6.0.2. body

参数 类型 必需 描述
groupId string 群组ID,参数是驼峰式的,为了兼容旧的SDK保持现状吧

6.0.3. 响应

参数 类型 必需 描述
GroupMember list<json> 群成员

6.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"groupId\":\"groupId1\"    \
    }"                                \
  http://localhost:18080/admin/group/member/list

{
  "code":0,
  "msg":"success",
  "result":[{
    "member_id":"groupMember1",
    "alias":"laoda",
    "type":2
  },
  {
    "member_id":"groupMember1",
    "type":0
  }
  ]
}

7. 添加群组成员

7.0.1. 地址

http://domain:18080/admin/group/member/add

7.0.2. body

参数 类型 必需 描述
operator string 操作者用户ID
group_id string 群组ID
members list<json> 群成员,成员类型只能为0/1
line int 会话线路,默认为0
payload json 消息负载,如果不填写,系统会发出内置通知消息,如果填写,覆盖系统通知消息

7.0.3. 响应

7.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"operator\":\"a\",       \
    \"group_id\":\"groupId1\",    \
    \"members\": [                  \
        {                              \
          \"member_id\": \"memberId1\",  \
          \"name\": \"老王的朋友们\",       \
          \"owner\": \"laowang\"        \
        }                            \
      ]                            \
    }"                                \
  http://localhost:18080/admin/group/member/add

{
  "code":0,
  "msg":"success"
}

8. 移除群组成员

8.0.1. 地址

http://domain:18080/admin/group/member/del

8.0.2. body

参数 类型 必需 描述
operator string 操作者用户ID
group_id string 群组ID
members list 群成员id,不能包含群主。
line int 会话线路,默认为0
payload json 消息负载,如果不填写,系统会发出内置通知消息,如果填写,覆盖系统通知消息

8.0.3. 响应

8.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"operator\":\"a\",       \
    \"group_id\":\"groupId1\",    \
    \"members\": [                  \
        \"memberId1\",  \
        \"memberId2\"  \
      ]                            \
    }"                                \
  http://localhost:18080/admin/group/member/del

{
  "code":0,
  "msg":"success"
}

9. 群组成员退出

9.0.1. 地址

http://domain:18080/admin/group/member/quit

9.0.2. body

参数 类型 必需 描述
operator string 退群用户ID
group_id string 群组ID
line int 会话线路,默认为0
payload json 消息负载,如果不填写,系统会发出内置通知消息,如果填写,覆盖系统通知消息

9.0.3. 响应

9.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"operator\":\"a\",       \
    \"group_id\":\"groupId1\"    \
    }"                                \
  http://localhost:18080/admin/group/member/quit

{
  "code":0,
  "msg":"success"
}

10. 设置/取消群管理员

10.0.1. 地址

http://domain:18080/admin/group/manager/set

10.0.2. body

参数 类型 必需 描述
operator string 操作者用户ID
group_id string 群组ID
members list 群成员ID
is_manager boolean true 设置为群管理;false 取消群管理员。
line int 会话线路,默认为0
payload json 消息负载,如果不填写,系统会发出内置通知消息,如果填写,覆盖系统通知消息

10.0.3. 响应

10.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"operator\":\"a\",       \
    \"group_id\":\"groupId1\",    \
    \"members\": [                  \
        \"memberId1\",  \
      ]                            \
    }"                                \
  http://localhost:18080/admin/group/manager/set

{
  "code":0,
  "msg":"success"
}

11. 获取用户的群列表(不建议高频使用,以防止有性能问题)

11.0.1. 地址

http://domain:18080/admin/group/of_user

11.0.2. body

参数 类型 必需 描述
userId string 用户ID,参数是驼峰式的,为了兼容旧的SDK保持现状吧

11.0.3. 响应

参数 类型 必需 描述
groupIds list 群id列表

11.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -d   \
  "{                       \
    \"userId\":\"userId1\"    \
    }"                                \
  http://localhost:18080/admin/group/of_user

{
  "code":0,
  "msg":"success",
  "result":{
    "groupIds":["groupId1", "groupId2", "groupId3"]
  }
}
2018 © wildfirechat.cn 京ICP备18060403号-1 all right reserved,powered by Gitbook该文件修订时间: 2020-03-03 22:39:27

results matching ""

    No results matching ""