机器人群操作

机器人拥有完整的群操作功能，可以使用机器人来管理群组。

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

1. 创建群组

1.0.1. 地址

http://domain/robot/group/create

1.0.2. body

参数 类型 必需 描述
operator string 是 操作者用户ID
group json 是 群参数，建议不填写群ID，由系统自动生成
to_lines int[] 否 会话线路，默认为0
notify_message 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" -H "rid":"robota" -d   \
  "{                       \
    \"operator\":\"a\",       \
    \"group\":{                 \
        \"group_info\":{              \
               \"name\": \"老王的朋友们\",     \
               \"owner\": \"laowang\",      \
             \"type\": 3                  \
          },                              \
          \"members\": [                  \
          {                              \
                 \"member_id\": \"memberId1\",  \
                 \"name\": \"老王的朋友们\",       \
                 \"type\": \"0\"        \
            }                            \
        ]                            \
      }                             \
    }"                                \
  http://localhost/robot/group/create

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

2. 销毁群组

2.0.1. 地址

http://localhost/robot/group/del

2.0.2. body

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

只有机器人拥有的群才可以销毁

2.0.3. 响应

无

2.0.4. 示例

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

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

3. 获取群组信息

3.0.1. 地址

http://localhost/robot/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" -H "rid":"robota" -d   \
  "{                       \
    \"groupId\":\"groupId1\"    \
    }"                                \
  http://localhost/robot/group/get_info

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

4. 转移群组

4.0.1. 地址

http://localhost/robot/group/transfer

4.0.2. body

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

4.0.3. 响应

无

4.0.4. 示例

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

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

5. 修改群组信息

5.0.1. 地址

http://localhost/robot/group/modify

5.0.2. body

参数 类型 必需 描述
operator string 是 操作者用户ID
group_id string 是 群组ID
type int 是 修改资料类型, 0 群名, 1 群头像, 2 群extra, 3 群全局禁言, 4 群加入方式, 5 禁止私聊
value string 是 修改资料的值，请仔细阅读后面针对value字段的说明
new_owner string 是 新群主用户ID
to_lines int[] 否 会话线路，默认为0
notify_message 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" -H "rid":"robota" -d   \
  "{                       \
    \"operator\":\"a\",       \
    \"group_id\":\"groupId1\",    \
    \"type\":3,    \
    \"value\":\"1\"    \
    }"                                \
  http://localhost/robot/group/modify

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

6. 获取群组成员列表

6.0.1. 地址

http://localhost/robot/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" -H "rid":"robota" -d   \
  "{                       \
    \"groupId\":\"groupId1\"    \
    }"                                \
  http://localhost/robot/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://localhost/robot/group/member/add

7.0.2. body

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

7.0.3. 响应

无

7.0.4. 示例

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

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

8. 移除群组成员

8.0.1. 地址

http://localhost/robot/group/member/del

8.0.2. body

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

8.0.3. 响应

无

8.0.4. 示例

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

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

9. 群组成员退出

9.0.1. 地址

http://localhost/robot/group/member/quit

9.0.2. body

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

9.0.3. 响应

无

9.0.4. 示例

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

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

10. 设置/修改群组成员昵称

10.0.1. 地址

http://localhost/robot/group/member/set_alias

10.0.2. body

参数 类型 必需 描述
operator string 是 操作者用户ID
group_id string 是 群组ID
memberId string 是 群组成员用户ID
alias string 否 群昵称
to_lines int[] 否 会话线路，默认为0
notify_message json 否 消息负载，如果不填写，系统会发出内置通知消息，如果填写，覆盖系统通知消息

10.0.3. 响应

无

10.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -H "rid":"robota" -d   \
  "{                       \
    \"operator\":\"a\",       \
    \"group_id\":\"groupId1\",    \
    \"memberId\":\"memberId1\",   \
    \"alias\":\"hello\"   \
    }"                                \
  http://localhost/robot/group/member/set_alias

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

11. 设置/修改群组成员附加信息

11.0.1. 地址

http://localhost/robot/group/member/set_extra

11.0.2. body

参数 类型 必需 描述
operator string 是 操作者用户ID
group_id string 是 群组ID
memberId string 是 群组成员用户ID
extra string 否 群成员附加信息
to_lines int[] 否 会话线路，默认为0
notify_message json 否 消息负载，如果不填写，系统会发出内置通知消息，如果填写，覆盖系统通知消息

11.0.3. 响应

无

11.0.4. 示例

curl -X POST -H "nonce:76616" -H "timestamp":"1558350862502" -H "sign":"b98f9b0717f59febccf1440067a7f50d9b31bdde" -H "Content-Type:application/json" -H "rid":"robota" -d   \
  "{                       \
    \"operator\":\"a\",       \
    \"group_id\":\"groupId1\",    \
    \"memberId\":\"memberId1\",   \
    \"extra\":\"hello extra\"   \
    }"                                \
  http://localhost/robot/group/member/set_extra

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

12. 设置/取消群管理员

12.0.1. 地址

http://localhost/robot/group/manager/set

12.0.2. body

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

12.0.3. 响应

无

12.0.4. 示例

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

{
  "code":0,
  "msg":"success"
}
2018 © wildfirechat.net 京ICP备18060403号-1 all right reserved，powered by Gitbook该文件修订时间： 2024-10-01 07:37:50

results matching ""

    No results matching ""