直达内容

管理群组

更新群组​

POST /conversations/:id​

这里的更新主要是群聊，比如更新群公告、入群、退出、静音等操作。

以下操作成功后，将返回完整的会话数据，包括群组成员。

API 端点 URL

 https://api.mixin.one/conversations/:id

授权和其他选项

授权
Authorized
限制No limitation

参数

id
*必须
The conversation's id.

请求体

{
  "name":         "New group name, 512 characters at most.",
  "announcement": "Group Announcements, 1024 characters at most.",
}
信息

每次字段更新，所有群成员都能看到醒目的群公告提醒栏。

请求示例

curl -i -X POST -H "Content-Type: application/json" -H "Authorization: Bearer $TOKEN" https://api.mixin.one/conversations/928c5c40-769c-3e97-8387-fb1ae0645311 --data PAYLOAD
Responses
{
  "data": {
    "type":             "conversation",
    "conversation_id":  "928c5c40-769c-3e97-8387-fb1ae0645311",
    "creator_id":       "8dcf823d-9eb3-4da2-8734-f0aad50c0da6",
    "category":         "GROUP",
    "name":             "",
    "icon_url":         "",
    "announcement":     "",
    "created_at":       "2018-05-16T12:34:44.134238105Z",
    "code_id":          "d8244b92-30e9-44b5-bfb0-ce597c788125",
    "code_url":         "https://mixin.one/codes/d8244b92-30e9-44b5-bfb0-ce597c788125",
    "mute_until":       "2018-05-16T12:34:44.143010035Z",
    "participants": [
      {
        "type":     "participant",
        "user_id":  "8dcf823d-9eb3-4da2-8734-f0aad50c0da6",
        "role":     "OWNER",
        "created_at": "2018-05-16T12:34:44.134238105Z"
      },
      {
        "type":     "participant",
        "user_id":  "e8e5b807-fa8b-455a-8dfa-b189d28310ff",
        "role":     "",
        "created_at": "2018-05-16T12:34:44.149277666Z"
      },
      ...
    ],
    "participant_sessions": [
      {
        "user_id":  "8dcf823d-9eb3-4da2-8734-f0aad50c0da6",
        "session_id":  "8dcf823d-9eb3-4da2-8734-f0aad50c0da6",
      },
      ...
    ],
    "circles": [
      {
        "circle_id":  "8dcf823d-9eb3-4da2-8734-f0aad50c0da6",
        "conversation_id":  "8dcf823d-9eb3-4da2-8734-f0aad50c0da6",
        "user_id":  "8dcf823d-9eb3-4da2-8734-f0aad50c0da6",
        "created_at": "2018-05-16T12:34:44.149277666Z"
      },
      ...
    ]
  }
}

管理群成员​

POST /conversations/:code_id/join​

通过链接加入群组。 code_id 是加入当前组的 ID，由 GET /conversation/:id 返回，通过 POST /conversations/:id/rotate 生成。

POST /conversations/:id/participants/ADD​

如果您是此群组对话的所有者或管理员，则可以通过调用此 API 将其他用户添加到群组中。

请求内容：

[
  { "user_id": "" },
  ...
]

POST /conversations/:id/participants/REMOVE​

如果您是此群组对话的群主或管理员，则可以从群组中删除成员。

请求内容：

[
  { "user_id": "" },
  ...
]

POST /conversations/:id/rotate​

重置邀请链接和 code_id。

POST /conversations/:id/exit​

离开当前群组。

管理群管理员​

只有群主可以设置或取消群管理员

POST /conversations/:id/participants/ROLE​

设置或撤销用户的管理员权限。

设置管理员：

[{ "user_id": "", "role": "ADMIN" }]

移除管理员：

[{ "user_id": "", "role": "" }]

设置群为静音​

静音对话仍会收到消息，但不会收到通知。

POST /conversations/:id/mute​

请求内容：

ParameterTypeDescription
durationInt64单位秒, 0s 代表取消静音, > 0s 表示静音时间, 例如 28,800 代表静音 8 小时

在静音之前，要创建 conversation, 如果 conversation 不存在会返回 403.

POST /conversations/:id/disappear​

请求内容：

ParameterTypeDescription
durationInt64单位秒, 最大 12 周

限时消息，只有管理员可以设置, 以 30s 为例, 规则：

  1. 如果消息已读，到 30s 后直接删除
  2. 如果消息未读，且超过 24 小时，那么 30s 后也删除