取消釘選訊息

概述

此端點允許聊天室擁有者或管理員取消目前釘選的訊息，將其從聊天室頂部移除。

API 端點

取消釘選訊息

取消目前釘選的訊息，將其從聊天室頂部移除。

DELETE /messages/:id/pin

Headers

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

Path Parameters

參數	類型	必填	說明
`:id`	string	✅	訊息唯一識別碼

此 API 無需請求內容（Request Body）。

範例請求

cURL 範例：

curl -X "DELETE" "https://your-app.imkit.io/messages/5f890cf37d980e06f6aaf349/pin" \
     -H 'IM-CLIENT-KEY: {IM-CLIENT-KEY}' \
     -H 'IM-Authorization: {IM-Authorization}'

JavaScript 範例：

const response = await axios.delete(
  `https://your-app.imkit.io/messages/${messageID}/pin`,
  {
    headers: {
      "IM-CLIENT-KEY": `${IM_CLIENT_KEY}`,
      "IM-Authorization": `${TOKEN}`,
    },
  }
);

Response

成功回應（200 OK）

參數	類型	說明
`RC`	number	回應代碼（0 表示成功）
`RM`	string	回應訊息
`result._id`	string	訊息唯一識別碼
`result.message`	string	訊息內容
`result.room`	string	所屬聊天室 ID
`result.sender`	object	訊息發送者資訊
`result.messageType`	string	訊息類型
`result.pinned`	boolean	是否已釘選（取消後為 `false`）
`result.messageTimeMS`	number	訊息發送時間戳（毫秒）
`result.updatedAtMS`	number	最後更新時間戳（毫秒）

範例回應

{
  "RC": 0,
  "RM": "OK",
  "result": {
    "_id": "5f890cf37d980e06f6aaf349",
    "message": "重要公告：明天下午兩點開會",
    "room": "demo-room",
    "sender": {
      "_id": "aaa",
      "nickname": "AAA",
      "avatarUrl": "http://loremflickr.com/240/240/style?1569804629",
      "isRobot": false,
      "id": "aaa",
      "lastLoginTimeMS": 1602817267900
    },
    "messageType": "text",
    "appID": "SampleApp",
    "pinned": false,
    "id": "5f890cf37d980e06f6aaf349",
    "messageTimeMS": 1602817267923,
    "updatedAtMS": 1602817300000,
    "createdAtMS": 1602817267925
  }
}

錯誤回應

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

無效的用戶端金鑰或授權權杖
指定的訊息不存在
當前用戶不是聊天室擁有者或管理員
伺服器內部錯誤

使用場景

訊息管理

移除過時公告：當釘選的訊息不再相關時，取消釘選以保持聊天室整潔
更換釘選內容：取消釘選舊訊息後，可釘選新的重要訊息

注意事項

權限限制：僅聊天室**擁有者（owner）或管理員（admin）**可以執行取消釘選操作
若要釘選訊息，請使用釘選訊息 API

釘選訊息搜尋訊息