刪除聊天室

概述

此端點允許您永久刪除指定的聊天室及其所有訊息。刪除後，聊天室資料與訊息記錄將從資料庫中完全移除且無法復原。

API 端點

刪除聊天室

永久刪除指定的聊天室及其所有訊息。

DELETE /rooms/:id

Headers

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

Path Parameters

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

範例請求

cURL 範例:

curl -X "DELETE" "https://your-app.imkit.io/rooms/test-room-123" \
     -H 'IM-CLIENT-KEY: {IM-CLIENT-KEY}' \
     -H 'IM-Authorization: {IM-Authorization}' \
     -H 'Content-Type: application/json; charset=utf-8'

JavaScript 範例:

const response = await axios.delete(
  "https://your-app.imkit.io/rooms/test-room-123",
  {
    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	刪除操作的結果

結果物件欄位

參數	類型	說明
`n`	number	受影響的文件數量
`ok`	number	操作是否成功(1 表示成功)

範例回應

{
  "RC": 0,
  "RM": "OK",
  "result": {
    "n": 1,
    "ok": 1
  }
}

錯誤回應

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

無效的用戶端金鑰或授權權杖
指定的聊天室不存在
無刪除該聊天室的權限
伺服器內部錯誤

使用場景

聊天室管理

清理不再使用的聊天室:永久刪除已經不再活躍或不需要的聊天室
資料管理:在必要時移除聊天室及其所有相關訊息記錄

注意事項

永久刪除:此操作會將聊天室及其所有訊息從資料庫永久刪除,無法復原
訊息一併刪除:聊天室內所有的訊息記錄也會同步被刪除
請確認聊天室 ID 正確,避免誤刪重要的聊天室
刪除後,原本在該聊天室中的成員將無法再存取任何相關資料

更新聊天室聊天室列表