チャットルームの削除

概要

このエンドポイントを使用すると、指定したチャットルームとそのすべてのメッセージを永久に削除できます。削除後、チャットルームのデータとメッセージ履歴はデータベースから完全に削除され、復元することはできません。

API エンドポイント

チャットルームの削除

指定したチャットルームとそのすべてのメッセージを永久に削除します。

DELETE /rooms/:id

ヘッダー

パスパラメータ

リクエスト例

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",
    },
  }
);

レスポンス

成功レスポンス (200 OK)

結果オブジェクトのフィールド

レスポンス例

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

エラーレスポンス

リクエストが失敗した場合、エラーの詳細情報を含むエラーレスポンスが返されます。一般的なエラーシナリオは以下の通りです：

• 無効なクライアントキーまたは認証トークン
• 指定されたチャットルームが存在しない
• 該当するチャットルームを削除する権限がない
• サーバー内部エラー

ユースケース

チャットルーム管理

• 使用されなくなったチャットルームのクリーンアップ: アクティブでなくなった、または不要になったチャットルームを永久に削除します。
• データ管理: 必要に応じて、チャットルームとそのすべての関連メッセージ履歴を削除します。

注意事項

• 永久削除: この操作により、チャットルームとそのすべてのメッセージがデータベースから永久に削除され、復元はできません。
• メッセージの同時削除: チャットルーム内のすべてのメッセージ履歴も同期して削除されます。
• 重要なチャットルームを誤って削除しないよう、チャットルーム ID が正しいことを確認してください。
• 削除後、元のチャットルームメンバーは関連データにアクセスできなくなります。