移除成員

概述

此端點允許您將一位或多位成員從指定聊天室中移除。若在 members 中傳入當前用戶自身的 ID，則代表該用戶主動離開聊天室。

API 端點

移除成員

將一位或多位成員從指定聊天室中移除。

POST /rooms/:id/delete/members

Headers

參數	類型	必填	說明
`IM-CLIENT-KEY`	string	✅	用戶端金鑰
`IM-Authorization`	string	✅	用戶端權杖

Path Parameters

參數	類型	必填	說明
`:id`	string	✅	聊天室唯一識別碼

Post Body

參數	類型	必填	說明
`members`	array[string]	✅	要移除的成員 ID 陣列；若包含當前用戶自身 ID，代表主動離開聊天室
`systemMessage`	boolean	❌	是否自動產生離開或移除成員的系統訊息（`leaveRoom` 或 `deleteMember`），預設為 `false`

範例請求

範例一：移除指定成員

cURL 範例：

curl -X "POST" "https://your-app.imkit.io/rooms/demo-room/delete/members" \
     -H 'IM-CLIENT-KEY: {IM-CLIENT-KEY}' \
     -H 'IM-Authorization: {IM-Authorization}' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d '{"members": ["ccc", "bbb"], "systemMessage": true}'

JavaScript 範例：

const response = await axios.post(
  `https://your-app.imkit.io/rooms/${roomID}/delete/members`,
  {
    members: ["ccc", "bbb"],
    systemMessage: true,
  },
  {
    headers: {
      "IM-CLIENT-KEY": `${IM_CLIENT_KEY}`,
      "IM-Authorization": `${TOKEN}`,
      "Content-Type": "application/json; charset=utf-8",
    },
  }
);

範例二：當前用戶主動離開聊天室

JavaScript 範例：

const response = await axios.post(
  `https://your-app.imkit.io/rooms/${roomID}/delete/members`,
  {
    members: [`${MY_CLIENT_ID}`],
    systemMessage: true,
  },
  {
    headers: {
      "IM-CLIENT-KEY": `${IM_CLIENT_KEY}`,
      "IM-Authorization": `${TOKEN}`,
      "Content-Type": "application/json; charset=utf-8",
    },
  }
);

Response

成功回應（200 OK）

參數	類型	說明
`RC`	number	回應代碼（0 表示成功）
`RM`	string	回應訊息
`result`	object	更新後的聊天室完整資訊

範例回應

{
  "RC": 0,
  "RM": "OK",
  "result": {
    "_id": "demo-room",
    "lastMessage": {
      "_id": "58a2dc9c965d09221ea7bedb",
      "message": "sadf dsfdf",
      "messageType": "text",
      "sender": {
        "_id": "1485248560558",
        "nickname": "Test AB",
        "avatarUrl": "http://example.com/avatarUrl",
        "lastLoginTimeMS": 0,
        "id": "1485248560558"
      },
      "messageTime": "2017-02-14T10:31:56.006Z",
      "messageTimeMS": 1487068316006,
      "id": "58a2dc9c965d09221ea7bedb"
    },
    "members": [
      {
        "_id": "1485248560558",
        "nickname": "Test AB",
        "avatarUrl": "http://example.com/avatarUrl",
        "lastLoginTimeMS": 1487068306745,
        "id": "1485248560558"
      },
      {
        "_id": "1485248566481",
        "nickname": "Test2",
        "lastLoginTimeMS": 1486720993257,
        "id": "1485248566481"
      }
    ],
    "id": "demo-room"
  }
}

錯誤回應

當請求失敗時，您會收到包含錯誤詳細資訊的錯誤回應。常見的錯誤情況包括：

無效的用戶端金鑰或授權權杖
指定的聊天室不存在
members 中包含不在聊天室內的用戶 ID
伺服器內部錯誤

使用場景

成員管理

移除成員：管理員可從聊天室中移除一位或多位成員
主動離開：用戶可透過傳入自身 ID 主動離開聊天室

系統通知

自動通知：設定 systemMessage: true 時，系統會根據情境自動產生 leaveRoom 或 deleteMember 類型的系統訊息

注意事項

主動離開：在 members 陣列中傳入當前用戶自身的 ID，即代表該用戶主動離開聊天室
系統訊息：設定 systemMessage: true 時，若成員為主動離開，系統訊息類型為 leaveRoom；若為被移除，則為 deleteMember
成員被移除後，將無法再存取該聊天室的任何訊息記錄

添加成員聊天室成員列表